Difference between revisions of "ParaView/Git/Develop"

From KitwarePublic
< ParaView‎ | Git
Jump to navigationJump to search
(Replaced content with "The instructions previously available on this page have been superseded. See [https://gitlab.kitware.com/paraview/paraview/blob/master/Documentation/dev/git/develop.md he...")
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
+
The instructions previously available on this page have been superseded. See [https://gitlab.kitware.com/paraview/paraview/blob/master/Documentation/dev/git/develop.md here].
 
 
This page documents how to develop ParaView through [http://git-scm.com Git].
 
See our [[ParaView/Git|table of contents]] for more information.
 
 
 
<i>
 
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/Resources|Git resource links]] for third-party documentation, such as the [http://progit.org/book/ ProGit Book].
 
</i>
 
 
 
==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 [http://www.paraview.org/ParaView3/index.php/ParaView_Development_Workflow 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. Contributors are also free to simply push their topics to [https://github.com/ github] or [http://gitorious.org/ Gitorious] and request integration to the ParaView repository on the [http://paraview.org/paraview/help/mailing.html ParaView mailing lists].
 
 
 
==Setup==
 
 
 
Before you begin, perform initial setup:
 
 
 
{| style="width: 100%" cellspacing="0" cellpadding="0"
 
|-
 
|width=60%|
 
1.
 
Register [[ParaView/Git/Account#Gerrit|Gerrit access]].
 
|-
 
|
 
2.
 
Follow the [[ParaView/Git/Download#Clone|download instructions]] to create a local ParaView clone:
 
|-
 
|
 
:<code>$ git clone --recursive git://paraview.org/ParaView.git</code>
 
|align="center"|
 
[[Git/Trouble#Firewall_Blocks_Port_9418|Connection refused]]?
 
|-
 
|
 
3.
 
Run the developer setup script to prepare your ParaView work tree and create Git command aliases used below:
 
|-
 
|
 
:<code>$ ./Utilities/SetupForDevelopment.sh</code>
 
|align="center"|
 
[http://paraview.org/gitweb?p=ParaView.git;a=blob;f=Utilities/SetupForDevelopment.sh;hb=HEAD <code>SetupForDevelopment.sh</code>]
 
<br/>
 
[http://progit.org/book/ch1-5.html Pro Git: Setup]
 
|}
 
 
 
==Workflow==
 
 
 
ParaView development uses a [[Git/Workflow/Topic|branchy workflow]] based on topic branches.
 
If you have changes affecting the VTK submodule, refer to [[#Contribute_VTK_Changes|Contribute VTK Changes]].
 
Our collaboration workflow consists of three main steps:
 
 
 
{| style="width: 100%" cellspacing="0" cellpadding="0"
 
|-
 
|width=60%|
 
1.
 
Local Development
 
|-
 
|
 
:* [[#Update|Update]]
 
|-
 
|
 
:* [[#Create_a_Topic|Create a Topic]]
 
|-
 
|
 
2.
 
Testing and Review
 
|-
 
|
 
:* [[#Share_a_Topic|Share a Topic]] (requires [[ParaView/Git/Account#Gerrit|Gerrit access]])
 
|align="center"|
 
[http://code.google.com/p/gerrit/ Gerrit Code Review]
 
|-
 
|
 
:* [[#Revise_a_Topic|Revise a Topic]]
 
|-
 
|
 
3.
 
Integrate Changes
 
|-
 
|
 
:* [[#Suggest_a_Topic_for_Inclusion|Suggest a Topic for Inclusion]]
 
|-
 
|
 
:* [[#Delete a Topic|Delete a Topic]]
 
|}
 
 
 
==Update==
 
 
 
{| style="width: 100%"
 
|-
 
|width=60%|
 
Update your local '''master''' branch:
 
|-
 
|
 
:<code>$ git checkout master</code>
 
:<code>$ git pullall</code>
 
|align="center"|
 
[http://schacon.github.com/git/git-checkout.html <code>git help checkout</code>]
 
<br/>
 
[http://paraview.org/gitweb?p=ParaView.git;a=blob;f=Utilities/Scripts/SetupGitAliases.sh;hb=HEAD <code>alias.pullall</code>]
 
<br/>
 
([http://schacon.github.com/git/git-pull.html <code>pull</code>] and
 
[http://schacon.github.com/git/git-submodule.html <code>submodule</code>] <code>update</code>)
 
|}
 
 
 
==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.
 
 
 
{| style="width: 100%"
 
|-
 
|width=60%|
 
To start a new topic branch:
 
|-
 
|
 
:<code>$ git fetch origin</code>
 
:<code>$ git checkout -b ''my-topic'' origin/master</code>
 
:''(If you are fixing a bug in the latest release then substitute'' <code>origin/release</code> ''for'' <code>origin/master</code>''.<br/>Then run'' <code>git submodule update</code>''.)''
 
|align="center"|
 
[http://schacon.github.com/git/git-fetch.html <code>git help fetch</code>]
 
<br/>
 
[http://schacon.github.com/git/git-checkout.html <code>git help checkout</code>]
 
<br/>
 
[http://schacon.github.com/git/git-submodule.html <code>git help submodule</code>]
 
<br/>
 
[http://progit.org/book/ch3-2.html Pro Git: Basic Branching]
 
|-
 
|
 
Edit files and create commits (repeat as needed):
 
|-
 
|
 
:<code>$ edit ''file1'' ''file2'' ''file3''</code>
 
:<code>$ git add ''file1'' ''file2'' ''file3''</code>
 
:''(To change VTK [[ParaView/Git/Develop/PVVTK#Create_a_Topic|create a VTK topic]] and use <code>git add VTK</code>.)''
 
:<code>$ git commit</code>
 
|align="center"|
 
[http://schacon.github.com/git/git-add.html <code>git help add</code>]
 
<br/>
 
[http://schacon.github.com/git/git-commit.html <code>git help commit</code>]
 
<br/>
 
[http://progit.org/book/ch2-2.html Pro Git: Recording Changes]
 
|}
 
 
 
==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 [[ParaView/Git/Account#Gerrit|Gerrit access]].
 
 
 
{| style="width: 100%"
 
|-
 
|width=60%|
 
Checkout the topic if it is not your current branch:
 
|-
 
|
 
:<code>$ git checkout ''my-topic''</code>
 
|align="center"|
 
[http://schacon.github.com/git/git-checkout.html <code>git help checkout</code>]
 
|-
 
|
 
Check what commits will be pushed to Gerrit for review:
 
|-
 
|
 
:<code>$ git prepush</code>
 
|align="center"|
 
[http://paraview.org/gitweb?p=ParaView.git;a=blob;f=Utilities/Scripts/SetupGitAliases.sh;hb=HEAD <code>alias.prepush</code>]
 
<br/>
 
([http://schacon.github.com/git/git-log.html <code>log</code>] <code>origin/master..</code>)
 
|-
 
|
 
Push commits in your topic branch for review by the community:
 
|-
 
|
 
:<code>$ git gerrit-push</code>
 
The output will include a link to the topic review page in [http://review.source.kitware.com/p/ParaView ParaView Gerrit].
 
|align="center"|
 
[http://paraview.org/gitweb?p=ParaView.git;a=blob;f=Utilities/Scripts/SetupGitAliases.sh;hb=HEAD <code>alias.gerrit-push</code>]
 
|-
 
|
 
Find your topic/change in the [http://review.source.kitware.com/p/ParaView ParaView Gerrit] instance and add reviewers. If you are not sure whom to add as a reviewer, send an email on the [http://www.paraview.org/mailman/listinfo/paraview-developers ParaView Developer mailing-list] with a link to your Gerrit topic. A member from the ParaView development team can now take over your topic and have it tested and merged into master as per the [http://www.paraview.org/ParaView3/index.php/ParaView_Development_Workflow ParaView Development Workflow].
 
 
 
|align="center"|
 
[[File:AddReviewer.png]]
 
|}
 
 
 
==Revise a Topic==
 
 
 
If a topic is approved during Gerrit review, skip to the [[#Merge_a_Topic|next step]].
 
Otherwise, revise the topic and push it back to Gerrit for another review.
 
 
 
{| style="width: 100%"
 
|-
 
|width=60%|
 
Checkout the topic if it is not your current branch:
 
|-
 
|
 
:<code>$ git checkout ''my-topic''</code>
 
|align="center"|
 
[http://schacon.github.com/git/git-checkout.html <code>git help checkout</code>]
 
|-
 
|
 
To revise the <code>3</code>rd commit back on the topic:
 
|-
 
|
 
:<code>$ git rebase -i HEAD~3</code>
 
''(Substitute the correct number of commits back, as low as ''<code>1</code>''.)''
 
 
 
Follow Git's interactive instructions.
 
Preserve the <code>Change-Id:</code> line at the bottom of each commit message.
 
|align="center"|
 
[http://schacon.github.com/git/git-rebase.html <code>git help rebase</code>]
 
<br/>
 
[http://git-scm.com/book/en/Git-Branching-Rebasing Pro Git: Rebasing]
 
|-
 
|
 
Return to the [[#Share_a_Topic|previous step]] to share the revised topic.
 
|}
 
 
 
==Extend a Topic==
 
 
 
If your topic runs cleanly after a night of dashboard builds, it is ready for the [[#Merge_a_Topic_for_Inclusion|next step]].
 
Otherwise, extend the topic with additional commits to fix the problems.
 
 
 
{| style="width: 100%"
 
|-
 
|width=60%|
 
Checkout the topic if it is not your current branch:
 
|-
 
|
 
:<code>$ git checkout ''my-topic''</code>
 
:<code>$ git submodule update</code>
 
|align="center"|
 
[http://schacon.github.com/git/git-checkout.html <code>git help checkout</code>]
 
<br/>
 
[http://schacon.github.com/git/git-submodule.html <code>git help submodule</code>]
 
|-
 
|
 
Edit files and create commits (repeat as needed):
 
|-
 
|
 
:<code>$ edit ''file1'' ''file2'' ''file3''</code>
 
:<code>$ git add ''file1'' ''file2'' ''file3''</code>
 
:''(To fix VTK [[#Contribute_VTK_Changes|contribute your VTK topic]] and use <code>git add VTK</code>.)''
 
:<code>$ git commit</code>
 
|align="center"|
 
[http://schacon.github.com/git/git-add.html <code>git help add</code>]
 
<br/>
 
[http://schacon.github.com/git/git-commit.html <code>git help commit</code>]
 
<br/>
 
[http://progit.org/book/ch2-2.html Pro Git: Recording Changes]
 
|-
 
|
 
Return to the [[#Share_a_Topic|earlier step]] to share the extended topic.
 
|}
 
 
 
==Suggest a Topic for Inclusion==
 
 
 
Once you are satisfied with your topic, report a bug/feature-request on the [http://paraview.org/Bug ParaView Bug Tracker] with details on the issue being addressed with a link to the Gerrit topic. Additionally, send an email to the [http://paraview.org/paraview/help/mailing.html ParaView mailing list] to suggest inclusion of your topic into the ParaView official repository. A member from the ParaView development team will then work with you to get your changes tested on the ParaView dashboards and then have them merged into ParaView git repository.
 
 
 
==Delete a Topic==
 
 
 
After a topic has been merged upstream, delete your local branch for the topic.
 
 
 
{| style="width: 100%"
 
|-
 
|width=60%|
 
Checkout and update the '''master''' branch:
 
|-
 
|
 
:<code>$ git checkout master</code>
 
:<code>$ git pullall</code>
 
|align="center"|
 
[http://schacon.github.com/git/git-checkout.html <code>git help checkout</code>]
 
<br/>
 
[http://paraview.org/gitweb?p=ParaView.git;a=blob;f=Utilities/Scripts/SetupGitAliases.sh;hb=HEAD <code>alias.pullall</code>]
 
<br/>
 
([http://schacon.github.com/git/git-pull.html <code>pull</code>] and
 
[http://schacon.github.com/git/git-submodule.html <code>submodule</code>] <code>update</code>)
 
|-
 
|
 
Delete the local topic branch:
 
|-
 
|
 
:<code>$ git branch -d ''my-topic''</code>
 
:''(If you changed VTK [[ParaView/Git/Develop/PVVTK#Delete_a_Topic|delete the VTK topic]].)''
 
|align="center"|
 
[http://schacon.github.com/git/git-branch.html <code>git help branch</code>]
 
|-
 
|
 
The <code>branch -d</code> command works only when the topic branch has been correctly merged.
 
Use <code>-D</code> instead of <code>-d</code> to force the deletion of an unmerged topic branch
 
(warning - you could lose commits).
 
|}
 
 
 
==Contribute VTK Changes==
 
 
 
If you have any VTK changes, then you are required to get your changes incorporated into VTK using [http://www.vtk.org/Wiki/VTK/Git/Develop VTK's development workflow]. Once your VTK topic has been approved and merged into VTK, add your VTK topic head (or the latest VTK origin/master which includes your VTK topic head) to a commit in a [[#Create_a_Topic|ParaView topic]] and follow the process documented earlier.
 

Latest revision as of 08:27, 20 March 2015

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