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

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

1. Make sure your code complies with the PALM coding standard. Strict rules apply for formatting PALM Fortran and Python code.

2. Change source code in your current working copy and 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!

3. Test the changed version, until it works sufficiently. Starting with r2515 the script palmtest is available which can be used to test the current state of the trunk (details about palmtest).

4. 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

5. 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.

6. Enter the changes into the change log (NOT for branches).

How to work with svn branches

Click here to find a step-by-step guide of how to create, checkout, modify, commit and merge code development within an svn branch.