git-for-windows/git
1
0
Fork 0
mirror of https://github.com/git-for-windows/git.git synced 2026-04-10 08:22:54 -05:00
Code Issues Packages Projects Releases 335 Wiki Activity

doc: interpret-trailers: explain key format

Browse Source 
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>
This commit is contained in:
Kristoffer Haugsbakk
2026-03-30 23:11:33 +02:00
committed by Junio C Hamano
parent 3dec6ccd13
commit f2e5902b0a
1 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
Documentation/git-interpret-trailers.adoc
View File

@@ -27,7 +27,10 @@ Signed-off-by: Alice <alice@example.com>
Signed-off-by: Bob <bob@example.com>
------------------------------------------------
the last two lines starting with `Signed-off-by` are trailers.
the last two lines starting with `Signed-off-by` are trailers. These two
trailers have the _key_ `Signed-off-by` and a _value_ (Alice and Bob).
The key must consist of only ASCII alphanumeric characters and hyphens
(`-`). The hyphens serve as interword separators.
This command reads commit messages from either the
_<file>_ arguments or the standard input if no _<file>_ is specified.