]> git.ipfire.org Git - thirdparty/git.git/commitdiff
docs: correct trailer `key_value_separator` description
authorBrian Lyles <brianmlyles@gmail.com>
Mon, 18 Mar 2024 05:38:01 +0000 (00:38 -0500)
committerJunio C Hamano <gitster@pobox.com>
Mon, 18 Mar 2024 16:35:49 +0000 (09:35 -0700)
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>
Documentation/pretty-formats.txt

index 23f63358871ad3732f8c4716678318237bc94870..6f0d3daa4d023472d6c2d9e583ec92c8e43289c6 100644 (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