diff options
| author | Prathamesh Chavan <pc44800@gmail.com> | 2018-02-02 10:27:43 +0530 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2018-02-02 12:47:53 -0800 |
| commit | 785bdb16d6667cb548f1e6fa9f9aedae9a940031 (patch) | |
| tree | 2bf6e0c7967ba1d3a59b7e6c0f76dd183d7da59b | |
| parent | 3753f1e8d23798af4f668d1fcdc49fb697ba3486 (diff) | |
| download | git-785bdb16d6667cb548f1e6fa9f9aedae9a940031.tar.gz | |
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@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>
| -rw-r--r-- | Documentation/git-submodule.txt | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt index a23baef62b..8e7930ebc2 100644 --- a/Documentation/git-submodule.txt +++ b/Documentation/git-submodule.txt @@ -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 |