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

From: Jeff King <peff@peff.net>
Date: Apr 6, 2018, 14:55 UTC
Message-ID: <20180406145517.GB25041@sigill.intra.peff.net>
In-Reply-To: <CAPig+cSYuWReTFfnN8Wg2VGKcOk5SPHHWpTdW6yks67mkOjY0Q@mail.gmail.com>

On Fri, Apr 06, 2018 at 02:14:34AM -0400, Eric Sunshine wrote:

Show 11 quoted lines

> > 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).

-Peff