]> git.ipfire.org Git - thirdparty/git.git/commit - builtin/checkout.c
branch,checkout: fix --track documentation
authorRené Scharfe <l.s.r@web.de>
Thu, 20 Jan 2022 12:35:54 +0000 (13:35 +0100)
committerJunio C Hamano <gitster@pobox.com>
Thu, 20 Jan 2022 19:07:51 +0000 (11:07 -0800)
commit6327f0efed36c64d98a140110171362b7cb75a52
tree7455b10e8451aa66bd6e2a11aee34986c64bce58
parent15f002812f858b49ce7641eb191561843cf31f00
branch,checkout: fix --track documentation

Document that the accepted variants of the --track option are --track,
--track=direct, and --track=inherit.  The equal sign in the latter two
cannot be replaced with whitespace; in general optional arguments need
to be attached firmly to their option.

Put "direct" consistently before "inherit", if only for the reasons
that the former is the default, explained first in the documentation,
and comes before the latter alphabetically.

Mention both modes in the short help so that readers don't have to look
them up in the full documentation.  They are literal strings and thus
untranslatable.  PARSE_OPT_LITERAL_ARGHELP is inferred due to the pipe
and parenthesis characters, so we don't have to provide that flag
explicitly.

Mention that -t has the same effect as --track and --track=direct.
There is no way to specify inherit mode using the short option, because
short options generally don't accept optional arguments.

Signed-off-by: René Scharfe <l.s.r@web.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-branch.txt
Documentation/git-checkout.txt
builtin/branch.c
builtin/checkout.c