From: Jeff King <peff@peff.net>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>
Subject: [PATCH 0/2] clean up some MAYBE_UNUSED cases
Date: Thu, 29 Aug 2024 16:08:07 -0400 [thread overview]
Message-ID: <20240829200807.GA430283@coredump.intra.peff.net> (raw)
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 reply other threads:[~2024-08-29 20:08 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-08-29 20:08 Jeff King [this message]
2024-08-29 20:08 ` [PATCH 1/2] gc: drop MAYBE_UNUSED annotation from used parameter Jeff King
2024-08-29 20:09 ` [PATCH 2/2] grep: prefer UNUSED to MAYBE_UNUSED for pcre allocators Jeff King
2024-08-29 20:27 ` Eric Sunshine
2024-08-30 6:39 ` Patrick Steinhardt
2024-08-30 16:30 ` Junio C Hamano
2024-08-29 20:46 ` [PATCH 0/2] clean up some MAYBE_UNUSED cases Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240829200807.GA430283@coredump.intra.peff.net \
--to=peff@peff.net \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).