git-for-windows/git
1
0
Fork 0
mirror of https://github.com/git-for-windows/git.git synced 2026-06-14 14:34:33 -05:00
Code Issues Packages Projects Releases 335 Wiki Activity

doc: trailer: add more examples in DESCRIPTION

Browse Source 
Be more up-front about what trailers are in practice with examples, to
give the reader a visual cue while they go on to read the rest of the
description.

Also add an example for multiline values.

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:50 +00:00
committed by Junio C Hamano
parent eda2c44c8b
commit d57fa7fc73
1 changed files with 18 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
Documentation/git-interpret-trailers.txt
View File

@@ -16,7 +16,18 @@ DESCRIPTION
----------- -----------
Add or parse 'trailer' lines that look similar to RFC 822 e-mail Add or parse 'trailer' lines that look similar to RFC 822 e-mail
headers, at the end of the otherwise free-form part of a commit headers, at the end of the otherwise free-form part of a commit
message. message. For example, in the following commit message
------------------------------------------------
subject
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
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.
This command reads commit messages from either the This command reads commit messages from either the
<file> arguments or the standard input if no <file> is specified. <file> arguments or the standard input if no <file> is specified.
@@ -73,7 +84,12 @@ When reading trailers, there can be no whitespace before or inside the
between the <token> and the separator. There can be whitespaces before, between the <token> and the separator. There can be whitespaces before,
inside or after the <value>. The <value> may be split over multiple lines inside or after the <value>. The <value> may be split over multiple lines
with each subsequent line starting with at least one whitespace, like with each subsequent line starting with at least one whitespace, like
the "folding" in RFC 822. the "folding" in RFC 822. Example:
------------------------------------------------
token: This is a very long value, with spaces and
newlines in it.
------------------------------------------------
Note that trailers do not follow (nor are they intended to follow) many of the Note that trailers do not follow (nor are they intended to follow) many of the
rules for RFC 822 headers. For example they do not follow the encoding rule. rules for RFC 822 headers. For example they do not follow the encoding rule.