public inbox for git@vger.kernel.org 
 help / color / mirror / Atom feed
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 2/5] config: use --value=<pattern> consistently
Date: Tue,  1 Jul 2025 17:14:29 +0200	[thread overview]
Message-ID: <fa183e470c52aed223d284f17a222a02edaeaad2.1751382830.git.code@khaugsbakk.name> (raw)
In-Reply-To: <cover.1751382830.git.code@khaugsbakk.name>

From: Kristoffer Haugsbakk <code@khaugsbakk•name>

This option was introduced in a series of commits from fe3ccc7aab (Merge
branch 'ps/config-subcommands', 2024-05-15).  But two styles were used
for the value provided to the option:

1. Synopsis: `--value=<value>`
2. Deprecated Modes: `--value=<pattern>`

(2) is also used in the synopsis on the command.

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 |  6 +++---
 builtin/config.c              | 12 ++++++------
 2 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/Documentation/git-config.adoc b/Documentation/git-config.adoc
index e05bf813d46..d3ddc538555 100644
--- a/Documentation/git-config.adoc
+++ b/Documentation/git-config.adoc
@@ -10,9 +10,9 @@ SYNOPSIS
 --------
 [verse]
 'git config list' [<file-option>] [<display-option>] [--includes]
-'git config get' [<file-option>] [<display-option>] [--includes] [--all] [--regexp] [--value=<value>] [--fixed-value] [--default=<default>] <name>
-'git config set' [<file-option>] [--type=<type>] [--all] [--value=<value>] [--fixed-value] <name> <value>
-'git config unset' [<file-option>] [--all] [--value=<value>] [--fixed-value] <name>
+'git config get' [<file-option>] [<display-option>] [--includes] [--all] [--regexp] [--value=<pattern>] [--fixed-value] [--default=<default>] <name>
+'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>
 'git config remove-section' [<file-option>] <name>
 'git config edit' [<file-option>]
diff --git a/builtin/config.c b/builtin/config.c
index f70d6354772..706269647e5 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>] <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
 };
 
-- 
2.50.0.136.g303b50f9132


  parent reply	other threads:[~2025-07-01 15:15 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 ` [PATCH v2 " kristofferhaugsbakk
2025-07-01 15:14   ` [PATCH v2 1/5] doc: config: document --[no-]show-names kristofferhaugsbakk
2025-07-01 15:14   ` kristofferhaugsbakk [this message]
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=fa183e470c52aed223d284f17a222a02edaeaad2.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