Commit dfe442c9 authored by Paul E. McKenney's avatar Paul E. McKenney Committed by Boqun Feng
Browse files

srcu: Fix srcu_read_unlock_{lite,nmisafe}() kernel-doc 



The srcu_read_unlock_lite() and srcu_read_unlock_nmisafe() both say that
their idx parameters must come from srcu_read_lock().  This would be bad,
because a given srcu_struct structure may be used only with one flavor of
SRCU reader.  This commit therefore updates the srcu_read_unlock_lite()
kernel-doc header to say that its idx parameter must be obtained
from srcu_read_lock_lite() and the srcu_read_unlock_nmisafe()
kernel-doc header to say that its idx parameter must be obtained from
srcu_read_lock_nmisafe().

Signed-off-by: default avatarPaul E. McKenney <paulmck@kernel.org>
Signed-off-by: default avatarBoqun Feng <boqun.feng@gmail.com>
parent c143bac0

include/linux/srcu.h

+2 −2
Original line number Diff line number Diff line
@@ -402,7 +402,7 @@ static inline void srcu_read_unlock_fast(struct srcu_struct *ssp, struct srcu_ct 
/**

 * srcu_read_unlock_lite - unregister a old reader from an SRCU-protected structure.

 * @ssp: srcu_struct in which to unregister the old reader.

 * @idx: return value from corresponding srcu_read_lock().

 * @idx: return value from corresponding srcu_read_lock_lite().

 *

 * Exit a light-weight SRCU read-side critical section.

 */
@@ -418,7 +418,7 @@ static inline void srcu_read_unlock_lite(struct srcu_struct *ssp, int idx) 
/**

 * srcu_read_unlock_nmisafe - unregister a old reader from an SRCU-protected structure.

 * @ssp: srcu_struct in which to unregister the old reader.

 * @idx: return value from corresponding srcu_read_lock().

 * @idx: return value from corresponding srcu_read_lock_nmisafe().

 *

 * Exit an SRCU read-side critical section, but in an NMI-safe manner.

 */