Re: [PATCH v5 2/2] builtin/config.c: prefer `--type=bool` over `--bool`, etc.

From: Taylor Blau <me@ttaylorr.com>
Date: Apr 7, 2018, 01:00 UTC
Message-ID: <20180407010003.GE78042@syl.local>
In-Reply-To: <20180406145517.GB25041@sigill.intra.peff.net>

On Fri, Apr 06, 2018 at 10:55:18AM -0400, Jeff King wrote:

Show 18 quoted lines

> On Fri, Apr 06, 2018 at 02:14:34AM -0400, Eric Sunshine wrote:
>
> > > diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
> > > @@ -9,13 +9,13 @@ git-config - Get and set repository or global options
> > >  SYNOPSIS
> > >  --------
> > >  [verse]
> > > -'git config' [<file-option>] [type] [--show-origin] [-z|--null] name [value [value_regex]]
> > > +'git config' [<file-option>] [--type] [--show-origin] [-z|--null] name [value [value_regex]]
> >
> > It's pretty confusing to see bare "--type" like this which makes it
> > seem as if it doesn't take an argument at all. Better would be
> > "[--type=<type>]".
>
> In the interest of brevity, I actually think it could remain "[type]".
> IMHO the synopsis should be giving a summary and does not have to
> mention every detail (as long as it is not _inaccurate_, which I agree
> that "--type" is bordering on).

I think I am OK with the "non-brevity" of "[--type=<type>]", since "--type" alone does not make sense.

I agree that it would still be fairly clear even if that's the way that it did end up being typeset, but I prefer the accuracy of its current state.

That said, I am happy to bend towards any strong feelings about this topic, but for now I will leave it as-is.

Thanks, Taylor