[GSoC][PATCH 11/13] submodule foreach: clarify the '$toplevel' variable documentation
- Date: Tue, 8 Aug 2017 02:48:58 +0530
- From: Prathamesh Chavan <pc44800@xxxxxxxxx>
- Subject: [GSoC][PATCH 11/13] submodule foreach: clarify the '$toplevel' variable documentation
It does not contain the topmost superproject as the author assumed,
but the direct superproject, such that $toplevel/$sm_path is the
actual absolute path of the submodule.
Discussed-with: Ramsay Jones <ramsay@xxxxxxxxxxxxxxxxxxxx>
Signed-off-by: Stefan Beller <sbeller@xxxxxxxxxx>
Signed-off-by: Prathamesh Chavan <pc44800@xxxxxxxxx>
Documentation/git-submodule.txt | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index a23baef62..8e7930ebc 100644
@@ -188,7 +188,8 @@ foreach [--recursive] <command>::
$name is the name of the relevant submodule section in `.gitmodules`,
$sm_path is the path of the submodule as recorded in the superproject,
$sha1 is the commit as recorded in the superproject, and
- $toplevel is the absolute path to the top-level of the superproject.
+ $toplevel is the absolute path to its superproject, such that
+ $toplevel/$sm_path is the absolute path of the submodule.
Note that to avoid conflicts with '$PATH' on Windows, the '$path'
variable is now a deprecated synonym of '$sm_path' variable.
Any submodules defined in the superproject but not checked out are