git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Eric Sunshine <ericsunshine@charter.net>
Cc: git@vger.kernel.org,  Eric Sunshine <sunshine@sunshineco.com>,
	 Bruno Haible <bruno@clisp.org>
Subject: Re: [PATCH] docs: sort configuration variable groupings alphabetically
Date: Thu, 29 Feb 2024 11:59:36 -0800	[thread overview]
Message-ID: <xmqqmsrjdot3.fsf@gitster.g> (raw)
In-Reply-To: <20240229190229.20222-1-ericsunshine@charter.net> (Eric Sunshine's message of "Thu, 29 Feb 2024 14:02:29 -0500")

Eric Sunshine <ericsunshine@charter.net> writes:

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

  reply	other threads:[~2024-02-29 19:59 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-02-28 10:12 git-config doc: variables sorting bug Bruno Haible
2024-02-29 19:02 ` [PATCH] docs: sort configuration variable groupings alphabetically Eric Sunshine
2024-02-29 19:59   ` Junio C Hamano [this message]
2024-02-29 19:08 ` git-config doc: variables sorting bug Eric Sunshine

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqqmsrjdot3.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=bruno@clisp.org \
    --cc=ericsunshine@charter.net \
    --cc=git@vger.kernel.org \
    --cc=sunshine@sunshineco.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).