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


Ignore:
Timestamp:
2020-02-28T10:47:44+01:00 (4 years ago)
Author:
luyssaert
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/UserGuide/svnBranchePerso

    v9 v10  
    44Last revision: 2020/02/28, S. Luyssaert 
    55 
    6 === Objective === 
    7 This item should help you to: (1) decide whether you need a branch or a personal copy, (2) contact the right persons to deal with the tasks that require administrator rights, and (3)  
     6== Objectives == 
     7This item should help you to: (1) decide whether you need a branch or a personal copy, (2) contact the right persons to deal with the tasks that require administrator rights, and (3) benefit from svn to save and share your developments.  
    88 
    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 ==  
     10Both 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 
     12In 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 
     14In 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 
     16The 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 == 
     20First, 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 
     22The 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{{{ 
     24svn mkdir svn://forge.ipsl.jussieu.fr/orchidee/perso/firstname.lastname 
     25}}} 
     26 
     27Subsequently, 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. 
    1128 
    1229 
    13  
     30== benefit from svn to save and share your developments == 
    1431 
    1532Here is some short help on how to create and commit in a personal directory or a branche.  
    1633 
    1734== Create your personal folder == 
    18 First, ask for a login on svn and a personal folder on the svn repository: use orchidee-help mailing list.  
    19 At the beginning, your personal folder is empty. 
    20  
    21 SVN administrators can create a personal folder using following syntax: 
    22 {{{ 
    23 svn mkdir svn://forge.ipsl.jussieu.fr/orchidee/perso/toto.tata 
    24 }}} 
    25 The administrator also needs to add read/write access for this new branch in the svn/conf/authz file at forge.  
    2635 
    2736