]> rtime.felk.cvut.cz Git - git.git/commit
submodule: Fix documentation of update subcommand submodule-update-doc-fix
authorMichal Sojka <sojkam1@fel.cvut.cz>
Mon, 3 Nov 2014 09:59:35 +0000 (10:59 +0100)
committerMichal Sojka <sojkam1@fel.cvut.cz>
Wed, 18 Feb 2015 22:25:48 +0000 (23:25 +0100)
commitb3e4d0f3c59293163f0afb2320c8457e3c4f1522
tree40522f784690fc628a31f762b5a15c0f36f958ef
parent3188ab3af60df6ace996d3985e8f1ca1ed3cbda5
submodule: Fix documentation of update subcommand

The documentation of 'git submodule update' has several problems:

1) It says that submodule.$name.update can be overridden by --checkout
   only if its value is `none`. This is not true, because both
   implementation and documentation of --checkout specifies that the
   override applies to all possible values.

2) The documentation of submodule.$name.update key 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.

This patch fixes all three problems. Now, submodule.$name.update is
fully documented in config.txt and the other files just refer to it.
This is based on discussion between myself, Junio C Hamano and Jens
Lehmann.

Signed-off-by: Michal Sojka <sojkam1@fel.cvut.cz>
Documentation/config.txt
Documentation/git-submodule.txt
Documentation/gitmodules.txt