Merge branch 'js/branch-track-inherit'

"git branch -h" incorrectly said "--track[=direct|inherit]",
implying that "--trackinherit" is a valid option, which has been
corrected.
source: <3de40324bea6a1dd9bca2654721471e3809e87d8.1642538935.git.steadmon@google.com>
source: <c3c26192-aee9-185a-e559-b8735139e49c@web.de>

* js/branch-track-inherit:
  branch,checkout: fix --track documentation
This commit is contained in:
Junio C Hamano 2022-01-20 15:25:38 -08:00
commit 297ca895a2
4 changed files with 9 additions and 9 deletions

View file

@ -16,7 +16,7 @@ SYNOPSIS
[--points-at <object>] [--format=<format>] [--points-at <object>] [--format=<format>]
[(-r | --remotes) | (-a | --all)] [(-r | --remotes) | (-a | --all)]
[--list] [<pattern>...] [--list] [<pattern>...]
'git branch' [--track [direct|inherit] | --no-track] [-f] <branchname> [<start-point>] 'git branch' [--track[=(direct|inherit)] | --no-track] [-f] <branchname> [<start-point>]
'git branch' (--set-upstream-to=<upstream> | -u <upstream>) [<branchname>] 'git branch' (--set-upstream-to=<upstream> | -u <upstream>) [<branchname>]
'git branch' --unset-upstream [<branchname>] 'git branch' --unset-upstream [<branchname>]
'git branch' (-m | -M) [<oldbranch>] <newbranch> 'git branch' (-m | -M) [<oldbranch>] <newbranch>
@ -206,7 +206,7 @@ This option is only applicable in non-verbose mode.
Display the full sha1s in the output listing rather than abbreviating them. Display the full sha1s in the output listing rather than abbreviating them.
-t:: -t::
--track [inherit|direct]:: --track[=(direct|inherit)]::
When creating a new branch, set up `branch.<name>.remote` and When creating a new branch, set up `branch.<name>.remote` and
`branch.<name>.merge` configuration entries to set "upstream" tracking `branch.<name>.merge` configuration entries to set "upstream" tracking
configuration for the new branch. This configuration for the new branch. This
@ -216,11 +216,11 @@ This option is only applicable in non-verbose mode.
upstream when the new branch is checked out. upstream when the new branch is checked out.
+ +
The exact upstream branch is chosen depending on the optional argument: The exact upstream branch is chosen depending on the optional argument:
`--track` or `--track direct` means to use the start-point branch itself as the `-t`, `--track`, or `--track=direct` means to use the start-point branch
upstream; `--track inherit` means to copy the upstream configuration of the itself as the upstream; `--track=inherit` means to copy the upstream
start-point branch. configuration of the start-point branch.
+ +
`--track direct` is the default when the start point is a remote-tracking branch. `--track=direct` is the default when the start point is a remote-tracking branch.
Set the branch.autoSetupMerge configuration variable to `false` if you Set the branch.autoSetupMerge configuration variable to `false` if you
want `git switch`, `git checkout` and `git branch` to always behave as if `--no-track` want `git switch`, `git checkout` and `git branch` to always behave as if `--no-track`
were given. Set it to `always` if you want this behavior when the were given. Set it to `always` if you want this behavior when the

View file

@ -156,7 +156,7 @@ of it").
linkgit:git-branch[1] for details. linkgit:git-branch[1] for details.
-t:: -t::
--track [direct|inherit]:: --track[=(direct|inherit)]::
When creating a new branch, set up "upstream" configuration. See When creating a new branch, set up "upstream" configuration. See
"--track" in linkgit:git-branch[1] for details. "--track" in linkgit:git-branch[1] for details.
+ +

View file

@ -638,7 +638,7 @@ int cmd_branch(int argc, const char **argv, const char *prefix)
OPT__VERBOSE(&filter.verbose, OPT__VERBOSE(&filter.verbose,
N_("show hash and subject, give twice for upstream branch")), N_("show hash and subject, give twice for upstream branch")),
OPT__QUIET(&quiet, N_("suppress informational messages")), OPT__QUIET(&quiet, N_("suppress informational messages")),
OPT_CALLBACK_F('t', "track", &track, N_("mode"), OPT_CALLBACK_F('t', "track", &track, "(direct|inherit)",
N_("set branch tracking configuration"), N_("set branch tracking configuration"),
PARSE_OPT_OPTARG, PARSE_OPT_OPTARG,
parse_opt_tracking_mode), parse_opt_tracking_mode),

View file

@ -1549,7 +1549,7 @@ static struct option *add_common_switch_branch_options(
{ {
struct option options[] = { struct option options[] = {
OPT_BOOL('d', "detach", &opts->force_detach, N_("detach HEAD at named commit")), OPT_BOOL('d', "detach", &opts->force_detach, N_("detach HEAD at named commit")),
OPT_CALLBACK_F('t', "track", &opts->track, N_("mode"), OPT_CALLBACK_F('t', "track", &opts->track, "(direct|inherit)",
N_("set branch tracking configuration"), N_("set branch tracking configuration"),
PARSE_OPT_OPTARG, PARSE_OPT_OPTARG,
parse_opt_tracking_mode), parse_opt_tracking_mode),