Changes between Version 7 and Version 8 of doc/tec/developerrules/svnbranch

Timestamp:

Nov 12, 2018 1:44:59 PM (6 years ago)

Author:

westbrink

Comment:

--

doc/tec/developerrules/svnbranch

@@ -12 +12 @@
   * You can browse your branch under https://palm.muk.uni-hannover.de/trac/browser/palm/branches
 
-== (2 a) Checkout of local branch copy ==
+
+== (2) Use of local branch copy==
+
+=== (2 a) Checkout of local branch copy ===
 
 * {{{cd $HOME/palm/branches/ }}}
 * {{{ svn checkout --username <your PALM username> https://palm.muk.uni-hannover.de/svn/palm/branches/<feature_name>}}}
 
-== (2 b) Update of local branch copy ==
+=== (2 b) Update of local branch copy ===
 
 If the local branch copy already exists, and you would like to update it with a newer svn revision of this branch:
@@ -41 +44 @@
            An alternative to this approach is to __use symbolic links__ to link {{{.../trunk to .../branches/<feature_name>}}}. \\ This way you don't have to keep changing the {{{PATH/PALM_BIN}}} variables, and you run PALM out of your current_version directory, \\ with your {{{SCRIPTS/SOURCE}}} files from {{{~/palm/branches/<feature_name>}}} 
 
-== (3 a) How to use git for local code versioning ==
+=== (3 a) How to use git for local code versioning ===
 
 (These are only brief hints, please refer to the git manual for more detailed help)
@@ -58 +61 @@
 |||| Please '''DO NOT''' mix up synchronization and other code changes in one commit, because when \\ doing  a diff of two branch revisions it‘s very difficult to find out the actual changes in the branch. ||
 
-== (4 a) Merge repository branch into local branch copy ==
+=== (4 a) Merge repository branch into local branch copy ===
 
 1. {{{cd $HOME/palm/branches/<feature_name>}}} \\
@@ -74 +77 @@
      [[span(style=color: #FF0000, __'''Note:'''__ It might be wise to put a copy of your modified files somewhere else before you do the merge.)]]
 
-== (4 b) Merge PALM main repository revision (trunk) into local branch copy ==
+=== (4 b) Merge PALM main repository revision (trunk) into local branch copy ===
 
 1. {{{cd $HOME/palm/branches/<feature_name>}}}
@@ -87 +90 @@
     [[span(style=color: #FF0000, __'''Note:'''__ It might be wise to put a copy of your modified files somewhere else before you do the merge.)]]
 
-== (4 c) Resolving conflicts in a merge ==
+=== (4 c) Resolving conflicts in a merge ===
 
 You will find following set of files in case of a conflict, e.g.
@@ -97 +100 @@
 To resolve the conflict, we recommend to take file {{{average_3d_data.f90}}}, and manually work through the conflicted lines, \\ which look something like this:
 [[Image(test.png)]]
+You could also use kdiff3 of files „left“ and „right“ to visualize the changes at conflicted lines.
+
+'''The final merged content must be in file {{{average_3d_data.f90}}}''' (without [[span(style=color: blue, suffix)]]) \\ '''Now continue with step {{{svn resolved}}} in Chapter 4a or 4b!'''
+
+== (5) Commit changes to repository branch ==
+ 
+1. Add a brief summary of your changes into the header of the file you modified under „Current revisions:“. \\ Add <your PALM username>, and repeat this for every commit of this specific file, e.g.:\\
+   {{{! Current revisions:}}}\\
+   {{{! - - - - - - - - - }}}\\
+   {{{! Change of variable name pt to vpt (<your PALM username>)}}}\\
+   {{{! Bugfix in shortwave radiation calculation (<your PALM username>)}}}
+2. {{{ cd ~/palm/branches/<feature_name>/SOURCE }}}
+3. {{{svn status}}} \\ (to see which files were earmarked, e.g. as '''M'''odified, '''D'''eleted/'''A'''dded from/to svn repository\\ '''[[span(style=color: red, ATTENTION:)]] all listed files will be commited in step 4)'''
+4. {{{svn commit -m 'Branch <feature_name>: short comment on changes' <file1.f90> <file2.f90>}}}
+5. Now you should be able to see your commited files, if you browse your branch under\\ https://palm.muk.uni-hannover.de/trac/browser/palm/branches
+ 
+|||| While committing to your branch, please make sure that the revision comments remain under „Current revisions“. \\ Do not use the script document_changes, nor manually copy the revision comment to the „Former revisions“ section.\\ This makes merging to the palm4u branch or to the trunk more difficult. ||
+
+=== (5 a) Commit changes to repository branch → How to add new files (I) ===
+
+(For how to structure new SOURCE files, please take a look at the template_newmodule_mod_v3.f90 in the Downloads section of the MOSAIK page).\\
+In order to use the “keyword substitution” feature of subversion, a newly created file must contain the Id-keyword.
+
+{{{! Former revisions:}}}\\
+{{{! -----------------}}}\\
+{{{! $Id$}}}
+
+The new file has to be earmarked in order to be added to the svn repository with the next commit. \\This marking is done by
+
+{{{svn add newfile.f90}}}
+
+Substitution of the „Id“-keyword has to be activated with svn-command
+
+{{{svn propset svn:keywords "Id" newfile.f90}}}
+
+=== (5 a) Commit changes to repository branch → How to add new files (II) ===
+
+After the commit (see Chapter 5), subversion will automatically substitute the “Id” string with the current timestamp:
+
+{{{! Former revisions:}}}\\
+{{{! -----------------}}}\\
+{{{! $Id: newfile.f90 1683 2015-10-07 23:57:51Z raasch $}}}
+
+ == (6) Some additional commands ==
+ 
+(For details about the commands, see http://svnbook.red-bean.com/de/1.7/index.html)
+
+* Deleting files or directories from the svn repository\\
+  {{{svn delete file/directory}}} \\
+  (Perform command in local branch copy to mark files/directories for deletion. \\During the commit, the marked files/directories will be deleted in the svn branch)
+* Checking, which files have been modified in your local branch copy with respect to the checked-out branch revision\\ (see http://svnbook.red-bean.com/de/1.7/svn.ref.svn.c.status.html)
+   {{{svn status <feature_name>}}}
+* Printing revision information about the local branch copy
+   {{{svn info <feature_name>}}}
+
+