From: Junio C Hamano <gitster@pobox.com>
To: Stavros Ntentos <stdedos@gmail.com>
Cc: git@vger.kernel.org, stdedos+git@gmail.com, bagasdotme@gmail.com,
peff@peff.net
Subject: Re: [PATCH v2] pathspec: advice: long and short forms are incompatible
Date: Tue, 30 Mar 2021 13:36:56 -0700 [thread overview]
Message-ID: <xmqqo8f0cr9z.fsf@gitster.g> (raw)
In-Reply-To: <20210330190517.21138-1-133706+stdedos@users.noreply.github.com> (Stavros Ntentos's message of "Tue, 30 Mar 2021 22:05:17 +0300")
Stavros Ntentos <stdedos@gmail.com> writes:
>> It may be more helpful if, rather than looking at what comes after
>> '(', we looked at what came before '(' and helped the user write
>> them out in the longform
>
> I don't see any explicit code in parsing the shortform magics, except:
> /* Special case alias for '!' */
> if (ch == '^') {
> *magic |= PATHSPEC_EXCLUDE;
> continue;
> }
> and therefore I would like to avoid such task (although I love well-written
> DWIMs-or-close-to-them).
I am not yet interested in doing DWIM, but a good advice is always
welcome.
Along the lines of the attached illustration patch, perhaps.
$ git show --oneline --stat -- ':/!(glob)**/*.txt'
hint: ':/!(...': cannot mix short- and longform pathspec magic
hint: instead, spell the shortform magic '/!' as 'top,exclude' inside :(...
Documentation/config/advice.txt | 3 +++
advice.c | 3 +++
advice.h | 2 ++
pathspec.c | 29 +++++++++++++++++++++++++++++
4 files changed, 37 insertions(+)
diff --git c/Documentation/config/advice.txt w/Documentation/config/advice.txt
index acbd0c09aa..05a3cbc164 100644
--- c/Documentation/config/advice.txt
+++ w/Documentation/config/advice.txt
@@ -119,4 +119,7 @@ advice.*::
addEmptyPathspec::
Advice shown if a user runs the add command without providing
the pathspec parameter.
+ mixedPathspecMagic::
+ Advice shown if a user tries to mix short- and
+ longform pathspec magic.
--
diff --git c/advice.c w/advice.c
index 164742305f..9426bc5295 100644
--- c/advice.c
+++ w/advice.c
@@ -33,6 +33,7 @@ int advice_checkout_ambiguous_remote_branch_name = 1;
int advice_submodule_alternate_error_strategy_die = 1;
int advice_add_ignored_file = 1;
int advice_add_empty_pathspec = 1;
+int advice_mixed_pathspec_magic = 1;
static int advice_use_color = -1;
static char advice_colors[][COLOR_MAXLEN] = {
@@ -95,6 +96,7 @@ static struct {
{ "submoduleAlternateErrorStrategyDie", &advice_submodule_alternate_error_strategy_die },
{ "addIgnoredFile", &advice_add_ignored_file },
{ "addEmptyPathspec", &advice_add_empty_pathspec },
+ { "mixedPathspecMagic", &advice_mixed_pathspec_magic },
/* make this an alias for backward compatibility */
{ "pushNonFastForward", &advice_push_update_rejected }
@@ -113,6 +115,7 @@ static struct {
[ADVICE_GRAFT_FILE_DEPRECATED] = { "graftFileDeprecated", 1 },
[ADVICE_IGNORED_HOOK] = { "ignoredHook", 1 },
[ADVICE_IMPLICIT_IDENTITY] = { "implicitIdentity", 1 },
+ [ADVICE_MIXED_PATHSPEC_MAGIC] = { "mixedPathspecMagic", 1 },
[ADVICE_NESTED_TAG] = { "nestedTag", 1 },
[ADVICE_OBJECT_NAME_WARNING] = { "objectNameWarning", 1 },
[ADVICE_PUSH_ALREADY_EXISTS] = { "pushAlreadyExists", 1 },
diff --git c/advice.h w/advice.h
index bc2432980a..d56c1896a0 100644
--- c/advice.h
+++ w/advice.h
@@ -33,6 +33,7 @@ extern int advice_checkout_ambiguous_remote_branch_name;
extern int advice_submodule_alternate_error_strategy_die;
extern int advice_add_ignored_file;
extern int advice_add_empty_pathspec;
+extern int advice_mixed_pathspec_magic;
/*
* To add a new advice, you need to:
@@ -51,6 +52,7 @@ extern int advice_add_empty_pathspec;
ADVICE_GRAFT_FILE_DEPRECATED,
ADVICE_IGNORED_HOOK,
ADVICE_IMPLICIT_IDENTITY,
+ ADVICE_MIXED_PATHSPEC_MAGIC,
ADVICE_NESTED_TAG,
ADVICE_OBJECT_NAME_WARNING,
ADVICE_PUSH_ALREADY_EXISTS,
diff --git c/pathspec.c w/pathspec.c
index 18b3be362a..ce9d1738a8 100644
--- c/pathspec.c
+++ w/pathspec.c
@@ -336,6 +336,32 @@ static const char *parse_long_magic(unsigned *magic, int *prefix_len,
return pos;
}
+/*
+ * Give hint for a common mistake of mixing short and long
+ * form of pathspec magic
+ */
+static void warn_mixed_magic(unsigned magic, const char *elem, const char *pos)
+{
+ struct strbuf longform = STRBUF_INIT;
+ int i;
+
+ if (!advice_enabled(ADVICE_MIXED_PATHSPEC_MAGIC))
+ return;
+ for (i = 0; i < ARRAY_SIZE(pathspec_magic); i++) {
+ if (pathspec_magic[i].bit & magic) {
+ if (longform.len)
+ strbuf_addch(&longform, ',');
+ strbuf_addstr(&longform, pathspec_magic[i].name);
+ }
+ }
+ advise(_("'%.*s(...': cannot mix short- and longform pathspec magic"),
+ (int)(pos - elem), elem);
+ advise(_("instead, spell the shortform magic '%.*s' as '%s' inside :(..."),
+ (int)(pos - (elem + 1)), elem + 1,
+ longform.buf);
+}
+
+
/*
* Parse the pathspec element looking for short magic
*
@@ -356,6 +382,9 @@ static const char *parse_short_magic(unsigned *magic, const char *elem)
continue;
}
+ if (ch == '(')
+ warn_mixed_magic(*magic, elem, pos);
+
if (!is_pathspec_magic(ch))
break;
next prev parent reply other threads:[~2021-03-30 20:37 UTC|newest]
Thread overview: 43+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-02-26 20:44 Pathspec does not accept / does not warn for specific pathspecs Σταύρος Ντέντος
2021-02-26 23:27 ` Junio C Hamano
2021-03-25 10:22 ` [PATCH v1 0/1] pathspec: warn for a no-glob entry that contains `**` Σταύρος Ντέντος
2021-03-25 10:22 ` [PATCH v1 1/1] " Σταύρος Ντέντος
2021-03-25 11:00 ` Bagas Sanjaya
2021-03-25 11:04 ` Bagas Sanjaya
2021-03-25 16:09 ` Stavros Ntentos
2021-03-25 20:09 ` Junio C Hamano
2021-03-25 23:36 ` [PATCH v2 0/1] " Σταύρος Ντέντος
2021-03-25 23:36 ` [PATCH v2 1/1] " Σταύρος Ντέντος
2021-03-26 0:41 ` Junio C Hamano
2021-03-26 1:32 ` Eric Sunshine
2021-03-26 3:02 ` Junio C Hamano
2021-03-26 5:13 ` Jeff King
2021-03-26 15:43 ` Stavros Ntentos
2021-03-26 15:48 ` [PATCH v3 1/2] " Stavros Ntentos
2021-03-26 15:48 ` [PATCH v3 2/2] pathspec: convert no-glob warn to advice Stavros Ntentos
2021-03-26 2:40 ` [RFC PATCH v1 0/1] pathspec: warn: long and short forms are incompatible Σταύρος Ντέντος
2021-03-26 2:40 ` [RFC PATCH v1 1/2] " Σταύρος Ντέντος
2021-03-26 5:28 ` Jeff King
2021-03-26 16:16 ` Stavros Ntentos
2021-03-27 9:41 ` Jeff King
2021-03-27 18:36 ` Junio C Hamano
2021-03-28 15:44 ` Stavros Ntentos
2021-03-26 2:40 ` [RFC PATCH v1 2/2] fixup! " Σταύρος Ντέντος
2021-03-26 8:14 ` Bagas Sanjaya
2021-03-26 15:55 ` Stavros Ntentos
2021-03-28 15:26 ` [RFC PATCH v1 3/3] squash! " Stavros Ntentos
2021-03-26 2:44 ` [RFC PATCH v1 0/1] " Σταύρος Ντέντος
2021-03-26 2:44 ` [RFC PATCH v1] " Σταύρος Ντέντος
2021-04-03 12:26 ` [PATCH v3] pathspec: advice: " Stavros Ntentos
2021-04-04 7:19 ` Junio C Hamano
2021-04-11 15:07 ` Σταύρος Ντέντος
2021-04-11 19:10 ` Junio C Hamano
2021-04-11 20:53 ` Σταύρος Ντέντος
2021-03-28 15:45 ` [PATCH v2] " Stavros Ntentos
2021-03-28 19:12 ` Junio C Hamano
2021-03-30 17:37 ` Junio C Hamano
2021-03-30 19:05 ` Stavros Ntentos
2021-03-30 19:17 ` Stavros Ntentos
2021-03-30 20:36 ` Junio C Hamano [this message]
2021-04-03 12:48 ` [PATCH v3] " Stavros Ntentos
2021-04-03 12:51 ` [PATCH v4] " Stavros Ntentos
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=xmqqo8f0cr9z.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=bagasdotme@gmail.com \
--cc=git@vger.kernel.org \
--cc=peff@peff.net \
--cc=stdedos+git@gmail.com \
--cc=stdedos@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).