Re: [QUESTION] how to find options set by scalar?

From: Derrick Stolee <stolee@gmail.com>
Date: Sep 19, 2025, 15:38 UTC
Message-ID: <08deb8a8-6c34-4f11-a36b-93d151a56f9b@gmail.com>
In-Reply-To: <xmqqikhf7bdf.fsf@gitster.g>

On 9/18/2025 4:29 PM, Junio C Hamano wrote:

Show 8 quoted lines

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

Thanks, -Stolee