git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH v4 00/16] Finish converting git bisect into a built-in

From
Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Date
Jun 27, 2022, 19:45 UTC
Message-ID
<220627.86mtdxhnwk.gmgdl@evledraar.gmail.com>
In-Reply-To
<pull.1132.v4.git.1656354677.gitgitgadget@gmail.com>
On Mon, Jun 27 2022, Johannes Schindelin via GitGitGadget wrote:
> After three GSoC/Outreachy students spent an incredible effort on this, it
> is finally time to put a neat little bow on it.

I probably just missed this in past iterations, but there's no GSOC/Outreachy students in SOB, or even Helped-by. Was their code not usable & this is the rewrite?

If that's the case it's not clear what that has to do with the current state of this series...

Show 16 quoted lines
> Changes since v3:
>
>  * Rebased because of merge conflicts with ab/plug-leak-in-revisions.
>  * Fixed the bug that git bisect --bisect-terms 1 2 wanted to auto-start a
>    bisection if running with a git executable built at the in-between state
>    at patch "bisect: move even the command-line parsing to bisect--helper".
>    Since this bug was "fixed" in v3 by the very next patch, "bisect: teach
>    the bisect--helper command to show the correct usage strings", v4 avoids
>    introducing this bug simply by letting these two patches trade places.
>    The range-diff admittedly looks quite awful because both patches overlap
>    quite a bit in the lines they modify. The end result is the same, though,
>    the diff between v3's and v4's builtin/bisect.c would be empty if I
>    hadn't been forced to rebase.
>  * Added a test case to ensure that this bug won't be introduced again. This
>    test case is the only actual difference relative to v3 of this patch
>    series.

I think there's still a lot of unnecessary churn in this series related to migrating away from parse_options(). Your 13/16 still has a side-note that I noted as not making sense in a past iteration.

On top of "master" I tried this trivial alternative to what you're doing
here in a *lot* more lines:
	
	diff --git a/builtin/bisect--helper.c b/builtin/bisect--helper.c
	index 8a052c7111f..38b23ee5fd4 100644
	--- a/builtin/bisect--helper.c
	+++ b/builtin/bisect--helper.c
	@@ -1321,6 +1321,29 @@ int cmd_bisect__helper(int argc, const char **argv, const char *prefix)
	 		OPT_END()
	 	};
	 	struct bisect_terms terms = { .term_good = NULL, .term_bad = NULL };
	+	int i;
	+	struct strvec args = STRVEC_INIT;
	+	
	+	for (i = 0; i < argc; i++) {
	+		const char *arg = argv[i];
	+		int is_cmd = 0;
	+		const struct option *o = options;
	+
	+		for (; o->type != OPTION_END; o++)
	+			if (o->flags & PARSE_OPT_CMDMODE &&
	+			    !strcmp(o->long_name, arg)) {
	+				is_cmd = 1;
	+				break;
	+			}
	+
	+		if (is_cmd)
	+			strvec_pushf(&args, "--%s", arg);
	+		else
	+			strvec_push(&args, argv[i]);
	+
	+	}
	+	argc = args.nr;
	+	argv = args.v;
	 
	 	argc = parse_options(argc, argv, prefix, options,
	 			     git_bisect_helper_usage,
	diff --git a/git-bisect.sh b/git-bisect.sh
	index 405cf76f2a3..0fd63bf34db 100755
	--- a/git-bisect.sh
	+++ b/git-bisect.sh
	@@ -57,27 +57,10 @@ case "$#" in
	 	case "$cmd" in
	 	help)
	 		git bisect -h ;;
	-	start)
	-		git bisect--helper --bisect-start "$@" ;;
	 	bad|good|new|old|"$TERM_BAD"|"$TERM_GOOD")
	 		git bisect--helper --bisect-state "$cmd" "$@" ;;
	-	skip)
	-		git bisect--helper --bisect-skip "$@" || exit;;
	-	next)
	-		# Not sure we want "next" at the UI level anymore.
	-		git bisect--helper --bisect-next "$@" || exit ;;
	-	visualize|view)
	-		git bisect--helper --bisect-visualize "$@" || exit;;
	-	reset)
	-		git bisect--helper --bisect-reset "$@" ;;
	-	replay)
	-		git bisect--helper --bisect-replay "$@" || exit;;
	-	log)
	-		git bisect--helper --bisect-log || exit ;;
	-	run)
	-		git bisect--helper --bisect-run "$@" || exit;;
	-	terms)
	-		git bisect--helper --bisect-terms "$@" || exit;;
	+	start|skip|next|visualize|view|reset|replay|log|run|terms)
	+		git bisect--helper "--bisect-$cmd" "$@" || exit;;
	 	*)
	 		usage ;;
	 	esac

I.e. you're spending a lot of effort on working around the parse_options() API supporting "--options-like-this" but not "options-like-this". In this case it's much easier just to "fake it", isn't it?

Of course near the end of this series we'd need to adjust that, but doing so seems pretty easy, either just treat "start" as "--start", or perhaps patch the relevant bits of parse_options(), but just constructing a new command-line as I'm doing here seemed easier.

Now, there's a subtle bug in the above, I passed "view" as-is, but this will error out. I don't think your topic introduces any bugs related to that (that I've seen), but it goes to the "confidence building" part of [1].

I.e. here we're converting a bunch of code that doesn't have tests, and as seen above v.s. the relevant parts of your series doing so in a way that's not the least invasive path to that goal.

In particular I think all of 08/16, 09/16 and 13/16 (and maybe 10/16?) would be easier & more straightforward to do with such one-pass argv construction. I.e. if we make "start" a "--start" and e.g. "good" a ["--bisect-state", "good"] shouldn't this all just work without migrating bisect--helper away from parse_options()?

In that way this seems a bit like two steps forward & one step back, e.g. with the above patch we could drive 'git bisect' completion via the usual --git-completion-helper facility (with a trivial s/--//) workaround.

B.t.w. I think your tip is buggy with regards to that, i.e. don't you need a NO_PARSEOPT flag in git.c when you s/bisect--helper/bisect/ so that the completion doesn't try to use both --git-completion-helper and its own current 'bisect function' (but maybe it works by happy accident now?). In any case if you're set on converting this away from parse_options() you should add that flag in git.c.

I think as far as this conversion goes we could say "we'll use parse_options() again later", even though I think doing so is unfortunate, as I think you're going the long way around to migrate away from an API we're generally migrating to, when we can use it rather easily.

I'm mainly concerned with the lack of testing. You have a new 01/16 here, but as noted in[1] and above that's really the tip of the iceberg.

Maybe you're really confident that that was the last bug, even without testing basic things like "view" working at all, but the CL here doesn't really make for a convincing (to me) argument.

1. https://lore.kernel.org/git/220523.865ylwzgji.gmgdl@evledraar.gmail.com/
Previous: Junio C HamanoNext: Johannes Schindelin via GitGitGadget
Message 93 of 147 in “Finish converting git bisect into a built-in”
  1. 00/11 Finish converting git bisect into a built-inJohannes Schindelin via GitGitGadget, Jan 28, 2022
  2. 01/11 bisect run: fix the error messageJohannes Schindelin via GitGitGadget, Jan 28, 2022
  3. Elijah NewrenFeb 8, 2022
  4. Johannes SchindelinFeb 22, 2022
  5. 02/11 bisect--helper: retire the --no-log optionJohannes Schindelin via GitGitGadget, Jan 28, 2022
  6. 03/11 bisect--helper: really retire --bisect-next-checkJohannes Schindelin via GitGitGadget, Jan 28, 2022
  7. 04/11 bisect--helper: really retire `--bisect-autostart`Johannes Schindelin via GitGitGadget, Jan 28, 2022
  8. 05/11 bisect--helper: align the sub-command order with git-bisect.shJohannes Schindelin via GitGitGadget, Jan 28, 2022
  9. 08/11 bisect--helper: using `--bisect-state` without an argument is a bugJohannes Schindelin via GitGitGadget, Jan 28, 2022
  10. Ævar Arnfjörð BjarmasonJan 29, 2022
  11. Elijah NewrenFeb 9, 2022
  12. 06/11 bisect--helper: make `--bisect-state` optionalJohannes Schindelin via GitGitGadget, Jan 28, 2022
  13. Elijah NewrenFeb 8, 2022
  14. Johannes SchindelinFeb 22, 2022
  15. Junio C HamanoFeb 9, 2022
  16. Johannes SchindelinFeb 22, 2022
  17. 09/11 Turn `git bisect` into a full built-in.Johannes Schindelin via GitGitGadget, Jan 28, 2022
  18. Ævar Arnfjörð BjarmasonJan 29, 2022
  19. 07/11 bisect: move even the option parsing to `bisect--helper`Johannes Schindelin via GitGitGadget, Jan 28, 2022
  20. Ævar Arnfjörð BjarmasonJan 29, 2022
  21. Elijah NewrenFeb 9, 2022
  22. Johannes SchindelinFeb 22, 2022
  23. 11/11 bisect: no longer try to clean up left-over `.git/head-name` filesJohannes Schindelin via GitGitGadget, Jan 28, 2022
  24. 10/11 bisect: remove Cogito-related codeJohannes Schindelin via GitGitGadget, Jan 28, 2022
  25. Elijah NewrenJan 30, 2022
  26. Elijah NewrenFeb 9, 2022
  27. Johannes SchindelinFeb 22, 2022
  28. 00/14 Finish converting git bisect into a built-inJohannes Schindelin via GitGitGadget, Feb 22, 2022
  29. 01/14 bisect run: fix the error messageJohannes Schindelin via GitGitGadget, Feb 22, 2022
  30. 02/14 bisect: avoid double-quoting when printing the failed commandJohannes Schindelin via GitGitGadget, Feb 22, 2022
  31. 03/14 bisect--helper: retire the --no-log optionJohannes Schindelin via GitGitGadget, Feb 22, 2022
  32. 04/14 bisect--helper: really retire --bisect-next-checkJohannes Schindelin via GitGitGadget, Feb 22, 2022
  33. 05/14 bisect--helper: really retire `--bisect-autostart`Johannes Schindelin via GitGitGadget, Feb 22, 2022
  34. 06/14 bisect--helper: using `--bisect-state` without an argument is a bugJohannes Schindelin via GitGitGadget, Feb 22, 2022
  35. 07/14 bisect--helper: align the sub-command order with git-bisect.shJohannes Schindelin via GitGitGadget, Feb 22, 2022
  36. 08/14 bisect--helper: make `--bisect-state` optionalJohannes Schindelin via GitGitGadget, Feb 22, 2022
  37. 09/14 bisect--helper: move the `BISECT_STATE` case to the endJohannes Schindelin via GitGitGadget, Feb 22, 2022
  38. 10/14 bisect--helper: return only correct exit codes in `cmd_*()`Johannes Schindelin via GitGitGadget, Feb 22, 2022
  39. 14/14 bisect: no longer try to clean up left-over `.git/head-name` filesJohannes Schindelin via GitGitGadget, Feb 22, 2022
  40. 13/14 bisect: remove Cogito-related codeJohannes Schindelin via GitGitGadget, Feb 22, 2022
  41. 11/14 bisect: move even the option parsing to `bisect--helper`Johannes Schindelin via GitGitGadget, Feb 22, 2022
  42. Ævar Arnfjörð BjarmasonFeb 23, 2022
  43. Johannes SchindelinFeb 25, 2022
  44. Ævar Arnfjörð BjarmasonFeb 25, 2022
  45. 12/14 Turn `git bisect` into a full built-inJohannes Schindelin via GitGitGadget, Feb 22, 2022
  46. Elijah NewrenFeb 23, 2022
  47. Johannes SchindelinFeb 25, 2022
  48. Junio C HamanoFeb 23, 2022
  49. Johannes SchindelinFeb 25, 2022
  50. Ævar Arnfjörð BjarmasonFeb 25, 2022
  51. 00/15 Finish converting git bisect into a built-inJohannes Schindelin via GitGitGadget, May 21, 2022
  52. 01/15 bisect run: fix the error messageJohannes Schindelin via GitGitGadget, May 21, 2022
  53. 02/15 bisect: avoid double-quoting when printing the failed commandJohannes Schindelin via GitGitGadget, May 21, 2022
  54. 03/15 bisect--helper: retire the --no-log optionJohannes Schindelin via GitGitGadget, May 21, 2022
  55. 05/15 bisect--helper: really retire `--bisect-autostart`Johannes Schindelin via GitGitGadget, May 21, 2022
  56. 06/15 bisect--helper: using `--bisect-state` without an argument is a bugJohannes Schindelin via GitGitGadget, May 21, 2022
  57. 04/15 bisect--helper: really retire --bisect-next-checkJohannes Schindelin via GitGitGadget, May 21, 2022
  58. 07/15 bisect--helper: align the sub-command order with git-bisect.shJohannes Schindelin via GitGitGadget, May 21, 2022
  59. 08/15 bisect--helper: make `--bisect-state` optionalJohannes Schindelin via GitGitGadget, May 21, 2022
  60. 10/15 bisect--helper: return only correct exit codes in `cmd_*()`Johannes Schindelin via GitGitGadget, May 21, 2022
  61. Ævar Arnfjörð BjarmasonMay 21, 2022
  62. 09/15 bisect--helper: move the `BISECT_STATE` case to the endJohannes Schindelin via GitGitGadget, May 21, 2022
  63. 12/15 bisect: teach the `bisect--helper` command to show the correct usage stringsJohannes Schindelin via GitGitGadget, May 21, 2022
  64. 11/15 bisect: move even the command-line parsing to `bisect--helper`Johannes Schindelin via GitGitGadget, May 21, 2022
  65. Ævar Arnfjörð BjarmasonMay 21, 2022
  66. 14/15 bisect: remove Cogito-related codeJohannes Schindelin via GitGitGadget, May 21, 2022
  67. 13/15 Turn `git bisect` into a full built-inJohannes Schindelin via GitGitGadget, May 21, 2022
  68. 15/15 bisect: no longer try to clean up left-over `.git/head-name` filesJohannes Schindelin via GitGitGadget, May 21, 2022
  69. Bagas SanjayaMay 22, 2022
  70. Ævar Arnfjörð BjarmasonMay 23, 2022
  71. 00/16 Finish converting git bisect into a built-inJohannes Schindelin via GitGitGadget, Jun 27, 2022
  72. 02/16 bisect run: fix the error messageJohannes Schindelin via GitGitGadget, Jun 27, 2022
  73. 01/16 bisect: verify that a bogus option won't try to start a bisectionJohannes Schindelin via GitGitGadget, Jun 27, 2022
  74. Junio C HamanoJun 28, 2022
  75. 04/16 bisect--helper: retire the --no-log optionJohannes Schindelin via GitGitGadget, Jun 27, 2022
  76. 05/16 bisect--helper: really retire --bisect-next-checkJohannes Schindelin via GitGitGadget, Jun 27, 2022
  77. 03/16 bisect: avoid double-quoting when printing the failed commandJohannes Schindelin via GitGitGadget, Jun 27, 2022
  78. 07/16 bisect--helper: using `--bisect-state` without an argument is a bugJohannes Schindelin via GitGitGadget, Jun 27, 2022
  79. 06/16 bisect--helper: really retire `--bisect-autostart`Johannes Schindelin via GitGitGadget, Jun 27, 2022
  80. 08/16 bisect--helper: align the sub-command order with git-bisect.shJohannes Schindelin via GitGitGadget, Jun 27, 2022
  81. 09/16 bisect--helper: make `--bisect-state` optionalJohannes Schindelin via GitGitGadget, Jun 27, 2022
  82. 10/16 bisect--helper: move the `BISECT_STATE` case to the endJohannes Schindelin via GitGitGadget, Jun 27, 2022
  83. 11/16 bisect--helper: return only correct exit codes in `cmd_*()`Johannes Schindelin via GitGitGadget, Jun 27, 2022
  84. Ævar Arnfjörð BjarmasonJun 27, 2022
  85. 12/16 bisect: teach the `bisect--helper` command to show the correct usage stringsJohannes Schindelin via GitGitGadget, Jun 27, 2022
  86. Junio C HamanoJun 27, 2022
  87. 14/16 Turn `git bisect` into a full built-inJohannes Schindelin via GitGitGadget, Jun 27, 2022
  88. Junio C HamanoJun 27, 2022
  89. 16/16 bisect: no longer try to clean up left-over `.git/head-name` filesJohannes Schindelin via GitGitGadget, Jun 27, 2022
  90. 13/16 bisect: move even the command-line parsing to `bisect--helper`Johannes Schindelin via GitGitGadget, Jun 27, 2022
  91. 15/16 bisect: remove Cogito-related codeJohannes Schindelin via GitGitGadget, Jun 27, 2022
  92. Junio C HamanoJun 27, 2022
  93. Ævar Arnfjörð BjarmasonJun 27, 2022
  94. 00/16 Finish converting git bisect into a built-inJohannes Schindelin via GitGitGadget, Aug 27, 2022
  95. 01/16 bisect--helper: retire the --no-log optionJohannes Schindelin via GitGitGadget, Aug 27, 2022
  96. 03/16 bisect--helper: really retire `--bisect-autostart`Johannes Schindelin via GitGitGadget, Aug 27, 2022
  97. 02/16 bisect--helper: really retire --bisect-next-checkJohannes Schindelin via GitGitGadget, Aug 27, 2022
  98. 04/16 bisect--helper: simplify exit code computationJohannes Schindelin via GitGitGadget, Aug 27, 2022
  99. Junio C HamanoAug 28, 2022
  100. 05/16 bisect--helper: make `terms` an explicit singletonJohannes Schindelin via GitGitGadget, Aug 27, 2022
  101. Junio C HamanoAug 28, 2022
  102. Johannes SchindelinAug 29, 2022
  103. Junio C HamanoAug 29, 2022
  104. Ævar Arnfjörð BjarmasonAug 29, 2022
  105. Johannes SchindelinAug 29, 2022
  106. Junio C HamanoAug 29, 2022
  107. 06/16 bisect--helper: make the order consistently `argc, argv`Johannes Schindelin via GitGitGadget, Aug 27, 2022
  108. Junio C HamanoAug 28, 2022
  109. 07/16 bisect--helper: migrate to OPT_SUBCOMMAND()Johannes Schindelin via GitGitGadget, Aug 27, 2022
  110. Ævar Arnfjörð BjarmasonAug 29, 2022
  111. Johannes SchindelinAug 30, 2022
  112. 08/16 bisect: verify that a bogus option won't try to start a bisectionJohannes Schindelin via GitGitGadget, Aug 27, 2022
  113. 09/16 bisect run: fix the error messageJohannes Schindelin via GitGitGadget, Aug 27, 2022
  114. Junio C HamanoAug 28, 2022
  115. Johannes SchindelinAug 29, 2022
  116. 10/16 bisect: avoid double-quoting when printing the failed commandJohannes Schindelin via GitGitGadget, Aug 27, 2022
  117. 11/16 bisect--helper: calling `bisect_state()` without an argument is a bugJohannes Schindelin via GitGitGadget, Aug 27, 2022
  118. Ævar Arnfjörð BjarmasonAug 29, 2022
  119. Johannes SchindelinAug 30, 2022
  120. 15/16 bisect: remove Cogito-related codeJohannes Schindelin via GitGitGadget, Aug 27, 2022
  121. 14/16 Turn `git bisect` into a full built-inJohannes Schindelin via GitGitGadget, Aug 27, 2022
  122. 13/16 bisect: move even the command-line parsing to `bisect--helper`Johannes Schindelin via GitGitGadget, Aug 27, 2022
  123. 12/16 bisect--helper: make `state` optionalJohannes Schindelin via GitGitGadget, Aug 27, 2022
  124. 16/16 bisect: no longer try to clean up left-over `.git/head-name` filesJohannes Schindelin via GitGitGadget, Aug 27, 2022
  125. 00/16 Finish converting git bisect into a built-inJohannes Schindelin via GitGitGadget, Aug 30, 2022
  126. 01/16 bisect--helper: retire the --no-log optionJohannes Schindelin via GitGitGadget, Aug 30, 2022
  127. 02/16 bisect--helper: really retire --bisect-next-checkJohannes Schindelin via GitGitGadget, Aug 30, 2022
  128. 03/16 bisect--helper: really retire `--bisect-autostart`Johannes Schindelin via GitGitGadget, Aug 30, 2022
  129. 04/16 bisect--helper: simplify exit code computationJohannes Schindelin via GitGitGadget, Aug 30, 2022
  130. 06/16 bisect--helper: make the order consistently `argc, argv`Johannes Schindelin via GitGitGadget, Aug 30, 2022
  131. 05/16 bisect--helper: make `terms` an explicit singletonJohannes Schindelin via GitGitGadget, Aug 30, 2022
  132. Junio C HamanoAug 30, 2022
  133. Junio C HamanoAug 30, 2022
  134. 07/16 bisect--helper: migrate to OPT_SUBCOMMAND()Johannes Schindelin via GitGitGadget, Aug 30, 2022
  135. 08/16 bisect: verify that a bogus option won't try to start a bisectionJohannes Schindelin via GitGitGadget, Aug 30, 2022
  136. 09/16 bisect run: fix the error messageJohannes Schindelin via GitGitGadget, Aug 30, 2022
  137. 10/16 bisect: avoid double-quoting when printing the failed commandJohannes Schindelin via GitGitGadget, Aug 30, 2022
  138. 11/16 bisect--helper: calling `bisect_state()` without an argument is a bugJohannes Schindelin via GitGitGadget, Aug 30, 2022
  139. 12/16 bisect--helper: make `state` optionalJohannes Schindelin via GitGitGadget, Aug 30, 2022
  140. 13/16 bisect: move even the command-line parsing to `bisect--helper`Johannes Schindelin via GitGitGadget, Aug 30, 2022
  141. 14/16 Turn `git bisect` into a full built-inJohannes Schindelin via GitGitGadget, Aug 30, 2022
  142. 15/16 bisect: remove Cogito-related codeJohannes Schindelin via GitGitGadget, Aug 30, 2022
  143. 16/16 bisect: no longer try to clean up left-over `.git/head-name` filesJohannes Schindelin via GitGitGadget, Aug 30, 2022
  144. Junio C HamanoSep 13, 2022
  145. Fwd: [PATCH 00/11] Finish converting git bisect into a built-inMiriam R., Jan 28, 2022
  146. Johannes SchindelinJan 28, 2022
  147. Miriam R.Jan 28, 2022

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.