submodules: don't stumble over symbolic links when cloning recursively
PATCH 1/1 submodules: don't stumble over symbolic links when cloning recursively
Since 69c305178 (submodules: refactor computation of relative gitdir path) cloning a submodule recursively fails for recursive submodules when a symbolic link is part of the path to the work tree of the superproject.
This happens when module_clone() tries to find the relative paths between work tree and git dir. When a symbolic link in current $PWD points to a directory in a different level determining the number of "../" needed to traverse to the superprojects work tree leads to a wrong result.
As there is no portable way to say "pwd -P" use cd_to_toplevel to remove the link from the pwd, which fixes this problem.
A test for this problem has been added to t7406.
---
Thanks to Bob for providing a very detailed bug report and test case!
git-submodule.sh | 4 ++-- t/t7406-submodule-update.sh | 13 +++++++++++++ 2 files changed, 15 insertions(+), 2 deletions(-)
git-submodule.sh +2 -2
@@ -186,8 +186,8 @@ module_clone() die "$(eval_gettext "Clone of '\$url' into submodule path '\$sm_path' failed")" fi - a=$(cd "$gitdir" && pwd)/ - b=$(cd "$sm_path" && pwd)/ + a=$(cd_to_toplevel && cd "$gitdir" && pwd)/ + b=$(cd_to_toplevel && cd "$sm_path" && pwd)/ # normalize Windows-style absolute paths to POSIX-style absolute paths case $a in [a-zA-Z]:/*) a=/${a%%:*}${a#*:} ;; esac case $b in [a-zA-Z]:/*) b=/${b%%:*}${b#*:} ;; esac
t/t7406-submodule-update.sh +13 -0
@@ -636,4 +636,17 @@ test_expect_success 'submodule update properly revives a moved submodule' ' ) ' +test_expect_success 'submodule update can handle symbolic links in pwd' ' + mkdir -p linked/dir && + ln -s linked/dir linkto && + ( + cd linkto && + git clone "$TRASH_DIRECTORY"/super_update_r2 super && + ( + cd super && + git submodule update --init --recursive + ) + ) +' + test_done
Signature · 1 line
1.7.11.1.166.gb8ff004
Am 11.07.2012 20:11, schrieb Jens Lehmann:
Quoted 11 lines
Since
69c305178(submodules: refactor computation of relative gitdir path) cloning a submodule recursively fails for recursive submodules when a symbolic link is part of the path to the work tree of the superproject.This happens when
module_clone()tries to find the relative paths between work tree and git dir. When a symbolic link in current $PWD points to a directory in a different level determining the number of "../" needed to traverse to the superprojects work tree leads to a wrong result.As there is no portable way to say "pwd -P" use
cd_to_toplevelto remove the link from the pwd, which fixes this problem.
...
git-submodule.sh module_clone() · line 190
Quoted 4 lines
git-submodule.sh +2
-2- a=$(cd "$gitdir" && pwd)/ - b=$(cd "$sm_path" && pwd)/ + a=$(cd_to_toplevel && cd "$gitdir" && pwd)/ + b=$(cd_to_toplevel && cd "$sm_path" && pwd)/
But if you cd out, how can it be correct not to cd in again if $gitdir and/or $sm_path are relative?
And if $gitdir and/or $sm_path are absolute, how can the earlier cd_to_toplevel make a difference?
Quoted 1 line
+test_expect_success 'submodule update can handle symbolic links in pwd' '
Please add a SYMLINKS prerequisite.
t/t7406-submodule-update.sh test_expect_success 'submodule update properly revives a moved submodule' ' · line 650
Quoted 11 lines
t/t7406-submodule-update.sh +11
-0+ mkdir -p linked/dir && + ln -s linked/dir linkto && + ( + cd linkto && + git clone "$TRASH_DIRECTORY"/super_update_r2 super && + ( + cd super && + git submodule update --init --recursive + ) + ) +'
-- Hannes
Am 11.07.2012 21:10, schrieb Johannes Sixt:
Quoted 12 lines
Am 11.07.2012 20:11, schrieb Jens Lehmann:
Quoted 11 lines
Since
69c305178(submodules: refactor computation of relative gitdir path) cloning a submodule recursively fails for recursive submodules when a symbolic link is part of the path to the work tree of the superproject.This happens when
module_clone()tries to find the relative paths between work tree and git dir. When a symbolic link in current $PWD points to a directory in a different level determining the number of "../" needed to traverse to the superprojects work tree leads to a wrong result.As there is no portable way to say "pwd -P" use
cd_to_toplevelto remove the link from the pwd, which fixes this problem.
Quoted 8 lines
...
git-submodule.sh module_clone() · line 190
Quoted 4 lines
git-submodule.sh +2
-2- a=$(cd "$gitdir" && pwd)/ - b=$(cd "$sm_path" && pwd)/ + a=$(cd_to_toplevel && cd "$gitdir" && pwd)/ + b=$(cd_to_toplevel && cd "$sm_path" && pwd)/But if you cd out, how can it be correct not to cd in again if $gitdir and/or $sm_path are relative?
I'm not sure what you mean by "cd out", but the two "cd_to_toplevel" make sure that when $gitdir or $sm_path are relative the symbolic link gets removed from the output of pwd. So it's rather "cd into the path where the symlink is resolved".
Quoted 2 lines
And if $gitdir and/or $sm_path are absolute, how can the earlier
cd_to_toplevelmake a difference?
Then it doesn't, but $sm_path is always relative while $gitdir is sometimes (in the superproject it returns ".git"). Just drop either of the "cd_to_toplevel" and run the test ;-)
But it looks like the commit message could use some tuning ...
Quoted 3 lines
Quoted 1 line
+test_expect_success 'submodule update can handle symbolic links in pwd' '
Please add a SYMLINKS prerequisite.
Oops. Thanks, will add that.
Will wait some time for other comments before preparing v2.
Am 11.07.2012 22:06, schrieb Jens Lehmann:
Quoted 22 lines
Am 11.07.2012 21:10, schrieb Johannes Sixt:
Quoted 12 lines
Am 11.07.2012 20:11, schrieb Jens Lehmann:
Quoted 11 lines
Since
69c305178(submodules: refactor computation of relative gitdir path) cloning a submodule recursively fails for recursive submodules when a symbolic link is part of the path to the work tree of the superproject.This happens when
module_clone()tries to find the relative paths between work tree and git dir. When a symbolic link in current $PWD points to a directory in a different level determining the number of "../" needed to traverse to the superprojects work tree leads to a wrong result.As there is no portable way to say "pwd -P" use
cd_to_toplevelto remove the link from the pwd, which fixes this problem.Quoted 8 lines
...
git-submodule.sh module_clone() · line 190
Quoted 4 lines
git-submodule.sh +2
-2- a=$(cd "$gitdir" && pwd)/ - b=$(cd "$sm_path" && pwd)/ + a=$(cd_to_toplevel && cd "$gitdir" && pwd)/ + b=$(cd_to_toplevel && cd "$sm_path" && pwd)/But if you cd out, how can it be correct not to cd in again if $gitdir and/or $sm_path are relative?
Quoted 4 lines
I'm not sure what you mean by "cd out", but the two "
cd_to_toplevel" make sure that when $gitdir or $sm_path are relative the symbolic link gets removed from the output of pwd. So it's rather "cd into the path where the symlink is resolved".
At this point we can be in a subdirectory of the worktree. With cd_to_toplevel we move up in the directory hierarchy ("cd out"). Then a relative $gitdir or $sm_path now points to the wrong directory. No?
-- Hannes
Am 11.07.2012 22:39, schrieb Johannes Sixt:
Quoted 23 lines
Am 11.07.2012 22:06, schrieb Jens Lehmann:
Quoted 22 lines
Am 11.07.2012 21:10, schrieb Johannes Sixt:
Quoted 20 lines
Am 11.07.2012 20:11, schrieb Jens Lehmann:
Quoted 11 lines
Since
69c305178(submodules: refactor computation of relative gitdir path) cloning a submodule recursively fails for recursive submodules when a symbolic link is part of the path to the work tree of the superproject.This happens when
module_clone()tries to find the relative paths between work tree and git dir. When a symbolic link in current $PWD points to a directory in a different level determining the number of "../" needed to traverse to the superprojects work tree leads to a wrong result.As there is no portable way to say "pwd -P" use
cd_to_toplevelto remove the link from the pwd, which fixes this problem....
git-submodule.sh module_clone() · line 190
Quoted 4 lines
git-submodule.sh +2
-2- a=$(cd "$gitdir" && pwd)/ - b=$(cd "$sm_path" && pwd)/ + a=$(cd_to_toplevel && cd "$gitdir" && pwd)/ + b=$(cd_to_toplevel && cd "$sm_path" && pwd)/But if you cd out, how can it be correct not to cd in again if $gitdir and/or $sm_path are relative?
Quoted 8 lines
Quoted 4 lines
I'm not sure what you mean by "cd out", but the two "
cd_to_toplevel" make sure that when $gitdir or $sm_path are relative the symbolic link gets removed from the output of pwd. So it's rather "cd into the path where the symlink is resolved".At this point we can be in a subdirectory of the worktree. With
cd_to_toplevelwe move up in the directory hierarchy ("cd out"). Then a relative $gitdir or $sm_path now points to the wrong directory. No?
Nope, "git submodule" will refuse to run in anything but the root of the worktree. So we already are at the toplevel and use "cd_to_toplevel" only to resolve any symlinks present in $PWD. Looks like a comment explaining that above those lines would be a good idea ... will add one.
Am 11.07.2012 23:08, schrieb Jens Lehmann:
Quoted 9 lines
Am 11.07.2012 22:39, schrieb Johannes Sixt:
Quoted 3 lines
At this point we can be in a subdirectory of the worktree. With
cd_to_toplevelwe move up in the directory hierarchy ("cd out"). Then a relative $gitdir or $sm_path now points to the wrong directory. No?Nope, "git submodule" will refuse to run in anything but the root of the worktree. So we already are at the toplevel and use "
cd_to_toplevel" only to resolve any symlinks present in $PWD. Looks like a comment explaining that above those lines would be a good idea ... will add one.
Ah, OK. I missed the lack of SUBDIRECTORY_OK=Yes, but noticed a few cd_to_toplevel sprinkled throughout the script, so I thought it was OK to be in a subdirectory.
-- Hannes