From: Junio C Hamano <gitster@pobox.com>
To: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Cc: git@vger.kernel.org, "René Scharfe" <l.s.r@web.de>
Subject: Re* [PATCH] push: comment on a funny unbalanced option help
Date: Thu, 02 Aug 2018 08:44:18 -0700 [thread overview]
Message-ID: <xmqq36vw4vu5.fsf_-_@gitster-ct.c.googlers.com> (raw)
In-Reply-To: <xmqqwot969mp.fsf@gitster-ct.c.googlers.com> (Junio C. Hamano's message of "Wed, 01 Aug 2018 14:48:46 -0700")
Junio C Hamano <gitster@pobox.com> writes:
> Ævar Arnfjörð Bjarmason <avarab@gmail.com> writes:
>
>>> + /* N_() will get "<>" around, resulting in "<refname>:<expect>" */
>>
>> ...but this comment isn't accurate at all, N_() doesn't wrap the string
>> with <>'s, as can be seen by applying this patch:
>
> I know. It is a short-hand for "what's inside N_() we see here".
> Try to come up with an equivalent that fits on a 80-char line.
OK, let's scrap the comment patch but do this instead.
If we decide to take René's "auto-literal" change, the update to the
arg help string in this patch will become a necessary preparatory
step, even though "auto-literal" will make the addition of the
PARSE_OPT_LITERAL_ARGHELP bit redundant.
-- >8 --
Subject: [PATCH] push: use PARSE_OPT_LITERAL_ARGHELP instead of unbalanced brackets
From: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Date: Thu, 02 Aug 2018 00:31:33 +0200
The option help text for the force-with-lease option to "git push"
reads like this:
$ git push -h 2>&1 | grep -e force-with-lease
--force-with-lease[=<refname>:<expect>]
which comes from having N_("refname>:<expect") as the argument help
text in the source code, with an aparent lack of "<" and ">" at both
ends.
It turns out that parse-options machinery takes the whole string and
encloses it inside a pair of "<>", to make it easier for majority
cases that uses a single token placeholder.
The help string was written in a funnily unbalanced way knowing that
the end result would balance out, by somebody who forgot the
presence of PARSE_OPT_LITERAL_ARGHELP, which is the escape hatch
mechanism designed to help such a case. We just should use the
official escape hatch instead.
Helped-by: René Scharfe <l.s.r@web.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
builtin/push.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/builtin/push.c b/builtin/push.c
index 1c28427d82..ef4032a9ef 100644
--- a/builtin/push.c
+++ b/builtin/push.c
@@ -542,9 +542,9 @@ int cmd_push(int argc, const char **argv, const char *prefix)
OPT_BIT( 0, "porcelain", &flags, N_("machine-readable output"), TRANSPORT_PUSH_PORCELAIN),
OPT_BIT('f', "force", &flags, N_("force updates"), TRANSPORT_PUSH_FORCE),
{ OPTION_CALLBACK,
- 0, CAS_OPT_NAME, &cas, N_("refname>:<expect"),
+ 0, CAS_OPT_NAME, &cas, N_("<refname>:<expect>"),
N_("require old value of ref to be at this value"),
- PARSE_OPT_OPTARG, parseopt_push_cas_option },
+ PARSE_OPT_OPTARG | PARSE_OPT_LITERAL_ARGHELP, parseopt_push_cas_option },
{ OPTION_CALLBACK, 0, "recurse-submodules", &recurse_submodules, "check|on-demand|no",
N_("control recursive pushing of submodules"),
PARSE_OPT_OPTARG, option_parse_recurse_submodules },
--
2.18.0-321-gffc6fa0e39
next prev parent reply other threads:[~2018-08-02 15:44 UTC|newest]
Thread overview: 38+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-08-01 18:43 [PATCH] push: comment on a funny unbalanced option help Junio C Hamano
2018-08-01 20:46 ` Ævar Arnfjörð Bjarmason
2018-08-01 21:48 ` Junio C Hamano
2018-08-01 22:31 ` Ævar Arnfjörð Bjarmason
2018-08-02 12:16 ` René Scharfe
2018-08-02 14:21 ` Ævar Arnfjörð Bjarmason
2018-08-02 15:06 ` René Scharfe
2018-08-02 15:16 ` René Scharfe
2018-08-02 15:24 ` Junio C Hamano
2018-08-02 15:31 ` Junio C Hamano
2018-08-02 16:50 ` René Scharfe
2018-08-02 16:54 ` Jeff King
2018-08-02 18:46 ` René Scharfe
2018-08-02 19:17 ` [PATCH 1/6] add, update-index: fix --chmod argument help René Scharfe
2018-08-02 20:41 ` Ævar Arnfjörð Bjarmason
2018-08-02 20:59 ` Ramsay Jones
2018-08-02 21:17 ` Junio C Hamano
2018-08-02 21:04 ` Andrei Rybak
2018-08-02 21:16 ` Junio C Hamano
2018-08-02 19:17 ` [PATCH 2/6] difftool: remove angular brackets from " René Scharfe
2018-08-02 19:17 ` [PATCH 3/6] pack-objects: specify --index-version argument help explicitly René Scharfe
2018-08-02 19:17 ` [PATCH 4/6] send-pack: specify --force-with-lease " René Scharfe
2018-08-02 19:18 ` [PATCH 5/6] shortlog: correct option help for -w René Scharfe
2018-08-02 19:18 ` [PATCH 6/6] parse-options: automatically infer PARSE_OPT_LITERAL_ARGHELP René Scharfe
2018-08-02 20:05 ` Junio C Hamano
2018-08-03 8:13 ` Kerry, Richard
2018-08-03 10:39 ` Kerry, Richard
2018-08-02 20:01 ` [PATCH] push: comment on a funny unbalanced option help Junio C Hamano
2018-08-02 22:38 ` René Scharfe
2018-08-03 15:29 ` Junio C Hamano
2018-08-02 15:44 ` Junio C Hamano [this message]
2018-08-02 15:59 ` Re* " René Scharfe
2018-08-02 16:23 ` Junio C Hamano
2018-08-02 20:33 ` Ævar Arnfjörð Bjarmason
2018-08-02 20:36 ` Junio C Hamano
2018-08-03 4:42 ` René Scharfe
2018-08-03 15:30 ` Junio C Hamano
2018-08-01 22:57 ` Jonathan Nieder
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=xmqq36vw4vu5.fsf_-_@gitster-ct.c.googlers.com \
--to=gitster@pobox.com \
--cc=avarab@gmail.com \
--cc=git@vger.kernel.org \
--cc=l.s.r@web.de \
/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).