ITK/Git/Develop: Difference between revisions

From KitwarePublic
< ITK‎ | Git
Jump to navigationJump to search
No edit summary
Line 40: Line 40:


{| style="width: 100%"
{| style="width: 100%"
!width=60%|
!
|-
|-
|
|width=60%|
Update your local '''master''' branch:
Update your local '''master''' branch:
|-
|-
Line 67: Line 65:


{| style="width: 100%"
{| style="width: 100%"
!width=60%|
!
|-
|-
|
|width=60%|
To start a new topic branch:
To start a new topic branch:
|-
|-
Line 100: Line 96:


{| style="width: 100%"
{| style="width: 100%"
!width=60%|
!
|-
|-
|
|width=60%|
Checkout the topic if it is not your current branch:
Checkout the topic if it is not your current branch:
|-
|-
Line 134: Line 128:


{| style="width: 100%"
{| style="width: 100%"
!width=60%|
!
|-
|-
|
|width=60%|
Checkout the topic if it is not your current branch:
Checkout the topic if it is not your current branch:
|-
|-
Line 161: Line 153:


{| style="width: 100%"
{| style="width: 100%"
!width=60%|
!
|-
|-
|
|width=60%|
Checkout and update the '''master''' branch:
Checkout and update the '''master''' branch:
|-
|-

Revision as of 18:38, 17 November 2010


This page documents how to develop ITK through Git. See our table of contents for more information.

Git is an extremely powerful version control tool that supports many different "workflows" for indivudal development and collaboration. Here we document procedures used by the ITK development community. In the interest of simplicity and brevity we do not provide an explanation of why we use this approach. Furthermore, this is not a Git tutorial. Please see our Git resource links for third-party documentation, such as the ProGit Book.

Setup

Before you begin, perform initial setup:

  1. Register Gerrit access and possibly Git push access.
  2. Optionally download our one page PDF desk reference.
  3. Follow the download instructions to create a local ITK clone:
    $ git clone git://itk.org/ITK.git
  4. Run the developer setup script to prepare your ITK work tree and create Git command aliases used below:
    $ ./Utilities/SetupForDevelopment.sh

Workflow

ITK development uses a branchy workflow based on topic branches. Our collaboration workflow consists of three main steps:

  1. Local Development
  2. Code Review
  3. Integrate Changes

Update

Update your local master branch:

$ git checkout master
$ git pullall

git help checkout

(pullall is an alias for pull
and submodule update)

Create a Topic

All new work must be committed on topic branches. Name topics like you might name functions: concise but precise. A reader should have a general idea of the feature or fix to be developed given just the branch name.

To start a new topic branch:

$ git fetch origin
$ git checkout -b my-topic origin/master

git help fetch

git help checkout

Edit files and create commits (repeat as needed):

$ edit file1 file2 file3
$ git add file1 file2 file3
$ git commit

git help add

git help commit

Share a Topic

When a topic is ready for review and possible inclusion, share it by pushing to Gerrit. Be sure you have registered for Gerrit access.

Checkout the topic if it is not your current branch:

$ git checkout my-topic

git help checkout

Check what commits will be pushed to Gerrit for review:

$ git prepush

(prepush is an alias)

Push commits in your topic branch for review by the community:

$ git gerrit-push

(gerrit-push is an alias)

Merge a Topic

After a topic has been reviewed and approved in Gerrit, merge it into the upstream repository. Only authorized developers with Git push access to itk.org may perform this step.

Checkout the topic if it is not your current branch:

$ git checkout my-topic

git help checkout

Merge the topic:

$ git gerrit-merge

(gerrit-merge is an alias
that uses a topic stage)

Delete a Topic

After a topic has been merged upstream, delete your local branch for the topic.

Checkout and update the master branch:

$ git checkout master
$ git pullall

git help checkout

(pullall is an alias for pull
and submodule update)

Delete the local topic branch:

$ git branch -d my-topic

git help branch

The branch -d command works only when the topic branch has been correctly merged. Use -D instead of -d to force the deletion of an unmerged topic branch (warning - you could lose commits).