git-clean: fix the description of the default behavior
authorMichael J Gruber <git@drmicha.warpmail.net>
Thu, 4 Feb 2010 16:01:16 +0000 (17:01 +0100)
committerJunio C Hamano <gitster@pobox.com>
Thu, 4 Feb 2010 23:12:13 +0000 (15:12 -0800)
commit89c38500192e00988966246420902dc946e4f4ef
treeb7747bd7290a53413f679a7b59f5323767fd42ac
parent76ea93ccb5df138eb57b2e8f2aee61dd1ca666ea
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>
Documentation/git-clean.txt
builtin-clean.c