Skip to content

Commit 5855187

Browse files
author
Kevin Paulisse
committed
Regenerate options documentation for 0.5.4
1 parent c39a892 commit 5855187

1 file changed

Lines changed: 71 additions & 1 deletion

File tree

doc/optionsref.md

Lines changed: 71 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ Usage: octocatalog-diff [command line options]
1616
--from-catalog FILENAME Use a pre-compiled catalog 'from'
1717
--to-catalog FILENAME Use a pre-compiled catalog 'to'
1818
--bootstrap-script FILENAME Bootstrap script relative to checkout directory
19+
--bootstrap-current Run bootstrap script for the current directory too
20+
--debug-bootstrap Print debugging output for bootstrap script
1921
--bootstrap-environment "key1=val1,key2=val2,..."
2022
Bootstrap script environment variables in key=value format
2123
--bootstrapped-from-dir DIRNAME
@@ -32,13 +34,16 @@ Usage: octocatalog-diff [command line options]
3234
More resources to ignore in format type[title]
3335
--[no-]include-tags Include changes to tags in the diff output
3436
--fact-file FILENAME Fact file to use instead of node lookup
37+
--cached-master-dir PATH Cache bootstrapped origin/master at this path
3538
--master-cache-branch BRANCH Branch to cache
3639
--safe-to-delete-cached-master-dir PATH
3740
OK to delete cached master directory at this path
38-
--cached-master-dir PATH Cache bootstrapped origin/master at this path
3941
--hiera-config PATH Relative path to hiera YAML file
4042
--no-hiera-config Disable hiera config file installation
43+
--hiera-path PATH Path to hiera data directory, relative to top directory of repository
44+
--no-hiera-path Do not use any default hiera path settings
4145
--hiera-path-strip PATH Path prefix to strip when munging hiera.yaml
46+
--no-hiera-path-strip Do not use any default hiera path strip settings
4247
--ignore-attr "attr1,attr2,..."
4348
Attributes to ignore
4449
--[no-]display-source Show source file and line for each difference
@@ -147,6 +152,19 @@ Usage: octocatalog-diff [command line options]
147152
</td>
148153
</tr>
149154

155+
<tr>
156+
<td valign=top>
157+
<pre><code>--bootstrap-current </code></pre>
158+
</td>
159+
<td valign=top>
160+
Run bootstrap script for the current directory too
161+
</td>
162+
<td valign=top>
163+
Option to bootstrap the current directory (by default, the bootstrap script is NOT
164+
run when the catalog builds in the current directory). (<a href="../lib/octocatalog-diff/catalog-diff/cli/options/bootstrap_current.rb">bootstrap_current.rb</a>)
165+
</td>
166+
</tr>
167+
150168
<tr>
151169
<td valign=top>
152170
<pre><code>--bootstrap-environment "key1=val1,key2=val2,..."</code></pre>
@@ -281,6 +299,20 @@ what is most often desired. (<a href="../lib/octocatalog-diff/catalog-diff/cli/o
281299
</td>
282300
</tr>
283301

302+
<tr>
303+
<td valign=top>
304+
<pre><code>--debug-bootstrap </code></pre>
305+
</td>
306+
<td valign=top>
307+
Print debugging output for bootstrap script
308+
</td>
309+
<td valign=top>
310+
Option to print debugging output for the bootstrap script in addition to the normal
311+
debugging output. Note that `--debug` must also be enabled for this option to have
312+
any effect. (<a href="../lib/octocatalog-diff/catalog-diff/cli/options/debug_bootstrap.rb">debug_bootstrap.rb</a>)
313+
</td>
314+
</tr>
315+
284316
<tr>
285317
<td valign=top>
286318
<pre><code>--default-header </code></pre>
@@ -449,6 +481,19 @@ These files must exist and be in Puppet catalog format. (<a href="../lib/octocat
449481
</td>
450482
</tr>
451483

484+
<tr>
485+
<td valign=top>
486+
<pre><code>--hiera-path PATH</code></pre>
487+
</td>
488+
<td valign=top>
489+
Path to hiera data directory, relative to top directory of repository
490+
</td>
491+
<td valign=top>
492+
Specify the path to the Hiera data directory (relative to the top level Puppet checkout). For Puppet Enterprise and the
493+
Puppet control repo template, the value of this should be 'hieradata', which is the default. (<a href="../lib/octocatalog-diff/catalog-diff/cli/options/hiera_path.rb">hiera_path.rb</a>)
494+
</td>
495+
</tr>
496+
452497
<tr>
453498
<td valign=top>
454499
<pre><code>--hiera-path-strip PATH</code></pre>
@@ -572,6 +617,31 @@ to ignore any changes for any defined type where this tag is set. (<a href="../l
572617
</td>
573618
</tr>
574619

620+
<tr>
621+
<td valign=top>
622+
<pre><code>--no-hiera-path </code></pre>
623+
</td>
624+
<td valign=top>
625+
Do not use any default hiera path settings
626+
</td>
627+
<td valign=top>
628+
Specify the path to the Hiera data directory (relative to the top level Puppet checkout). For Puppet Enterprise and the
629+
Puppet control repo template, the value of this should be 'hieradata', which is the default. (<a href="../lib/octocatalog-diff/catalog-diff/cli/options/hiera_path.rb">hiera_path.rb</a>)
630+
</td>
631+
</tr>
632+
633+
<tr>
634+
<td valign=top>
635+
<pre><code>--no-hiera-path-strip </code></pre>
636+
</td>
637+
<td valign=top>
638+
Do not use any default hiera path strip settings
639+
</td>
640+
<td valign=top>
641+
Specify the path to strip off the datadir to munge hiera.yaml file (<a href="../lib/octocatalog-diff/catalog-diff/cli/options/hiera_path_strip.rb">hiera_path_strip.rb</a>)
642+
</td>
643+
</tr>
644+
575645
<tr>
576646
<td valign=top>
577647
<pre><code>--no-ignore-tags </code></pre>

0 commit comments

Comments
 (0)