All of lore.kernel.org
 help / color / mirror / Atom feed
From: jari <jari.aalto@cante.net>
To: Jakub Narebski <jnareb@gmail.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] Documentation/config.txt: Order variables alphabetically
Date: Wed, 1 Dec 2010 17:09:17 +0200	[thread overview]
Message-ID: <20101201150917.GD6537@picasso.cante.net> (raw)
In-Reply-To: <201012011557.30849.jnareb@gmail.com>

On 2010-12-01 15:57, Jakub Narebski wrote:
| On Wed, 1 Dec 2010, Jari Aalto wrote:
| > On 2010-12-01 05:58, Jakub Narebski wrote:
| > | jari.aalto@cante.net writes:
| > | 
| > | > From: Jari Aalto <jari.aalto@cante.net>
| > | > 
| > | > 
| > | > Signed-off-by: Jari Aalto <jari.aalto@cante.net>
| > | > ---
| > | >  Documentation/config.txt | 1698 +++++++++++++++++++++++-----------------------
| > | >  1 files changed, 852 insertions(+), 846 deletions(-)
| > | 
| > | Why?  What such large change is for?
| > | 
| > | Note that currently config variables are grouped by functionality: for
| > | example core.eol and core.safecrlf, or core.compression and
| > | core.loosecompression are close to each other.
| 
| What about the above?

We use standard biblical refences:

	 Se ....

Suggest what is needed, and it will be so.

| > The phone books have an index where to up information.
| > 
| >     - When you see script and it use VARIABLE, you look it from
| >       manual page
| 
| Manpages (and 'git <cmd> --help') are displayed in pager, so you can
| always search for option in a pager (e.g. '/' in 'less', the default
| pager).

Yuck, it's real fun start backward/forward ping-pong when you dont'
know the directions and can't rely on standard A-Z index.

| > It is same as putting option in alphabetical order. See GNU cp(1),
| > ssh(1) etc.
| 
| In git documentation command line options are not in alphabetical order,
| but grouped by functionality, therefore your argument is invalid.

I see that only in pages that have tens and tens and tens of options..

The problem is more the asciidoc's. Various bits and pices are
"included" in place and make orderign the options impossile in some
pages.

Let's get all pages in shape with A-Z in this regard. That's a god
quality goal.

| > There are zillion values and for a reference, alphabetical order makes
| > sense.
| 
| I agree that alphabetical order makes sense for glossary; I disagree that
| it makes sense here.

About 60% in git-config is already in alpha order (core.*, sendmail.*
etc), so there is not really much that is changing.

Well. If standard reading order is not the standard, I don't know what
is.

Jari

  reply	other threads:[~2010-12-01 15:09 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-12-01 13:12 [PATCH] Documentation/config.txt: Order variables alphabetically jari.aalto
2010-12-01 13:58 ` Jakub Narebski
2010-12-01 14:34   ` jari
     [not found]   ` <20101201142920.GB6537@picasso.cante.net>
2010-12-01 14:57     ` Jakub Narebski
2010-12-01 15:09       ` jari [this message]
2010-12-01 15:19         ` Erik Faye-Lund
2010-12-01 15:33           ` Jari Aalto
2010-12-01 15:37           ` Jari Aalto
2010-12-01 16:37         ` Jakub Narebski
2010-12-01 17:10           ` Jari Aalto
2010-12-01 18:03             ` Jeff King
2010-12-01 23:38               ` Jakub Narebski
2010-12-02  1:02             ` SZEDER Gábor
2010-12-02  5:43               ` Jari Aalto
2010-12-02  9:32                 ` SZEDER Gábor
2010-12-02  5:46               ` Jari Aalto
2010-12-02  9:24                 ` SZEDER Gábor

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=20101201150917.GD6537@picasso.cante.net \
    --to=jari.aalto@cante.net \
    --cc=git@vger.kernel.org \
    --cc=jnareb@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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.