git-clean: fix the description of the default behavior
Currently, when called without -n and -f, git clean issues fatal: clean.requireForce not set and -n or -f not given; refusing to clean which leaves the user wondering why force is required when requireForce is not set. Looking up in git-clean(1) does not help because its description is wrong. Change it so that git clean issues fatal: clean.requireForce defaults to true and -n or -f not given; refusing to clean in this situation (and "...set to true..." when it is set) which makes it clearer that an unset config means true here, and adjust the documentation. Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Michael J Gruber committed
Feb 4, 2010 at 17:01 UTC
89c38500192e00988966246420902dc946e4f4ef
2 files changed
+4
-4
Documentation/git-clean.txt
+2
-2
@@ -33,8 +33,8 @@ OPTIONS
33
34
-f::
35
--force::
36
- If the git configuration specifies clean.requireForce as true,
37
- 'git clean' will refuse to run unless given -f or -n.
36
+ If the git configuration variable clean.requireForce is not set
37
+ to false, 'git clean' will refuse to run unless given -f or -n.
38
39
-n::
40
--dry-run::
builtin-clean.c
+2
-2
@@ -67,8 +67,8 @@ int cmd_clean(int argc, const char **argv, const char *prefix)
67
die("-x and -X cannot be used together");
68
69
if (!show_only && !force)
70
- die("clean.requireForce%s set and -n or -f not given; "
71
- "refusing to clean", config_set ? "" : " not");
70
+ die("clean.requireForce %s to true and neither -n nor -f given; "
71
+ "refusing to clean", config_set ? "set" : "defaults");
72
73
if (force > 1)
74
rm_flags = 0;