From: Taylor Blau <me@ttaylorr.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: Taylor Blau <me@ttaylorr.com>,
git@vger.kernel.org, sunshine@sunshineco.com, peff@peff.net
Subject: Re: [PATCH v8 0/2] builtin/config.c: support `--type=<type>` as preferred alias for `--type`
Date: Tue, 10 Apr 2018 18:33:09 -0700 [thread overview]
Message-ID: <20180411013309.GA36066@syl.local> (raw)
In-Reply-To: <xmqqtvsizg9u.fsf@gitster-ct.c.googlers.com>
On Wed, Apr 11, 2018 at 10:24:45AM +0900, Junio C Hamano wrote:
> Taylor Blau <me@ttaylorr.com> writes:
>
> > Attached is the eighth re-roll of my series to add `--type=<type>` as
> > the preferred alternative for `--<type>`.
> >
> > The main changes since v7 concern handling degenerate cases, such as:
> >
> > * git config --type=int --type=bool
> > * git config --type=int --int
> >
> > We have previously had discussion about whether we should (1) retain the
> > error in previous versions when confronted with multiple, conflicting
> > type specifiers, (2) ignore the error, in favor of making --<type> and
> > --type=<type> true synonyms, or (3) some combination of the two.
> >
> > I have thought some more about my argument that it would be favorable to
> > make "--type=int" and "--int" behave in the same way, and I am no
> > longer convinced that my argument makes sense. It's based on the premise
> > that "--type=<type>" must _necessarily_ allow multiple invocations, such
> > as '--type=int --type=bool', and therefore "--int --bool" should be
> > updated to behave the same way.
> >
> > We are not constrained to this behavior, so in v8, I have taught Git the
> > following:
> >
> > 1. Allow multiple non-conflicting types, such as '--int --int',
> > '--type=int --int', and '--int --type=int'.
> >
> > 2. Disallow multiple conflicting types, such as '--int --bool',
> > '--type=int --bool', and '--int --type=bool'.
> >
> > 3. Allow conflicting types following --no-type, such as '--int
> > --no-type --bool', '--type=int --no-type --bool', and '--int
> > --no-type --type=bool'. Note that this does _not_ introduce options
> > such as '--no-int' and whatnot.
> >
> > This is accomplished by a new locally defined macro called
> > OPT_CALLBACK_VALUE, which allows us to reuse option_parse_type() to
> > handle --int as well, by sending it through as opt->defval.
> >
> > I think that the above is the best-of-all-worlds choice, but I am
> > curious to hear everyone else's thoughts. Thanks in advance for your
> > review.
>
> I too am curious. Personally I do not think your "last one wins"
> was necessarily bad--in fact it internally was consistent--I just
> thought that the log message did not justify the choice well. And I
> do not think the semantics defined by this one, "once you choose,
> stick to it, or explicitly clear the previous choice", is bad,
> either.
:-). If nothing else, I like that we retain more, stricter behavior from
previous versions.
> > diff --git a/builtin/config.c b/builtin/config.c
> > index 5c8952a17c..7184c09582 100644
> > --- a/builtin/config.c
> > +++ b/builtin/config.c
> > @@ -61,28 +61,53 @@ static int show_origin;
> > #define TYPE_PATH 4
> > #define TYPE_EXPIRY_DATE 5
> >
> > +#define OPT_CALLBACK_VALUE(s, l, h, f, i) \
> > + { OPTION_CALLBACK, (s), (l), NULL, NULL, (h), PARSE_OPT_NOARG | \
> > + PARSE_OPT_NONEG, (f), (i) }
> > +
> > +static struct option builtin_config_options[];
>
> OK. I am not sure if OPT_CALLBACK_VALUE() needs to take 'f', as you
> always pass the option_parse_type function to it.
That's fair. I left this in as an indication that something like this
_might_ want to make its way into parse-options.h as a general-purpose
utility, but was not yet ready to do so. Thus, I defined it inside
builtin/config.c.
> > static int option_parse_type(const struct option *opt, const char *arg,
> > int unset)
> > {
> > - int *type = opt->value;
> > -
> > if (unset) {
> > - *type = 0;
> > + type = 0;
> > return 0;
> > }
> >
> > - if (!strcmp(arg, "bool"))
> > - *type = TYPE_BOOL;
> > - else if (!strcmp(arg, "int"))
> > - *type = TYPE_INT;
> > - else if (!strcmp(arg, "bool-or-int"))
> > - *type = TYPE_BOOL_OR_INT;
> > - else if (!strcmp(arg, "path"))
> > - *type = TYPE_PATH;
> > - else if (!strcmp(arg, "expiry-date"))
> > - *type = TYPE_EXPIRY_DATE;
> > - else
> > - die(_("unrecognized --type argument, %s"), arg);
> > + /*
> > + * To support '--<type>' style flags, begin with new_type equal to
> > + * opt->defval.
> > + */
> > + int new_type = opt->defval;
> > + if (!new_type) {
> > + if (!strcmp(arg, "bool"))
> > + new_type = TYPE_BOOL;
> > + else if (!strcmp(arg, "int"))
> > + new_type = TYPE_INT;
> > + else if (!strcmp(arg, "bool-or-int"))
> > + new_type = TYPE_BOOL_OR_INT;
> > + else if (!strcmp(arg, "path"))
> > + new_type = TYPE_PATH;
> > + else if (!strcmp(arg, "expiry-date"))
> > + new_type = TYPE_EXPIRY_DATE;
> > + else
> > + die(_("unrecognized --type argument, %s"), arg);
> > + }
> > +
> > + if (type != 0 && type != new_type) {
> > + /*
> > + * Complain when there is a new type not equal to the old type.
> > + * This allows for combinations like '--int --type=int' and
> > + * '--type=int --type=int', but disallows ones like '--type=bool
> > + * --int' and '--type=bool
> > + * --type=int'.
> > + */
> > + error("only one type at a time.");
> > + usage_with_options(builtin_config_usage,
> > + builtin_config_options);
> > + }
> > + type = new_type;
>
> Does this rely on a file-scope global variable (type)?
I don't think it does. I think I had conflated the difference between
opt->value and opt->defval while amending this patch. What do you think of the
following (which removes reaching outside the function for "type")?
diff --git a/builtin/config.c b/builtin/config.c
index 7184c09582..53755ca461 100644
--- a/builtin/config.c
+++ b/builtin/config.c
@@ -61,8 +61,8 @@ static int show_origin;
#define TYPE_PATH 4
#define TYPE_EXPIRY_DATE 5
-#define OPT_CALLBACK_VALUE(s, l, h, f, i) \
- { OPTION_CALLBACK, (s), (l), NULL, NULL, (h), PARSE_OPT_NOARG | \
+#define OPT_CALLBACK_VALUE(s, l, v, h, f, i) \
+ { OPTION_CALLBACK, (s), (l), (v), NULL, (h), PARSE_OPT_NOARG | \
PARSE_OPT_NONEG, (f), (i) }
static struct option builtin_config_options[];
@@ -71,7 +71,7 @@ static int option_parse_type(const struct option *opt, const char *arg,
int unset)
{
if (unset) {
- type = 0;
+ *((int *) opt->value) = 0;
return 0;
}
@@ -95,7 +95,8 @@ static int option_parse_type(const struct option *opt, const char *arg,
die(_("unrecognized --type argument, %s"), arg);
}
- if (type != 0 && type != new_type) {
+ int *to_type = opt->value;
+ if (*to_type && *to_type != new_type) {
/*
* Complain when there is a new type not equal to the old type.
* This allows for combinations like '--int --type=int' and
@@ -107,7 +108,7 @@ static int option_parse_type(const struct option *opt, const char *arg,
usage_with_options(builtin_config_usage,
builtin_config_options);
}
- type = new_type;
+ *to_type = new_type;
return 0;
}
@@ -135,12 +136,12 @@ static struct option builtin_config_options[] = {
OPT_BIT(0, "get-color", &actions, N_("find the color configured: slot [default]"), ACTION_GET_COLOR),
OPT_BIT(0, "get-colorbool", &actions, N_("find the color setting: slot [stdout-is-tty]"), ACTION_GET_COLORBOOL),
OPT_GROUP(N_("Type")),
- OPT_CALLBACK('t', "type", NULL, "", N_("value is given this type"), option_parse_type),
- OPT_CALLBACK_VALUE(0, "bool", N_("value is \"true\" or \"false\""), option_parse_type, TYPE_BOOL),
- OPT_CALLBACK_VALUE(0, "int", N_("value is decimal number"), option_parse_type, TYPE_INT),
- OPT_CALLBACK_VALUE(0, "bool-or-int", N_("value is --bool or --int"), option_parse_type, TYPE_BOOL_OR_INT),
- OPT_CALLBACK_VALUE(0, "path", N_("value is a path (file or directory name)"), option_parse_type, TYPE_PATH),
- OPT_CALLBACK_VALUE(0, "expiry-date", N_("value is an expiry date"), option_parse_type, TYPE_EXPIRY_DATE),
+ OPT_CALLBACK('t', "type", &type, "", N_("value is given this type"), option_parse_type),
+ OPT_CALLBACK_VALUE(0, "bool", &type, N_("value is \"true\" or \"false\""), option_parse_type, TYPE_BOOL),
+ OPT_CALLBACK_VALUE(0, "int", &type, N_("value is decimal number"), option_parse_type, TYPE_INT),
+ OPT_CALLBACK_VALUE(0, "bool-or-int", &type, N_("value is --bool or --int"), option_parse_type, TYPE_BOOL_OR_INT),
+ OPT_CALLBACK_VALUE(0, "path", &type, N_("value is a path (file or directory name)"), option_parse_type, TYPE_PATH),
+ OPT_CALLBACK_VALUE(0, "expiry-date", &type, N_("value is an expiry date"), option_parse_type, TYPE_EXPIRY_DATE),
OPT_GROUP(N_("Other")),
OPT_BOOL('z', "null", &end_null, N_("terminate values with NUL byte")),
OPT_BOOL(0, "name-only", &omit_values, N_("show variable names only")),
Thanks,
Taylor
next prev parent reply other threads:[~2018-04-11 1:33 UTC|newest]
Thread overview: 60+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-03-28 23:47 [PATCH] builtin/config.c: prefer `--type=bool` over `--bool`, etc Taylor Blau
2018-03-29 20:18 ` Junio C Hamano
2018-03-29 22:11 ` Jeff King
2018-03-30 5:27 ` Taylor Blau
2018-03-30 13:53 ` Jeff King
2018-03-30 16:00 ` Junio C Hamano
2018-03-30 18:27 ` Jeff King
2018-03-30 5:28 ` [PATCH v2 1/2] builtin/config.c: treat type specifiers singularly Taylor Blau
2018-03-30 5:28 ` [PATCH v2 2/2] builtin/config.c: prefer `--type=bool` over `--bool`, etc Taylor Blau
2018-03-30 6:17 ` René Scharfe
2018-03-30 13:48 ` Jeff King
2018-03-30 13:41 ` [PATCH v2 1/2] builtin/config.c: treat type specifiers singularly Jeff King
2018-04-04 6:07 ` [PATCH v3 0/2] builtin/config.c: prefer `--type=bool` over `--bool`, etc Taylor Blau
2018-04-04 6:07 ` [PATCH v3 1/2] builtin/config.c: treat type specifiers singularly Taylor Blau
2018-04-04 7:57 ` Eric Sunshine
2018-04-05 1:53 ` Taylor Blau
2018-04-05 21:51 ` Jeff King
2018-04-04 6:07 ` [PATCH v3 2/2] builtin/config.c: prefer `--type=bool` over `--bool`, etc Taylor Blau
2018-04-04 7:27 ` Eric Sunshine
2018-04-05 1:47 ` Taylor Blau
2018-04-05 2:00 ` [PATCH v4 0/2] " Taylor Blau
2018-04-05 21:58 ` Jeff King
2018-04-05 22:15 ` Taylor Blau
[not found] ` <cover.1522893363.git.me@ttaylorr.com>
2018-04-05 2:00 ` [PATCH v4 1/2] builtin/config.c: treat type specifiers singularly Taylor Blau
2018-04-05 2:00 ` [PATCH v4 2/2] builtin/config.c: prefer `--type=bool` over `--bool`, etc Taylor Blau
2018-04-05 22:29 ` Eric Sunshine
2018-04-05 22:40 ` Jeff King
2018-04-06 5:19 ` Taylor Blau
2018-04-06 5:17 ` Taylor Blau
2018-04-05 2:02 ` Taylor Blau
2018-04-05 22:12 ` Jeff King
2018-04-05 22:15 ` Taylor Blau
2018-04-06 5:08 ` Taylor Blau
2018-04-06 6:38 ` [PATCH v6 0/2] builtin/config.c: support `--type=<type>` as preferred alias for `--type` Taylor Blau
[not found] ` <cover.1522996619.git.me@ttaylorr.com>
2018-04-06 6:39 ` [PATCH v6 1/2] builtin/config.c: treat type specifiers singularly Taylor Blau
2018-04-06 6:39 ` [PATCH v6 2/2] builtin/config.c: support `--type=<type>` as preferred alias for `--type` Taylor Blau
2018-04-06 7:04 ` Eric Sunshine
2018-04-07 0:39 ` Taylor Blau
2018-04-07 8:25 ` Eric Sunshine
2018-04-09 22:46 ` [PATCH v7 0/2] " Taylor Blau
2018-04-09 23:11 ` Eric Sunshine
[not found] ` <cover.1523313730.git.me@ttaylorr.com>
2018-04-09 22:46 ` [PATCH v7 1/2] builtin/config.c: treat type specifiers singularly Taylor Blau
2018-04-10 1:22 ` Junio C Hamano
2018-04-10 2:12 ` Taylor Blau
2018-04-10 4:13 ` Eric Sunshine
2018-04-09 22:46 ` [PATCH v7 2/2] builtin/config.c: support `--type=<type>` as preferred alias for `--type` Taylor Blau
2018-04-10 1:44 ` Junio C Hamano
2018-04-10 2:17 ` Taylor Blau
2018-04-11 1:06 ` [PATCH v8 0/2] " Taylor Blau
2018-04-11 1:24 ` Junio C Hamano
2018-04-11 1:33 ` Taylor Blau [this message]
2018-04-11 3:11 ` Junio C Hamano
2018-04-11 3:49 ` Taylor Blau
[not found] ` <cover.1523408336.git.me@ttaylorr.com>
2018-04-11 1:06 ` [PATCH v8 1/2] builtin/config.c: treat type specifiers singularly Taylor Blau
2018-04-11 1:07 ` [PATCH v8 2/2] builtin/config.c: support `--type=<type>` as preferred alias for `--type` Taylor Blau
2018-04-18 21:43 ` [PATCH v9 0/2] " Taylor Blau
[not found] ` <cover.1524087557.git.me@ttaylorr.com>
2018-04-18 21:43 ` [PATCH v9 1/2] builtin/config.c: treat type specifiers singularly Taylor Blau
2018-04-18 21:43 ` [PATCH v9 2/2] builtin/config.c: support `--type=<type>` as preferred alias for `--type` Taylor Blau
2018-04-19 2:47 ` Junio C Hamano
2018-04-19 3:01 ` Taylor Blau
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=20180411013309.GA36066@syl.local \
--to=me@ttaylorr.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=peff@peff.net \
--cc=sunshine@sunshineco.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).