Improve the error message added in f8aae12034 ("push: allow
unqualified dest refspecs to DWIM", 2008-04-23), which before this
change looks like this:
$ git push avar v2.19.0^{commit}:newbranch -n
error: unable to push to unqualified destination: newbranch
The destination refspec neither matches an existing ref on the remote nor
begins with refs/, and we are unable to guess a prefix based on the source ref.
error: failed to push some refs to 'git@xxxxxxxxxx:avar/git.git'
This message needed to be read very carefully to spot how to fix the
error, i.e. to push to refs/heads/newbranch, and it didn't use the
advice system (since initial addition of the error predated it).
Fix both of those, now the message will look like this instead:
$ ./git-push avar v2.19.0^{commit}:newbranch -n
error: unable to push to unqualified destination: newbranch
hint: The destination refspec neither matches an existing
hint: ref on the remote nor begins with refs/, and we are
hint: unable to guess a prefix based on the source ref.
hint:
hint: The <src> part of the refspec is a commit object.
hint: Did you mean to create a new branch by pushing to
hint: 'v2.19.0^{commit}:refs/heads/newbranch'?
error: failed to push some refs to 'git@xxxxxxxxxx:avar/git.git'
When trying to push a tag, tree or a blob we suggest that perhaps the
user meant to push them to refs/tags/ instead.
The if/else duplication for all of OBJ_{COMMIT,TAG,TREE,BLOB} is
unfortunate, but is required to correctly mark the messages for
translation.
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@xxxxxxxxx>
---
Documentation/config.txt | 7 +++++
advice.c | 2 ++
advice.h | 1 +
remote.c | 62 +++++++++++++++++++++++++++++++++++-----
t/t5505-remote.sh | 25 ++++++++++++++++
5 files changed, 90 insertions(+), 7 deletions(-)
diff --git a/Documentation/config.txt b/Documentation/config.txt
index 1546833213..fd455e2739 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -320,6 +320,13 @@ advice.*::
tries to overwrite a remote ref that points at an
object that is not a commit-ish, or make the remote
ref point at an object that is not a commit-ish.
+ pushAmbigiousRefName::
+ Shown when linkgit:git-push[1] gives up trying to
+ guess based on the source and destination refs what
+ remote ref namespace the source belongs in, but where
+ we can still suggest that the user push to either
+ refs/heads/* or refs/tags/* based on the type of the
+ source object.
statusHints::
Show directions on how to proceed from the current
state in the output of linkgit:git-status[1], in
diff --git a/advice.c b/advice.c
index 3561cd64e9..84e9d0168d 100644
--- a/advice.c
+++ b/advice.c
@@ -9,6 +9,7 @@ int advice_push_non_ff_matching = 1;
int advice_push_already_exists = 1;
int advice_push_fetch_first = 1;
int advice_push_needs_force = 1;
+int advice_push_ambiguous_ref_name = 1;
int advice_status_hints = 1;
int advice_status_u_option = 1;
int advice_commit_before_merge = 1;
@@ -62,6 +63,7 @@ static struct {
{ "pushAlreadyExists", &advice_push_already_exists },
{ "pushFetchFirst", &advice_push_fetch_first },
{ "pushNeedsForce", &advice_push_needs_force },
+ { "pushAmbigiousRefName", &advice_push_ambiguous_ref_name },
{ "statusHints", &advice_status_hints },
{ "statusUoption", &advice_status_u_option },
{ "commitBeforeMerge", &advice_commit_before_merge },
diff --git a/advice.h b/advice.h
index ab24df0fd0..d2445cab8b 100644
--- a/advice.h
+++ b/advice.h
@@ -9,6 +9,7 @@ extern int advice_push_non_ff_matching;
extern int advice_push_already_exists;
extern int advice_push_fetch_first;
extern int advice_push_needs_force;
+extern int advice_push_ambiguous_ref_name;
extern int advice_status_hints;
extern int advice_status_u_option;
extern int advice_commit_before_merge;
diff --git a/remote.c b/remote.c
index cc5553acc2..78fa2d9aff 100644
--- a/remote.c
+++ b/remote.c
@@ -13,6 +13,7 @@
#include "mergesort.h"
#include "argv-array.h"
#include "commit-reach.h"
+#include "advice.h"
enum map_direction { FROM_SRC, FROM_DST };
@@ -1046,13 +1047,60 @@ static int match_explicit(struct ref *src, struct ref *dst,
else if ((dst_guess = guess_ref(dst_value, matched_src))) {
matched_dst = make_linked_ref(dst_guess, dst_tail);
free(dst_guess);
- } else
- error(_("unable to push to unqualified destination: %s\n"
- "The destination refspec neither matches an "
- "existing ref on the remote nor\n"
- "begins with refs/, and we are unable to "
- "guess a prefix based on the source ref."),
- dst_value);
+ } else {
+ struct object_id oid;
+ enum object_type type;
+
+ error("unable to push to unqualified destination: %s", dst_value);
+ if (!advice_push_ambiguous_ref_name)
+ break;
+ if (get_oid(matched_src->name, &oid))
+ BUG("'%s' is not a valid object, "
+ "match_explicit_lhs() should catch this!",
+ matched_src->name);
+ type = oid_object_info(the_repository, &oid, NULL);
+ if (type == OBJ_COMMIT) {
+
+ advise(_("The destination refspec neither matches an existing\n"
+ "ref on the remote nor begins with refs/, and we are\n"
+ "unable to guess a prefix based on the source ref.\n"
+ "\n"
+ "The <src> part of the refspec is a commit object.\n"
+ "Did you mean to create a new branch by pushing to\n"
+ "'%s:refs/heads/%s'?"),
+ matched_src->name, dst_value);
+ } else if (type == OBJ_TAG) {
+ advise(_("The destination refspec neither matches an existing\n"
+ "ref on the remote nor begins with refs/, and we are\n"
+ "unable to guess a prefix based on the source ref.\n"
+ "\n"
+ "The <src> part of the refspec is a tag object.\n"
+ "Did you mean to create a new tag by pushing to\n"
+ "'%s:refs/tags/%s'?"),
+ matched_src->name, dst_value);
+ } else if (type == OBJ_TREE) {
+ advise(_("The destination refspec neither matches an existing\n"
+ "ref on the remote nor begins with refs/, and we are\n"
+ "unable to guess a prefix based on the source ref.\n"
+ "\n"
+ "The <src> part of the refspec is a tree object.\n"
+ "Did you mean to tag a new tree by pushing to\n"
+ "'%s:refs/tags/%s'?"),
+ matched_src->name, dst_value);
+ } else if (type == OBJ_BLOB) {
+ advise(_("The destination refspec neither matches an existing\n"
+ "ref on the remote nor begins with refs/, and we are\n"
+ "unable to guess a prefix based on the source ref.\n"
+ "\n"
+ "The <src> part of the refspec is a blob object.\n"
+ "Did you mean to tag a new blob by pushing to\n"
+ "'%s:refs/tags/%s'?"),
+ matched_src->name, dst_value);
+ } else {
+ BUG("'%s' should be commit/tag/tree/blob, is '%d'",
+ matched_src->name, type);
+ }
+ }
break;
default:
matched_dst = NULL;
diff --git a/t/t5505-remote.sh b/t/t5505-remote.sh
index d2a2cdd453..1eabf06aa4 100755
--- a/t/t5505-remote.sh
+++ b/t/t5505-remote.sh
@@ -1222,4 +1222,29 @@ test_expect_success 'add remote matching the "insteadOf" URL' '
git remote add backup xyz@xxxxxxxxxxx
'
+test_expect_success 'unqualified refspec DWIM and advice' '
+ test_when_finished "(cd test && git tag -d some-tag)" &&
+ (
+ cd test &&
+ git tag -a -m "Some tag" some-tag master &&
+ for type in commit tag tree blob
+ do
+ if test "$type" = "blob"
+ then
+ oid=$(git rev-parse some-tag:file)
+ else
+ oid=$(git rev-parse some-tag^{$type})
+ fi &&
+ test_must_fail git push origin $oid:dst -n 2>err &&
+ test_i18ngrep "error: unable to push" err &&
+ test_i18ngrep "hint: Did you mean" err &&
+ test_must_fail git -c advice.pushAmbigiousRefName=false \
+ push origin $oid:dst -n 2>err &&
+ test_i18ngrep "error: unable to push" err &&
+ test_i18ngrep ! "hint: Did you mean" err
+ done
+ )
+'
+
+
test_done
--
2.19.1.390.gf3a00b506f
