Skip to content

Commit 975c9a4

Browse files
LemmingAvalanchegitster
authored andcommitted
doc: interpret-trailers: explain key format
A trailer key must consist of ASCII alphanumeric characters and hyphens *only*. Let’s document it explicitly instead of relying on readers being conservative and only basing their trailer keys on the documentation examples.[1] The previous commit provided us with an appropriate paragraph to describe the key format. † 1: Technically they would then miss out on using digits in them since all of the example keys just use letters and hyphens Reported-by: Brendan Jackman <jackmanb@google.com> Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name> Signed-off-by: Junio C Hamano <gitster@pobox.com>
1 parent d1673e5 commit 975c9a4

1 file changed

Lines changed: 2 additions & 1 deletion

File tree

Documentation/git-interpret-trailers.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ Add or parse trailers metadata at the end of the otherwise
1818
free-form part of a commit message, or any other kind of text.
1919

2020
A _trailer_ in its simplest form is a key-value pair with a colon as a
21-
separator. A _trailer block_ consists of one or more trailers. The
21+
separator. The _key_ consists of ASCII alphanumeric characters and
22+
hyphens (`-`). A _trailer block_ consists of one or more trailers. The
2223
trailer block needs to be preceded by a blank line, where a _blank line_
2324
is either an empty or a whitespace-only line. For example, in the
2425
following commit message

0 commit comments

Comments
 (0)