|This section is currently out-of-date and may contain errors but is retained for historical reference. Additional guidance can be found via the Slicer Discussion Forum.|
- 1 Intro
- 2 Prerequisites
- 3 Make a local clone of Slicer
- 4 Optional - push it to your own github repository
- 5 Create a topic branch
- 6 Committing back to svn
- 7 How it looks in svn
- 8 Alternate Import from svn with History
- 9 Pull request from a git-svn tracking branch
- 10 Integrating topic from external contributor
- 11 More git resources
As of 2011 the 3D Slicer projects use subversion (svn) for the main repositories. Many project are switching to git and many developers prefer it, but feedback is also mixed about just how easy it is for a large distributed team to standardize on a set of workflows and stick with them (much anecdotal evidence and hearsay omitted).
But, individual developers or groups can use git for their work and then commit the results back to svn. The info here provides a brief set of hints for this.
Install git and git-svn on your machine (git svn is an add-on package, requiring an extra apt-get install on ubuntu).
For these instructions we'll assume you are using github so make yourself an account there (it's free and pretty simple). Configure the account with your email, name, and ssh keys. The git tutorials are never-ending, so don't try to read them all at once. The only way to get good with git is to play around with some dummy repositories while reading various documents until you feel reasonably confident with the way things work.
Update your git settings so that it remove directories from the SVN tree if there are no files left behind, configure it globaly:
git config --global svn.rmdir true
Make a local clone of Slicer
Then, check out a read-only version of Slicer your own copy and associate it with slicer's svn:
git clone git://github.com/Slicer/Slicer.git cd Slicer git svn init http://svn.slicer.org/Slicer4/trunk git update-ref refs/remotes/git-svn refs/remotes/origin/master git svn rebase
git://github.com/Slicer/Slicer.git is read-only, no one can push on it. A robot synchronizes the svn repository with the github repository (svn ->git, not git -> svn).
Optional - push it to your own github repository
First, fork the Slicer/Slicer.git project on github into your own account (this will save space on github):
- Go to https://github.com/Slicer/Slicer
- and click on the Fork button.
Then set up a 'git remote' (basically an alias) to your git hub repository:
cd Slicer git remote add pieperSlicer4 email@example.com:pieper/Slicer.git
(of course, replace occurrences of 'pieper' with your github username!).
The following command will populate the github master with your Slicer4 master (which is based on trunk).
git push pieperSlicer4 master
Create a topic branch
The 'branchy workflow' method of git is cool because all the changes related to a topic (meaning bug fix, feature addition, refactoring...) can be encapsulated in a lightweight branch that you can easily share with others.
Create a branch called "testbranch" for implementing our topic:
git checkout -b testbranch
(use 'git branch' to list branches and see that you are currently on the testbranch).
Now do some edits. If you create a new file, add it for tracking like so:
echo "new stuff" > newfile git add newfile
As you make the changes, commit them to your local copy and give descriptive comments:
git commit -am "ENH: added a new file with new stuff ..."
(in reality we prefer that you don't use the -m flag and instead us your editor to write a fairly long commit message with as much detail as you can stand to type). Also be sure to start your commit message with ENH, BUG, COMP, STYLE... for compatibility with the slicer svn rules.
Whenever you want to sync this up to github, just do:
git push pieperSlicer4 testbranch
Now if you look at the github repository it will have your new branch and commits. And you can easily email the link to the diffs off to your collaborators. They can review them, or check them out, make their own clones, or (with your permission) edit and commit back to your branch.
To work on the same branch on a different machine (for example, if you want to work out cross-platform build issues) you can checkout the repository and the create a tracking branch for your topic. Something like this:
git branch --track testbranch pieperSlicer4/testbranch
then you can push into that branch from the new machine as well.
Committing back to svn
Once you have the code from the branch just the way you want it, you can put it directly back into svn (do not merge it back into master).
While in the branch with the changes you want to commit, bring it in sync with svn by doing, essentially, the same as 'svn update':
git svn rebase
then you can commit
git svn dcommit --add-author-from
Note: you may need to use git commit --amend to edit the commit message to add "ENH:", "COMP:", "BUG:" etc. to be compatible with slicer svn.
Since we're done with this branch, we can clean it up:
git branch -D testbranch
(use the capital D to delete the branch even though it is not merged to master)
And, we can get rid of it off of github:
git push pieperSlicer4 testbranch --delete or git push pieperSlicer4 :testbranch
How it looks in svn
These are normal svn operations, so once they are commited (with dcommit) they show up as normal (example here is from Slicer3):
File created: http://viewvc.slicer.org/viewvc.cgi/Slicer3?view=revision&revision=15512 File modified: http://viewvc.slicer.org/viewvc.cgi/Slicer3?view=revision&revision=15514 File deleted (using svn, just for cleanliness): http://viewvc.slicer.org/viewvc.cgi/Slicer3?view=revision&revision=15513
Alternate Import from svn with History
This will pull the git-svn hash history from the existing repo, (avoids calculating from the beginning), then update to the current svn revision.
git svn clone -s -r 16923 http://svn.slicer.org/Slicer4
The -s says that slicer uses the standard trunk/tags/branches svn layout and the -r says grab the code at revision 16923 (just to keep things smaller). The command above tries to checkout the "trunk" branch of the svn repository, so revision 16923 must exist within the "trunk" branch. Note: use the URL http://svn.slicer.org/Slicer3 to access the Slicer3 svn repository.
Then update to get the most recent:
cd Slicer4 git svn fetch git checkout master
Jim needed an extra step here to have the checkout sit at HEAD and not at R16923
git svn rebase
Pull request from a git-svn tracking branch
If you have been running git-svn for any length of time, the commit hash history will have diverged from the Official Github history at http://github.com/Slicer/slicer. This will result in very dirty pull requests from your fork (no, you really don't want to merge 803 commits!)
To generate a "clean" pull request, do the following:
1) Add upstream
git remote add upstream https://github.com/Slicer/Slicer.git
2) Update, if any changes:
git fetch upstream/master (NOTE: don't use pull, it will generate nasty merge commits by default)
3) rebase the feature branch:
git rebase upstream/master myFeature
This will change the commit hash history to match that of upstream/master.
4) Now push the feature to github:
git push origin myFeature
It should now be possible to issue a clean pull request against Slicer/slicer with *only* the commits in myFeature listed by github.
Integrating topic from external contributor
The idea is to use the option
--add-author-from associated with
git svn dcommit so that a
From: field is added to the commit message.
From: Jean-Christophe Fillion-Robin <firstname.lastname@example.org>
Single patch approach
git checkout master git svn rebase git checkout -b 2885-add-ruler-projection-on-2D-viewers curl -O https://github.com/lchauvin/Slicer/commit/203b44301c0421d619d68e2ccd3a13dee0047cf0.patch git apply 203b44301c0421d619d68e2ccd3a13dee0047cf0.patch gitk # <- always check what's going on :-) git svn dcommit --add-author-from
git checkout master git svn rebase git checkout -b 2885-add-ruler-projection-on-2D-viewers git remote add laurent git://github.com/lchauvin/Slicer git fetch laurent git cherry-pick <the sha1 of the commit> gitk # <- always check what's going on :-) git svn dcommit --add-author-from
Complete topic approach
git checkout master git svn rebase git remote add laurent git://github.com/lchauvin/Slicer git fetch laurent git checkout -b 2885-add-ruler-projection-on-2D-viewers laurent/2885-add-ruler-projection-on-2D-viewers git svn rebase gitk <- always check what's going on :-) git svn dcommit --add-author-from
More git resources
(There is more info on git than anyone can really digest - unfortunately I often find that the information you need is not exactly described by the man page or tutorial you are currently reading. The only solution is to read widely, don't believe everything you read, skip the parts that seem too wordy or abstract, and experiment a lot.)
Here are a bunch of links that may help:
- A Visual Git Reference
- Git branching visual tutorial