Re: [PATCH] docs: sort configuration variable groupings alphabetically

From: Junio C Hamano <gitster@pobox.com>
Date: Feb 29, 2024, 19:59 UTC
Message-ID: <xmqqmsrjdot3.fsf@gitster.g>
In-Reply-To: <20240229190229.20222-1-ericsunshine@charter.net>

Eric Sunshine <ericsunshine@charter.net> writes:

Show 5 quoted lines

> NOTE: This change only sorts the top-level groupings (i.e. "core.*"
> comes after "completion.*"); it does not touch the ordering of variables
> within each group since variables within individual groups might
> intentionally be ordered in some other fashion (such as
> most-common-first or most-important-first).

I think this is a useful first step.

It is tempting to think, in this day and age, searching in a document is so easy to start with a single keystroke (either ^F in a browser, or '/' in a pager) that the ordering of entries does not matter as much as it used to, but the reader may not know exactly what variable they are looking for, and a predictable ordering helps while they are browsing the list.

Will queue.  Thanks.