Re: [PATCH] git-commit.txt: Order options alphabetically

[Jonathan Nieder <jrnieder@gmail.com>]

Hi again,

jari.aalto@cante.net wrote:

> [Subject: [PATCH] git-commit.txt: Order options alphabetically]
>
> Signed-off-by: Jari Aalto <jari.aalto@cante.net>

Here's what Documentation/SubmittingPatches has to say.

	[...] patches which plainly describe the things that
	help reviewers check the patch, and future maintainers understand
	the code, are the most beautiful patches.  Descriptions that summarise
	the point in the subject well, and describe the motivation for the
	change, the approach taken by the change, and if relevant how this
	differs substantially from the prior version, can be found on Usenet
	archives back into the late 80's.  Consider it like good Netiquette,
	but for code.

Here, you've explained what the patch does, but not why.  How are
reviewers to evaluate whether it succeeded?

If the goal is sorted option lists in all manpages, that will _have_
to be automated.  Some manpages read some and not all of their options
from an external file.  But before we deal with that: why would I want
sorted option lists in all manpages?

Sorting can sometimes be an improvement; it just seems better to
mention the particulars of the situation and why sorting rather than
some thematic grouping is appropriate in a given case.

Hope that helps,
Jonathan