srcu: Improve srcu_read_lock_lite() kernel-doc comment

paulmckrcu · Frederic Weisbecker · commit 768b1f87098a · 2024-11-12T15:45:12.000+01:00
Where RCU is watching is where it is OK to invoke rcu_read_lock().

Reported-by: Andrii Nakryiko &lt;andrii@kernel.org&gt;
Signed-off-by: Paul E. McKenney &lt;paulmck@kernel.org&gt;
Acked-by: Andrii Nakryiko &lt;andrii@kernel.org&gt;
Reviewed-by: Neeraj Upadhyay &lt;Neeraj.Upadhyay@amd.com&gt;
Signed-off-by: Frederic Weisbecker &lt;frederic@kernel.org&gt;
diff --git a/include/linux/srcu.h b/include/linux/srcu.h
@@ -270,7 +270,8 @@ static inline int srcu_read_lock(struct srcu_struct *ssp) __acquires(ssp)
  * synchronize_rcu_expedited(), IPIs and all.
  *
  * Note that srcu_read_lock_lite() can be invoked only from those contexts
- * where RCU is watching.  Otherwise, lockdep will complain.
+ * where RCU is watching, that is, from contexts where it would be legal
+ * to invoke rcu_read_lock().  Otherwise, lockdep will complain.
  */
 static inline int srcu_read_lock_lite(struct srcu_struct *ssp) __acquires(ssp)
 {

Original file line number	Diff line number	Diff line change
`@@ -270,7 +270,8 @@ static inline int srcu_read_lock(struct srcu_struct *ssp) __acquires(ssp)`
`270`	`270`	`* synchronize_rcu_expedited(), IPIs and all.`
`271`	`271`	`*`
`272`	`272`	`* Note that srcu_read_lock_lite() can be invoked only from those contexts`
`273`		`- * where RCU is watching. Otherwise, lockdep will complain.`
	`273`	`+ * where RCU is watching, that is, from contexts where it would be legal`
	`274`	`+ * to invoke rcu_read_lock(). Otherwise, lockdep will complain.`
`274`	`275`	`*/`
`275`	`276`	`static inline int srcu_read_lock_lite(struct srcu_struct *ssp) __acquires(ssp)`
`276`	`277`	`{`