From: Junio C Hamano <gitster@pobox.com>
To: Antoine Queru <antoine.queru@ensimag.grenoble-inp.fr>
Cc: git@vger.kernel.org, william.duclot@ensimag.grenoble-inp.fr,
simon.rabourg@ensimag.grenoble-inp.fr,
francois.beutin@ensimag.grenoble-inp.fr,
Matthieu.Moy@grenoble-inp.fr, peff@peff.net,
sunshine@sunshineco.com
Subject: Re: [PATCH v5] upload-pack.c: use parse-options API
Date: Mon, 30 May 2016 12:26:01 -0700 [thread overview]
Message-ID: <xmqqd1o38i0m.fsf@gitster.mtv.corp.google.com> (raw)
In-Reply-To: <20160530145347.15643-1-antoine.queru@ensimag.grenoble-inp.fr> (Antoine Queru's message of "Mon, 30 May 2016 16:53:47 +0200")
Antoine Queru <antoine.queru@ensimag.grenoble-inp.fr> writes:
> From: Antoine Queru <Antoine.Queru@ensimag.grenoble-inp.fr>
Don't you want to be known to the project as the email that matches
your Signed-off-by: line?
> Use the parse-options API rather than a hand-rolled option parser.
>
> Description for --stateless-rpc and --advertise-refs come from
> 42526b4 (Add stateless RPC options to upload-pack,
> receive-pack, 2009-10-30).
>
> Signed-off-by: Antoine Queru <antoine.queru@grenoble-inp.fr>
> Signed-off-by: Matthieu Moy <matthieu.moy@grenoble-inp.fr>
> ---
> ---strict::
> +--[no-]strict::
> Do not try <directory>/.git/ if <directory> is no Git directory.
Not a new problem, but "is no Git ..." may technically be correct,
but it would be easier to read if phrased "is not a Git ..." or
something like that.
I am NOT asking _you_ to change/fix that in this patch. It
is just a note for "a low hanging fruit" for people to pick
up with a separate patch.
> +--stateless-rpc::
> + Perform only a single read-write cycle with stdin and stdout.
> + This fits with the HTTP POST request processing model where
> + a program may read the request, write a response, and must exit.
> +
> +--advertise-refs::
> + Only the initial ref advertisement is output, and the program exits
> + immediately. This fits with the HTTP GET request model, where
> + no request content is received but a response must be produced.
> +
Good.
> diff --git a/upload-pack.c b/upload-pack.c
> index dc802a0..083d068 100644
> --- a/upload-pack.c
> +++ b/upload-pack.c
> @@ -14,8 +14,12 @@
> #include "sigchain.h"
> #include "version.h"
> #include "string-list.h"
> +#include "parse-options.h"
>
> -static const char upload_pack_usage[] = "git upload-pack [--strict] [--timeout=<n>] <dir>";
> +static const char * const upload_pack_usage[] = {
> + N_("git upload-pack [options] <dir>"),
> + NULL
> +};
Output from "git grep -e '\[option' -e '\[<option' -- \*.c" tells me
that "[<options>]" would be more in line with the established
convention than "[options]".
I personally wish if all these hits from the above grep
consistently spelled it as "[options]", because there is not
much gained by enclosing the word in <> to highlight it as a
placeholder. An argument that "it is done for uniformity
with descriptions for other non option arguments, i.e. not
to special case 'options'" would not hold water, e.g. in
builtin/merge.c: N_("git merge [<options>] [<commit>...]"),
<options> is still special-cased in that it implies multiple
things, unlike "<commit>..." notation that has to explicitly
say that can have multiple. [<options>...] would have been
justifiable with the "make it uniform with non-option args",
though.
BUT this patch is not about "make usage string better"
patch, so I do NOT want you to switch upload-pack's usage
string to use the "options is special anyway, so let's not
waste two display columns with enclosing <>" convention.
So, in conclusion, "git upload-pack [<options>] <dir>".
The remainder of the patch looked OK to me.
Thanks.
next prev parent reply other threads:[~2016-05-30 19:26 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
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 [this message]
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=xmqqd1o38i0m.fsf@gitster.mtv.corp.google.com \
--to=gitster@pobox.com \
--cc=Matthieu.Moy@grenoble-inp.fr \
--cc=antoine.queru@ensimag.grenoble-inp.fr \
--cc=francois.beutin@ensimag.grenoble-inp.fr \
--cc=git@vger.kernel.org \
--cc=peff@peff.net \
--cc=simon.rabourg@ensimag.grenoble-inp.fr \
--cc=sunshine@sunshineco.com \
--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).