Re: [PATCH 1/2] docs: clarify file options in git-config `--edit`

From: Patrick Steinhardt <ps@pks.im>
Date: Mar 21, 2024, 10:00 UTC
Message-ID: <ZfwFKyE-eOJo0zl4@tanuki>
In-Reply-To: <20240316050149.1182867-1-brianmlyles@gmail.com>

On Sat, Mar 16, 2024 at 12:01:24AM -0500, Brian Lyles wrote:

Show 10 quoted lines

> The description for the `-e`/`--edit` option references scopes
> inconsistently: system and global are referenced by their option name
> (`--system`/`--global`), but repository (`--local` is not. Additionally,
> neither `--worktree` nor `--file` are referenced at all, despite also
> being a valid options.
> 
> Update the description to mention all four available scopes as well as
> `--file`, referencing each consistently by their option name.
> 
> Signed-off-by: Brian Lyles <brianmlyles@gmail.com>

I know that this series has been merged to `next` already, but as it didn't get any on-list review I just wanted to mention that this series looks good to me.

Patrick

Show 22 quoted lines

> ---
>  Documentation/git-config.txt | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
> index dff39093b5..6876803253 100644
> --- a/Documentation/git-config.txt
> +++ b/Documentation/git-config.txt
> @@ -275,7 +275,8 @@ Valid `<type>`'s include:
>  -e::
>  --edit::
>  	Opens an editor to modify the specified config file; either
> -	`--system`, `--global`, or repository (default).
> +	`--system`, `--global`, `--local` (default), `--worktree`, or
> +	`--file <config-file>`.
>  
>  --[no-]includes::
>  	Respect `include.*` directives in config files when looking up
> -- 
> 2.43.0
> 
>