From: kristofferhaugsbakk@fastmail.com
To: git@vger.kernel.org
Cc: Kristoffer Haugsbakk <code@khaugsbakk.name>
Subject: [PATCH 2/4] doc: am: say that --message-id adds a trailer
Date: Mon, 9 Feb 2026 18:34:35 +0100 [thread overview]
Message-ID: <message-id_trailer.323@msgid.xyz> (raw)
In-Reply-To: <doc_am_gitlinks_and_am.messageId.321@msgid.xyz>
From: Kristoffer Haugsbakk <code@khaugsbakk.name>
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>
---
Documentation/git-am.adoc | 16 +++++++++-------
1 file changed, 9 insertions(+), 7 deletions(-)
diff --git a/Documentation/git-am.adoc b/Documentation/git-am.adoc
index 70c605b4156..5e0d6e6fe02 100644
--- a/Documentation/git-am.adoc
+++ b/Documentation/git-am.adoc
@@ -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.
--
2.53.0.26.g2afa8602a26
next prev parent reply other threads:[~2026-02-09 17:36 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-02-09 17:34 [PATCH 0/4] doc: am: improve command linking and add am.messageId kristofferhaugsbakk
2026-02-09 17:34 ` [PATCH 1/4] doc: am: normalize git(1) command links kristofferhaugsbakk
2026-02-11 17:32 ` Kristoffer Haugsbakk
2026-02-09 17:34 ` kristofferhaugsbakk [this message]
2026-02-09 17:34 ` [PATCH 3/4] doc: am: add missing config am.messageId kristofferhaugsbakk
2026-02-09 17:34 ` [PATCH 4/4] doc: am: fill out hook discussion kristofferhaugsbakk
2026-02-09 21:57 ` [PATCH 0/4] doc: am: improve command linking and add am.messageId D. Ben Knoble
2026-02-09 22:22 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=message-id_trailer.323@msgid.xyz \
--to=kristofferhaugsbakk@fastmail.com \
--cc=code@khaugsbakk.name \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox