]> git.99rst.org Git - git.git/commitdiff
doc: trailer: mention 'key' in DESCRIPTION
authorLinus Arver <redacted>
Thu, 15 Jun 2023 02:53:49 +0000 (02:53 +0000)
committerJunio C Hamano <redacted>
Thu, 15 Jun 2023 04:42:20 +0000 (21:42 -0700)
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 <redacted>
Signed-off-by: Junio C Hamano <redacted>
Documentation/git-interpret-trailers.txt

index 6016af5c203111ef1cbcb3bb961addc9a4f79aa0..7e77cbb1cad89ae8dc058d20692da03d92d58ab2 100644 (file)
@@ -49,7 +49,10 @@ 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). For convenience, the <token> can be a
+shortened string key (e.g., "sign") instead of the full string which should
+appear before the separator on the output (e.g., "Signed-off-by"). This can be
+configured using the 'trailer.<token>.key' configuration variable.
 
 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
git clone https://git.99rst.org/PROJECT