submodule foreach: document variable '$displaypath'

It was observed that the variable '$displaypath' was accessible but
undocumented. Hence, document it.

Discussed-with: Ramsay Jones <ramsay@ramsayjones.plus.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Prathamesh Chavan <pc44800@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index 066c7b6c18e994859953451ec0273a7a444735c7..500dfdafd1641da96300bddfe28b4f732205cecf 100644 (file)
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt
@@ -183,11 +183,13 @@ information too.
 
 foreach [--recursive] <command>::
        Evaluates an arbitrary shell command in each checked out submodule.
 
 foreach [--recursive] <command>::
        Evaluates an arbitrary shell command in each checked out submodule.

-       The command has access to the variables $name, $sm_path, $sha1 and
-       $toplevel:
+       The command has access to the variables $name, $sm_path, $displaypath,
+       $sha1 and $toplevel:

        $name is the name of the relevant submodule section in `.gitmodules`,
        $sm_path is the path of the submodule as recorded in the immediate
        $name is the name of the relevant submodule section in `.gitmodules`,
        $sm_path is the path of the submodule as recorded in the immediate

-       superproject, $sha1 is the commit as recorded in the immediate
+       superproject, $displaypath contains the relative path from the
+       current working directory to the submodules root directory,
+       $sha1 is the commit as recorded in the immediate

        superproject, and $toplevel is the absolute path to the top-level
        of the immediate superproject.
        Note that to avoid conflicts with '$PATH' on Windows, the '$path'
        superproject, and $toplevel is the absolute path to the top-level
        of the immediate superproject.
        Note that to avoid conflicts with '$PATH' on Windows, the '$path'

diff --git a/t/t7407-submodule-foreach.sh b/t/t7407-submodule-foreach.sh
index 5144cc6926be3c9ff5b1a73919e9a96e7ac1a4c7..77729ac4aa1873a7e74b59975910ca33a00899d8 100755 (executable)
--- a/t/t7407-submodule-foreach.sh
+++ b/t/t7407-submodule-foreach.sh
@@ -82,16 +82,16 @@ test_expect_success 'test basic "submodule foreach" usage' '
 
 cat >expect <<EOF
 Entering '../sub1'
 
 cat >expect <<EOF
 Entering '../sub1'

-$pwd/clone-foo1-sub1-$sub1sha1
+$pwd/clone-foo1-sub1-../sub1-$sub1sha1

 Entering '../sub3'
 Entering '../sub3'

-$pwd/clone-foo3-sub3-$sub3sha1
+$pwd/clone-foo3-sub3-../sub3-$sub3sha1

 EOF
 
 test_expect_success 'test "submodule foreach" from subdirectory' '
        mkdir clone/sub &&
        (
                cd clone/sub &&
 EOF
 
 test_expect_success 'test "submodule foreach" from subdirectory' '
        mkdir clone/sub &&
        (
                cd clone/sub &&

-               git submodule foreach "echo \$toplevel-\$name-\$sm_path-\$sha1" >../../actual
+               git submodule foreach "echo \$toplevel-\$name-\$sm_path-\$displaypath-\$sha1" >../../actual

        ) &&
        test_i18ncmp expect actual
 '
        ) &&
        test_i18ncmp expect actual
 '


@@ -206,25 +206,25 @@ submodulesha1=$(cd clone2/nested1/nested2/nested3/submodule && git rev-parse HEA
 
 cat >expect <<EOF
 Entering '../nested1'
 
 cat >expect <<EOF
 Entering '../nested1'

-toplevel: $pwd/clone2 name: nested1 path: nested1 hash: $nested1sha1
+toplevel: $pwd/clone2 name: nested1 path: nested1 displaypath: ../nested1 hash: $nested1sha1

 Entering '../nested1/nested2'
 Entering '../nested1/nested2'

-toplevel: $pwd/clone2/nested1 name: nested2 path: nested2 hash: $nested2sha1
+toplevel: $pwd/clone2/nested1 name: nested2 path: nested2 displaypath: ../nested1/nested2 hash: $nested2sha1

 Entering '../nested1/nested2/nested3'
 Entering '../nested1/nested2/nested3'

-toplevel: $pwd/clone2/nested1/nested2 name: nested3 path: nested3 hash: $nested3sha1
+toplevel: $pwd/clone2/nested1/nested2 name: nested3 path: nested3 displaypath: ../nested1/nested2/nested3 hash: $nested3sha1

 Entering '../nested1/nested2/nested3/submodule'
 Entering '../nested1/nested2/nested3/submodule'

-toplevel: $pwd/clone2/nested1/nested2/nested3 name: submodule path: submodule hash: $submodulesha1
+toplevel: $pwd/clone2/nested1/nested2/nested3 name: submodule path: submodule displaypath: ../nested1/nested2/nested3/submodule hash: $submodulesha1

 Entering '../sub1'
 Entering '../sub1'

-toplevel: $pwd/clone2 name: foo1 path: sub1 hash: $sub1sha1
+toplevel: $pwd/clone2 name: foo1 path: sub1 displaypath: ../sub1 hash: $sub1sha1

 Entering '../sub2'
 Entering '../sub2'

-toplevel: $pwd/clone2 name: foo2 path: sub2 hash: $sub2sha1
+toplevel: $pwd/clone2 name: foo2 path: sub2 displaypath: ../sub2 hash: $sub2sha1

 Entering '../sub3'
 Entering '../sub3'

-toplevel: $pwd/clone2 name: foo3 path: sub3 hash: $sub3sha1
+toplevel: $pwd/clone2 name: foo3 path: sub3 displaypath: ../sub3 hash: $sub3sha1

 EOF
 
 test_expect_success 'test "submodule foreach --recursive" from subdirectory' '
        (
                cd clone2/untracked &&
 EOF
 
 test_expect_success 'test "submodule foreach --recursive" from subdirectory' '
        (
                cd clone2/untracked &&

-               git submodule foreach --recursive "echo toplevel: \$toplevel name: \$name path: \$sm_path hash: \$sha1" >../../actual
+               git submodule foreach --recursive "echo toplevel: \$toplevel name: \$name path: \$sm_path displaypath: \$displaypath hash: \$sha1" >../../actual

        ) &&
        test_i18ncmp expect actual
 '
        ) &&
        test_i18ncmp expect actual
 '