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

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

From
Junio C Hamano <gitster@pobox.com>
Date
Mar 4, 2022, 07:45 UTC
Message-ID
<xmqq8rtq2may.fsf@gitster.g>
In-Reply-To
<pull.1220.v2.git.git.1646368313714.gitgitgadget@gmail.com>
"Matheus Felipe via GitGitGadget" <gitgitgadget@gmail.com> writes:
> Subject: Re: [PATCH v2] fix: include the type flag in the cli docs

One more (hopefully final) nit. By reading the above alone (which is what people will see in "git shortlog --no-merges" output), you can not even guess which subcommand the "fix" is about, or if it is even a fix to the code, or just a documentation update.

I'd retitle it to
	config: correct "--type" option in "git config -h" output
> From: Matheus Felipe <matheusfelipeog@protonmail.com>
>
> The usage help for --type option of `git config` is missing `type`
> in the argument placeholder (`<>`). Add it.
Good.
Show 10 quoted lines
> diff --git a/builtin/config.c b/builtin/config.c
> index 542d8d02b2b..2aea465466b 100644
> --- a/builtin/config.c
> +++ b/builtin/config.c
> @@ -151,7 +151,7 @@ static struct option builtin_config_options[] = {
>  	OPT_BIT(0, "get-color", &actions, N_("find the color configured: slot [default]"), ACTION_GET_COLOR),
>  	OPT_BIT(0, "get-colorbool", &actions, N_("find the color setting: slot [stdout-is-tty]"), ACTION_GET_COLORBOOL),
>  	OPT_GROUP(N_("Type")),
> -	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),
Good again.
Thanks.  Will queue.
Previous: Matheus Felipe via GitGitGadgetNext: Matheus Felipe
Message 7 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.