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

Re: [PATCH 2/3] bisect--helper: move all subcommands into their own functions

From
Đoàn Trần Công Danh <congdanhqx@gmail.com>
Date
Nov 4, 2022, 14:03 UTC
Message-ID
<Y2UbrCzTIvIbPbgX@danh.dev>
In-Reply-To
<221104.86r0yiygtd.gmgdl@evledraar.gmail.com>
On 2022-11-04 14:32:34+0100, Ævar Arnfjörð Bjarmason <avarab@gmail.com> wrote:
Show 46 quoted lines
> 
> On Fri, Nov 04 2022, Đoàn Trần Công Danh wrote:
> 
> > In a later change, we will use OPT_SUBCOMMAND to parse sub-commands to
> > avoid consuming non-option opts.
> >
> > Since OPT_SUBCOMMAND needs a function pointer to operate,
> > let's move it now.
> 
> As shown in
> https://lore.kernel.org/git/patch-11.13-d261c32ddd7-20221104T132117Z-avarab@gmail.com/
> this can be much nicer in terms of avoiding these wrappers if we jsut
> teach parse-options.c to take our custom signature'd callback, but...
> 
> > +static int cmd_bisect__reset(int argc, const char **argv, const char *prefix UNUSED)
> > +static int cmd_bisect__terms(int argc, const char **argv, const char *prefix UNUSED)
> > +static int cmd_bisect__start(int argc, const char **argv, const char *prefix UNUSED)
> ....
> 
> >  	switch (cmdmode) {
> >  	case BISECT_RESET:
> > -		if (argc > 1)
> > -			return error(_("--bisect-reset requires either no argument or a commit"));
> > -		res = bisect_reset(argc ? argv[0] : NULL);
> > +		res = cmd_bisect__reset(argc, argv, prefix);
> >  		break;
> >  	case BISECT_TERMS:
> > -		if (argc > 1)
> > -			return error(_("--bisect-terms requires 0 or 1 argument"));
> > -		res = bisect_terms(&terms, argc == 1 ? argv[0] : NULL);
> > +		res = cmd_bisect__terms(argc, argv, prefix);
> >  		break;
> >  	case BISECT_START:
> > -		set_terms(&terms, "bad", "good");
> > -		res = bisect_start(&terms, argv, argc);
> > +		res = cmd_bisect__start(argc, argv, prefix);
> 
> If we're not going to do that this isn't too bad actually. s noted in my
> CL
> (https://lore.kernel.org/git/cover-00.13-00000000000-20221104T132117Z-avarab@gmail.com/)
> I started seeing if I could cut Johannes's built-in-bisect series down
> to size so we could have it merged sooner than later.
> 
> It ended up refactoring every single user of "terms" to take the
> file-global instead of the variable on the stack, but this shows that
> that's not something we need, even without a new parse-options.c API.

Yes, I saw your patches, but I think adding a whole new parse-options.c API is a lot (taking a side the type-safety the new API introduced). If I were doing the new parse-options API without the type safety, I probably make an API like:

	int (*subcommand_fn)(int argc, const char **argv, const char *prefix, void *ctx)

We would still have a non-safe 4th argument, but we won't need a new typedef and picking_fn in every source file.

Show 7 quoted lines
> B.t.w. you can cut down more on the verbosity by doing:
> 
> 	struct bisect_terms terms = { 0 };
> Which is the same as "{ .term_good = NULL, .term_bad = NULL }". I left
> it in place in my version because I'm explicitly trying to avoid
> touching anything we don't need to for a bisect built-in, but if we're
> refactoring this anyway...

Sure. I'll see which direction is favourable by other people. Yes, the free_terms is the one that increase the size of this patch,

Show 11 quoted lines
> I also think this could be further reduced in size a lot if we go for
> your approach, i.e. make a helper function that these call, like:
> 
> 	if (have_err)
> 		return error(_(error_msg));
>         if (set_terms)
> 		set_terms(&terms, "bad", "good");
> 	if (get_terms)
> 		get_terms(&terms);
> 	res = !strcmp(iam, "terms") ? bisect_terms(&terms, argc == 1 ? argv[0] : NULL) :
>         	!strcmp(iam, "start") ? bisect_start(&terms, argv, argc) :

However, if we're doing this, aren't we getting back to step 1: strcmp to a list of subcommand instead of using OPT_SUBCOMMAND?

Show 12 quoted lines
>                 [...];
> 	free_terms(&terms);
> 	return res;
> 
> Then e.g. the body of "terms" is just:
> 
> 	return that_helper(argc, argv, prefix, "terms", /* iam */
>         		  argc > 1, /* have err */ N_("--bisect-terms requires 0 or 1 argument"), /* err msg */
>                           0, 0, /* get terms and set terms */);
> 
> Etc., I think that might be worth it, as almost all of the contents of
> these functions is just copy/pasted...
-- 
Danh
Previous: Ævar Arnfjörð BjarmasonNext: Đoàn Trần Công Danh
Message 16 of 106 in “"git bisect run" strips "--log" from the list of arguments”
  1. Lukáš DoktorNov 4, 2022
  2. Jeff KingNov 4, 2022
  3. Đoàn Trần Công DanhNov 4, 2022
  4. Jeff KingNov 4, 2022
  5. Ævar Arnfjörð BjarmasonNov 4, 2022
  6. Jeff KingNov 4, 2022
  7. Ævar Arnfjörð BjarmasonNov 4, 2022
  8. SZEDER GáborNov 4, 2022
  9. Jeff KingNov 4, 2022
  10. 0/3 Convert git-bisect--helper to OPT_SUBCOMMANDĐoàn Trần Công Danh, Nov 4, 2022
  11. 1/3 bisect--helper: remove unused optionsĐoàn Trần Công Danh, Nov 4, 2022
  12. Jeff KingNov 4, 2022
  13. 2/3 bisect--helper: move all subcommands into their own functionsĐoàn Trần Công Danh, Nov 4, 2022
  14. Jeff KingNov 4, 2022
  15. Ævar Arnfjörð BjarmasonNov 4, 2022
  16. Đoàn Trần Công DanhNov 4, 2022
  17. 3/3 bisect--helper: parse subcommand with OPT_SUBCOMMANDĐoàn Trần Công Danh, Nov 4, 2022
  18. Jeff KingNov 4, 2022
  19. Ævar Arnfjörð BjarmasonNov 4, 2022
  20. Đoàn Trần Công DanhNov 4, 2022
  21. Ævar Arnfjörð BjarmasonNov 4, 2022
  22. 0/3 Convert git-bisect--helper to OPT_SUBCOMMANDĐoàn Trần Công Danh, Nov 5, 2022
  23. 1/3 bisect--helper: remove unused optionsĐoàn Trần Công Danh, Nov 5, 2022
  24. 3/3 bisect--helper: parse subcommand with OPT_SUBCOMMANDĐoàn Trần Công Danh, Nov 5, 2022
  25. 2/3 bisect--helper: move all subcommands into their own functionsĐoàn Trần Công Danh, Nov 5, 2022
  26. Đoàn Trần Công DanhNov 5, 2022
  27. 00/13 Turn git-bisect to be builtinĐoàn Trần Công Danh, Nov 5, 2022
  28. 01/13 bisect tests: test for v2.30.0 "bisect run" regressionsĐoàn Trần Công Danh, Nov 5, 2022
  29. Ævar Arnfjörð BjarmasonNov 7, 2022
  30. Đoàn Trần Công DanhNov 8, 2022
  31. 02/13 bisect: refactor bisect_run() to match CodingGuidelinesĐoàn Trần Công Danh, Nov 5, 2022
  32. 03/13 bisect--helper: pass arg[cv] down to do_bisect_runĐoàn Trần Công Danh, Nov 5, 2022
  33. 04/13 bisect: fix output regressions in v2.30.0Đoàn Trần Công Danh, Nov 5, 2022
  34. 05/13 bisect run: keep some of the post-v2.30.0 outputĐoàn Trần Công Danh, Nov 5, 2022
  35. Ævar Arnfjörð BjarmasonNov 7, 2022
  36. Đoàn Trần Công DanhNov 8, 2022
  37. Ævar Arnfjörð BjarmasonNov 8, 2022
  38. 06/13 bisect--helper: remove unused arguments from do_bisect_runĐoàn Trần Công Danh, Nov 5, 2022
  39. 07/13 bisect--helper: pretend we're real bisect when report errorĐoàn Trần Công Danh, Nov 5, 2022
  40. Ævar Arnfjörð BjarmasonNov 7, 2022
  41. 08/13 bisect test: test exit codes on bad usageĐoàn Trần Công Danh, Nov 5, 2022
  42. 09/13 bisect--helper: emit usage for "git bisect"Đoàn Trần Công Danh, Nov 5, 2022
  43. 10/13 bisect--helper: make `state` optionalĐoàn Trần Công Danh, Nov 5, 2022
  44. 11/13 bisect--helper: remove subcommand stateĐoàn Trần Công Danh, Nov 5, 2022
  45. Ævar Arnfjörð BjarmasonNov 7, 2022
  46. Đoàn Trần Công DanhNov 8, 2022
  47. 12/13 bisect--helper: log: allow arbitrary number of argumentsĐoàn Trần Công Danh, Nov 5, 2022
  48. 13/13 Turn `git bisect` into a full built-inĐoàn Trần Công Danh, Nov 5, 2022
  49. Taylor BlauNov 5, 2022
  50. 0/3 Convert git-bisect--helper to OPT_SUBCOMMANDĐoàn Trần Công Danh, Nov 10, 2022
  51. 1/3 bisect--helper: remove unused optionsĐoàn Trần Công Danh, Nov 10, 2022
  52. Ævar Arnfjörð BjarmasonNov 11, 2022
  53. 2/3 bisect--helper: move all subcommands into their own functionsĐoàn Trần Công Danh, Nov 10, 2022
  54. Ævar Arnfjörð BjarmasonNov 11, 2022
  55. 3/3 bisect--helper: parse subcommand with OPT_SUBCOMMANDĐoàn Trần Công Danh, Nov 10, 2022
  56. 00/11 Turn git-bisect to be builtinĐoàn Trần Công Danh, Nov 10, 2022
  57. 02/11 bisect: refactor bisect_run() to match CodingGuidelinesĐoàn Trần Công Danh, Nov 10, 2022
  58. 01/11 bisect tests: test for v2.30.0 "bisect run" regressionsĐoàn Trần Công Danh, Nov 10, 2022
  59. 03/11 bisect: fix output regressions in v2.30.0Đoàn Trần Công Danh, Nov 10, 2022
  60. 04/11 bisect run: keep some of the post-v2.30.0 outputĐoàn Trần Công Danh, Nov 10, 2022
  61. 05/11 bisect-run: verify_good: account for non-negative exit statusĐoàn Trần Công Danh, Nov 10, 2022
  62. 06/11 bisect--helper: identify as bisect when report errorĐoàn Trần Công Danh, Nov 10, 2022
  63. 07/11 bisect test: test exit codes on bad usageĐoàn Trần Công Danh, Nov 10, 2022
  64. 08/11 bisect--helper: emit usage for "git bisect"Đoàn Trần Công Danh, Nov 10, 2022
  65. 09/11 bisect--helper: handle states directlyĐoàn Trần Công Danh, Nov 10, 2022
  66. 10/11 bisect--helper: log: allow arbitrary number of argumentsĐoàn Trần Công Danh, Nov 10, 2022
  67. Ævar Arnfjörð BjarmasonNov 11, 2022
  68. 11/11 Turn `git bisect` into a full built-inĐoàn Trần Công Danh, Nov 10, 2022
  69. Ævar Arnfjörð BjarmasonNov 11, 2022
  70. Jeff KingNov 11, 2022
  71. Ævar Arnfjörð BjarmasonNov 11, 2022
  72. Taylor BlauNov 11, 2022
  73. Taylor BlauNov 15, 2022
  74. Jeff KingNov 15, 2022
  75. Taylor BlauNov 15, 2022
  76. Ævar Arnfjörð BjarmasonNov 11, 2022
  77. 00/13 bisect: v2.30.0 "run" regressions + make it built-inÆvar Arnfjörð Bjarmason, Nov 4, 2022
  78. 01/13 bisect tests: test for v2.30.0 "bisect run" regressionsÆvar Arnfjörð Bjarmason, Nov 4, 2022
  79. 02/13 bisect: refactor bisect_run() to match CodingGuidelinesÆvar Arnfjörð Bjarmason, Nov 4, 2022
  80. 04/13 bisect run: fix "--log" eating regression in v2.30.0Ævar Arnfjörð Bjarmason, Nov 4, 2022
  81. 03/13 bisect: fix output regressions in v2.30.0Ævar Arnfjörð Bjarmason, Nov 4, 2022
  82. 05/13 bisect run: keep some of the post-v2.30.0 outputÆvar Arnfjörð Bjarmason, Nov 4, 2022
  83. 06/13 bisect test: test exit codes on bad usageÆvar Arnfjörð Bjarmason, Nov 4, 2022
  84. 07/13 bisect--helper: emit usage for "git bisect"Ævar Arnfjörð Bjarmason, Nov 4, 2022
  85. 09/13 parse-options API: don't restrict OPT_SUBCOMMAND() to one *_fn typeÆvar Arnfjörð Bjarmason, Nov 4, 2022
  86. René ScharfeNov 5, 2022
  87. Đoàn Trần Công DanhNov 5, 2022
  88. Phillip WoodNov 5, 2022
  89. Ævar Arnfjörð BjarmasonNov 5, 2022
  90. Phillip WoodNov 5, 2022
  91. Ævar Arnfjörð BjarmasonNov 5, 2022
  92. René ScharfeNov 5, 2022
  93. Ævar Arnfjörð BjarmasonNov 5, 2022
  94. René ScharfeNov 6, 2022
  95. Ævar Arnfjörð BjarmasonNov 6, 2022
  96. René ScharfeNov 12, 2022
  97. Jeff KingNov 12, 2022
  98. Ævar Arnfjörð BjarmasonNov 12, 2022
  99. René ScharfeNov 13, 2022
  100. 08/13 bisect--helper: have all functions take state, argc, argv, prefixÆvar Arnfjörð Bjarmason, Nov 4, 2022
  101. 10/13 bisect--helper: remove dead --bisect-{next-check,autostart} codeÆvar Arnfjörð Bjarmason, Nov 4, 2022
  102. 11/13 bisect--helper: convert to OPT_SUBCOMMAND_CB()Ævar Arnfjörð Bjarmason, Nov 4, 2022
  103. 12/13 bisect--helper: make `state` optionalÆvar Arnfjörð Bjarmason, Nov 4, 2022
  104. 13/13 Turn `git bisect` into a full built-inÆvar Arnfjörð Bjarmason, Nov 4, 2022
  105. Taylor BlauNov 5, 2022
  106. Johannes SchindelinNov 10, 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.