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>
This commit is contained in:
Linus Arver
2023-06-15 02:53:49 +00:00
committed by Junio C Hamano
parent dc8937fbb9
commit eda2c44c8b

View File

@@ -49,7 +49,10 @@ token: value
------------------------------------------------ ------------------------------------------------
This means that the trimmed <token> and <value> will be separated by 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 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 trailers. If there is no existing trailer, the new trailer will appear