I realized that it would probably be easier to discuss this proposal if I attached the final command listing and the rendered manual page. Please find them attached to this message. Thank you, Frederick On Tue, Feb 19, 2019 at 09:54:12AM -0800, Frederick Eaton wrote: >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 >