From: kristofferhaugsbakk@fastmail•com
To: git@vger•kernel.org
Cc: "Kristoffer Haugsbakk" <code@khaugsbakk•name>,
"Patrick Steinhardt" <ps@pks•im>,
"Jean-Noël Avila" <jn.avila@free•fr>,
"Eric Sunshine" <sunshine@sunshineco•com>
Subject: [PATCH v2 0/5] doc: config: update for the ps/config-subcommands series
Date: Tue, 1 Jul 2025 17:14:27 +0200 [thread overview]
Message-ID: <cover.1751382830.git.code@khaugsbakk.name> (raw)
In-Reply-To: <cover.1751310455.git.code@khaugsbakk.name>
From: Kristoffer Haugsbakk <code@khaugsbakk•name>
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=<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=<pattern> 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 [<file-option>] [<display-option>] [--includes]"),
- N_("git config get [<file-option>] [<display-option>] [--includes] [--all] [--regexp] [--value=<value>] [--fixed-value] [--default=<default>] <name>"),
- N_("git config set [<file-option>] [--type=<type>] [--all] [--value=<value>] [--fixed-value] <name> <value>"),
- N_("git config unset [<file-option>] [--all] [--value=<value>] [--fixed-value] <name>"),
+ N_("git config get [<file-option>] [<display-option>] [--includes] [--all] [--regexp] [--value=<pattern>] [--fixed-value] [--default=<default>] [--url=<url>] <name>"),
+ N_("git config set [<file-option>] [--type=<type>] [--all] [--value=<pattern>] [--fixed-value] <name> <value>"),
+ N_("git config unset [<file-option>] [--all] [--value=<pattern>] [--fixed-value] <name>"),
N_("git config rename-section [<file-option>] <old-name> <new-name>"),
N_("git config remove-section [<file-option>] <name>"),
N_("git config edit [<file-option>]"),
@@ -33,17 +33,17 @@ static const char *const builtin_config_list_usage[] = {
};
static const char *const builtin_config_get_usage[] = {
- N_("git config get [<file-option>] [<display-option>] [--includes] [--all] [--regexp=<regexp>] [--value=<value>] [--fixed-value] [--default=<default>] <name>"),
+ N_("git config get [<file-option>] [<display-option>] [--includes] [--all] [--regexp=<regexp>] [--value=<pattern>] [--fixed-value] [--default=<default>] <name>"),
NULL
};
static const char *const builtin_config_set_usage[] = {
- N_("git config set [<file-option>] [--type=<type>] [--comment=<message>] [--all] [--value=<value>] [--fixed-value] <name> <value>"),
+ N_("git config set [<file-option>] [--type=<type>] [--comment=<message>] [--all] [--value=<pattern>] [--fixed-value] <name> <value>"),
NULL
};
static const char *const builtin_config_unset_usage[] = {
- N_("git config unset [<file-option>] [--all] [--value=<value>] [--fixed-value] <name>"),
+ N_("git config unset [<file-option>] [--all] [--value=<pattern>] [--fixed-value] <name>"),
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 <ps@pks•im>
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk•name>
2: a52322528da ! 2: fa183e470c5 doc: config: use --value=<pattern> consistently
@@ Metadata
Author: Kristoffer Haugsbakk <code@khaugsbakk•name>
## Commit message ##
- doc: config: use --value=<pattern> consistently
+ config: use --value=<pattern> 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 <ps@pks•im>
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk•name>
+
+ ## 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' [<file-option>] <old-name> <new-name>
'git config remove-section' [<file-option>] <name>
'git config edit' [<file-option>]
+
+ ## builtin/config.c ##
+@@
+
+ static const char *const builtin_config_usage[] = {
+ N_("git config list [<file-option>] [<display-option>] [--includes]"),
+- N_("git config get [<file-option>] [<display-option>] [--includes] [--all] [--regexp] [--value=<value>] [--fixed-value] [--default=<default>] <name>"),
+- N_("git config set [<file-option>] [--type=<type>] [--all] [--value=<value>] [--fixed-value] <name> <value>"),
+- N_("git config unset [<file-option>] [--all] [--value=<value>] [--fixed-value] <name>"),
++ N_("git config get [<file-option>] [<display-option>] [--includes] [--all] [--regexp] [--value=<pattern>] [--fixed-value] [--default=<default>] <name>"),
++ N_("git config set [<file-option>] [--type=<type>] [--all] [--value=<pattern>] [--fixed-value] <name> <value>"),
++ N_("git config unset [<file-option>] [--all] [--value=<pattern>] [--fixed-value] <name>"),
+ N_("git config rename-section [<file-option>] <old-name> <new-name>"),
+ N_("git config remove-section [<file-option>] <name>"),
+ N_("git config edit [<file-option>]"),
+@@ builtin/config.c: static const char *const builtin_config_list_usage[] = {
+ };
+
+ static const char *const builtin_config_get_usage[] = {
+- N_("git config get [<file-option>] [<display-option>] [--includes] [--all] [--regexp=<regexp>] [--value=<value>] [--fixed-value] [--default=<default>] <name>"),
++ N_("git config get [<file-option>] [<display-option>] [--includes] [--all] [--regexp=<regexp>] [--value=<pattern>] [--fixed-value] [--default=<default>] <name>"),
+ NULL
+ };
+
+ static const char *const builtin_config_set_usage[] = {
+- N_("git config set [<file-option>] [--type=<type>] [--comment=<message>] [--all] [--value=<value>] [--fixed-value] <name> <value>"),
++ N_("git config set [<file-option>] [--type=<type>] [--comment=<message>] [--all] [--value=<pattern>] [--fixed-value] <name> <value>"),
+ NULL
+ };
+
+ static const char *const builtin_config_unset_usage[] = {
+- N_("git config unset [<file-option>] [--all] [--value=<value>] [--fixed-value] <name>"),
++ N_("git config unset [<file-option>] [--all] [--value=<pattern>] [--fixed-value] <name>"),
+ 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 <ps@pks•im>
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk•name>
## 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=<pattern>` in the rest of the doc.
+ Acked-by: Patrick Steinhardt <ps@pks•im>
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk•name>
## Documentation/git-config.adoc ##
5: ac3257a934d ! 5: 8300e0fc349 doc: config: mention --url in the synopsis
@@ Metadata
Author: Kristoffer Haugsbakk <code@khaugsbakk•name>
## 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 <ps@pks•im>
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk•name>
+
+ ## 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' [<file-option>] [--type=<type>] [--all] [--value=<pattern>] [--fixed-value] <name> <value>
'git config unset' [<file-option>] [--all] [--value=<pattern>] [--fixed-value] <name>
'git config rename-section' [<file-option>] <old-name> <new-name>
+
+ ## builtin/config.c ##
+@@
+
+ static const char *const builtin_config_usage[] = {
+ N_("git config list [<file-option>] [<display-option>] [--includes]"),
+- N_("git config get [<file-option>] [<display-option>] [--includes] [--all] [--regexp] [--value=<pattern>] [--fixed-value] [--default=<default>] <name>"),
++ N_("git config get [<file-option>] [<display-option>] [--includes] [--all] [--regexp] [--value=<pattern>] [--fixed-value] [--default=<default>] [--url=<url>] <name>"),
+ N_("git config set [<file-option>] [--type=<type>] [--all] [--value=<pattern>] [--fixed-value] <name> <value>"),
+ N_("git config unset [<file-option>] [--all] [--value=<pattern>] [--fixed-value] <name>"),
+ N_("git config rename-section [<file-option>] <old-name> <new-name>"),
base-commit: cf6f63ea6bf35173e02e18bdc6a4ba41288acff9
--
2.50.0.136.g303b50f9132
next prev parent reply other threads:[~2025-07-01 15:14 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-06-30 19:10 [PATCH 0/5] doc: config: update for the ps/config-subcommands series kristofferhaugsbakk
2025-06-30 19:10 ` [PATCH 1/5] doc: config: document --[no-]show-names kristofferhaugsbakk
2025-06-30 19:10 ` [PATCH 2/5] doc: config: use --value=<pattern> consistently kristofferhaugsbakk
2025-07-01 7:27 ` Kristoffer Haugsbakk
2025-07-01 8:00 ` Kristoffer Haugsbakk
2025-06-30 19:10 ` [PATCH 3/5] doc: config: document --[no-]value kristofferhaugsbakk
2025-06-30 19:26 ` Eric Sunshine
2025-06-30 19:10 ` [PATCH 4/5] doc: config: use --value instead of value-pattern kristofferhaugsbakk
2025-06-30 19:10 ` [PATCH 5/5] doc: config: mention --url in the synopsis kristofferhaugsbakk
2025-07-01 7:09 ` Kristoffer Haugsbakk
2025-06-30 23:10 ` [PATCH 0/5] doc: config: update for the ps/config-subcommands series Junio C Hamano
2025-07-01 7:05 ` Kristoffer Haugsbakk
2025-07-01 10:01 ` Patrick Steinhardt
2025-07-01 10:15 ` Kristoffer Haugsbakk
2025-07-01 16:03 ` Junio C Hamano
2025-07-01 15:14 ` kristofferhaugsbakk [this message]
2025-07-01 15:14 ` [PATCH v2 1/5] doc: config: document --[no-]show-names kristofferhaugsbakk
2025-07-01 15:14 ` [PATCH v2 2/5] config: use --value=<pattern> consistently kristofferhaugsbakk
2025-07-01 15:14 ` [PATCH v2 3/5] doc: config: document --[no-]value kristofferhaugsbakk
2025-07-01 15:14 ` [PATCH v2 4/5] doc: config: use --value instead of value-pattern kristofferhaugsbakk
2025-07-01 15:14 ` [PATCH v2 5/5] config: mention --url in the synopsis kristofferhaugsbakk
2025-07-01 17:32 ` [PATCH v2 0/5] doc: config: update for the ps/config-subcommands series Junio C Hamano
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=cover.1751382830.git.code@khaugsbakk.name \
--to=kristofferhaugsbakk@fastmail$(echo .)com \
--cc=code@khaugsbakk$(echo .)name \
--cc=git@vger$(echo .)kernel.org \
--cc=jn.avila@free$(echo .)fr \
--cc=ps@pks$(echo .)im \
--cc=sunshine@sunshineco$(echo .)com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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