kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

docs: correct trailer `key_value_separator` description 

The description for `key_value_separator` incorrectly states that this
separator is inserted between trailer lines, which appears likely to
have been incorrectly copied from `separator` when this option was
added.

Update the description to correctly indicate that it is a separator that
appears between the key and the value of each trailer.

Signed-off-by: Brian Lyles <brianmlyles@gmail.com>
Acked-by: Linus Arver <linusa@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Brian Lyles 2024-03-18 00:38:01 -05:00 committed by Junio C Hamano
parent 133db54dab
commit cb85ed1eb4
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/pretty-formats.txt
View File

@ -302,8 +302,8 @@ option is given with no value, it's enabled.
** 'keyonly[=<bool>]': only show the key part of the trailer.
** 'valueonly[=<bool>]': only show the value part of the trailer.
** 'key_value_separator=<sep>': specify a separator inserted between
trailer lines. When this option is not given each trailer key-value
pair is separated by ": ". Otherwise it shares the same semantics
the key and value of each trailer. When this option is not given each trailer
key-value pair is separated by ": ". Otherwise it shares the same semantics
as 'separator=<sep>' above.

NOTE: Some placeholders may depend on other options given to the