diff mbox series

[2/2] checkout: improve error messages for -b with extra argument

Message ID c5e797b8-4b80-f9fa-e746-95f7f39e74f8@web.de (mailing list archive)
State New, archived
Headers show
Series None | expand

Commit Message

René Scharfe May 24, 2020, 7:23 a.m. UTC
When we try to create a branch "foo" based on "origin/master" and give
git commit -b an extra unsupported argument "bar", it confusingly
reports:

   $ git checkout -b foo origin/master bar
   fatal: 'bar' is not a commit and a branch 'foo' cannot be created from it

   $ git checkout --track -b foo origin/master bar
   fatal: 'bar' is not a commit and a branch 'foo' cannot be created from it

That's wrong, because it very well understands that "origin/master" is
supposed to be the start point for the new branch and not "bar".  Check
if we got a commit and show more fitting messages in that case instead:

   $ git checkout -b foo origin/master bar
   fatal: Cannot update paths and switch to branch 'foo' at the same time.

   $ git checkout --track -b foo origin/master bar
   fatal: '--track' cannot be used with updating paths

Original-patch-by: Jeff King <peff@peff.net>
Signed-off-by: René Scharfe <l.s.r@web.de>
---
 builtin/checkout.c         | 2 +-
 t/t2018-checkout-branch.sh | 2 +-
 t/t2027-checkout-track.sh  | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

--
2.26.2

Comments

Jeff King May 27, 2020, 6:42 a.m. UTC | #1
On Sun, May 24, 2020 at 09:23:00AM +0200, René Scharfe wrote:

> When we try to create a branch "foo" based on "origin/master" and give
> git commit -b an extra unsupported argument "bar", it confusingly
> reports:
> 
>    $ git checkout -b foo origin/master bar
>    fatal: 'bar' is not a commit and a branch 'foo' cannot be created from it
> 
>    $ git checkout --track -b foo origin/master bar
>    fatal: 'bar' is not a commit and a branch 'foo' cannot be created from it
> 
> That's wrong, because it very well understands that "origin/master" is
> supposed to be the start point for the new branch and not "bar".  Check
> if we got a commit and show more fitting messages in that case instead:
> 
>    $ git checkout -b foo origin/master bar
>    fatal: Cannot update paths and switch to branch 'foo' at the same time.
> 
>    $ git checkout --track -b foo origin/master bar
>    fatal: '--track' cannot be used with updating paths

Well explained.

> Original-patch-by: Jeff King <peff@peff.net>

If you want to count my hackery as a patch, sure...:)

> diff --git a/builtin/checkout.c b/builtin/checkout.c
> index e9d111bb83..24336e1017 100644
> --- a/builtin/checkout.c
> +++ b/builtin/checkout.c
> @@ -1689,7 +1689,7 @@ static int checkout_main(int argc, const char **argv, const char *prefix,
>  		 * Try to give more helpful suggestion.
>  		 * new_branch && argc > 1 will be caught later.
>  		 */
> -		if (opts->new_branch && argc == 1)
> +		if (opts->new_branch && argc == 1 && !new_branch_info.commit)
>  			die(_("'%s' is not a commit and a branch '%s' cannot be created from it"),
>  				argv[0], opts->new_branch);

And the fix itself looks obviously correct. We fall through to the other
error clauses, which you can't really see in the context, but your tests
verify it.

Thanks.

-Peff
diff mbox series

Patch

diff --git a/builtin/checkout.c b/builtin/checkout.c
index e9d111bb83..24336e1017 100644
--- a/builtin/checkout.c
+++ b/builtin/checkout.c
@@ -1689,7 +1689,7 @@  static int checkout_main(int argc, const char **argv, const char *prefix,
 		 * Try to give more helpful suggestion.
 		 * new_branch && argc > 1 will be caught later.
 		 */
-		if (opts->new_branch && argc == 1)
+		if (opts->new_branch && argc == 1 && !new_branch_info.commit)
 			die(_("'%s' is not a commit and a branch '%s' cannot be created from it"),
 				argv[0], opts->new_branch);

diff --git a/t/t2018-checkout-branch.sh b/t/t2018-checkout-branch.sh
index d99b699396..5b8c042997 100755
--- a/t/t2018-checkout-branch.sh
+++ b/t/t2018-checkout-branch.sh
@@ -265,7 +265,7 @@  test_expect_success 'checkout -b rejects an invalid start point' '
 	test_i18ngrep "is not a commit" err
 '

-test_expect_failure 'checkout -b rejects an extra path argument' '
+test_expect_success 'checkout -b rejects an extra path argument' '
 	test_must_fail git checkout -b branch4 branch1 file1 2>err &&
 	test_i18ngrep "Cannot update paths and switch to branch" err
 '
diff --git a/t/t2027-checkout-track.sh b/t/t2027-checkout-track.sh
index d0b41d7cd0..bcba1bf90c 100755
--- a/t/t2027-checkout-track.sh
+++ b/t/t2027-checkout-track.sh
@@ -16,7 +16,7 @@  test_expect_success 'checkout --track -b creates a new tracking branch' '
 	test $(git config --get branch.branch1.merge) = refs/heads/master
 '

-test_expect_failure 'checkout --track -b rejects an extra path argument' '
+test_expect_success 'checkout --track -b rejects an extra path argument' '
 	test_must_fail git checkout --track -b branch2 master one.t 2>err &&
 	test_i18ngrep "cannot be used with updating paths" err
 '