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

Re: [PATCH v5 11/13] builtin/rerere: use `OPT_SUBCOMMAND()`

From
Junio C Hamano <gitster@pobox.com>
Date
Nov 19, 2026, 22:43 UTC
Message-ID
<xmqqwlq8tpbm.fsf@gitster.g>
In-Reply-To
<20261119-pks-rerere-subcommands-v5-11-0c1092b88958@pks.im>
Patrick Steinhardt <ps@pks.im> writes:
Show 10 quoted lines
> In git-rerere(1) we have our own custom logic to parse subcommands. In
> preceding commits we have refactored all of those subcommands so that
> they are ready to be used as `OPT_SUBCOMMAND()`s. Switch over to use
> these so that we get rid of our custom subcommand parsing.
>
> Unfortunately this means that we have a backwards-incompatible change
> because we no longer accept the "--[no-]rerere-autoupdate" flag for all
> subcommands. But this was arguably broken and misleading as we ignore
> this flag for any other subcommand aynway. So we cheat a bit and simply
> call it a bug that those flags were accepted in the first place.
Aynway.
Show 12 quoted lines
> +static int cmd_rerere_perform(int argc,
> +			      const char **argv,
> +			      const char *prefix,
> +			      struct repository *repo)
> +{
> +	int autoupdate = -1;
> +	struct option options[] = {
> +		OPT_SET_INT(0, "rerere-autoupdate", &autoupdate,
> +			N_("register clean resolutions in index"), 1),
> +		OPT_END(),
> +	};
> +	enum rerere_flags flags = 0;
The "register clean resolutions in index" text used to be given for "-h"
    $ rungit master rerere -h
    usage: git rerere [clear | forget <pathspec>... | diff | status | remaining | gc]
        --[no-]rerere-autoupdate
                              register clean resolutions in index
but we moved it to this subcommand.

It was a bug that "git rerere diff --no-rerere-autoupdate" did not complain. Because this option only appears here, those subcommands would now complain when they see the --no-rerere-autoupdate option.

Which is very good.

What is a bit sad is that it has become very hard to actually see this help text.

    $ rungit seen rerere -h
    usage: git rerere [--[no-]rerere-autoupdate]
       or: git rerere clear
       or: git rerere diff
       or: git rerere forget <pathspec>...
       or: git rerere gc
       or: git rerere remaining
       or: git rerere status

Because the primary subcommand (i.e., record and replay after you got a conflict in the working tree) does not have a subcommand verb, "git rerere -h" would trigger the help for the top-level command, and the help is shown from there without using the options[] array in this subcommand.

I said "very hard", not impossible, because there is an awkward way to see this.

    $ rungit seen rerere -- -h
    $ rungit seen rerere --rerere-autoupdate -h
Both of which would give you
    usage: git rerere [--[no-]rerere-autoupdate]
        --[no-]rerere-autoupdate
                              register clean resolutions in index
but it probably is not what users will ever use.

I think it is OK to stop here and leave the above as-is. The only people who use this option are those who already know and are used to it. Everybody else I would imagine would rather use

	git -c rerere.autoupdate=no rerere
instead.
It might have fallouts on --git-completion-helper, too.
    $ rungit master rerere --git-completion-helper
    --rerere-autoupdate --no-rerere-autoupdate
    $ rungit seen rerere --git-completion-helper
    clear diff forget gc remaining status

Arguably, the updated choices are better, but I do not know offhand how the bash completion script uses this (specifically, the old output was so bad that it may have workaround that we will no longer need with your improvements).

Thanks.
Previous: Patrick SteinhardtNext: Patrick Steinhardt
Message 106 of 108 in “builtin/rerere: convert to use subcommands”
  1. 00/12 builtin/rerere: convert to use subcommandsPatrick Steinhardt, Oct 27, 2026
  2. 01/12 rerere: rename `repo_rerere()`Patrick Steinhardt, Oct 27, 2026
  3. Junio C HamanoOct 27, 2026
  4. Patrick SteinhardtOct 28, 2026
  5. Junio C HamanoOct 28, 2026
  6. 02/12 rerere: convert flags into an enumPatrick Steinhardt, Oct 27, 2026
  7. Mark C. Chu-CarrollOct 27, 2026
  8. Junio C HamanoOct 27, 2026
  9. Patrick SteinhardtOct 28, 2026
  10. Mark C. Chu-CarrollOct 28, 2026
  11. Junio C HamanoOct 28, 2026
  12. 03/12 builtin/rerere: drop `the_repository`Patrick Steinhardt, Oct 27, 2026
  13. 04/12 builtin/rerere: stop passing flags to subcommands that ignore themPatrick Steinhardt, Oct 27, 2026
  14. 05/12 builtin/rerere: turn "forget" into a proper subcommandPatrick Steinhardt, Oct 27, 2026
  15. 06/12 builtin/rerere: turn "clear" into a proper subcommandPatrick Steinhardt, Oct 27, 2026
  16. 07/12 builtin/rerere: turn "status" into a proper subcommandPatrick Steinhardt, Oct 27, 2026
  17. 08/12 builtin/rerere: turn "remaining" into a proper subcommandPatrick Steinhardt, Oct 27, 2026
  18. 09/12 builtin/rerere: turn "diff" into a proper subcommandPatrick Steinhardt, Oct 27, 2026
  19. 10/12 builtin/rerere: turn "gc" into a proper subcommandPatrick Steinhardt, Oct 27, 2026
  20. 11/12 builtin/rerere: use `OPT_SUBCOMMAND()`Patrick Steinhardt, Oct 27, 2026
  21. 12/12 builtin/rerere: introduce proper usage strings for subcommandsPatrick Steinhardt, Oct 27, 2026
  22. Junio C HamanoOct 27, 2026
  23. 00/12 builtin/rerere: convert to use subcommandsPatrick Steinhardt, Oct 29, 2026
  24. 01/12 rerere: rename `repo_rerere()`Patrick Steinhardt, Oct 29, 2026
  25. 02/12 rerere: convert flags into an enumPatrick Steinhardt, Oct 29, 2026
  26. Karthik NayakNov 6, 2026
  27. Patrick SteinhardtNov 6, 2026
  28. Karthik NayakNov 6, 2026
  29. 03/12 builtin/rerere: drop `the_repository`Patrick Steinhardt, Oct 29, 2026
  30. 04/12 builtin/rerere: stop passing flags to subcommands that ignore themPatrick Steinhardt, Oct 29, 2026
  31. 05/12 builtin/rerere: turn "forget" into a proper subcommandPatrick Steinhardt, Oct 29, 2026
  32. 06/12 builtin/rerere: turn "clear" into a proper subcommandPatrick Steinhardt, Oct 29, 2026
  33. 07/12 builtin/rerere: turn "status" into a proper subcommandPatrick Steinhardt, Oct 29, 2026
  34. 08/12 builtin/rerere: turn "remaining" into a proper subcommandPatrick Steinhardt, Oct 29, 2026
  35. 09/12 builtin/rerere: turn "diff" into a proper subcommandPatrick Steinhardt, Oct 29, 2026
  36. 10/12 builtin/rerere: turn "gc" into a proper subcommandPatrick Steinhardt, Oct 29, 2026
  37. Karthik NayakNov 6, 2026
  38. 11/12 builtin/rerere: use `OPT_SUBCOMMAND()`Patrick Steinhardt, Oct 29, 2026
  39. Karthik NayakNov 6, 2026
  40. Patrick SteinhardtNov 6, 2026
  41. 12/12 builtin/rerere: introduce proper usage strings for subcommandsPatrick Steinhardt, Oct 29, 2026
  42. Karthik NayakNov 6, 2026
  43. 00/12 builtin/rerere: convert to use subcommandsPatrick Steinhardt, Nov 6, 2026
  44. 01/12 rerere: rename `repo_rerere()`Patrick Steinhardt, Nov 6, 2026
  45. 02/12 rerere: convert flags into an enumPatrick Steinhardt, Nov 6, 2026
  46. Junio C HamanoNov 6, 2026
  47. Patrick SteinhardtNov 9, 2026
  48. Junio C HamanoNov 9, 2026
  49. Junio C HamanoNov 9, 2026
  50. Patrick SteinhardtNov 11, 2026
  51. 03/12 builtin/rerere: drop `the_repository`Patrick Steinhardt, Nov 6, 2026
  52. 04/12 builtin/rerere: stop passing flags to subcommands that ignore themPatrick Steinhardt, Nov 6, 2026
  53. 05/12 builtin/rerere: turn "forget" into a proper subcommandPatrick Steinhardt, Nov 6, 2026
  54. 06/12 builtin/rerere: turn "clear" into a proper subcommandPatrick Steinhardt, Nov 6, 2026
  55. 07/12 builtin/rerere: turn "status" into a proper subcommandPatrick Steinhardt, Nov 6, 2026
  56. 08/12 builtin/rerere: turn "remaining" into a proper subcommandPatrick Steinhardt, Nov 6, 2026
  57. 09/12 builtin/rerere: turn "diff" into a proper subcommandPatrick Steinhardt, Nov 6, 2026
  58. 10/12 builtin/rerere: turn "gc" into a proper subcommandPatrick Steinhardt, Nov 6, 2026
  59. 11/12 builtin/rerere: use `OPT_SUBCOMMAND()`Patrick Steinhardt, Nov 6, 2026
  60. 12/12 builtin/rerere: introduce proper usage strings for subcommandsPatrick Steinhardt, Nov 6, 2026
  61. 00/12 builtin/rerere: convert to use subcommandsPatrick Steinhardt, Nov 11, 2026
  62. 01/12 rerere: rename `repo_rerere()`Patrick Steinhardt, Nov 11, 2026
  63. 02/12 rerere: convert flags into an enumPatrick Steinhardt, Nov 11, 2026
  64. 03/12 builtin/rerere: drop `the_repository`Patrick Steinhardt, Nov 11, 2026
  65. 04/12 builtin/rerere: stop passing flags to subcommands that ignore themPatrick Steinhardt, Nov 11, 2026
  66. 05/12 builtin/rerere: turn "forget" into a proper subcommandPatrick Steinhardt, Nov 11, 2026
  67. 06/12 builtin/rerere: turn "clear" into a proper subcommandPatrick Steinhardt, Nov 11, 2026
  68. 07/12 builtin/rerere: turn "status" into a proper subcommandPatrick Steinhardt, Nov 11, 2026
  69. 08/12 builtin/rerere: turn "remaining" into a proper subcommandPatrick Steinhardt, Nov 11, 2026
  70. 09/12 builtin/rerere: turn "diff" into a proper subcommandPatrick Steinhardt, Nov 11, 2026
  71. Junio C HamanoNov 17, 2026
  72. 10/12 builtin/rerere: turn "gc" into a proper subcommandPatrick Steinhardt, Nov 11, 2026
  73. Junio C HamanoNov 17, 2026
  74. 11/12 builtin/rerere: use `OPT_SUBCOMMAND()`Patrick Steinhardt, Nov 11, 2026
  75. Junio C HamanoNov 17, 2026
  76. Patrick SteinhardtNov 18, 2026
  77. Junio C HamanoNov 18, 2026
  78. 12/12 builtin/rerere: introduce proper usage strings for subcommandsPatrick Steinhardt, Nov 11, 2026
  79. Junio C HamanoNov 17, 2026
  80. Patrick SteinhardtNov 18, 2026
  81. Karthik NayakNov 12, 2026
  82. Patrick SteinhardtNov 13, 2026
  83. Junio C HamanoNov 13, 2026
  84. Tuomas AholaNov 13, 2026
  85. Phillip WoodNov 13, 2026
  86. Junio C HamanoNov 13, 2026
  87. Tuomas AholaNov 14, 2026
  88. Patrick SteinhardtNov 16, 2026
  89. Junio C HamanoNov 14, 2026
  90. Patrick SteinhardtNov 16, 2026
  91. Junio C HamanoNov 16, 2026
  92. Junio C HamanoNov 17, 2026
  93. Patrick SteinhardtNov 18, 2026
  94. 00/13 builtin/rerere: convert to use subcommandsPatrick Steinhardt, Nov 19, 2026
  95. 01/13 rerere: rename `repo_rerere()`Patrick Steinhardt, Nov 19, 2026
  96. 02/13 rerere: convert flags into an enumPatrick Steinhardt, Nov 19, 2026
  97. 03/13 builtin/rerere: drop `the_repository`Patrick Steinhardt, Nov 19, 2026
  98. 04/13 builtin/rerere: stop passing flags to subcommands that ignore themPatrick Steinhardt, Nov 19, 2026
  99. 05/13 builtin/rerere: turn "forget" into a proper subcommandPatrick Steinhardt, Nov 19, 2026
  100. 06/13 builtin/rerere: turn "clear" into a proper subcommandPatrick Steinhardt, Nov 19, 2026
  101. 07/13 builtin/rerere: turn "status" into a proper subcommandPatrick Steinhardt, Nov 19, 2026
  102. 08/13 builtin/rerere: turn "remaining" into a proper subcommandPatrick Steinhardt, Nov 19, 2026
  103. 09/13 builtin/rerere: turn "diff" into a proper subcommandPatrick Steinhardt, Nov 19, 2026
  104. 10/13 builtin/rerere: turn "gc" into a proper subcommandPatrick Steinhardt, Nov 19, 2026
  105. 11/13 builtin/rerere: use `OPT_SUBCOMMAND()`Patrick Steinhardt, Nov 19, 2026
  106. Junio C HamanoNov 19, 2026
  107. 12/13 builtin/rerere: introduce proper usage strings for subcommandsPatrick Steinhardt, Nov 19, 2026
  108. 13/13 Documentation/git-rerere: drop claim that we pass args to diff(1)Patrick Steinhardt, Nov 19, 2026

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.