From: Jeff King <peff@peff.net>
To: "Lukáš Doktor" <ldoktor@redhat.com>
Cc: Christian Couder <chriscool@tuxfamily.org>, git@vger.kernel.org
Subject: Re: "git bisect run" strips "--log" from the list of arguments
Date: Fri, 4 Nov 2022 05:45:52 -0400 [thread overview]
Message-ID: <Y2TfUFkLUa2tHdS7@coredump.intra.peff.net> (raw)
In-Reply-To: <1cb1c033-0525-7e62-8c09-81019bf26060@redhat.com>
On Fri, Nov 04, 2022 at 07:31:26AM +0100, Lukáš Doktor wrote:
> Steps to Reproduce:
>
> 1. git bisect start BAD GOOD
> 2. git bisect run ./myscript arg1 --log arg2 --log -- arg3 --log arg4
>
> Results with 2.34.1:
>
> running './myscript' 'arg1' 'arg2' '--' 'arg3' '--log' 'arg4'
>
> Results with 2.33.0:
>
> running ./myscript arg1 --log arg2 --log -- arg3 --log arg4
Thanks for an easy reproduction recipe. I used this as an easy-to-see
test case, which works in any repo:
git bisect start HEAD HEAD~2 >/dev/null 2>&1
git bisect bisect run echo --log 2>&1 | grep running
> Is this expected? In https://bugzilla.redhat.com/show_bug.cgi?id=2139883 Todd suggested it might be related to
>
> d1bbbe45df (bisect--helper: reimplement `bisect_run` shell function in C, 2021-09-13)
>
> but I haven't tried it myself.
Yes, it bisects to that commit. +cc Christian, who mentored this gsoc
project.
I think the problem is that we are now feeding the arguments to
parse_options() in git bisect--helper, and it doesn't realize that it
needs to stop after seeing that we are in "run" mode. And because
"--log" is an option to git-bisect--helper (it is the opposite of
"--no-log"), it is consumed there.
As you noticed, the "--" stops parsing, so the one between "arg3" and
"arg4" is preserved.
It feels like the invocation of bisect--helper ought to be passing "--"
itself to indicate the end of options, like:
diff --git a/git-bisect.sh b/git-bisect.sh
index 405cf76f2a..bd69e8d389 100755
--- a/git-bisect.sh
+++ b/git-bisect.sh
@@ -75,7 +75,7 @@ case "$#" in
log)
git bisect--helper --bisect-log || exit ;;
run)
- git bisect--helper --bisect-run "$@" || exit;;
+ git bisect--helper --bisect-run -- "$@" || exit;;
terms)
git bisect--helper --bisect-terms "$@" || exit;;
*)
but there are two oddities:
1. We use PARSE_OPT_KEEP_DASHDASH, so it ends up in the final command.
We might be able to drop that; it goes back to 06f5608c14
(bisect--helper: `bisect_start` shell function partially in C,
2019-01-02), but I'm not sure which other modes might be relying on
it.
2. We are forwarding "$@" from the user. I'm not sure if they would
ever use "--" themselves to signal end of options. We might be OK
because "bisect run" does not take any other options (as far as I
know), so nobody would ever need to do that. I.e., I don't think
anybody would do:
git bisect run -- mycommand
because it will treat the "--" literally as a command name.
So we could possibly just add it in the script as above, and then
unconditionally eat it in the C program. I.e., add this hunk:
diff --git a/builtin/bisect--helper.c b/builtin/bisect--helper.c
index 28ef7ec2a4..2d6c77df2e 100644
--- a/builtin/bisect--helper.c
+++ b/builtin/bisect--helper.c
@@ -1377,6 +1377,11 @@ int cmd_bisect__helper(int argc, const char **argv, const char *prefix)
res = bisect_visualize(&terms, argv, argc);
break;
case BISECT_RUN:
+ /* consume "--" added by git-bisect.sh, but left by parse-options */
+ if (argc) {
+ argc--;
+ argv++;
+ }
if (!argc)
return error(_("bisect run failed: no command provided."));
get_terms(&terms);
It feels a bit hacky, but I think it would work, and there's no
possibility of disrupting the other modes.
The other option is probably an elaborate parse-options callback, like
the diff below. But it's pretty horrible, too.
diff --git a/builtin/bisect--helper.c b/builtin/bisect--helper.c
index 28ef7ec2a4..16f71fd59c 100644
--- a/builtin/bisect--helper.c
+++ b/builtin/bisect--helper.c
@@ -1277,22 +1277,49 @@ static int bisect_run(struct bisect_terms *terms, const char **argv, int argc)
return res;
}
+enum bisect_cmdmode {
+ BISECT_RESET = 1,
+ BISECT_NEXT_CHECK,
+ BISECT_TERMS,
+ BISECT_START,
+ BISECT_AUTOSTART,
+ BISECT_NEXT,
+ BISECT_STATE,
+ BISECT_LOG,
+ BISECT_REPLAY,
+ BISECT_SKIP,
+ BISECT_VISUALIZE,
+ BISECT_RUN,
+};
+
+static int run_argc;
+static const char **run_argv;
+
+static int parse_opt_bisect_run(struct parse_opt_ctx_t *ctx,
+ const struct option *opt,
+ const char *arg, int unset)
+{
+ enum bisect_cmdmode *cmdmode = opt->value;
+
+ BUG_ON_OPT_ARG(arg);
+ BUG_ON_OPT_NEG(unset);
+
+ *cmdmode = BISECT_RUN;
+ /*
+ * Yuck, parse-options has no way to say "done, and stop parsing";
+ * it will keep going if we still have any argc left. So we have to
+ * stash the rest of the options ourselves.
+ */
+ run_argc = ctx->argc - 1;
+ run_argv = ctx->argv + 1;
+ ctx->argc = 1;
+
+ return 0;
+}
+
int cmd_bisect__helper(int argc, const char **argv, const char *prefix)
{
- enum {
- BISECT_RESET = 1,
- BISECT_NEXT_CHECK,
- BISECT_TERMS,
- BISECT_START,
- BISECT_AUTOSTART,
- BISECT_NEXT,
- BISECT_STATE,
- BISECT_LOG,
- BISECT_REPLAY,
- BISECT_SKIP,
- BISECT_VISUALIZE,
- BISECT_RUN,
- } cmdmode = 0;
+ enum bisect_cmdmode cmdmode = 0;
int res = 0, nolog = 0;
struct option options[] = {
OPT_CMDMODE(0, "bisect-reset", &cmdmode,
@@ -1315,8 +1342,10 @@ int cmd_bisect__helper(int argc, const char **argv, const char *prefix)
N_("skip some commits for checkout"), BISECT_SKIP),
OPT_CMDMODE(0, "bisect-visualize", &cmdmode,
N_("visualize the bisection"), BISECT_VISUALIZE),
- OPT_CMDMODE(0, "bisect-run", &cmdmode,
- N_("use <cmd>... to automatically bisect"), BISECT_RUN),
+ {OPTION_LOWLEVEL_CALLBACK, 0, "bisect-run", &cmdmode, NULL,
+ N_("use <cmd>... to automatically bisect"),
+ PARSE_OPT_NOARG|PARSE_OPT_NONEG,
+ NULL, 0, parse_opt_bisect_run},
OPT_BOOL(0, "no-log", &nolog,
N_("no log for BISECT_WRITE")),
OPT_END()
@@ -1377,10 +1406,10 @@ int cmd_bisect__helper(int argc, const char **argv, const char *prefix)
res = bisect_visualize(&terms, argv, argc);
break;
case BISECT_RUN:
- if (!argc)
+ if (!run_argc)
return error(_("bisect run failed: no command provided."));
get_terms(&terms);
- res = bisect_run(&terms, argv, argc);
+ res = bisect_run(&terms, run_argv, run_argc);
break;
default:
BUG("unknown subcommand %d", cmdmode);
-Peff
next prev parent reply other threads:[~2022-11-04 9:45 UTC|newest]
Thread overview: 106+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-11-04 6:31 "git bisect run" strips "--log" from the list of arguments Lukáš Doktor
2022-11-04 9:45 ` Jeff King [this message]
2022-11-04 11:10 ` Đoàn Trần Công Danh
2022-11-04 12:51 ` Jeff King
2022-11-04 11:36 ` Ævar Arnfjörð Bjarmason
2022-11-04 12:45 ` Jeff King
2022-11-04 13:07 ` Ævar Arnfjörð Bjarmason
2022-11-04 12:37 ` SZEDER Gábor
2022-11-04 12:44 ` Jeff King
2022-11-04 11:40 ` [PATCH 0/3] Convert git-bisect--helper to OPT_SUBCOMMAND Đoàn Trần Công Danh
2022-11-04 11:40 ` [PATCH 1/3] bisect--helper: remove unused options Đoàn Trần Công Danh
2022-11-04 12:53 ` Jeff King
2022-11-04 11:40 ` [PATCH 2/3] bisect--helper: move all subcommands into their own functions Đoàn Trần Công Danh
2022-11-04 12:55 ` Jeff King
2022-11-04 13:32 ` Ævar Arnfjörð Bjarmason
2022-11-04 14:03 ` Đoàn Trần Công Danh
2022-11-04 11:40 ` [PATCH 3/3] bisect--helper: parse subcommand with OPT_SUBCOMMAND Đoàn Trần Công Danh
2022-11-04 13:00 ` Jeff King
2022-11-04 13:46 ` Ævar Arnfjörð Bjarmason
2022-11-04 14:07 ` Đoàn Trần Công Danh
2022-11-04 13:55 ` [PATCH 0/3] Convert git-bisect--helper to OPT_SUBCOMMAND Ævar Arnfjörð Bjarmason
2022-11-05 17:03 ` [PATCH v2 " Đoàn Trần Công Danh
2022-11-05 17:03 ` [PATCH v2 1/3] bisect--helper: remove unused options Đoàn Trần Công Danh
2022-11-05 17:03 ` [PATCH v2 2/3] bisect--helper: move all subcommands into their own functions Đoàn Trần Công Danh
2022-11-05 17:13 ` Đoàn Trần Công Danh
2022-11-05 17:03 ` [PATCH v2 3/3] bisect--helper: parse subcommand with OPT_SUBCOMMAND Đoàn Trần Công Danh
2022-11-05 17:07 ` [PATCH 00/13] Turn git-bisect to be builtin Đoàn Trần Công Danh
2022-11-05 17:07 ` [PATCH 01/13] bisect tests: test for v2.30.0 "bisect run" regressions Đoàn Trần Công Danh
2022-11-07 21:31 ` Ævar Arnfjörð Bjarmason
2022-11-08 1:17 ` Đoàn Trần Công Danh
2022-11-05 17:07 ` [PATCH 02/13] bisect: refactor bisect_run() to match CodingGuidelines Đoàn Trần Công Danh
2022-11-05 17:07 ` [PATCH 03/13] bisect--helper: pass arg[cv] down to do_bisect_run Đoàn Trần Công Danh
2022-11-05 17:07 ` [PATCH 04/13] bisect: fix output regressions in v2.30.0 Đoàn Trần Công Danh
2022-11-05 17:07 ` [PATCH 05/13] bisect run: keep some of the post-v2.30.0 output Đoàn Trần Công Danh
2022-11-07 21:40 ` Ævar Arnfjörð Bjarmason
2022-11-08 1:26 ` Đoàn Trần Công Danh
2022-11-08 3:11 ` Ævar Arnfjörð Bjarmason
2022-11-05 17:07 ` [PATCH 06/13] bisect--helper: remove unused arguments from do_bisect_run Đoàn Trần Công Danh
2022-11-05 17:07 ` [PATCH 07/13] bisect--helper: pretend we're real bisect when report error Đoàn Trần Công Danh
2022-11-07 21:29 ` Ævar Arnfjörð Bjarmason
2022-11-05 17:07 ` [PATCH 08/13] bisect test: test exit codes on bad usage Đoàn Trần Công Danh
2022-11-05 17:07 ` [PATCH 09/13] bisect--helper: emit usage for "git bisect" Đoàn Trần Công Danh
2022-11-05 17:07 ` [PATCH 10/13] bisect--helper: make `state` optional Đoàn Trần Công Danh
2022-11-05 17:07 ` [PATCH 11/13] bisect--helper: remove subcommand state Đoàn Trần Công Danh
2022-11-07 21:45 ` Ævar Arnfjörð Bjarmason
2022-11-08 1:27 ` Đoàn Trần Công Danh
2022-11-05 17:07 ` [PATCH 12/13] bisect--helper: log: allow arbitrary number of arguments Đoàn Trần Công Danh
2022-11-05 17:07 ` [PATCH 13/13] Turn `git bisect` into a full built-in Đoàn Trần Công Danh
2022-11-05 23:18 ` [PATCH v2 0/3] Convert git-bisect--helper to OPT_SUBCOMMAND Taylor Blau
2022-11-10 16:36 ` [PATCH v3 " Đoàn Trần Công Danh
2022-11-10 16:36 ` [PATCH v3 1/3] bisect--helper: remove unused options Đoàn Trần Công Danh
2022-11-11 12:42 ` Ævar Arnfjörð Bjarmason
2022-11-10 16:36 ` [PATCH v3 2/3] bisect--helper: move all subcommands into their own functions Đoàn Trần Công Danh
2022-11-11 13:51 ` Ævar Arnfjörð Bjarmason
2022-11-10 16:36 ` [PATCH v3 3/3] bisect--helper: parse subcommand with OPT_SUBCOMMAND Đoàn Trần Công Danh
2022-11-10 16:36 ` [PATCH v2 00/11] Turn git-bisect to be builtin Đoàn Trần Công Danh
2022-11-10 16:36 ` [PATCH v2 01/11] bisect tests: test for v2.30.0 "bisect run" regressions Đoàn Trần Công Danh
2022-11-10 16:36 ` [PATCH v2 02/11] bisect: refactor bisect_run() to match CodingGuidelines Đoàn Trần Công Danh
2022-11-10 16:36 ` [PATCH v2 03/11] bisect: fix output regressions in v2.30.0 Đoàn Trần Công Danh
2022-11-10 16:36 ` [PATCH v2 04/11] bisect run: keep some of the post-v2.30.0 output Đoàn Trần Công Danh
2022-11-10 16:36 ` [PATCH v2 05/11] bisect-run: verify_good: account for non-negative exit status Đoàn Trần Công Danh
2022-11-10 16:36 ` [PATCH v2 06/11] bisect--helper: identify as bisect when report error Đoàn Trần Công Danh
2022-11-10 16:36 ` [PATCH v2 07/11] bisect test: test exit codes on bad usage Đoàn Trần Công Danh
2022-11-10 16:36 ` [PATCH v2 08/11] bisect--helper: emit usage for "git bisect" Đoàn Trần Công Danh
2022-11-10 16:36 ` [PATCH v2 09/11] bisect--helper: handle states directly Đoàn Trần Công Danh
2022-11-10 16:36 ` [PATCH v2 10/11] bisect--helper: log: allow arbitrary number of arguments Đoàn Trần Công Danh
2022-11-11 14:01 ` Ævar Arnfjörð Bjarmason
2022-11-10 16:36 ` [PATCH v2 11/11] Turn `git bisect` into a full built-in Đoàn Trần Công Danh
2022-11-11 13:53 ` Ævar Arnfjörð Bjarmason
2022-11-11 15:37 ` Jeff King
2022-11-11 21:09 ` Ævar Arnfjörð Bjarmason
2022-11-11 22:07 ` [PATCH v2 00/11] Turn git-bisect to be builtin Taylor Blau
2022-11-15 19:18 ` Taylor Blau
2022-11-15 19:36 ` Jeff King
2022-11-15 19:40 ` Taylor Blau
2022-11-11 12:32 ` [PATCH v3 0/3] Convert git-bisect--helper to OPT_SUBCOMMAND Ævar Arnfjörð Bjarmason
2022-11-04 13:22 ` [PATCH 00/13] bisect: v2.30.0 "run" regressions + make it built-in Ævar Arnfjörð Bjarmason
2022-11-04 13:22 ` [PATCH 01/13] bisect tests: test for v2.30.0 "bisect run" regressions Ævar Arnfjörð Bjarmason
2022-11-04 13:22 ` [PATCH 02/13] bisect: refactor bisect_run() to match CodingGuidelines Ævar Arnfjörð Bjarmason
2022-11-04 13:22 ` [PATCH 03/13] bisect: fix output regressions in v2.30.0 Ævar Arnfjörð Bjarmason
2022-11-04 13:22 ` [PATCH 04/13] bisect run: fix "--log" eating regression " Ævar Arnfjörð Bjarmason
2022-11-04 13:22 ` [PATCH 05/13] bisect run: keep some of the post-v2.30.0 output Ævar Arnfjörð Bjarmason
2022-11-04 13:22 ` [PATCH 06/13] bisect test: test exit codes on bad usage Ævar Arnfjörð Bjarmason
2022-11-04 13:22 ` [PATCH 07/13] bisect--helper: emit usage for "git bisect" Ævar Arnfjörð Bjarmason
2022-11-04 13:22 ` [PATCH 08/13] bisect--helper: have all functions take state, argc, argv, prefix Ævar Arnfjörð Bjarmason
2022-11-04 13:22 ` [PATCH 09/13] parse-options API: don't restrict OPT_SUBCOMMAND() to one *_fn type Ævar Arnfjörð Bjarmason
2022-11-05 8:32 ` René Scharfe
2022-11-05 11:34 ` Đoàn Trần Công Danh
2022-11-05 21:32 ` Phillip Wood
2022-11-05 13:52 ` Ævar Arnfjörð Bjarmason
2022-11-05 16:36 ` Phillip Wood
2022-11-05 21:59 ` Ævar Arnfjörð Bjarmason
2022-11-05 17:26 ` René Scharfe
2022-11-05 22:33 ` Ævar Arnfjörð Bjarmason
2022-11-06 8:25 ` René Scharfe
2022-11-06 13:28 ` Ævar Arnfjörð Bjarmason
2022-11-12 10:42 ` René Scharfe
2022-11-12 16:34 ` Jeff King
2022-11-12 16:55 ` Ævar Arnfjörð Bjarmason
2022-11-13 17:31 ` René Scharfe
2022-11-04 13:22 ` [PATCH 10/13] bisect--helper: remove dead --bisect-{next-check,autostart} code Ævar Arnfjörð Bjarmason
2022-11-04 13:22 ` [PATCH 11/13] bisect--helper: convert to OPT_SUBCOMMAND_CB() Ævar Arnfjörð Bjarmason
2022-11-04 13:22 ` [PATCH 12/13] bisect--helper: make `state` optional Ævar Arnfjörð Bjarmason
2022-11-04 13:22 ` [PATCH 13/13] Turn `git bisect` into a full built-in Ævar Arnfjörð Bjarmason
2022-11-05 0:13 ` [PATCH 00/13] bisect: v2.30.0 "run" regressions + make it built-in Taylor Blau
2022-11-10 12:50 ` Johannes Schindelin
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=Y2TfUFkLUa2tHdS7@coredump.intra.peff.net \
--to=peff@peff.net \
--cc=chriscool@tuxfamily.org \
--cc=git@vger.kernel.org \
--cc=ldoktor@redhat.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 read-only IMAP folder(s) and NNTP newsgroup(s).