undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

switch: mention the --detach option when dying due to lack of a branch

Browse Source 
Users who are accustomed to doing `git checkout <tag>` assume that
`git switch <tag>` will do the same thing. Inform them of the --detach
option so they aren't left wondering why `git switch` doesn't work but
`git checkout` does.

Signed-off-by: Alex Henrie <alexhenrie24@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Alex Henrie 2022-02-25 23:12:13 -07:00 committed by Junio C Hamano
parent dab1b7905d
commit 808213ba36
5 changed files with 35 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Documentation/config/advice.txt
View File

@ -85,6 +85,9 @@ advice.*::
linkgit:git-switch[1] or linkgit:git-checkout[1] linkgit:git-switch[1] or linkgit:git-checkout[1]
to move to the detach HEAD state, to instruct how to to move to the detach HEAD state, to instruct how to
create a local branch after the fact. create a local branch after the fact.
suggestDetachingHead::
Advice shown when linkgit:git-switch[1] refuses to detach HEAD
without the explicit `--detach` option.
checkoutAmbiguousRemoteBranchName:: checkoutAmbiguousRemoteBranchName::
Advice shown when the argument to Advice shown when the argument to
linkgit:git-checkout[1] and linkgit:git-switch[1] linkgit:git-checkout[1] and linkgit:git-switch[1]

1
advice.c
View File

@ -42,6 +42,7 @@ static struct {
[ADVICE_CHECKOUT_AMBIGUOUS_REMOTE_BRANCH_NAME] = { "checkoutAmbiguousRemoteBranchName", 1 }, [ADVICE_CHECKOUT_AMBIGUOUS_REMOTE_BRANCH_NAME] = { "checkoutAmbiguousRemoteBranchName", 1 },
[ADVICE_COMMIT_BEFORE_MERGE] = { "commitBeforeMerge", 1 }, [ADVICE_COMMIT_BEFORE_MERGE] = { "commitBeforeMerge", 1 },
[ADVICE_DETACHED_HEAD] = { "detachedHead", 1 }, [ADVICE_DETACHED_HEAD] = { "detachedHead", 1 },
[ADVICE_SUGGEST_DETACHING_HEAD] = { "suggestDetachingHead", 1 },
[ADVICE_FETCH_SHOW_FORCED_UPDATES] = { "fetchShowForcedUpdates", 1 }, [ADVICE_FETCH_SHOW_FORCED_UPDATES] = { "fetchShowForcedUpdates", 1 },
[ADVICE_GRAFT_FILE_DEPRECATED] = { "graftFileDeprecated", 1 }, [ADVICE_GRAFT_FILE_DEPRECATED] = { "graftFileDeprecated", 1 },
[ADVICE_IGNORED_HOOK] = { "ignoredHook", 1 }, [ADVICE_IGNORED_HOOK] = { "ignoredHook", 1 },

1
advice.h
View File

@ -20,6 +20,7 @@ struct string_list;
ADVICE_CHECKOUT_AMBIGUOUS_REMOTE_BRANCH_NAME, ADVICE_CHECKOUT_AMBIGUOUS_REMOTE_BRANCH_NAME,
ADVICE_COMMIT_BEFORE_MERGE, ADVICE_COMMIT_BEFORE_MERGE,
ADVICE_DETACHED_HEAD, ADVICE_DETACHED_HEAD,
ADVICE_SUGGEST_DETACHING_HEAD,
ADVICE_FETCH_SHOW_FORCED_UPDATES, ADVICE_FETCH_SHOW_FORCED_UPDATES,
ADVICE_GRAFT_FILE_DEPRECATED, ADVICE_GRAFT_FILE_DEPRECATED,
ADVICE_IGNORED_HOOK, ADVICE_IGNORED_HOOK,

30
builtin/checkout.c
View File

@ -1397,23 +1397,31 @@ static void die_expecting_a_branch(const struct branch_info *branch_info)
{ {
struct object_id oid; struct object_id oid;
char *to_free; char *to_free;
int code;
if (dwim_ref(branch_info->name, strlen(branch_info->name), &oid, &to_free, 0) == 1) { if (dwim_ref(branch_info->name, strlen(branch_info->name), &oid, &to_free, 0) == 1) {
const char *ref = to_free; const char *ref = to_free;
if (skip_prefix(ref, "refs/tags/", &ref)) if (skip_prefix(ref, "refs/tags/", &ref))
die(_("a branch is expected, got tag '%s'"), ref); code = die_message(_("a branch is expected, got tag '%s'"), ref);
if (skip_prefix(ref, "refs/remotes/", &ref)) else if (skip_prefix(ref, "refs/remotes/", &ref))
die(_("a branch is expected, got remote branch '%s'"), ref); code = die_message(_("a branch is expected, got remote branch '%s'"), ref);
die(_("a branch is expected, got '%s'"), ref); else
code = die_message(_("a branch is expected, got '%s'"), ref);
} }
if (branch_info->commit) else if (branch_info->commit)
die(_("a branch is expected, got commit '%s'"), branch_info->name); code = die_message(_("a branch is expected, got commit '%s'"), branch_info->name);
/* else
* This case should never happen because we already die() on /*
* non-commit, but just in case. * This case should never happen because we already die() on
*/ * non-commit, but just in case.
die(_("a branch is expected, got '%s'"), branch_info->name); */
code = die_message(_("a branch is expected, got '%s'"), branch_info->name);
if (advice_enabled(ADVICE_SUGGEST_DETACHING_HEAD))
advise(_("If you want to detach HEAD at the commit, try again with the --detach option."));
exit(code);
} }
static void die_if_some_operation_in_progress(void) static void die_if_some_operation_in_progress(void)

11
t/t2060-switch.sh
View File

@ -32,6 +32,17 @@ test_expect_success 'switch and detach' '
test_must_fail git symbolic-ref HEAD test_must_fail git symbolic-ref HEAD
' '
test_expect_success 'suggestion to detach' '
test_must_fail git switch main^{commit} 2>stderr &&
grep "try again with the --detach option" stderr
'
test_expect_success 'suggestion to detach is suppressed with advice.suggestDetachingHead=false' '
test_config advice.suggestDetachingHead false &&
test_must_fail git switch main^{commit} 2>stderr &&
! grep "try again with the --detach option" stderr
'
test_expect_success 'switch and detach current branch' ' test_expect_success 'switch and detach current branch' '
test_when_finished git switch main && test_when_finished git switch main &&
git switch main && git switch main &&