aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/git-checkout.txt
diff options
context:
space:
mode:
authorRené Scharfe <l.s.r@web.de>2022-01-20 13:35:54 +0100
committerJunio C Hamano <gitster@pobox.com>2022-01-20 11:07:51 -0800
commit6327f0efed36c64d98a140110171362b7cb75a52 (patch)
tree7455b10e8451aa66bd6e2a11aee34986c64bce58 /Documentation/git-checkout.txt
parent15f002812f858b49ce7641eb191561843cf31f00 (diff)
downloadgit-6327f0efed36c64d98a140110171362b7cb75a52.tar.gz
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>
Diffstat (limited to 'Documentation/git-checkout.txt')
-rw-r--r--Documentation/git-checkout.txt2
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt
index 61825b060d..4353f1031b 100644
--- a/Documentation/git-checkout.txt
+++ b/Documentation/git-checkout.txt
@@ -156,7 +156,7 @@ of it").
linkgit:git-branch[1] for details.
-t::
---track [direct|inherit]::
+--track[=(direct|inherit)]::
When creating a new branch, set up "upstream" configuration. See
"--track" in linkgit:git-branch[1] for details.
+