]> git.ipfire.org Git - thirdparty/git.git/commitdiff
doc: am: say that --message-id adds a trailer
authorKristoffer Haugsbakk <code@khaugsbakk.name>
Mon, 9 Feb 2026 17:34:35 +0000 (18:34 +0100)
committerJunio C Hamano <gitster@pobox.com>
Mon, 9 Feb 2026 18:34:04 +0000 (10:34 -0800)
The option `--message-id` was added in a078f732 (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>
Documentation/git-am.adoc

index 0f9980603d24c2ee2a79c7afc3aab0b796f618f0..ba05c703fcab3313201bbee5e1fba091a1737073 100644 (file)
@@ -37,9 +37,10 @@ OPTIONS
 
 -s::
 --signoff::
-       Add a `Signed-off-by` trailer to the commit message, using
-       the committer identity of yourself.
-       See the signoff option in linkgit:git-commit[1] for more information.
+       Add a `Signed-off-by` trailer to the commit message (see
+       linkgit:git-interpret-trailers[1]), using the committer identity
+       of yourself.  See the signoff option in linkgit:git-commit[1]
+       for more information.
 
 -k::
 --keep::
@@ -83,10 +84,11 @@ OPTIONS
 
 -m::
 --message-id::
-       Pass the `-m` flag to linkgit:git-mailinfo[1],
-       so that the Message-ID header is added to the commit message.
-       The `am.messageid` configuration variable can be used to specify
-       the default behaviour.
+       Pass the `-m` flag to linkgit:git-mailinfo[1], so that the
+       `Message-ID` header is added as a trailer (see
+       linkgit:git-interpret-trailers[1]).  The `am.messageid`
+       configuration variable can be used to specify the default
+       behaviour.
 
 --no-message-id::
        Do not add the Message-ID header to the commit message.