Skip to content

Commit 03658df

Browse files
committed
Merge branch 'bl/doc-key-val-sep-fix'
The documentation for "%(trailers[:options])" placeholder in the "--pretty" option of commands in the "git log" family has been updated. * bl/doc-key-val-sep-fix: docs: adjust trailer `separator` and `key_value_separator` language docs: correct trailer `key_value_separator` description
2 parents b58cc6a + bff85a3 commit 03658df

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
@@ -316,9 +316,8 @@ multiple times, the last occurrence wins.
316316
`Reviewed-by`.
317317
** 'only[=<bool>]': select whether non-trailer lines from the trailer
318318
block should be included.
319-
** 'separator=<sep>': specify a separator inserted between trailer
320-
lines. When this option is not given each trailer line is
321-
terminated with a line feed character. The string <sep> may contain
319+
** 'separator=<sep>': specify the separator inserted between trailer
320+
lines. Defaults to a line feed character. The string <sep> may contain
322321
the literal formatting codes described above. To use comma as
323322
separator one must use `%x2C` as it would otherwise be parsed as
324323
next option. E.g., `%(trailers:key=Ticket,separator=%x2C )`
@@ -329,10 +328,9 @@ multiple times, the last occurrence wins.
329328
`%(trailers:only,unfold=true)` unfolds and shows all trailer lines.
330329
** 'keyonly[=<bool>]': only show the key part of the trailer.
331330
** 'valueonly[=<bool>]': only show the value part of the trailer.
332-
** 'key_value_separator=<sep>': specify a separator inserted between
333-
trailer lines. When this option is not given each trailer key-value
334-
pair is separated by ": ". Otherwise it shares the same semantics
335-
as 'separator=<sep>' above.
331+
** 'key_value_separator=<sep>': specify the separator inserted between
332+
the key and value of each trailer. Defaults to ": ". Otherwise it
333+
shares the same semantics as 'separator=<sep>' above.
336334

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

0 commit comments

Comments
 (0)