git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH] fix: include the type flag in the cli docs

From
Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Date
Feb 28, 2022, 22:42 UTC
Message-ID
<220228.86a6ea38z9.gmgdl@evledraar.gmail.com>
In-Reply-To
<xmqqilt03xat.fsf@gitster.g>
On Sun, Feb 27 2022, Junio C Hamano wrote:
Show 55 quoted lines
> Bagas Sanjaya <bagasdotme@gmail.com> writes:
>
>> On 26/02/22 12.34, Matheus Felipe via GitGitGadget wrote:
>>> From: Matheus Felipe <matheusfelipeog@protonmail.com>
>>> When the `git config --global --help` command is invoked,
>>> the cli documentation is shown in the terminal with a small
>>> error in one of the values of the Type group, which is the
>>> absence of the type flag in the `--type` argument.
>>> This commit fixes that.
>>> 
>>
>> What about the commit message below?
>>
>> ```
>> The usage help for --type option of `git config` is missing `type`
>> in the argument placeholder (`<>`). Add it.
>> ```
>
> It is more concise, and at the same time points out the problem
> being addressed a lot more explicitly.  Much better.
>
>>> -	OPT_CALLBACK('t', "type", &type, "", N_("value is given this type"), option_parse_type),
>>> +	OPT_CALLBACK('t', "type", &type, N_("type"), N_("value is given this type"), option_parse_type),
>>
>>
>> The help should be `give the value the specified type`.
>
> I am not sure if this is much of an improvement.
>
>     $ git config --type=bool junk.flag 0
>     $ git config junk.flag
>     false
>
> uses the type information to turn "0" into "false" before it writes
> the value set to the variable to the file, while
>
>     $ git config junk.flag 0
>     $ git config junk.flag
>     0
>     $ git config --type=bool junk.flag
>     false
>
> shows that a stored value of "0" can be turned into "false" when
> showing.  "Give the value the specified type" does not capture the
> essense in either direction.
>
>     Before setting or showing, convert the value to its canonical
>     representation according to the given type.
>
> is what we want to convey, but it is quote a mouthful as-is.
>
> Saying "Assume the value is of this type" would strongly imply
> "Convert ... to its canonical reporesentation", and the current
> "value is given this type" may be a close enough and shorter
> approximation of it.  I dunno.
Perhaps:
	"coerce (on read and write) <value> to <type>"
or:
	"coerce (on read & write) <value> to <type>"
or:
	"coerce (on rw) <value> to <type>"
For the short help, depending on how verbose we'd like to be?

In any case a follow-up fix, just the "" to "type" being proposed here is orthagonal & looks good to me.

Previous: Junio C HamanoNext: Matheus Felipe
Message 4 of 9 in “fix: include the type flag in the cli docs”
  1. fix: include the type flag in the cli docsMatheus Felipe via GitGitGadget, Feb 26, 2022
  2. Bagas SanjayaFeb 27, 2022
  3. Junio C HamanoFeb 27, 2022
  4. Ævar Arnfjörð BjarmasonFeb 28, 2022
  5. Matheus FelipeMar 4, 2022
  6. fix: include the type flag in the cli docsMatheus Felipe via GitGitGadget, Mar 4, 2022
  7. Junio C HamanoMar 4, 2022
  8. Matheus FelipeMar 4, 2022
  9. config: correct "--type" option in "git config -h" outputMatheus Felipe via GitGitGadget, Mar 4, 2022

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.