diff options
author | Junio C Hamano <gitster@pobox.com> | 2017-08-26 23:14:59 -0700 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2017-08-26 23:14:59 -0700 |
commit | fb1fdf1f6a77bd1efab252589905f85f760611ab (patch) | |
tree | 6e3a8bf5784f4709a0dbf3b12e1a8f1b5a43dd26 /git-interpret-trailers.html | |
parent | 7526f0aeb1f0a4fa2a4a6fc213db28d5a1b8d418 (diff) | |
download | git-htmldocs-fb1fdf1f6a77bd1efab252589905f85f760611ab.tar.gz |
Autogenerated HTML docs for v2.14.1-459-g238e4
Diffstat (limited to 'git-interpret-trailers.html')
-rw-r--r-- | git-interpret-trailers.html | 102 |
1 files changed, 92 insertions, 10 deletions
diff --git a/git-interpret-trailers.html b/git-interpret-trailers.html index e6c2af80b..76aaffd96 100644 --- a/git-interpret-trailers.html +++ b/git-interpret-trailers.html @@ -739,7 +739,7 @@ git-interpret-trailers(1) Manual Page <h2>NAME</h2>
<div class="sectionbody">
<p>git-interpret-trailers -
- help add structured information into commit messages
+ add or parse structured information in commit messages
</p>
</div>
</div>
@@ -748,7 +748,8 @@ git-interpret-trailers(1) Manual Page <h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>git interpret-trailers</em> [--in-place] [--trim-empty] [(--trailer <token>[(=|:)<value>])…] [<file>…]</pre>
+<pre class="content"><em>git interpret-trailers</em> [options] [(--trailer <token>[(=|:)<value>])…] [<file>…]
+<em>git interpret-trailers</em> [options] [--parse] [<file>…]</pre>
<div class="attribution">
</div></div>
</div>
@@ -756,14 +757,15 @@ git-interpret-trailers(1) Manual Page <div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
-<div class="paragraph"><p>Help adding <em>trailers</em> lines, that look similar to RFC 822 e-mail
+<div class="paragraph"><p>Help parsing or adding <em>trailers</em> lines, that look similar to RFC 822 e-mail
headers, at the end of the otherwise free-form part of a commit
message.</p></div>
<div class="paragraph"><p>This command reads some patches or commit messages from either the
-<file> arguments or the standard input if no <file> is specified. Then
-this command applies the arguments passed using the <code>--trailer</code>
-option, if any, to the commit message part of each input file. The
-result is emitted on the standard output.</p></div>
+<file> arguments or the standard input if no <file> is specified. If
+<code>--parse</code> is specified, the output consists of the parsed trailers.</p></div>
+<div class="paragraph"><p>Otherwise, this command applies the arguments passed using the
+<code>--trailer</code> option, if any, to the commit message part of each input
+file. The result is emitted on the standard output.</p></div>
<div class="paragraph"><p>Some configuration variables control the way the <code>--trailer</code> arguments
are applied to each commit message and the way any existing trailer in
the commit message is changed. They also make it possible to
@@ -834,6 +836,86 @@ the encoding rules and probably many other rules.</p></div> command.
</p>
</dd>
+<dt class="hdlist1">
+--where <placement>
+</dt>
+<dt class="hdlist1">
+--no-where
+</dt>
+<dd>
+<p>
+ Specify where all new trailers will be added. A setting
+ provided with <em>--where</em> overrides all configuration variables
+ and applies to all <em>--trailer</em> options until the next occurrence of
+ <em>--where</em> or <em>--no-where</em>.
+</p>
+</dd>
+<dt class="hdlist1">
+--if-exists <action>
+</dt>
+<dt class="hdlist1">
+--no-if-exists
+</dt>
+<dd>
+<p>
+ Specify what action will be performed when there is already at
+ least one trailer with the same <token> in the message. A setting
+ provided with <em>--if-exists</em> overrides all configuration variables
+ and applies to all <em>--trailer</em> options until the next occurrence of
+ <em>--if-exists</em> or <em>--no-if-exists</em>.
+</p>
+</dd>
+<dt class="hdlist1">
+--if-missing <action>
+</dt>
+<dt class="hdlist1">
+--no-if-missing
+</dt>
+<dd>
+<p>
+ Specify what action will be performed when there is no other
+ trailer with the same <token> in the message. A setting
+ provided with <em>--if-missing</em> overrides all configuration variables
+ and applies to all <em>--trailer</em> options until the next occurrence of
+ <em>--if-missing</em> or <em>--no-if-missing</em>.
+</p>
+</dd>
+<dt class="hdlist1">
+--only-trailers
+</dt>
+<dd>
+<p>
+ Output only the trailers, not any other parts of the input.
+</p>
+</dd>
+<dt class="hdlist1">
+--only-input
+</dt>
+<dd>
+<p>
+ Output only trailers that exist in the input; do not add any
+ from the command-line or by following configured <code>trailer.*</code>
+ rules.
+</p>
+</dd>
+<dt class="hdlist1">
+--unfold
+</dt>
+<dd>
+<p>
+ Remove any whitespace-continuation in trailers, so that each
+ trailer appears on a line by itself with its full content.
+</p>
+</dd>
+<dt class="hdlist1">
+--parse
+</dt>
+<dd>
+<p>
+ A convenience alias for <code>--only-trailers --only-input
+ --unfold</code>.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -942,11 +1024,11 @@ trailer.<token>.where </p>
</dd>
<dt class="hdlist1">
-trailer.<token>.ifexist
+trailer.<token>.ifexists
</dt>
<dd>
<p>
- This option takes the same values as the <em>trailer.ifexist</em>
+ This option takes the same values as the <em>trailer.ifexists</em>
configuration variable and it overrides what is specified by
that option for trailers with the specified <token>.
</p>
@@ -1157,7 +1239,7 @@ $ chmod +x .git/hooks/commit-msg</code></pre> <div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
-Last updated 2017-06-01 23:23:19 PDT
+Last updated 2017-08-26 23:14:22 PDT
</div>
</div>
</body>
|