From: Jeff King <peff@peff.net>
To: Taylor Blau <me@ttaylorr.com>
Cc: gitster@pobox.com, git@vger.kernel.org
Subject: Re: [PATCH] builtin/config.c: prefer `--type=bool` over `--bool`, etc.
Date: Thu, 29 Mar 2018 18:11:22 -0400 [thread overview]
Message-ID: <20180329221122.GL2939@sigill.intra.peff.net> (raw)
In-Reply-To: <20180328234719.595-1-me@ttaylorr.com>
On Wed, Mar 28, 2018 at 04:47:19PM -0700, Taylor Blau wrote:
> `git config` has long allowed the ability for callers to provide a 'type
> specifier', which instructs `git config` to (1) ensure that incoming
> values are satisfiable under that type, and (2) that outgoing values are
> canonicalized under that type.
>
> In another series, we propose to add extend this functionality with
> `--color` and `--default` to replace `--get-color`.
>
> However, we traditionally use `--color` to mean "colorize this output",
> instead of "this value should be treated as a color".
>
> Currently, `git config` does not support this kind of colorization, but
> we should be careful to avoid inhabiting this option too soon, so that
> `git config` can support `--color` (in the traditional sense) in the
> future, if that is desired.
>
> In this patch, we prefer `--type=[int|bool|bool-or-int|...]` over
> `--int`, `--bool`, and etc. This allows the aforementioned other patch
> to add `--color` (in the non-traditional sense) via `--type=color`,
> instead of `--color`.
Makes sense. I agree with promoting --type as the correct way going
forward, since it will grow new types, whereas we can stop adding
"--foo" aliases for "--type=foo".
> +Valid `[type]`'s include:
> ++
> +- 'bool': canonicalize values as either "true" or "false".
> +- 'int': canonicalize values as simple decimla numbers. An optional suffix of
> + 'k', 'm', or 'g' will cause the value to be multiplied by 1024, 1048576, or
> + 1073741824 prior to output.
> +- 'bool-or-int': canonicalize according to either 'bool' or 'int', as described
> + above.
> +- 'path': canonicalize by adding a leading `~` to the value of `$HOME` and
> + `~user` to the home directory for the specified user. This specifier has no
> + effect when setting the value (but you can use `git config section.variable
> + ~/` from the command line to let your shell do the expansion.)
> +- 'expiry-date': canonicalize by converting from a fixed or relative ate-string
> + to a timestamp. This specifier has no effect when setting the value.
> ++
Yay. It's nice to have this in only one place now.
s/ate-string/d&/ :)
> +static int type_name_to_specifier(char *name)
> +{
> + if (!(strcmp(name, "bool")))
> + return TYPE_BOOL;
We'd usually drop the extra level of parentheses, and just write:
if (!strcmp(name, "bool"))
> @@ -601,6 +618,14 @@ int cmd_config(int argc, const char **argv, const char *prefix)
> usage_with_options(builtin_config_usage, builtin_config_options);
> }
>
> + if (type) {
> + if (types != 0) {
> + error("usage of --type is ambiguous");
> + usage_with_options(builtin_config_usage, builtin_config_options);
> + }
> + types = type_name_to_specifier(type);
> + }
This error message left me scratching my head for a minute. Ambiguous
how? I think this is covering the case of:
git config --int --type=bool
So maybe "--type cannot be used with other type options" or something?
Let's take a step back, though. As part of this, should we convert the
parsing of type options to last-one-wins? The fact that they are all
OPT_BIT() is quite silly, since you cannot have more than one bit set.
So if you do:
git config --int --bool
you get an error. Whereas normal behavior for most options would be for
--bool to override --int. And that is what happens with:
git config --type=int --type=bool
I don't think there are any backwards compatibility issues to deal with
here; we'd be changing a case which is now always an error.
And then after that, you truly can make (and document, if we want) that
"--int" is a true synonym for "--type=int".
I think it would be pretty simple. One of:
- convert OPT_BIT("bool") into OPT_CALLBACK("bool") and just assign
"bool" to the "type" string, which will then later get parsed into
TYPE_BOOL.
or
- convert OPT_BIT("bool") into OPT_SET_INT("bool") to set TYPE_BOOL
directly. Convert OPT_STRING("type") into OPT_CALLBACK(), and have
it assign the result of type_name_to_specifier() directly.
I'd probably do the latter, but would be fine with either (and I'd make
the OPT_SET_INT thing its own preparatory patch).
If you really want to go all-out, I think the ACTION flags could use the
same cleanup. We treat them as bitflags, and then issue an error when
you set more than one, which is just silly.
-Peff
next prev parent reply other threads:[~2018-03-29 22:11 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 [this message]
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
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=20180329221122.GL2939@sigill.intra.peff.net \
--to=peff@peff.net \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=me@ttaylorr.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).