docs/rcu: Update the call_rcu() API
authorHui Su <sh_def@163.com>
Thu, 15 Oct 2020 14:13:34 +0000 (22:13 +0800)
committerPaul E. McKenney <paulmck@kernel.org>
Sat, 7 Nov 2020 01:02:43 +0000 (17:02 -0800)
This commit updates the documented API of call_rcu() to use the
rcu_callback_t typedef instead of the open-coded function definition.

Signed-off-by: Hui Su <sh_def@163.com>
Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
Documentation/RCU/whatisRCU.rst

index fb3ff76..1a4723f 100644 (file)
@@ -497,8 +497,7 @@ long -- there might be other high-priority work to be done.
 In such cases, one uses call_rcu() rather than synchronize_rcu().
 The call_rcu() API is as follows::
 
-       void call_rcu(struct rcu_head * head,
-                     void (*func)(struct rcu_head *head));
+       void call_rcu(struct rcu_head *head, rcu_callback_t func);
 
 This function invokes func(head) after a grace period has elapsed.
 This invocation might happen from either softirq or process context,