diff options
| author | Prathamesh Chavan <pc44800@gmail.com> | 2018-05-09 03:29:51 +0300 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2018-05-09 06:37:00 +0300 |
| commit | b6f7ac8fd561d6df9c76009898daf96a93765ffc (patch) | |
| tree | 825ea9000b2fc288c4f496d9ab1c1437fe2f6ad7 /Documentation/git-submodule.txt | |
| parent | f0fd0dc5c5fcc066fc2e0b7dc1e809cb2d219ee3 (diff) | |
submodule foreach: document variable '$displaypath'
It was observed that the variable '$displaypath' was accessible but
undocumented. Hence, document it.
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/git-submodule.txt')
| -rw-r--r-- | Documentation/git-submodule.txt | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt index 066c7b6c18..500dfdafd1 100644 --- a/Documentation/git-submodule.txt +++ b/Documentation/git-submodule.txt @@ -183,11 +183,13 @@ information too. foreach [--recursive] <command>:: Evaluates an arbitrary shell command in each checked out submodule. - The command has access to the variables $name, $sm_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`, $sm_path is the path of the submodule as recorded in the immediate - superproject, $sha1 is the commit 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' |