Difference between revisions of "VTK/Git"

From KitwarePublic
< VTK
Jump to navigationJump to search
(Replaced content with "The instructions previously available on this page have been superseded. See [https://gitlab.kitware.com/vtk/vtk/blob/master/Documentation/dev/git/README.md here].")
 
(72 intermediate revisions by 10 users not shown)
Line 1: Line 1:
__TOC__
+
The instructions previously available on this page have been superseded.  See [https://gitlab.kitware.com/vtk/vtk/blob/master/Documentation/dev/git/README.md here].
 
 
VTK 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://vtk.org/gitweb.
 
 
 
==Cloning==
 
 
 
One may clone the repository using [http://www.kernel.org/pub/software/scm/git/docs/git-clone.html git clone] through the native <code>git</code> protocol:
 
 
 
$ git clone git://vtk.org/VTK.git VTK
 
 
 
or through the (less efficient) <code>http</code> protocol:
 
 
 
$ git clone http://vtk.org/VTK.git VTK
 
 
 
All further commands work inside the local copy of the repository created by the clone:
 
 
 
$ cd VTK
 
 
 
For VTKData the URLs are
 
 
 
git://vtk.org/VTKData.git
 
http://vtk.org/VTKData.git
 
 
 
==Branches==
 
 
 
At the time of this writing the repository has the following branches:
 
 
 
* '''master''': Development (default)
 
* '''hooks''': Local commit hooks ([[Git/Hooks#Local|place]] in .git/hooks)
 
 
 
Release branches converted from CVS have been artificially merged into master.
 
Actual releases have tags named by the release version number.
 
 
 
=Development=
 
 
 
We provide here a brief introduction to '''VTK''' development with Git.
 
See the [[#Resources|Resources]] below for further information such as Git tutorials.
 
 
 
==Introduction==
 
 
 
We require all commits in VTK to record valid author/committer name and email information.
 
Use [http://www.kernel.org/pub/software/scm/git/docs/git-config.html git config] to introduce yourself to Git:
 
 
 
$ git config --global user.name "Your Name"
 
$ git config --global user.email "you@yourdomain.com"
 
 
 
Note that "Your Name" is your ''real name'' (e.g. "John Doe", not "jdoe").
 
While you're at it, optionally enable color output from Git commands:
 
 
 
  $ git config --global color.ui auto
 
 
 
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 [http://public.kitware.com/Wiki/Git/Workflow/Topic branchy workflow] based on topic branches.
 
 
 
We already provide support for topic branches and merges through the VTK Topic Stage described in the next section.
 
 
 
==Topic Stage==
 
 
 
We provide a "[http://vtk.org/stage/VTK.git VTK Topic Stage]" repository to which developers may publish arbitrary topic branches and request automatic merges.
 
 
 
The topic stage URLs are
 
 
 
* <code>git://vtk.org/stage/VTK.git</code> (clone, fetch)
 
* <code>http://vtk.org/stage/VTK.git</code> (clone, fetch, gitweb)
 
* <code>git@vtk.org:stage/VTK.git</code> (push)
 
 
 
See our [http://public.kitware.com/Wiki/Git/Workflow/Stage Topic Stage Workflow] documentation for general instructions.
 
''(Currently VTK does not have a '''next''' branch.  Just skip that part of the instructions and merge directly to master.)''
 
When accessing the VTK stage, one may optionally substitute
 
"<code>ssh git@vtk.org stage VTK ...</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://vtk.org/stage/VTK.git
 
$ git config remote.stage.pushurl git@vtk.org:stage/VTK.git
 
|-
 
|align="center"|
 
'''Fetch Staged Topics:'''
 
|
 
$ git fetch stage --prune
 
|-
 
|align="center"|
 
'''Create Local Topic:'''
 
|
 
$ git checkout -b ''topic-name'' origin/master
 
$ edit files
 
$ git commit
 
|-
 
|align="center"|
 
'''Stage Current Topic:'''
 
|
 
$ git push stage HEAD
 
|-
 
|align="center"|
 
'''Print Staged Topics:'''
 
|
 
$ ssh git@vtk.org stage VTK print
 
|-
 
|align="center"|
 
'''Merge Staged Topic:'''
 
|
 
$ ssh git@vtk.org stage VTK merge ''topic-name''
 
|}
 
 
 
Note that the stage implementation is not VTK-specific and is used for other projects too.
 
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=
 
 
 
Authorized developers may publish work directly to <code>vtk.org/VTK.git</code> using Git's SSH protocol.
 
 
 
Note that ''we may not grant all contributors push access'' to the <code>vtk.org</code> repository.
 
The distributed nature of Git allows contributors to retain authorship credit even if they do not publish changes directly.
 
 
 
If you are an external contributor without push access, you can submit a patch to the vtk-developers mailing list, see [[#Submitting_a_patch]].
 
 
 
==Authentication==
 
 
 
All publishers share the <code>git@vtk.org</code> account but each uses a unique ssh key for authentication.
 
If you do not have a public/private ssh key pair, generate one:
 
 
 
$ ssh-keygen -C 'you@yourdomain.com'
 
Generating public/private rsa key pair.
 
Enter file in which to save the key ($HOME/.ssh/id_rsa):
 
Enter passphrase (empty for no passphrase): (use-a-passphrase!!)
 
Enter same passphrase again: (use-same-passphrase!!)
 
Your identification has been saved in $HOME/.ssh/id_rsa.
 
Your public key has been saved in $HOME/.ssh/id_rsa.pub.
 
 
 
To request access, fill out the [https://www.kitware.com/Admin/SendPassword.cgi Kitware Password] form.
 
Include your ssh public key, '''<code>id_rsa.pub</code>''', and a reference to someone our administrators may contact to verify your privileges.
 
 
 
===Generating an ssh key on Windows===
 
 
 
If you are familiar with generating an ssh key on Linux or Mac, you can follow the same procedure on Windows in a "Git Bash" prompt. There is an ssh-keygen program installed with msysGit to help you set up an ssh identity on a Windows machine. By default it puts the ".ssh" directory in the HOME directory, which is typically "/c/Users/Username" on Vista and Windows 7; on XP, it's "/c/Documents and Settings/Username".
 
 
 
Alternatively, you can also set up a "normal" Windows command prompt shell such that it will work with msysGit, without ever invoking the Git Bash prompt if you like. If you install msysGit and accept all its default options, "git" will not be in the PATH. However, if you add "C:\Program Files (x86)\Git\cmd" to your PATH, then only the two commands '''git''' and '''gitk''' are available to use via *.cmd script wrappers installed by msysGit. Or, if you add "C:\Program Files (x86)\Git\bin" to your PATH, then '''all''' of the command line tools that git installs are available.
 
 
 
The full PuTTY suite of tools includes an application called PuTTYgen. If you already have a private key created with PuTTYgen, you may export it to an OpenSSH identity file. Open the key using PuTTYgen and choose "Conversions > Export OpenSSH key" from the menu bar. That will allow you to save an "id_rsa" file for use in the ".ssh" directory. You can also copy and paste the public key portion of the key from the PuTTYgen text field to save into an "id_rsa.pub" file if you like. Or email it to whoever needs the public side of your key pair.
 
 
 
If you routinely set up your own command prompt environment on Windows, using msysGit from that envrionment is a cinch: just add the full path to either Git\cmd or Git\bin to your PATH. (Or, write your own git.cmd wrapper that is in your PATH that simply calls the git.cmd installed with msysGit.) And make sure you have a HOME environment variable that points to the place where the .ssh directory is.
 
 
 
==Pushing==
 
 
 
Git automatically configures a new clone to refer to its origin through a [http://www.kernel.org/pub/software/scm/git/docs/git-remote.html remote] called <code>origin</code>.
 
Initially one may [http://www.kernel.org/pub/software/scm/git/docs/git-fetch.html fetch] or [http://www.kernel.org/pub/software/scm/git/docs/git-pull.html pull] changes from <code>origin</code>,
 
but may not [http://www.kernel.org/pub/software/scm/git/docs/git-push.html push] changes to it.
 
 
 
In order to publish new commits in the <code>vtk.org</code> repository, developers must configure a ''push URL'' for the <code>origin</code>.
 
Use [http://www.kernel.org/pub/software/scm/git/docs/git-config.html git config] to specify an ssh-protocol URL:
 
 
 
$ git config remote.origin.pushurl git@vtk.org:VTK.git
 
 
 
(Note that 'pushurl' requires Git >= 1.6.4.  Use just 'url' for Git < 1.6.4.)
 
 
 
Failing to do so with result in the following error message: "fatal: The remote end hung up unexpectedly".
 
 
 
Once your push URL is configured and your key is installed for <code>git@vtk.org</code> then you can try pushing changes.
 
 
 
For VTKData, the push URL is
 
 
 
git@vtk.org:VTKData.git
 
 
 
===Update Hook===
 
 
 
The vtk.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]].
 
 
 
==Patches==
 
 
 
===Submitting a patch===
 
If you are an external contributor without push access, you can submit a patch to the vtk-developers mailing list.
 
# subscribe to the vtk-developers mailing list: http://www.vtk.org/mailman/listinfo/vtk-developers
 
# prepare your patch:
 
<pre>
 
# 1. pull from the central repository with rebase, not merge
 
$ cd VTK
 
$ git pull --rebase
 
</pre>
 
<pre>
 
# 2. create the patch
 
$ git format-patch
 
</pre>
 
3. send the patch to the vtk-developers list
 
 
 
A contributor with push access will be able to apply the patch and push it to the central repository. See the following section to apply a patch [[#Applying_a_patch]] .
 
 
 
ref: [http://www.kernel.org/pub/software/scm/git/docs/everyday.html#Individual%20Developer%20%28Participant%29 Everyday GIT: Individual Developer (Participant)]
 
 
 
===Applying a patch===
 
When you receive a patch by email, you can apply it locally with:
 
<pre>
 
$ cd VTK
 
$ git am -3 -i -s -u patch.txt
 
</pre>
 
 
 
If the following error happens:
 
<pre>
 
Patch format detection failed.
 
</pre>
 
It means the patch was not generated with <tt>git format-patch</tt> but with <tt>git show</tt>
 
 
 
To apply a patch generated with <tt>git show</tt>, use
 
<pre>
 
$ cd VTK
 
$ git apply --whitespace=fix patch.txt
 
</pre>
 
 
 
Now you have applied the patch, you can review it and test it.
 
 
 
If you are a contributor with push access, you can decide to reject or accept the patch and maybe apply additional commits. At this point, you are ready to publish the patch to the central repository [[#Publishing]] .
 
 
 
ref: [http://www.kernel.org/pub/software/scm/git/docs/everyday.html#Integrator Everyday GIT: Integrator]
 
 
 
= Troubleshooting =
 
== fatal: The remote end hung up unexpectedly ==
 
* If <tt>git push</tt> fails with "fatal: The remote end hung up unexpectedly", you probably forgot to set the push url with "git config" see [[#Pushing]].
 
 
 
== Restoring files locally ==
 
Q: "I cloned the VTK repository. Now I "rm -rf Hybrid". How do I get it back?"<br>
 
A: git checkout Hybrid<br>
 
Q: "I modified a file locally. I want to revert it."<br>
 
A: git checkout myfile.cxx
 
 
 
=Resources=
 
 
 
Additional information about Git may be obtained at these sites:
 
 
 
* [http://git-scm.com Git Homepage]
 
* [http://git.wiki.kernel.org/index.php/GitDocumentation Git Documentation Wiki]
 
* [http://book.git-scm.com/ Git Community Book]
 
* [http://www.kernel.org/pub/software/scm/git/docs/everyday.html Everyday Git]
 
* [http://github.com/guides/git-cheat-sheet Git Cheat-Sheet]
 
* [http://progit.org/book/ Pro Git]
 
* [http://marklodato.github.com/visual-git-guide/ A Visual Git Reference]
 

Latest revision as of 15:42, 16 March 2015

The instructions previously available on this page have been superseded. See here.