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

[PATCH 2/2] commit -m: commit staged submodules regardless of ignore config

From
Jens Lehmann <jens.lehmann@web.de>
Date
Apr 5, 2014, 16:59 UTC
Message-ID
<53403678.3060708@web.de>
In-Reply-To
<53403617.7050506@web.de>

The previous commit fixed the problem that the staged but that ignored submodules did not show up in the status output of the commit command and weren't committed afterwards either. But when commit doesn't generate the status output (e.g. when used in a script with '-m') the ignored submodule will still not be committed. This is because in that case a different code path is taken which calls index_differs_from() instead of calling the wt_status functions.

Fix that by calling index_differs_from() from builtin/commit.c with a diff_options argument value that tells it not ignore any submodule changes unless the '--ignore-submodules' option is used. Even though this option isn't yet implemented for cmd_commit() but only for cmd_status() this prepares cmd_commit() to correctly handle the '--ignore-submodules' option later. As status and commit share the same ignore_submodule_arg variable this makes the code more robust against accidental breakage and documents how to correctly call index_differs_from().

Change the expected result of the test documenting this problem from failure to success.

Signed-off-by: Jens Lehmann <Jens.Lehmann@web.de>
---
 builtin/commit.c  | 18 ++++++++++++++++--
 t/t7508-status.sh |  2 +-
 2 files changed, 17 insertions(+), 3 deletions(-)
diff --git a/builtin/commit.c b/builtin/commit.c
index d9550c5..a456a60 100644
--- a/builtin/commit.c
+++ b/builtin/commit.c
@@ -833,8 +833,22 @@ static int prepare_to_commit(const char *index_file, const char *prefix,

 		if (get_sha1(parent, sha1))
 			commitable = !!active_nr;
-		else
-			commitable = index_differs_from(parent, 0);
+		else {
+			/*
+			 * Unless the user did explicitly request a submodule
+			 * ignore mode by passing a command line option we do
+			 * not ignore any changed submodule SHA-1s when
+			 * comparing index and parent, no matter what is
+			 * configured. Otherwise we won't commit any
+			 * submodules which were manually staged, which would
+			 * be really confusing.
+			 */
+			int diff_flags = DIFF_OPT_OVERRIDE_SUBMODULE_CONFIG;
+			if (ignore_submodule_arg &&
+			    !strcmp(ignore_submodule_arg, "all"))
+				diff_flags |= DIFF_OPT_IGNORE_SUBMODULES;
+			commitable = index_differs_from(parent, diff_flags);
+		}
 	}
 	strbuf_release(&committer_ident);

diff --git a/t/t7508-status.sh b/t/t7508-status.sh
index e6483fc..d480069 100755
--- a/t/t7508-status.sh
+++ b/t/t7508-status.sh
@@ -1523,7 +1523,7 @@ EOF
 	test_i18ngrep "^M. sm" output
 '

-test_expect_failure 'git commit -m will commit a staged but ignored submodule' '
+test_expect_success 'git commit -m will commit a staged but ignored submodule' '
 	git commit -uno -m message &&
 	git status -s --ignore-submodules=dirty >output &&
 	 test_i18ngrep ! "^M. sm" output &&
-- 
1.9.1.476.g510abc7
Previous: Jens Lehmann
Message 3 of 3 in “status/commit: do not ignore staged submodules”
  1. 0/2 status/commit: do not ignore staged submodulesJens Lehmann, Apr 5, 2014
  2. 1/2 status/commit: show staged submodules regardless of ignore configJens Lehmann, Apr 5, 2014
  3. 2/2 commit -m: commit staged submodules regardless of ignore configJens Lehmann, Apr 5, 2014

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.