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

From: Junio C Hamano <gitster@pobox.com>
Date: Aug 26, 2024, 17:32 UTC
Message-ID: <xmqqle0jjikl.fsf@gitster.g>
In-Reply-To: <xmqq34mrkxre.fsf@gitster.g>

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>