Skip to content

Commit bc0a7c9

Browse files
committed
Merge branch 'kh/doc-trailers' into seen
Documentation updates. * kh/doc-trailers: doc: interpret-trailers: explain key format doc: interpret-trailers: stop fixating on RFC 822
2 parents 5ea4e74 + f2e5902 commit bc0a7c9

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

Documentation/git-interpret-trailers.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ git interpret-trailers [--in-place] [--trim-empty]
1414

1515
DESCRIPTION
1616
-----------
17-
Add or parse _trailer_ lines that look similar to RFC 822 e-mail
18-
headers, at the end of the otherwise free-form part of a commit
19-
message. For example, in the following commit message
17+
Add or parse _trailer_ key-value pairs at the end of the otherwise
18+
free-form part of a commit message. For example, in the following commit
19+
message
2020

2121
------------------------------------------------
2222
subject
@@ -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.
@@ -107,9 +110,6 @@ key: This is a very long value, with spaces and
107110
newlines in it.
108111
------------------------------------------------
109112

110-
Note that trailers do not follow (nor are they intended to follow) many of the
111-
rules for RFC 822 headers. For example they do not follow the encoding rule.
112-
113113
OPTIONS
114114
-------
115115
`--in-place`::

0 commit comments

Comments
 (0)