EXODUS/cmake/tribits/doc/guides/TribitsToolsDocumentation.rst

clone_extra_repos.py --help
---------------------------

Below is a snapshot of the output from ``clone_extra_repos.py --help``.  For
more details on the usage of ``clone_extra_repos.py``, see `Multi-Repository
Support`_ and `Multi-Repository Development Workflow`_.

.. include:: clone_extra_repos-help.txt
   :literal:


gitdist documentation
---------------------

The sections below show snapshots of the output from the `gitdist`_ tool from
`gitdist --help`_ and ``gitdist --dist-help=<topic>``:

* `gitdist --help`_
* `gitdist --dist-help=overview`_
* `gitdist --dist-help=repo-selection-and-setup`_
* `gitdist --dist-help=dist-repo-status`_
* `gitdist --dist-help=repo-versions`_
* `gitdist --dist-help=aliases`_
* `gitdist --dist-help=default-branch`_
* `gitdist --dist-help=move-to-base-dir`_
* `gitdist --dist-help=usage-tips`_
* `gitdist --dist-help=script-dependencies`_
* `gitdist --dist-help=all`_

For more details on the usage of ``gitdist``, see `Multi-Repository Support`_
and `Multi-Repository Development Workflow`_.


gitdist --help
++++++++++++++

.. include:: gitdist-help.txt
   :literal:


gitdist --dist-help=overview
++++++++++++++++++++++++++++

.. include:: gitdist-dist-help-overview.txt
   :literal:


gitdist --dist-help=repo-selection-and-setup
++++++++++++++++++++++++++++++++++++++++++++

.. include:: gitdist-dist-help-repo-selection-and-setup.txt
   :literal:


gitdist --dist-help=dist-repo-status
++++++++++++++++++++++++++++++++++++

.. include:: gitdist-dist-help-dist-repo-status.txt
   :literal:


gitdist --dist-help=repo-versions
+++++++++++++++++++++++++++++++++

.. include:: gitdist-dist-help-repo-versions.txt
   :literal:


gitdist --dist-help=aliases
+++++++++++++++++++++++++++

.. include:: gitdist-dist-help-aliases.txt
   :literal:


gitdist --dist-help=default-branch
++++++++++++++++++++++++++++++++++

.. include:: gitdist-dist-help-default-branch.txt
   :literal:


gitdist --dist-help=move-to-base-dir
++++++++++++++++++++++++++++++++++++

.. include:: gitdist-dist-help-move-to-base-dir.txt
   :literal:


gitdist --dist-help=usage-tips
++++++++++++++++++++++++++++++

.. include:: gitdist-dist-help-usage-tips.txt
   :literal:


gitdist --dist-help=script-dependencies
+++++++++++++++++++++++++++++++++++++++

.. include:: gitdist-dist-help-script-dependencies.txt
   :literal:


gitdist --dist-help=all
+++++++++++++++++++++++++++++++++++++++

.. include:: gitdist-dist-help-all.txt
   :literal:


.. _snapshot-dir.py:

snapshot-dir.py --help
----------------------

Below is a snapshot of the output from ``snapshot-dir.py --help``.  For more
details on the usage of ``snapshot-dir.py``, specifically for snapshotting the
`<projectDir>/cmake/tribits/`_ directory, see `TriBITS directory
snapshotting`_.

.. include:: snapshot-dir-help.txt
   :literal:


checkin-test.py --help
----------------------

Below is a snapshot of the output from ``checkin-test.py --help``.  This
``--help`` output contains a lot of information about the recommended
development workflow (mostly related to pushing commits) and outlines a number
of different use cases for using the tool.

.. include:: checkin-test-help.txt
   :literal:


.. _is_checkin_tested_commit.py:

is_checkin_tested_commit.py --help
----------------------------------

Below is a snapshot of the output from ``is_checkin_tested_commit.py --help``.
For more details see `Using Git Bisect with checkin-test.py workflows`_.

.. include:: is_checkin_tested_commit.txt
   :literal:


.. _get-tribits-packages-from-files-list.py:

get-tribits-packages-from-files-list.py --help
----------------------------------------------

Below is a snapshot of the output from
``get-tribits-packages-from-files-list.py --help``.  For more details see
`TriBITS Project Dependencies XML file and tools`_.

.. include:: get-tribits-packages-from-files-list.txt
   :literal:


.. _get-tribits-packages-from-last-tests-failed.py:

get-tribits-packages-from-last-tests-failed.py --help
-----------------------------------------------------

Below is a snapshot of the output from
``get-tribits-packages-from-last-tests-failed.py --help``.  For more details
see `TriBITS Project Dependencies XML file and tools`_.

.. include:: get-tribits-packages-from-last-tests-failed.txt
   :literal:


.. _filter-packages-list.py:

filter-packages-list.py --help
------------------------------

Below is a snapshot of the output from ``filter-packages-list.py --help``.
For more details see `TriBITS Project Dependencies XML file and tools`_.

.. include:: filter-packages-list.txt
   :literal:


install_devtools.py --help
--------------------------

Below is a snapshot of the output from ``install_devtools.py --help``.

.. include:: install_devtools-help.txt
   :literal: