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>
Junio C Hamano committed
Feb 14, 2024 at 10:44 UTC
a171dac73496138ba1ac15a6689ee5478c9a88d0
2 files changed
+5
-1
Documentation/git-am.txt
+3
@@ -128,6 +128,9 @@ include::rerere-options.txt[]
128
These flags are passed to the 'git apply' (see linkgit:git-apply[1])
129
program that applies
130
the patch.
131
++
132
+Valid <action> for the `--whitespace` option are:
133
+`nowarn`, `warn`, `fix`, `error`, and `error-all`.
134
135
--patch-format::
136
By default the command will try to detect the patch format
apply.c
+2
-1
@@ -78,7 +78,8 @@ static int parse_whitespace_option(struct apply_state *state, const char *option
78
return 0;
79
}
80
/*
81
- * Please update $__git_whitespacelist in git-completion.bash
81
+ * Please update $__git_whitespacelist in git-completion.bash,
82
+ * Documentation/git-apply.txt, and Documentation/git-am.txt
83
* when you add new options.
84
*/
85
return error(_("unrecognized whitespace option '%s'"), option);