From: Denton Liu <liu.denton@gmail.com>
To: Git Mailing List <git@vger.kernel.org>
Cc: "Robert Dailey" <rcdailey.lists@gmail.com>,
"Jeff King" <peff@peff.net>,
"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>,
"Junio C Hamano" <gitster@pobox.com>
Subject: [PATCH v3 2/2] tag: advise on nested tags
Date: Thu, 4 Apr 2019 11:25:15 -0700 [thread overview]
Message-ID: <20190404182515.GA29754@dev-l> (raw)
In-Reply-To: <cover.1554183429.git.liu.denton@gmail.com>
Robert Dailey reported confusion on the mailing list about a nested tag
which was most likely created by mistake. Jeff King noted that this
isn't a very common case so, most likely, creating a tag-to-a-tag is a
user-error.
Prevent mistakes by providing advice on nested tags. Add tests to ensure
that advice is given for nested tags.
Reported-by: Robert Dailey <rcdailey.lists@gmail.com>
Helped-by: Jeff King <peff@peff.net>
Helped-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Denton Liu <liu.denton@gmail.com>
---
The advice message probably needs more work. Also, we currently only
warn on nested tags because I agree with what Peff said here[1], but I
don't really have any strong opinions on the matter so I'm open to
changing it.
[1]: https://public-inbox.org/git/20190404122722.GA23024@sigill.intra.peff.net/
Documentation/config/advice.txt | 2 ++
advice.c | 2 ++
advice.h | 1 +
builtin/tag.c | 14 ++++++++++++--
t/t7004-tag.sh | 11 +++++++++++
5 files changed, 28 insertions(+), 2 deletions(-)
diff --git a/Documentation/config/advice.txt b/Documentation/config/advice.txt
index 88620429ea..ec4f6ae658 100644
--- a/Documentation/config/advice.txt
+++ b/Documentation/config/advice.txt
@@ -90,4 +90,6 @@ advice.*::
waitingForEditor::
Print a message to the terminal whenever Git is waiting for
editor input from the user.
+ nestedTag::
+ Advice shown if a user attempts to recursively tag a tag object.
--
diff --git a/advice.c b/advice.c
index 567209aa79..ce5f374ecd 100644
--- a/advice.c
+++ b/advice.c
@@ -26,6 +26,7 @@ int advice_ignored_hook = 1;
int advice_waiting_for_editor = 1;
int advice_graft_file_deprecated = 1;
int advice_checkout_ambiguous_remote_branch_name = 1;
+int advice_nested_tag = 1;
static int advice_use_color = -1;
static char advice_colors[][COLOR_MAXLEN] = {
@@ -81,6 +82,7 @@ static struct {
{ "waitingForEditor", &advice_waiting_for_editor },
{ "graftFileDeprecated", &advice_graft_file_deprecated },
{ "checkoutAmbiguousRemoteBranchName", &advice_checkout_ambiguous_remote_branch_name },
+ { "nestedTag", &advice_nested_tag },
/* make this an alias for backward compatibility */
{ "pushNonFastForward", &advice_push_update_rejected }
diff --git a/advice.h b/advice.h
index f875f8cd8d..cb5d361614 100644
--- a/advice.h
+++ b/advice.h
@@ -26,6 +26,7 @@ extern int advice_ignored_hook;
extern int advice_waiting_for_editor;
extern int advice_graft_file_deprecated;
extern int advice_checkout_ambiguous_remote_branch_name;
+extern int advice_nested_tag;
int git_default_advice_config(const char *var, const char *value);
__attribute__((format (printf, 1, 2)))
diff --git a/builtin/tag.c b/builtin/tag.c
index faae364e0f..32948fade0 100644
--- a/builtin/tag.c
+++ b/builtin/tag.c
@@ -206,7 +206,14 @@ struct create_tag_options {
} cleanup_mode;
};
-static void create_tag(const struct object_id *object, const char *tag,
+static const char message_advice_nested_tag[] =
+ N_("You have created a nested tag. The object referred to by your new is\n"
+ "already a tag. If you meant to tag the object that it points to, use:\n"
+ "\n"
+ "\tgit tag -f %s %s^{}");
+
+static void create_tag(const struct object_id *object, const char *object_ref,
+ const char *tag,
struct strbuf *buf, struct create_tag_options *opt,
struct object_id *prev, struct object_id *result)
{
@@ -218,6 +225,9 @@ static void create_tag(const struct object_id *object, const char *tag,
if (type <= OBJ_NONE)
die(_("bad object type."));
+ if (type == OBJ_TAG && advice_nested_tag)
+ advise(_(message_advice_nested_tag), tag, object_ref);
+
strbuf_addf(&header,
"object %s\n"
"type %s\n"
@@ -551,7 +561,7 @@ int cmd_tag(int argc, const char **argv, const char *prefix)
if (create_tag_object) {
if (force_sign_annotate && !annotate)
opt.sign = 1;
- create_tag(&object, tag, &buf, &opt, &prev, &object);
+ create_tag(&object, object_ref, tag, &buf, &opt, &prev, &object);
}
transaction = ref_transaction_begin(&err);
diff --git a/t/t7004-tag.sh b/t/t7004-tag.sh
index 0b01862c23..34c130ba1c 100755
--- a/t/t7004-tag.sh
+++ b/t/t7004-tag.sh
@@ -1700,6 +1700,17 @@ test_expect_success '--points-at finds annotated tags of tags' '
test_cmp expect actual
'
+test_expect_success 'recursive tagging should give advice' '
+ cat <<-EOF >expected &&
+ hint: You have created a nested tag. The object referred to by your new is
+ hint: already a tag. If you meant to tag the object that it points to, use:
+ hint:
+ hint: git tag -f nested annotated-v4.0^{}
+ EOF
+ git tag -m nested nested annotated-v4.0 2>actual &&
+ test_i18ncmp expected actual
+'
+
test_expect_success 'multiple --points-at are OR-ed together' '
cat >expect <<-\EOF &&
v2.0
--
2.21.0.843.gd0ae0373aa
prev parent reply other threads:[~2019-04-04 18:25 UTC|newest]
Thread overview: 48+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-03-21 16:59 Strange annotated tag issue Robert Dailey
2019-03-21 19:04 ` Bryan Turner
2019-03-21 19:39 ` Jeff King
2019-03-21 19:29 ` Jeff King
2019-03-25 13:50 ` Robert Dailey
2019-03-25 14:49 ` Jeff King
2019-03-25 15:31 ` Robert Dailey
2019-03-25 18:43 ` Bryan Turner
2019-03-25 23:36 ` Jeff King
2019-03-25 19:19 ` Ævar Arnfjörð Bjarmason
2019-03-25 23:37 ` Jeff King
2019-03-26 7:53 ` [PATCH 0/3] tag: prevent recursive tags Denton Liu
2019-03-26 7:53 ` [PATCH 1/3] " Denton Liu
2019-03-26 8:51 ` Denton Liu
2019-03-26 10:10 ` Ævar Arnfjörð Bjarmason
2019-03-27 4:57 ` Elijah Newren
2019-03-27 10:27 ` Ævar Arnfjörð Bjarmason
2019-03-28 19:02 ` Robert Dailey
2019-03-26 7:53 ` [PATCH 2/3] t7004: ensure recursive tag behavior is working Denton Liu
2019-03-26 10:11 ` Ævar Arnfjörð Bjarmason
2019-03-26 7:53 ` [PATCH 3/3] git-tag.txt: document --allow-recursive-tag option Denton Liu
2019-03-26 10:16 ` Ævar Arnfjörð Bjarmason
2019-03-26 16:18 ` [PATCH 0/3] tag: prevent recursive tags Jeff King
2019-04-02 5:38 ` [PATCH v2 0/2] tag: prevent nested tags Denton Liu
2019-04-02 5:38 ` [PATCH v2 1/2] tag: fix formatting Denton Liu
2019-04-02 5:38 ` [PATCH v2 2/2] tag: prevent nested tags Denton Liu
2019-04-02 23:03 ` [PATCH v2.5 " Denton Liu
2019-04-03 7:32 ` Junio C Hamano
2019-04-03 8:49 ` Junio C Hamano
2019-04-03 18:26 ` Robert Dailey
2019-04-04 9:32 ` Junio C Hamano
2019-04-04 13:47 ` Robert Dailey
2019-04-04 21:50 ` Junio C Hamano
2019-04-05 2:51 ` Robert Dailey
2019-04-03 18:16 ` Johannes Sixt
2019-04-03 21:33 ` Denton Liu
2019-04-04 2:02 ` Jeff King
2019-04-04 9:31 ` Junio C Hamano
2019-04-04 12:27 ` Jeff King
2019-04-04 21:54 ` Junio C Hamano
2019-04-04 22:12 ` Jeff King
2019-04-11 18:40 ` Eckhard Maaß
2019-04-12 3:21 ` Junio C Hamano
2019-04-05 0:36 ` Elijah Newren
2019-04-05 5:29 ` Junio C Hamano
2019-04-04 18:25 ` [PATCH v3 0/2] tag: advise on recursive tagging Denton Liu
2019-04-04 18:25 ` [PATCH v3 1/2] tag: fix formatting Denton Liu
2019-04-04 18:25 ` Denton Liu [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190404182515.GA29754@dev-l \
--to=liu.denton@gmail.com \
--cc=avarab@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=peff@peff.net \
--cc=rcdailey.lists@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).