Skip to content

Commit f2e5902

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 painting their trailers by numbers (by the documentation examples). The previous commit for “key–value pairs” allows us to segue right into describing these lines as consisting of a key and a value, which is our opening to describing the key format. Just like *trailer* we emphasize these two first standalone word mentions. They are then mostly used in placeholders throughout the rest of the document (<key> and <value>). 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 3dec6cc commit f2e5902

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

Documentation/git-interpret-trailers.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,10 @@ Signed-off-by: Alice <alice@example.com>
2727
Signed-off-by: Bob <bob@example.com>
2828
------------------------------------------------
2929

30-
the last two lines starting with `Signed-off-by` are trailers.
30+
the last two lines starting with `Signed-off-by` are trailers. These two
31+
trailers have the _key_ `Signed-off-by` and a _value_ (Alice and Bob).
32+
The key must consist of only ASCII alphanumeric characters and hyphens
33+
(`-`). The hyphens serve as interword separators.
3134

3235
This command reads commit messages from either the
3336
_<file>_ arguments or the standard input if no _<file>_ is specified.

0 commit comments

Comments
 (0)