Skip to content

Commit eda2c44

Browse files
Linus Arvergitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent dc8937f commit eda2c44

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

Documentation/git-interpret-trailers.txt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,10 @@ token: value
4949
------------------------------------------------
5050

5151
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.
5356

5457
By default the new trailer will appear at the end of all the existing
5558
trailers. If there is no existing trailer, the new trailer will appear

0 commit comments

Comments
 (0)