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

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

[Brian Lyles]

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

[PATCH 2/2] docs: fix typo in git-config `--default`

[Brian Lyles]

Signed-off-by: Brian Lyles <brianmlyles@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 6876803253..a6e82b871b 100644
--- a/Documentation/git-config.txt
+++ b/Documentation/git-config.txt
@@ -286,7 +286,7 @@ Valid `<type>`'s include:
 
 --default <value>::
   When using `--get`, and the requested variable is not found, behave as if
-  <value> were the value assigned to the that variable.
+  <value> were the value assigned to that variable.
 
 CONFIGURATION
 -------------
-- 
2.43.0

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

[Patrick Steinhardt]

[-- Attachment #1: Type: text/plain, Size: 1454 bytes --]

On Sat, Mar 16, 2024 at 12:01:24AM -0500, Brian Lyles wrote:
> 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

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

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

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

[Junio C Hamano]

Patrick Steinhardt <ps@pks.im> writes:

> On Sat, Mar 16, 2024 at 12:01:24AM -0500, Brian Lyles wrote:
>> 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

Yeah, thanks, both of you.

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