Subject: Re: [PATCH v2 1/2] docs: correct trailer `key_value_separator` description

From: Junio C Hamano <[email-masked]>
Date: Mon, 18 Mar 2024 09:34:43 -0700

Brian Lyles <[email-masked]> writes:

> 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 <[email-masked]>
> ---
> Changes since v1:
> - Minor wording tweak
> - Minor wrapping tweak
>
>  Documentation/pretty-formats.txt | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/pretty-formats.txt b/Documentation/pretty-formats.txt
> index d38b4ab566..e1788cb07a 100644
> --- a/Documentation/pretty-formats.txt
> +++ b/Documentation/pretty-formats.txt
> @@ -330,8 +330,8 @@ multiple times, the last occurrence wins.
>  ** '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
> -   trailer lines. When this option is not given each trailer key-value
> -   pair is separated by ": ". Otherwise it shares the same semantics
> +   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.

I was tempted to insert a comma before "each trailer key-value pair"
while queuing this, but the missing comma is shared with other
entries of the same list, so I'd queue it as-is.

Thanks.