rcu: Clarify rcu_is_watching() kernel-doc comment
authorPaul E. McKenney <paulmck@kernel.org>
Tue, 23 May 2023 09:22:10 +0000 (02:22 -0700)
committerPaul E. McKenney <paulmck@kernel.org>
Wed, 19 Jul 2023 20:21:28 +0000 (13:21 -0700)
commitc924bf5a43e47d5591d527d39b474f8ca9e63c0e
tree942ef6e2c9ddf2ae5c74f7e4cbb3366d3117cf90
parent6716f4d39c17febf7aa4fa5f5923da67a8d10e85
rcu: Clarify rcu_is_watching() kernel-doc comment

Make it clear that this function always returns either true or false
without other planned failure modes.

Reported-by: Masami Hiramatsu <mhiramat@kernel.org>
Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
Reviewed-by: Joel Fernandes (Google) <joel@joelfernandes.org>
kernel/rcu/tree.c