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

[PATCH 0/2] clean up some MAYBE_UNUSED cases

From
Jeff King <peff@peff.net>
Date
Aug 29, 2024, 20:08 UTC
Message-ID
<20240829200807.GA430283@coredump.intra.peff.net>

The discussion about MAYBE_UNUSED over in[1] made me wonder how it was used in practice. This series cleans up a few spots where I think it is being misused.

[1] https://lore.kernel.org/git/xmqqseunxtks.fsf_-_@gitster.g/
The remaining grep hits are:
  - fsmonitor has a few functions with sometimes-unused parameters based
    on conditional compilation (try_to_run_foreground_daemon() and
    check_for_incompatible()). This is a good use of MAYBE_UNUSED.
  - builtin/gc.c's check_crontab_process(). The whole function is marked
    as MAYBE_UNUSED here, which is a little funny. It's because
    is_crontab_available() may or may not call us based on __APPLE__.
    Should we conditionally define the function, too, in that case? It
    would mean repeating the #ifdef. Alternatively, we could define it
    like this:
      #ifdef __APPLE__
      static int check_crontab_process(const char *cmd UNUSED)
      {
              return 0;
      }
      #else
      static int check_crontab_process(const char *cmd UNUSED)
      {
              [...the real function...]
      }
      #endif
    But I think we're getting into "well, this is how I would have
    written it" territory, and it doesn't matter much either way in
    practice. It's probably better to just leave it alone.
  - commit-slab marks auto-generated static functions with MAYBE_UNUSED,
    since it doesn't know which ones actually need to be instantiated.
    This was the original thing we added MAYBE_UNUSED for.
  - khash does something similar when auto-generating functions.
  - test_bitmap_commits() marks a local variable as MAYBE_UNUSED! In
    fact it's completely unused by the function itself, but the macro
    expansion of kh_foreach() assigns to it. So we need the variable to
    exist to pass into the macro, but the compiler warning is triggered
    on the expanded code. We have kh_foreach_value(), but not
    kh_foreach_key(), which is what we'd want here. It wouldn't be hard
    to add it, but the MAYBE_UNUSED here is doing a fine job of
    suppressing the warning (and presumably an optimizing compiler
    removes the useless assignment).

I prepared this on top of what's queued in jk/unused-parameters (which helps with making sure the annotations are all correct), but it could be applied separately.

  [1/2]: gc: drop MAYBE_UNUSED annotation from used parameter
  [2/2]: grep: prefer UNUSED to MAYBE_UNUSED for pcre allocators
 builtin/gc.c | 2 +-
 grep.c       | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)
-Peff
Next: Jeff King
Message 1 of 7 in “clean up some MAYBE_UNUSED cases”
  1. 0/2 clean up some MAYBE_UNUSED casesJeff King, Aug 29, 2024
  2. 1/2 gc: drop MAYBE_UNUSED annotation from used parameterJeff King, Aug 29, 2024
  3. 2/2 grep: prefer UNUSED to MAYBE_UNUSED for pcre allocatorsJeff King, Aug 29, 2024
  4. Eric SunshineAug 29, 2024
  5. Patrick SteinhardtAug 30, 2024
  6. Junio C HamanoAug 30, 2024
  7. Junio C HamanoAug 29, 2024

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.