Re: [PATCH 2/4] Documentation: list all type specifiers in config prose

From: Junio C Hamano <gitster@pobox.com>
Date: Mar 6, 2018, 07:40 UTC
Message-ID: <xmqqd10h7it8.fsf@gitster-ct.c.googlers.com>
In-Reply-To: <20180306065253.GC3522@sigill.intra.peff.net>

Jeff King <peff@peff.net> writes:

Show 9 quoted lines

>> +The type specifier can be either `--int` or `--bool`, to make 'git config'
>> +ensure that the variable(s) are of the given type and convert the value to the
>> +canonical form (simple decimal number for int, a "true" or "false" string for
>> +bool, either of for --bool-or-int), or `--path`, which does some path expansion
>> +(see `--path` below), or `--expiry-date` (see `--expiry-date` below).  If no
>> +type specifier is passed, no checks or transformations are performed on the
>> +value.
>
> Perhaps it's time to switch to a list format for these?

A very sensible suggestion. The original was already bad enough but with complete set, it does become quite hard to read. Perhaps along the lines of...

    A type specifier option can be used to force interpretation of
    values and conversion to canonical form.  Currently supported
    type specifiers are:

    `--int`::
            The value is taken as an integer.

    `--bool`::
            The value is taken as a yes/no value, and are shown as
            "true" or "false".

...