diff options
| author | J. Bruce Fields <bfields@citi.umich.edu> | 2008-04-07 15:59:05 -0400 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2008-04-11 13:17:46 -0600 |
| commit | dc07e721a26ec7e0adb66340f1763d220cfbbd0c (patch) | |
| tree | b31b5d9d826c4b2e161a0f3e833dab95abb5f6c1 /include/linux/spinlock.h | |
| parent | b40b5162ac4e5b94d16cd9fb0a87168b1633c7dd (diff) | |
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>
Diffstat (limited to 'include/linux/spinlock.h')
| -rw-r--r-- | include/linux/spinlock.h | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/include/linux/spinlock.h b/include/linux/spinlock.h index 576a5f77d3bd..1129ee0a7180 100644 --- a/include/linux/spinlock.h +++ b/include/linux/spinlock.h @@ -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: the atomic counter * @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); #define atomic_dec_and_lock(atomic, lock) \ |