From: Taylor Blau <me@ttaylorr.com>
To: Eric Sunshine <sunshine@sunshineco.com>
Cc: "Git List" <git@vger.kernel.org>, "Jeff King" <peff@peff.net>,
"Junio C Hamano" <gitster@pobox.com>,
"René Scharfe" <l.s.r@web.de>,
--@vger.kernel.org
Subject: Re: [PATCH v3 2/2] builtin/config.c: prefer `--type=bool` over `--bool`, etc.
Date: Wed, 4 Apr 2018 18:47:58 -0700 [thread overview]
Message-ID: <20180405014758.GA4671@syl.local> (raw)
In-Reply-To: <CAPig+cR4uFiC_gFsb2e9JR6SdP-wUQVz-E0MjRHR=vNHd+hvhA@mail.gmail.com>
On Wed, Apr 04, 2018 at 03:27:48AM -0400, Eric Sunshine wrote:
> On Wed, Apr 4, 2018 at 2:07 AM, Taylor Blau <me@ttaylorr.com> wrote:
> > 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`.
>
> I always find this last sentence confusing since it's not clear to
> which ilk of "--color" option you refer. Perhaps say instead something
> like:
>
> This normalization will allow the aforementioned upcoming patch to
> support querying a color value with a default via "--type=color
> --default=...".
I agree that this is much clearer. I have amended this patch to include
your wording here.
> > Signed-off-by: Taylor Blau <me@ttaylorr.com>
> > ---
> > diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
> > @@ -160,30 +158,34 @@ See also <<FILES>>.
> > +--type [type]::
> > + 'git config' will ensure that any input output is valid under the given type
> > + constraint(s), and will canonicalize outgoing values in `[type]`'s canonical
> > + form.
>
> Do the brackets in "[type]" mean that the argument is optional? If so,
> what does 'type' default to when not specified? The documentation
> should discuss this.
This is my mistake; I was unaware of the semantic difference between '[]'
and '<>'. If my understanding is correct that '<>' means "required" and
'[]' means "optional", than this is a misspelling of "<type>".
I have addressed this during the re-roll.
> > diff --git a/builtin/config.c b/builtin/config.c
> > @@ -61,6 +61,33 @@ static int show_origin;
> > +static int option_parse_type(const struct option *opt, const char *arg,
> > + int unset)
> > +{
> > + [...]
> > + 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(_("unexpected --type argument, %s"), arg);
>
> "unexpected" doesn't seem like the best word choice since an argument
> to --type _is_ expected. Perhaps you mean "unrecognized"?
Sure; I think "unrecognized" is a much better fit. I have updated this
in the re-roll.
Thanks,
Taylor
next prev parent reply other threads:[~2018-04-05 1:48 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 [this message]
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=20180405014758.GA4671@syl.local \
--to=me@ttaylorr.com \
--cc=--@vger.kernel.org \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=l.s.r@web.de \
--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).