submodule update: consistently document the '--checkout' option
authorJens Lehmann <Jens.Lehmann@web.de>
Fri, 28 Feb 2014 22:41:11 +0000 (22:41 +0000)
committerJunio C Hamano <gitster@pobox.com>
Fri, 28 Feb 2014 23:34:36 +0000 (15:34 -0800)
commit893a9764dc5e6d5d3432a47f595ffffade1edd9c
treebac92743bc8103255bbddf8f5c48911b0b134560
parent23d25e48f5ead73c9ce233986f90791abec9f1e8
submodule update: consistently document the '--checkout' option

Commit 322bb6e12f (add update 'none' flag to disable update of submodule
by default) added the '--checkout' option to "git submodule update" but
forgot to explicitly document it in synopsis, usage string and man page
(It is only mentioned implicitly in the man page). In 23d25e48 (submodule:
explicit local branch creation in module_clone) the synopsis of the man
page was updated, but the "OPTIONS" section of the man page and the usage
string of the git-submodule script still do not mention the '--checkout'
option.

Fix that by documenting this option in usage string and the "OPTIONS"
section of man page too. While at it group the update-mode options into
a single set in the usage string.

Reported-by: Matthijs Kooijman <matthijs@stdin.nl>
Signed-off-by: Jens Lehmann <Jens.Lehmann@web.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-submodule.txt
git-submodule.sh