mirror/git
1
0
Fork 0
mirror of https://github.com/git/git.git synced 2024-09-28 19:42:15 +02:00
Code

pretty-formats: enclose options in angle brackets

Browse Source 
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>
This commit is contained in:
Andy Koppe 2023-08-20 19:50:03 +01:00 committed by Junio C Hamano
parent 014aa1d1aa
commit 31a922f838
1 changed files with 10 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
Documentation/pretty-formats.txt
View File

@ -224,13 +224,11 @@ The placeholders are:
linkgit:git-rev-list[1]) linkgit:git-rev-list[1])
'%d':: ref names, like the --decorate option of linkgit:git-log[1] '%d':: ref names, like the --decorate option of linkgit:git-log[1]
'%D':: ref names without the " (", ")" wrapping. '%D':: ref names without the " (", ")" wrapping.
'%(describe[:options])':: human-readable name, like '%(describe[:<options>])'::
linkgit:git-describe[1]; empty string for human-readable name, like linkgit:git-describe[1]; empty string for
undescribable commits. The `describe` string undescribable commits. The `describe` string may be followed by a colon and
may be followed by a colon and zero or more zero or more comma-separated options. Descriptions can be inconsistent when
comma-separated options. Descriptions can be tags are added or removed at the same time.
inconsistent when tags are added or removed at
the same time.
+ +
** 'tags[=<bool-value>]': Instead of only considering annotated tags, ** 'tags[=<bool-value>]': Instead of only considering annotated tags,
consider lightweight tags as well. consider lightweight tags as well.
@ -283,13 +281,11 @@ endif::git-rev-list[]
'%gE':: reflog identity email (respecting .mailmap, see '%gE':: reflog identity email (respecting .mailmap, see
linkgit:git-shortlog[1] or linkgit:git-blame[1]) linkgit:git-shortlog[1] or linkgit:git-blame[1])
'%gs':: reflog subject '%gs':: reflog subject
'%(trailers[:options])':: display the trailers of the body as '%(trailers[:<options>])'::
interpreted by display the trailers of the body as interpreted by
linkgit:git-interpret-trailers[1]. The linkgit:git-interpret-trailers[1]. The `trailers` string may be followed by
`trailers` string may be followed by a colon a colon and zero or more comma-separated options. If any option is provided
and zero or more comma-separated options. multiple times, the last occurrence wins.
If any option is provided multiple times the
last occurrence wins.
+ +
** 'key=<key>': only show trailers with specified <key>. Matching is done ** 'key=<key>': only show trailers with specified <key>. Matching is done
case-insensitively and trailing colon is optional. If option is case-insensitively and trailing colon is optional. If option is