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

From: Matthew Hughes <matthewhughes934@gmail.com>
Date: Dec 1, 2025, 17:58 UTC
Message-ID: <wqvecbwieexjpp2pgxn66mlvq5foiw6as4doxgyiehzjuo7hv7@jrskhegeuqvg>
In-Reply-To: <ac1627dbd94e3330117fbaeac2e2373104aef531.1764607847.git.gitgitgadget@gmail.com>

On Mon, Dec 01, 2025 at 04:50:47PM +0000, Derrick Stolee via GitGitGadget wrote:

> Add user-facing documentation that justifies the values being set by
> 'scalar clone', 'scalar register', and 'scalar reconfigure'.

Thanks! This is exactly what I was hoping for.

> +REQUIRED AND RECOMMENDED CONFIG
> +-------------------------------

Would it be worth noting in scalar.c that the config options listed there are documented here, So that a dev changing the list in the source will know to also update this? I assume there's an understanding that if e.g. you update a flag you should know to also update relevant docs, but perhaps this is a bit more niche.

> +gc.auto=0::
> +	This disables automatic garbage collection, since Scalar uses background
> +	maintenance to keep the repository data in good shape.

Checking my understanding: this means there will be _no_ automatic GC in a scalar repo? Since scalar calls 'maintenance register' which means maintenance.strategy will be set to 'incremental' which won't schedule any gc runs