development/git
development/git
1
0
Fork 0
mirror of https://github.com/git/git synced 2024-07-05 00:58:49 +00:00
Code Issues Projects Releases Wiki Activity

docs: adjust trailer separator and key_value_separator language

Browse Source 
The language describing the trailer separator and key-value separator
default value is overly complicated.

Indicate the default with simpler "Defaults to ..." language.

Suggested-by: Linus Arver <linusa@google.com>
Signed-off-by: Brian Lyles <brianmlyles@gmail.com>
Acked-by: Linus Arver <linusa@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Brian Lyles 2024-03-18 00:38:02 -05:00 committed by Junio C Hamano
parent cb85ed1eb4
commit bff85a338c
1 changed files with 5 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Documentation/pretty-formats.txt
View File

@ -288,9 +288,8 @@ option is given with no value, it's enabled.
`Reviewed-by`. `Reviewed-by`.
** 'only[=<bool>]': select whether non-trailer lines from the trailer ** 'only[=<bool>]': select whether non-trailer lines from the trailer
block should be included. block should be included.
** 'separator=<sep>': specify a separator inserted between trailer ** 'separator=<sep>': specify the separator inserted between trailer
lines. When this option is not given each trailer line is lines. Defaults to a line feed character. The string <sep> may contain
terminated with a line feed character. The string <sep> may contain
the literal formatting codes described above. To use comma as the literal formatting codes described above. To use comma as
separator one must use `%x2C` as it would otherwise be parsed as separator one must use `%x2C` as it would otherwise be parsed as
next option. E.g., `%(trailers:key=Ticket,separator=%x2C )` next option. E.g., `%(trailers:key=Ticket,separator=%x2C )`
@ -301,10 +300,9 @@ option is given with no value, it's enabled.
`%(trailers:only,unfold=true)` unfolds and shows all trailer lines. `%(trailers:only,unfold=true)` unfolds and shows all trailer lines.
** 'keyonly[=<bool>]': only show the key part of the trailer. ** 'keyonly[=<bool>]': only show the key part of the trailer.
** 'valueonly[=<bool>]': only show the value part of the trailer. ** 'valueonly[=<bool>]': only show the value part of the trailer.
** 'key_value_separator=<sep>': specify a separator inserted between ** 'key_value_separator=<sep>': specify the separator inserted between
the key and value of each trailer. When this option is not given each trailer the key and value of each trailer. Defaults to ": ". Otherwise it
key-value pair is separated by ": ". Otherwise it shares the same semantics shares the same semantics as 'separator=<sep>' above.
as 'separator=<sep>' above.
NOTE: Some placeholders may depend on other options given to the NOTE: Some placeholders may depend on other options given to the
revision traversal engine. For example, the `%g*` reflog options will revision traversal engine. For example, the `%g*` reflog options will