diff options
| author | Prathamesh Chavan <pc44800@gmail.com> | 2018-05-08 17:29:50 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2018-05-09 12:37:00 +0900 |
| commit | f0fd0dc5c5fcc066fc2e0b7dc1e809cb2d219ee3 (patch) | |
| tree | 3dedc761c2ba40c4c5c56271bd41fbc2137d0803 /Documentation | |
| parent | c033a2f62dda774de8cccc83b7f1918377995d6c (diff) | |
| download | git-f0fd0dc5c5fcc066fc2e0b7dc1e809cb2d219ee3.tar.gz | |
submodule foreach: document '$sm_path' instead of '$path'
As using a variable '$path' may be harmful to users due to
capitalization issues, see 64394e3ae9 (git-submodule.sh: Don't
use $path variable in eval_gettext string, 2012-04-17). Adjust
the documentation to advocate for using $sm_path, which contains
the same value. We still make the 'path' variable available and
document it as a deprecated synonym of 'sm_path'.
Discussed-with: Ramsay Jones <ramsay@ramsayjones.plus.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Prathamesh Chavan <pc44800@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/git-submodule.txt | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt index 630999f41a..066c7b6c18 100644 --- a/Documentation/git-submodule.txt +++ b/Documentation/git-submodule.txt @@ -183,12 +183,15 @@ 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 + The command has access to the variables $name, $sm_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. + $sm_path is the path of the submodule as recorded in the immediate + superproject, $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. |