rcu: Fix kerneldoc comments in rcupdate.h

This commit fixes the kerneldoc comments for rcu_read_unlock_bh(),
rcu_read_unlock_sched() and rcu_head_after_call_rcu() so they e.g. get
properly linked in the API documentation. Also add parenthesis after
function names to match the notation used in other kerneldoc comments in
the same file.

Signed-off-by: Tobias Klauser <tklauser@distanz.ch>
Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
This commit is contained in:
Tobias Klauser
2020-07-09 15:05:59 +02:00
committed by Paul E. McKenney
parent 1ef5a442a1
commit 000601bb62

View File

@@ -709,8 +709,8 @@ static inline void rcu_read_lock_bh(void)
"rcu_read_lock_bh() used illegally while idle"); "rcu_read_lock_bh() used illegally while idle");
} }
/* /**
* rcu_read_unlock_bh - marks the end of a softirq-only RCU critical section * rcu_read_unlock_bh() - marks the end of a softirq-only RCU critical section
* *
* See rcu_read_lock_bh() for more information. * See rcu_read_lock_bh() for more information.
*/ */
@@ -751,10 +751,10 @@ static inline notrace void rcu_read_lock_sched_notrace(void)
__acquire(RCU_SCHED); __acquire(RCU_SCHED);
} }
/* /**
* rcu_read_unlock_sched - marks the end of a RCU-classic critical section * rcu_read_unlock_sched() - marks the end of a RCU-classic critical section
* *
* See rcu_read_lock_sched for more information. * See rcu_read_lock_sched() for more information.
*/ */
static inline void rcu_read_unlock_sched(void) static inline void rcu_read_unlock_sched(void)
{ {
@@ -945,7 +945,7 @@ static inline void rcu_head_init(struct rcu_head *rhp)
} }
/** /**
* rcu_head_after_call_rcu - Has this rcu_head been passed to call_rcu()? * rcu_head_after_call_rcu() - Has this rcu_head been passed to call_rcu()?
* @rhp: The rcu_head structure to test. * @rhp: The rcu_head structure to test.
* @f: The function passed to call_rcu() along with @rhp. * @f: The function passed to call_rcu() along with @rhp.
* *