Skip to content

Commit bff85a3

Browse files
zivarahgitster
authored andcommitted
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 <[email protected]> Signed-off-by: Brian Lyles <[email protected]> Acked-by: Linus Arver <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent cb85ed1 commit bff85a3

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

Documentation/pretty-formats.txt

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -288,9 +288,8 @@ option is given with no value, it's enabled.
288288
`Reviewed-by`.
289289
** 'only[=<bool>]': select whether non-trailer lines from the trailer
290290
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
294293
the literal formatting codes described above. To use comma as
295294
separator one must use `%x2C` as it would otherwise be parsed as
296295
next option. E.g., `%(trailers:key=Ticket,separator=%x2C )`
@@ -301,10 +300,9 @@ option is given with no value, it's enabled.
301300
`%(trailers:only,unfold=true)` unfolds and shows all trailer lines.
302301
** 'keyonly[=<bool>]': only show the key part of the trailer.
303302
** '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.
308306

309307
NOTE: Some placeholders may depend on other options given to the
310308
revision traversal engine. For example, the `%g*` reflog options will

0 commit comments

Comments
 (0)