Re: [PATCH 5/5] pretty format %(trailers): add a "key_value_separator"

From: Christian Couder <christian.couder@gmail.com>
Date: Dec 5, 2020, 07:13 UTC
Message-ID: <CAP8UFD1q7ab5wyhmxknoM8FC5y_QqrF34HCRiS3=MP8YLCx20A@mail.gmail.com>
In-Reply-To: <20201205013918.18981-6-avarab@gmail.com>

On Sat, Dec 5, 2020 at 2:39 AM Ævar Arnfjörð Bjarmason <avarab@gmail.com> wrote:

>
> As noted in a previous commit which added "keyonly" it's needlessly

Maybe add a comma after `"keyonly"` and s/"keyonly"/the "keyonly" option/

> hard to use the "log" machinery to produce machine-readable output for
> %(trailers). with the combination of the existing "separator" and this

s/with/With/ s/"separator"/"separator" option/

> new "key_value_separator" this becomes trivial, as seen by the test

s/"key_value_separator"/"key_value_separator" option,/

> being added here.

Show 12 quoted lines

> diff --git a/Documentation/pretty-formats.txt b/Documentation/pretty-formats.txt
> index d080f0d2476..369d243eae9 100644
> --- a/Documentation/pretty-formats.txt
> +++ b/Documentation/pretty-formats.txt
> @@ -286,6 +286,10 @@ multiple times the last occurance wins.
>     `%(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
> +   trailer lines. When this option is not given each trailer key-value
> +   pair separated by ": ". Otherwise it shares the same semantics as
> +   'separator=<SEP>' above.

The above is not very clear to me.

Maybe:

s/between trailer lines/between a key and its associated value/ s/each trailer key-value pair separated by/each key and its associated value are separated by/