From: Junio C Hamano Date: Tue, 3 Mar 2026 01:06:52 +0000 (-0800) Subject: Merge branch 'kh/doc-am-xref' X-Git-Tag: v2.54.0-rc0~140 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=05c4af5c8f3d7310c8a3b2909d30ce761c6757aa;p=thirdparty%2Fgit.git Merge branch 'kh/doc-am-xref' Doc update. * kh/doc-am-xref: doc: am: fill out hook discussion doc: am: add missing config am.messageId doc: am: say that --message-id adds a trailer doc: am: normalize git(1) command links --- 05c4af5c8f3d7310c8a3b2909d30ce761c6757aa diff --cc Documentation/git-am.adoc index 972398d457,403181baa9..384e0cd7f9 --- a/Documentation/git-am.adoc +++ b/Documentation/git-am.adoc @@@ -253,13 -249,16 +257,13 @@@ where the patch begins. Excess whitesp line is automatically stripped. The patch is expected to be inline, directly following the -message. Any line that is of the form: - -* three-dashes and end-of-line, or -* a line that begins with "diff -", or -* a line that begins with "Index: " +message. +include::format-patch-end-of-commit-message.adoc[] -is taken as the beginning of a patch, and the commit log message -is terminated before the first occurrence of such a line. +This means that the contents of the commit message can inadvertently +interrupt the processing (see the <> section below). - When initially invoking `git am`, you give it the names of the mailboxes + When initially invoking linkgit:git-am[1], you give it the names of the mailboxes to process. Upon seeing the first patch that does not apply, it aborts in the middle. You can recover from this in one of two ways: @@@ -277,17 -276,10 +281,17 @@@ names Before any patches are applied, ORIG_HEAD is set to the tip of the current branch. This is useful if you have problems with multiple - commits, like running 'git am' on the wrong branch or an error in the - commits that is more easily fixed by changing the mailbox (e.g. + commits, like running linkgit:git-am[1] on the wrong branch or an error + in the commits that is more easily fixed by changing the mailbox (e.g. errors in the "From:" lines). +[[caveats]] +CAVEATS +------- + +:git-am: 1 +include::format-patch-caveats.adoc[] + HOOKS ----- This command can run `applypatch-msg`, `pre-applypatch`,