git/list[1] front-page[2] threads[3] people[4] search[5] about
 

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

From
Josh Triplett <josh@freedesktop.org>
Date
Apr 24, 2007, 00:18 UTC
Message-ID
<462D4CC8.70006@freedesktop.org>

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>
---
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(-)
diff --git a/Documentation/config.txt b/Documentation/config.txt
index b13ff3a..e0aff53 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -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`),
diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt
index c61afbc..5aff026 100644
--- a/Documentation/git-clean.txt
+++ b/Documentation/git-clean.txt
@@ -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.
 
diff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash
index 7c03403..46356e8 100755
--- a/contrib/completion/git-completion.bash
+++ b/contrib/completion/git-completion.bash
@@ -790,6 +790,7 @@ _git_config ()
 		core.legacyHeaders
 		core.packedGitWindowSize
 		core.packedGitLimit
+		clean.requireForce
 		color.branch
 		color.branch.current
 		color.branch.local
diff --git a/git-clean.sh b/git-clean.sh
index db177a7..299309d 100755
--- a/git-clean.sh
+++ b/git-clean.sh
@@ -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
-- 
1.5.1.1
Next: Michael Spang
Message 1 of 4 in “Add clean.requireForce option, and add -f option to git-clean to override it”
  1. Add clean.requireForce option, and add -f option to git-clean to override itJosh Triplett, Apr 24, 2007
  2. Michael SpangApr 24, 2007
  3. Josh TriplettApr 24, 2007
  4. Josh TriplettApr 24, 2007

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.