diff options
| author | Junio C Hamano <gitster@pobox.com> | 2007-06-12 00:17:26 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2007-06-12 00:17:26 -0700 |
| commit | 30ba3809a4670c99c73800393ce29473c84c8521 (patch) | |
| tree | 056d8ea3c5b508f9b15db1f666e5867bcd92e441 /Documentation | |
| parent | f26cacf4956b08238868b21a8eac6b5e51a17d7f (diff) | |
| parent | 211b7f19c7b046a6cadd36d54c549e4f335f0519 (diff) | |
| download | git-30ba3809a4670c99c73800393ce29473c84c8521.tar.gz git-30ba3809a4670c99c73800393ce29473c84c8521.tar.xz | |
Merge branch 'lh/submodule'
* lh/submodule:
git-submodule: clone during update, not during init
git-submodule: move cloning into a separate function
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/git-submodule.txt | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt index cb0424f77..f8fb80f18 100644 --- a/Documentation/git-submodule.txt +++ b/Documentation/git-submodule.txt @@ -23,15 +23,15 @@ status:: repository. This command is the default command for git-submodule. init:: - Initialize the submodules, i.e. clone the git repositories specified - in the .gitmodules file and checkout the submodule commits specified - in the index of the containing repository. This will make the - submodules HEAD be detached. + Initialize the submodules, i.e. register in .git/config each submodule + path and url found in .gitmodules. The key used in git/config is + `submodule.$path.url`. This command does not alter existing information + in .git/config. update:: - Update the initialized submodules, i.e. checkout the submodule commits - specified in the index of the containing repository. This will make - the submodules HEAD be detached. + Update the registered submodules, i.e. clone missing submodules and + checkout the commit specified in the index of the containing repository. + This will make the submodules HEAD be detached. OPTIONS @@ -50,7 +50,7 @@ OPTIONS FILES ----- -When cloning submodules, a .gitmodules file in the top-level directory +When initializing submodules, a .gitmodules file in the top-level directory of the containing repository is used to find the url of each submodule. This file should be formatted in the same way as $GIR_DIR/config. The key to each submodule url is "module.$path.url". |