ParaView/Git/Develop

This page documents how to develop ParaView 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 ParaView 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.

Target Audience

This document is intended for developers from the larger ParaView open-source community who want to contribute patches back to ParaView. Registered developers of ParaView (with write access to the git repository) should refer to ParaView Developers Wiki for instructions on using the ParaView integration branches for contributing code. The rest of the community can push contributions to ParaView using the workflow described here.

Setup

Before you begin, perform initial setup:

1. Register Gerrit access.
2. Follow the download instructions to create a local ParaView clone:
$ git clone --recursive git://paraview.org/ParaView.git	Connection refused?
3. Run the developer setup script to prepare your ParaView work tree and create Git command aliases used below:
$ ./Utilities/SetupForDevelopment.sh	SetupForDevelopment.sh Pro Git: Setup

Workflow

ParaView development uses a branchy workflow based on topic branches. We manage changes to the VTK submodule using an extended VTK workflow. Our collaboration workflow consists of three main steps:

1. Local Development

Update

Create a Topic

2. Testing and Review

Share a Topic

Merge a Topic for Testing

Extend a Topic

3. Integration by Maintainers

Merge a Topic for Inclusion

Delete a Topic

Update

Update your local master branch:
$ git checkout master $ git pullall	git help checkout alias.pullall (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 (If you are fixing a bug in the latest release then substitute origin/release for origin/master. Then run git submodule update.)	git help fetch git help checkout git help submodule Pro Git: Basic Branching
Edit files and create commits (repeat as needed):
$ edit file1 file2 file3 $ git add file1 file2 file3 (To change VTK create a VTK topic and use git add VTK.) $ git commit	git help add git help commit Pro Git: Recording Changes

Share a Topic

When a topic is ready for testing and review by others, share it by pushing it to the topic stage. Be sure you have registered for Git push 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 the topic stage:
$ git prepush	alias.prepush (log origin/master..)
Push commits in your topic branch to the topic stage:
(If you changed VTK share the VTK topic first.) $ git stage-push	alias.stage-push (push stage HEAD)

The topic is now published on the ParaView Topic Stage and may be (optionally) reviewed by others.

Merge a Topic for Testing

When your topic is ready, merge it to the ParaView next branch for testing.

Checkout the topic if it is not your current branch:
$ git checkout my-topic	git help checkout
Ask the topic stage to automatically merge the topic. It will merge to next by default.
(If you changed VTK merge the VTK topic first.) $ git stage-merge (If the merge conflicts follow the printed instructions to resolve them.)	alias.stage-merge (ssh git@paraview.org stage ParaView merge my-topic) Topic-to-Topic Conflict Resolution

The topic is now integrated into ParaView's next branch and will be tested by dashboard builds.

Extend a Topic

If your topic runs cleanly after a night of dashboard builds, it is ready for the next step. Otherwise, extend the topic with additional commits to fix the problems.

Checkout the topic if it is not your current branch:
$ git checkout my-topic $ git submodule update	git help checkout git help submodule
Edit files and create commits (repeat as needed):
$ edit file1 file2 file3 $ git add file1 file2 file3 (To fix VTK extend the VTK topic and use git add VTK.) $ git commit	git help add git help commit Pro Git: Recording Changes
Return to the earlier step to share the extended topic.

Merge a Topic for Inclusion

Only core maintainers have access to merge a topic to master. They meet weekly to evaluate topics in next (and PVVTK pv-next) based on dashboard results and manual review. If your topic is accepted it will be merged to master for permanent inclusion after which you may delete it. Otherwise the maintainers will contact you with feedback. Respond by returning to the above step to address their concerns.

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 alias.pullall (pull and submodule update)
Delete the local topic branch:
$ git branch -d my-topic (If you changed VTK delete the VTK 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).