Changes between Version 2 and Version 3 of Chimera2/git

Timestamp:

May 3, 2013, 11:28:53 AM (13 years ago)

Author:

Conrad Huang

Comment:

--

Chimera2/git

@@ -7 +7 @@
 The remainder of this document describes some common tasks using '''git'''.
 
-== Create Developer Repository on plato ==
+== Cloning a Developer Repository ==
+
+To make changes to the source code, a developer must have a working repository.  The repository may be on the same host as the team repository, or it may be on a separate host.
+
+The following example shows the steps for creating a repository in the same directory, ''/usr/local/projects/chimera/git'', as the team repository.  Developer repositories do not need to be the the same directory as the team repository.  The last argument to '''git clone''' specifies the location where the developer repository will be created and it may be a full path.  However, the web server on the cluster is configured to simplify accessing files below ''/usr/local/projects/chimera/git'' (see NotYetWritten), for example, for viewing changes to HTML files; so it may be more convenient to have developer repositories there than elsewhere.
+
+After cloning the repository, it is necessary to initialize it for '''git flow''', the tool for managing branches.  The '''-d''' flag specifies that the default branch names for development and feature branches be used.  Even if there is no plan to use '''git flow''' operations, executing this command is useful since it checks out the '''develop''' branch rather than leaving the repository on the '''master''' branch, which should only be modified during releases.
+
+{{{#!html
+<pre style="margin-left:20px; margin-right:20px; border:solid 1px; padding:3px; background:white;">
+<b style="color:#c22;">franklin:~ conrad$ cd /usr/local/projects/chimera2/git</b>
+<b style="color:#c22;">franklin:git conrad$ git clone chimera2.git myrepo</b>
+Initialized empty Git repository in /usr/local/projects/chimera2/git/myrepo/.git/
+<b style="color:#c22;">franklin:git conrad$ cd myrepo</b>
+/usr/local/projects/chimera2/git/myrepo
+<b style="color:#c22;">franklin:myrepo conrad$ git flow init -d</b>
+Using default branch names.
+
+Which branch should be used for bringing forth production releases?
+   - master
+Branch name for production releases: [master]
+Branch name for "next release" development: [develop]
+
+How to name your supporting branch prefixes?
+Feature branches? [feature/]
+Release branches? [release/]
+Hotfix branches? [hotfix/]
+Support branches? [support/]
+Version tag prefix? []
+<b style="color:#c22;">franklin:myrepo conrad$ ls -l</b>
+total 36
+drwxrwxr-x  4 conrad ferrin 3864 May  3 11:01 docs/
+-rw-rw-r--  1 conrad ferrin  183 May  3 11:01 index.html
+-rw-rw-r--  1 conrad ferrin  657 May  3 11:01 Makefile
+drwxrwxr-x  2 conrad ferrin 3864 May  3 11:01 mk/
+drwxrwxr-x 28 conrad ferrin 3864 May  3 11:01 prereqs/
+-rw-rw-r--  1 conrad ferrin 1262 May  3 11:01 README.rst
+drwxrwxr-x  7 conrad ferrin 3864 May  3 11:01 src/
+-rwxrwxr-x  1 conrad ferrin 3589 May  3 11:01 vsvars.sh*
+drwxrwxr-x  3 conrad ferrin 3864 May  3 11:01 webdemo/
+</pre>
+}}}
+
+Alternatively, a developer may use a repository on his own workstation rather than the cluster.  Below is an example of creating a clone on the remote host, <b>loft</b>, running Cygwin on Windows 7.  The <b>ssh</b> agent has already been initialized, so no passwords are required.  The steps after '''git clone''' are effective the same as the example above.
+
+{{{#!html
+<pre style="margin-left:20px; margin-right:20px; border:solid 1px; padding:3px; background:white;">
+<b style="color:#c22;">[loft - /e]$ git clone \
+  ssh://conrad@plato.cgl.ucsf.edu/usr/local/projects/chimera2/git/chimera2.git \
+  chimera2</b>
+Cloning into 'chimera2'...
+remote: Counting objects: 556, done.
+remote: Compressing objects: 100% (533/533), done.
+remote: Total 556 (delta 170), reused 275 (delta 16)
+Receiving objects: 100% (556/556), 311.17 MiB | 621 KiB/s, done.
+Resolving deltas: 100% (170/170), done.
+<b style="color:#c22;">[loft - /e]$ cd chimera2</b>
+/e/chimera2
+<b style="color:#c22;">[loft - /e/chimera2]$ git flow init -d</b>
+Using default branch names.
+
+Which branch should be used for bringing forth production releases?
+   - master
+Branch name for production releases: [master]
+Branch name for "next release" development: [develop]
+
+How to name your supporting branch prefixes?
+Feature branches? [feature/]
+Release branches? [release/]
+Hotfix branches? [hotfix/]
+Support branches? [support/]
+Version tag prefix? []
+<b style="color:#c22;">[loft - /e/chimera2]$ ls -l</b>
+total 26
+-rw-r--r--+ 1 conrad None  657 May  3 10:51 Makefile
+-rw-r--r--+ 1 conrad None 1262 May  3 10:51 README.rst
+drwxr-xr-x+ 1 conrad None    0 May  3 10:51 docs/
+-rw-r--r--+ 1 conrad None  183 May  3 10:51 index.html
+drwxr-xr-x+ 1 conrad None    0 May  3 10:51 mk/
+drwxr-xr-x+ 1 conrad None    0 May  3 10:51 prereqs/
+drwxr-xr-x+ 1 conrad None    0 May  3 10:51 src/
+-rwxr-xr-x+ 1 conrad None 3589 May  3 10:51 vsvars.sh*
+drwxr-xr-x+ 1 conrad None    0 May  3 10:51 webdemo/
+</pre>
+}}}
 == Use ''develop'' Branch Directly for Development ==
 == Use Feature Branch for Development ==
 == Stash Modified Files before Switching Branches ==
-== Create Remote Repository ==
 == Use plato Repository to Coordinate Development on Multiple Hosts ==
 == Create Team Repository ==