v2 leaves "pathspec with wildcard" case alone. The behavior in this
case remains as before.
--no-guess is now made visible in "git checkout -h" and the man page.
PS. Based on git-checkout.txt I don't think any user can work out that
"git checkout branch --" can be used to disambiguate. And updating the
doc to show that makes it a lot uglier.
Perhaps it's time we add two new semi-aliases, switch-branch and
restore-path. They will have the same syntax as checkout in their
respective use case, without ambiguation. Semi-aliases because like
builtin commands, they cannot be overriden by user aliases.
Nguyễn Thái Ngọc Duy (1):
checkout: disambiguate dwim tracking branches and local files
Documentation/git-checkout.txt | 4 ++++
builtin/checkout.c | 18 +++++++++++++-----
t/t2024-checkout-dwim.sh | 31 +++++++++++++++++++++++++++++++
t/t9902-completion.sh | 3 ++-
4 files changed, 50 insertions(+), 6 deletions(-)
Range-diff against v1:
1: 530f5d8f03 ! 1: 0408fdde4d checkout: disambiguate dwim tracking branches and local files
@@ -21,12 +21,36 @@
We normally try to do the right thing, but when there are multiple
"right things" to do, it's best to leave it to the user to decide.
- Check this case, ask the user to use "--" to disambiguate.
+ Check this case, ask the user to to disambiguate:
+
+ - "git checkout -- foo" will check out path "foo"
+ - "git checkout foo --" will dwim and create branch "foo" [4]
+
+ For users who do not want dwim, use --no-guess. It's useless in this
+ particular case because "git checkout --no-guess foo --" will just
+ fail. But it could be used by scripts.
[1] 70c9ac2f19 (DWIM "git checkout frotz" to "git checkout -b frotz
origin/frotz" - 2009-10-18)
[2] https://public-inbox.org/git/CACsJy8B2TVr1g+k+eSQ=pBEO3WN4_LtgLo9gpur8X7Z9GOFL_A@xxxxxxxxxxxxxx/
[3] https://news.ycombinator.com/item?id=18230655
+ [4] a047fafc78 (checkout: allow dwim for branch creation for "git
+ checkout $branch --" - 2013-10-18)
+
+ diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt
+ --- a/Documentation/git-checkout.txt
+ +++ b/Documentation/git-checkout.txt
+@@
+ 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.
++
+ <branch>::
+ Branch to checkout; if it refers to a branch (i.e., a name that,
+ when prepended with "refs/heads/", is a valid ref), then that
diff --git a/builtin/checkout.c b/builtin/checkout.c
--- a/builtin/checkout.c
@@ -37,9 +61,11 @@
- if (!has_dash_dash &&
- (check_filename(opts->prefix, arg) || !no_wildcard(arg)))
-- recover_with_dwim = 0;
+ int could_be_checkout_paths = !has_dash_dash &&
-+ (check_filename(opts->prefix, arg) || !no_wildcard(arg));
++ check_filename(opts->prefix, arg);
++
++ if (!has_dash_dash && !no_wildcard(arg))
+ recover_with_dwim = 0;
+
/*
* Accept "git checkout foo" and "git checkout foo --"
@@ -50,10 +76,39 @@
if (remote) {
+ if (could_be_checkout_paths)
+ die(_("'%s' could be both a local file and a tracking branch.\n"
-+ "Please use -- to disambiguate"), arg);
++ "Please use -- (and optionally --no-guess) to disambiguate"),
++ arg);
*new_branch = arg;
arg = remote;
/* DWIMmed to create local branch, case (3).(b) */
+@@
+ struct checkout_opts opts;
+ struct branch_info new_branch_info;
+ char *conflict_style = NULL;
+- int dwim_new_local_branch = 1;
++ int dwim_new_local_branch, no_dwim_new_local_branch = 0;
+ int dwim_remotes_matched = 0;
+ struct option options[] = {
+ OPT__QUIET(&opts.quiet, N_("suppress progress reporting")),
+@@
+ OPT_BOOL('p', "patch", &opts.patch_mode, N_("select hunks interactively")),
+ OPT_BOOL(0, "ignore-skip-worktree-bits", &opts.ignore_skipworktree,
+ N_("do not limit pathspecs to sparse entries only")),
+- OPT_HIDDEN_BOOL(0, "guess", &dwim_new_local_branch,
+- N_("second guess 'git checkout <no-such-branch>'")),
++ OPT_BOOL(0, "no-guess", &no_dwim_new_local_branch,
++ N_("do not 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")),
+ { OPTION_CALLBACK, 0, "recurse-submodules", NULL,
+@@
+ argc = parse_options(argc, argv, prefix, options, checkout_usage,
+ PARSE_OPT_KEEP_DASHDASH);
+
++ dwim_new_local_branch = !no_dwim_new_local_branch;
+ if (opts.show_progress < 0) {
+ if (opts.quiet)
+ opts.show_progress = 0;
diff --git a/t/t2024-checkout-dwim.sh b/t/t2024-checkout-dwim.sh
--- a/t/t2024-checkout-dwim.sh
@@ -94,3 +149,17 @@
+'
+
test_done
+
+ diff --git a/t/t9902-completion.sh b/t/t9902-completion.sh
+ --- a/t/t9902-completion.sh
+ +++ b/t/t9902-completion.sh
+@@
+ --ignore-other-worktrees Z
+ --recurse-submodules Z
+ --progress Z
+- --no-quiet Z
++ --guess Z
++ --no-guess Z
+ --no-... Z
+ EOF
+ '
--
2.19.1.1318.g5295c6727d
