Skip to content

Commit

Permalink
Add clean.requireForce option, and add -f option to git-clean to over…
Browse files Browse the repository at this point in the history
…ride it

Add a new configuration option clean.requireForce.  If set, git-clean will
refuse to run, unless forced with the new -f option, or not acting due to -n.

Signed-off-by: Josh Triplett <josh@freedesktop.org>
Signed-off-by: Junio C Hamano <junkio@cox.net>
  • Loading branch information
Josh Triplett authored and Junio C Hamano committed Apr 24, 2007
1 parent ab69e89 commit 2122591
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 2 deletions.
4 changes: 4 additions & 0 deletions Documentation/config.txt
Original file line number Diff line number Diff line change
Expand Up @@ -300,6 +300,10 @@ branch.<name>.merge::
branch.<name>.merge to the desired branch, and use the special setting
`.` (a period) for branch.<name>.remote.

clean.requireForce::
A boolean to make git-clean do nothing unless given -f or -n. Defaults
to false.

color.branch::
A boolean to enable/disable color in the output of
gitlink:git-branch[1]. May be set to `true` (or `always`),
Expand Down
6 changes: 5 additions & 1 deletion Documentation/git-clean.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ git-clean - Remove untracked files from the working tree
SYNOPSIS
--------
[verse]
'git-clean' [-d] [-n] [-q] [-x | -X] [--] <paths>...
'git-clean' [-d] [-f] [-n] [-q] [-x | -X] [--] <paths>...

DESCRIPTION
-----------
Expand All @@ -25,6 +25,10 @@ OPTIONS
-d::
Remove untracked directories in addition to untracked files.

-f::
If the git configuration specifies clean.forceRequire as true,
git-clean will refuse to run unless given -f or -n.

-n::
Don't actually remove anything, just show what would be done.

Expand Down
1 change: 1 addition & 0 deletions contrib/completion/git-completion.bash
Original file line number Diff line number Diff line change
Expand Up @@ -790,6 +790,7 @@ _git_config ()
core.legacyHeaders
core.packedGitWindowSize
core.packedGitLimit
clean.requireForce
color.branch
color.branch.current
color.branch.local
Expand Down
13 changes: 12 additions & 1 deletion git-clean.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@
# Copyright (c) 2005-2006 Pavel Roskin
#

USAGE="[-d] [-n] [-q] [-x | -X] [--] <paths>..."
USAGE="[-d] [-f] [-n] [-q] [-x | -X] [--] <paths>..."
LONG_USAGE='Clean untracked files from the working directory
-d remove directories as well
-f override clean.requireForce and clean anyway
-n don'\''t remove anything, just show what would be done
-q be quiet, only report errors
-x remove ignored files as well
Expand All @@ -19,6 +20,7 @@ require_work_tree
ignored=
ignoredonly=
cleandir=
disabled="`git-config --bool clean.requireForce`"
rmf="rm -f --"
rmrf="rm -rf --"
rm_refuse="echo Not removing"
Expand All @@ -30,7 +32,11 @@ do
-d)
cleandir=1
;;
-f)
disabled=
;;
-n)
disabled=
rmf="echo Would remove"
rmrf="echo Would remove"
rm_refuse="echo Would not remove"
Expand Down Expand Up @@ -58,6 +64,11 @@ do
shift
done

if [ "$disabled" = true ]; then
echo "clean.requireForce set and -n or -f not given; refusing to clean"
exit 1
fi

case "$ignored,$ignoredonly" in
1,1) usage;;
esac
Expand Down

0 comments on commit 2122591

Please sign in to comment.