push: use PARSE_OPT_LITERAL_ARGHELP instead of unbalanced brackets

avar · gitster · commit c67318ecb6dd · 2018-08-03T08:31:28.000-07:00
The option help text for the force-with-lease option to "git push"
reads like this:

    $ git push -h 2&gt;&amp;1 | grep -e force-with-lease
       --force-with-lease[=&lt;refname&gt;:&lt;expect&gt;]

which comes from having N_("refname&gt;:&lt;expect") as the argument help
text in the source code, with an aparent lack of "&lt;" and "&gt;" at both
ends.

It turns out that parse-options machinery takes the whole string and
encloses it inside a pair of "&lt;&gt;", 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.

Because ":&lt;expect&gt;" part can be omitted to ask Git to guess, it may
be more correct to spell it as "&lt;refname&gt;[:&lt;expect&gt;]", but that is
not the focus of this topic.

Signed-off-by: Ævar Arnfjörð Bjarmason &lt;avarab@gmail.com&gt;
Helped-by: René Scharfe &lt;l.s.r@web.de&gt;
Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
diff --git 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 },
