From: Mahi Kolla <mahikolla@xxxxxxxxxx>
Currently, when running 'git clone --recurse-submodules', developers do not expect other commands such as 'pull' or 'checkout' to run recursively into active submodules. However, setting 'submodule.recurse' to true at this step could make for a simpler workflow by eliminating the '--recurse-submodules' option in subsequent commands. To collect more data on developers' preference in regards to making 'submodule.recurse=true' a default config value in the future, deploy this feature under the opt in feature.experimental flag.
Since V1: Made this an opt in feature under the experimental flag. Updated tests to reflect this design change. Also updated commit message.
Signed-off-by: Mahi Kolla <mahikolla@xxxxxxxxxx>
---
clone: set submodule.recurse=true if feature.experimental flag enabled
Based on current experience, when running git clone
--recurse-submodules, developers do not expect other commands such as
pull or checkout to run recursively into active submodules. However,
setting submodule.recurse=true at this step could make for a simpler
workflow by eliminating the need for the --recurse-submodules option in
subsequent commands. To collect more data on developers' preference in
regards to making submodule.recurse=true a default config value in the
future, deploy this feature under the opt in feature.experimental flag.
Since V1: Made this an opt in feature under the experimental flag.
Updated tests to reflect this design change. Also updated commit
message.
Signed-off-by: Mahi Kolla mahikolla@xxxxxxxxxx
cc: Philippe Blain levraiphilippeblain@xxxxxxxxx
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1006%2F24mahik%2Fmaster-v5
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1006/24mahik/master-v5
Pull-Request: https://github.com/gitgitgadget/git/pull/1006
Range-diff vs v4:
1: 73937d48a53 ! 1: 2c6ffe00736 clone: update submodule.recurse in config when using --recurse-submodule
@@ Metadata
Author: Mahi Kolla <mahikolla@xxxxxxxxxx>
## Commit message ##
- clone: update submodule.recurse in config when using --recurse-submodule
+ clone: set submodule.recurse=true if user enables feature.experimental flag
- When running 'git clone --recurse-submodules', developers might expect various other commands such as 'pull' and 'checkout' to also run recursively into submodules. Set 'submodule.recurse' to true when 'git clone' is run with '--recurse-submodules'.
+ Currently, when running 'git clone --recurse-submodules', developers do not expect other commands such as 'pull' or 'checkout' to run recursively into active submodules. However, setting 'submodule.recurse' to true at this step could make for a simpler workflow by eliminating the '--recurse-submodules' option in subsequent commands. To collect more data on developers' preference in regards to making 'submodule.recurse=true' a default config value in the future, deploy this feature under the opt in feature.experimental flag.
- Since V1: Updated test and 'git clone' man page. Also updated commit message.
+ Since V1: Made this an opt in feature under the experimental flag. Updated tests to reflect this design change. Also updated commit message.
Signed-off-by: Mahi Kolla <mahikolla@xxxxxxxxxx>
- ## Documentation/git-clone.txt ##
-@@ Documentation/git-clone.txt: branch of some repository for search indexing.
- This option can be given multiple times for pathspecs consisting
- of multiple entries. The resulting clone has `submodule.active` set to
- the provided pathspec, or "." (meaning all submodules) if no
-- pathspec is provided.
-+ pathspec is provided. In addition, `submodule.recurse` is set to true.
- +
- Submodules are initialized and cloned using their default settings. This is
- equivalent to running
-
## builtin/clone.c ##
+@@ builtin/clone.c: int cmd_clone(int argc, const char **argv, const char *prefix)
+ struct remote *remote;
+ int err = 0, complete_refs_before_fetch = 1;
+ int submodule_progress;
++ int experimental_flag;
+
+ struct transport_ls_refs_options transport_ls_refs_options =
+ TRANSPORT_LS_REFS_OPTIONS_INIT;
@@ builtin/clone.c: int cmd_clone(int argc, const char **argv, const char *prefix)
strbuf_detach(&sb, NULL));
}
-+ string_list_append(&option_config, "submodule.recurse=true");
++ if(!git_config_get_bool("feature.experimental", &experimental_flag) &&
++ experimental_flag) {
++ string_list_append(&option_config, "submodule.recurse=true");
++ }
++
if (option_required_reference.nr &&
option_optional_reference.nr)
die(_("clone --recursive is not compatible with "
@@ t/t5606-clone-options.sh: test_expect_success 'setup' '
'
-+test_expect_success 'clone --recurse-submodules sets submodule.recurse=true' '
++test_expect_success 'feature.experimental flag manipulates submodule.recurse value' '
++
++ test_config_global feature.experimental true &&
++ git clone --recurse-submodules parent clone_recurse_true &&
++ test_cmp_config -C clone_recurse_true true submodule.recurse &&
+
-+ git clone --recurse-submodules parent clone-rec-submodule &&
-+ test_cmp_config -C clone-rec-submodule true submodule.recurse
++ test_config_global feature.experimental false &&
++ git clone --recurse-submodules parent clone_recurse_false &&
++ test_expect_code 1 git -C clone_recurse_false config --get submodule.recurse
+
+'
+
builtin/clone.c | 6 ++++++
t/t5606-clone-options.sh | 12 ++++++++++++
2 files changed, 18 insertions(+)
diff --git a/builtin/clone.c b/builtin/clone.c
index 66fe66679c8..24f242b4a60 100644
--- a/builtin/clone.c
+++ b/builtin/clone.c
@@ -986,6 +986,7 @@ int cmd_clone(int argc, const char **argv, const char *prefix)
struct remote *remote;
int err = 0, complete_refs_before_fetch = 1;
int submodule_progress;
+ int experimental_flag;
struct transport_ls_refs_options transport_ls_refs_options =
TRANSPORT_LS_REFS_OPTIONS_INIT;
@@ -1130,6 +1131,11 @@ int cmd_clone(int argc, const char **argv, const char *prefix)
strbuf_detach(&sb, NULL));
}
+ if(!git_config_get_bool("feature.experimental", &experimental_flag) &&
+ experimental_flag) {
+ string_list_append(&option_config, "submodule.recurse=true");
+ }
+
if (option_required_reference.nr &&
option_optional_reference.nr)
die(_("clone --recursive is not compatible with "
diff --git a/t/t5606-clone-options.sh b/t/t5606-clone-options.sh
index 3a595c0f82c..f20cdfa6fca 100755
--- a/t/t5606-clone-options.sh
+++ b/t/t5606-clone-options.sh
@@ -16,6 +16,18 @@ test_expect_success 'setup' '
'
+test_expect_success 'feature.experimental flag manipulates submodule.recurse value' '
+
+ test_config_global feature.experimental true &&
+ git clone --recurse-submodules parent clone_recurse_true &&
+ test_cmp_config -C clone_recurse_true true submodule.recurse &&
+
+ test_config_global feature.experimental false &&
+ git clone --recurse-submodules parent clone_recurse_false &&
+ test_expect_code 1 git -C clone_recurse_false config --get submodule.recurse
+
+'
+
test_expect_success 'clone -o' '
git clone -o foo parent clone-o &&
base-commit: 66262451ec94d30ac4b80eb3123549cf7a788afd
--
gitgitgadget
