* [PATCH v2] rcu: Fix description of kvfree_rcu()
@ 2021-12-01 9:20 Uladzislau Rezki (Sony)
2021-12-01 14:37 ` Paul E. McKenney
0 siblings, 1 reply; 2+ messages in thread
From: Uladzislau Rezki (Sony) @ 2021-12-01 9:20 UTC (permalink / raw)
To: LKML, RCU, Paul E . McKenney
Cc: Michal Hocko, Andrew Morton, Daniel Axtens, Frederic Weisbecker,
Neeraj Upadhyay, Joel Fernandes, Peter Zijlstra, Thomas Gleixner,
Theodore Y . Ts'o, Sebastian Andrzej Siewior,
Uladzislau Rezki, Oleksiy Avramchenko, Steven Rostedt
The passed "ptr" parameter might be wrongly interpreted
therefore rephrase it to prevent people from being confused.
Reported-by: Steven Rostedt <rostedt@goodmis.org>
Signed-off-by: Uladzislau Rezki (Sony) <urezki@gmail.com>
---
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 88b42eb46406..9d7df8d36af0 100644
--- a/include/linux/rcupdate.h
+++ b/include/linux/rcupdate.h
@@ -924,7 +924,7 @@ static inline notrace void rcu_read_unlock_sched_notrace(void)
*
* kvfree_rcu(ptr);
*
- * where @ptr is a pointer to kvfree().
+ * where @ptr is the pointer to be freed by kvfree().
*
* Please note, head-less way of freeing is permitted to
* use from a context that has to follow might_sleep()
--
2.30.2
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH v2] rcu: Fix description of kvfree_rcu()
2021-12-01 9:20 [PATCH v2] rcu: Fix description of kvfree_rcu() Uladzislau Rezki (Sony)
@ 2021-12-01 14:37 ` Paul E. McKenney
0 siblings, 0 replies; 2+ messages in thread
From: Paul E. McKenney @ 2021-12-01 14:37 UTC (permalink / raw)
To: Uladzislau Rezki (Sony)
Cc: LKML, RCU, Michal Hocko, Andrew Morton, Daniel Axtens,
Frederic Weisbecker, Neeraj Upadhyay, Joel Fernandes,
Peter Zijlstra, Thomas Gleixner, Theodore Y . Ts'o,
Sebastian Andrzej Siewior, Oleksiy Avramchenko, Steven Rostedt
On Wed, Dec 01, 2021 at 10:20:53AM +0100, Uladzislau Rezki (Sony) wrote:
> The passed "ptr" parameter might be wrongly interpreted
> therefore rephrase it to prevent people from being confused.
>
> Reported-by: Steven Rostedt <rostedt@goodmis.org>
> Signed-off-by: Uladzislau Rezki (Sony) <urezki@gmail.com>
Thank you both! Queued with wordsmithed commit log as shown below,
so please check to see if I messed anything up.
Thanx, Paul
------------------------------------------------------------------------
commit 59ef229194204b023bb7bde95ce769d4e94a4b62
Author: Uladzislau Rezki (Sony) <urezki@gmail.com>
Date: Wed Dec 1 10:20:53 2021 +0100
rcu: Fix description of kvfree_rcu()
The kvfree_rcu() header comment's description of the "ptr" parameter
is unclear, therefore rephrase it to make it clear that it is a pointer
to the memory to eventually be passed to kvfree().
Reported-by: Steven Rostedt <rostedt@goodmis.org>
Signed-off-by: Uladzislau Rezki (Sony) <urezki@gmail.com>
Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
diff --git a/include/linux/rcupdate.h b/include/linux/rcupdate.h
index 88b42eb464068..9d7df8d36af07 100644
--- a/include/linux/rcupdate.h
+++ b/include/linux/rcupdate.h
@@ -924,7 +924,7 @@ static inline notrace void rcu_read_unlock_sched_notrace(void)
*
* kvfree_rcu(ptr);
*
- * where @ptr is a pointer to kvfree().
+ * where @ptr is the pointer to be freed by kvfree().
*
* Please note, head-less way of freeing is permitted to
* use from a context that has to follow might_sleep()
^ permalink raw reply related [flat|nested] 2+ messages in thread
end of thread, other threads:[~2021-12-01 14:41 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2021-12-01 9:20 [PATCH v2] rcu: Fix description of kvfree_rcu() Uladzislau Rezki (Sony)
2021-12-01 14:37 ` Paul E. McKenney
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox