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

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

[Celeste Liu]

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
-- 
2.46.0

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

[Junio C Hamano]

Celeste Liu <coelacanthushex@gmail.com> writes:

> 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.

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

[Patrick Steinhardt]

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?

Thanks!

Patrick

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

[Celeste Liu]

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?

Ok. I will include this in v2 later.

> 
> Thanks!
> 
> Patrick

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

[Celeste Liu]

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.

> 
> Thanks!
> 
> Patrick

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

[Patrick Steinhardt]

On Fri, Aug 23, 2024 at 04:21:15PM +0800, Celeste Liu wrote:
> 
> 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

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

[Junio C Hamano]

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.

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

Thanks.

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

[Celeste Liu]

On 2024-08-26 23:19, Junio C Hamano wrote:

> 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?

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

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

[Junio C Hamano]

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

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>

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

[Junio C Hamano]

"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>
---
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>`.

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

[Junio C Hamano]

Junio C Hamano <gitster@pobox.com> writes:

> 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.

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