rcu: fix kerneldoc comments in rcuupdate.h
PATCH v2 1/1 rcu: fix kerneldoc comments in rcuupdate.h
Fix 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.
---
v2: extend commit message to explain added "()" after functio names
include/linux/rcupdate.h | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-)
include/linux/rcupdate.h +6 -6
@@ -709,8 +709,8 @@ static inline void rcu_read_lock_bh(void) "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. */
@@ -751,10 +751,10 @@ static inline notrace void rcu_read_lock_sched_notrace(void)__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 ) {
@@ -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. * @f: The function passed to call_rcu() along with @rhp. *
Signature · 1 line
2.27.0
Quoted 7 lines · Tobias Klauser
Fix the kerneldoc comments for
rcu_read_unlock_bh(),rcu_read_unlock_sched()andrcu_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 <[email protected]>
Queued, thank you!
Thanx, Paul
Quoted 47 lines
---
v2: extend commit message to explain added "()" after functio namesinclude/linux/rcupdate.h | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-)include/linux/rcupdate.h +6
-6@@ -709,8 +709,8 @@ static inline void rcu_read_lock_bh(void) "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. */ @@ -751,10 +751,10 @@ static inline notrace void rcu_read_lock_sched_notrace(void)__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 ) {@@ -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. * @f: The function passed to call_rcu() along with @rhp. * Signature · 1 line
2.27.0