aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/git-am.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2024-02-14 10:44:01 -0800
committerJunio C Hamano <gitster@pobox.com>2024-02-14 11:00:04 -0800
commita171dac73496138ba1ac15a6689ee5478c9a88d0 (patch)
tree94b6d82f2c242dee9d7c78f7769bdfe2395add1e /Documentation/git-am.txt
parent61a22ddaf0626111193a17ac12f366bd6d167dff (diff)
downloadgit-a171dac73496138ba1ac15a6689ee5478c9a88d0.tar.gz
doc: add shortcut to "am --whitespace=<action>"
We refer readers of "git am --help" to "git apply --help" for many options that are passed through, and most of them are simple booleans, but --whitespace takes from a set of actions whose names may slip users' minds. Give a list of them in "git am --help" to reduce one level of redirection only to find out what they are. In the helper function to parse the available options, there was a helpful comment reminding the developer to update list of <action>s in the completion script. Mention the two documentation pages there as well. Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-am.txt')
-rw-r--r--Documentation/git-am.txt3
1 files changed, 3 insertions, 0 deletions
diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt
index 82dadbecc8..67b12f315f 100644
--- a/Documentation/git-am.txt
+++ b/Documentation/git-am.txt
@@ -128,6 +128,9 @@ include::rerere-options.txt[]
These flags are passed to the 'git apply' (see linkgit:git-apply[1])
program that applies
the patch.
++
+Valid <action> for the `--whitespace` option are:
+`nowarn`, `warn`, `fix`, `error`, and `error-all`.
--patch-format::
By default the command will try to detect the patch format