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

Re: [PATCH 3/4] builtin: also setup gently for --help-all

From
D. Ben Knoble <ben.knoble+github@gmail.com>
Date
Jul 30, 2025, 22:00 UTC
Message-ID
<CALnO6CB+Hh46A=hLLNDYc2dJB=DbfdbethuGk0rzX3dA2ptO8g@mail.gmail.com>
In-Reply-To
<xmqqcy9kxrbw.fsf@gitster.g>
On Mon, Jul 28, 2025 at 11:33 AM Junio C Hamano <gitster@pobox.com> wrote:
Show 29 quoted lines
>
> "D. Ben Knoble" <ben.knoble+github@gmail.com> writes:
>
> >     I originally considered leaving out the changes to
> >     show_usage_with_options_if_asked and relying on the parse-options API to
> >     do the right thing. Unfortunately, most commands can't make it all the
> >     way to parse-options when setting up gently, and trying to parse options
> >     without a repo creates myriad dependency problems (like: we might read
> >     config after parsing CLI options, so we have to make sure the parsed
> >     options overrride config).
> >
> >     Some usage.c callers, like check-ref-format, probably deserve to be
> >     ported to parse-options at this point.
>
> It is unclear what you mean by all of the above, but hopefully it
> would become clear as we read the code changes.
>
> [snip]
>
> I don't understand your "I originally considered leaving out ..." at
> all.  We are special casing a lone "-h" here already because we know
> this is where we should stop without exercising unnecessary code
> because we may not even have repo!=NULL and that is the reason why
> this function exists in the first place.  It is obvious to me that
> we need the same special casing for "--help-all".
>
> In other words, I think all the above changes are good.
>
> Thanks.

I'm glad it was obvious to you! I spent a lot of time trying to get commands to call parse_options early, before touching any repository variables, since that was the only place where I knew "--help-all" was handled. This turned out to be a terrible mess, so I looked around for a different path forward (the one here now), and that turned out to work much better.

In that old world, parse-options doesn't change and the builtins need a lot of surgery (and probably still aren't completely right)—I can see how that note is confusing without that context, though, and I'll drop it in future rounds (esp. now we've discussed this version).

Previous: Junio C HamanoNext: D. Ben Knoble
Message 11 of 30 in “permit -h/--help-all in more scenarios”
  1. 0/4 permit -h/--help-all in more scenariosD. Ben Knoble, Jul 26, 2025
  2. 1/4 t1517: fixup for ua/t1517-short-help-testsD. Ben Knoble, Jul 26, 2025
  3. Usman AkinyemiJul 26, 2025
  4. Junio C HamanoJul 28, 2025
  5. 2/4 parse-options: name flags passed to usage_with_options_internalD. Ben Knoble, Jul 26, 2025
  6. Junio C HamanoJul 28, 2025
  7. Junio C HamanoJul 28, 2025
  8. D. Ben KnobleJul 30, 2025
  9. 3/4 builtin: also setup gently for --help-allD. Ben Knoble, Jul 26, 2025
  10. Junio C HamanoJul 28, 2025
  11. D. Ben KnobleJul 30, 2025
  12. 4/4 builtins: show help on "-h"/"--help-all" with more than 2 arguments leftD. Ben Knoble, Jul 26, 2025
  13. Junio C HamanoJul 27, 2025
  14. D. Ben KnobleJul 30, 2025
  15. Jeff KingAug 2, 2025
  16. D. Ben KnobleAug 2, 2025
  17. Jeff KingAug 2, 2025
  18. D. Ben KnobleAug 2, 2025
  19. 0/3 permit -h/--help-all in more scenariosD. Ben Knoble, Aug 3, 2025
  20. 0/3 permit -h/--help-all in more scenariosD. Ben Knoble, Aug 3, 2025
  21. Junio C HamanoAug 4, 2025
  22. D. Ben KnobleAug 5, 2025
  23. 1/3 t1517: fixup for ua/t1517-short-help-testsD. Ben Knoble, Aug 3, 2025
  24. Junio C HamanoAug 3, 2025
  25. D. Ben KnobleAug 3, 2025
  26. 2/3 parse-options: refactor flags for usage_with_options_internalD. Ben Knoble, Aug 3, 2025
  27. 3/3 builtin: also setup gently for --help-allD. Ben Knoble, Aug 3, 2025
  28. 1/3 t1517: fixup for ua/t1517-short-help-testsD. Ben Knoble, Aug 3, 2025
  29. 2/3 parse-options: refactor flags for usage_with_options_internalD. Ben Knoble, Aug 3, 2025
  30. 3/3 builtin: also setup gently for --help-allD. Ben Knoble, Aug 3, 2025

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.