diff mbox series

[10/11] doc: trailer: mention 'key' in DESCRIPTION

Message ID 2c04a5ba7f0ac16fe648c7dac2684523429378af.1683566870.git.gitgitgadget@gmail.com (mailing list archive)
State Accepted
Commit e45e009f5df4f065984f04bb8fc9f80570d222d7
Headers show
Series docs: interpret-trailers: reword and add examples | expand

Commit Message

Linus Arver May 8, 2023, 5:27 p.m. UTC 
From: Linus Arver <linusa@google.com>

The 'key' option is used frequently in the examples at the bottom but
there is no mention of it in the description.

Signed-off-by: Linus Arver <linusa@google.com>
---
 Documentation/git-interpret-trailers.txt | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt
index c9b82ceba34..119dcd64f34 100644
--- a/Documentation/git-interpret-trailers.txt
+++ b/Documentation/git-interpret-trailers.txt
@@ -43,7 +43,9 @@  token: value
 ------------------------------------------------
 
 This means that the trimmed <token> and <value> will be separated by
-`': '` (one colon followed by one space).
+`': '` (one colon followed by one space). If the <token> should have a different
+string representation than itself, then the 'key' can be configured with
+'trailer.<token>.key'.
 
 By default the new trailer will appear at the end of all the existing
 trailers. If there is no existing trailer, the new trailer will appear