Debian Codegraph @

cmake/tribits/doc/guides/TribitsToolsDocumentation.rst

raw
1 clone_extra_repos.py --help
2 ---------------------------
3
4 Below is a snapshot of the output from ``clone_extra_repos.py --help``. For
5 more details on the usage of ``clone_extra_repos.py``, see `Multi-Repository
6 Support`_ and `Multi-Repository Development Workflow`_.
7
8 .. include:: clone_extra_repos-help.txt
9 :literal:
10
11
12 gitdist documentation
13 ---------------------
14
15 The sections below show snapshots of the output from the `gitdist`_ tool from
16 `gitdist --help`_ and ``gitdist --dist-help=<topic>``:
17
18 * `gitdist --help`_
19 * `gitdist --dist-help=overview`_
20 * `gitdist --dist-help=repo-selection-and-setup`_
21 * `gitdist --dist-help=dist-repo-status`_
22 * `gitdist --dist-help=repo-versions`_
23 * `gitdist --dist-help=aliases`_
24 * `gitdist --dist-help=default-branch`_
25 * `gitdist --dist-help=move-to-base-dir`_
26 * `gitdist --dist-help=usage-tips`_
27 * `gitdist --dist-help=script-dependencies`_
28 * `gitdist --dist-help=all`_
29
30 For more details on the usage of ``gitdist``, see `Multi-Repository Support`_
31 and `Multi-Repository Development Workflow`_.
32
33
34 gitdist --help
35 ++++++++++++++
36
37 .. include:: gitdist-help.txt
38 :literal:
39
40
41 gitdist --dist-help=overview
42 ++++++++++++++++++++++++++++
43
44 .. include:: gitdist-dist-help-overview.txt
45 :literal:
46
47
48 gitdist --dist-help=repo-selection-and-setup
49 ++++++++++++++++++++++++++++++++++++++++++++
50
51 .. include:: gitdist-dist-help-repo-selection-and-setup.txt
52 :literal:
53
54
55 gitdist --dist-help=dist-repo-status
56 ++++++++++++++++++++++++++++++++++++
57
58 .. include:: gitdist-dist-help-dist-repo-status.txt
59 :literal:
60
61
62 gitdist --dist-help=repo-versions
63 +++++++++++++++++++++++++++++++++
64
65 .. include:: gitdist-dist-help-repo-versions.txt
66 :literal:
67
68
69 gitdist --dist-help=aliases
70 +++++++++++++++++++++++++++
71
72 .. include:: gitdist-dist-help-aliases.txt
73 :literal:
74
75
76 gitdist --dist-help=default-branch
77 ++++++++++++++++++++++++++++++++++
78
79 .. include:: gitdist-dist-help-default-branch.txt
80 :literal:
81
82
83 gitdist --dist-help=move-to-base-dir
84 ++++++++++++++++++++++++++++++++++++
85
86 .. include:: gitdist-dist-help-move-to-base-dir.txt
87 :literal:
88
89
90 gitdist --dist-help=usage-tips
91 ++++++++++++++++++++++++++++++
92
93 .. include:: gitdist-dist-help-usage-tips.txt
94 :literal:
95
96
97 gitdist --dist-help=script-dependencies
98 +++++++++++++++++++++++++++++++++++++++
99
100 .. include:: gitdist-dist-help-script-dependencies.txt
101 :literal:
102
103
104 gitdist --dist-help=all
105 +++++++++++++++++++++++++++++++++++++++
106
107 .. include:: gitdist-dist-help-all.txt
108 :literal:
109
110
111 .. _snapshot-dir.py:
112
113 snapshot-dir.py --help
114 ----------------------
115
116 Below is a snapshot of the output from ``snapshot-dir.py --help``. For more
117 details on the usage of ``snapshot-dir.py``, specifically for snapshotting the
118 `<projectDir>/cmake/tribits/`_ directory, see `TriBITS directory
119 snapshotting`_.
120
121 .. include:: snapshot-dir-help.txt
122 :literal:
123
124
125 checkin-test.py --help
126 ----------------------
127
128 Below is a snapshot of the output from ``checkin-test.py --help``. This
129 ``--help`` output contains a lot of information about the recommended
130 development workflow (mostly related to pushing commits) and outlines a number
131 of different use cases for using the tool.
132
133 .. include:: checkin-test-help.txt
134 :literal:
135
136
137 .. _is_checkin_tested_commit.py:
138
139 is_checkin_tested_commit.py --help
140 ----------------------------------
141
142 Below is a snapshot of the output from ``is_checkin_tested_commit.py --help``.
143 For more details see `Using Git Bisect with checkin-test.py workflows`_.
144
145 .. include:: is_checkin_tested_commit.txt
146 :literal:
147
148
149 .. _get-tribits-packages-from-files-list.py:
150
151 get-tribits-packages-from-files-list.py --help
152 ----------------------------------------------
153
154 Below is a snapshot of the output from
155 ``get-tribits-packages-from-files-list.py --help``. For more details see
156 `TriBITS Project Dependencies XML file and tools`_.
157
158 .. include:: get-tribits-packages-from-files-list.txt
159 :literal:
160
161
162 .. _get-tribits-packages-from-last-tests-failed.py:
163
164 get-tribits-packages-from-last-tests-failed.py --help
165 -----------------------------------------------------
166
167 Below is a snapshot of the output from
168 ``get-tribits-packages-from-last-tests-failed.py --help``. For more details
169 see `TriBITS Project Dependencies XML file and tools`_.
170
171 .. include:: get-tribits-packages-from-last-tests-failed.txt
172 :literal:
173
174
175 .. _filter-packages-list.py:
176
177 filter-packages-list.py --help
178 ------------------------------
179
180 Below is a snapshot of the output from ``filter-packages-list.py --help``.
181 For more details see `TriBITS Project Dependencies XML file and tools`_.
182
183 .. include:: filter-packages-list.txt
184 :literal:
185
186
187 install_devtools.py --help
188 --------------------------
189
190 Below is a snapshot of the output from ``install_devtools.py --help``.
191
192 .. include:: install_devtools-help.txt
193 :literal: