On 07/25, Prathamesh Chavan wrote: > It was observer that the variable '$displaypath' was accessible but s/observer/observed > undocumented. Hence, document it. > > Discussed-with: Ramsay Jones <ramsay@xxxxxxxxxxxxxxxxxxxx> > Signed-off-by: Stefan Beller <sbeller@xxxxxxxxxx> > Signed-off-by: Prathamesh Chavan <pc44800@xxxxxxxxx> > --- > Documentation/git-submodule.txt | 6 ++++-- > t/t7407-submodule-foreach.sh | 22 +++++++++++----------- > 2 files changed, 15 insertions(+), 13 deletions(-) > > diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt > index 8e7930ebc..0cca702cb 100644 > --- a/Documentation/git-submodule.txt > +++ b/Documentation/git-submodule.txt > @@ -183,10 +183,12 @@ information too. > > 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 superproject, > + $displaypath contains the relative path from the current working > + directory to the submodules root directory, > $sha1 is the commit as recorded in the superproject, and > $toplevel is the absolute path to its superproject, such that > $toplevel/$sm_path is the absolute path of the submodule. > diff --git a/t/t7407-submodule-foreach.sh b/t/t7407-submodule-foreach.sh > index 0663622a4..6ad57e061 100755 > --- 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' > -$pwd/clone-foo1-sub1-$sub1sha1 > +$pwd/clone-foo1-sub1-../sub1-$sub1sha1 > 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 && > - 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 > ' > @@ -206,25 +206,25 @@ submodulesha1=$(cd clone2/nested1/nested2/nested3/submodule && git rev-parse HEA > > cat >expect <<EOF > Entering '../nested1' > -$pwd/clone2-nested1-nested1-$nested1sha1 > +$pwd/clone2-nested1-nested1-../nested1-$nested1sha1 > Entering '../nested1/nested2' > -$pwd/clone2/nested1-nested2-nested2-$nested2sha1 > +$pwd/clone2/nested1-nested2-nested2-../nested1/nested2-$nested2sha1 > Entering '../nested1/nested2/nested3' > -$pwd/clone2/nested1/nested2-nested3-nested3-$nested3sha1 > +$pwd/clone2/nested1/nested2-nested3-nested3-../nested1/nested2/nested3-$nested3sha1 > Entering '../nested1/nested2/nested3/submodule' > -$pwd/clone2/nested1/nested2/nested3-submodule-submodule-$submodulesha1 > +$pwd/clone2/nested1/nested2/nested3-submodule-submodule-../nested1/nested2/nested3/submodule-$submodulesha1 > Entering '../sub1' > -$pwd/clone2-foo1-sub1-$sub1sha1 > +$pwd/clone2-foo1-sub1-../sub1-$sub1sha1 > Entering '../sub2' > -$pwd/clone2-foo2-sub2-$sub2sha1 > +$pwd/clone2-foo2-sub2-../sub2-$sub2sha1 > Entering '../sub3' > -$pwd/clone2-foo3-sub3-$sub3sha1 > +$pwd/clone2-foo3-sub3-../sub3-$sub3sha1 > EOF > > test_expect_success 'test "submodule foreach --recursive" from subdirectory' ' > ( > cd clone2/untracked && > - git submodule foreach --recursive "echo \$toplevel-\$name-\$sm_path-\$sha1" >../../actual > + git submodule foreach --recursive "echo \$toplevel-\$name-\$sm_path-\$displaypath-\$sha1" >../../actual > ) && > test_i18ncmp expect actual > ' > -- > 2.13.0 > -- Brandon Williams
