ParaView/Git: Difference between revisions

From KitwarePublic
Jump to navigationJump to search
No edit summary
Line 7: Line 7:
We have published an ''experimental'' repository on paraview.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!  
We have published an ''experimental'' repository on paraview.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://paraview.org/paraview-tmp.git.
One may browse the repository online using the [http://git.wiki.kernel.org/index.php/Gitweb Gitweb] interface at http://paraview.org/ParaView.git.


At the time of this writing the repository does not have all branches and tags older than ParaView 2.6.
At the time of this writing the repository does not have all branches and tags older than ParaView 2.6.
Line 16: Line 16:
The clone URLs for the repository are
The clone URLs for the repository are


  git://paraview.org/paraview-tmp.git
  git://paraview.org/ParaView.git
  http://paraview.org/paraview-tmp.git
  http://paraview.org/ParaView.git


The push URL for the repository is
The push URL for the repository is


  git@paraview.org:paraview-tmp.git
  git@paraview.org:ParaView.git


''Feel free to push anything to the experimental paraview-tmp.git repository. Note however that it is not official and all changes will be thrown away before publishing the official repository.''
''Pushes to the experimental ParaView.git repository are currently disabled. Pushing will be enabled again when the final changes from CVS have been published and the ParaView.git repo is open for development.''


See the [[VTK/Git | VTK]] Git documentation for further details.
See the [[VTK/Git | VTK]] Git documentation for further details.
Line 35: Line 35:


==Submodules==
==Submodules==
ParaView references a few other projects as ''submodules''.  They 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 submodules:
$ git submodule init
This configures the submodules to fetch from their default URLs, such as <code>git://vtk.org/VTK.git</code> for VTK.
Next one may optionally configure a different URL, perhaps to use the http protocol:
$ git config submodule.VTK.url http://vtk.org/VTK.git
(and similarly for other submodules if necessary).
Finally, use the 'update' subcommand to get the submodules:
$ git submodule update
Whenever you update your work tree to some revision of ParaView then 'git status' may report that the submodule directories are modified.  This is because commands like 'git checkout' do not automatically update submodules.  Use 'git submodule update' at any time to ensure that the submodule directories are updated to the versions referenced by the parent project.


===VTK===
===VTK===


ParaView references VTK as a ''submodule'' called '<code>VTK</code>'.
ParaView references VTK as a ''submodule'' called '<code>VTK</code>'.
It 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 VTK
===IceT===


This configures the VTK submodule to fetch from the default URL <code>git://vtk.org/vtk-tmp.git</code>.
ParaView references IceT as a ''submodule'' called '<code>IceT</code>' at path '<code>Utilities/IceT</code>'.
Next one may optionally configure a different URL, perhaps to use the http protocol:


$ git config submodule.VTK.url http://vtk.org/vtk-tmp.git
===Xdmf===


Finally, use the 'update' subcommand to get the submodule:
ParaView references Xdmf as a ''submodule'' called '<code>IceT</code>' at path '<code>Utilities/Xdmf2</code>'.


$ git submodule update VTK
===ParaViewData===


===ParaViewData===
''NOTE: The ParaViewData submodule referenced by this section is not currently in the ParaView.git repository. It will be added again after the final changes from CVS have been ported and development is open on ParaView.git''


ParaView references sample and test data in a submodule called 'ParaViewData'. These data come in a separate repository because they are large and are not needed to build.
ParaView references sample and test data in a submodule called 'ParaViewData'. These data come in a separate repository because they are large and are not needed to build.
Use commands similar to those above for the VTK submodule.  The default URL is <code>git://paraview.org/paraview-data-tmp.git</code>, and the http url is <code>http://paraview.org/paraview-data-tmp.git</code>.
Use commands similar to those above for the VTK submodule.  The default URL is <code>git://paraview.org/ParaViewData.git</code>, and the http url is <code>http://paraview.org/ParaViewData.git</code>.

Revision as of 14:12, 16 April 2010

Experimental Repository

ParaView version tracking and development will be hosted by Git.

We have published an experimental repository on paraview.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 Gitweb interface at http://paraview.org/ParaView.git.

At the time of this writing the repository does not have all branches and tags older than ParaView 2.6. Conversion of older branches and tags from CVS will be completed later and added.

Cloning

The clone URLs for the repository are

git://paraview.org/ParaView.git
http://paraview.org/ParaView.git

The push URL for the repository is

git@paraview.org:ParaView.git

Pushes to the experimental ParaView.git repository are currently disabled. Pushing will be enabled again when the final changes from CVS have been published and the ParaView.git repo is open for development.

See the VTK Git documentation for further details.

Branches

At the time of this writing the repository has the following branches:

  • master: Development (default)
  • hooks: Local commit hooks (place in .git/hooks)

Submodules

ParaView references a few other projects as submodules. They can be obtained using the git submodule command. First use the 'init' subcommand to register the submodules:

$ git submodule init

This configures the submodules to fetch from their default URLs, such as git://vtk.org/VTK.git for VTK. Next one may optionally configure a different URL, perhaps to use the http protocol:

$ git config submodule.VTK.url http://vtk.org/VTK.git

(and similarly for other submodules if necessary). Finally, use the 'update' subcommand to get the submodules:

$ git submodule update

Whenever you update your work tree to some revision of ParaView then 'git status' may report that the submodule directories are modified. This is because commands like 'git checkout' do not automatically update submodules. Use 'git submodule update' at any time to ensure that the submodule directories are updated to the versions referenced by the parent project.

VTK

ParaView references VTK as a submodule called 'VTK'.

IceT

ParaView references IceT as a submodule called 'IceT' at path 'Utilities/IceT'.

Xdmf

ParaView references Xdmf as a submodule called 'IceT' at path 'Utilities/Xdmf2'.

ParaViewData

NOTE: The ParaViewData submodule referenced by this section is not currently in the ParaView.git repository. It will be added again after the final changes from CVS have been ported and development is open on ParaView.git

ParaView references sample and test data in a submodule called 'ParaViewData'. These data come in a separate repository because they are large and are not needed to build. Use commands similar to those above for the VTK submodule. The default URL is git://paraview.org/ParaViewData.git, and the http url is http://paraview.org/ParaViewData.git.