Re: [PATCH 5/5] scalar: document config settings

From: Derrick Stolee <stolee@gmail.com>
Date: Nov 30, 2025, 19:56 UTC
Message-ID: <a4d60418-f48a-4321-b305-d37ae2f752b1@gmail.com>
In-Reply-To: <xmqqbjkol4je.fsf@gitster.g>

On 11/26/2025 7:09 PM, Junio C Hamano wrote:

Show 9 quoted lines

> "Derrick Stolee via GitGitGadget" <gitgitgadget@gmail.com> writes:
> 
>> +commitGraph.generationVersion=1::
>> +	While the preferred version is 2 for performance reasons, existing users
>> +	that had version 1 by default will need special care in upgrading to
>> +	version 2. This is likely to change in the future as the upgrade story
>> +	is solidifies.
> 
> "as the upgrade story solidifies"?

That's better than what I was going for which was "is solidified". Will fix.

Show 7 quoted lines

>> +fetch.writeCommitGraph=false::
>> +	This config setting was created to help users automatically udpate their
>> +	commit-graph files as they perform fetches. However, this takes time
>> +	from foreground fetches and pulls and Scalar uses background maintenance
>> +	for this function instead.
> 
> "update their files".

Yes. thanks.

Show 7 quoted lines

>> +index.threads=true::
>> +	This tells Git to automatically detect how many threads it should use
>> +	when reading the index in parallel due to the `core.preloadIndex=true`
>> +	setting.
> 
> Is "due to the `core.preloadIndex=true` setting" part of this
> sentence still relevant?

I should still include this, but mention that it is enabled by default and still recommended.

> Other than that, superbly written.  Thanks, will queue.

Thanks, -Stolee