From 105ec9ae8d0d100994ddf1ee5e99e4616558ff90 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Sun, 3 Mar 2024 14:06:00 -0800 Subject: [PATCH] clean: further clean-up of implementation around "--force" We clarified how "clean.requireForce" interacts with the "--dry-run" option in the previous commit, both in the implementation and in the documentation. Even when "git clean" (without other options) is required to be used with "--force" (i.e. either clean.requireForce is unset, or explicitly set to true) to protect end-users from casual invocation of the command by mistake, "--dry-run" does not require "--force" to be used, because it is already its own protection mechanism by being a no-op to the working tree files. The previous commit, however, missed another clean-up opportunity around the same area. Just like in the "--dry-run" mode, the command in the "--interactive" mode does not require "--force", either. This is because by going interactive and giving the end user one more chance to confirm, the mode itself is serving as its own protection mechanism. Let's take things one step further, and unify the code that defines interaction between "--force" and these two other options. Just like we added explanation for the reason why "--dry-run" does not honor "clean.requireForce", give an explanation for the reason why "--interactive" makes "clean.requireForce" to be ignored. Finally, add some tests to show the interaction between "--force" and "--interactive". We already have tests that show interaction between "--force" and "--dry-run", but didn't test "--interactive". Signed-off-by: Junio C Hamano --- Documentation/config/clean.txt | 2 +- Documentation/git-clean.txt | 6 ++++-- builtin/clean.c | 9 ++------- t/t7300-clean.sh | 6 ++++++ 4 files changed, 13 insertions(+), 10 deletions(-) diff --git a/Documentation/config/clean.txt b/Documentation/config/clean.txt index b19ca210f39b57..c0188ead4e6cd8 100644 --- a/Documentation/config/clean.txt +++ b/Documentation/config/clean.txt @@ -1,3 +1,3 @@ clean.requireForce:: A boolean to make git-clean refuse to delete files unless -f - or -i is given. Defaults to true. + is given. Defaults to true. diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt index 662eebb852076a..fd171654163c1f 100644 --- a/Documentation/git-clean.txt +++ b/Documentation/git-clean.txt @@ -37,7 +37,7 @@ OPTIONS --force:: If the Git configuration variable clean.requireForce is not set to false, 'git clean' will refuse to delete files or directories - unless given -f or -i. Git will refuse to modify untracked + unless given -f. Git will refuse to modify untracked nested git repositories (directories with a .git subdirectory) unless a second -f is given. @@ -45,11 +45,13 @@ OPTIONS --interactive:: Show what would be done and clean files interactively. See ``Interactive mode'' for details. + Configuration variable `clean.requireForce` is ignored, as + this mode gives its own safety protection by going interactive. -n:: --dry-run:: Don't actually remove anything, just show what would be done. - Configuration variable clean.requireForce is ignored, as + Configuration variable `clean.requireForce` is ignored, as nothing will be deleted anyway. -q:: diff --git a/builtin/clean.c b/builtin/clean.c index 41502dcb0ddeed..29efe841537b34 100644 --- a/builtin/clean.c +++ b/builtin/clean.c @@ -950,13 +950,8 @@ int cmd_clean(int argc, const char **argv, const char *prefix) argc = parse_options(argc, argv, prefix, options, builtin_clean_usage, 0); - /* Dry run won't remove anything, so requiring force makes no sense */ - if (dry_run) - require_force = 0; - - if (require_force != 0 && !force && !interactive) - die(_("clean.requireForce is true and neither -f nor -i given:" - " refusing to clean")); + if (require_force != 0 && !force && !interactive && !dry_run) + die(_("clean.requireForce is true and -f not given: refusing to clean")); if (force > 1) rm_flags = 0; diff --git a/t/t7300-clean.sh b/t/t7300-clean.sh index 611b3dd3aedb44..1f7201eb60caf9 100755 --- a/t/t7300-clean.sh +++ b/t/t7300-clean.sh @@ -407,6 +407,12 @@ test_expect_success 'clean.requireForce and -f' ' ' +test_expect_success 'clean.requireForce and --interactive' ' + git clean --interactive output 2>error && + test_grep ! "requireForce is true and" error && + test_grep "\*\*\* Commands \*\*\*" output +' + test_expect_success 'core.excludesfile' ' echo excludes >excludes &&