git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Jan Krüger" <jk@jk.gs>
To: Jari Aalto <jari.aalto@cante.net>
Cc: git@vger.kernel.org, Kevin Ballard <kevin@sb.org>,
	Junio C Hamano <gitster@pobox.com>,
	Jonathan Nieder <jrnieder@gmail.com>,
	Erik Faye-Lund <kusmabite@gmail.com>,
	Jakub Narebski <jnareb@gmail.com>
Subject: Re: [PATCH] git-commit.txt: Order options alphabetically
Date: Thu, 2 Dec 2010 20:30:01 +0100	[thread overview]
Message-ID: <20101202203001.3793718d@jk.gs> (raw)
In-Reply-To: <87fwugs7pf.fsf@picasso.cante.net>

[Cc unculled again; I will ignore all further posts from you until you
stop culling or explain why you are ignoring all requests to stop
culling.]

--- Jari Aalto <jari.aalto@cante.net> wrote:

> Yes, that's the standard way of doing groups. Just like it's being
> done in other manual pages that are huge. But it is not being done in
> small manual pages. GNU project certainly doesn't in general.

What makes the GNU project the gold standard? They've got some pretty
weird conventions, such as their coding style.

> I agree tat doing "groups" makes only sense on pages that have large
> number of options. For a screenful, it's more distracting than worth.

You are "agreeing with" something I didn't say. That's not very helpful.

> Well. In my experience (having watched others to learn) the manual
> pages are not the source used for learning.

They were for me.

>     - They are technical documentation

I want related things in technical documentation to be grouped.

>     - They are reference documentation

I want related things in reference documentation to be grouped.

>     - They are visited, then discarded, visited and discarded.

Correct. Especially for that reason, I want related things to be
grouped. I don't want to scroll through the entire list of options just
to find everything related to what I want to do.

>     - Someone throws up a git command (IRC #git, Blogs, Web page).
> What do all those unreadable one letter options mean? Gosh they don't
>       even mean the save accross different git* programs.

The only realistic way around that is to stop using 

>       > He searches manual pages A-Z, easy to spot all options. Not
>       > interested in related things. He tries to understand the
>       > command, script etc.

Because everyone always knows whether the desired option is called
--skip-foo, --no-use-foo, --disable-foo, --no-foo, --antifoo or --bar?

In virtually all cases, I know what I want but not the name of the
option. It rarely happens that I know the name of the option but not
what it does.

>       This person just wants to solve a problem, get things done, the
>       faster the better. The easier the better, the less thinking the
>       better.

As mentioned, I believe that alphabetic ordering makes it harder and
take longer.

>       > He digestestes all. Related options, related pages, flipping
>       > form man to man as he knows all the glory details is just
>       > there.

Even then, learning works better if you learn things grouped by
similarities. Alphabetic ordering of the material just makes it harder.
You don't see the English teachers hand out vocabulary lessons in
alphabetic order, do you?

> There are 100+ manual pages in the git distribution. You get even
> disoriented in shere numbers of them. And you have to throw dice to
> figure out in what page that information might be you are currently in
> need.

That is correct, but none of your patches change anything about that.

> It's classical case of how to arrange information for easy retrieval.
> Think Libraries as model.

Have you ever been inside a library? The bookshelves are not ordered
alphabetically. There is a section for physics and a section for
zoology and a section for architecture. That makes it easier to find.

In fact, even before the advent of computers, the catalogs of libraries
were available in two forms: alphabetically ordered (which only helps
if you know the exact name of what you are looking for) and ordered by
category (which is pretty much the only way to find something if you
don't know exactly what you want, unless you want to read the whole
catalog back to front).



In any case, we can go around in circles forever on this. Our opinions
are different, and if we don't accept each others' arguments, nothing
will ever come of this. The next stage in a productive discussion is to
either stop bothering or to produce evidence. If you have any
scientific evidence that alphabetically ordered lists make it easier to
find things the names of which you don't know, I'll be happy to look at
it.

-Jan

  parent reply	other threads:[~2010-12-02 19:30 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-12-01 14:58 [PATCH] git-commit.txt: Order options alphabetically jari.aalto
2010-12-01 16:50 ` Jonathan Nieder
2010-12-01 17:16   ` Jari Aalto
2010-12-01 17:48     ` Jakub Narebski
2010-12-01 18:39       ` Jari Aalto
2010-12-02 14:27         ` Jakub Narebski
2010-12-01 19:30     ` Junio C Hamano
2010-12-01 21:58       ` Kevin Ballard
2010-12-01 22:45         ` Jari Aalto
2010-12-01 22:52           ` Kevin Ballard
2010-12-01 23:02             ` Jari Aalto
2010-12-02  8:53               ` Jan Krüger
2010-12-02 12:03                 ` Jari Aalto
2010-12-02 14:23                   ` Jakub Narebski
2010-12-02 19:30                   ` Jan Krüger [this message]
2010-12-01 22:35       ` Jari Aalto
2010-12-01 22:49         ` Kevin Ballard
2010-12-01 23:05           ` Jari Aalto
2010-12-01 23:40             ` Kevin Ballard
2010-12-02  5:35               ` Jari Aalto
2010-12-03 12:10             ` Erik Faye-Lund
2010-12-03 13:03 ` Nguyen Thai Ngoc Duy
  -- strict thread matches above, loose matches on Subject: below --
2010-12-01 15:52 jari.aalto

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

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

  git send-email \
    --in-reply-to=20101202203001.3793718d@jk.gs \
    --to=jk@jk.gs \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=jari.aalto@cante.net \
    --cc=jnareb@gmail.com \
    --cc=jrnieder@gmail.com \
    --cc=kevin@sb.org \
    --cc=kusmabite@gmail.com \
    /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
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).