]> git.ipfire.org Git - thirdparty/git.git/commitdiff
doc: am: revert Message-ID trailer claim
authorKristoffer Haugsbakk <code@khaugsbakk.name>
Sat, 11 Apr 2026 20:15:50 +0000 (22:15 +0200)
committerJunio C Hamano <gitster@pobox.com>
Mon, 13 Apr 2026 15:26:43 +0000 (08:26 -0700)
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>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-am.adoc

index 403181baa9fb4a2422a8ea579fa17c4a58e77dfc..14f83a8920a89f7a4051aa4498139f5b2a97475f 100644 (file)
@@ -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.