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

[Patrick Steinhardt <ps@pks.im>]

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