Skip to content

Commit 3c18135

Browse files
LemmingAvalanchegitster
authored andcommitted
doc: am: say that --message-id adds a trailer
The option `--message-id` was added in a078f73 (git-am: add --message-id/--no-message-id, 2014-11-25) back when git-interpret- trailers(1) was relatively new. Let’s spell out that it is a trailer and link to the dedicated trailer command. Also use inline-verbatim for `Message-ID`. Also link to git-interpret-trailers(1) on `--signoff`. Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name> Signed-off-by: Junio C Hamano <gitster@pobox.com>
1 parent b679ee0 commit 3c18135

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

Documentation/git-am.adoc

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,10 @@ OPTIONS
3737

3838
-s::
3939
--signoff::
40-
Add a `Signed-off-by` trailer to the commit message, using
41-
the committer identity of yourself.
42-
See the signoff option in linkgit:git-commit[1] for more information.
40+
Add a `Signed-off-by` trailer to the commit message (see
41+
linkgit:git-interpret-trailers[1]), using the committer identity
42+
of yourself. See the signoff option in linkgit:git-commit[1]
43+
for more information.
4344

4445
-k::
4546
--keep::
@@ -83,10 +84,11 @@ OPTIONS
8384

8485
-m::
8586
--message-id::
86-
Pass the `-m` flag to linkgit:git-mailinfo[1],
87-
so that the Message-ID header is added to the commit message.
88-
The `am.messageid` configuration variable can be used to specify
89-
the default behaviour.
87+
Pass the `-m` flag to linkgit:git-mailinfo[1], so that the
88+
`Message-ID` header is added as a trailer (see
89+
linkgit:git-interpret-trailers[1]). The `am.messageid`
90+
configuration variable can be used to specify the default
91+
behaviour.
9092

9193
--no-message-id::
9294
Do not add the Message-ID header to the commit message.

0 commit comments

Comments
 (0)