Spell out behavior of atomic_dec_and_lock() in kerneldoc

A little more detail here wouldn't hurt.

Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
J. Bruce Fields 2008-04-07 15:59:05 -04:00 committed by Jonathan Corbet
parent b40b5162ac
commit dc07e721a2
1 changed files with 3 additions and 0 deletions

View File

@ -341,6 +341,9 @@ static inline void double_spin_unlock(spinlock_t *l1, spinlock_t *l2,
* atomic_dec_and_lock - lock on reaching reference count zero * atomic_dec_and_lock - lock on reaching reference count zero
* @atomic: the atomic counter * @atomic: the atomic counter
* @lock: the spinlock in question * @lock: the spinlock in question
*
* Decrements @atomic by 1. If the result is 0, returns true and locks
* @lock. Returns false for all other cases.
*/ */
extern int _atomic_dec_and_lock(atomic_t *atomic, spinlock_t *lock); extern int _atomic_dec_and_lock(atomic_t *atomic, spinlock_t *lock);
#define atomic_dec_and_lock(atomic, lock) \ #define atomic_dec_and_lock(atomic, lock) \