9 | | === Vocabulary === |
10 | | Both a branch and a personal copy are a line of development that exists independently of another line, yet still shares a common history if you look far enough back in time. They always begin life as a copy of the trunk or another branch, and moves on from there, generating its own history (http://svnbook.red-bean.com/en/1.7/svn.branchmerge.whatis.html). In the ORCHIDEE context branches are established for large research projects (i.e., a team of 5 persons working towards a common goal) or specific functionalities (i.e., a single person developing new functionality). This allows you to save your not-yet-completed work frequently without interfering with others' changes and while still selectively sharing information with your collaborators. |
| 9 | == Decide whether you need a branch or a personal copy == |
| 10 | Both a branch and a personal copy are a line of development that exists independently of another line, yet still shares a common history if you look far enough back in time. They always begin life as a copy of the trunk or another branch, and moves on from there, generating its own history (http://svnbook.red-bean.com/en/1.7/svn.branchmerge.whatis.html). |
| 11 | |
| 12 | In the ORCHIDEE context branches are established for large research projects (i.e., a team of 5 persons working towards a common goal) or specific functionalities (i.e., a one or two persons developing new functionality). This allows you to save your not-yet-completed work frequently without interfering with others' changes and while still selectively sharing information with your collaborators. |
| 13 | |
| 14 | In the ORCHIDEE context personal copies are established for a single person who will work on the trunk or a branch of ORCHIDEE. Personal copies are the typical choice for an MSc or PhD project. This allows you to save your not-yet-completed work frequently, and benefit from updates made on your parent-copy. |
| 15 | |
| 16 | The svn functionality of a branch and personal copy are identical, the choice is more driven by consideration related to project management than to technical consideration. Discuss with your supervisor or the ORCHIDEE-team what seems to be the most appropriate choice for the project you have in mind. |
| 17 | |
| 18 | |
| 19 | == Contact the right persons to deal with the tasks that require administrator rights == |
| 20 | First, ask for a login on svn and a personal folder on the svn repository. As this task requires administrator rights for the svn server, only few persons can help you with this task. If you want a quick answers send your request to the orchidee-help mailing list. The three administrators (Josefine, Fabienne and Nicolas Vuichard) will all receive this email. This is also a good time to decide whether you want to receive an alert every time someone of the ORCHIDEE-team has committed changes to svn. Note that you will receive emails of changes made to the trunk, all branches and personal copies. Expect tens of emails per week. By default you will NOT receive alerts, tell the administrators if you want to subscribe for svn-alerts. |
| 21 | |
| 22 | The svn administrators will create a folder for your branch or personal copy in the svn server using following syntax (example for a personal copy): |
| 23 | {{{ |
| 24 | svn mkdir svn://forge.ipsl.jussieu.fr/orchidee/perso/firstname.lastname |
| 25 | }}} |
| 26 | |
| 27 | Subsequently, the administrator will set read and write access for this new branch in the svn/conf/authz file at forge. Note that When a branch or personal copy has been created, its folder will be empty. |