summaryrefslogtreecommitdiffstats
path: root/Documentation/RCU
diff options
context:
space:
mode:
authorPaul E. McKenney <paulmck@linux.vnet.ibm.com>2013-02-12 07:56:27 -0800
committerPaul E. McKenney <paulmck@linux.vnet.ibm.com>2013-03-12 14:09:01 -0700
commit4357fb570b3709c145384065d04b698a30dc722e (patch)
tree2a245674b59344110301402516240d5e77b5bb18 /Documentation/RCU
parentf6161aa153581da4a3867a2d1a7caf4be19b6ec9 (diff)
downloadlinux-stable-4357fb570b3709c145384065d04b698a30dc722e.tar.gz
linux-stable-4357fb570b3709c145384065d04b698a30dc722e.tar.bz2
linux-stable-4357fb570b3709c145384065d04b698a30dc722e.zip
rcu: Make bugginess of code sample more evident
One of the code samples in whatisRCU.txt shows a bug, but someone scanning the document quickly might mistake it for a valid use of RCU. Add some screaming comments to help keep speed-readers on track. Reported-by: Nathan Zimmer <nzimmer@sgi.com> Signed-off-by: Paul E. McKenney <paulmck@linux.vnet.ibm.com> Acked-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Diffstat (limited to 'Documentation/RCU')
-rw-r--r--Documentation/RCU/whatisRCU.txt4
1 files changed, 2 insertions, 2 deletions
diff --git a/Documentation/RCU/whatisRCU.txt b/Documentation/RCU/whatisRCU.txt
index 0cc7820967f4..10df0b82f459 100644
--- a/Documentation/RCU/whatisRCU.txt
+++ b/Documentation/RCU/whatisRCU.txt
@@ -265,9 +265,9 @@ rcu_dereference()
rcu_read_lock();
p = rcu_dereference(head.next);
rcu_read_unlock();
- x = p->address;
+ x = p->address; /* BUG!!! */
rcu_read_lock();
- y = p->data;
+ y = p->data; /* BUG!!! */
rcu_read_unlock();
Holding a reference from one RCU read-side critical section