git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Patrick Steinhardt <ps@pks.im>
Cc: Brian Lyles <brianmlyles@gmail.com>,  git@vger.kernel.org
Subject: Re: [PATCH 1/2] docs: clarify file options in git-config `--edit`
Date: Thu, 21 Mar 2024 09:23:15 -0700	[thread overview]
Message-ID: <xmqqcyrnbll8.fsf@gitster.g> (raw)
In-Reply-To: <ZfwFKyE-eOJo0zl4@tanuki> (Patrick Steinhardt's message of "Thu, 21 Mar 2024 11:00:11 +0100")

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

      reply	other threads:[~2024-03-21 16:23 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-03-16  5:01 [PATCH 1/2] docs: clarify file options in git-config `--edit` Brian Lyles
2024-03-16  5:01 ` [PATCH 2/2] docs: fix typo in git-config `--default` Brian Lyles
2024-03-21 10:00 ` [PATCH 1/2] docs: clarify file options in git-config `--edit` Patrick Steinhardt
2024-03-21 16:23   ` Junio C Hamano [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqqcyrnbll8.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=brianmlyles@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=ps@pks.im \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).