]> git.ipfire.org Git - thirdparty/git.git/commit - Documentation/git-submodule.txt
submodule: improve documentation of update subcommand
authorMichal Sojka <sojkam1@fel.cvut.cz>
Mon, 2 Mar 2015 22:57:58 +0000 (23:57 +0100)
committerJunio C Hamano <gitster@pobox.com>
Mon, 2 Mar 2015 22:59:55 +0000 (14:59 -0800)
commit5c31acfbe22cebdf1a04723b58cdb358e377632a
treec3ddfa53d10dc06a0bccda6a9eae18dc0aa59b21
parent76f8611a5fb7e81c1bada0fb190d573a66fc03f6
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>
Documentation/config.txt
Documentation/git-submodule.txt
Documentation/gitmodules.txt