git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Matthieu Moy <matthieu.moy@grenoble-inp.fr>
Cc: Antoine Queru <Antoine.Queru@ensimag.grenoble-inp.fr>,
	git@vger.kernel.org,
	william duclot <william.duclot@ensimag.grenoble-inp.fr>,
	simon rabourg <simon.rabourg@ensimag.grenoble-inp.fr>,
	francois beutin <francois.beutin@ensimag.grenoble-inp.fr>
Subject: Re: [PATCH v2] upload-pack.c: use of parse-options API
Date: Thu, 19 May 2016 09:46:16 -0700	[thread overview]
Message-ID: <xmqqa8jmknc7.fsf@gitster.mtv.corp.google.com> (raw)
In-Reply-To: <431335092.10912437.1463674220365.JavaMail.zimbra@imag.fr> (Matthieu Moy's message of "Thu, 19 May 2016 18:10:20 +0200 (CEST)")

Matthieu Moy <matthieu.moy@grenoble-inp.fr> writes:

> Antoine.Queru@ensimag.grenoble-inp.fr wrote:
>> Option parsing now uses the parser API instead of a local parser.
>> Code is now more compact.
>> Description for -stateless-rpc and --advertise-refs
>> come from the commit (gmane/131517)
>
> Please, use a real commit id instead of a Gmane link.
>
> We don't know how long Gmane will remain up, but a self
> reference from Git's history to itself will always remain valid.
>
> The following alias is handy for this:
>
> [alias]
>         whatis = show -s --pretty='tformat:%h (%s, %ad)' --date=short
>
> In your case it would allow writing: 
>
> Description for --stateless-rpc and --advertise-refs is taken
> from commit 42526b4 (Add stateless RPC options to upload-pack,
> receive-pack, 2009-10-30).

Good suggestion; a real question may be how you went from
$gmane/131517 to 42526b4 (I vaguely recall that you have and publish
a database of sort; this would be a good place to advertise it ;-).

>
>> diff v1 v2:
>
> We usually say "diff" to refer to an actual diff. I'd write "changes since v1" here.
>
>> +		OPT_BOOL(0, "stateless-rpc", &stateless_rpc,
>> +			 N_("may perform only a single read-write cycle with stdin and stdout")),
>
> It's weird to define what an option does with "may". It's a
> property of --stateless-rpc, but does not really define it.

If this "may" were to express "The program might or might not do
this, and we do not know what it would do until we try", then it
indeed would be weird.  But the way the word "may" was used in
42526b4 is "the program is ALLOWED to do only a single exchange".

I agree that the phrasing is bad, in the sense that it can be
misread as a non-definition; perhaps

    quit after a single request/response exchange

or something?

  reply	other threads:[~2016-05-19 16:46 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-05-18 16:40 [PATCH] upload-pack.c: use of parse-options API Antoine Queru
2016-05-18 18:08 ` Jeff King
2016-05-19 10:10   ` Antoine Queru
2016-05-19 11:57     ` Jeff King
2016-05-19 14:36       ` Matthieu Moy
2016-05-19 15:39 ` [PATCH v2] " Antoine Queru
2016-05-19 16:10   ` Matthieu Moy
2016-05-19 16:46     ` Junio C Hamano [this message]
2016-05-20  6:55       ` Matthieu Moy
2016-05-19 16:58     ` Junio C Hamano
2016-05-20  6:53       ` Matthieu Moy
2016-05-20 16:52         ` Junio C Hamano
2016-05-23 13:02   ` [PATCH v3] " Antoine Queru
2016-05-23 18:03     ` Matthieu Moy
2016-05-27 14:16     ` [PATCH v4] " Antoine Queru
2016-05-27 14:52       ` Matthieu Moy
2016-05-27 16:59       ` Eric Sunshine
2016-05-30 14:27         ` Antoine Queru
2016-05-30 14:53       ` [PATCH v5] upload-pack.c: use " Antoine Queru
2016-05-30 15:06         ` Matthieu Moy
2016-05-30 19:26         ` Junio C Hamano
2016-05-31  9:53           ` Antoine Queru
2016-05-31 11:27           ` Matthieu Moy
2016-05-31 17:16             ` Junio C Hamano
2016-06-01 15:49               ` Antoine Queru
2016-05-31  9:57         ` [PATCH v6] " Antoine Queru

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=xmqqa8jmknc7.fsf@gitster.mtv.corp.google.com \
    --to=gitster@pobox.com \
    --cc=Antoine.Queru@ensimag.grenoble-inp.fr \
    --cc=francois.beutin@ensimag.grenoble-inp.fr \
    --cc=git@vger.kernel.org \
    --cc=matthieu.moy@grenoble-inp.fr \
    --cc=simon.rabourg@ensimag.grenoble-inp.fr \
    --cc=william.duclot@ensimag.grenoble-inp.fr \
    /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.
Code repositories for project(s) associated with this public inbox

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

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 read-only IMAP folder(s) and NNTP newsgroup(s).