git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: "Matheus Felipe via GitGitGadget" <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org, "Bagas Sanjaya" <bagasdotme@gmail.com>,
	"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>,
	"Matheus Felipe" <matheusfelipeog@protonmail.com>
Subject: Re: [PATCH v2] fix: include the type flag in the cli docs
Date: Thu, 03 Mar 2022 23:45:25 -0800	[thread overview]
Message-ID: <xmqq8rtq2may.fsf@gitster.g> (raw)
In-Reply-To: <pull.1220.v2.git.git.1646368313714.gitgitgadget@gmail.com> (Matheus Felipe via GitGitGadget's message of "Fri, 04 Mar 2022 04:31:53 +0000")

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

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

  reply	other threads:[~2022-03-04  7:45 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-02-26  5:34 [PATCH] fix: include the type flag in the cli docs Matheus Felipe via GitGitGadget
2022-02-27  4:29 ` Bagas Sanjaya
2022-02-27 19:48   ` Junio C Hamano
2022-02-28 22:42     ` Ævar Arnfjörð Bjarmason
2022-03-04  3:56       ` Matheus Felipe
2022-03-04  4:31 ` [PATCH v2] " Matheus Felipe via GitGitGadget
2022-03-04  7:45   ` Junio C Hamano [this message]
2022-03-04 15:52     ` Matheus Felipe
2022-03-04 16:15   ` [PATCH v3] config: correct "--type" option in "git config -h" output Matheus Felipe via GitGitGadget

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqq8rtq2may.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=avarab@gmail.com \
    --cc=bagasdotme@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitgitgadget@gmail.com \
    --cc=matheusfelipeog@protonmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).