Changes between Version 9 and Version 10 of doc/tec/developerrules

Timestamp:

May 31, 2017 8:15:18 AM (8 years ago)

Author:

maronga

Comment:

--

doc/tec/developerrules

@@ -1 +1 @@
 = How to change and commit the source code and how to document modifications =
+[[NoteBox(note,Please note that the change-and-commit procedure has changed starting from revision r2235)]]
 
 Strict rules apply to formatting of the PALM FORTRAN code. These rules are outlined in the [attachment:PALM_coding_standard.docx PALM coding standard document].
@@ -5 +6 @@
 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, document all changes 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! [[BR]] [[BR]]
+   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! [[BR]] [[BR]]
    2. Test the changed version, until it works sufficiently. [[BR]] [[BR]]
-   3. Commit the changes to the repository
-      {{{
-         svn commit -m "message string" trunk
-      }}}
-      where {{{"message string"}}} is a short, meaningful summary of the changes. [[BR]] [[BR]]
-      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
-      }}}
-   4. Enter the changes into the change log ([wiki:/doc/tec/changelog]). [[BR]] [[BR]]
-   5. Move the change comments in the file headers from {{{"Current revisions:"}}} to {{{"Former revisions:"}}}. Set the current svn id in front of that. 
-      This procedure is taken over by the shell script {{{document_changes}}}. After having committed your changes, simply call
+   3. Run the script document_changes to save the change comments. After having made your changes in the source code, simply call
       {{{
          document_changes trunk
       }}}
-      Alternatively, you can do the necessary changes manually.
+      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.
       [[BR]] [[BR]]
       Example:  [[BR]] [[BR]]
@@ -33 +23 @@
       ! Former revisions:
       ! -----------------
-      ! $Id: init_3d_model.f90 425 2010-02-06 13:37:48Z raasch $
+      ! $Id: init_3d_model.f90 424 2010-02-06 13:37:48Z raasch $
+      ! var_pr is no longer needed and is removed
       !
       ! 407 2009-12-01 15:01:15Z maronga
@@ -47 +38 @@
       ! -----------------
       ! $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
@@ -55 +47 @@
       }}}
 
-   6. Commit the changes in the technical documentation and the file headers:
+
+   3. Commit the changes to the repository
       {{{
-         svn commit -m "last commit documented" trunk
+         svn commit -m "message string" trunk
       }}}
+      where {{{"message string"}}} is a short, meaningful summary of the changes. [[BR]] [[BR]]
+      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
+      }}}
+   4. Enter the changes into the change log ([wiki:/doc/tec/changelog]). [[BR]] [[BR]]