Changes between Version 9 and Version 10 of Documentation/UserGuide/CommitOnTrunk

Timestamp:

2015-09-25T16:42:33+02:00 (9 years ago)

Author:

jgipsl

Comment:

--

Documentation/UserGuide/CommitOnTrunk

@@ -1 @@
-= Commit on the trunk =
+[[PageOutline]] 
+= Commit on the trunk or a branch =
 Here are some general guidelines for committing into the trunk ORCHIDEE. These recommendations can also be applied to branches and other versions under SVN control. 
 
@@ -10 +11 @@
 
 Some cases must be discussed in advance:
- * if the behavior of the model change. For example: change in parameter name in getin function, change in default value for some parameters, etc..
+ * if the behaviour of the model change. For example: change in parameter name in getin function, change in default value for some parameters, etc..
  * if the interface towards the atmosphere is changed
  * big modifications
 
 During commit:
- * one commit per ticket
+ * a commit should only resolve one problem at a time, related to one ticket. Do not make to be commit.
  * write a useful log message in English
  * use '''#X''' to refer to the ticket number X (the # will make a link directly to the ticket when visualizing the log message on the web)
 
 After commit:
- * for important changes, make a note here: [wiki:trunk]
+ * for important changes, make a note here: [wiki:SourceCode]
  * tell the project group if the results changed even for tiny changes. A new reference must then be done in the [http://webservices.ipsl.fr/trusting/ trusting].
  * if related to a ticket, add a link to the commit in the ticket using '''[Y]''', where Y is the revision number on the commit. Close the ticket if all questions are treated. 
 
 == Basic use of SVN ==
-See the section '''svn''' on the [wiki:Documentation/UserGuide How to] page...
+See also the section '''svn''' on the [wiki:Documentation/UserGuide].
+=== Create a new file ===
+Add a new file to the svn repository either by coping an existent, renaming or adding a new file. 
+
+{{{
+> svn cp file1 file2
+or
+> svn mv file1 file2
+or create first the file2 and then add it
+> svn add file2
+}}}
+
+All these commands will only add locally the file. To finally add them to the repository you must commit:
+
+{{{
+> svn -u stat
+> svn ci
+}}}
+
+
+=== Activate revision information ===
+If you added a new file, make sure also to activate the commit information in the header, after activation this should be done automatically at each commit. Add in the beginning of the file the following keywords : 
+{{{
+!! $HeadURL$
+!! $Date$
+!! $Revision$
+}}}
+ 
+Activate substitution by using propset and commit the file:
+{{{
+> svn propset svn:keywords "Date Revision HeadURL" file2.f90
+> svn ci file2.f90
+}}}
+
+
+After the commit it should look something like: 
+{{{
+!! $HeadURL: svn://forge.ipsl.jussieu.fr/orchidee/trunk/ORCHIDEE/src_sechiba/file2.f90 $
+!! $Date: 2015-09-21 13:37:38 +0200 (lun. 21 sept. 2015) $
+!! $Revision: 2928 $
+}}}
+
+