atomics: Add header comment so spin_unlock_wait()
authorPaul E. McKenney <paulmck@linux.vnet.ibm.com>
Wed, 19 Apr 2017 23:20:07 +0000 (16:20 -0700)
committerPaul E. McKenney <paulmck@linux.vnet.ibm.com>
Thu, 8 Jun 2017 15:25:29 +0000 (08:25 -0700)
commit6016ffc3874d3a1ddf41518481da54b4714717af
tree3746c96e1cfffb9d5f740082ddff6e9454230680
parent79269ee3fa1da52f392f8a4ebf3082152c1c8c58
atomics: Add header comment so spin_unlock_wait()

There is material describing the ordering guarantees provided by
spin_unlock_wait(), but it is not necessarily easy to find.  This commit
therefore adds a docbook header comment to this function informally
describing its semantics.

Signed-off-by: Paul E. McKenney <paulmck@linux.vnet.ibm.com>
Acked-by: Peter Zijlstra <peterz@infradead.org>
include/linux/spinlock.h