doc: Make reader aware of rcu_dereference_protected
authorJoel Fernandes (Google) <joel@joelfernandes.org>
Tue, 9 Oct 2018 01:33:41 +0000 (18:33 -0700)
committerPaul E. McKenney <paulmck@linux.ibm.com>
Mon, 12 Nov 2018 16:56:25 +0000 (08:56 -0800)
commit93eb14201fc690687c2d94865bc38c1aa23356b8
treec724b95dbf03d099e65a96de629b7ea965e779db
parent1c7d6d4411a1ce7530cbdc4605261c560e07d51a
doc: Make reader aware of rcu_dereference_protected

The whatisRCU.txt document says rcu_dereference() cannot be used
outside of rcu_read_lock() protected sections.  The commit adds a
mention of rcu_dereference_protected(), so that the new reader knows
that this API can be used to avoid update-side use of rcu_read_lock()
and rcu_read_unlock().

Cc: tytso@mit.edu
Suggested-by: tytso@mit.edu
Signed-off-by: Joel Fernandes (Google) <joel@joelfernandes.org>
[ paulmck: Update wording, including further feedback from Joel. ]
Signed-off-by: Paul E. McKenney <paulmck@linux.ibm.com>
Documentation/RCU/whatisRCU.txt