Re: [PATCH 00/59] Split config.txt

From: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Date: Oct 20, 2018, 19:25 UTC
Message-ID: <87d0s4ctds.fsf@evledraar.gmail.com>
In-Reply-To: <20181020123848.2785-1-pclouds@gmail.com>

On Sat, Oct 20 2018, Nguyễn Thái Ngọc Duy wrote:

Show 14 quoted lines

> I started this a couple months back, moving a couple big config
> sections out of config.txt to make it more manageable. This series
> almost completes that. It moves all configs (except http.* which have
> changes on 'pu') out of config.txt. config.txt is now about the
> syntax, and a list of config sections. http section can be moved out
> later.
>
> I did a doc-diff on this series and the only change is ssh.variant is
> moved down a bit to keep it in order, which is intended.
>
> I thought of grouping all these config files in a separate directory
> Documentation/config to avoid cluttering Documentation/ too much but
> let's wait and see if people really find Documentation growing too
> large first.

I had a slight bias against this when you started this, since I'm one of these odd people who don't mind ~20k line files if the line count isn't contributing to inherent complexity, e.g. in the case of config.txt you could just use the search function all in one file.

But FWIW I've changed my mind to as strong opinion in favor this series, because an actual annoyance of mine has been how inconsistently we document config variables affecting individual commands.

I.e. in some cases we have somecmd.switch=xyz that's also a --switch described in git-somecmd(1), and the --switch docs are more exhaustive, or the other way around.

And sometimes like in the case of git-gc(1) we have gc.* config documented in two places with different prose that needs to be updated in two places in a CONFIGURATION section. This series allows us to just unify the two and do an "include" in two places, and more generally have the convention that a given command that uses configuration could have that config both documented in git-config(1), and the same docs in its own manpage.

Is doing some post-cleanup like that your eventual goal after this series?