rcu: Improve rcu_assign_pointer() and RCU_INIT_POINTER() documentation
authorPaul E. McKenney <paulmck@linux.vnet.ibm.com>
Mon, 1 Aug 2011 05:33:02 +0000 (22:33 -0700)
committerPaul E. McKenney <paulmck@linux.vnet.ibm.com>
Thu, 29 Sep 2011 04:38:34 +0000 (21:38 -0700)
commit6846c0c54074d47927c90eab4a805115e1ae3292
tree8f074445ca802a48d976b9a9c8595ac7fe603f22
parentd322f45ceed525daa9401154590bbae3222cfefb
rcu: Improve rcu_assign_pointer() and RCU_INIT_POINTER() documentation

The differences between rcu_assign_pointer() and RCU_INIT_POINTER() are
subtle, and it is easy to use the the cheaper RCU_INIT_POINTER() when
the more-expensive rcu_assign_pointer() should have been used instead.
The consequences of this mistake are quite severe.

This commit therefore carefully lays out the situations in which it it
permissible to use RCU_INIT_POINTER().

Signed-off-by: Paul E. McKenney <paulmck@linux.vnet.ibm.com>
include/linux/rcupdate.h