From: Derrick Stolee <stolee@gmail.com>
To: Patrick Steinhardt <ps@pks.im>
Cc: Junio C Hamano <gitster@pobox.com>,
Matthew Hughes <matthewhughes934@gmail.com>,
git@vger.kernel.org
Subject: Re: [QUESTION] how to find options set by scalar?
Date: Mon, 22 Sep 2025 09:36:00 -0400 [thread overview]
Message-ID: <ffa61066-7004-48dd-9096-85b305373bc7@gmail.com> (raw)
In-Reply-To: <aNDqnMTJIoHi7Ifc@pks.im>
On 9/22/2025 2:20 AM, Patrick Steinhardt wrote:
> On Fri, Sep 19, 2025 at 11:38:50AM -0400, Derrick Stolee wrote:
>> On 9/18/2025 4:29 PM, Junio C Hamano wrote:
>>> Matthew Hughes <matthewhughes934@gmail.com> writes:
>>>
>>>> I was also looking through the list of config options (within
>>>> `set_recommended_config`) and thought it might also be useful to comment why
>>>> each those settings are recommended in the context of working within a large
>>>> repository.
>>>
>>> That would be ultra useful.
>>
>> I think all of these ideas are good ones. Adding the comment as Patrick
>> described is good, for sure.
>>
>> Instead of commenting the _reason_ in code or in the config, it would be
>> good to list the reasons for each recommended config in the Scalar docs
>> so they would be visible in web docs [1] for easy discovery.
>>
>> [1] https://git-scm.com/docs/scalar
>>
>> It seems like Patrick is already 80% of the way to a patch for the
>> comment in the config. I'll see if I can carve out some time next week
>> for the commentary on the config options in the Documentation.
>
> Agreed, that seems like a good compromise: we note in the config the
> values that were set by scalar(1), but the more verbose justification
> would be part of the docs.
>
> I'm a bit stretched right now, so if you want to work on this please
> feel free to just pick my patch and iterate on it.
Makes sense. I'll pick up your patch into my series as I prepare it.
Thanks,
-Stolee
next prev parent reply other threads:[~2025-09-22 13:36 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-09-16 6:21 [QUESTION] how to find options set by scalar? Matthew Hughes
2025-09-16 7:45 ` Patrick Steinhardt
2025-09-18 19:32 ` Matthew Hughes
2025-09-18 20:29 ` Junio C Hamano
2025-09-19 15:38 ` Derrick Stolee
2025-09-22 6:20 ` Patrick Steinhardt
2025-09-22 13:36 ` Derrick Stolee [this message]
2025-10-19 17:43 ` Matthew Hughes
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=ffa61066-7004-48dd-9096-85b305373bc7@gmail.com \
--to=stolee@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=matthewhughes934@gmail.com \
--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).