Skip to content

Commit 444e423

Browse files
LemmingAvalanchegitster
authored andcommitted
doc: am: revert Message-ID trailer claim
I claimed in 3c18135 (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 3c18135 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>
1 parent b10e0cb commit 444e423

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

Documentation/git-am.adoc

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -84,11 +84,10 @@ OPTIONS
8484

8585
-m::
8686
--message-id::
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.
87+
Pass the `-m` flag to linkgit:git-mailinfo[1],
88+
so that the `Message-ID` header is added to the commit message.
89+
The `am.messageid` configuration variable can be used to specify
90+
the default behaviour.
9291

9392
--no-message-id::
9493
Do not add the Message-ID header to the commit message.

0 commit comments

Comments
 (0)