From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-20.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,MENTIONS_GIT_HOSTING,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id A3192C433ED for ; Sat, 3 Apr 2021 12:49:24 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 6FACE611CE for ; Sat, 3 Apr 2021 12:49:24 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231800AbhDCMtH (ORCPT ); Sat, 3 Apr 2021 08:49:07 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:51420 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230409AbhDCMtG (ORCPT ); Sat, 3 Apr 2021 08:49:06 -0400 Received: from mail-lj1-x22f.google.com (mail-lj1-x22f.google.com [IPv6:2a00:1450:4864:20::22f]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 38E34C0613E6 for ; Sat, 3 Apr 2021 05:49:03 -0700 (PDT) Received: by mail-lj1-x22f.google.com with SMTP id f16so8113273ljm.1 for ; Sat, 03 Apr 2021 05:49:03 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=Dy33vA4L4oTS+UEzZ4bI/sY9S4nd4shFKD8UHUxfkf0=; b=RJieZx32Bo0u/8W+zTmrJJEWOcK/wJlvNpgUAjKrxZgvnSC0uLU72QovUmyuVKLe8G wLK/3arBy5sQqy8iGdQMkTziyz1c3Rls336QmZN3jWIGeGNG6Saa8YNP8Fdr9dRPIlIi EVPrekUCUxX6tuH+oYyK6OoPmHlsYjE1fmxDn9JpHac8JNQkHBcsrp1LXSGsEAc0Y6nl 1PGrcgItU+Pa6MWsOwQ0508/rmi+gpz0kUtnknOeToa2P39rf6ITIZedig2OTo3SDT8J h4uEUzcM2CrHg5dXgoH2BTrnpxD2XdsGSarhw7GpflaQIwFSsq0PXrr+wnw+9NFOAiNS vwwA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=Dy33vA4L4oTS+UEzZ4bI/sY9S4nd4shFKD8UHUxfkf0=; b=cBQCw8yED593pSS/LeA2N8xWH8/KefKuQOhC1Bwo7UXMjmSF0uYQudToaBH5CHJ3l6 5E2aT3368J1hblqNP+zEyg8gs/ov+zW0k4Mfq1/L/exhVbOnUtmZ/WUEU28ebIBvoPI0 gNI4ShUIPp1yCg3hnVBO333699bES4pCW+tuLEB9jhm5pS8mhwx24CsySdMl7MHDwPRu 9TZw65ZCncIFEIvLBS2qEnru4IlzEPsqStludWQAjV0EGyElBWNfzoEJ//PQm7nmz1Vg DdC3OY7OX17xWXH2+35UPApg8EfsDUGeASL1soSXcOOvvK1lSDm1kwBol6K7b6CSwZoz +KtA== X-Gm-Message-State: AOAM532oVdE9McC9zJ7duLGanEDDzNn2nITxTbUnSghoJnx8E1SPIyQR PZ3ahTUGgs16yYHHPPf7O1W4kyt3786+AEIr X-Google-Smtp-Source: ABdhPJy95xMfGYUkh2r1Sv/sQaZfsm2G/0RmE2WHZchPmuvf6UDYdPHzPcjmAScg7m/OswhhJOnEQA== X-Received: by 2002:a2e:b5cd:: with SMTP id g13mr11061542ljn.372.1617454139138; Sat, 03 Apr 2021 05:48:59 -0700 (PDT) Received: from localhost.localdomain (88-115-235-153.elisa-laajakaista.fi. [88.115.235.153]) by smtp.googlemail.com with ESMTPSA id t192sm1138393lff.295.2021.04.03.05.48.57 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 03 Apr 2021 05:48:58 -0700 (PDT) From: Stavros Ntentos X-Google-Original-From: Stavros Ntentos <133706+stdedos@users.noreply.github.com> To: git@vger.kernel.org Cc: stdedos+git@gmail.com, gitster@pobox.com, bagasdotme@gmail.com, peff@peff.net, Stavros Ntentos <133706+stdedos@users.noreply.github.com> Subject: [PATCH v3] pathspec: advice: long and short forms are incompatible Date: Sat, 3 Apr 2021 15:48:49 +0300 Message-Id: <20210403124849.21544-1-133706+stdedos@users.noreply.github.com> X-Mailer: git-send-email 2.31.1 In-Reply-To: References: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org It can be a "reasonable" mistake to mix short and long forms, e.g. `:!(glob)`, instead of the (correct) `:(exclude,glob)`. Teach git to issue an advice when such a pathspec is given. i.e.: While in short form parsing: * if the string contains an open parenthesis [`(`], and * without having explicitly terminated magic parsing (`:`) issue an advice hinting to that fact. Based on "Junio C Hamano "'s code suggestions: * https://lore.kernel.org/git/xmqqa6qoqw9n.fsf@gitster.g/ * https://lore.kernel.org/git/xmqqo8f0cr9z.fsf@gitster.g/ Signed-off-by: Stavros Ntentos <133706+stdedos@users.noreply.github.com> --- Documentation/config/advice.txt | 3 +++ advice.c | 3 +++ advice.h | 2 ++ pathspec.c | 33 ++++++++++++++++++++++++++++ t/t6132-pathspec-exclude.sh | 38 +++++++++++++++++++++++++++++++++ 5 files changed, 79 insertions(+) diff --git a/Documentation/config/advice.txt b/Documentation/config/advice.txt index acbd0c09aa..05a3cbc164 100644 --- a/Documentation/config/advice.txt +++ b/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 a/advice.c b/advice.c index 164742305f..f94505e0d6 100644 --- a/advice.c +++ b/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 } @@ -137,6 +139,7 @@ static struct { [ADVICE_STATUS_U_OPTION] = { "statusUoption", 1 }, [ADVICE_SUBMODULE_ALTERNATE_ERROR_STRATEGY_DIE] = { "submoduleAlternateErrorStrategyDie", 1 }, [ADVICE_WAITING_FOR_EDITOR] = { "waitingForEditor", 1 }, + [ADVICE_MIXED_PATHSPEC_MAGIC] = { "mixedPathspecMagic", 1 }, }; static const char turn_off_instructions[] = diff --git a/advice.h b/advice.h index bc2432980a..aa229fded8 100644 --- a/advice.h +++ b/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: @@ -72,6 +73,7 @@ extern int advice_add_empty_pathspec; ADVICE_STATUS_U_OPTION, ADVICE_SUBMODULE_ALTERNATE_ERROR_STRATEGY_DIE, ADVICE_WAITING_FOR_EDITOR, + ADVICE_MIXED_PATHSPEC_MAGIC, }; int git_default_advice_config(const char *var, const char *value); diff --git a/pathspec.c b/pathspec.c index 18b3be362a..5f77e2e8d8 100644 --- a/pathspec.c +++ b/pathspec.c @@ -336,6 +336,36 @@ 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, as well as possible corrections + */ +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_if_enabled(ADVICE_MIXED_PATHSPEC_MAGIC, + _("'%.*s(...': cannot mix short- and longform pathspec magic!\n" + "Either spell the shortform magic '%.*s' as ':(%s,...'\n" + "or end magic pathspec matching with '%.*s:'."), + (int)(pos - elem), elem, + (int)(pos - (elem + 1)), elem + 1, + longform.buf, + (int)(pos - elem), elem); +} + /* * Parse the pathspec element looking for short magic * @@ -356,6 +386,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; diff --git a/t/t6132-pathspec-exclude.sh b/t/t6132-pathspec-exclude.sh index 30328b87f0..8b9d543e1e 100755 --- a/t/t6132-pathspec-exclude.sh +++ b/t/t6132-pathspec-exclude.sh @@ -244,4 +244,42 @@ test_expect_success 'grep --untracked PATTERN :(exclude)*FILE' ' test_cmp expect-grep actual-grep ' +cat > expected_warn <<"EOF" +hint: ':!(...': cannot mix short- and longform pathspec magic! +hint: Either spell the shortform magic '!' as ':(exclude,...' +hint: or end magic pathspec matching with ':!:'. +hint: Disable this message with "git config advice.mixedPathspecMagic false" +EOF +test_expect_success 'warn pathspec not matching longform magic in :!(...)' ' + git log --oneline --format=%s -- '"'"':!(glob)**/file'"'"' >actual 2>warn && + cat <expect && +sub2/file +sub/sub/sub/file +sub/file2 +sub/sub/file +sub/file +file +EOF + cat actual && + cat warn && + test_cmp expect actual && + test_cmp expected_warn warn +' + +test_expect_success 'do not warn pathspec not matching longform magic in :!:(...) (i.e. if magic parsing is explicitly stopped)' ' + git log --oneline --format=%s -- '"'"':!:(glob)**/file'"'"' >actual 2>warn && + cat <expect && +sub2/file +sub/sub/sub/file +sub/file2 +sub/sub/file +sub/file +file +EOF + cat actual && + cat warn && + test_cmp expect actual && + ! test_cmp expected_warn warn +' + test_done -- 2.31.1