threads / patch / 61995

patchdoc: replace 3 dash with correct 2 dash in git-config(1)

Subject: [PATCH] doc: replace 3 dash with correct 2 dash in git-config(1)

## tl;dr

11 messages between Aug 22, 2024 and Aug 26, 2024. Diffs are folded; open one to read it.

replies: 10people: 3as markdown or json

Celeste Liu· Aug 22, 2024, 17:20 UTC · lore

Commit 4e51389000 (builtin/config: introduce "get" subcommand, 2024-05-06) introduced this typo.

Fixes: 4e51389000 (builtin/config: introduce "get" subcommand, 2024-05-06)
Signed-off-by: Celeste Liu <CoelacanthusHex@gmail.com>
---
 Documentation/git-config.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Show changes to Documentation/git-config.txt +1 −0
diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
index 65c645d461..79360328aa 100644
--- a/Documentation/git-config.txt
+++ b/Documentation/git-config.txt
@@ -130,7 +130,7 @@ OPTIONS
 --all::
 	With `get`, return all values for a multi-valued key.
 
----regexp::
+--regexp::
 	With `get`, interpret the name as a regular expression. Regular
 	expression matching is currently case-sensitive and done against a
 	canonicalized version of the key in which section and variable names

-- 
2.46.0
Junio C Hamano· Aug 22, 2024, 18:02 UTC · re: Celeste Liu · lore

Re: [PATCH] doc: replace 3 dash with correct 2 dash in git-config(1)

Celeste Liu <coelacanthushex@gmail.com> writes:
Show 22 quoted lines
> Commit 4e51389000 (builtin/config: introduce "get" subcommand, 2024-05-06)
> introduced this typo.
>
> Fixes: 4e51389000 (builtin/config: introduce "get" subcommand, 2024-05-06)
> Signed-off-by: Celeste Liu <CoelacanthusHex@gmail.com>
> ---
>  Documentation/git-config.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
> index 65c645d461..79360328aa 100644
> --- a/Documentation/git-config.txt
> +++ b/Documentation/git-config.txt
> @@ -130,7 +130,7 @@ OPTIONS
>  --all::
>  	With `get`, return all values for a multi-valued key.
>  
> ----regexp::
> +--regexp::
>  	With `get`, interpret the name as a regular expression. Regular
>  	expression matching is currently case-sensitive and done against a
>  	canonicalized version of the key in which section and variable names
Looks obviously correct.  Thanks.
Patrick Steinhardt· Aug 23, 2024, 05:45 UTC · re: Celeste Liu · lore

Re: [PATCH] doc: replace 3 dash with correct 2 dash in git-config(1)

On Fri, Aug 23, 2024 at 01:20:41AM +0800, Celeste Liu wrote:
> Commit 4e51389000 (builtin/config: introduce "get" subcommand, 2024-05-06)
> introduced this typo.

We typically do not word the commit message as a continuation of the subject. The subject often becomes invisible in many contexts, so it is helpful if it can be read standalone while providing all of the context necessary. So mentioning what is wrong would be welcome here.

> Fixes: 4e51389000 (builtin/config: introduce "get" subcommand, 2024-05-06)
We do not use Fixes tags in the Git project.
Show 18 quoted lines
> Signed-off-by: Celeste Liu <CoelacanthusHex@gmail.com>
> ---
>  Documentation/git-config.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
> index 65c645d461..79360328aa 100644
> --- a/Documentation/git-config.txt
> +++ b/Documentation/git-config.txt
> @@ -130,7 +130,7 @@ OPTIONS
>  --all::
>  	With `get`, return all values for a multi-valued key.
>  
> ----regexp::
> +--regexp::
>  	With `get`, interpret the name as a regular expression. Regular
>  	expression matching is currently case-sensitive and done against a
>  	canonicalized version of the key in which section and variable names
This looks obviously correct to me.

There's one more thing I noticed: the synopsis for `git config get` says `--regrexp=<regexp>`, which is clearly wrong. As you're already at it, would you mind including a second patch that corrects this?

Thanks!
Patrick
Celeste Liu· Aug 23, 2024, 07:59 UTC · re: Patrick Steinhardt · lore

Re: [PATCH] doc: replace 3 dash with correct 2 dash in git-config(1)

On 2024-08-23 13:45, Patrick Steinhardt wrote:
Show 37 quoted lines
> On Fri, Aug 23, 2024 at 01:20:41AM +0800, Celeste Liu wrote:
>> Commit 4e51389000 (builtin/config: introduce "get" subcommand, 2024-05-06)
>> introduced this typo.
> 
> We typically do not word the commit message as a continuation of the
> subject. The subject often becomes invisible in many contexts, so it is
> helpful if it can be read standalone while providing all of the context
> necessary. So mentioning what is wrong would be welcome here.
> 
>> Fixes: 4e51389000 (builtin/config: introduce "get" subcommand, 2024-05-06)
> 
> We do not use Fixes tags in the Git project.
> 
>> Signed-off-by: Celeste Liu <CoelacanthusHex@gmail.com>
>> ---
>>  Documentation/git-config.txt | 2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
>> index 65c645d461..79360328aa 100644
>> --- a/Documentation/git-config.txt
>> +++ b/Documentation/git-config.txt
>> @@ -130,7 +130,7 @@ OPTIONS
>>  --all::
>>  	With `get`, return all values for a multi-valued key.
>>  
>> ----regexp::
>> +--regexp::
>>  	With `get`, interpret the name as a regular expression. Regular
>>  	expression matching is currently case-sensitive and done against a
>>  	canonicalized version of the key in which section and variable names
> 
> This looks obviously correct to me.
> 
> There's one more thing I noticed: the synopsis for `git config get` says
> `--regrexp=<regexp>`, which is clearly wrong. As you're already at it,
> would you mind including a second patch that corrects this?
Ok. I will include this in v2 later.
> 
> Thanks!
> 
> Patrick
Celeste Liu· Aug 23, 2024, 08:21 UTC · re: Patrick Steinhardt · lore

Re: [PATCH] doc: replace 3 dash with correct 2 dash in git-config(1)

On 2024-08-23 13:45, Patrick Steinhardt wrote:
Show 37 quoted lines
> On Fri, Aug 23, 2024 at 01:20:41AM +0800, Celeste Liu wrote:
>> Commit 4e51389000 (builtin/config: introduce "get" subcommand, 2024-05-06)
>> introduced this typo.
> 
> We typically do not word the commit message as a continuation of the
> subject. The subject often becomes invisible in many contexts, so it is
> helpful if it can be read standalone while providing all of the context
> necessary. So mentioning what is wrong would be welcome here.
> 
>> Fixes: 4e51389000 (builtin/config: introduce "get" subcommand, 2024-05-06)
> 
> We do not use Fixes tags in the Git project.
> 
>> Signed-off-by: Celeste Liu <CoelacanthusHex@gmail.com>
>> ---
>>  Documentation/git-config.txt | 2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
>> index 65c645d461..79360328aa 100644
>> --- a/Documentation/git-config.txt
>> +++ b/Documentation/git-config.txt
>> @@ -130,7 +130,7 @@ OPTIONS
>>  --all::
>>  	With `get`, return all values for a multi-valued key.
>>  
>> ----regexp::
>> +--regexp::
>>  	With `get`, interpret the name as a regular expression. Regular
>>  	expression matching is currently case-sensitive and done against a
>>  	canonicalized version of the key in which section and variable names
> 
> This looks obviously correct to me.
> 
> There's one more thing I noticed: the synopsis for `git config get` says
> `--regrexp=<regexp>`, which is clearly wrong. As you're already at it,
> would you mind including a second patch that corrects this?

I couldn't find this typo. Did I miss something? If something missed, please tell me. I will include it in v3. v2 has been sent.

> 
> Thanks!
> 
> Patrick
Patrick Steinhardt· Aug 26, 2024, 06:24 UTC · re: Celeste Liu · lore

Re: [PATCH] doc: replace 3 dash with correct 2 dash in git-config(1)

On Fri, Aug 23, 2024 at 04:21:15PM +0800, Celeste Liu wrote:
Show 43 quoted lines
> 
> On 2024-08-23 13:45, Patrick Steinhardt wrote:
> > On Fri, Aug 23, 2024 at 01:20:41AM +0800, Celeste Liu wrote:
> >> Commit 4e51389000 (builtin/config: introduce "get" subcommand, 2024-05-06)
> >> introduced this typo.
> > 
> > We typically do not word the commit message as a continuation of the
> > subject. The subject often becomes invisible in many contexts, so it is
> > helpful if it can be read standalone while providing all of the context
> > necessary. So mentioning what is wrong would be welcome here.
> > 
> >> Fixes: 4e51389000 (builtin/config: introduce "get" subcommand, 2024-05-06)
> > 
> > We do not use Fixes tags in the Git project.
> > 
> >> Signed-off-by: Celeste Liu <CoelacanthusHex@gmail.com>
> >> ---
> >>  Documentation/git-config.txt | 2 +-
> >>  1 file changed, 1 insertion(+), 1 deletion(-)
> >>
> >> diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
> >> index 65c645d461..79360328aa 100644
> >> --- a/Documentation/git-config.txt
> >> +++ b/Documentation/git-config.txt
> >> @@ -130,7 +130,7 @@ OPTIONS
> >>  --all::
> >>  	With `get`, return all values for a multi-valued key.
> >>  
> >> ----regexp::
> >> +--regexp::
> >>  	With `get`, interpret the name as a regular expression. Regular
> >>  	expression matching is currently case-sensitive and done against a
> >>  	canonicalized version of the key in which section and variable names
> > 
> > This looks obviously correct to me.
> > 
> > There's one more thing I noticed: the synopsis for `git config get` says
> > `--regrexp=<regexp>`, which is clearly wrong. As you're already at it,
> > would you mind including a second patch that corrects this?
> 
> I couldn't find this typo. Did I miss something? If something missed, please 
> tell me. I will include it in v3.
> v2 has been sent.

It's in line 13 in Documentation/git-config.txt. Seeing that your v2 is already out and queued for `next` by Junio I wouldn't fix that in a v3 resend though. If you want to fix that as well, I'd just send a separate patch.

Also fine if you just ignore this, I can also fix this myself. Just let me know your preference :)

Patrick
Junio C Hamano· Aug 26, 2024, 15:19 UTC · re: Patrick Steinhardt · lore

Re: [PATCH] doc: replace 3 dash with correct 2 dash in git-config(1)

Patrick Steinhardt <ps@pks.im> writes:
Show 9 quoted lines
>> > There's one more thing I noticed: the synopsis for `git config get` says
>> > `--regrexp=<regexp>`, which is clearly wrong. As you're already at it,
>> > would you mind including a second patch that corrects this?
>> 
>> I couldn't find this typo. Did I miss something? If something missed, please 
>> tell me. I will include it in v3.
>> v2 has been sent.
>
> It's in line 13 in Documentation/git-config.txt. Seeing that your v2 is

Ahhhh. You weren't saying "regexp is misspelt as regrexp". You're right. I too missed it.

The synopsis should lose "=<regexp>" part, as the option does not take any arguments.

Thanks.
Celeste Liu· Aug 26, 2024, 15:56 UTC · re: Junio C Hamano · lore

Re: [PATCH] doc: replace 3 dash with correct 2 dash in git-config(1)

On 2024-08-26 23:19, Junio C Hamano wrote:
Show 14 quoted lines
> Patrick Steinhardt <ps@pks.im> writes:
> 
>>>> There's one more thing I noticed: the synopsis for `git config get` says
>>>> `--regrexp=<regexp>`, which is clearly wrong. As you're already at it,
>>>> would you mind including a second patch that corrects this?
>>>
>>> I couldn't find this typo. Did I miss something? If something missed, please 
>>> tell me. I will include it in v3.
>>> v2 has been sent.
>>
>> It's in line 13 in Documentation/git-config.txt. Seeing that your v2 is
> 
> Ahhhh.  You weren't saying "regexp is misspelt as regrexp".  You're
> right.  I too missed it.

Ohhhhh. I missed it. A comment which include typo and point out a typo led my brain to wrong way.

And is there need a new patch to fix this? Or you will fix it directly?
Show 5 quoted lines
> 
> The synopsis should lose "=<regexp>" part, as the option does not
> take any arguments.
> 
> Thanks.
Junio C Hamano· Aug 26, 2024, 17:19 UTC · re: Celeste Liu · lore

Re: [PATCH] doc: replace 3 dash with correct 2 dash in git-config(1)

Celeste Liu <coelacanthushex@gmail.com> writes:
> And is there need a new patch to fix this? Or you will fix it directly?
>> 
>> The synopsis should lose "=<regexp>" part, as the option does not
>> take any arguments.
It is a separate documentation bug.  We can fix it separately.
----- >8 --------- >8 --------- >8 -----
Subject: git-config.1: two random small fixes

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>
---
Show changes to diff +1 −1
diff --git c/Documentation/git-config.txt w/Documentation/git-config.txt
index 65c645d461..1ee5c89ba2 100644
--- c/Documentation/git-config.txt
+++ w/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>
Junio C Hamano· Aug 26, 2024, 17:31 UTC · re: Junio C Hamano · lore

[PATCH] git-config.1: --get-all description update

"git config --get-all foo.bar" shows all values for the foo.bar variable, but does not give the variable name in each output entry. Hence it is equivalent to "git config get --all foo.bar", without "--show-names", in the more modern syntax.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
Show changes to diff +1 −1
diff --git i/Documentation/git-config.txt w/Documentation/git-config.txt
index 65c645d461..1ee5c89ba2 100644
--- i/Documentation/git-config.txt
+++ w/Documentation/git-config.txt
@@ -309,7 +309,7 @@ recommended to migrate to the new syntax.
 	Replaced by `git config get [--value=<pattern>] <name>`.
 
 --get-all <name> [<value-pattern>]::
-	Replaced by `git config get [--value=<pattern>] --all --show-names <name>`.
+	Replaced by `git config get [--value=<pattern>] --all <name>`.
 
 --get-regexp <name-regexp>::
 	Replaced by `git config get --all --show-names --regexp <name-regexp>`.
Junio C Hamano· Aug 26, 2024, 17:32 UTC · re: Junio C Hamano · lore

Re: [PATCH] doc: replace 3 dash with correct 2 dash in git-config(1)

Junio C Hamano <gitster@pobox.com> writes:
Show 11 quoted lines
> Celeste Liu <coelacanthushex@gmail.com> writes:
>
>> And is there need a new patch to fix this? Or you will fix it directly?
>>> 
>>> The synopsis should lose "=<regexp>" part, as the option does not
>>> take any arguments.
>
> It is a separate documentation bug.  We can fix it separately.
>
> ----- >8 --------- >8 --------- >8 -----
> Subject: git-config.1: two random small fixes
Sorry but, this is a stale subject.
    Subject: git-config.1: fix --regexp description in synopsis
or something, probably.
Show 20 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>
> ---
>
> diff --git c/Documentation/git-config.txt w/Documentation/git-config.txt
> index 65c645d461..1ee5c89ba2 100644
> --- c/Documentation/git-config.txt
> +++ w/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>

← back to recent threads