[PATCH v2] git-config.1: fix description of --regexp in synopsis

Junio C Hamano· Aug 26, 2024, 18:48 UTC · lore

The synopsis says --regexp=<regexp> but the --regexp option is a Boolean that says "the name given is not literal, but a pattern to match the name".

Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
 * t0450 strikes again X-<.  This should pass that test.

 Documentation/git-config.txt | 2 +-
 builtin/config.c             | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

Show changes to 2 files +2 −2

Documentation/git-config.txt, builtin/config.c

diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
index 65c645d461..85a7edc407 100644
--- a/Documentation/git-config.txt
+++ b/Documentation/git-config.txt
@@ -10,7 +10,7 @@ SYNOPSIS
 --------
 [verse]
 'git config list' [<file-option>] [<display-option>] [--includes]
-'git config get' [<file-option>] [<display-option>] [--includes] [--all] [--regexp=<regexp>] [--value=<value>] [--fixed-value] [--default=<default>] <name>
+'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> <value>
 'git config rename-section' [<file-option>] <old-name> <new-name>
diff --git a/builtin/config.c b/builtin/config.c
index 20a0b64090..97e4d5f57c 100644
--- a/builtin/config.c
+++ b/builtin/config.c
@@ -17,7 +17,7 @@
 
 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=<regexp>] [--value=<value>] [--fixed-value] [--default=<default>] <name>"),
+	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> <value>"),
 	N_("git config rename-section [<file-option>] <old-name> <new-name>"),

-- 
2.46.0-528-g6fe5f670b3

Patrick Steinhardt· Aug 27, 2024, 12:09 UTC · re: Junio C Hamano · lore

Re: [PATCH v2] git-config.1: fix description of --regexp in synopsis

On Mon, Aug 26, 2024 at 11:48:57AM -0700, Junio C Hamano wrote:

Show 7 quoted lines

> The synopsis says --regexp=<regexp> but the --regexp option is a
> Boolean that says "the name given is not literal, but a pattern to
> match the name".
> 
> Signed-off-by: Junio C Hamano <gitster@pobox.com>
> ---
>  * t0450 strikes again X-<.  This should pass that test.

Thanks, this version looks good to me!

Patrick

v2git-config.1: fix description of --regexp in synopsis