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

[PATCH v3 13/13] submodule--helper update-clone: check for --filter and --init

From
Glen Choo <chooglen@google.com>
Date
Mar 3, 2022, 00:57 UTC
Message-ID
<20220303005727.69270-14-chooglen@google.com>
In-Reply-To
<20220303005727.69270-1-chooglen@google.com>

"git submodule update --filter" also requires the "--init" option. Teach update-clone to do this usage check in C and remove the check from git-submodule.sh.

In addition, change update-clone's usage string so that it teaches users about "git submodule update" instead of "git submodule--helper update-clone" (the string is copied from git-submodule.sh). This should be more helpful to users since they don't invoke update-clone directly.

Signed-off-by: Glen Choo <chooglen@google.com>
---
 builtin/submodule--helper.c | 20 +++++++++++++++++++-
 git-submodule.sh            |  5 -----
 2 files changed, 19 insertions(+), 6 deletions(-)
diff --git a/builtin/submodule--helper.c b/builtin/submodule--helper.c
index 296ab80bf2..bef9ab22d4 100644
--- a/builtin/submodule--helper.c
+++ b/builtin/submodule--helper.c
@@ -2545,7 +2545,12 @@ static int update_clone(int argc, const char **argv, const char *prefix)
 	};
 
 	const char *const git_submodule_helper_usage[] = {
-		N_("git submodule--helper update-clone [--prefix=<path>] [<path>...]"),
+		N_("git submodule [--quiet] update"
+		" [--init [--filter=<filter-spec>]] [--remote]"
+		" [-N|--no-fetch] [-f|--force]"
+		" [--checkout|--merge|--rebase]"
+		" [--[no-]recommend-shallow] [--reference <repository>]"
+		" [--recursive] [--[no-]single-branch] [--] [<path>...]"),
 		NULL
 	};
 	suc.prefix = prefix;
@@ -2556,6 +2561,19 @@ static int update_clone(int argc, const char **argv, const char *prefix)
 	memset(&filter_options, 0, sizeof(filter_options));
 	argc = parse_options(argc, argv, prefix, module_update_clone_options,
 			     git_submodule_helper_usage, 0);
+
+	if (filter_options.choice && !suc.init) {
+		/*
+		 * NEEDSWORK: Don't use usage_with_options() because the
+		 * usage string is for "git submodule update", but the
+		 * options are for "git submodule--helper update-clone".
+		 *
+		 * This will no longer be an issue when "update-clone"
+		 * is replaced by "git submodule--helper update".
+		 */
+		usage(git_submodule_helper_usage[0]);
+	}
+
 	suc.filter_options = &filter_options;
 
 	if (update)
diff --git a/git-submodule.sh b/git-submodule.sh
index 51be7c7f7e..aa8bdfca9d 100755
--- a/git-submodule.sh
+++ b/git-submodule.sh
@@ -356,11 +356,6 @@ cmd_update()
 		shift
 	done
 
-	if test -n "$filter" && test "$init" != "1"
-	then
-		usage
-	fi
-
 	{
 	git ${wt_prefix:+-C "$wt_prefix"} submodule--helper update-clone \
 		${GIT_QUIET:+--quiet} \
-- 
2.33.GIT
Previous: Glen ChooNext: Ævar Arnfjörð Bjarmason
Message 58 of 75 in “submodule: convert parts of 'update' to C”
  1. 00/13 submodule: convert parts of 'update' to CGlen Choo, Mar 1, 2022
  2. 01/13 submodule tests: test for init and update failure outputGlen Choo, Mar 1, 2022
  3. 02/13 submodule--helper: remove update-module-modeGlen Choo, Mar 1, 2022
  4. 04/13 submodule--helper run-update-procedure: remove --suboidGlen Choo, Mar 1, 2022
  5. 03/13 submodule--helper: reorganize code for sh to C conversionGlen Choo, Mar 1, 2022
  6. 05/13 submodule--helper: remove ensure-core-worktreeGlen Choo, Mar 1, 2022
  7. 06/13 submodule--helper: get remote names from any repositoryGlen Choo, Mar 1, 2022
  8. Junio C HamanoMar 1, 2022
  9. Glen ChooMar 1, 2022
  10. 07/13 submodule--helper: don't use bitfield indirection for parse_options()Glen Choo, Mar 1, 2022
  11. 09/13 submodule--helper: refactor get_submodule_displaypath()Glen Choo, Mar 1, 2022
  12. 08/13 submodule--helper run-update-procedure: learn --remoteGlen Choo, Mar 1, 2022
  13. 10/13 submodule--helper: allow setting superprefix for init_submodule()Glen Choo, Mar 1, 2022
  14. 11/13 submodule--helper update-clone: learn --initGlen Choo, Mar 1, 2022
  15. 12/13 submodule update: add tests for --filterGlen Choo, Mar 1, 2022
  16. 13/13 submodule--helper update-clone: check for --filter and --initGlen Choo, Mar 1, 2022
  17. Glen ChooMar 1, 2022
  18. 00/13 submodule: convert parts of 'update' to CGlen Choo, Mar 1, 2022
  19. 01/13 submodule tests: test for init and update failure outputGlen Choo, Mar 1, 2022
  20. 02/13 submodule--helper: remove update-module-modeGlen Choo, Mar 1, 2022
  21. 03/13 submodule--helper: reorganize code for sh to C conversionGlen Choo, Mar 1, 2022
  22. 04/13 submodule--helper run-update-procedure: remove --suboidGlen Choo, Mar 1, 2022
  23. 05/13 submodule--helper: remove ensure-core-worktreeGlen Choo, Mar 1, 2022
  24. 06/13 submodule--helper: get remote names from any repositoryGlen Choo, Mar 1, 2022
  25. Ævar Arnfjörð BjarmasonMar 1, 2022
  26. 07/13 submodule--helper: don't use bitfield indirection for parse_options()Glen Choo, Mar 1, 2022
  27. 08/13 submodule--helper run-update-procedure: learn --remoteGlen Choo, Mar 1, 2022
  28. 09/13 submodule--helper: refactor get_submodule_displaypath()Glen Choo, Mar 1, 2022
  29. Ævar Arnfjörð BjarmasonMar 1, 2022
  30. 10/13 submodule--helper: allow setting superprefix for init_submodule()Glen Choo, Mar 1, 2022
  31. 12/13 submodule update: add tests for --filterGlen Choo, Mar 1, 2022
  32. Ævar Arnfjörð BjarmasonMar 1, 2022
  33. Glen ChooMar 1, 2022
  34. 11/13 submodule--helper update-clone: learn --initGlen Choo, Mar 1, 2022
  35. 13/13 submodule--helper update-clone: check for --filter and --initGlen Choo, Mar 1, 2022
  36. Ævar Arnfjörð BjarmasonMar 1, 2022
  37. Junio C HamanoMar 1, 2022
  38. Glen ChooMar 1, 2022
  39. Ævar Arnfjörð BjarmasonMar 3, 2022
  40. 00/13 submodule: convert parts of 'update' to CGlen Choo, Mar 3, 2022
  41. 01/13 submodule tests: test for init and update failure outputGlen Choo, Mar 3, 2022
  42. 03/13 submodule--helper: reorganize code for sh to C conversionGlen Choo, Mar 3, 2022
  43. 02/13 submodule--helper: remove update-module-modeGlen Choo, Mar 3, 2022
  44. 04/13 submodule--helper run-update-procedure: remove --suboidGlen Choo, Mar 3, 2022
  45. Junio C HamanoMar 3, 2022
  46. 05/13 submodule--helper: remove ensure-core-worktreeGlen Choo, Mar 3, 2022
  47. Junio C HamanoMar 3, 2022
  48. Glen ChooMar 4, 2022
  49. 06/13 submodule--helper: get remote names from any repositoryGlen Choo, Mar 3, 2022
  50. 07/13 submodule--helper: don't use bitfield indirection for parse_options()Glen Choo, Mar 3, 2022
  51. 08/13 submodule--helper run-update-procedure: learn --remoteGlen Choo, Mar 3, 2022
  52. Junio C HamanoMar 3, 2022
  53. Glen ChooMar 4, 2022
  54. 09/13 submodule--helper: refactor get_submodule_displaypath()Glen Choo, Mar 3, 2022
  55. 10/13 submodule--helper: allow setting superprefix for init_submodule()Glen Choo, Mar 3, 2022
  56. 11/13 submodule--helper update-clone: learn --initGlen Choo, Mar 3, 2022
  57. 12/13 submodule update: add tests for --filterGlen Choo, Mar 3, 2022
  58. 13/13 submodule--helper update-clone: check for --filter and --initGlen Choo, Mar 3, 2022
  59. Ævar Arnfjörð BjarmasonMar 3, 2022
  60. Junio C HamanoMar 3, 2022
  61. 00/13 submodule: convert parts of 'update' to CGlen Choo, Mar 5, 2022
  62. 01/13 submodule tests: test for init and update failure outputGlen Choo, Mar 5, 2022
  63. 04/13 submodule--helper run-update-procedure: remove --suboidGlen Choo, Mar 5, 2022
  64. 03/13 submodule--helper: reorganize code for sh to C conversionGlen Choo, Mar 5, 2022
  65. 02/13 submodule--helper: remove update-module-modeGlen Choo, Mar 5, 2022
  66. 05/13 submodule--helper: get remote names from any repositoryGlen Choo, Mar 5, 2022
  67. 06/13 submodule--helper: don't use bitfield indirection for parse_options()Glen Choo, Mar 5, 2022
  68. 07/13 submodule--helper run-update-procedure: learn --remoteGlen Choo, Mar 5, 2022
  69. 08/13 submodule--helper: refactor get_submodule_displaypath()Glen Choo, Mar 5, 2022
  70. 09/13 submodule--helper: allow setting superprefix for init_submodule()Glen Choo, Mar 5, 2022
  71. 10/13 submodule--helper update-clone: learn --initGlen Choo, Mar 5, 2022
  72. 11/13 submodule--helper: remove ensure-core-worktreeGlen Choo, Mar 5, 2022
  73. 13/13 submodule--helper update-clone: check for --filter and --initGlen Choo, Mar 5, 2022
  74. 12/13 submodule update: add tests for --filterGlen Choo, Mar 5, 2022
  75. Junio C HamanoMar 5, 2022

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.