From: Linus Arver <linusa@google.com>
Date: Mon, 18 Mar 2024 06:42:59 GMT
Subject: Re: [PATCH v2 2/2] docs: adjust trailer `separator` and `key_value_separator` language
Message-ID: <owlyr0g82g7g.fsf@fine.c.googlers.com>
In-Reply-To: <20240318053848.185201-2-brianmlyles@gmail.com>

Brian Lyles <brianmlyles@gmail.com> writes:

This v2 LGTM. Thanks!

> 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>
> ---
> This commit is new in v2 per Linus' suggestion[1].
>
> [1]: https://lore.kernel.org/git/owly1q8a4qhh.fsf@fine.c.googlers.com/
>
>  Documentation/pretty-formats.txt | 12 +++++-------
>  1 file changed, 5 insertions(+), 7 deletions(-)
>
> diff --git a/Documentation/pretty-formats.txt b/Documentation/pretty-formats.txt
> index e1788cb07a..8ee940b6a4 100644
> --- a/Documentation/pretty-formats.txt
> +++ b/Documentation/pretty-formats.txt
> @@ -316,9 +316,8 @@ multiple times, the last occurrence wins.
>     `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 )`
> @@ -329,10 +328,9 @@ multiple times, the last occurrence 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
> -   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
> -- 
> 2.43.2