* [PATCH] doc: am: revert Message-ID trailer claim
@ 2026-04-11 20:15 kristofferhaugsbakk
0 siblings, 0 replies; only message in thread
From: kristofferhaugsbakk @ 2026-04-11 20:15 UTC (permalink / raw)
To: git; +Cc: Kristoffer Haugsbakk
From: Kristoffer Haugsbakk <code@khaugsbakk.name>
I claimed in 3c18135b (doc: am: say that --message-id adds a trailer,
2026-02-09) that `git am --message-id` adds a Git trailer. But that
isn’t the case; for the case of a commit message with a subject, body,
and no trailer block:
<subject>
<paragrah>
It just appends the line right after `paragraph`:
<subject>
<paragraph>
Message-ID: <message-id_trailer.323@msgid.xyz>
It does work for two other cases though, namely subject-only and with an
existing trailer block.
This is at best an inconsistency and arguably a bug, but we’re at the
trailing end of the release cycle now. So reverting the doc is safer
than making msg-id act as a trailer, for now.
Revert this hunk from commit 3c18135b except the only useful
change (“Also use inline-verbatim for `Message-ID`”).
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
Notes (series):
Topic name: kh/doc-am-message-id-not-trailer
Topic summary: Revert claim that `git am --message-id` adds the msg-id
header as a trailer.
This is based on topic kh/doc-am-xref which was merged to `master` in
05c4af5c (Merge branch 'kh/doc-am-xref', 2026-03-02).
Documentation/git-am.adoc | 9 ++++-----
1 file changed, 4 insertions(+), 5 deletions(-)
diff --git a/Documentation/git-am.adoc b/Documentation/git-am.adoc
index 403181baa9f..14f83a8920a 100644
--- a/Documentation/git-am.adoc
+++ b/Documentation/git-am.adoc
@@ -84,11 +84,10 @@ OPTIONS
-m::
--message-id::
- 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.
+ 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.
--no-message-id::
Do not add the Message-ID header to the commit message.
base-commit: b10e0cb1f391a4466f8d7c4b2550a8b89fda3573
--
2.53.0.32.gf6228eaf9cc
^ permalink raw reply related [flat|nested] only message in thread
only message in thread, other threads:[~2026-04-11 20:16 UTC | newest]
Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-04-11 20:15 [PATCH] doc: am: revert Message-ID trailer claim kristofferhaugsbakk
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox