git@vger.kernel.org list mirror (unofficial, one of many)
 help / color / mirror / code / Atom feed
From: Frederick Eaton <frederik@ofb.net>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>,
	Eric Sunshine <sunshine@sunshineco.com>,
	Jonathan Nieder <jrnieder@gmail.com>,
	"Theodore Y. Ts'o" <tytso@mit.edu>,
	Frederick Eaton <frederik@ofb.net>
Subject: [PATCH 0/1] de-alphabetize command list
Date: Tue, 19 Feb 2019 09:54:12 -0800
Message-ID: <20190219175413.18292-1-frederik@ofb.net> (raw)
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


  reply	other threads:[~2019-02-19 18:01 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-07-06 20:04 de-alphabetizing the documentation frederik
2018-07-06 21:16 ` Jonathan Nieder
2018-07-06 21:18   ` Jonathan Nieder
2018-07-06 23:21     ` frederik
2018-07-06 23:47       ` Jonathan Nieder
2018-07-08  1:09         ` frederik
2018-07-24 19:52           ` frederik
2018-07-24 21:11             ` Jonathan Nieder
2018-08-11  2:30               ` frederik
2018-08-13 18:17                 ` Junio C Hamano
2019-02-19 17:54                   ` Frederick Eaton [this message]
2019-02-21 18:05                     ` [PATCH 0/1] de-alphabetize command list frederik
2019-03-11  9:04                       ` frederik
2019-03-11 14:38                         ` Jacob Keller
2019-02-19 17:54                   ` [PATCH] Prioritize list of commands appearing in git(1), via command-list.txt. Don't invoke 'sort' in Documentation/cmd-list.perl Frederick Eaton
2018-07-07  4:25       ` de-alphabetizing the documentation Theodore Y. Ts'o
2018-07-06 21:32   ` 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

  List information: http://vger.kernel.org/majordomo-info.html

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

  git send-email \
    --in-reply-to=20190219175413.18292-1-frederik@ofb.net \
    --to=frederik@ofb.net \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=jrnieder@gmail.com \
    --cc=sunshine@sunshineco.com \
    --cc=tytso@mit.edu \
    --subject='Re: [PATCH 0/1] de-alphabetize command list' \
    /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

git@vger.kernel.org list mirror (unofficial, one of many)

This inbox may be cloned and mirrored by anyone:

	git clone --mirror https://public-inbox.org/git
	git clone --mirror http://ou63pmih66umazou.onion/git
	git clone --mirror http://czquwvybam4bgbro.onion/git
	git clone --mirror http://hjrcffqmbrq6wope.onion/git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V1 git git/ https://public-inbox.org/git \
		git@vger.kernel.org
	public-inbox-index git

Example config snippet for mirrors.
Newsgroups are available over NNTP:
	nntp://news.public-inbox.org/inbox.comp.version-control.git
	nntp://ou63pmih66umazou.onion/inbox.comp.version-control.git
	nntp://czquwvybam4bgbro.onion/inbox.comp.version-control.git
	nntp://hjrcffqmbrq6wope.onion/inbox.comp.version-control.git
	nntp://news.gmane.io/gmane.comp.version-control.git
 note: .onion URLs require Tor: https://www.torproject.org/

code repositories for project(s) associated with this inbox:

	https://80x24.org/mirrors/git.git

AGPL code for this site: git clone https://public-inbox.org/public-inbox.git