|
|
| (127 intermediate revisions by 12 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 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.
| |
| | |
| ==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-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
| |
| | |
| ==Branches==
| |
| | |
| At the time of this writing the repository has the following branches:
| |
| | |
| * '''master''': Development (default)
| |
| | |
| ==Submodules==
| |
| | |
| VTK references sample and test data in a ''submodule'' called '<code>VTKData</code>'.
| |
| These data come in a separate repository because they are much larger than the source tree and are not needed to build.
| |
| VTKData can be obtained using the [http://www.kernel.org/pub/software/scm/git/docs/git-submodule.html git submodule] command.
| |
| First use the 'init' subcommand to register the submodule:
| |
| | |
| $ git submodule init VTKData | |
| | |
| This configures the VTKData submodule to fetch from the default URL <code>git://vtk.org/vtk-data-tmp.git</code>.
| |
| Next one may optionally configure a different URL, perhaps to use the http protocol:
| |
| | |
| $ git config submodule.VTKData.url http://vtk.org/vtk-data-tmp.git
| |
| | |
| Finally, use the 'update' subcommand to get the submodule:
| |
| | |
| $ git submodule update VTKData
| |
| | |
| =Development=
| |
| | |
| 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.
| |
| | |
| =Publishing=
| |
| | |
| Authorized developers may publish work directly to <code>vtk.org/vtk-tmp.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.
| |
| '''After the final conversion to Git''' is finished we will consider pull requests from online Git hosting sites.
| |
| | |
| ==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==
| |
| | |
| ''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.''
| |
| | |
| 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.
| |
| | |
| =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]
| |
