docs/index.html in update_repo-0.9.7 vs docs/index.html in update_repo-0.9.8
- old
+ new
@@ -59,15 +59,14 @@
<h1 class="icon fa-info-circle">About</h1>
</div>
</div><!-- row -->
<div class="row row-body">
<div class="col-lg-12 col-md-12">
- <p>A Simple Gem to keep multiple locally-cloned Git Repositories up to date.</p>
+ <p>A Simple Gem to keep multiple locally-cloned Git Repositories up to date. Current release version is <span id="version" class="version"></span></p>
<p>The script will simply run <span class="console-output">git pull</span> on every local clone of a git repository that it finds under the specified directory or directories.</p>
<p class="important-note">Note: Versions prior to 0.9.4 had a serious bug where the script would crash on startup unless there was an <span class="yaml-tag">exception:</span> defined in the configuration file. This has been fixed from version 0.9.4 onwards.</p>
<div class="text-center">
- <a href="https://badge.fury.io/rb/update_repo"><img src="https://badge.fury.io/rb/update_repo.svg" alt="Gem Version" height="18"></a>
<a href="https://travis-ci.org/seapagan/update_repo"><img src="https://travis-ci.org/seapagan/update_repo.svg?branch=master"></a>
</div>
</div>
</div><!-- row -->
</div><!-- container -->
@@ -174,11 +173,11 @@
<div class="col-lg-12 col-md-12">
<p><span class="yaml-tag">log_local:</span> - Store the logfile (if this is enabled) in the current working directory instead of the Users' Home directory. Defaults to <b>FALSE</b> (optional). Equivalent to <span class="cmdline">--log-local</span> on the command line.</p>
<pre>
<code class="language-yaml">
- log: true
+ log_local: true
</code>
</pre>
</div><!-- col -->
<div class="col-lg-12 col-md-12">
@@ -216,10 +215,19 @@
</code>
</pre>
</div><!-- col -->
<div class="col-lg-12 col-md-12">
+ <p><span class="yaml-tag">brief:</span> - Do not print the header, footer or summary, defaults to FALSE (optional). If this is set to TRUE, there will be no extra output except that from each git operation or the non-verbose legend. Equivalent to <span class="cmdline">--brief</span> and <span class="cmdline">--no-brief</span> on the command line.</p>
+ <pre>
+ <code class="language-yaml">
+ brief: true
+ </code>
+ </pre>
+ </div><!-- col -->
+
+ <div class="col-lg-12 col-md-12">
<p><span class="yaml-tag">quiet:</span> - Enable or disable Quiet mode, defaults to FALSE (optional). If this is specified then there will be nothing printed to the terminal except for fatal errors. Overrules the <span class="cmdline">--verbose</span> mode if also specified. Equivalent to <span class="cmdline">--quiet</span> and <span class="cmdline">--no-quiet</span> on the command line.</p>
<pre>
<code class="language-yaml">
quiet: true
</code>
@@ -240,10 +248,11 @@
log: true
timestamp: true
color: false
verbose: true
verbose_errors: true
+ brief: false
quiet: false
</code>
</pre>
</div><!-- col -->
@@ -255,17 +264,18 @@
<code class="language-markup">
Options:
-c, --color, --no-color Use colored output (default: true)
-d, --dump Dump a list of Directories and Git URL's to STDOUT in CSV format
-p, --prune=<i> Number of directory levels to remove from the --dump output. Only valid when --dump or -d specified (Default: 0)
- -l, --log Create a logfile of all program output to './update_repo.log'. Any older logs will be overwritten.
- -t, --timestamp Timestamp the logfile instead of overwriting. Does nothing unless the --log option is also specified.
+ -l, --log Create a logfile of all program output to './update_repo.log'. Any older logs will be overwritten
+ -t, --timestamp Timestamp the logfile instead of overwriting. Does nothing unless the --log option is also specified
-g, --log-local Create the logfile in the current directory instead of in the users home directory
- -r, --dump-remote Create a dump to screen or log listing all the git remote URLS found in the specified directories.
+ -r, --dump-remote Create a dump to screen or log listing all the git remote URLS found in the specified directories
-V, --verbose Display each repository and the git output to screen
-E, --verbose-errors List all the error output from a failing command in the summary, not just the first line
- -q, --quiet Run completely silent, with no output to the terminal (except fatal errors).
+ -b, --brief Do not print the header, footer or summary
+ -q, --quiet Run completely silent, with no output to the terminal (except fatal errors)
-v, --version Print version and exit
-h, --help Show this message
</code>
</pre>
</div><!-- col -->
@@ -392,9 +402,25 @@
</p>
<ul class="opt-list">
<li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--verbose-errors</span></li>
<li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-E</span></li>
<li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">--no-verbose-errors</span></li>
+ <li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li>
+ </ul>
+ </div>
+ </div>
+ <div class="col-lg-12 col-md-12">
+ <div class="cmd-header row-header">
+ <p>Brief Output</p>
+ </div>
+ <div class="cmd-body row-body">
+ <p class="cmd-text">Do not print the Header, Footer or Summary.</p>
+ <p class="cmd-text">Equivalent to the <span class="yaml-tag">brief:</span> YAML configuration file tag.
+ </p>
+ <ul class="opt-list">
+ <li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--brief</span></li>
+ <li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-b</span></li>
+ <li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">--no-brief</span></li>
<li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li>
</ul>
</div>
</div>
<div class="col-lg-12 col-md-12">