git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Jari Aalto <jari.aalto@cante.net>
Cc: Jakub Narebski <jnareb@gmail.com>, git@vger.kernel.org
Subject: Re: [PATCH] git-rebase.sh: Update USAGE string (No. 1)
Date: Sun, 03 Feb 2008 16:39:06 -0800	[thread overview]
Message-ID: <7vfxw9pnbp.fsf@gitster.siamese.dyndns.org> (raw)
In-Reply-To: <zluh1sxv.fsf@blue.sea.net> (Jari Aalto's message of "Mon, 04 Feb 2008 02:11:40 +0200")

Jari Aalto <jari.aalto@cante.net> writes:

> * Sun 2008-02-03 Jakub Narebski <jnareb@gmail.com> INBOX
>> I would say "[--whitespace=<option>]" or "[--whitespace=<action>]"
>> instead of introducing yet not agreed upon notation (this has the
>> advantage of shortening synopisis, which should be short IMHO).
>
> The "{a|b|c}" is a used syntax. See cpio(1).
>  
>     cpio  {-o|--create} [-0acvABLV] ...

I do not think using {} for grouping is incorrect, and I think
there is at least a consensus on the list that it is Ok as long
as we consistently do so.

Unfortunately, the majority of, if not all of, our existing
documents use () instead for that purpose.

So pros-and-cons are that (1) changing all of them to use {} is
more politically correct (pro); (2) our use of (), as we
consistently use them, does not hurt readability (neutral); and
(3) it is a thankless makework to replace them all to {} _and
make sure the conversion is correct_ (large con).  (4) also if
other people make changes to documentation at the same time,
that would add more work in conflict resolution (slight con).

As you seem to have volunteered to do the conversion and
validation, I do not see much problem to move from () to {} in
principle.

About the part your patch touches, [--whitespace={a|b|c}] is
more precise than [--whitespace=a|b|c] Jakub suggested, but I
suspect most sane people would not misinterpret the latter as
"this part can be omitted but you could write '--whitespace=a',
'b' or 'c' here", so...

  parent reply	other threads:[~2008-02-04  0:39 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-02-03 20:19 [PATCH] git-rebase.sh: Update USAGE string Jari Aalto
2008-02-03 21:14 ` Jakub Narebski
2008-02-03 23:33 ` [PATCH] git-rebase.sh: Update USAGE string (No. 1) Jari Aalto
2008-02-03 23:41   ` Johannes Schindelin
2008-02-03 23:52   ` Jakub Narebski
2008-02-04  0:11     ` Jari Aalto
2008-02-04  0:27       ` Johannes Schindelin
2008-02-04  0:39       ` Junio C Hamano [this message]
2008-02-04 10:15         ` Jakub Narebski
2008-02-04 11:57           ` Mike Hommey
2008-02-04 12:53             ` Jakub Narebski
2008-02-04  0:24     ` Junio C Hamano
2008-02-04  8:04       ` [PATCH v3] git-rebase.sh: Update USAGE string Jari Aalto
2008-02-04 11:12   ` [PATCH] git-rebase.sh: Update USAGE string (No. 1) しらいしななこ
2008-02-04 15:06     ` rebase -i and --whitespace, was " Johannes Schindelin
2008-02-04 15:42       ` Jakub Narebski
2008-02-04 16:32         ` Johannes Schindelin
2008-02-05 23:43         ` Junio C Hamano
2008-02-06  1:00           ` Johannes Schindelin
2008-02-04  0:16 ` [PATCH v2] git-rebase.sh: Update USAGE string 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=7vfxw9pnbp.fsf@gitster.siamese.dyndns.org \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=jari.aalto@cante.net \
    --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 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).