diff options
| author |  Michal Sojka <sojkam1@fel.cvut.cz> | 2015-03-02 23:57:58 +0100 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2015-03-02 14:59:55 -0800 |
| commit | 5c31acfbe22cebdf1a04723b58cdb358e377632a (patch) | |
| tree | c3ddfa53d10dc06a0bccda6a9eae18dc0aa59b21 /Documentation/config.txt | |
| parent | Merge branch 'maint-1.9' into maint-2.0 (diff) | |
| download | tgif-5c31acfbe22cebdf1a04723b58cdb358e377632a.tar.xz | |
submodule: improve documentation of update subcommand
The documentation of 'git submodule update' has several problems:
1) It mentions that value 'none' of submodule.$name.update can be
overridden by --checkout, but other combinations of configuration
values and command line options are not mentioned.
2) The documentation of submodule.$name.update is scattered across three
places, which is confusing.
3) The documentation of submodule.$name.update in gitmodules.txt is
incorrect, because the code always uses the value from .git/config
and never from .gitmodules.
4) Documentation of --force was incomplete, because it is only effective
in case of checkout method of update.
Fix all these problems by documenting submodule.*.update in
git-submodule.txt and make everybody else refer to it.
Helped-by: Junio C Hamano <gitster@pobox.com>
Helped-by: Jens Lehmann <Jens.Lehmann@web.de>
Signed-off-by: Michal Sojka <sojkam1@fel.cvut.cz>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
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 c08286e968..1c0bae0052 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -2303,12 +2303,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 |