From: kristofferhaugsbakk@fastmail.com Date: Tue, 01 Jul 2025 15:14:27 GMT Subject: [PATCH v2 0/5] doc: config: update for the ps/config-subcommands series Message-ID: In-Reply-To: From: Kristoffer Haugsbakk Update git-config(1) according to the ps/config-subcommands series (fe3ccc7aab (Merge branch 'ps/config-subcommands', 2024-05-15)): 1. Document `--show-names` 2. Document `--value` 3. Mention `--value` throughout instead of the deprecated `value-pattern` 4. Mention `--url` in the synopsis § Changes in v2 • Unbreak t/t0450-txt-doc-vs-help.sh caused by source/doc synopsis being out of synch • I missed some `--value=` in patch 2/5 • Add acks from Patrick • Link: https://lore.kernel.org/git/aGOx3C7-9NNi7h8Z@pks.im/ • Use area=config for patches that touch both the source code (builtin) and the doc Kristoffer Haugsbakk (5): doc: config: document --[no-]show-names config: use --value= consistently doc: config: document --[no-]value doc: config: use --value instead of value-pattern config: mention --url in the synopsis Documentation/git-config.adoc | 28 +++++++++++++++++++++------- builtin/config.c | 12 ++++++------ 2 files changed, 27 insertions(+), 13 deletions(-) Interdiff against v1: diff --git a/builtin/config.c b/builtin/config.c index f70d6354772..5efe2730106 100644 --- a/builtin/config.c +++ b/builtin/config.c @@ -17,9 +17,9 @@ static const char *const builtin_config_usage[] = { N_("git config list [] [] [--includes]"), - N_("git config get [] [] [--includes] [--all] [--regexp] [--value=] [--fixed-value] [--default=] "), - N_("git config set [] [--type=] [--all] [--value=] [--fixed-value] "), - N_("git config unset [] [--all] [--value=] [--fixed-value] "), + N_("git config get [] [] [--includes] [--all] [--regexp] [--value=] [--fixed-value] [--default=] [--url=] "), + N_("git config set [] [--type=] [--all] [--value=] [--fixed-value] "), + N_("git config unset [] [--all] [--value=] [--fixed-value] "), N_("git config rename-section [] "), N_("git config remove-section [] "), N_("git config edit []"), @@ -33,17 +33,17 @@ static const char *const builtin_config_list_usage[] = { }; static const char *const builtin_config_get_usage[] = { - N_("git config get [] [] [--includes] [--all] [--regexp=] [--value=] [--fixed-value] [--default=] "), + N_("git config get [] [] [--includes] [--all] [--regexp=] [--value=] [--fixed-value] [--default=] "), NULL }; static const char *const builtin_config_set_usage[] = { - N_("git config set [] [--type=] [--comment=] [--all] [--value=] [--fixed-value] "), + N_("git config set [] [--type=] [--comment=] [--all] [--value=] [--fixed-value] "), NULL }; static const char *const builtin_config_unset_usage[] = { - N_("git config unset [] [--all] [--value=] [--fixed-value] "), + N_("git config unset [] [--all] [--value=] [--fixed-value] "), NULL }; Range-diff against v1: 1: 7d66a5403b3 ! 1: 3c90ec17459 doc: config: document --[no-]show-names @@ Commit message [1]: https://lore.kernel.org/git/xmqqcyct1mtq.fsf@gitster.g/ + Acked-by: Patrick Steinhardt Signed-off-by: Kristoffer Haugsbakk 2: a52322528da ! 2: fa183e470c5 doc: config: use --value= consistently @@ Metadata Author: Kristoffer Haugsbakk ## Commit message ## - doc: config: use --value= consistently + config: use --value= consistently This option was introduced in a series of commits from fe3ccc7aab (Merge branch 'ps/config-subcommands', 2024-05-15). But two styles were used @@ Commit message Use (2) consistently throughout since it’s a pattern in the general case (`value` sounds more generic). + Acked-by: Patrick Steinhardt Signed-off-by: Kristoffer Haugsbakk + + ## Notes (series) ## + v2: + • Unbreak t/t0450-txt-doc-vs-help.sh caused by source/doc synopsis being + out of synch + • Replaced the rest that I missed + ## Documentation/git-config.adoc ## @@ Documentation/git-config.adoc: SYNOPSIS -------- @@ Documentation/git-config.adoc: SYNOPSIS 'git config rename-section' [] 'git config remove-section' [] 'git config edit' [] + + ## builtin/config.c ## +@@ + + static const char *const builtin_config_usage[] = { + N_("git config list [] [] [--includes]"), +- N_("git config get [] [] [--includes] [--all] [--regexp] [--value=] [--fixed-value] [--default=] "), +- N_("git config set [] [--type=] [--all] [--value=] [--fixed-value] "), +- N_("git config unset [] [--all] [--value=] [--fixed-value] "), ++ N_("git config get [] [] [--includes] [--all] [--regexp] [--value=] [--fixed-value] [--default=] "), ++ N_("git config set [] [--type=] [--all] [--value=] [--fixed-value] "), ++ N_("git config unset [] [--all] [--value=] [--fixed-value] "), + N_("git config rename-section [] "), + N_("git config remove-section [] "), + N_("git config edit []"), +@@ builtin/config.c: static const char *const builtin_config_list_usage[] = { + }; + + static const char *const builtin_config_get_usage[] = { +- N_("git config get [] [] [--includes] [--all] [--regexp=] [--value=] [--fixed-value] [--default=] "), ++ N_("git config get [] [] [--includes] [--all] [--regexp=] [--value=] [--fixed-value] [--default=] "), + NULL + }; + + static const char *const builtin_config_set_usage[] = { +- N_("git config set [] [--type=] [--comment=] [--all] [--value=] [--fixed-value] "), ++ N_("git config set [] [--type=] [--comment=] [--all] [--value=] [--fixed-value] "), + NULL + }; + + static const char *const builtin_config_unset_usage[] = { +- N_("git config unset [] [--all] [--value=] [--fixed-value] "), ++ N_("git config unset [] [--all] [--value=] [--fixed-value] "), + NULL + }; + 3: f8407f331e0 ! 3: c85b42e3331 doc: config: document --[no-]value @@ Commit message Document this option and the negated form according to the current convention.[2] - † 1: `--value` is a replacement for the `value-pattern` + [1]: `--value` is a replacement for the `value-pattern` positional argument [2]: https://lore.kernel.org/git/xmqqcyct1mtq.fsf@gitster.g/ + Acked-by: Patrick Steinhardt Signed-off-by: Kristoffer Haugsbakk ## Documentation/git-config.adoc ## 4: e895215e0cd ! 4: e5eee1a0541 doc: config: use --value instead of value-pattern @@ Commit message The deprecated modes have been quarantined in the “Deprecated Modes” section. So let’s only use `--value=` in the rest of the doc. + Acked-by: Patrick Steinhardt Signed-off-by: Kristoffer Haugsbakk ## Documentation/git-config.adoc ## 5: ac3257a934d ! 5: 8300e0fc349 doc: config: mention --url in the synopsis @@ Metadata Author: Kristoffer Haugsbakk ## Commit message ## - doc: config: mention --url in the synopsis + config: mention --url in the synopsis 4e513890008 (builtin/config: introduce "get" subcommand, 2024-05-06) introduced `get` and `--url` but didn’t add `--url` to the synopsis. + Acked-by: Patrick Steinhardt Signed-off-by: Kristoffer Haugsbakk + + ## Notes (series) ## + v2: + • Unbreak t/t0450-txt-doc-vs-help.sh caused by source/doc synopsis being + out of synch + ## Documentation/git-config.adoc ## @@ Documentation/git-config.adoc: SYNOPSIS -------- @@ Documentation/git-config.adoc: SYNOPSIS 'git config set' [] [--type=] [--all] [--value=] [--fixed-value] 'git config unset' [] [--all] [--value=] [--fixed-value] 'git config rename-section' [] + + ## builtin/config.c ## +@@ + + static const char *const builtin_config_usage[] = { + N_("git config list [] [] [--includes]"), +- N_("git config get [] [] [--includes] [--all] [--regexp] [--value=] [--fixed-value] [--default=] "), ++ N_("git config get [] [] [--includes] [--all] [--regexp] [--value=] [--fixed-value] [--default=] [--url=] "), + N_("git config set [] [--type=] [--all] [--value=] [--fixed-value] "), + N_("git config unset [] [--all] [--value=] [--fixed-value] "), + N_("git config rename-section [] "), base-commit: cf6f63ea6bf35173e02e18bdc6a4ba41288acff9 -- 2.50.0.136.g303b50f9132