aboutsummaryrefslogtreecommitdiff
path: root/Documentation/config
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2026-03-02 17:06:52 -0800
committerJunio C Hamano <gitster@pobox.com>2026-03-02 17:06:52 -0800
commit05c4af5c8f3d7310c8a3b2909d30ce761c6757aa (patch)
tree40a2af03e67db7280bf4bf5166e368a7634a27aa /Documentation/config
parent10dd04a3feef385358d66bf3d653325f64c20d3c (diff)
parentb10e0cb1f391a4466f8d7c4b2550a8b89fda3573 (diff)
downloadgit-05c4af5c8f3d7310c8a3b2909d30ce761c6757aa.tar.xz
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
Diffstat (limited to 'Documentation/config')
-rw-r--r--Documentation/config/am.adoc24
1 files changed, 15 insertions, 9 deletions
diff --git a/Documentation/config/am.adoc b/Documentation/config/am.adoc
index 5bcad2efb1..e9561e12d7 100644
--- a/Documentation/config/am.adoc
+++ b/Documentation/config/am.adoc
@@ -1,14 +1,20 @@
am.keepcr::
- If true, git-am will call git-mailsplit for patches in mbox format
- with parameter `--keep-cr`. In this case git-mailsplit will
+ If true, linkgit:git-am[1] will call linkgit:git-mailsplit[1]
+ for patches in mbox format with parameter `--keep-cr`. In this
+ case linkgit:git-mailsplit[1] will
not remove `\r` from lines ending with `\r\n`. Can be overridden
by giving `--no-keep-cr` from the command line.
- See linkgit:git-am[1], linkgit:git-mailsplit[1].
am.threeWay::
- By default, `git am` will fail if the patch does not apply cleanly. When
- set to true, this setting tells `git am` to fall back on 3-way merge if
- the patch records the identity of blobs it is supposed to apply to and
- we have those blobs available locally (equivalent to giving the `--3way`
- option from the command line). Defaults to `false`.
- See linkgit:git-am[1].
+ By default, linkgit:git-am[1] will fail if the patch does not
+ apply cleanly. When set to true, this setting tells
+ linkgit:git-am[1] to fall back on 3-way merge if the patch
+ records the identity of blobs it is supposed to apply to and we
+ have those blobs available locally (equivalent to giving the
+ `--3way` option from the command line). Defaults to `false`.
+
+am.messageId::
+ Add a `Message-ID` trailer based on the email header to the
+ commit when using linkgit:git-am[1] (see
+ linkgit:git-interpret-trailers[1]). See also the `--message-id`
+ and `--no-message-id` options.