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

[RFC PATCHv2 08/17] update submodules: add depopulate_submodule

From
Stefan Beller <sbeller@google.com>
Date
Dec 3, 2016, 00:30 UTC
Message-ID
<20161203003022.29797-9-sbeller@google.com>
In-Reply-To
<20161203003022.29797-1-sbeller@google.com>

Implement the functionality needed to enable work tree manipulating commands so that a deleted submodule should not only affect the index (leaving all the files of the submodule in the work tree) but also to remove the work tree of the superproject (including any untracked files).

To do so, we need an equivalent of "rm -rf", which is already found in entry.c, so expose that and for clarity add a suffix "_or_dir" to it.

That will only work properly when the submodule uses a gitfile instead of a .git directory and no untracked files are present. Otherwise the removal will fail with a warning (which is just what happened until now).

Signed-off-by: Stefan Beller <sbeller@google.com>
---
 cache.h     |  2 ++
 entry.c     |  5 +++++
 submodule.c | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 submodule.h |  1 +
 4 files changed, 54 insertions(+)
diff --git a/cache.h b/cache.h
index a50a61a197..b645ca2f9a 100644
--- a/cache.h
+++ b/cache.h
@@ -2018,4 +2018,6 @@ void sleep_millisec(int millisec);
  */
 void safe_create_dir(const char *dir, int share);
 
+extern void remove_directory_or_die(struct strbuf *path);
+
 #endif /* CACHE_H */
diff --git a/entry.c b/entry.c
index c6eea240b6..02c4ac9f22 100644
--- a/entry.c
+++ b/entry.c
@@ -73,6 +73,11 @@ static void remove_subtree(struct strbuf *path)
 		die_errno("cannot rmdir '%s'", path->buf);
 }
 
+void remove_directory_or_die(struct strbuf *path)
+{
+	remove_subtree(path);
+}
+
 static int create_file(const char *path, unsigned int mode)
 {
 	mode = (mode & 0100) ? 0777 : 0666;
diff --git a/submodule.c b/submodule.c
index 62e9ef3872..7bb64d6c69 100644
--- a/submodule.c
+++ b/submodule.c
@@ -324,6 +324,52 @@ void prepare_submodule_repo_env(struct argv_array *out)
 	argv_array_push(out, "GIT_DIR=.git");
 }
 
+int depopulate_submodule(const char *path)
+{
+	int ret = 0;
+	struct strbuf pathbuf = STRBUF_INIT;
+	char *dot_git = xstrfmt("%s/.git", path);
+
+	/* Is it populated? */
+	if (!resolve_gitdir(dot_git))
+		goto out;
+
+	/* Does it have a .git directory? */
+	if (!submodule_uses_gitfile(path)) {
+		struct child_process cp = CHILD_PROCESS_INIT;
+
+		prepare_submodule_repo_env(&cp.env_array);
+		argv_array_pushl(&cp.args, "submodule--helper",
+				 "embed-git-dirs", path, NULL);
+		cp.git_cmd = 1;
+		if (run_command(&cp)) {
+			warning(_("Cannot remove submodule '%s'\n"
+				  "because it (or one of its nested submodules) has a git \n"
+				  "directory in the working tree, which could not be embedded\n"
+				  "the superprojects git directory automatically."), path);
+			ret = -1;
+			goto out;
+		}
+
+		if (!submodule_uses_gitfile(path)) {
+			/*
+			 * We should be using a gitfile by now, let's double
+			 * check as loosing the git dir would be fatal.
+			 */
+			die("BUG: \"git submodule--helper embed git-dirs '%s'\" "
+			    "did not embed the git-dirs recursively for '%s'",
+			    path, path);
+		}
+	}
+
+	strbuf_addstr(&pathbuf, path);
+	remove_directory_or_die(&pathbuf);
+out:
+	strbuf_release(&pathbuf);
+	free(dot_git);
+	return ret;
+}
+
 /* Helper function to display the submodule header line prior to the full
  * summary output. If it can locate the submodule objects directory it will
  * attempt to lookup both the left and right commits and put them into the
diff --git a/submodule.h b/submodule.h
index 7d890e0464..d8bb1d4baf 100644
--- a/submodule.h
+++ b/submodule.h
@@ -63,6 +63,7 @@ extern void set_config_update_recurse_submodules(int value);
  */
 extern int submodule_is_interesting(const char *path);
 extern int submodules_interesting_for_update(void);
+extern int depopulate_submodule(const char *path);
 extern void check_for_new_submodule_commits(unsigned char new_sha1[20]);
 extern int fetch_populated_submodules(const struct argv_array *options,
 			       const char *prefix, int command_line_option,
-- 
2.11.0.rc2.28.g2673dad
Previous: Stefan BellerNext: David Turner
Message 8 of 30 in “[RFC PATCHv2 00/17] Checkout aware of Submodules!”
  1. Stefan BellerDec 3, 2016
  2. 02/17 submodule: modernize ok_to_remove_submodule to use argv_arrayStefan Beller, Dec 3, 2016
  3. 12/17 unpack-trees: remove submodule contents if interestingStefan Beller, Dec 3, 2016
  4. 09/17 update submodules: add scheduling to update submodulesStefan Beller, Dec 3, 2016
  5. David TurnerDec 5, 2016
  6. Stefan BellerDec 5, 2016
  7. 07/17 update submodules: introduce submodule_is_interestingStefan Beller, Dec 3, 2016
  8. 08/17 update submodules: add depopulate_submoduleStefan Beller, Dec 3, 2016
  9. David TurnerDec 5, 2016
  10. Stefan BellerDec 6, 2016
  11. 04/17 update submodules: add is_submodule_populatedStefan Beller, Dec 3, 2016
  12. 10/17 update submodules: is_submodule_checkout_safeStefan Beller, Dec 3, 2016
  13. 05/17 update submodules: add submodule config parsingStefan Beller, Dec 3, 2016
  14. 15/17 checkout: recurse into submodules if asked toStefan Beller, Dec 3, 2016
  15. Brandon WilliamsDec 5, 2016
  16. Stefan BellerDec 5, 2016
  17. Brandon WilliamsDec 5, 2016
  18. David TurnerDec 5, 2016
  19. 03/17 update submodules: move up prepare_submodule_repo_envStefan Beller, Dec 3, 2016
  20. 16/17 completion: add '--recurse-submodules' to checkoutStefan Beller, Dec 3, 2016
  21. 01/17 submodule.h: add extern keyword to functionsStefan Beller, Dec 3, 2016
  22. 14/17 submodule: teach unpack_trees() to update submodulesStefan Beller, Dec 3, 2016
  23. David TurnerDec 5, 2016
  24. 06/17 update submodules: add a config option to determine if submodules are updatedStefan Beller, Dec 3, 2016
  25. 13/17 entry: write_entry to write populate submodulesStefan Beller, Dec 3, 2016
  26. 11/17 unpack-trees: teach verify_clean_submodule to inspect submodulesStefan Beller, Dec 3, 2016
  27. 17/17 checkout: add config option to recurse into submodules by defaultStefan Beller, Dec 3, 2016
  28. Brandon WilliamsDec 5, 2016
  29. Stefan BellerDec 5, 2016
  30. Brandon WilliamsDec 5, 2016

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.