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

[PATCH 0/1] de-alphabetize command list

From
FEFrederick Eaton <frederik@ofb.net>
Date
Feb 19, 2019, 17:54 UTC
Message-ID
<20190219175413.18292-1-frederik@ofb.net>
In-Reply-To
<xmqqva8e5dxj.fsf@gitster-ct.c.googlers.com>

This is a follow-up to my proposal to de-alphabetize the command listings in the git(1) manual page, from 6 July 2018.

Some projects have manual page items listed in alphabetical order, some don't. As I argued in my proposal, I find it easier to learn from material which is not alphabetized. If this patch is accepted, I hope that it will make the Git documentation more accessible to myself and others.

I produced the reordered command list in this patch using several sources, as indicated by comments in the new command-list.txt file. First, all the commands in the main part of "gittutorial(7)" appear in order, then the commands in giteveryday(7). Then appear additional commands from a friend's shell history, in reverse order of frequency. Then gittutorial-2(7), then gitcore-tutorial(7). After that there is a list of "guides", followed by about 100 commands not appearing in the earlier lists. I kept the guides and the remaining commands in their category groupings (guide, mainporcelain, ancillarymanipulators, etc.), but ordered the commands within each category according to my own judgment after skimming each manual page.

To verify that the new list is a permutation of the most recent list, I use the following command (it should produce no output and exit 0):

    diff <(git show master:command-list.txt | grep -v '^#' | sort ) <(cat command-list.txt | grep -v '^#' | sort)

Note this patch changes the order of commands appearing in the generated file "command-list.h", which mostly seems to be used by "help.c". Probably due to the various occurrences of QSORT in "help.c", I think this reordering has no visible effect. I am willing to do any additional testing which may be recommended to ensure that this patch has no undesired consequences.

Frederick Eaton (1):
  Prioritize list of commands appearing in git(1), via command-list.txt.
    Don't invoke 'sort' in Documentation/cmd-list.perl.
 Documentation/cmd-list.perl |   2 +-
 command-list.txt            | 295 +++++++++++++++++++-----------------
 2 files changed, 158 insertions(+), 139 deletions(-)
-- 
2.20.1
Previous: Junio C HamanoNext: frederik@ofb.net
Message 12 of 17 in “de-alphabetizing the documentation”
  1. frederik@ofb.netJul 6, 2018
  2. Jonathan NiederJul 6, 2018
  3. Jonathan NiederJul 6, 2018
  4. Eric SunshineJul 6, 2018
  5. frederik@ofb.netJul 6, 2018
  6. Jonathan NiederJul 6, 2018
  7. frederik@ofb.netJul 8, 2018
  8. frederik@ofb.netJul 24, 2018
  9. Jonathan NiederJul 24, 2018
  10. frederik@ofb.netAug 11, 2018
  11. Junio C HamanoAug 13, 2018
  12. 0/1 de-alphabetize command listFrederick Eaton, Feb 19, 2019
  13. frederik@ofb.netFeb 21, 2019
  14. frederik@ofb.netMar 11, 2019
  15. Jacob KellerMar 11, 2019
  16. Prioritize list of commands appearing in git(1), via command-list.txt. Don't invoke 'sort' in Documentation/cmd-list.perl.Frederick Eaton, Feb 19, 2019
  17. Theodore Y. Ts'oJul 7, 2018

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.