linux-stable/Documentation/RCU
Jason A. Donenfeld 2c4ac34bc2 documentation: Correct doc to use rcu_dereference_protected
As there is lots of misinformation and outdated information on the
Internet about nearly all topics related to the kernel, I thought it
would be best if I based my RCU code on the guidelines of the examples
in the Documentation/ tree of the latest kernel. One thing that stuck
out when reading the whatisRCU.txt document was, "interesting how we
don't need any function to dereference rcu protected pointers when doing
updates if a lock is held. I wonder how static analyzers will work with
that." Then, a few weeks later, upon discovering sparse's __rcu support,
I ran it over my code, and lo and behold, things weren't done right.
Examining other RCU usages in the kernel reveal consistent usage of
rcu_dereference_protected, passing in lockdep_is_held as the
conditional. So, this patch adds that idiom to the documentation, so
that others ahead of me won't endure the same exercise.

Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
Signed-off-by: Paul E. McKenney <paulmck@linux.vnet.ibm.com>
Reviewed-by: Josh Triplett <josh@joshtriplett.org>
2015-10-06 11:22:43 -07:00
..
00-INDEX documentation: Record rcu_dereference() value mishandling 2014-04-29 08:38:33 -07:00
arrayRCU.txt documentation: RCU-protected array indexes no longer supported 2015-05-27 12:56:17 -07:00
checklist.txt documentation: Record rcu_dereference() value mishandling 2014-04-29 08:38:33 -07:00
listRCU.txt rcu: Update docs to include kfree_rcu() 2012-11-08 11:44:25 -08:00
lockdep-splat.txt rcu: Document interpretation of RCU-lockdep splats 2011-09-28 21:38:28 -07:00
lockdep.txt documentation: RCU-protected array indexes no longer supported 2015-05-27 12:56:17 -07:00
NMI-RCU.txt rcu: Fix RCU's NMI documentation 2011-09-28 21:36:44 -07:00
rcu.txt rcu: Remove redundant TREE_PREEMPT_RCU config option 2014-10-29 10:20:05 -07:00
rcu_dereference.txt documentation: Fix spelling of "operators" 2015-07-15 14:43:10 -07:00
rcubarrier.txt rcu: Fix rcu_barrier() documentation 2013-08-18 17:05:32 -07:00
rculist_nulls.txt netfilter: nf_conntrack: nf_conntrack_alloc() fixes 2009-07-16 14:03:40 +02:00
rcuref.txt documentation: Add pointer to percpu-ref for RCU and refcount 2014-07-08 08:32:56 -07:00
RTFP.txt Doc: Change wikipedia's URL from http to https 2015-06-22 10:14:05 -06:00
stallwarn.txt documentation: Call out slow consoles as cause of stall warnings 2015-10-06 11:22:38 -07:00
torture.txt rcu: Increase rcutorture test coverage 2013-08-20 11:38:41 -07:00
trace.txt rcu: Add fastpath bypassing funnel locking 2015-07-17 14:59:06 -07:00
UP.txt rcu: Add synchronize_sched_expedited() rcutorture doc + updates 2009-07-03 10:02:29 +02:00
whatisRCU.txt documentation: Correct doc to use rcu_dereference_protected 2015-10-06 11:22:43 -07:00