diff mbox series

[v3] config: correct "--type" option in "git config -h" output

Message ID pull.1220.v3.git.git.1646410557888.gitgitgadget@gmail.com (mailing list archive)
State Accepted
Commit 5445124fad4db6c6646edc8b9b0348794fd7e439
Headers show
Series [v3] config: correct "--type" option in "git config -h" output | expand

Commit Message

Matheus Felipe March 4, 2022, 4:15 p.m. UTC 
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>
---
    config: correct "--type" option in "git config -h" output
    
    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>)
     * Improve the title of the commit, to make it more explicit when viewed
       with git shortlog --no-merges (as suggested by Junio C Hamano
       <gitster@pobox.com>)
    
    ------------------------------------------------------------------------

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1220%2Fmatheusfelipeog%2Ffix%2Fgit-config-docs-v3
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1220/matheusfelipeog/fix/git-config-docs-v3
Pull-Request: https://github.com/git/git/pull/1220

Range-diff vs v2:

 1:  1550d29f5da ! 1:  f0fff5f3597 fix: include the type flag in the cli docs
     @@ Metadata
      Author: Matheus Felipe <matheusfelipeog@protonmail.com>
      
       ## Commit message ##
     -    fix: include the type flag in the cli docs
     +    config: correct "--type" option in "git config -h" output
      
          The usage help for --type option of `git config` is missing `type`
          in the argument placeholder (`<>`). Add it.


 builtin/config.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)


base-commit: dab1b7905d0b295f1acef9785bb2b9cbb0fdec84
diff mbox series

Patch

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),