From f7c413b58818f100ff80b69e65c798454775e6c6 Mon Sep 17 00:00:00 2001 From: Yoichi NAKAYAMA Date: Sat, 8 Aug 2026 13:17:11 +0900 Subject: [PATCH] worktree add: improve message for ambiguous remote branch name When the user runs 'git worktree add ../foo-dir bar-topic' command that does not exactly say which remote they want to work with, and there is no local branch named bar-topic, we try to guess which remote by passing bar-topic then create a new branch named bar-topic which tracks the remote branch. If there are multiple remotes that have branch named bar-topic, we silently gave up, leaving the variable 'branch' intact. Then we entered the conditional clause 'if (!opts.orphan && !lookup_commit_reference_by_name(branch))' and triggered "invalid reference" error. This error message did not contain enough information to resolve the issue where the remote could not be guessed. To improve the situation, we display a hint and a descriptive error message and die immediately when multiple matching branches are found. Signed-off-by: Yoichi NAKAYAMA --- builtin/worktree.c | 23 ++++++++++++++++++++++- t/t2400-worktree-add.sh | 4 ++-- 2 files changed, 24 insertions(+), 3 deletions(-) diff --git a/builtin/worktree.c b/builtin/worktree.c index 654d27c3e1ce99..b29c3a3755c58e 100644 --- a/builtin/worktree.c +++ b/builtin/worktree.c @@ -64,6 +64,19 @@ "\n" \ " git worktree add --orphan %s\n") +#define WORKTREE_ADD_AMBIGUOUS_REMOTE_BRANCH_NAME_HINT_TEXT \ + _("Matched multiple remote tracking branches, you can list them by:\n" \ + "\n" \ + " git branch -r --list \"*/%s\"\n" \ + "\n" \ + "If you meant to create a worktree from a remote tracking branch on,\n" \ + "e.g. 'origin', you can do so by:\n" \ + "\n" \ + " git worktree add -b %s %s origin/%s\n" \ + "\n" \ + "If you'd like to always prefer some remote, e.g. 'origin',\n" \ + "consider setting checkout.defaultRemote=origin in your config.") + static const char * const git_worktree_usage[] = { BUILTIN_WORKTREE_ADD_USAGE, BUILTIN_WORKTREE_LIST_USAGE, @@ -904,10 +917,18 @@ static int add(int ac, const char **av, const char *prefix, commit = lookup_commit_reference_by_name(branch); if (!commit) { - remote = unique_tracking_name(branch, &oid, NULL); + int num_matches = 0; + remote = unique_tracking_name(branch, &oid, &num_matches); if (remote) { new_branch = branch; branch = new_branch_to_free = remote; + } else if (num_matches > 1) { + if (!opts.quiet) + advise_if_enabled(ADVICE_CHECKOUT_AMBIGUOUS_REMOTE_BRANCH_NAME, + WORKTREE_ADD_AMBIGUOUS_REMOTE_BRANCH_NAME_HINT_TEXT, + branch, branch, path, branch); + die(_("'%s' matched multiple (%d) remote tracking branches"), + branch, num_matches); } } diff --git a/t/t2400-worktree-add.sh b/t/t2400-worktree-add.sh index 87b926728ad8cf..5c105cf2529bfa 100755 --- a/t/t2400-worktree-add.sh +++ b/t/t2400-worktree-add.sh @@ -624,12 +624,12 @@ test_expect_success '"add" dwims' ' test_expect_success '"add" dwims with checkout.defaultRemote' ' test_when_finished rm -rf repo_upstream repo_dwim foo && setup_remote_repo repo_upstream repo_dwim && - git init repo_dwim && ( cd repo_dwim && git remote add repo_upstream2 ../repo_upstream && git fetch repo_upstream2 && - test_must_fail git worktree add ../foo foo && + test_must_fail git worktree add ../foo foo 2>error.actual && + test_grep "matched multiple (2) remote tracking branches" error.actual && git -c checkout.defaultRemote=repo_upstream worktree add ../foo foo && git status -uno --porcelain >status.actual && test_must_be_empty status.actual