[PATCH] Document SPIN_LOCK_UNLOCKED/RW_LOCK_UNLOCKED deprecation

From: Michael Ellerman
Date: Tue Apr 17 2007 - 21:41:47 EST


Apparently it's not cool anymore to use SPIN/RW_LOCK_UNLOCKED.
There's some mention of this in Documentation/spinlocks.txt, but that
only talks about dynamic initialisation.

A comment in the code mentioning the preferred usage would be good IMHO.

Signed-off-by: Michael Ellerman <michael@xxxxxxxxxxxxxx>
---

include/linux/spinlock_types.h | 5 +++++
1 file changed, 5 insertions(+)

Index: powerpc/include/linux/spinlock_types.h
===================================================================
--- powerpc.orig/include/linux/spinlock_types.h
+++ powerpc/include/linux/spinlock_types.h
@@ -85,6 +85,11 @@ typedef struct {
RW_DEP_MAP_INIT(lockname) }
#endif

+/*
+ * SPIN_LOCK_UNLOCKED and RW_LOCK_UNLOCKED are deprecated.
+ * Please use DEFINE_SPINLOCK()/DEFINE_RWLOCK() or
+ * __SPIN_LOCK_UNLOCKED()/__RW_LOCK_UNLOCKED() as appropriate.
+ */
#define SPIN_LOCK_UNLOCKED __SPIN_LOCK_UNLOCKED(old_style_spin_init)
#define RW_LOCK_UNLOCKED __RW_LOCK_UNLOCKED(old_style_rw_init)

-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/