From: Duy Nguyen <pclouds@gmail.com> To: Junio C Hamano <gitster@pobox.com> Cc: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>, "Git Mailing List" <git@vger.kernel.org>, "Johannes Schindelin" <Johannes.Schindelin@gmx.de>, "Denton Liu" <liu.denton@gmail.com> Subject: Re: [PATCH v2] parse-options: don't emit "ambiguous option" for aliases Date: Thu, 18 Apr 2019 16:29:41 +0700 Message-ID: <20190418092940.GA13484@ash> (raw) In-Reply-To: <xmqq4l6wjfyw.fsf@gitster-ct.c.googlers.com> On Thu, Apr 18, 2019 at 09:48:39AM +0900, Junio C Hamano wrote: > > But on the other hand I can see it's a bit more work to teach > > parse-options OPT_ALIAS to say "--recursive is just an alias of > > --recurse-submodules" and chances of --recursive-hard coming up are > > probably very low. > > The "bit more work" is something that is worth doing in this case, I > think. I had a look at it. Linking two options together is not exactly easy because the way we organize option data. And I also had difficulty defining the exact semantics of this OPT_ALIAS. So an alternative is simply outsource the ambiguity decision back to git-clone. If the same situation appears again elsewhere, we'll need to sit back and fix it for real. But this way we don't potentially introduce any new traps. parse_options_extended() also makes it easier to extend parseopt functionality without changing all call sites. One thing I have in mind, which could maybe use this interface, is to remove parse_options_{start,step,end} from public API, avoid expose the parse_options_step internal result code. The caller just need to pass a callback to handle unknown options. -- 8< -- diff --git a/builtin/clone.c b/builtin/clone.c index 50bde99618..041cd43ddc 100644 --- a/builtin/clone.c +++ b/builtin/clone.c @@ -145,6 +145,29 @@ static struct option builtin_clone_options[] = { OPT_END() }; +/* + * Avoid ambiguation error between --recursive and --recurse-submodule + * because they are the same. --recurs can be expanded to any of them + * and it still works. + */ +static int is_abbrev_ambiguous(const struct option *prev, + const struct option *next) +{ + const struct option *opts[] = { prev, next }; + int i, found = 0; + + for (i = 0; i < ARRAY_SIZE(opts); i++) { + if (!opts[i]->long_name) + continue; + if (!strcmp(opts[i]->long_name, "recursive")) + found |= 1 << 0; + if (!strcmp(opts[i]->long_name, "recurse-submodules")) + found |= 1 << 1; + } + + return found != 3; +} + static const char *get_repo_path_1(struct strbuf *path, int *is_bundle) { static char *suffix[] = { "/.git", "", ".git/.git", ".git" }; @@ -905,14 +928,18 @@ int cmd_clone(int argc, const char **argv, const char *prefix) struct remote *remote; int err = 0, complete_refs_before_fetch = 1; int submodule_progress; + struct parseopt_options parseopts = { 0 }; struct argv_array ref_prefixes = ARGV_ARRAY_INIT; fetch_if_missing = 0; packet_trace_identity("clone"); - argc = parse_options(argc, argv, prefix, builtin_clone_options, - builtin_clone_usage, 0); + parseopts.usagestr = builtin_clone_usage; + parseopts.is_abbrev_ambiguous = is_abbrev_ambiguous; + argc = parse_options_extended(argc, argv, prefix, + builtin_clone_options, + &parseopts); if (argc > 2) usage_msg_opt(_("Too many arguments."), diff --git a/parse-options.c b/parse-options.c index cec74522e5..c0354e5a92 100644 --- a/parse-options.c +++ b/parse-options.c @@ -294,7 +294,8 @@ static enum parse_opt_result parse_long_opt( if (!(p->flags & PARSE_OPT_KEEP_UNKNOWN) && !strncmp(long_name, arg, arg_end - arg)) { is_abbreviated: - if (abbrev_option) { + if (abbrev_option && + p->is_abbrev_ambiguous(abbrev_option, options)) { /* * If this is abbreviated, it is * ambiguous. So when there is no @@ -450,6 +451,12 @@ static void parse_options_check(const struct option *opts) exit(128); } +static int abbrev_is_always_ambiguous(const struct option *prev, + const struct option *next) +{ + return 1; +} + void parse_options_start(struct parse_opt_ctx_t *ctx, int argc, const char **argv, const char *prefix, const struct option *options, int flags) @@ -466,6 +473,7 @@ void parse_options_start(struct parse_opt_ctx_t *ctx, ctx->prefix = prefix; ctx->cpidx = ((flags & PARSE_OPT_KEEP_ARGV0) != 0); ctx->flags = flags; + ctx->is_abbrev_ambiguous = abbrev_is_always_ambiguous; if ((flags & PARSE_OPT_KEEP_UNKNOWN) && (flags & PARSE_OPT_STOP_AT_NON_OPTION) && !(flags & PARSE_OPT_ONE_SHOT)) @@ -702,13 +710,17 @@ int parse_options_end(struct parse_opt_ctx_t *ctx) return ctx->cpidx + ctx->argc; } -int parse_options(int argc, const char **argv, const char *prefix, - const struct option *options, const char * const usagestr[], - int flags) +int parse_options_extended(int argc, const char **argv, const char *prefix, + const struct option *options, + const struct parseopt_options *parseopts) { struct parse_opt_ctx_t ctx; + const char * const * usagestr = parseopts->usagestr; + int flags = parseopts->flags; parse_options_start(&ctx, argc, argv, prefix, options, flags); + if (parseopts->is_abbrev_ambiguous) + ctx.is_abbrev_ambiguous = parseopts->is_abbrev_ambiguous; switch (parse_options_step(&ctx, options, usagestr)) { case PARSE_OPT_HELP: case PARSE_OPT_ERROR: @@ -734,6 +746,17 @@ int parse_options(int argc, const char **argv, const char *prefix, return parse_options_end(&ctx); } +int parse_options(int argc, const char **argv, const char *prefix, + const struct option *options, const char * const usagestr[], + int flags) +{ + struct parseopt_options parseopts = {0}; + + parseopts.flags = flags; + parseopts.usagestr = usagestr; + return parse_options_extended(argc, argv, prefix, options, &parseopts); +} + static int usage_argh(const struct option *opts, FILE *outfile) { const char *s; diff --git a/parse-options.h b/parse-options.h index 74cce4e7fc..31ebf4572c 100644 --- a/parse-options.h +++ b/parse-options.h @@ -198,6 +198,17 @@ int parse_options(int argc, const char **argv, const char *prefix, const struct option *options, const char * const usagestr[], int flags); +struct parseopt_options { + int flags; + const char * const * usagestr; + int (*is_abbrev_ambiguous)(const struct option *prev, + const struct option *next); +}; + +int parse_options_extended(int argc, const char **argv, const char *prefix, + const struct option *options, + const struct parseopt_options *parseopts); + NORETURN void usage_with_options(const char * const *usagestr, const struct option *options); @@ -256,6 +267,7 @@ struct parse_opt_ctx_t { const char *opt; int flags; const char *prefix; + int (*is_abbrev_ambiguous)(const struct option *, const struct option *); }; void parse_options_start(struct parse_opt_ctx_t *ctx, -- 8< -- > > Thanks.
next prev parent reply other threads:[~2019-04-18 9:29 UTC|newest] Thread overview: 52+ messages / expand[flat|nested] mbox.gz Atom feed top 2019-03-25 18:14 [PATCH 0/8] Do not use abbreviated options in tests Johannes Schindelin via GitGitGadget 2019-03-25 18:14 ` [PATCH 1/8] tests (rebase): spell out the `--keep-empty` option Johannes Schindelin via GitGitGadget 2019-03-25 18:14 ` [PATCH 3/8] t7810: do not abbreviate `--no-exclude-standard` nor `--invert-match` Johannes Schindelin via GitGitGadget 2019-03-25 18:14 ` [PATCH 2/8] tests (rebase): spell out the `--force-rebase` option Johannes Schindelin via GitGitGadget 2019-03-25 18:14 ` [PATCH 4/8] t5531: avoid using an abbreviated option Johannes Schindelin via GitGitGadget 2019-03-25 18:14 ` [PATCH 5/8] tests (push): do not abbreviate the `--follow-tags` option Johannes Schindelin via GitGitGadget 2019-03-25 18:14 ` [PATCH 6/8] tests (status): spell out the `--find-renames` option in full Johannes Schindelin via GitGitGadget 2019-03-25 18:14 ` [PATCH 7/8] tests (pack-objects): use the full, unabbreviated `--revs` option Johannes Schindelin via GitGitGadget 2019-03-25 18:14 ` [PATCH 8/8] tests: disallow the use of abbreviated options (by default) Johannes Schindelin via GitGitGadget 2019-03-25 18:35 ` Denton Liu 2019-03-25 20:26 ` Ævar Arnfjörð Bjarmason 2019-04-12 8:48 ` Johannes Schindelin 2019-04-12 8:50 ` Johannes Schindelin 2019-03-25 19:47 ` Ævar Arnfjörð Bjarmason 2019-04-12 8:59 ` Johannes Schindelin 2019-03-25 20:23 ` [PATCH 0/2] allow for configuring option abbreviation + fix Ævar Arnfjörð Bjarmason 2019-03-25 20:23 ` [PATCH 1/2] parse-options: allow for configuring option abbreviation Ævar Arnfjörð Bjarmason 2019-03-25 21:23 ` Eric Sunshine 2019-03-25 22:47 ` Ævar Arnfjörð Bjarmason 2019-03-26 4:14 ` Duy Nguyen 2019-03-26 6:28 ` Ævar Arnfjörð Bjarmason 2019-03-26 7:13 ` Duy Nguyen 2019-03-26 11:00 ` Ævar Arnfjörð Bjarmason 2019-04-01 10:47 ` Junio C Hamano 2019-04-12 9:06 ` Johannes Schindelin 2019-03-25 20:23 ` [PATCH 2/2] parse-options: don't emit "ambiguous option" for aliases Ævar Arnfjörð Bjarmason 2019-04-17 12:44 ` [PATCH v2] " Ævar Arnfjörð Bjarmason 2019-04-17 16:04 ` Duy Nguyen 2019-04-18 0:48 ` Junio C Hamano 2019-04-18 9:29 ` Duy Nguyen [this message] 2019-04-19 4:39 ` Junio C Hamano 2019-04-22 12:22 ` [PATCH] " Nguyễn Thái Ngọc Duy 2019-04-22 12:34 ` Duy Nguyen 2019-04-29 10:05 ` [PATCH v2] " Nguyễn Thái Ngọc Duy 2019-05-07 3:43 ` Junio C Hamano 2019-05-07 11:58 ` Duy Nguyen 2019-04-02 0:58 ` [PATCH 0/8] Do not use abbreviated options in tests Junio C Hamano 2019-04-12 9:37 ` [PATCH v2 " Johannes Schindelin via GitGitGadget 2019-04-12 9:37 ` [PATCH v2 1/8] tests (rebase): spell out the `--keep-empty` option Johannes Schindelin via GitGitGadget 2019-04-12 9:37 ` [PATCH v2 3/8] t7810: do not abbreviate `--no-exclude-standard` nor `--invert-match` Johannes Schindelin via GitGitGadget 2019-04-12 9:37 ` [PATCH v2 2/8] tests (rebase): spell out the `--force-rebase` option Johannes Schindelin via GitGitGadget 2019-04-12 9:37 ` [PATCH v2 4/8] t5531: avoid using an abbreviated option Johannes Schindelin via GitGitGadget 2019-04-12 9:37 ` [PATCH v2 5/8] tests (push): do not abbreviate the `--follow-tags` option Johannes Schindelin via GitGitGadget 2019-04-12 9:37 ` [PATCH v2 7/8] tests (pack-objects): use the full, unabbreviated `--revs` option Johannes Schindelin via GitGitGadget 2019-04-12 9:37 ` [PATCH v2 6/8] tests (status): spell out the `--find-renames` option in full Johannes Schindelin via GitGitGadget 2019-04-12 9:37 ` [PATCH v2 8/8] tests: disallow the use of abbreviated options (by default) Johannes Schindelin via GitGitGadget 2019-04-14 2:35 ` Junio C Hamano 2019-04-15 2:55 ` Junio C Hamano 2019-04-15 13:09 ` Johannes Schindelin 2019-04-15 13:45 ` Junio C Hamano 2019-04-17 12:07 ` Johannes Schindelin 2019-04-15 13:08 ` Johannes Schindelin
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=20190418092940.GA13484@ash \ --to=pclouds@gmail.com \ --cc=Johannes.Schindelin@gmx.de \ --cc=avarab@gmail.com \ --cc=git@vger.kernel.org \ --cc=gitster@pobox.com \ --cc=liu.denton@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
git@vger.kernel.org list mirror (unofficial, one of many) This inbox may be cloned and mirrored by anyone: git clone --mirror https://public-inbox.org/git git clone --mirror http://ou63pmih66umazou.onion/git git clone --mirror http://czquwvybam4bgbro.onion/git git clone --mirror http://hjrcffqmbrq6wope.onion/git # If you have public-inbox 1.1+ installed, you may # initialize and index your mirror using the following commands: public-inbox-init -V1 git git/ https://public-inbox.org/git \ git@vger.kernel.org public-inbox-index git Example config snippet for mirrors. Newsgroups are available over NNTP: nntp://news.public-inbox.org/inbox.comp.version-control.git nntp://ou63pmih66umazou.onion/inbox.comp.version-control.git nntp://czquwvybam4bgbro.onion/inbox.comp.version-control.git nntp://hjrcffqmbrq6wope.onion/inbox.comp.version-control.git nntp://news.gmane.io/gmane.comp.version-control.git note: .onion URLs require Tor: https://www.torproject.org/ code repositories for the project(s) associated with this inbox: https://80x24.org/mirrors/git.git AGPL code for this site: git clone https://public-inbox.org/public-inbox.git