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>
Brian Lyles committed
Mar 18, 2024 at 00:38 UTC
cb85ed1eb4df9b0ae3f2020a6c1036cd493c5284
1 file changed
+2
-2
Documentation/pretty-formats.txt
+2
-2
@@ -302,8 +302,8 @@ option is given with no value, it's enabled.
302
** 'keyonly[=<bool>]': only show the key part of the trailer.
303
** 'valueonly[=<bool>]': only show the value part of the trailer.
304
** 'key_value_separator=<sep>': specify a separator inserted between
305
- trailer lines. When this option is not given each trailer key-value
306
- pair is separated by ": ". Otherwise it shares the same semantics
305
+ the key and value of each trailer. When this option is not given each trailer
306
+ key-value pair is separated by ": ". Otherwise it shares the same semantics
307
as 'separator=<sep>' above.
308
309
NOTE: Some placeholders may depend on other options given to the