--- v2
+++ v3
@@ -6,37 +6,47 @@
superproject directory around on the filesystem without breaking the
submodule's cache.
-Since this cached value is only introduced during new submodule creation
+Since this hint value is only introduced during new submodule creation
via `git submodule add`, though, there is more work to do to allow the
-cache to be created at other times.
+record to be created at other times.
+
+If the new config is present, we can do some optional value-added
+behavior, like letting "git status" print additional info about the
+submodule's status in relation to its superproject, or like letting the
+superproject and submodule share an additional config file separate from
+either one's local config.
Signed-off-by: Emily Shaffer <emilyshaffer@google.com>
+Helped-by: Junio C Hamano <gitster@pobox.com>
---
- Documentation/config/submodule.txt | 12 +++++++++
+ Documentation/config/submodule.txt | 15 +++++++++++
builtin/submodule--helper.c | 4 +++
t/t7400-submodule-basic.sh | 40 ++++++++++++++++--------------
- 3 files changed, 38 insertions(+), 18 deletions(-)
+ 3 files changed, 41 insertions(+), 18 deletions(-)
diff --git a/Documentation/config/submodule.txt b/Documentation/config/submodule.txt
-index d7a63c8c12..7c459cc19e 100644
+index d7a63c8c12..23e0a01d90 100644
--- a/Documentation/config/submodule.txt
+++ b/Documentation/config/submodule.txt
-@@ -90,3 +90,15 @@ submodule.alternateErrorStrategy::
+@@ -90,3 +90,18 @@ submodule.alternateErrorStrategy::
`ignore`, `info`, `die`. Default is `die`. Note that if set to `ignore`
or `info`, and if there is an error with the computed alternate, the
clone proceeds as if no alternate was specified.
+
+submodule.superprojectGitDir::
-+ The relative path from the submodule's worktree to the superproject's
-+ gitdir. This config should only be present in projects which are
-+ submodules, but is not guaranteed to be present in every submodule. It
-+ is set automatically during submodule creation.
++ The relative path from the submodule's worktree to its superproject's
++ gitdir. When Git is run in a repository, it usually makes no difference
++ whether this repository is standalone or a submodule, but if this
++ configuration variable is present, additional behavior may be possible,
++ such as "git status" printing additional information about this
++ submodule's status with respect to its superproject. This config should
++ only be present in projects which are submodules, but is not guaranteed
++ to be present in every submodule, so only optional value-added behavior
++ should be linked to it. It is set automatically during
++ submodule creation.
++
-+ In situations where more than one superproject references the same
-+ submodule worktree, the value of this config and the behavior of
-+ operations which use it are undefined. To reference a single project
-+ from multiple superprojects, it is better to create a worktree of the
-+ submodule for each superproject.
++ Because of this configuration variable, it is forbidden to use the
++ same submodule worktree shared by multiple superprojects.
diff --git a/builtin/submodule--helper.c b/builtin/submodule--helper.c
index d55f6262e9..d60fcd2c7d 100644
--- a/builtin/submodule--helper.c
@@ -53,7 +63,7 @@
free(error_strategy);
diff --git a/t/t7400-submodule-basic.sh b/t/t7400-submodule-basic.sh
-index f5dc051a6e..e45f42588f 100755
+index 4bc6b6c886..e407329d81 100755
--- a/t/t7400-submodule-basic.sh
+++ b/t/t7400-submodule-basic.sh
@@ -108,14 +108,18 @@ test_expect_success 'setup - repository to add submodules to' '
@@ -82,8 +92,8 @@
+ git -C "$sub_dir" clean -n -d -x >untracked
}
-
-@@ -139,7 +143,7 @@ test_expect_success 'submodule add' '
+ test_expect_success 'submodule add' '
+@@ -138,7 +142,7 @@ test_expect_success 'submodule add' '
) &&
rm -f heads head untracked &&
@@ -92,7 +102,7 @@
test_cmp expect heads &&
test_cmp expect head &&
test_must_be_empty untracked
-@@ -230,7 +234,7 @@ test_expect_success 'submodule add --branch' '
+@@ -229,7 +233,7 @@ test_expect_success 'submodule add --branch' '
) &&
rm -f heads head untracked &&
@@ -101,7 +111,7 @@
test_cmp expect-heads heads &&
test_cmp expect-head head &&
test_must_be_empty untracked
-@@ -246,7 +250,7 @@ test_expect_success 'submodule add with ./ in path' '
+@@ -245,7 +249,7 @@ test_expect_success 'submodule add with ./ in path' '
) &&
rm -f heads head untracked &&
@@ -110,7 +120,7 @@
test_cmp expect heads &&
test_cmp expect head &&
test_must_be_empty untracked
-@@ -262,7 +266,7 @@ test_expect_success 'submodule add with /././ in path' '
+@@ -261,7 +265,7 @@ test_expect_success 'submodule add with /././ in path' '
) &&
rm -f heads head untracked &&
@@ -119,7 +129,7 @@
test_cmp expect heads &&
test_cmp expect head &&
test_must_be_empty untracked
-@@ -278,7 +282,7 @@ test_expect_success 'submodule add with // in path' '
+@@ -277,7 +281,7 @@ test_expect_success 'submodule add with // in path' '
) &&
rm -f heads head untracked &&
@@ -128,7 +138,7 @@
test_cmp expect heads &&
test_cmp expect head &&
test_must_be_empty untracked
-@@ -294,7 +298,7 @@ test_expect_success 'submodule add with /.. in path' '
+@@ -293,7 +297,7 @@ test_expect_success 'submodule add with /.. in path' '
) &&
rm -f heads head untracked &&
@@ -137,7 +147,7 @@
test_cmp expect heads &&
test_cmp expect head &&
test_must_be_empty untracked
-@@ -310,7 +314,7 @@ test_expect_success 'submodule add with ./, /.. and // in path' '
+@@ -309,7 +313,7 @@ test_expect_success 'submodule add with ./, /.. and // in path' '
) &&
rm -f heads head untracked &&
@@ -146,7 +156,7 @@
test_cmp expect heads &&
test_cmp expect head &&
test_must_be_empty untracked
-@@ -341,7 +345,7 @@ test_expect_success 'submodule add in subdirectory' '
+@@ -340,7 +344,7 @@ test_expect_success 'submodule add in subdirectory' '
) &&
rm -f heads head untracked &&
@@ -155,7 +165,7 @@
test_cmp expect heads &&
test_cmp expect head &&
test_must_be_empty untracked
-@@ -482,7 +486,7 @@ test_expect_success 'update should work when path is an empty dir' '
+@@ -481,7 +485,7 @@ test_expect_success 'update should work when path is an empty dir' '
git submodule update -q >update.out &&
test_must_be_empty update.out &&
@@ -164,7 +174,7 @@
test_cmp expect head-sha1
'
-@@ -541,7 +545,7 @@ test_expect_success 'update should checkout rev1' '
+@@ -540,7 +544,7 @@ test_expect_success 'update should checkout rev1' '
echo "$rev1" >expect &&
git submodule update init &&
@@ -174,5 +184,5 @@
test_cmp expect head-sha1
'
--
-2.32.0.272.g935e593368-goog
+2.33.0.rc2.250.ged5fa647cd-goog