doc: config: update for the ps/config-subcommands series

[email protected] git 2 versions Jun 30, 2025 – Jul 1, 2025 In review

Get series with b4

b4 am [email protected]

Versions newest first · linked by author and title

v2 Latest Jul 1, 20255 patches 1 replyIn review
v1 Jun 30, 20255 patches 9 repliesSuperseded

Patches in v2 No applies recorded yet

#	Subject and files	Size	Replies
1/5	doc: config: document --[no-]show-names`Documentation/git-config.adoc`	+6 -0	0 replies
2/5	config: use --value=<pattern> consistently`Documentation/git-config.adoc` `builtin/config.c`	+9 -9	0 replies
3/5	doc: config: document --[no-]value`Documentation/git-config.adoc`	+8 -0	0 replies
4/5	doc: config: use --value instead of value-pattern`Documentation/git-config.adoc`	+4 -4	0 replies
5/5	config: mention --url in the synopsis`Documentation/git-config.adoc` `builtin/config.c`	+2 -2	0 replies

Reviews trailers per patch

All 5 patches have a Reviewed-by or Acked-by.

Patch	Patrick Steinhardt
1/5	A-b
2/5	A-b
3/5	A-b
4/5	A-b
5/5	A-b

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v2 thread

Cover letter [PATCH v2 0/5] doc: config: update for the ps/config-subcommands series

From: Kristoffer Haugsbakk <[email protected]>

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/[email protected]/
• 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:

builtin/config.c +6 -6

index f70d6354772..5efe2730106 100644
@@ -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/[email protected]/

+ Acked-by: Patrick Steinhardt <[email protected]>

Signed-off-by Kristoffer Haugsbakk <[email protected]>

2: a52322528da ! 2: fa183e470c5 doc: config: use --value=<pattern> consistently
@@ Metadata
Author: Kristoffer Haugsbakk <[email protected]>

## 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 <[email protected]>

Signed-off-by Kristoffer Haugsbakk <[email protected]>

+
+ ## 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/[email protected]/

+ Acked-by: Patrick Steinhardt <[email protected]>

Signed-off-by Kristoffer Haugsbakk <[email protected]>

## 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 <[email protected]>

Signed-off-by Kristoffer Haugsbakk <[email protected]>

## Documentation/git-config.adoc ##
5: ac3257a934d ! 5: 8300e0fc349 doc: config: mention --url in the synopsis
@@ Metadata
Author: Kristoffer Haugsbakk <[email protected]>

## 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 <[email protected]>

Signed-off-by Kristoffer Haugsbakk <[email protected]>

+
+ ## 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

Signature · 1 line

2.50.0.136.g303b50f9132

Read the cover letter in its thread