git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jakub Narebski <jnareb@gmail.com>
To: Jari Aalto <jari.aalto@cante.net>
Cc: git@vger.kernel.org, Jonathan Nieder <jrnieder@gmail.com>,
	Erik Faye-Lund <kusmabite@gmail.com>
Subject: Re: [PATCH] git-commit.txt: Order options alphabetically
Date: Wed, 01 Dec 2010 09:48:57 -0800 (PST)	[thread overview]
Message-ID: <m362vd4c6h.fsf@localhost.localdomain> (raw)
In-Reply-To: <87r5e1v2g8.fsf@picasso.cante.net>

Jari, could you please do not cull Cc list, if possible?  Thanks in
advance.

Jari Aalto <jari.aalto@cante.net> writes:
> 2010-12-01 18:50 Jonathan Nieder <jrnieder@gmail.com>:

> > If the goal is sorted option lists in all manpages, that will _have_
> > to be automated.
> 
> Who is going to write that script? I'm afraid that will never happen.
> 
> It's easier and faster to edit. One page at a time. As time allows.
> Nobody is going take vacation and do it once for all. Bit by bit is
> better approach.

But because some manpages "include" other pages (to refactor common
options), it would be impossible to sort alphabetically options in all
manpages.  So why bother with impossible?  It would only introduce
inconsistency.

> > why would I want sorted option lists in all manpages?
> 
> Does that really need an answer? You read from top to bottom, therefore
> A-Z. Well, GNU uses it in manual pages. 

What do you mean by "GNU" here?

>                                          It looks good, it looks
> professional, it looks clean. And it works when searching (= no
> orientation problems).

It works if you have separate user's documentation from reference
documentation.  GNU projects were meant to have manpages as reference,
and info pages as user's documentation.  Options sorted alphabetically
might make sense for reference documentation.  

But git manpages doesn't serve _only_ as reference documentation.  And
learning commands from manpages where options are sorted alphabetically
instead of grouped together by function *suck* big time.

-- 
Jakub Narebski
Poland
ShadeHawk on #git

  reply	other threads:[~2010-12-01 17:49 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 [this message]
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
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=m362vd4c6h.fsf@localhost.localdomain \
    --to=jnareb@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=jari.aalto@cante.net \
    --cc=jrnieder@gmail.com \
    --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).