Subject: [PATCH v7] submodule: absorb git dir instead of dying on deinit

From: "Mugdha Pattnaik via GitGitGadget" <[email-masked]>
Date: Fri, 19 Nov 2021 10:56:27 +0000

From: Mugdha Pattnaik <[email-masked]>

Currently, running 'git submodule deinit' on repos where the
submodule's '.git' is a directory, aborts with a message that is not
exactly user friendly.

Let's change this to instead warn the user that the .git/ directory
has been absorbed into the superproject.
The rest of the deinit function can operate as it already does with
new-style submodules.

In one test, we used to require "git submodule deinit" to fail even
with the "--force" option when the submodule's .git/ directory is not
absorbed. Adjust it to expect the operation to pass.

Suggested-by: Atharva Raykar <[email-masked]>
Signed-off-by: Mugdha Pattnaik <[email-masked]>
---
    submodule: absorb git dir instead of dying on deinit
    
    Changes since v6:
    
     * Edited commit message based on suggestions given.
     * Passed correct arguments to absorb gitdir function; path and recurse
       flag
     * Modified behaviour of deinit such that it absorbs the gitdir even
       when not forced.
    
    Changes since v5:
    
     * Fixed accidental submission of old version
    
    Changes since v4:
    
     * Changed test case from "! test -d" to "test_path_is_missing"
    
    Changes since v3:
    
     * Replaced 1 instance of the word "folder" with "directory"
     * Fixed tab spacing
    
    Changes since v2:
    
     * Replaced all instances of the word "folder" with either "directory"
       or "git dir"
    
    Changes since v1:
    
     * Removed extra indent within the if statements
     * Moved absorb_git_dir_into_superproject() call outside the if
       condition checking for --quiet flag
    
    ------------------------------------------------------------------------
    
    Currently, running 'git submodule deinit' on repos where the submodule's
    '.git' is a directory, aborts with a message that is not exactly user
    friendly.
    
    Let's change this to instead warn the user that the .git/ directory has
    been absorbed into the superproject. The rest of the deinit function can
    operate as it already does with new-style submodules.
    
    In one test, we used to require "git submodule deinit" to fail even with
    the "--force" option when the submodule's .git/ directory is not
    absorbed. Adjust it to expect the operation to pass.
    
    I have changed the 'cp -R ../.git/modules/example .git' to 'mv
    ../.git/modules/example .git' since, at the time of testing, the test
    would fail - deinit now would be moving the '.git' directory into the
    superproject's '.git/modules/' directory, and since this same directory
    already existed before, it was causing errors. So, before running
    deinit, instead of copying the '.git' directory into the submodule, if
    we move it there instead, this functionality can be appropriately
    tested.
    
    Thank you, Mugdha

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1078%2Fmugdhapattnaik%2Fsubmodule-deinit-absorbgitdirs-v7
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1078/mugdhapattnaik/submodule-deinit-absorbgitdirs-v7
Pull-Request: https://github.com/git/git/pull/1078

Range-diff vs v6:

 1:  384a6742388 ! 1:  f37724016f0 submodule: absorb git dir instead of dying on deinit
     @@
       ## Metadata ##
     -Author: mugdha <[email-masked]>
     +Author: Mugdha Pattnaik <[email-masked]>
      
       ## Commit message ##
          submodule: absorb git dir instead of dying on deinit
      
          Currently, running 'git submodule deinit' on repos where the
          submodule's '.git' is a directory, aborts with a message that is not
     -    exactly user friendly. Let's change this to instead warn the user
     -    to rerun the command with '--force'.
     +    exactly user friendly.
      
     -    This internally calls 'absorb_git_dir_into_superproject()', which
     -    moves the git dir into the superproject and replaces it with
     -    a '.git' file. The rest of the deinit function can operate as it
     -    already does with new-style submodules.
     +    Let's change this to instead warn the user that the .git/ directory
     +    has been absorbed into the superproject.
     +    The rest of the deinit function can operate as it already does with
     +    new-style submodules.
      
     -    We also edit a test case such that it matches the new behaviour of
     -    deinit.
     +    In one test, we used to require "git submodule deinit" to fail even
     +    with the "--force" option when the submodule's .git/ directory is not
     +    absorbed. Adjust it to expect the operation to pass.
      
          Suggested-by: Atharva Raykar <[email-masked]>
          Signed-off-by: Mugdha Pattnaik <[email-masked]>
     @@ builtin/submodule--helper.c: static void deinit_submodule(const char *path, cons
      -			      "to remove it including all of its history)"),
      -			    displaypath);
      +		if (is_directory(sub_git_dir)) {
     -+			if (!(flags & OPT_FORCE))
     -+				die(_("Submodule work tree '%s' contains a "
     -+				      ".git directory.\nUse --force if you want "
     -+				      "to move its contents to superproject's "
     -+				      "module directory and convert .git to a file "
     -+				      "and then proceed with deinit."),
     -+				    displaypath);
     -+
      +			if (!(flags & OPT_QUIET))
      +				warning(_("Submodule work tree '%s' contains a .git "
      +					  "directory. This will be replaced with a "
      +					  ".git file by using absorbgitdirs."),
      +					displaypath);
      +
     -+			absorb_git_dir_into_superproject(displaypath, flags);
     ++			absorb_git_dir_into_superproject(path,
     ++							 ABSORB_GITDIR_RECURSE_SUBMODULES);
      +
      +		}
       
     @@ t/t7400-submodule-basic.sh: test_expect_success 'submodule deinit is silent when
       '
       
      -test_expect_success 'submodule deinit fails when submodule has a .git directory even when forced' '
     -+test_expect_success 'submodule deinit fails when submodule has a .git directory unless forced' '
     ++test_expect_success 'submodule deinit absorbs .git directory if .git is a directory' '
       	git submodule update --init &&
       	(
       		cd init &&
     @@ t/t7400-submodule-basic.sh: test_expect_success 'submodule deinit is silent when
      +		mv ../.git/modules/example .git &&
       		GIT_WORK_TREE=. git config --unset core.worktree
       	) &&
     - 	test_must_fail git submodule deinit init &&
     +-	test_must_fail git submodule deinit init &&
      -	test_must_fail git submodule deinit -f init &&
      -	test -d init/.git &&
      -	test -n "$(git config --get-regexp "submodule\.example\.")"
     -+	git submodule deinit -f init &&
     ++	git submodule deinit init &&
      +	test_path_is_missing init/.git &&
      +	test -z "$(git config --get-regexp "submodule\.example\.")"
       '

 builtin/submodule--helper.c | 21 +++++++++++----------
 t/t7400-submodule-basic.sh  | 11 +++++------
 2 files changed, 16 insertions(+), 16 deletions(-)

diff --git a/builtin/submodule--helper.c b/builtin/submodule--helper.c
index ef2776a9e45..bbab562dec6 100644
--- a/builtin/submodule--helper.c
+++ b/builtin/submodule--helper.c
@@ -1539,16 +1539,17 @@ static void deinit_submodule(const char *path, const char *prefix,
 		struct strbuf sb_rm = STRBUF_INIT;
 		const char *format;
 
-		/*
-		 * protect submodules containing a .git directory
-		 * NEEDSWORK: instead of dying, automatically call
-		 * absorbgitdirs and (possibly) warn.
-		 */
-		if (is_directory(sub_git_dir))
-			die(_("Submodule work tree '%s' contains a .git "
-			      "directory (use 'rm -rf' if you really want "
-			      "to remove it including all of its history)"),
-			    displaypath);
+		if (is_directory(sub_git_dir)) {
+			if (!(flags & OPT_QUIET))
+				warning(_("Submodule work tree '%s' contains a .git "
+					  "directory. This will be replaced with a "
+					  ".git file by using absorbgitdirs."),
+					displaypath);
+
+			absorb_git_dir_into_superproject(path,
+							 ABSORB_GITDIR_RECURSE_SUBMODULES);
+
+		}
 
 		if (!(flags & OPT_FORCE)) {
 			struct child_process cp_rm = CHILD_PROCESS_INIT;
diff --git a/t/t7400-submodule-basic.sh b/t/t7400-submodule-basic.sh
index cb1b8e35dbf..e7cec2e457a 100755
--- a/t/t7400-submodule-basic.sh
+++ b/t/t7400-submodule-basic.sh
@@ -1182,18 +1182,17 @@ test_expect_success 'submodule deinit is silent when used on an uninitialized su
 	rmdir init example2
 '
 
-test_expect_success 'submodule deinit fails when submodule has a .git directory even when forced' '
+test_expect_success 'submodule deinit absorbs .git directory if .git is a directory' '
 	git submodule update --init &&
 	(
 		cd init &&
 		rm .git &&
-		cp -R ../.git/modules/example .git &&
+		mv ../.git/modules/example .git &&
 		GIT_WORK_TREE=. git config --unset core.worktree
 	) &&
-	test_must_fail git submodule deinit init &&
-	test_must_fail git submodule deinit -f init &&
-	test -d init/.git &&
-	test -n "$(git config --get-regexp "submodule\.example\.")"
+	git submodule deinit init &&
+	test_path_is_missing init/.git &&
+	test -z "$(git config --get-regexp "submodule\.example\.")"
 '
 
 test_expect_success 'submodule with UTF-8 name' '

base-commit: c4203212e360b25a1c69467b5a8437d45a373cac
-- 
gitgitgadget