summaryrefslogtreecommitdiffstats
path: root/git-submodule.html
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.html
parent7578608bd24d16e08ff2c765d8e2aada854fee57 (diff)
downloadgit-htmldocs-ec40f134aa677499a0c1bf7ea6133b7b5fe348c4.tar.gz
Autogenerated HTML docs for v2.18.0-129-ge3331
Diffstat (limited to 'git-submodule.html')
-rw-r--r--git-submodule.html17
1 files changed, 11 insertions, 6 deletions
diff --git a/git-submodule.html b/git-submodule.html
index 02d3dba4c..32518535e 100644
--- a/git-submodule.html
+++ b/git-submodule.html
@@ -978,12 +978,17 @@ foreach [--recursive] &lt;command&gt;
<dd>
<p>
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 <code>.gitmodules</code>,
- $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 <em>$PATH</em> on Windows, the <em>$path</em>
+ variable is now a deprecated synonym of <em>$sm_path</em> variable.
Any submodules defined in the superproject but not checked out are
ignored by this command. Unless given <code>--quiet</code>, foreach prints the name
of each submodule before evaluating the command.
@@ -1360,7 +1365,7 @@ for details.</p></div>
<div id="footer">
<div id="footer-text">
Last updated
- 2018-06-18 11:31:52 PDT
+ 2018-06-28 14:40:38 PDT
</div>
</div>
</body>