diff options
| author | Junio C Hamano <gitster@pobox.com> | 2015-03-06 15:02:31 -0800 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2015-03-06 15:02:31 -0800 |
| commit | a11c508d5619c696816d93da0b43a0fe7087dccc (patch) | |
| tree | 84857887652fa2afa7afdf96cc3f4c76de08dc88 /Documentation/config.txt | |
| parent | 83ac11fac4a71be40b6397763f685f49a39718be (diff) | |
| parent | 5c31acfbe22cebdf1a04723b58cdb358e377632a (diff) | |
| download | git-a11c508d5619c696816d93da0b43a0fe7087dccc.tar.gz git-a11c508d5619c696816d93da0b43a0fe7087dccc.tar.xz | |
Merge branch 'ms/submodule-update-config-doc'
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 3babf4af1..153025556 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -2417,12 +2417,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 |