From: Brian Lyles <brianmlyles@gmail.com>
To: git@vger.kernel.org
Cc: Brian Lyles <brianmlyles@gmail.com>
Subject: [PATCH] docs: correct trailer `key_value_separator` description
Date: Fri, 15 Mar 2024 22:55:42 -0500 [thread overview]
Message-ID: <20240316035612.752910-1-brianmlyles@gmail.com> (raw)
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>
---
Documentation/pretty-formats.txt | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/Documentation/pretty-formats.txt b/Documentation/pretty-formats.txt
index d38b4ab566..4839c2843c 100644
--- a/Documentation/pretty-formats.txt
+++ b/Documentation/pretty-formats.txt
@@ -329,9 +329,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
- trailer lines. When this option is not given each trailer key-value
- pair is separated by ": ". Otherwise it shares the same semantics
+** 'key_value_separator=<sep>': specify a separator inserted between each
+ trailer's key and value. When this option is not given each trailer
+ key-value pair is separated by ": ". Otherwise it shares the same semantics
as 'separator=<sep>' above.
NOTE: Some placeholders may depend on other options given to the
--
2.43.0
next reply other threads:[~2024-03-16 3:56 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-16 3:55 Brian Lyles [this message]
2024-03-16 6:53 ` [PATCH] docs: correct trailer `key_value_separator` description Linus Arver
2024-03-18 4:49 ` Brian Lyles
2024-03-18 6:29 ` Linus Arver
2024-03-18 16:02 ` Junio C Hamano
2024-03-18 18:15 ` Kristoffer Haugsbakk
2024-03-18 19:13 ` Junio C Hamano
2024-03-19 7:21 ` Linus Arver
2024-03-18 5:38 ` [PATCH v2 1/2] " Brian Lyles
2024-03-18 16:34 ` Junio C Hamano
2024-03-18 5:38 ` [PATCH v2 2/2] docs: adjust trailer `separator` and `key_value_separator` language Brian Lyles
2024-03-18 6:42 ` Linus Arver
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240316035612.752910-1-brianmlyles@gmail.com \
--to=brianmlyles@gmail.com \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).