aboutsummaryrefslogtreecommitdiffstats
path: root/include/linux/rcupdate.h
diff options
context:
space:
mode:
authorPaul E. McKenney <paulmck@linux.ibm.com>2018-11-20 08:29:35 -0800
committerPaul E. McKenney <paulmck@linux.ibm.com>2019-01-25 15:35:19 -0800
commit2aa5503026ceaa8860697b93c9e5bbbcd025ba89 (patch)
tree7f55d0315c225711b085d872e0720fc1dfc36abf /include/linux/rcupdate.h
parentMerge branches 'consolidate.2019.01.26a' and 'fwd.2019.01.26a' into HEAD (diff)
downloadlinux-dev-2aa5503026ceaa8860697b93c9e5bbbcd025ba89.tar.xz
linux-dev-2aa5503026ceaa8860697b93c9e5bbbcd025ba89.zip
rcu: Docbook for rcu_head_init() and rcu_head_after_call_rcu()
This commit adds the missing asterisks required to make Sphinx pick up the current header comments for these two functions. Signed-off-by: Paul E. McKenney <paulmck@linux.ibm.com>
Diffstat (limited to 'include/linux/rcupdate.h')
-rw-r--r--include/linux/rcupdate.h6
1 files changed, 3 insertions, 3 deletions
diff --git a/include/linux/rcupdate.h b/include/linux/rcupdate.h
index 0e39e0d2629e..632113946757 100644
--- a/include/linux/rcupdate.h
+++ b/include/linux/rcupdate.h
@@ -859,7 +859,7 @@ static inline notrace void rcu_read_unlock_sched_notrace(void)
/* Has the specified rcu_head structure been handed to call_rcu()? */
-/*
+/**
* rcu_head_init - Initialize rcu_head for rcu_head_after_call_rcu()
* @rhp: The rcu_head structure to initialize.
*
@@ -874,10 +874,10 @@ static inline void rcu_head_init(struct rcu_head *rhp)
rhp->func = (rcu_callback_t)~0L;
}
-/*
+/**
* rcu_head_after_call_rcu - Has this rcu_head been passed to call_rcu()?
* @rhp: The rcu_head structure to test.
- * @func: The function passed to call_rcu() along with @rhp.
+ * @f: The function passed to call_rcu() along with @rhp.
*
* Returns @true if the @rhp has been passed to call_rcu() with @func,
* and @false otherwise. Emits a warning in any other case, including