git-submodule: give submodules proper names

This changes the way git-submodule uses .gitmodules: Subsections no longer
specify the submodule path, they now specify the submodule name. The
submodule path is found under the new key "submodule.<name>.path", which is
a required key.

With this change a submodule can be moved between different 'checkout paths'
without upsetting git-submodule.

Signed-off-by: Lars Hjemli <hjemli@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/git-submodule.sh b/git-submodule.sh
index 6c83c52cf422d44fd22b1df4e55da0de5e368581..89a388535026258d65ecba3c0dd6de68e2b06cb4 100755 (executable)
--- a/git-submodule.sh
+++ b/git-submodule.sh
@@ -25,6 +25,19 @@ say()
        fi
 }
 
+#
+# Map submodule path to submodule name
+#
+# $1 = path
+#
+module_name()
+{
+       name=$(GIT_CONFIG=.gitmodules git-config --get-regexp '^submodule\..*\.path$' "$1" |
+       sed -nre 's/^submodule\.(.+)\.path .+$/\1/p')
+       test -z "$name" &&
+       die "No submodule mapping found in .gitmodules for path '$path'"
+       echo "$name"
+}
 
 #
 # Clone a submodule
@@ -49,7 +62,7 @@ module_clone()
        die "A file already exist at path '$path'"
 
        git-clone -n "$url" "$path" ||
-       die "Clone of submodule '$path' failed"
+       die "Clone of '$url' into submodule path '$path' failed"
 }
 
 #
@@ -63,17 +76,18 @@ modules_init()
        while read mode sha1 stage path
        do
                # Skip already registered paths
-               url=$(git-config submodule."$path".url)
+               name=$(module_name "$path") || exit
+               url=$(git-config submodule."$name".url)
                test -z "$url" || continue
 
-               url=$(GIT_CONFIG=.gitmodules git-config submodule."$path".url)
+               url=$(GIT_CONFIG=.gitmodules git-config submodule."$name".url)
                test -z "$url" &&
-               die "No url found for submodule '$path' in .gitmodules"
+               die "No url found for submodule path '$path' in .gitmodules"
 
-               git-config submodule."$path".url "$url" ||
-               die "Failed to register url for submodule '$path'"
+               git-config submodule."$name".url "$url" ||
+               die "Failed to register url for submodule path '$path'"
 
-               say "Submodule '$path' registered with url '$url'"
+               say "Submodule '$name' ($url) registered for path '$path'"
        done
 }
 
@@ -87,13 +101,14 @@ modules_update()
        git ls-files --stage -- "$@" | grep -e '^160000 ' |
        while read mode sha1 stage path
        do
-               url=$(git-config submodule."$path".url)
+               name=$(module_name "$path") || exit
+               url=$(git-config submodule."$name".url)
                if test -z "$url"
                then
                        # Only mention uninitialized submodules when its
                        # path have been specified
                        test "$#" != "0" &&
-                       say "Submodule '$path' not initialized"
+                       say "Submodule path '$path' not initialized"
                        continue
                fi
 
@@ -104,22 +119,22 @@ modules_update()
                else
                        subsha1=$(unset GIT_DIR && cd "$path" &&
                                git-rev-parse --verify HEAD) ||
-                       die "Unable to find current revision of submodule '$path'"
+                       die "Unable to find current revision in submodule path '$path'"
                fi
 
                if test "$subsha1" != "$sha1"
                then
                        (unset GIT_DIR && cd "$path" && git-fetch &&
                                git-checkout -q "$sha1") ||
-                       die "Unable to checkout '$sha1' in submodule '$path'"
+                       die "Unable to checkout '$sha1' in submodule path '$path'"
 
-                       say "Submodule '$path': checked out '$sha1'"
+                       say "Submodule path '$path': checked out '$sha1'"
                fi
        done
 }
 
 #
-# List all registered submodules, prefixed with:
+# List all submodules, prefixed with:
 #  - submodule not initialized
 #  + different revision checked out
 #
@@ -133,7 +148,9 @@ modules_list()
        git ls-files --stage -- "$@" | grep -e '^160000 ' |
        while read mode sha1 stage path
        do
-               if ! test -d "$path"/.git
+               name=$(module_name "$path") || exit
+               url=$(git-config submodule."$name".url)
+               if test -z "url" || ! test -d "$path"/.git
                then
                        say "-$sha1 $path"
                        continue;

diff --git a/t/t7400-submodule-basic.sh b/t/t7400-submodule-basic.sh
index 9f2d4f9b38f199c04fb44d13d65659b1ff161d82..7a9b505b13f60ebbca188439b24f7a20b30b66cf 100755 (executable)
--- a/t/t7400-submodule-basic.sh
+++ b/t/t7400-submodule-basic.sh
@@ -18,7 +18,7 @@ subcommands of git-submodule.
 #  -add directory lib to 'superproject', this creates a DIRLINK entry
 #  -add a couple of regular files to enable testing of submodule filtering
 #  -mv lib subrepo
-#  -add an entry to .gitmodules for path 'lib'
+#  -add an entry to .gitmodules for submodule 'example'
 #
 test_expect_success 'Prepare submodule testing' '
        mkdir lib &&
@@ -40,7 +40,19 @@ test_expect_success 'Prepare submodule testing' '
        git-add a lib z &&
        git-commit -m "super commit 1" &&
        mv lib .subrepo &&
-       GIT_CONFIG=.gitmodules git-config submodule.lib.url git://example.com/lib.git
+       GIT_CONFIG=.gitmodules git-config submodule.example.url git://example.com/lib.git
+'
+
+test_expect_success 'status should fail for unmapped paths' '
+       if git-submodule status
+       then
+               echo "[OOPS] submodule status succeeded"
+               false
+       elif ! GIT_CONFIG=.gitmodules git-config submodule.example.path lib
+       then
+               echo "[OOPS] git-config failed to update .gitmodules"
+               false
+       fi
 '
 
 test_expect_success 'status should only print one line' '
@@ -54,12 +66,12 @@ test_expect_success 'status should initially be "missing"' '
 
 test_expect_success 'init should register submodule url in .git/config' '
        git-submodule init &&
-       url=$(git-config submodule.lib.url) &&
+       url=$(git-config submodule.example.url) &&
        if test "$url" != "git://example.com/lib.git"
        then
                echo "[OOPS] init succeeded but submodule url is wrong"
                false
-       elif ! git-config submodule.lib.url ./.subrepo
+       elif ! git-config submodule.example.url ./.subrepo
        then
                echo "[OOPS] init succeeded but update of url failed"
                false