On Fri, May 26, 2017 at 9:31 AM, Ramsay Jones
<ramsay@xxxxxxxxxxxxxxxxxxxx> wrote:
>
>
> On 26/05/17 16:17, Prathamesh Chavan wrote:
>> According to the documentation about git-submodule foreach subcommand's
>> $path variable:
>> $path is the name of the submodule directory relative to the superproject
>>
>> But it was observed when the value of the $path value deviates from this
>> for the nested submodules when the <command> is run from a subdirectory.
>> This patch aims for its correction.
>>
>> Mentored-by: Christian Couder <christian.couder@xxxxxxxxx>
>> Mentored-by: Stefan Beller <sbeller@xxxxxxxxxx>
>> Signed-off-by: Prathamesh Chavan <pc44800@xxxxxxxxx>
>> ---
>> This series of patch is based on gitster/jk/bug-to-abort for untilizing its
>> BUG() macro.
>>
>> The observation made was as follows:
>> For a project - super containing dir (not a submodule) and a submodule sub
>> which contains another submodule subsub. When we run a command from super/dir:
>>
>> git submodule foreach "echo \$path-\$sm_path"
>>
>> actual results:
>> Entering '../sub'
>> ../sub-../sub
>> Entering '../sub/subsub'
>> ../subsub-../subsub
>>
>> expected result wrt documentation and current test suite:
>> Entering '../sub'
>> sub-../sub
>> Entering '../sub/subsub'
>> subsub-../sub/subsub
>>
>> This make the value of $path confusing and I also feel it deviates from its
>> documentation:
>> $path is the name of the submodule directory relative to the superproject.
>> Hence, this patch corrects the value assigned to the $path and $sm_path.
>>
>> git-submodule.sh | 2 +-
>> 1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/git-submodule.sh b/git-submodule.sh
>> index c0d0e9a4c..ea6f56337 100755
>> --- a/git-submodule.sh
>> +++ b/git-submodule.sh
>> @@ -344,9 +344,9 @@ cmd_foreach()
>> prefix="$prefix$sm_path/"
>> sanitize_submodule_env
>> cd "$sm_path" &&
>> - sm_path=$(git submodule--helper relative-path "$sm_path" "$wt_prefix") &&
>> # we make $path available to scripts ...
>> path=$sm_path &&
>> + sm_path=$displaypath &&
>> if test $# -eq 1
>> then
>> eval "$1"
>>
>
> Hmm, I'm not sure which documentation you are referring to,
Quite likely our fine manual pages. ;)
foreach [--recursive] <command>
Evaluates an arbitrary shell command in each checked out submodule.
The command has access to the variables $name, $path, $sha1 and
$toplevel: $name is the name of the relevant submodule section in
.gitmodules, $path is the name of the submodule directory relative
to the superproject, $sha1 is the commit as recorded in the
superproject, and $toplevel is the absolute path to the top-level
of the superproject. Any submodules defined in the superproject but
not checked out are ignored by this command. Unless given --quiet,
foreach prints the name of each submodule before evaluating the
command. If --recursive is given, submodules are traversed
recursively (i.e. the given shell command is evaluated in nested
submodules as well). A non-zero return from the command in any
submodule causes the processing to terminate. This can be
overridden by adding || : to the end of the command.
As $path is documented and $sm_path is not, we should care about
$path first to be correct and either fix the documentation or the implementation
such that we have a consistent world view. :)
> but if
> $path != $sm_path then something is wrong. (unless their definition
> has changed, of course).
I would lean in doing so (changing their definition):
$path (as documented) is the name of the submodule directory
relative to the direct superproject (so in nested submodules you
go up only one level).
$sm_path on the other hand is not documented at all and yields
non-sense results in corner cases.
With this patch it becomes less non-sensey and could be documented as:
$sm_path is the relative path from the current working directory
to the submodule (ignoring relations to the superproject or nesting
of submodules). This documentation also fits into the narrative of
the test in t7407.
Thanks,
Stefan