git/list[1] front-page[2] threads[3] people[4] search[5] about
 

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

From
Jonathan Nieder <jrnieder@gmail.com>
Date
Dec 1, 2010, 16:50 UTC
Message-ID
<20101201165043.GF26120@burratino>
In-Reply-To
<1291215526-11428-1-git-send-email-jari.aalto@cante.net>
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

Previous: jari.aalto@cante.netNext: Jari Aalto
Message 2 of 22 in “git-commit.txt: Order options alphabetically”
  1. git-commit.txt: Order options alphabeticallyjari.aalto@cante.net, Dec 1, 2010
  2. Jonathan NiederDec 1, 2010
  3. Jari AaltoDec 1, 2010
  4. Jakub NarebskiDec 1, 2010
  5. Jari AaltoDec 1, 2010
  6. Jakub NarebskiDec 2, 2010
  7. Junio C HamanoDec 1, 2010
  8. Kevin BallardDec 1, 2010
  9. Jari AaltoDec 1, 2010
  10. Kevin BallardDec 1, 2010
  11. Jari AaltoDec 1, 2010
  12. Jan KrügerDec 2, 2010
  13. Jari AaltoDec 2, 2010
  14. Jakub NarebskiDec 2, 2010
  15. Jan KrügerDec 2, 2010
  16. Jari AaltoDec 1, 2010
  17. Kevin BallardDec 1, 2010
  18. Jari AaltoDec 1, 2010
  19. Kevin BallardDec 1, 2010
  20. Jari AaltoDec 2, 2010
  21. Erik Faye-LundDec 3, 2010
  22. Nguyen Thai Ngoc DuyDec 3, 2010

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.