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

Re: [PATCH 6/9] list-objects-filter-options: support 'auto' mode for --filter

From
Christian Couder <christian.couder@gmail.com>
Date
Feb 4, 2026, 10:21 UTC
Message-ID
<CAP8UFD2Nf4N2BUwZVtSDLH3Uu+UkGY67wmevwc4CoBN3jnqWCg@mail.gmail.com>
In-Reply-To
<aV4v6_DFJtraLlPI@pks.im>
On Wed, Jan 7, 2026 at 11:05 AM Patrick Steinhardt <ps@pks.im> wrote:
Show 10 quoted lines
>
> On Tue, Dec 23, 2025 at 12:11:10PM +0100, Christian Couder wrote:
> > In a following commit, we are going to allow passing "auto" as a
> > <filterspec> to the `--filter=<filterspec>` option, but only for some
> > commands. Other commands that support the `--filter=<filterspec>`
> > option should still die() when 'auto' is passed.
>
> Okay. I assume the idea is that the user can eventually say `git clone
> --filter=auto`, and Git would automatically pick the best filter
> advertised by the remote. Sounds reasonable to me.
Yeah, that's the idea.
Show 25 quoted lines
> > Let's set up the "list-objects-filter-options.{c,h}" infrastructure to
> > support that:
> >
> > - Add a new `unsigned int allow_auto_filter : 1;` flag to
> >   `struct list_objects_filter_options` which specifies if "auto" is
> >   accepted or not.
> > - Change gently_parse_list_objects_filter() to parse "auto" if it's
> >   accepted.
> > - Make sure we die() if "auto" is combined with another filter.
> > - Update list_objects_filter_release() to preserve the
> >   allow_auto_filter flag, as this function is often called (via
> >   opt_parse_list_objects_filter) to reset the struct before parsing a
> >   new value.
> >
> > Let's also update `list-objects-filter.c` to recognize the new
> > `LOFC_AUTO` choice. Since "auto" must be resolved to a concrete filter
> > before filtering actually begins, initializing a filter with
> > `LOFC_AUTO` is invalid and will trigger a BUG().
> >
> > Note that ideally combining "auto" with "auto" could be allowed, but in
> > practice, it's probably not worth the added code complexity. And if we
> > really want it, nothing prevents us to allow it in future work.
>
> I guess the question is what this would even mean, and I cannot think
> of any benefit to allow `--filter=combine:auto+auto`. So agreed

We could allow `--filter=combine:auto+auto` to mean the same as just `--filter=auto`. But I also don't see a benefit to allow this now.

Show 7 quoted lines
> > If we ever want to give a meaning to combining "auto" with a different
> > filter too, nothing prevents us to do that in future work either.
>
> So basically the case where the user knows that they definitely don't
> want blobs, and in addition they want to pick the best filter advertised
> by the server? Yeah, that sounds like it could eventually be a nice
> addition.
Yeah, but I think it's also not needed for now.
Show 16 quoted lines
> > diff --git a/list-objects-filter-options.c b/list-objects-filter-options.c
> > index 7420bf81fe..f13ae5caeb 100644
> > --- a/list-objects-filter-options.c
> > +++ b/list-objects-filter-options.c
> > @@ -52,7 +54,17 @@ int gently_parse_list_objects_filter(
> >       if (filter_options->choice)
> >               BUG("filter_options already populated");
> >
> > -     if (!strcmp(arg, "blob:none")) {
> > +     if (!strcmp(arg, "auto")) {
> > +             if (!filter_options->allow_auto_filter) {
> > +                     strbuf_addstr(
> > +                             errbuf,
> > +                             _("'auto' filter not supported by this command"));
>
> Tiny nit: the indentation looks a bit weird here.
I have changed it. Hope it's better now.
Show 22 quoted lines
> > @@ -146,10 +158,20 @@ static int parse_combine_subfilter(
> >
> >       decoded = url_percent_decode(subspec->buf);
> >
> > -     result = has_reserved_character(subspec, errbuf) ||
> > -             gently_parse_list_objects_filter(
> > +     result = has_reserved_character(subspec, errbuf);
> > +     if (result)
> > +             goto cleanup;
> > +
> > +     result = gently_parse_list_objects_filter(
> >                       &filter_options->sub[new_index], decoded, errbuf);
> > +     if (result)
> > +             goto cleanup;
> > +
> > +     result = (filter_options->sub[new_index].choice == LOFC_AUTO);
> > +     if (result)
> > +             strbuf_addstr(errbuf, _("an 'auto' filter cannot be combined"));
>
> Nit: let's maybe also add the `goto cleanup` here. I'm not a fan of
> leaving it away for the final statement as it makes it easy to forget
> backfilling it in case this function needs to be extended in the future.
Ok, I have added the `goto cleanup`.
Show 18 quoted lines
> > @@ -317,6 +345,7 @@ void list_objects_filter_release(
> >       struct list_objects_filter_options *filter_options)
> >  {
> >       size_t sub;
> > +     unsigned int allow_auto_filter = filter_options->allow_auto_filter;
> >
> >       if (!filter_options)
> >               return;
> > @@ -326,6 +355,7 @@ void list_objects_filter_release(
> >               list_objects_filter_release(&filter_options->sub[sub]);
> >       free(filter_options->sub);
> >       list_objects_filter_init(filter_options);
> > +     filter_options->allow_auto_filter = allow_auto_filter;
> >  }
>
> Why do we do this extra step to restore the `allow_auto_filter` option
> here? Are there any callers that reuse the filter after it has been
> released?

As you noticed below, list_objects_filter_release() doesn't just release resources but actually resets the state. That's because the filter options are indeed reused during command-line parsing.

In cmd_clone() a single `struct list_objects_filter_options` called "filter_options" is declared and then pointers to it are passed to a number of functions. In particular, opt_parse_list_objects_filter() handles the `--no-filter` case by calling list_objects_filter_set_no_filter() which calls list_objects_filter_release().

So yeah, if the user runs something like `git fetch --no-filter --filter=auto`, then "filter_options" is reused when `--filter=auto` is processed, so after it has been released.

Also note that the `allow_auto_filter` field is a configuration bit set by the command (e.g., cmd_fetch) before parsing begins. It indicates that the command supports the 'auto' mode. It's not data provided by users, so it doesn't change depending on which filter related options are passed.

I have added the following to the commit message:

"Also note that the new `allow_auto_filter` flag depends on the command, not user choices, so it should be reset to the command default when `struct list_objects_filter_options` instances are reset."

Show 5 quoted lines
> In any case, this function does have clearing semantics as it also knows
> to re-init the filter options. So it's somewhat misnamed and really
> should be called `list_objects_filter_clear()` according to our coding
> guidelines. That's certainly outside the scope of this patch series
> though.
Yeah, it can be done separately.
Previous: Patrick SteinhardtNext: Christian Couder
Message 14 of 111 in “Implement `promisor.storeFields` and `--filter=auto`”
  1. 0/9 Implement `promisor.storeFields` and `--filter=auto`Christian Couder, Dec 23, 2025
  2. 1/9 promisor-remote: refactor initialising field listsChristian Couder, Dec 23, 2025
  3. 2/9 promisor-remote: allow a client to store fieldsChristian Couder, Dec 23, 2025
  4. Patrick SteinhardtJan 7, 2026
  5. Christian CouderFeb 4, 2026
  6. 3/9 clone: make filter_options local to cmd_clone()Christian Couder, Dec 23, 2025
  7. 4/9 fetch: make filter_options local to cmd_fetch()Christian Couder, Dec 23, 2025
  8. Patrick SteinhardtJan 7, 2026
  9. 5/9 doc: fetch: document `--filter=<filter-spec>` optionChristian Couder, Dec 23, 2025
  10. Jean-Noël AVILADec 26, 2025
  11. Christian CouderFeb 4, 2026
  12. 6/9 list-objects-filter-options: support 'auto' mode for --filterChristian Couder, Dec 23, 2025
  13. Patrick SteinhardtJan 7, 2026
  14. Christian CouderFeb 4, 2026
  15. 7/9 list-objects-filter-options: implement auto filter resolutionChristian Couder, Dec 23, 2025
  16. Patrick SteinhardtJan 7, 2026
  17. Christian CouderFeb 4, 2026
  18. Patrick SteinhardtFeb 11, 2026
  19. Christian CouderFeb 12, 2026
  20. 8/9 promisor-remote: keep advertised filter in memoryChristian Couder, Dec 23, 2025
  21. Patrick SteinhardtJan 7, 2026
  22. Christian CouderFeb 4, 2026
  23. Patrick SteinhardtFeb 11, 2026
  24. Junio C HamanoFeb 11, 2026
  25. Christian CouderFeb 12, 2026
  26. 9/9 fetch-pack: wire up and enable auto filter logicChristian Couder, Dec 23, 2025
  27. Patrick SteinhardtJan 7, 2026
  28. Christian CouderFeb 4, 2026
  29. 0/8 Implement `promisor.storeFields` and `--filter=auto`Christian Couder, Feb 4, 2026
  30. 1/8 promisor-remote: refactor initialising field listsChristian Couder, Feb 4, 2026
  31. 2/8 promisor-remote: allow a client to store fieldsChristian Couder, Feb 4, 2026
  32. 3/8 clone: make filter_options local to cmd_clone()Christian Couder, Feb 4, 2026
  33. 4/8 fetch: make filter_options local to cmd_fetch()Christian Couder, Feb 4, 2026
  34. 5/8 doc: fetch: document `--filter=<filter-spec>` optionChristian Couder, Feb 4, 2026
  35. Patrick SteinhardtFeb 11, 2026
  36. Christian CouderFeb 12, 2026
  37. 6/8 list-objects-filter-options: support 'auto' mode for --filterChristian Couder, Feb 4, 2026
  38. 7/8 promisor-remote: keep advertised filters in memoryChristian Couder, Feb 4, 2026
  39. 8/8 fetch-pack: wire up and enable auto filter logicChristian Couder, Feb 4, 2026
  40. Patrick SteinhardtFeb 11, 2026
  41. Christian CouderFeb 12, 2026
  42. 0/9 Implement `promisor.storeFields` and `--filter=auto`Christian Couder, Feb 12, 2026
  43. 1/9 promisor-remote: refactor initialising field listsChristian Couder, Feb 12, 2026
  44. 2/9 promisor-remote: allow a client to store fieldsChristian Couder, Feb 12, 2026
  45. 3/9 clone: make filter_options local to cmd_clone()Christian Couder, Feb 12, 2026
  46. 4/9 fetch: make filter_options local to cmd_fetch()Christian Couder, Feb 12, 2026
  47. 5/9 doc: fetch: document `--filter=<filter-spec>` optionChristian Couder, Feb 12, 2026
  48. 6/9 list-objects-filter-options: support 'auto' mode for --filterChristian Couder, Feb 12, 2026
  49. Jeff KingFeb 14, 2026
  50. Christian CouderFeb 16, 2026
  51. 7/9 promisor-remote: keep advertised filters in memoryChristian Couder, Feb 12, 2026
  52. 8/9 promisor-remote: change promisor_remote_reply()'s signatureChristian Couder, Feb 12, 2026
  53. Patrick SteinhardtFeb 13, 2026
  54. 9/9 fetch-pack: wire up and enable auto filter logicChristian Couder, Feb 12, 2026
  55. Patrick SteinhardtFeb 13, 2026
  56. Patrick SteinhardtFeb 13, 2026
  57. 0/9 Implement `promisor.storeFields` and `--filter=auto`Christian Couder, Feb 16, 2026
  58. 1/9 promisor-remote: refactor initialising field listsChristian Couder, Feb 16, 2026
  59. 2/9 promisor-remote: allow a client to store fieldsChristian Couder, Feb 16, 2026
  60. 3/9 clone: make filter_options local to cmd_clone()Christian Couder, Feb 16, 2026
  61. 4/9 fetch: make filter_options local to cmd_fetch()Christian Couder, Feb 16, 2026
  62. 5/9 doc: fetch: document `--filter=<filter-spec>` optionChristian Couder, Feb 16, 2026
  63. 6/9 list-objects-filter-options: support 'auto' mode for --filterChristian Couder, Feb 16, 2026
  64. 7/9 promisor-remote: keep advertised filters in memoryChristian Couder, Feb 16, 2026
  65. 8/9 promisor-remote: change promisor_remote_reply()'s signatureChristian Couder, Feb 16, 2026
  66. 9/9 fetch-pack: wire up and enable auto filter logicChristian Couder, Feb 16, 2026
  67. 0/8 Auto-configure advertised remotes via URL allowlistChristian Couder, Apr 27, 2026
  68. 1/8 t5710: simplify 'mkdir X' followed by 'git -C X init'Christian Couder, Apr 27, 2026
  69. 2/8 urlmatch: change 'allow_globs' arg to boolChristian Couder, Apr 27, 2026
  70. 3/8 urlmatch: add url_normalize_pattern() helperChristian Couder, Apr 27, 2026
  71. 4/8 promisor-remote: add 'local_name' to 'struct promisor_info'Christian Couder, Apr 27, 2026
  72. Toon ClaesMay 4, 2026
  73. 5/8 promisor-remote: introduce promisor.acceptFromServerUrlChristian Couder, Apr 27, 2026
  74. 6/8 promisor-remote: trust known remotes matching acceptFromServerUrlChristian Couder, Apr 27, 2026
  75. Toon ClaesMay 8, 2026
  76. Christian CouderMay 19, 2026
  77. Toon ClaesMay 11, 2026
  78. Christian CouderMay 19, 2026
  79. 7/8 promisor-remote: auto-configure unknown remotesChristian Couder, Apr 27, 2026
  80. Toon ClaesMay 11, 2026
  81. Christian CouderMay 19, 2026
  82. 8/8 doc: promisor: improve acceptFromServer entryChristian Couder, Apr 27, 2026
  83. Christian CouderApr 27, 2026
  84. 0/8 Auto-configure advertised remotes via URL allowlistChristian Couder, May 19, 2026
  85. 1/8 t5710: simplify 'mkdir X' followed by 'git -C X init'Christian Couder, May 19, 2026
  86. 2/8 urlmatch: change 'allow_globs' arg to boolChristian Couder, May 19, 2026
  87. 3/8 urlmatch: add url_normalize_pattern() helperChristian Couder, May 19, 2026
  88. 4/8 promisor-remote: add 'local_name' to 'struct promisor_info'Christian Couder, May 19, 2026
  89. Junio C HamanoMay 20, 2026
  90. Christian CouderMay 27, 2026
  91. 5/8 promisor-remote: introduce promisor.acceptFromServerUrlChristian Couder, May 19, 2026
  92. 6/8 promisor-remote: trust known remotes matching acceptFromServerUrlChristian Couder, May 19, 2026
  93. Kristoffer HaugsbakkMay 23, 2026
  94. Christian CouderMay 27, 2026
  95. 7/8 promisor-remote: auto-configure unknown remotesChristian Couder, May 19, 2026
  96. 8/8 doc: promisor: improve acceptFromServer entryChristian Couder, May 19, 2026
  97. 0/8 Auto-configure advertised remotes via URL allowlistChristian Couder, May 27, 2026
  98. 1/8 t5710: simplify 'mkdir X' followed by 'git -C X init'Christian Couder, May 27, 2026
  99. 2/8 urlmatch: change 'allow_globs' arg to boolChristian Couder, May 27, 2026
  100. 3/8 urlmatch: add url_normalize_pattern() helperChristian Couder, May 27, 2026
  101. 4/8 promisor-remote: add 'local_name' to 'struct promisor_info'Christian Couder, May 27, 2026
  102. 5/8 promisor-remote: introduce promisor.acceptFromServerUrlChristian Couder, May 27, 2026
  103. 6/8 promisor-remote: trust known remotes matching acceptFromServerUrlChristian Couder, May 27, 2026
  104. 7/8 promisor-remote: auto-configure unknown remotesChristian Couder, May 27, 2026
  105. 8/8 doc: promisor: improve acceptFromServer entryChristian Couder, May 27, 2026
  106. Kristoffer HaugsbakkJul 4, 2026
  107. Toon ClaesJun 9, 2026
  108. Christian CouderJun 9, 2026
  109. Toon ClaesJun 9, 2026
  110. Junio C HamanoJun 10, 2026
  111. Christian CouderJun 11, 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.