summaryrefslogtreecommitdiffstats
path: root/git-submodule.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2018-06-28 14:40:57 -0700
committerJunio C Hamano <gitster@pobox.com>2018-06-28 14:40:57 -0700
commitec40f134aa677499a0c1bf7ea6133b7b5fe348c4 (patch)
treeccfbc4d2f3b9dbf94015ba91975a7166105221f7 /git-submodule.txt
parent7578608bd24d16e08ff2c765d8e2aada854fee57 (diff)
downloadgit-htmldocs-ec40f134aa677499a0c1bf7ea6133b7b5fe348c4.tar.gz
Autogenerated HTML docs for v2.18.0-129-ge3331
Diffstat (limited to 'git-submodule.txt')
-rw-r--r--git-submodule.txt15
1 files changed, 10 insertions, 5 deletions
diff --git a/git-submodule.txt b/git-submodule.txt
index ef9d9d28a..ba3c4df55 100644
--- a/git-submodule.txt
+++ b/git-submodule.txt
@@ -183,12 +183,17 @@ information too.
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:
+ 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`,
- $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.
+ $sm_path is the path of the submodule as recorded in the immediate
+ superproject, $displaypath contains the relative path from the
+ current working directory to the submodules root directory,
+ $sha1 is the commit as recorded in the immediate
+ superproject, and $toplevel is the absolute path to the top-level
+ of the immediate superproject.
+ 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
ignored by this command. Unless given `--quiet`, foreach prints the name
of each submodule before evaluating the command.