diff options
author | Michael J Gruber <git@drmicha.warpmail.net> | 2010-02-04 17:01:16 +0100 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2010-02-04 15:12:13 -0800 |
commit | 89c38500192e00988966246420902dc946e4f4ef (patch) | |
tree | b7747bd7290a53413f679a7b59f5323767fd42ac /Documentation | |
parent | 76ea93ccb5df138eb57b2e8f2aee61dd1ca666ea (diff) | |
download | git-89c38500192e00988966246420902dc946e4f4ef.tar.gz git-89c38500192e00988966246420902dc946e4f4ef.tar.xz |
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>
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/git-clean.txt | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt index 335c885bb..a81cb6c28 100644 --- a/Documentation/git-clean.txt +++ b/Documentation/git-clean.txt @@ -33,8 +33,8 @@ OPTIONS -f:: --force:: - If the git configuration specifies clean.requireForce as true, - 'git clean' will refuse to run unless given -f or -n. + If the git configuration variable clean.requireForce is not set + to false, 'git clean' will refuse to run unless given -f or -n. -n:: --dry-run:: |