Difference between revisions of "ITK/Git"

From KitwarePublic
< ITK
Jump to navigationJump to search
(Add the historical label after Change Id I5b79451da962c95614c65e09679bc8b5c12b6dea was merged)
 
(35 intermediate revisions by 9 users not shown)
Line 1: Line 1:
__TOC__
+
{{ Historical }}
 
 
ITK version tracking and development is hosted by [http://git-scm.com Git].
 
 
 
=Official Repository=
 
 
 
One may browse the repository online using the [http://git.wiki.kernel.org/index.php/Gitweb Gitweb] interface at http://itk.org/gitweb.
 
 
 
==Cloning==
 
 
 
Clone ITK using the command
 
 
 
$ git clone git://itk.org/ITK.git
 
 
 
If your institution's firewall blocks the Git port for outgoing connections you may see an error similar to:
 
 
 
Initialized empty Git repository in C:/abc/ITK/.git/itk.org[0: 66.194.253.19]:
 
errno=No such file or directory
 
fatal: unable to connect a socket (No such file or directory)
 
 
 
In that case, see [[#Firewall_Blocks_Port_9418|below]].
 
 
 
If you want to run tests, add the <code>--recursive</code> option to download the <code>Testing/Data</code> submodule.
 
 
 
$ git clone --recursive git://itk.org/ITK.git
 
 
 
This requires Git 1.6.5 or higher. If you do not have it, see [[#Git Below 1.6.5|below]].
 
 
 
All further commands work inside the local copy of the repository created by the clone:
 
 
 
$ cd ITK
 
 
 
If you already cloned and want to add the <code>Testing/Data</code> submodule then run
 
 
 
$ git submodule update --init
 
 
 
For ITKApps, use the url
 
 
 
git://itk.org/ITKApps.git
 
 
 
instead.
 
 
 
==Updating==
 
 
 
If you have made no local commits and simply want to update your clone with the latest changes, run
 
 
 
$ git pull
 
$ git submodule update
 
 
 
If you know you do not have the <code>Testing/Data</code> submodule checked out then you can skip the submodule update command.
 
 
 
==Branches==
 
 
 
At the time of this writing the repository has the following branches:
 
 
 
* '''master''': Development (default)
 
* '''release''': Release maintenance
 
* '''nightly-master''': Follows '''master''', updated at 01:00 UTC
 
* '''hooks''': Local commit hooks ([[Git/Hooks#Local|place]] in .git/hooks)
 
* '''dashboard''': Dashboard script (see [[#Dashboard|below]])
 
 
 
Release branches converted from CVS have been artificially merged into master.
 
Actual releases have tags named by the release version number.
 
 
 
After cloning your local repository will be configured to follow the upstream '''master''' branch by default.
 
One may create a local branch to track another upstream branch using [http://www.kernel.org/pub/software/scm/git/docs/git-checkout.html git checkout]:
 
 
 
$ git checkout -b release origin/release
 
 
 
As a shortcut with Git >= 1.6.5 one may choose a branch during the initial clone:
 
 
 
$ git clone -b release git://itk.org/ITK.git ITKRel
 
 
 
=Development=
 
 
 
We provide here a brief introduction to '''ITK''' development with Git.
 
See the [[Git/Resources|Resources]] page for further information such as Git tutorials.
 
  
 
==Introduction==
 
==Introduction==
  
We require all commits in ITK to record valid author/committer name and email information.
+
ITK version tracking and development is hosted by [http://git-scm.com Git].
Use [http://www.kernel.org/pub/software/scm/git/docs/git-config.html git config] to introduce yourself to Git:
+
Please select a task for further instructions:
  
$ git config --global user.name "Your Name"
+
{|border="0"
$ git config --global user.email "you@yourdomain.com"
+
|-
 
+
|width=70%|
Note that "Your Name" is your ''real name'' (e.g. "John Doe", not "jdoe").
+
Main Tasks:
While you're at it, optionally enable color output from Git commands:
 
 
 
$ git config --global color.ui auto
 
 
 
If less displays strange characters and no color, your LESS environment variable may already be set. You can override the less options with:
 
 
 
$ git config --global core.pager "less -FXRS"
 
 
 
The <code>--global</code> option stores the configuration settings in <code>~/.gitconfig</code> in your home directory so that they apply to all repositories.
 
 
 
==Hooks==
 
 
 
The '''hooks''' branch provides local commit hooks to be placed in <code>.git/hooks</code>.
 
It is shared by many <code>public.kitware.com</code> repositories.
 
 
 
See the general [[Git/Hooks|hooks]] information page to set up your local hooks.
 
 
 
==Workflow==
 
 
 
We've chosen to approximate our previous CVS-based development workflow after the initial move to Git, at least while things get settled.
 
The basic rule is to rebase your work on origin/master before pushing:
 
 
 
git fetch origin
 
git rebase origin/master
 
 
 
or
 
 
 
git pull --rebase
 
 
 
The server will refuse your push if it contains any merges.
 
Later we will move to a full [[Git/Workflow/Topic|branchy workflow]] based on topic branches.
 
 
 
==Topic Stage==
 
 
 
We provide a "[http://itk.org/stage/ITK.git ITK Topic Stage]" repository to which developers may publish arbitrary topic branches and request automatic merges.
 
 
 
The topic stage URLs are
 
 
 
* <code>git://itk.org/stage/ITK.git</code> (clone, fetch)
 
* <code>http://itk.org/stage/ITK.git</code> (clone, fetch, gitweb)
 
* <code>git@itk.org:stage/ITK.git</code> (push)
 
 
 
See our [http://public.kitware.com/Wiki/Git/Workflow/Stage Topic Stage Workflow] documentation for general instructions.
 
''(Currently ITK does not have a '''next''' branch.  Just skip that part of the instructions and merge directly to master.)''
 
When accessing the ITK stage, one may optionally substitute
 
"<code>ssh git@itk.org stage ITK ...</code>"
 
for
 
"<code>ssh git@public.kitware.com stage <repo> ...</code>"
 
in the ssh command-line interface.
 
 
 
{| border="0"
 
!colspan=2|Stage Usage Summary
 
 
|-
 
|-
|align="center"|
 
'''Initial Setup:'''
 
 
|
 
|
$ git remote add stage git://itk.org/stage/ITK.git
+
:*<span style="font-size: 1.5em">[[Git/Download|Install Git]]</span> - Git 1.6.6 or greater is preferred (required for development)
$ git config remote.stage.pushurl git@itk.org:stage/ITK.git
 
 
|-
 
|-
|align="center"|
 
'''Fetch Staged Topics:'''
 
 
|
 
|
$ git fetch stage --prune
+
:*<span style="font-size: 1.5em">[[ITK/Git/Download|Download ITK]] - Users start here</span>
 
|-
 
|-
|align="center"|
 
'''Create Local Topic:'''
 
 
|
 
|
$ git checkout -b ''topic-name'' origin/master
+
:*<span style="font-size: 1.5em">[[ITK/Git/Develop|Develop ITK]] - Contributors start here</span>
$ edit files
 
$ git commit
 
 
|-
 
|-
|align="center"|
 
'''Stage Current Topic:'''
 
 
|
 
|
$ git push stage HEAD
+
Other Tasks:
 
|-
 
|-
|align="center"|
 
'''Print Staged Topics:'''
 
 
|
 
|
$ ssh git@itk.org stage ITK print
+
:*<span style="font-size: 1.5em">[[ITK/Git/Dashboard|Test ITK]]</span> - CDash client setup
 
|-
 
|-
|align="center"|
 
'''Merge Staged Topic:'''
 
 
|
 
|
$ ssh git@itk.org stage ITK merge ''topic-name''
+
:*<span style="font-size: 1.5em">[[Git/Resources|Learn Git]]</span> - Third-party documentation
 
|}
 
|}
  
Note that the stage implementation is not ITK-specific and is used for other projects too.
+
''The remainder of this page provides reference information and links.  It is not intended to provide instructions.''
If the merge attempt conflicts it may print instructions for performing the merge manually.
 
'''Ignore''' these instructions; you will not be able to push the merge commit directly.
 
Instead, identify the commit that conflicts with yours, merge it into your topic locally, push the topic to the stage again, and then repeat the merge request.
 
  
=Publishing=
+
==Repositories==
  
==Pushing==
+
One may browse the repositories online using the [https://git.wiki.kernel.org/index.php/Gitweb Gitweb] interface at http://itk.org/gitweb.
  
Authorized developers may publish work directly to <code>itk.org/ITK.git</code> using Git's SSH protocol.
+
{|border="1" cellspacing="0" cellpadding="3"
To request access, fill out the [https://www.kitware.com/Admin/SendPassword.cgi Kitware Password] form.
+
!Repository
 +
!Purpose
 +
!Access
 +
!URL
 +
|-
 +
|rowspan=3|<code>ITK.git</code>
 +
|rowspan=3|Insight Toolkit
 +
|clone (git)
 +
|<code>git://itk.org/ITK.git</code>
 +
|-
 +
|clone (http)
 +
|<code>http://itk.org/ITK.git</code>
 +
|-
 +
|push (ssh)
 +
|<code>git@itk.org:ITK.git</code>
 +
|-
 +
|rowspan=3|<code>stage/ITK.git</code>
 +
|rowspan=3|ITK Topic Stage
 +
|clone (git)
 +
|<code>git://itk.org/stage/ITK.git</code>
 +
|-
 +
|clone (http)
 +
|<code>http://itk.org/stage/ITK.git</code>
 +
|-
 +
|push (ssh)
 +
|<code>git@itk.org:stage/ITK.git</code>
 +
|-
 +
|rowspan=3|<code>ITKApps.git</code>
 +
|rowspan=3|Insight Applications
 +
|clone (git)
 +
|<code>git://itk.org/ITKApps.git</code>
 +
|-
 +
|clone (http)
 +
|<code>http://itk.org/ITKApps.git</code>
 +
|-
 +
|push (ssh)
 +
|<code>git@itk.org:ITKApps.git</code>
 +
|-
 +
|rowspan=3|<code>ITKData.git</code>
 +
|rowspan=3|ITK <code>Testing/Data</code> Submodule
 +
|clone (git)
 +
|<code>git://itk.org/ITKData.git</code>
 +
|-
 +
|clone (http)
 +
|<code>http://itk.org/ITKData.git</code>
 +
|-
 +
|push (ssh)
 +
|<code>git@itk.org:ITKData.git</code>
 +
|}
  
See the [[Git/Publish#Push_Access|push instructions]] for details.
+
==Branches==
  
For ITK, configure the push URL:
+
At the time of this writing the <code>ITK.git</code> repository has the following branches:
  
git config remote.origin.pushurl git@itk.org:ITK.git
+
* '''master''': Development (default)
 +
* '''release''': Maintenance of latest release
 +
* '''release-3.20''': Maintenance of the ITKv3 series
 +
* '''nightly-master''': Follows '''master''', updated at 01:00 UTC
 +
* '''hooks''': Local commit hooks ([[Git/Hooks#Local|place]] in .git/hooks)
 +
* '''dashboard''': Dashboard script ([[ITK/Git/Dashboard|setup]] a CDash client)
  
For ITKApps, configure the push URL:
+
Release branches converted from CVS have been artificially merged into master.
 
+
Actual releases have tags named by the release version number.
git config remote.origin.pushurl git@itk.org:ITKApps.git
 
 
 
===Update Hook===
 
 
 
The itk.org repository has an <code>update</code> hook.
 
When someone tries to push changes to the repository it checks the commits as documented [[Git/Hooks#update|here]].
 
 
 
=Testing=
 
 
 
==Dashboard==
 
 
 
The [[#Branches| dashboard]] branch contains a dashboard client helper script.
 
Use these commands to track it:
 
 
 
$ mkdir -p ~/Dashboards/ITKScripts
 
$ cd ~/Dashboards/ITKScripts
 
$ git init
 
$ git remote add -t dashboard origin git://itk.org/ITK.git
 
$ git pull origin
 
 
 
The <code>itk_common.cmake</code> script contains setup instructions in its top comments.
 
Update the '''dashboard''' branch to get the latest version of this script by simply running
 
 
 
$ git pull origin
 
 
 
= Contributing Patches =
 
 
 
Contributions of bug fixes and features are commonly produced by the community. This section describes a convenient method for managing such contributions.
 
 
 
== Generating a Patch ==
 
 
 
This content is based on [http://progit.org/book/ch5-2.html Pro Git Book, Chapter 5: Distributed Git]
 
 
 
The typical scenario
 
 
 
* You are a user
 
* Just found a bug
 
* Figured out how to fix it
 
* Want to contribute the fix back to the ITK repository
 
 
 
You can safely create your patch with the following sequence
 
 
 
# Create a branch
 
# Commit your changes to it
 
# Generate a patch
 
# Send the patch via email (or attach it to a report in the bug tracker)
 
 
 
This can be done with the following commands
 
 
 
  git checkout -b  cool_name_for_branch_for_my_bug_fix_here
 
  git add          name_of_the_file_that_I_changed_to_fix_the_bug
 
  git commit
 
 
 
and to generate a patch, finally you do
 
 
 
  git format-patch -M origin/master
 
 
 
This will generate a file for each one of the commits that you did in that branch. The files will have extension .patch, and if you look at their content, it will be a plain text with the format of an email that you can send to the maintainers.
 
 
 
NOTE: if you are a brave Linux user, you can also configure git to send email directly with the command "git send-email"
 
 
 
== Applying a Patch ==
 
 
 
This content is based on [http://progit.org/book/ch5-2.html Pro Git Book, Chapter 5: Distributed Git]
 
 
 
We assume here that you got a .patch file from a contributor.
 
 
 
This file may have arrived to you as:
 
 
 
* A file attached to an email, or
 
* An email, or
 
* A file attached to a bug tracker report
 
 
 
Save this .patch file to your disk.
 
 
 
Then use the git command
 
 
 
  git  am  filename_of_cool_bug_fix.patch
 
 
 
Verify the patch content with
 
 
 
  git log --pretty-fuller -1
 
 
 
Build the code in order to verify the correctness of the patch
 
 
 
Finally, push it to the repository where you want to publish the patch.
 
 
 
=Troubleshooting=
 
 
 
==Firewall Blocks Port 9418==
 
 
 
Some institutions have firewalls that block Git's native protocol port 9418.
 
Use the "<code>url.<base>.insteadOf</code>" configuration option to map git URLs to http:
 
 
 
<pre>
 
$ git config --global url.http://itk.org/.insteadOf git://itk.org/
 
</pre>
 
 
 
This tells Git to translate URLs under the hood by replacing prefixes.
 
After running these commands ''once'' in your home directory then you can just use the "<code>git://</code>" mentioned elsewhere on this page and git will use the http protocol automagically.
 
 
 
==Git Below 1.6.5==
 
 
 
To clone ITK using Git 1.6.4 or lower, use the commands
 
 
 
$ git clone git://itk.org/ITK.git
 
$ cd ITK
 
$ git submodule init
 
$ git submodule update
 
 
 
== The remote end hung up unexpectedly ==
 
 
 
If <code>git push</code> fails with
 
 
 
fatal: The remote end hung up unexpectedly
 
 
 
check that you set the pushurl with "<code>git config</code>".
 
See the [[#Pushing|push instructions]].
 
 
 
If you suspect your ssh key may not be configured correctly, see the [[Git/Publish#Authentication_Test|authentication test]] instructions.
 
 
 
=Tips=
 
 
 
==Tip: Renaming==
 
 
 
Git does not explicitly track renames.  The command
 
 
 
$ git mv old new
 
 
 
is equivalent to
 
 
 
$ mv old new
 
$ git add new
 
$ git rm old
 
 
 
Neither approach records the rename outright.
 
However, Git's philosophy is "''dumb add, smart view''".
 
It uses heuristics to ''detect'' renames when viewing history after-the-fact.
 
It even works when the content of a renamed file changes slightly.
 
 
 
In order to help Git efficiently detect the rename, it is important to remove the old file and add the new one in ''one commit'', perhaps by using <code>git mv</code> or the above 3-step procedure.
 
If the new file were added in one commit and the old file removed in the next, Git would report this as a copy followed by a removal.
 
It's copy-detection heuristics are more computationally intensive and must be explicitly enabled with the <code>-C</code> option to relevant operations (such as <code>git blame</code>).
 
 
 
=Resources=
 
 
 
Additional information about Git may be obtained at sites listed [[Git/Resources|here]].
 

Latest revision as of 09:51, 6 October 2017

Introduction

ITK version tracking and development is hosted by Git. Please select a task for further instructions:

Main Tasks:

  • Install Git - Git 1.6.6 or greater is preferred (required for development)

Other Tasks:

The remainder of this page provides reference information and links. It is not intended to provide instructions.

Repositories

One may browse the repositories online using the Gitweb interface at http://itk.org/gitweb.

Repository Purpose Access URL
ITK.git Insight Toolkit clone (git) git://itk.org/ITK.git
clone (http) http://itk.org/ITK.git
push (ssh) git@itk.org:ITK.git
stage/ITK.git ITK Topic Stage clone (git) git://itk.org/stage/ITK.git
clone (http) http://itk.org/stage/ITK.git
push (ssh) git@itk.org:stage/ITK.git
ITKApps.git Insight Applications clone (git) git://itk.org/ITKApps.git
clone (http) http://itk.org/ITKApps.git
push (ssh) git@itk.org:ITKApps.git
ITKData.git ITK Testing/Data Submodule clone (git) git://itk.org/ITKData.git
clone (http) http://itk.org/ITKData.git
push (ssh) git@itk.org:ITKData.git

Branches

At the time of this writing the ITK.git repository has the following branches:

  • master: Development (default)
  • release: Maintenance of latest release
  • release-3.20: Maintenance of the ITKv3 series
  • nightly-master: Follows master, updated at 01:00 UTC
  • hooks: Local commit hooks (place in .git/hooks)
  • dashboard: Dashboard script (setup a CDash client)

Release branches converted from CVS have been artificially merged into master. Actual releases have tags named by the release version number.