Skip to content

Commit 31a922f

Browse files
ak2gitster
authored andcommitted
pretty-formats: enclose options in angle brackets
Enclose the 'options' placeholders in the documentation of the %(describe) and %(trailers) format specifiers in angle brackets to clarify that they are placeholders rather than keywords. Also remove the indentation from their descriptions, instead of increasing it to account for the extra two angle brackets in the headings. The indentation isn't required by asciidoc, it doesn't reflect how the output text is formatted, and it's inconsistent with the following bullet points that are at the same level in the output. Signed-off-by: Andy Koppe <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 014aa1d commit 31a922f

File tree

1 file changed

+10
-14
lines changed

1 file changed

+10
-14
lines changed

Documentation/pretty-formats.txt

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -224,13 +224,11 @@ The placeholders are:
224224
linkgit:git-rev-list[1])
225225
'%d':: ref names, like the --decorate option of linkgit:git-log[1]
226226
'%D':: ref names without the " (", ")" wrapping.
227-
'%(describe[:options])':: human-readable name, like
228-
linkgit:git-describe[1]; empty string for
229-
undescribable commits. The `describe` string
230-
may be followed by a colon and zero or more
231-
comma-separated options. Descriptions can be
232-
inconsistent when tags are added or removed at
233-
the same time.
227+
'%(describe[:<options>])'::
228+
human-readable name, like linkgit:git-describe[1]; empty string for
229+
undescribable commits. The `describe` string may be followed by a colon and
230+
zero or more comma-separated options. Descriptions can be inconsistent when
231+
tags are added or removed at the same time.
234232
+
235233
** 'tags[=<bool-value>]': Instead of only considering annotated tags,
236234
consider lightweight tags as well.
@@ -283,13 +281,11 @@ endif::git-rev-list[]
283281
'%gE':: reflog identity email (respecting .mailmap, see
284282
linkgit:git-shortlog[1] or linkgit:git-blame[1])
285283
'%gs':: reflog subject
286-
'%(trailers[:options])':: display the trailers of the body as
287-
interpreted by
288-
linkgit:git-interpret-trailers[1]. The
289-
`trailers` string may be followed by a colon
290-
and zero or more comma-separated options.
291-
If any option is provided multiple times the
292-
last occurrence wins.
284+
'%(trailers[:<options>])'::
285+
display the trailers of the body as interpreted by
286+
linkgit:git-interpret-trailers[1]. The `trailers` string may be followed by
287+
a colon and zero or more comma-separated options. If any option is provided
288+
multiple times, the last occurrence wins.
293289
+
294290
** 'key=<key>': only show trailers with specified <key>. Matching is done
295291
case-insensitively and trailing colon is optional. If option is

0 commit comments

Comments
 (0)