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].")
 
(19 intermediate revisions by 5 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==
 
 
 
These instructions assume a command prompt is available with <code>git</code> in the path.
 
See our Git [[Git/Download|download instructions]] for help installing Git.
 
 
 
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
 
 
 
For VTKLargeData the URLs are
 
 
 
git://vtk.org/VTKLargeData.git
 
http://vtk.org/VTKLargeData.git
 
 
 
==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)
 
 
 
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 [[Git/Resources|Resources]] page for further information such as Git tutorials.
 
 
 
==Quick Start Guide==
 
 
 
If you would like to get up and running quickly, we recommend you follow the [[VTK/Git/Simple|simple Git guide]]. It will guide you through getting your development environment setup, working on topic branches and merging your changes back into master.
 
 
 
==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 have now moved to use a branchy workflow, [http://public.kitware.com/Wiki/Git/Workflow/Topic branchy workflow] based on topic branches. We do not have a next integration branch at this point, and so you should ignore any reference to that and merge straight to master. The next section describes use of the topic stage, [[VTK/Git/Simple|simplified guide]] can be followed using supplied scripts and aliases.
 
 
 
==Gerrit==
 
 
 
If you have a patch that you want to be considered for inclusion in VTK, you can submit it to [http://review.source.kitware.com/ gerrit]. To register on gerrit, use the following steps:
 
 
 
# Get an [http://openid.net/get-an-openid/ OpenID]
 
# Register at http://review.source.kitware.com using your OpenID (link in upper right)
 
# Set all fields in your profile at http://review.source.kitware.com/#settings
 
# Add your ssh public key at http://review.source.kitware.com/#settings,ssh-keys
 
 
 
You will then be ready to submit patches.  A typical patch for gerrit will be a topic branch that includes a single commit.  If your branch has multiple commits you should use "git rebase -i" to squash the commits into a single commit, or if this is not reasonable, then consider pushing your branch to github or to some other external site for review.  Your topic branch should be based on either the release or the master, depending on where you want it to go.  An example workflow is as follows:
 
 
 
{| border="0"
 
!colspan=2|Gerrit Usage Summary
 
|-
 
|align="center"|
 
'''Initial Setup:'''
 
|
 
$ git remote add gerrit USERNAME@review.source.kitware.com:VTK
 
|-
 
|align="center"|
 
'''Create topic branch:'''
 
|
 
$ git checkout master
 
$ git pull (i.e. get your local repository up-to-date)
 
$ git checkout -b topic-branch-to-create
 
|-
 
|align="center"|
 
'''Push to Gerrit:'''
 
|
 
$ edit files
 
$ git commit
 
$ git gerrit-push (alias for git push gerrit HEAD:refs/for/master/topic-name)
 
|-
 
|align="center"|
 
'''Revise a Gerrit topic:'''
 
|
 
$ edit files
 
$ git commit --amend
 
$ verify that the commit log ends with the correct Change-Id
 
$ git gerrit-push
 
|-
 
|align="center"|
 
'''Revise topic that has multiple commits:'''
 
|
 
$ git rebase -i HEAD~2 (number depends on number of commits)
 
$ verify that the commit log ends with the correct Change-Id
 
$ git gerrit-push
 
|-
 
|align="center"|
 
'''Merge topic into VTK (for those with access)'''
 
|
 
$ git stage-push (alias for git push stage HEAD)
 
$ git stage-merge (alias for ssh git@vtk.org stage VTK merge topic-name)
 
|}
 
 
 
To get your patch reviewed, go to [http://review.source.kitware.com/ http://review.source.kitware.com/] and add reviewers for your patch.  Alternatively, you can post an email to the vtk-developers list asking for reviewers.  If you do not have commit access for VTK, ask one of the reviewers to merge your topic into VTK.
 
 
 
==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.  To follow this workflow, you should have git version 1.7 or greater.
 
 
 
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''
 
|-
 
|align="center"|
 
'''Check out Staged Topic:'''
 
|
 
$ git fetch stage
 
$ git checkout -b ''topic-name'' remotes/stage/''topic-name''
 
|-
 
|align="center"|
 
'''Abandon/Delete Staged Topic:'''
 
|
 
$ git push stage :''topic-name''
 
 
 
|}
 
 
 
If the merge attempt conflicts follow the printed instructions.
 
 
 
==Github==
 
 
 
The VTK repository is mirrored on github.  Experimental branches that are not ready for staging can be published on github for review.
 
 
 
The first step in creating a github branch is to create an account on github and make a fork of [http://github.com/Kitware/VTK http://github.com/Kitware/VTK].  Since this fork will be a mirror of the VTK master, there is no need to clone it on your local machine.  Instead, you will just want to set github as an alternative remote in your existing local copy of the VTK git repository.
 
 
 
To set github as an alternative remote, use the following commands:
 
 
 
{| border="0"
 
!colspan=2|Github Usage Summary
 
|-
 
|align="center"|
 
'''Remote Setup:'''
 
|
 
$ git remote add github git@github.com:yourname/VTK.git
 
$ git config remote.github.pushurl git@github.com:yourname/VTK.git
 
|-
 
|align="center"|
 
'''Update the Remote:'''
 
|
 
# update from Kitware's master and push to github
 
$ git pull
 
$ git push github HEAD
 
|-
 
|align="center"|
 
'''Push Branch to Github:'''
 
|
 
$ git checkout -b some-branch github/master
 
# edit files and commit changes
 
$ git push github HEAD
 
|}
 
 
 
The second step above should be done regularly on your master, in order to keep your github fork up-to-date with the VTK master.  Do not use github's graphical interface for merging commits, it creates new commits by rebasing the commits you select against your VTK fork.  These new commits will be very difficult to merge back into VTK master.
 
 
 
The checkout command in the third step will automatically set github as the default remote for the new branch, but you still must specify "github HEAD" when you push or else you will push to the github master branch, instead of pushing to a new github branch.  Also, since it bases the branch on your github fork, you should perform step 2 before creating the branch to make sure that your fork is up-to-date.  This is just a suggestion, as it is always possible to rebase or merge at a later time.
 
 
 
The default remotes for each of your branches are controlled by entries such as this in your  .git/config file:
 
 
 
[branch "my-branch-name"]
 
remote = github
 
merge = refs/heads/my-branch-name
 
 
 
You can edit this file to make github the default remote and to set the remote branch name for your existing branches.  Or you can always use "git push github HEAD" to push each branch to github, without changing the defaults.
 
 
 
=Publishing=
 
 
 
==Pushing==
 
 
 
Authorized developers may publish work directly to <code>vtk.org/VTK.git</code> using Git's SSH protocol.
 
To request access, fill out the [https://www.kitware.com/Admin/SendPassword.cgi Kitware Password] form.
 
 
 
See the [[Git/Publish#Push_Access|push instructions]] for details.
 
 
 
For VTK, configure the push URL:
 
 
 
git config remote.origin.pushurl git@vtk.org:VTK.git
 
 
 
For VTKData, configure the push URL:
 
 
 
git config remote.origin.pushurl 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==
 
 
 
Contributions of bug fixes and features are commonly produced by the community. Patches are a convenient method for managing such contributions.
 
 
 
One may send patches after subscribing to our mailing list:
 
 
 
* [http://www.vtk.org/mailman/listinfo/vtk-developers VTK Developers Mailing List]
 
 
 
See our [[Git/Publish#Patches|patch instructions]] for details.
 
 
 
= 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<br>
 
Q: "I want to get rid of all local changes in this directory and start clean."<br>
 
A: git checkout .
 
 
 
=Resources=
 
 
 
Additional information about Git may be obtained at sites listed [[Git/Resources|here]].
 

Latest revision as of 15:42, 16 March 2015

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