doc: trailer: mention 'key' in DESCRIPTION
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> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Linus Arver committed
Jun 15, 2023 at 02:53 UTC
eda2c44c8b999547c0726baa7a12a40960ac5d6a
1 file changed
+4
-1
Documentation/git-interpret-trailers.txt
+4
-1
@@ -49,7 +49,10 @@ token: value
49
------------------------------------------------
50
51
This means that the trimmed <token> and <value> will be separated by
52
-`': '` (one colon followed by one space).
52
+`': '` (one colon followed by one space). For convenience, the <token> can be a
53
+shortened string key (e.g., "sign") instead of the full string which should
54
+appear before the separator on the output (e.g., "Signed-off-by"). This can be
55
+configured using the 'trailer.<token>.key' configuration variable.
56
57
By default the new trailer will appear at the end of all the existing
58
trailers. If there is no existing trailer, the new trailer will appear