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

[PATCHv2 34/36] submodule update: add `--init-default-path` switch

From
Stefan Beller <sbeller@google.com>
Date
Oct 28, 2016, 18:55 UTC
Message-ID
<20161028185502.8789-35-sbeller@google.com>
In-Reply-To
<20161028185502.8789-1-sbeller@google.com>

The new switch `--init-default-path` initializes the submodules which are configured in `submodule.defaultUpdatePath` instead of those given as command line arguments before updating. In the first implementation this is made incompatible with further command line arguments as it is unclear what the user means by

    git submodule update --init --init-default-path <paths>

This new switch allows to record more complex patterns as it saves retyping them whenever you invoke update.

Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
 Documentation/config.txt        |  5 ++++
 Documentation/git-submodule.txt | 17 +++++++++----
 git-submodule.sh                | 21 +++++++++++++---
 t/t7400-submodule-basic.sh      | 53 +++++++++++++++++++++++++++++++++++++++++
 4 files changed, 89 insertions(+), 7 deletions(-)
diff --git a/Documentation/config.txt b/Documentation/config.txt
index 27069ac032..72901ef90e 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -2886,6 +2886,11 @@ submodule.alternateErrorStrategy
 	as computed via `submodule.alternateLocation`. Possible values are
 	`ignore`, `info`, `die`. Default is `die`.
 
+submodule.defaultUpdatePath::
+	Specifies a set of submodules to initialize when calling
+	`git submodule --init-default-group` by using the pathspec
+	syntax.
+
 tag.forceSignAnnotated::
 	A boolean to specify whether annotated tags created should be GPG signed.
 	If `--annotate` is specified on the command line, it takes
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index d841573475..98a6d36c78 100644
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt
@@ -14,10 +14,10 @@ SYNOPSIS
 'git submodule' [--quiet] status [--cached] [--recursive] [--] [<path>...]
 'git submodule' [--quiet] init [--] [<path>...]
 'git submodule' [--quiet] deinit [-f|--force] (--all|[--] <path>...)
-'git submodule' [--quiet] update [--init] [--remote] [-N|--no-fetch]
-	      [--[no-]recommend-shallow] [-f|--force] [--rebase|--merge]
-	      [--reference <repository>] [--depth <depth>] [--recursive]
-	      [--jobs <n>] [--] [<path>...]
+'git submodule' [--quiet] update [--init[-default-path]] [--remote] [-N|--no-fetch]
+	      [--[no-]recommend-shallow]
+	      [-f|--force] [--rebase|--merge] [--reference <repository>]
+	      [--depth <depth>] [--recursive] [--jobs <n>] [--] [<path>...]
 'git submodule' [--quiet] summary [--cached|--files] [(-n|--summary-limit) <n>]
 	      [commit] [--] [<path>...]
 'git submodule' [--quiet] foreach [--recursive] <command>
@@ -194,6 +194,10 @@ If the submodule is not yet initialized, and you just want to use the
 setting as stored in .gitmodules, you can automatically initialize the
 submodule with the `--init` option.
 
+You can configure a set of submodules using pathspec syntax in
+submodule.defaultUpdatePath you can use `--init-default-path` to initialize
+those before updating.
+
 If `--recursive` is specified, this command will recurse into the
 registered submodules, and update any nested submodules within.
 --
@@ -363,6 +367,11 @@ the submodule itself.
 	Initialize all submodules for which "git submodule init" has not been
 	called so far before updating.
 
+--init-default-path::
+	This option is only valid for the update command.
+	Initialize all submodules configured in "`submodule.defaultUpdatePath`"
+	that have not been updated before.
+
 --name::
 	This option is only valid for the add command. It sets the submodule's
 	name to the given string instead of defaulting to its path. The name
diff --git a/git-submodule.sh b/git-submodule.sh
index a024a135d6..334cecc62d 100755
--- a/git-submodule.sh
+++ b/git-submodule.sh
@@ -9,7 +9,7 @@ USAGE="[--quiet] add [-b <branch>] [-f|--force] [--name <name>] [--reference <re
    or: $dashless [--quiet] status [--cached] [--recursive] [--] [<path>...]
    or: $dashless [--quiet] init [--] [<path>...]
    or: $dashless [--quiet] deinit [-f|--force] (--all| [--] <path>...)
-   or: $dashless [--quiet] update [--init] [--remote] [-N|--no-fetch] [-f|--force] [--checkout|--merge|--rebase] [--[no-]recommend-shallow] [--reference <repository>] [--recursive] [--] [<path>...]
+   or: $dashless [--quiet] update [--init[-default-path]] [--remote] [-N|--no-fetch] [-f|--force] [--checkout|--merge|--rebase] [--[no-]recommend-shallow] [--reference <repository>] [--recursive] [--] [<path>...]
    or: $dashless [--quiet] summary [--cached|--files] [--summary-limit <n>] [commit] [--] [<path>...]
    or: $dashless [--quiet] foreach [--recursive] <command>
    or: $dashless [--quiet] sync [--recursive] [--] [<path>...]"
@@ -503,7 +503,12 @@ cmd_update()
 			progress="--progress"
 			;;
 		-i|--init)
-			init=1
+			test -z $init || test $init = by_args || die "$(gettext "Only one of --init or --init-default-path may be used.")"
+			init=by_args
+			;;
+		--init-default-path)
+			test -z $init || test $init = by_config || die "$(gettext "Only one of --init or --init-default-path may be used.")"
+			init=by_config
 			;;
 		--remote)
 			remote=1
@@ -572,7 +577,17 @@ cmd_update()
 
 	if test -n "$init"
 	then
-		cmd_init "--" "$@" || return
+		if test "$init" = "by_config"
+		then
+			if test $# -gt 0
+			then
+				die "$(gettext "path arguments are incompatible with --init-default-path")"
+			fi
+			cmd_init "--" $(git config --get-all submodule.defaultUpdatePath) || return
+		else
+			cmd_init "--" "$@" || return
+		fi
+
 	fi
 
 	{
diff --git a/t/t7400-submodule-basic.sh b/t/t7400-submodule-basic.sh
index b77cce8e40..4699b1c532 100755
--- a/t/t7400-submodule-basic.sh
+++ b/t/t7400-submodule-basic.sh
@@ -1116,5 +1116,58 @@ test_expect_success 'submodule helper list is not confused by common prefixes' '
 	test_cmp expect actual
 '
 
+test_expect_success 'setup superproject with submodules' '
+	mkdir sub1 &&
+	(
+		cd sub1 &&
+		git init &&
+		test_commit test &&
+		test_commit test2
+	) &&
+	mkdir multisuper &&
+	(
+		cd multisuper &&
+		git init &&
+		git submodule add ../sub1 sub0 &&
+		git submodule add ../sub1 sub1 &&
+		git submodule add ../sub1 sub2 &&
+		git submodule add ../sub1 sub3 &&
+		git commit -m "add some submodules"
+	)
+'
+
+cat >expect <<-EOF
+-sub0
+ sub1 (test2)
+ sub2 (test2)
+ sub3 (test2)
+EOF
+
+test_expect_success 'submodule update --init with a specification' '
+	test_when_finished "rm -rf multisuper_clone" &&
+	pwd=$(pwd) &&
+	git clone file://"$pwd"/multisuper multisuper_clone &&
+	(
+		cd multisuper_clone &&
+		git submodule update --init . ":(exclude)sub0" &&
+		git submodule status |cut -c 1,43- >../actual
+	) &&
+	test_cmp expect actual
+'
+
+test_expect_success 'submodule update --init-default-path' '
+	test_when_finished "rm -rf multisuper_clone" &&
+	pwd=$(pwd) &&
+	git clone file://"$pwd"/multisuper multisuper_clone &&
+	(
+		cd multisuper_clone &&
+		git config submodule.defaultUpdatePath "." &&
+		git config --add submodule.defaultUpdatePath ":(exclude)sub0" &&
+		git submodule update --init-default-path &&
+		git submodule status |cut -c 1,43- >../actual &&
+		test_must_fail git submodule update --init-default-path sub0
+	) &&
+	test_cmp expect actual
+'
 
 test_done

-- 
2.10.1.714.ge3da0db
Previous: Stefan BellerNext: Stefan Beller
Message 29 of 50 in “[PATCHv2 00/36] Revamp the attr subsystem!”
  1. Stefan BellerOct 28, 2016
  2. 01/36 commit.c: use strchrnul() to scan for one lineStefan Beller, Oct 28, 2016
  3. 02/36 attr.c: use strchrnul() to scan for one lineStefan Beller, Oct 28, 2016
  4. 03/36 attr.c: update a stale comment on "struct match_attr"Stefan Beller, Oct 28, 2016
  5. 04/36 attr.c: explain the lack of attr-name syntax check in parse_attr()Stefan Beller, Oct 28, 2016
  6. 06/36 attr.c: mark where #if DEBUG ends more clearlyStefan Beller, Oct 28, 2016
  7. 07/36 attr.c: simplify macroexpand_one()Stefan Beller, Oct 28, 2016
  8. 05/36 attr.c: complete a sentence in a commentStefan Beller, Oct 28, 2016
  9. 09/36 attr.c: plug small leak in parse_attr_line()Stefan Beller, Oct 28, 2016
  10. 08/36 attr.c: tighten constness around "git_attr" structureStefan Beller, Oct 28, 2016
  11. 10/36 attr: rename function and struct related to checking attributesStefan Beller, Oct 28, 2016
  12. 14/36 attr: retire git_check_attrs() APIStefan Beller, Oct 28, 2016
  13. 19/36 attr.c: add push_stack() helperStefan Beller, Oct 28, 2016
  14. 25/36 attr.c: outline the future plans by heavily commentingStefan Beller, Oct 28, 2016
  15. 18/36 attr: support quoting pathname patterns in C styleStefan Beller, Oct 28, 2016
  16. 20/36 attr.c: pass struct git_attr_check down the callchainStefan Beller, Oct 28, 2016
  17. 21/36 attr.c: rename a local variable checkStefan Beller, Oct 28, 2016
  18. 22/36 attr.c: correct ugly hack for git_all_attrs()Stefan Beller, Oct 28, 2016
  19. 28/36 attr: keep attr stack for each checkStefan Beller, Oct 28, 2016
  20. Junio C HamanoOct 28, 2016
  21. 23/36 attr.c: introduce empty_attr_check_elems()Stefan Beller, Oct 28, 2016
  22. 26/36 attr: make git_check_attr_counted staticStefan Beller, Oct 28, 2016
  23. 27/36 attr: convert to new threadsafe APIStefan Beller, Oct 28, 2016
  24. Junio C HamanoOct 28, 2016
  25. Stefan BellerOct 28, 2016
  26. Junio C HamanoOct 28, 2016
  27. Johannes SixtOct 29, 2016
  28. 29/36 Documentation: fix a typoStefan Beller, Oct 28, 2016
  29. 34/36 submodule update: add `--init-default-path` switchStefan Beller, Oct 28, 2016
  30. SQUASH to: submodule update: add `--init-default-path` switchStefan Beller, Nov 3, 2016
  31. 32/36 pathspec: allow querying for attributesStefan Beller, Oct 28, 2016
  32. Duy NguyenNov 9, 2016
  33. Stefan BellerNov 9, 2016
  34. 36/36 completion: clone can initialize specific submodulesStefan Beller, Oct 28, 2016
  35. 31/36 pathspec: move prefix check out of the inner loopStefan Beller, Oct 28, 2016
  36. 35/36 clone: add --init-submodule=<pathspec> switchStefan Beller, Oct 28, 2016
  37. 33/36 pathspec: allow escaped query valuesStefan Beller, Oct 28, 2016
  38. 30/36 pathspec: move long magic parsing out of prefix_pathspecStefan Beller, Oct 28, 2016
  39. 24/36 attr.c: always pass check[] to collect_some_attrs()Stefan Beller, Oct 28, 2016
  40. 13/36 attr: convert git_check_attrs() callers to use the new APIStefan Beller, Oct 28, 2016
  41. 17/36 attr: expose validity check for attribute namesStefan Beller, Oct 28, 2016
  42. 16/36 attr: add counted string version of git_attr()Stefan Beller, Oct 28, 2016
  43. 15/36 attr: add counted string version of git_check_attr()Stefan Beller, Oct 28, 2016
  44. 12/36 attr: convert git_all_attrs() to use "struct git_attr_check"Stefan Beller, Oct 28, 2016
  45. 11/36 attr: (re)introduce git_check_attr() and struct git_attr_checkStefan Beller, Oct 28, 2016
  46. Junio C HamanoOct 28, 2016
  47. Stefan BellerOct 28, 2016
  48. Ramsay JonesOct 28, 2016
  49. Johannes SixtNov 3, 2016
  50. Stefan BellerNov 3, 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.