docs: adjust trailer `separator` and `key_value_separator` language
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>
Brian Lyles committed
Mar 18, 2024 at 00:38 UTC
bff85a338cfd15b0574f7366b81199d27b19505e
1 file changed
+5
-7
Documentation/pretty-formats.txt
+5
-7
@@ -288,9 +288,8 @@ option is given with no value, it's enabled.
288
`Reviewed-by`.
289
** 'only[=<bool>]': select whether non-trailer lines from the trailer
290
block should be included.
291
-** 'separator=<sep>': specify a separator inserted between trailer
292
- lines. When this option is not given each trailer line is
293
- terminated with a line feed character. The string <sep> may contain
291
+** 'separator=<sep>': specify the separator inserted between trailer
292
+ lines. Defaults to a line feed character. The string <sep> may contain
293
the literal formatting codes described above. To use comma as
294
separator one must use `%x2C` as it would otherwise be parsed as
295
next option. E.g., `%(trailers:key=Ticket,separator=%x2C )`
@@ -301,10 +300,9 @@ option is given with no value, it's enabled.
300
`%(trailers:only,unfold=true)` unfolds and shows all trailer lines.
301
** 'keyonly[=<bool>]': only show the key part of the trailer.
302
** 'valueonly[=<bool>]': only show the value part of the trailer.
304
-** 'key_value_separator=<sep>': specify a separator inserted between
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.
303
+** 'key_value_separator=<sep>': specify the separator inserted between
304
+ the key and value of each trailer. Defaults to ": ". Otherwise it
305
+ shares the same semantics as 'separator=<sep>' above.
306
307
NOTE: Some placeholders may depend on other options given to the
308
revision traversal engine. For example, the `%g*` reflog options will