[GSoC][PATCH v5 1/3] submodule: fix buggy $path and $sm_path variable's value

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@gmail.com>
Mentored-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Prathamesh Chavan <pc44800@gmail.com>
---
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(-)