diff options
| author | Junio C Hamano <gitster@pobox.com> | 2015-03-13 22:56:03 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2015-03-13 22:56:03 -0700 |
| commit | 30a52c1dcbb286214a0d59fb4b3df1d13d9d060d (patch) | |
| tree | c50c7c6212f91a6adc78dc1c102bdb26aad55944 /Documentation/config.txt | |
| parent | 5244a31039dbb3fe0d544fc56100d0ccbc653131 (diff) | |
| parent | 5c31acfbe22cebdf1a04723b58cdb358e377632a (diff) | |
| download | git-30a52c1dcbb286214a0d59fb4b3df1d13d9d060d.tar.gz | |
Merge branch 'ms/submodule-update-config-doc' into maint
The interaction between "git submodule update" and the
submodule.*.update configuration was not clearly documented.
* ms/submodule-update-config-doc:
submodule: improve documentation of update subcommand
Diffstat (limited to 'Documentation/config.txt')
| -rw-r--r-- | Documentation/config.txt | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/Documentation/config.txt b/Documentation/config.txt index 9307c98aab..5fbe9403b8 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -2408,12 +2408,16 @@ status.submodulesummary:: submodule.<name>.path:: submodule.<name>.url:: + The path within this project and URL for a submodule. These + variables are initially populated by 'git submodule init'. See + linkgit:git-submodule[1] and linkgit:gitmodules[5] for + details. + submodule.<name>.update:: - The path within this project, URL, and the updating strategy - for a submodule. These variables are initially populated - by 'git submodule init'; edit them to override the - URL and other values found in the `.gitmodules` file. See - linkgit:git-submodule[1] and linkgit:gitmodules[5] for details. + The default update procedure for a submodule. This variable + is populated by `git submodule init` from the + linkgit:gitmodules[5] file. See description of 'update' + command in linkgit:git-submodule[1]. submodule.<name>.branch:: The remote branch name for a submodule, used by `git submodule |