From: "Matheus Felipe via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: "Bagas Sanjaya" <bagasdotme@gmail.com>,
"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>,
"Matheus Felipe" <matheusfelipeog@protonmail.com>,
"Matheus Felipe" <matheusfelipeog@protonmail.com>
Subject: [PATCH v2] fix: include the type flag in the cli docs
Date: Fri, 04 Mar 2022 04:31:53 +0000 [thread overview]
Message-ID: <pull.1220.v2.git.git.1646368313714.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.1220.git.git.1645853661519.gitgitgadget@gmail.com>
From: Matheus Felipe <matheusfelipeog@protonmail.com>
The usage help for --type option of `git config` is missing `type`
in the argument placeholder (`<>`). Add it.
Signed-off-by: Matheus Felipe <matheusfelipeog@protonmail.com>
---
fix: include the type flag in the cli docs
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:
image
[https://user-images.githubusercontent.com/50463866/155674905-01fcdf18-8f67-488a-b367-985040dfe57d.png]
In the web documentation and man page:
image
[https://user-images.githubusercontent.com/50463866/155675353-4a39965a-875c-475c-829d-7849a982f5b9.png]
image
[https://user-images.githubusercontent.com/50463866/155675437-7283dbac-fff2-44b7-8733-7d5af375bce4.png]
------------------------------------------------------------------------
Changes since v1:
* Added a better commit message (as suggested by Bagas Sanjaya
<bagasdotme@gmail.com>)
------------------------------------------------------------------------
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1220%2Fmatheusfelipeog%2Ffix%2Fgit-config-docs-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1220/matheusfelipeog/fix/git-config-docs-v2
Pull-Request: https://github.com/git/git/pull/1220
Range-diff vs v1:
1: 7bc0abde8ff ! 1: 1550d29f5da fix: include the type flag in the cli docs
@@ Metadata
## Commit message ##
fix: include the type flag in the cli docs
- 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.
+ The usage help for --type option of `git config` is missing `type`
+ in the argument placeholder (`<>`). Add it.
Signed-off-by: Matheus Felipe <matheusfelipeog@protonmail.com>
builtin/config.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
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),
OPT_CALLBACK_VALUE(0, "bool", &type, N_("value is \"true\" or \"false\""), TYPE_BOOL),
OPT_CALLBACK_VALUE(0, "int", &type, N_("value is decimal number"), TYPE_INT),
OPT_CALLBACK_VALUE(0, "bool-or-int", &type, N_("value is --bool or --int"), TYPE_BOOL_OR_INT),
base-commit: dab1b7905d0b295f1acef9785bb2b9cbb0fdec84
--
gitgitgadget
next prev parent reply other threads:[~2022-03-04 4:32 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 ` Matheus Felipe via GitGitGadget [this message]
2022-03-04 7:45 ` [PATCH v2] " Junio C Hamano
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=pull.1220.v2.git.git.1646368313714.gitgitgadget@gmail.com \
--to=gitgitgadget@gmail.com \
--cc=avarab@gmail.com \
--cc=bagasdotme@gmail.com \
--cc=git@vger.kernel.org \
--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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.