rcu: Fix description of kvfree_rcu()

urezki · paulmckrcu · commit 150154aae431 · 2022-02-14T10:36:35.000-08:00
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 &lt;rostedt@goodmis.org&gt;
Signed-off-by: Uladzislau Rezki (Sony) &lt;urezki@gmail.com&gt;
Signed-off-by: Paul E. McKenney &lt;paulmck@kernel.org&gt;
diff --git 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()

Original file line number	Diff line number	Diff line change
`@@ -924,7 +924,7 @@ static inline notrace void rcu_read_unlock_sched_notrace(void)`
`924`	`924`	`*`
`925`	`925`	`* kvfree_rcu(ptr);`
`926`	`926`	`*`
`927`		`- * where @ptr is a pointer to kvfree().`
	`927`	`+ * where @ptr is the pointer to be freed by kvfree().`
`928`	`928`	`*`
`929`	`929`	`* Please note, head-less way of freeing is permitted to`
`930`	`930`	`* use from a context that has to follow might_sleep()`