Difference between revisions of "VTK/Git"

From KitwarePublic
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].")
(133 intermediate revisions by 12 users not shown)
Line 1: Line 1:
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 will be hosted by [http://git-scm.com Git].
=Experimental Repository=
We have published an ''experimental'' repository on vtk.org. '''WE REQUEST THAT NO ONE PUBLISH A CLONE OF THIS REPOSITORY AT AN ONLINE HOSTING SITE'''. This may or may not be the final version of history after conversion from CVS. It may be removed or rewritten at any time. We prefer to not have multiple incompatible histories out there. The final conversion will be available soon, at which point we may all begin sharing changes!
One may browse the repository online using the [http://git.wiki.kernel.org/index.php/Gitweb Gitweb] interface at http://vtk.org/vtk-tmp.git.
At the time of this writing the repository does not have branches and tags older than VTK 5.0.
Conversion of older branches and tags from CVS will be completed later and added.
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-tmp.git VTK
or through the (less efficient) <code>http</code> protocol:
$ git clone http://vtk.org/vtk-tmp.git VTK
All further commands work inside the local copy of the repository created by the clone:
$ cd VTK
We provide here a brief introduction to development with Git.
See the [[#Resources|Resources]] below for further information.
First, 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"
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.
Authorized developers may publish work directly to <code>vtk.org/vtk-tmp.git</code> using Git's SSH protocol.
All publishers share the <code>git@vtk.org</code> account but each uses a unique ssh key for authentication.
To request access, fill out the [https://www.kitware.com/Admin/SendPassword.cgi Kitware Password] form.
Include your ssh public key and a reference to someone our administrators may contact to verify your privileges.
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.
'''After the final conversion to Git''' is finished we will consider pull requests from online Git hosting sites.
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-tmp.git
(Note that 'pushurl' requires Git >= 1.6.4.  Use just 'url' for Git < 1.6.4.)
Once your push URL is configured and your key is installed for <code>git@vtk.org</code> then you can try pushing changes.
''Feel free to push anything to the experimental vtk-tmp.git repository.  Note however that it is not official and all changes will be thrown away before publishing the official repository.''
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.