| | 2 | |
| | 3 | == MESSAGE JULY 4 th 2011 == |
| | 4 | '''Senders:''' Thomas Launois and Kun Tan |
| | 5 | |
| | 6 | '''Aim:''' How to commit changes to the source code of ORCHIDEE-FM |
| | 7 | |
| | 8 | '''Background:''' Through the use of the svn server we are now aiming to maintain a single version of ORCHIDEE-FM. All ORCHIDEE-FM users are therefore requested to upload there changes regularly. Uploading your changes to the server is called 'Committing'. |
| | 9 | |
| | 10 | '''When to commit:''' (1) It is good practice to commit after a bug in the ORCHIDEE-FM branch version was corrected because several people are using this branch. |
| | 11 | (2) When new functionality has been added (and debugged) to the branch, this new code should be merged with the version available on the svn server and then committed. |
| | 12 | |
| | 13 | '''Good practices for committing:''' (1) Please, use flags (on/off) when committing new functionality so that not all users are forced to use these new functions. |
| | 14 | (2) Send an e-mail to the ORCHIDEE-FM list so everybody knows what was added/deleted/changed and which bug it corrected. |
| | 15 | (3) Provide detailed information when committing. This information is stored on the svn server. |
| | 16 | (4) Properly document your code/changes because others will need to understand it! |
| | 17 | |
| | 18 | '''How to commit:''' (1) Check whether your code is compatible with the SVN one : no other change should exist between your version and the SVN server version. Update/merge when necessary |
| | 19 | (2) To commit one particular file, browse to the folder that contains the file and type the following command |
| | 20 | |
| | 21 | svn ci --username /login /--no-auth-cache / filename/ -m "/message or commentary about your version. Provide sufficient information/" |
| | 22 | |
| | 23 | where /login is "firstname.lastname" format and /filename is sample.f90 format |
| | 24 | |
| | 25 | For example |
| | 26 | svn ci --username thomas.launois --no-auth-cache dim2_driver.f90 -m "Modification of intersurf to allow this and that" |
| | 27 | |
| | 28 | |
| | 29 | |
