Messages in this thread Patch in this message | | | Date | Sun, 11 Apr 2021 13:43:41 -0000 | From | "tip-bot2 for Mauro Carvalho Chehab" <> | Subject | [tip: core/rcu] rcu: Fix kfree_rcu() docbook errors |
| |
The following commit has been merged into the core/rcu branch of tip:
Commit-ID: e75956bd00cf4246067c6aee7751faf313233435 Gitweb: https://git.kernel.org/tip/e75956bd00cf4246067c6aee7751faf313233435 Author: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> AuthorDate: Thu, 14 Jan 2021 08:22:02 +01:00 Committer: Paul E. McKenney <paulmck@kernel.org> CommitterDate: Mon, 08 Mar 2021 14:17:35 -08:00
rcu: Fix kfree_rcu() docbook errors
After commit 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'
This commit added some macro magic in order to call two different versions of kfree_rcu(), the first having just one argument and the second having two arguments. That makes it difficult to document the kfree_rcu() arguments in the docboook header.
In order to make clearer that this macro accepts optional arguments, this commit uses macro concatenation so that this macro changes from: #define kfree_rcu kvfree_rcu
to: #define kfree_rcu(ptr, rhf...) kvfree_rcu(ptr, ## rhf)
That not only helps kernel-doc understand the macro arguments, 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") Tested-by: Uladzislau Rezki (Sony) <urezki@gmail.com> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Paul E. McKenney <paulmck@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 bd04f72..5cc6dea 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.
| |