How to change and commit the source code and how to document modifications

Please note that the change-and-commit procedure has changed with revision r2235

Strict rules apply to formatting of the PALM FORTRAN code. These rules are outlined in the PALM coding standard document​.

Only authorized users are allowed to commit changes to the repository.

1. Change source code in your current working copy. Document all changes in the respective file headers under "Current revisions:". Additionally, all changes might be documented in a local file (e.g. ~/palm/current_version/CURRENT_MODIFICATIONS), including the names of those files that have been changed. Classify changes in three cases, new (N), changed (C), and bugfix (B). Try to be as short and as precise as possible in describing the changes!
   
   
2. Test the changed version, until it works sufficiently. Starting with revision r2347 the script testsuite is available which can be used to test the current state of the trunk. Starting with r2515 the script palmtest supersedes testsuite.
   
   
3. Run the script document_changes to save the change comments (NOT for branches). After having made your changes in the source code, simply call

      document_changes trunk
   

   Alternatively, move the change comments in the file headers from "Current revisions:" to "Former revisions:" manually. Set the current svn id in front of that and modify the id string of the last commit.
   
   Example:
   
   before move:

   ! Current revisions:
   ! -----------------
   ! new dummy argument abcd
   !
   ! Former revisions:
   ! -----------------
   ! $Id: init_3d_model.f90 425 2010-02-06 13:37:48Z raasch $
   ! var_pr is no longer needed and is removed
   !
   ! 407 2009-12-01 15:01:15Z maronga
   ! var_ts is replaced by dots_max
   

   after move:

   ! Current revisions:
   ! -----------------
   !
   !
   ! Former revisions:
   ! -----------------
   ! $Id: init_3d_model.f90 425 2010-02-06 13:37:48Z raasch $
   ! new dummy argument abcd
   !
   ! 425 2010-02-06 13:37:48Z raasch
   ! var_pr is no longer needed and is removed
   !
   ! 407 2009-12-01 15:01:15Z maronga
   ! var_ts is replaced by dots_max
   

4. Commit the changes to the repository

      svn commit -m "message string" trunk
   

   where "message string" is a short, meaningful summary of the changes.
   
   Alternatively, in case that you have made quite a lot of changes, you can also give the contents of your file CURRENT_MODIFICATIONS as the log message:

      svn commit -F CURRENT_MODIFICATIONS trunk
   

   The id tag in the modified source code will change accordingly.

5. Enter the changes into the change log (doc/tec/changelog).
   
   

How to work with svn branches

Following presentation holds a step-by-step guide of how to create, checkout, modify, commit and merge code development within an svn branch.