Similar to automatic detach, this behavior could be confusing because it can sometimes create a new branch without a user asking it to, especially when the user is still not aware about this feature. In the future, perhaps we could have a config key to disable these safety nets and let 'switch' do automatic detach or dwim again. But that will be opt-in after the user knows what is what. For now give a short option if you want to use it often. Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@xxxxxxxxx> --- Documentation/git-checkout.txt | 37 ++++++++++++++++++++-------------- builtin/checkout.c | 16 +++++++-------- 2 files changed, 30 insertions(+), 23 deletions(-) diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt index 31c6cbef19..bcb7822c27 100644 --- a/Documentation/git-checkout.txt +++ b/Documentation/git-checkout.txt @@ -31,22 +31,13 @@ branch. <branch>. + If <branch> is not found but there does exist a tracking branch in -exactly one remote (call it <remote>) with a matching name, treat as -equivalent to +exactly one remote (call it <remote>) with a matching name and +--no-guess is not specified, treat as equivalent to + ------------ $ git checkout -b <branch> --track <remote>/<branch> ------------ + -If the branch exists in multiple remotes and one of them is named by -the `checkout.defaultRemote` configuration variable, we'll use that -one for the purposes of disambiguation, even if the `<branch>` isn't -unique across all remotes. Set it to -e.g. `checkout.defaultRemote=origin` to always checkout remote -branches from there if `<branch>` is ambiguous but exists on the -'origin' remote. See also `checkout.defaultRemote` in -linkgit:git-config[1]. -+ You could omit <branch>, in which case the command degenerates to "check out the current branch", which is a glorified no-op with rather expensive side-effects to show only the tracking information, @@ -182,6 +173,26 @@ explicitly give a name with `-b` in such a case. Do not set up "upstream" configuration, even if the branch.autoSetupMerge configuration variable is true. +--[no-]guess:: + If <branch> is not found but there does exist a tracking + branch in exactly one remote (call it <remote>) with a + matching name, treat as equivalent to ++ +------------ +$ git checkout -b <branch> --track <remote>/<branch> +------------ ++ +If the branch exists in multiple remotes and one of them is named by +the `checkout.defaultRemote` configuration variable, we'll use that +one for the purposes of disambiguation, even if the `<branch>` isn't +unique across all remotes. Set it to +e.g. `checkout.defaultRemote=origin` to always checkout remote +branches from there if `<branch>` is ambiguous but exists on the +'origin' remote. See also `checkout.defaultRemote` in +linkgit:git-config[1]. ++ +Use `--no-guess` to disable this. + -l:: Create the new branch's reflog; see linkgit:git-branch[1] for details. @@ -284,10 +295,6 @@ Note that this option uses the no overlay mode by default (see also Just like linkgit:git-submodule[1], this will detach the submodules HEAD. ---no-guess:: - Do not attempt to create a branch if a remote tracking branch - of the same name exists. - --[no-]overlay:: In the default overlay mode, `git checkout` never removes files from the index or the working tree. When diff --git a/builtin/checkout.c b/builtin/checkout.c index a5284391a9..a49ab35b7d 100644 --- a/builtin/checkout.c +++ b/builtin/checkout.c @@ -52,7 +52,7 @@ struct checkout_opts { int show_progress; int count_checkout_paths; int overlay_mode; - int no_dwim_new_local_branch; + int dwim_new_local_branch; int accept_pathspec; int switch_branch_doing_nothing_is_ok; @@ -1388,8 +1388,6 @@ static struct option *add_common_switch_branch_options( OPT_BOOL_F(0, "overwrite-ignore", &opts->overwrite_ignore, N_("update ignored files (default)"), PARSE_OPT_NOCOMPLETE), - OPT_BOOL(0, "no-guess", &opts->no_dwim_new_local_branch, - N_("second guess 'git checkout <no-such-branch>'")), OPT_BOOL(0, "ignore-other-worktrees", &opts->ignore_other_worktrees, N_("do not check if another worktree is holding the given ref")), OPT_END() @@ -1426,7 +1424,6 @@ static int checkout_main(int argc, const char **argv, const char *prefix, { struct branch_info new_branch_info; int dwim_remotes_matched = 0; - int dwim_new_local_branch; memset(&new_branch_info, 0, sizeof(new_branch_info)); opts->overwrite_ignore = 1; @@ -1441,7 +1438,6 @@ static int checkout_main(int argc, const char **argv, const char *prefix, argc = parse_options(argc, argv, prefix, options, usagestr, PARSE_OPT_KEEP_DASHDASH); - dwim_new_local_branch = !opts->no_dwim_new_local_branch; if (opts->show_progress < 0) { if (opts->quiet) opts->show_progress = 0; @@ -1501,7 +1497,7 @@ static int checkout_main(int argc, const char **argv, const char *prefix, struct object_id rev; int dwim_ok = !opts->patch_mode && - dwim_new_local_branch && + opts->dwim_new_local_branch && opts->track == BRANCH_TRACK_UNSPECIFIED && !opts->new_branch; int n = parse_branchname_arg(argc, argv, dwim_ok, @@ -1582,12 +1578,14 @@ int cmd_checkout(int argc, const char **argv, const char *prefix) OPT_STRING('B', NULL, &opts.new_branch_force, N_("branch"), N_("create/reset and checkout a branch")), OPT_BOOL('l', NULL, &opts.new_branch_log, N_("create reflog for new branch")), + OPT_BOOL(0, "guess", &opts.dwim_new_local_branch, + N_("second guess 'git checkout <no-such-branch>' (default)")), OPT_END() }; int ret; memset(&opts, 0, sizeof(opts)); - opts.no_dwim_new_local_branch = 0; + opts.dwim_new_local_branch = 1; opts.switch_branch_doing_nothing_is_ok = 1; opts.accept_pathspec = 1; opts.implicit_detach = 1; @@ -1612,12 +1610,14 @@ int cmd_switch(int argc, const char **argv, const char *prefix) N_("create and switch to a new branch")), OPT_STRING('C', "force-create", &opts.new_branch_force, N_("branch"), N_("create/reset and switch to a branch")), + OPT_BOOL('g', "guess", &opts.dwim_new_local_branch, + N_("second guess 'git switch <no-such-branch>'")), OPT_END() }; int ret; memset(&opts, 0, sizeof(opts)); - opts.no_dwim_new_local_branch = 0; + opts.dwim_new_local_branch = 0; opts.accept_pathspec = 0; opts.switch_branch_doing_nothing_is_ok = 0; opts.implicit_detach = 0; -- 2.20.1.682.gd5861c6d90