mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: trailer: drop "commit message part" phrasing

Browse Source 
The command can take inputs that are either just a commit message, or
an email-like output such as git-format-patch which includes a commit
message, "---" divider, and patch part. The existing explanation blends
these two inputs together in the first sentence

    This command reads some patches or commit messages

which then necessitates using the "commit message part" phrasing (as
opposed to just "commit message") because the input is ambiguous per the
above definition.

This change separates the two input types and explains them separately,
and so there is no longer a need to use the "commit message part"
phrase.

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:44 +00:00
committed by Junio C Hamano
parent 00432a36e2
commit 94f15fe5d5
1 changed files with 20 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -18,17 +18,23 @@ 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.
This command reads some patches or commit messages from either the This command reads commit messages from either the
<file> arguments or the standard input if no <file> is specified. If <file> arguments or the standard input if no <file> is specified.
`--parse` is specified, the output consists of the parsed trailers. If `--parse` is specified, the output consists of the parsed trailers.
Otherwise, this command applies the arguments passed using the Otherwise, this command applies the arguments passed using the
`--trailer` option, if any, to the commit message part of each input `--trailer` option, if any, to each input file. The result is emitted on the
file. The result is emitted on the standard output. standard output.
This command can also operate on the output of linkgit:git-format-patch[1],
which is more elaborate than a plain commit message. Namely, such output
includes a commit message (as above), a "---" divider line, and a patch part.
For these inputs, the divider and patch parts are not modified by
this command and are emitted as is on the output, unless
`--no-divider` is specified.
Some configuration variables control the way the `--trailer` arguments Some configuration variables control the way the `--trailer` arguments
are applied to each commit message and the way any existing trailer in are applied to each input and the way any existing trailer in
the commit message is changed. They also make it possible to the input is changed. They also make it possible to
automatically add some trailers. automatically add some trailers.
By default, a '<token>=<value>' or '<token>:<value>' argument given By default, a '<token>=<value>' or '<token>:<value>' argument given
@ -36,7 +42,7 @@ using `--trailer` will be appended after the existing trailers only if
the last trailer has a different (<token>, <value>) pair (or if there the last trailer has a different (<token>, <value>) pair (or if there
is no existing trailer). The <token> and <value> parts will be trimmed is no existing trailer). The <token> and <value> parts will be trimmed
to remove starting and trailing whitespace, and the resulting trimmed to remove starting and trailing whitespace, and the resulting trimmed
<token> and <value> will appear in the message like this: <token> and <value> will appear in the output like this:
------------------------------------------------ ------------------------------------------------
token: value token: value
@ -47,19 +53,17 @@ This means that the trimmed <token> and <value> will be separated by
By default the new trailer will appear at the end of all the existing By default the new trailer will appear at the end of all the existing
trailers. If there is no existing trailer, the new trailer will appear trailers. If there is no existing trailer, the new trailer will appear
after the commit message part of the output, and, if there is no line at the end of the input. A blank line will be added before the new
with only spaces at the end of the commit message part, one blank line trailer if there isn't one already.
will be added before the new trailer.
Existing trailers are extracted from the input message by looking for Existing trailers are extracted from the input by looking for
a group of one or more lines that (i) is all trailers, or (ii) contains at a group of one or more lines that (i) is all trailers, or (ii) contains at
least one Git-generated or user-configured trailer and consists of at least one Git-generated or user-configured trailer and consists of at
least 25% trailers. least 25% trailers.
The group must be preceded by one or more empty (or whitespace-only) lines. The group must be preceded by one or more empty (or whitespace-only) lines.
The group must either be at the end of the message or be the last The group must either be at the end of the input or be the last
non-whitespace lines before a line that starts with '---' (followed by a non-whitespace lines before a line that starts with '---' (followed by a
space or the end of the line). Such three minus signs start the patch space or the end of the line).
part of the message. See also `--no-divider` below.
When reading trailers, there can be no whitespace before or inside the When reading trailers, there can be no whitespace before or inside the
token, but any number of regular space and tab characters are allowed token, but any number of regular space and tab characters are allowed