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 <andy.koppe@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Andy Koppe committed
Aug 20, 2023 at 19:50 UTC
31a922f8383ea75b5757d2f9d0615c85b2083b5a
1 file changed
+10
-14
Documentation/pretty-formats.txt
+10
-14
@@ -224,13 +224,11 @@ The placeholders are:
224
linkgit:git-rev-list[1])
225
'%d':: ref names, like the --decorate option of linkgit:git-log[1]
226
'%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.
232
+
233
** 'tags[=<bool-value>]': Instead of only considering annotated tags,
234
consider lightweight tags as well.
@@ -283,13 +281,11 @@ endif::git-rev-list[]
281
'%gE':: reflog identity email (respecting .mailmap, see
282
linkgit:git-shortlog[1] or linkgit:git-blame[1])
283
'%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.
289
+
290
** 'key=<key>': only show trailers with specified <key>. Matching is done
291
case-insensitively and trailing colon is optional. If option is