diff options
| author | Kristoffer Haugsbakk <code@khaugsbakk.name> | 2026-02-09 18:34:35 +0100 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2026-02-09 10:34:04 -0800 |
| commit | 3c18135bfd04d8ab1007137bcf565badc4ae2953 (patch) | |
| tree | 47b59d0e6b480aac04fe407b9f5c936032274f83 | |
| parent | b679ee04226f4ba1633078797f3aa3a5677e2c5c (diff) | |
| download | git-3c18135bfd04d8ab1007137bcf565badc4ae2953.tar.xz | |
doc: am: say that --message-id adds a trailer
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>
| -rw-r--r-- | Documentation/git-am.adoc | 16 |
1 files changed, 9 insertions, 7 deletions
diff --git a/Documentation/git-am.adoc b/Documentation/git-am.adoc index 0f9980603d..ba05c703fc 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. |