git/list[1] front-page[2] threads[3] people[4] search[5] about
 

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

From
Junio C Hamano <gitster@pobox.com>
Date
Mar 18, 2024, 16:34 UTC
Message-ID
<xmqq1q87jy70.fsf@gitster.g>
In-Reply-To
<20240318053848.185201-1-brianmlyles@gmail.com>
Brian Lyles <brianmlyles@gmail.com> writes:
Show 30 quoted lines
> 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 <brianmlyles@gmail.com>
> ---
> 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.
Previous: Brian LylesNext: Brian Lyles
Message 10 of 12 in “docs: correct trailer `key_value_separator` description”
  1. docs: correct trailer `key_value_separator` descriptionBrian Lyles, Mar 16, 2024
  2. Linus ArverMar 16, 2024
  3. Brian LylesMar 18, 2024
  4. Linus ArverMar 18, 2024
  5. Junio C HamanoMar 18, 2024
  6. Kristoffer HaugsbakkMar 18, 2024
  7. Junio C HamanoMar 18, 2024
  8. Linus ArverMar 19, 2024
  9. 1/2 docs: correct trailer `key_value_separator` descriptionBrian Lyles, Mar 18, 2024
  10. Junio C HamanoMar 18, 2024
  11. 2/2 docs: adjust trailer `separator` and `key_value_separator` languageBrian Lyles, Mar 18, 2024
  12. Linus ArverMar 18, 2024

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.