From: Uladzislau Rezki <urezki@gmail.com>
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: "Paul E. McKenney" <paulmck@kernel.org>,
Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Jonathan Corbet <corbet@lwn.net>,
"Uladzislau Rezki (Sony)" <urezki@gmail.com>,
Joel Fernandes <joel@joelfernandes.org>,
Josh Triplett <josh@joshtriplett.org>,
Lai Jiangshan <jiangshanlai@gmail.com>,
Mathieu Desnoyers <mathieu.desnoyers@efficios.com>,
Steven Rostedt <rostedt@goodmis.org>,
linux-kernel@vger.kernel.org, rcu@vger.kernel.org
Subject: Re: [PATCH] rcu: better document kfree_rcu()
Date: Thu, 14 Jan 2021 12:36:19 +0100 [thread overview]
Message-ID: <20210114113619.GA49982@pc638.lan> (raw)
In-Reply-To: <2ec9a8bc8b411b04e2f541b285cc0a133a6d94de.1610608910.git.mchehab+huawei@kernel.org>
On Thu, Jan 14, 2021 at 08:22:02AM +0100, Mauro Carvalho Chehab wrote:
> After changeset 5130b8fd0690 ("rcu: Introduce kfree_rcu() single-argument macro"),
> kernel-doc now emits two warnings:
>
> ./include/linux/rcupdate.h:884: warning: Excess function parameter 'ptr' description in 'kfree_rcu'
> ./include/linux/rcupdate.h:884: warning: Excess function parameter 'rhf' description in 'kfree_rcu'
>
> What's happening here is that some macro magic was added in order
> to call two different versions of kfree_rcu(), being the first one
> with just one argument and a second one with two arguments.
>
> That makes harder to document the kfree_rcu() arguments, which
> also reflects on the documentation text.
>
> In order to make clearer that this macro accepts optional
> arguments, by using macro concatenation, changing its
> definition from:
> #define kfree_rcu kvfree_rcu
>
> to:
> #define kfree_rcu(ptr, rhf...) kvfree_rcu(ptr, ## rhf)
>
> That not only helps kernel-doc to understand the macro arguemnts,
> but also provides a better C definition that makes clearer that
> the first argument is mandatory and the second one is optional.
>
> Fixes: 5130b8fd0690 ("rcu: Introduce kfree_rcu() single-argument macro")
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
> include/linux/rcupdate.h | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/include/linux/rcupdate.h b/include/linux/rcupdate.h
> index bd04f722714f..5cc6deaa5df2 100644
> --- a/include/linux/rcupdate.h
> +++ b/include/linux/rcupdate.h
> @@ -881,7 +881,7 @@ static inline notrace void rcu_read_unlock_sched_notrace(void)
> * The BUILD_BUG_ON check must not involve any function calls, hence the
> * checks are done in macros here.
> */
> -#define kfree_rcu kvfree_rcu
> +#define kfree_rcu(ptr, rhf...) kvfree_rcu(ptr, ## rhf)
>
> /**
> * kvfree_rcu() - kvfree an object after a grace period.
> --
> 2.29.2
>
I think it is fair enough. I checked the "kernel-doc" and after this
change it does not detect any violations which are in question.
Tested-by: Uladzislau Rezki (Sony) <urezki@gmail.com>
--
Vlad Rezki
next prev parent reply other threads:[~2021-01-14 11:38 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-01-14 7:22 [PATCH] rcu: better document kfree_rcu() Mauro Carvalho Chehab
2021-01-14 11:36 ` Uladzislau Rezki [this message]
2021-01-15 18:54 ` Paul E. McKenney
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=20210114113619.GA49982@pc638.lan \
--to=urezki@gmail.com \
--cc=corbet@lwn.net \
--cc=jiangshanlai@gmail.com \
--cc=joel@joelfernandes.org \
--cc=josh@joshtriplett.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mathieu.desnoyers@efficios.com \
--cc=mchehab+huawei@kernel.org \
--cc=paulmck@kernel.org \
--cc=rcu@vger.kernel.org \
--cc=rostedt@goodmis.org \
/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).