diff options
Diffstat (limited to 'git-show.html')
| -rw-r--r-- | git-show.html | 75 |
1 files changed, 56 insertions, 19 deletions
diff --git a/git-show.html b/git-show.html index 53bd3b1d9..68521ec4e 100644 --- a/git-show.html +++ b/git-show.html @@ -1132,7 +1132,9 @@ a raw <em>%</em> </dt>
<dd>
<p>
-print a byte from a hex code
+<em>%x</em> followed by two hexadecimal digits is replaced with a
+ byte with the hexadecimal digits' value (we will call this
+ "literal formatting code" in the rest of this document).
</p>
</dd>
</dl></div>
@@ -1581,17 +1583,56 @@ ref names without the " (", ")" wrapping. </p>
</dd>
<dt class="hdlist1">
-<em>%(describe[:options])</em>
+<em>%(decorate[:<options>])</em>
</dt>
<dd>
<p>
-human-readable name, like
- <a href="git-describe.html">git-describe(1)</a>; empty string for
- undescribable commits. The <code>describe</code> string
- may be followed by a colon and zero or more
- comma-separated options. Descriptions can be
- inconsistent when tags are added or removed at
- the same time.
+ref names with custom decorations. The <code>decorate</code> string may be followed by a
+colon and zero or more comma-separated options. Option values may contain
+literal formatting codes. These must be used for commas (<code>%x2C</code>) and closing
+parentheses (<code>%x29</code>), due to their role in the option syntax.
+</p>
+<div class="ulist"><ul>
+<li>
+<p>
+<em>prefix=<value></em>: Shown before the list of ref names. Defaults to " <code>(</code>".
+</p>
+</li>
+<li>
+<p>
+<em>suffix=<value></em>: Shown after the list of ref names. Defaults to "<code>)</code>".
+</p>
+</li>
+<li>
+<p>
+<em>separator=<value></em>: Shown between ref names. Defaults to "<code>,</code> ".
+</p>
+</li>
+<li>
+<p>
+<em>pointer=<value></em>: Shown between HEAD and the branch it points to, if any.
+ Defaults to " <code>-></code> ".
+</p>
+</li>
+<li>
+<p>
+<em>tag=<value></em>: Shown before tag names. Defaults to "<code>tag:</code> ".
+</p>
+</li>
+</ul></div>
+<div class="paragraph"><p>For example, to produce decorations with no wrapping
+or tag annotations, and spaces as separators:</p></div>
+<div class="paragraph"><p><code>%(decorate:prefix=,suffix=,tag=,separator= )</code></p></div>
+</dd>
+<dt class="hdlist1">
+<em>%(describe[:<options>])</em>
+</dt>
+<dd>
+<p>
+human-readable name, like <a href="git-describe.html">git-describe(1)</a>; empty string for
+undescribable commits. The <code>describe</code> string may be followed by a colon and
+zero or more comma-separated options. Descriptions can be inconsistent when
+tags are added or removed at the same time.
</p>
<div class="ulist"><ul>
<li>
@@ -1808,17 +1849,14 @@ reflog subject </p>
</dd>
<dt class="hdlist1">
-<em>%(trailers[:options])</em>
+<em>%(trailers[:<options>])</em>
</dt>
<dd>
<p>
-display the trailers of the body as
- interpreted by
- <a href="git-interpret-trailers.html">git-interpret-trailers(1)</a>. The
- <code>trailers</code> string may be followed by a colon
- and zero or more comma-separated options.
- If any option is provided multiple times the
- last occurrence wins.
+display the trailers of the body as interpreted by
+<a href="git-interpret-trailers.html">git-interpret-trailers(1)</a>. The <code>trailers</code> string may be followed by
+a colon and zero or more comma-separated options. If any option is provided
+multiple times, the last occurrence wins.
</p>
<div class="ulist"><ul>
<li>
@@ -1962,8 +2000,7 @@ diff output.</p></div> </dt>
<dd>
<p>
- Generate patch (see section titled
-<a href="#generate_patch_text_with_p">"Generating patch text with -p"</a>).
+ Generate patch (see <a href="#generate_patch_text_with_p">[generate_patch_text_with_p]</a>).
</p>
</dd>
<dt class="hdlist1">
|