diff options
| author | Brian Lyles <brianmlyles@gmail.com> | 2024-03-18 00:38:02 -0500 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2024-03-18 09:36:00 -0700 |
| commit | bff85a338cfd15b0574f7366b81199d27b19505e (patch) | |
| tree | e82a27978878bb6f8662bc90ce38b7b9fe1a2e52 | |
| parent | cb85ed1eb4df9b0ae3f2020a6c1036cd493c5284 (diff) | |
| download | git-bff85a338cfd15b0574f7366b81199d27b19505e.tar.gz | |
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>
| -rw-r--r-- | Documentation/pretty-formats.txt | 12 |
1 files changed, 5 insertions, 7 deletions
diff --git a/Documentation/pretty-formats.txt b/Documentation/pretty-formats.txt index 6f0d3daa4d..51024a8c23 100644 --- a/Documentation/pretty-formats.txt +++ b/Documentation/pretty-formats.txt @@ -288,9 +288,8 @@ option is given with no value, it's enabled. `Reviewed-by`. ** 'only[=<bool>]': select whether non-trailer lines from the trailer block should be included. -** 'separator=<sep>': specify a separator inserted between trailer - lines. When this option is not given each trailer line is - terminated with a line feed character. The string <sep> may contain +** 'separator=<sep>': specify the separator inserted between trailer + lines. Defaults to a line feed character. The string <sep> may contain the literal formatting codes described above. To use comma as separator one must use `%x2C` as it would otherwise be parsed as next option. E.g., `%(trailers:key=Ticket,separator=%x2C )` @@ -301,10 +300,9 @@ option is given with no value, it's enabled. `%(trailers:only,unfold=true)` unfolds and shows all trailer lines. ** '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 - 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. +** 'key_value_separator=<sep>': specify the separator inserted between + the key and value of each trailer. Defaults to ": ". Otherwise it + shares the same semantics as 'separator=<sep>' above. NOTE: Some placeholders may depend on other options given to the revision traversal engine. For example, the `%g*` reflog options will |