Skip to contentSkip to conversation

Add clean.requireForce option, and add -f option to git-clean to override it

PATCH In review Josh Triplett 2 participants 4 messages Jun 15, 2016 Documentation

lore
Share & tools
lore

Josh Triplett

author
#0 lore raw

PATCH 1/1 Add clean.requireForce option, and add -f option to git-clean to override 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 <[email protected]>

---
Passes the test suite, and works fine for me.

 Documentation/config.txt               |    4 ++++
 Documentation/git-clean.txt            |    6 +++++-
 contrib/completion/git-completion.bash |    1 +
 git-clean.sh                           |   13 ++++++++++++-
 4 files changed, 22 insertions(+), 2 deletions(-)
Documentation/config.txt +4 -0
index b13ff3a..e0aff53 100644
@@ -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`),
Documentation/git-clean.txt +5 -1
index c61afbc..5aff026 100644
@@ -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
 -----------

@@ -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.
contrib/completion/git-completion.bash +1 -0
index 7c03403..46356e8 100755
@@ -790,6 +790,7 @@ _git_config ()
 		core.legacyHeaders
 		core.packedGitWindowSize
 		core.packedGitLimit
+		clean.requireForce
 		color.branch
 		color.branch.current
 		color.branch.local
git-clean.sh +12 -1
index db177a7..299309d 100755
@@ -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

@@ -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"

@@ -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"

@@ -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
Signature · 1 line
1.5.1.1
#1 lore raw

git-clean.sh do · line 70

Quoted 4 lines · Josh Triplett
git-clean.sh +4 -0
+if [ "$disabled" = true ]; then
+	echo "clean.requireForce set and -n or -f not given; refusing to clean"
+	exit 1
+fi

How is it useful to abort completely? Wouldn't it be better to behave like -n unless -f is given?

Cheers,
Michael Spang

author
#2 lore raw
Quoted 8 lines · Michael Spang

git-clean.sh do · line 70

Quoted 4 lines · Josh Triplett
git-clean.sh +4 -0
+if [ "$disabled" = true ]; then
+	echo "clean.requireForce set and -n or -f not given; refusing to clean"
+	exit 1
+fi

How is it useful to abort completely? Wouldn't it be better to behave like -n unless -f is given?

I don't think so, for a couple of reasons.

* I want to make it really obvious that git-clean did nothing. Spewing piles of output quickly obscures the error message, and doesn't convey "git-clean did nothing" at a glance.

* -n takes time, especially with a large working copy. Doing nothing takes very little time. The original use case motivating this patch came from the idea of a git $HOME, and wanting to make sure git-clean won't delete everything untracked in $HOME. git-clean -n would take a long time here, and I don't want to do it implicitly, particularly if I meant to clean a git repository *under* $HOME.

- Josh Triplett

author
#3 lore raw
Quoted 10 lines · Josh Triplett
Quoted 7 lines · Michael Spang

git-clean.sh do · line 70

Quoted 4 lines · Josh Triplett
git-clean.sh +4 -0
+if [ "$disabled" = true ]; then
+	echo "clean.requireForce set and -n or -f not given; refusing to clean"
+	exit 1
+fi

How is it useful to abort completely? Wouldn't it be better to behave like -n unless -f is given?

I don't think so, for a couple of reasons.

[...]

That said, a *separate* config option to make git-clean assume -n by default seems potentially useful as well.

- Josh Triplett