From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on dcvr.yhbt.net X-Spam-Level: X-Spam-ASN: AS31976 209.132.180.0/23 X-Spam-Status: No, score=-2.8 required=3.0 tests=AWL,BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,RCVD_IN_DNSWL_HI,T_RP_MATCHES_RCVD shortcircuit=no autolearn=no autolearn_force=no version=3.4.0 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by dcvr.yhbt.net (Postfix) with ESMTP id AE7371F404 for ; Tue, 20 Mar 2018 17:50:56 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751450AbeCTRuy (ORCPT ); Tue, 20 Mar 2018 13:50:54 -0400 Received: from mail-wm0-f66.google.com ([74.125.82.66]:55578 "EHLO mail-wm0-f66.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751330AbeCTRux (ORCPT ); Tue, 20 Mar 2018 13:50:53 -0400 Received: by mail-wm0-f66.google.com with SMTP id t7so5134283wmh.5 for ; Tue, 20 Mar 2018 10:50:52 -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; bh=99gViYOSH0QbD7HN44yzuq1BFrPWyj4jpYpjoLBPY50=; b=nK0bNN8bET9osLcSp3mP/CrxD7wFII7IVOPCZe2503n07yMi2+KRSYFvbmEfgRPot+ Fb9HgUYlwL+J33bR5EwzHIiSditj8lB/70APfiEBBNy5Cp/OYvgI0vMWO1Up/BbTosHz Yt03j0v6xI5wK9Iz2mSuj5qYuCq/mpkusvjYGaRsYYbqYY+6oFXBIBJF08bnKBFQpiuj DVeCz0E0wu2zkVWzDfUFluVhOEZEw+mt2Y+jX+XN4N5UQYuDdPTMJV8Bi2YzcpSGeEdx 3FjCfGTitT/oraNVbcYuNaGJ6NH6emTju9A6PTOIHeF2CsmW1d5M47uEtswhF0/fA/y+ E+Fg== 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; bh=99gViYOSH0QbD7HN44yzuq1BFrPWyj4jpYpjoLBPY50=; b=b1INwyl6bNw9i2YSRK6HRSBRxvH5S6Dtd+keEAQf4H1/iSSabZYmaC2aoJBjHXOdDM waqYfWdodsHmgL8vvmfCKN+9WrzcGkHEJr0nDxm1WDsusqwyRcOVatTfL5S3ITq/TCnD gKSgpJH8giFe7vBg8XCVNENhrS0+0wOOSsT02ishs5ks8b6pl2MISRsooKZIGOROMm6d aAwJEHZ+1+HlhnRdkZqZ3xDLZ3Uwt8MJtp1WxqfkjWDqHn4Jq7HA3LWqzWXj3wcPwP0q co9YOn9vkmR2Nr0i2MrKVaZ3qyyqAfdZFHtDu/PddWqCPzMTuDdpvPzP9WeNsYIxbUji 8RFA== X-Gm-Message-State: AElRT7HkfmuT8gwlOHI6fMrYmbEPiz9WuuhlAo9OHG2z2G1I9y+9yk8s uBo21LbXEn8Mk+g19g63A+izBbRJ X-Google-Smtp-Source: AG47ELttf+Ye8ZMm4TVHwtl/FoLbxEOjJ5TzYmppWJAdEiIxONzETrTrbDqz8NsJl2olD/DdDE/ImQ== X-Received: by 10.28.172.196 with SMTP id v187mr429734wme.69.1521568251877; Tue, 20 Mar 2018 10:50:51 -0700 (PDT) Received: from localhost.localdomain ([92.55.154.10]) by smtp.gmail.com with ESMTPSA id o12sm2265634wrf.93.2018.03.20.10.50.50 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 20 Mar 2018 10:50:51 -0700 (PDT) From: Paul-Sebastian Ungureanu To: git@vger.kernel.org Cc: Paul-Sebastian Ungureanu Subject: [GSoC][PATCH v6] parse-options: do not show usage upon invalid option value Date: Tue, 20 Mar 2018 19:50:05 +0200 Message-Id: <20180320175005.18759-1-ungureanupaulsebastian@gmail.com> X-Mailer: git-send-email 2.16.2.346.g16307f54f.dirty Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Usually, the usage should be shown only if the user does not know what options are available. If the user specifies an invalid value, the user is already aware of the available options. In this case, there is no point in displaying the usage anymore. This patch applies to "git tag --contains", "git branch --contains", "git branch --points-at", "git for-each-ref --contains" and many more. Signed-off-by: Paul-Sebastian Ungureanu --- builtin/blame.c | 1 + builtin/shortlog.c | 1 + builtin/update-index.c | 1 + parse-options.c | 20 ++++--- parse-options.h | 1 + t/t0040-parse-options.sh | 2 +- t/t0041-usage.sh | 107 ++++++++++++++++++++++++++++++++++ t/t3404-rebase-interactive.sh | 6 +- 8 files changed, 125 insertions(+), 14 deletions(-) create mode 100755 t/t0041-usage.sh diff --git a/builtin/blame.c b/builtin/blame.c index 9dcb367b9..e8c6a4d6a 100644 --- a/builtin/blame.c +++ b/builtin/blame.c @@ -729,6 +729,7 @@ int cmd_blame(int argc, const char **argv, const char *prefix) for (;;) { switch (parse_options_step(&ctx, options, blame_opt_usage)) { case PARSE_OPT_HELP: + case PARSE_OPT_ERROR: exit(129); case PARSE_OPT_DONE: if (ctx.argv[0]) diff --git a/builtin/shortlog.c b/builtin/shortlog.c index e29875b84..be4df6a03 100644 --- a/builtin/shortlog.c +++ b/builtin/shortlog.c @@ -283,6 +283,7 @@ int cmd_shortlog(int argc, const char **argv, const char *prefix) for (;;) { switch (parse_options_step(&ctx, options, shortlog_usage)) { case PARSE_OPT_HELP: + case PARSE_OPT_ERROR: exit(129); case PARSE_OPT_DONE: goto parse_done; diff --git a/builtin/update-index.c b/builtin/update-index.c index 58d1c2d28..34adf55a7 100644 --- a/builtin/update-index.c +++ b/builtin/update-index.c @@ -1059,6 +1059,7 @@ int cmd_update_index(int argc, const char **argv, const char *prefix) break; switch (parseopt_state) { case PARSE_OPT_HELP: + case PARSE_OPT_ERROR: exit(129); case PARSE_OPT_NON_OPTION: case PARSE_OPT_DONE: diff --git a/parse-options.c b/parse-options.c index d02eb8b01..47c09a82b 100644 --- a/parse-options.c +++ b/parse-options.c @@ -317,14 +317,16 @@ static int parse_long_opt(struct parse_opt_ctx_t *p, const char *arg, return get_value(p, options, all_opts, flags ^ opt_flags); } - if (ambiguous_option) - return error("Ambiguous option: %s " + if (ambiguous_option) { + error("Ambiguous option: %s " "(could be --%s%s or --%s%s)", arg, (ambiguous_flags & OPT_UNSET) ? "no-" : "", ambiguous_option->long_name, (abbrev_flags & OPT_UNSET) ? "no-" : "", abbrev_option->long_name); + return -3; + } if (abbrev_option) return get_value(p, abbrev_option, all_opts, abbrev_flags); return -2; @@ -434,7 +436,6 @@ int parse_options_step(struct parse_opt_ctx_t *ctx, const char * const usagestr[]) { int internal_help = !(ctx->flags & PARSE_OPT_NO_INTERNAL_HELP); - int err = 0; /* we must reset ->opt, unknown short option leave it dangling */ ctx->opt = NULL; @@ -459,7 +460,7 @@ int parse_options_step(struct parse_opt_ctx_t *ctx, ctx->opt = arg + 1; switch (parse_short_opt(ctx, options)) { case -1: - goto show_usage_error; + return PARSE_OPT_ERROR; case -2: if (ctx->opt) check_typos(arg + 1, options); @@ -472,7 +473,7 @@ int parse_options_step(struct parse_opt_ctx_t *ctx, while (ctx->opt) { switch (parse_short_opt(ctx, options)) { case -1: - goto show_usage_error; + return PARSE_OPT_ERROR; case -2: if (internal_help && *ctx->opt == 'h') goto show_usage; @@ -504,9 +505,11 @@ int parse_options_step(struct parse_opt_ctx_t *ctx, goto show_usage; switch (parse_long_opt(ctx, arg + 2, options)) { case -1: - goto show_usage_error; + return PARSE_OPT_ERROR; case -2: goto unknown; + case -3: + goto show_usage; } continue; unknown: @@ -517,10 +520,8 @@ int parse_options_step(struct parse_opt_ctx_t *ctx, } return PARSE_OPT_DONE; - show_usage_error: - err = 1; show_usage: - return usage_with_options_internal(ctx, usagestr, options, 0, err); + return usage_with_options_internal(ctx, usagestr, options, 0, 0); } int parse_options_end(struct parse_opt_ctx_t *ctx) @@ -539,6 +540,7 @@ int parse_options(int argc, const char **argv, const char *prefix, parse_options_start(&ctx, argc, argv, prefix, options, flags); switch (parse_options_step(&ctx, options, usagestr)) { case PARSE_OPT_HELP: + case PARSE_OPT_ERROR: exit(129); case PARSE_OPT_NON_OPTION: case PARSE_OPT_DONE: diff --git a/parse-options.h b/parse-options.h index af711227a..c77bb3b4f 100644 --- a/parse-options.h +++ b/parse-options.h @@ -188,6 +188,7 @@ enum { PARSE_OPT_HELP = -1, PARSE_OPT_DONE, PARSE_OPT_NON_OPTION, + PARSE_OPT_ERROR, PARSE_OPT_UNKNOWN }; diff --git a/t/t0040-parse-options.sh b/t/t0040-parse-options.sh index 0c2fc81d7..04d474c84 100755 --- a/t/t0040-parse-options.sh +++ b/t/t0040-parse-options.sh @@ -291,7 +291,7 @@ test_expect_success 'OPT_CALLBACK() and OPT_BIT() work' ' test_expect_success 'OPT_CALLBACK() and callback errors work' ' test_must_fail test-parse-options --no-length >output 2>output.err && test_i18ncmp expect output && - test_i18ncmp expect.err output.err + test_must_be_empty output.err ' cat >expect <<\EOF diff --git a/t/t0041-usage.sh b/t/t0041-usage.sh new file mode 100755 index 000000000..ac96bc3b9 --- /dev/null +++ b/t/t0041-usage.sh @@ -0,0 +1,107 @@ +#!/bin/sh + +test_description='Test commands behavior when given invalid argument value' + +. ./test-lib.sh + +test_expect_success 'setup ' ' + test_commit "v1.0" +' + +test_expect_success 'tag --contains ' ' + git tag --contains "v1.0" 1>actual 2>actual.err && + grep "v1.0" actual && + test_line_count = 0 actual.err +' + +test_expect_success 'tag --contains ' ' + test_must_fail git tag --contains "notag" 1>actual 2>actual.err && + test_line_count = 0 actual && + test_i18ngrep "error" actual.err && + test_must_fail test_i18ngrep "usage" actual.err +' + +test_expect_success 'tag --no-contains ' ' + git tag --no-contains "v1.0" 1>actual 2>actual.err && + test_line_count = 0 actual && + test_line_count = 0 actual.err +' + +test_expect_success 'tag --no-contains ' ' + test_must_fail git tag --no-contains "notag" 1>actual 2>actual.err && + test_line_count = 0 actual && + test_i18ngrep "error" actual.err && + test_must_fail test_i18ngrep "usage" actual.err +' + +test_expect_success 'tag usage error' ' + test_must_fail git tag --noopt 1>actual 2>actual.err && + test_line_count = 0 actual && + test_i18ngrep "usage" actual.err +' + +test_expect_success 'branch --contains ' ' + git branch --contains "master" 1>actual 2>actual.err && + test_i18ngrep "master" actual && + test_line_count = 0 actual.err +' + +test_expect_success 'branch --contains ' ' + test_must_fail git branch --no-contains "nocommit" 1>actual 2>actual.err && + test_line_count = 0 actual && + test_i18ngrep "error" actual.err && + test_must_fail test_i18ngrep "usage" actual.err +' + +test_expect_success 'branch --no-contains ' ' + git branch --no-contains "master" 1>actual 2>actual.err && + test_line_count = 0 actual && + test_line_count = 0 actual.err +' + +test_expect_success 'branch --no-contains ' ' + test_must_fail git branch --no-contains "nocommit" 1>actual 2>actual.err && + test_line_count = 0 actual && + test_i18ngrep "error" actual.err && + test_must_fail test_i18ngrep "usage" actual.err +' + +test_expect_success 'branch usage error' ' + test_must_fail git branch --noopt 1>actual 2>actual.err && + test_line_count = 0 actual && + test_i18ngrep "usage" actual.err +' + +test_expect_success 'for-each-ref --contains ' ' + git for-each-ref --contains "master" 1>actual 2>actual.err && + test_line_count = 2 actual && + test_line_count = 0 actual.err +' + +test_expect_success 'for-each-ref --contains ' ' + test_must_fail git for-each-ref --no-contains "noobject" 1>actual 2>actual.err && + test_line_count = 0 actual && + test_i18ngrep "error" actual.err && + test_must_fail test_i18ngrep "usage" actual.err +' + +test_expect_success 'for-each-ref --no-contains ' ' + git for-each-ref --no-contains "master" 1>actual 2>actual.err && + test_line_count = 0 actual && + test_line_count = 0 actual.err +' + +test_expect_success 'for-each-ref --no-contains ' ' + test_must_fail git for-each-ref --no-contains "noobject" 1>actual 2>actual.err && + test_line_count = 0 actual && + test_i18ngrep "error" actual.err && + test_must_fail test_i18ngrep "usage" actual.err +' + +test_expect_success 'for-each-ref usage error' ' + test_must_fail git for-each-ref --noopt 1>actual 2>actual.err && + test_line_count = 0 actual && + test_i18ngrep "usage" actual.err +' + +test_done diff --git a/t/t3404-rebase-interactive.sh b/t/t3404-rebase-interactive.sh index ef2887bd8..cac8b2bd8 100755 --- a/t/t3404-rebase-interactive.sh +++ b/t/t3404-rebase-interactive.sh @@ -919,10 +919,8 @@ test_expect_success 'rebase --exec works without -i ' ' test_expect_success 'rebase -i --exec without ' ' git reset --hard execute && set_fake_editor && - test_must_fail git rebase -i --exec 2>tmp && - sed -e "1d" tmp >actual && - test_must_fail git rebase -h >expected && - test_cmp expected actual && + test_must_fail git rebase -i --exec 2>actual && + test_i18ngrep "requires a value" actual && git checkout master ' -- 2.16.2.346.g16307f54f.dirty