doc: rcu: Update core and full API in whatisRCU
authorJoel Fernandes (Google) <joel@joelfernandes.org>
Fri, 5 Oct 2018 23:18:10 +0000 (16:18 -0700)
committerPaul E. McKenney <paulmck@linux.ibm.com>
Mon, 12 Nov 2018 16:56:25 +0000 (08:56 -0800)
commit3398496483df3508764d24917deaa8ab5176969e
tree2f3aab93d09c2eb89b2ba3466e9d43cf79a8c3bb
parented8f6fb247785d98ffe6babcf93b7bedd2c88fd8
doc: rcu: Update core and full API in whatisRCU

RCU consolidation effort causes the update side of the RCU API to
be consistent across all the 3 RCU flavors (normal, sched, bh). This
commit therefore updates the full API in the whatisRCU document, thus
encouraging people to use the consolidated RCU update API instead of
the old RCU-bh and RCU-sched update APIs.

Also rcu_dereference is documented to be the same for all 3 mechanisms
(even before the consolidation), however its actually different - as
using the right rcu_dereference primitive (such as rcu_dereference_bh
for bh) is needed to make lock debugging work correctly. This update
also corrects that.

Also, add local_bh_disable() and local_bh_enable() as softirq
protection primitives and correct a grammar error in a quiz answer.

Signed-off-by: Joel Fernandes (Google) <joel@joelfernandes.org>
Signed-off-by: Paul E. McKenney <paulmck@linux.ibm.com>
Documentation/RCU/whatisRCU.txt