aboutsummaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
authorRandy Dunlap <randy.dunlap@oracle.com>2010-09-02 15:48:16 -0700
committerIngo Molnar <mingo@elte.hu>2010-09-03 08:19:51 +0200
commitef5dc121d5a0bb1fa477c5395277259f07d318a3 (patch)
tree5af1d24406aa014eed72f07097316ba6f7d0d04f /include
parent950eaaca681c44aab87a46225c9e44f902c080aa (diff)
downloadmrst-s0i3-test-ef5dc121d5a0bb1fa477c5395277259f07d318a3.tar.gz
mrst-s0i3-test-ef5dc121d5a0bb1fa477c5395277259f07d318a3.tar.xz
mrst-s0i3-test-ef5dc121d5a0bb1fa477c5395277259f07d318a3.zip
mutex: Fix annotations to include it in kernel-locking docbook
Fix kernel-doc notation in linux/mutex.h and kernel/mutex.c, then add these 2 files to the kernel-locking docbook as the Mutex API reference chapter. Add one API function to mutex-design.txt and correct a typo in that file. Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com> Cc: Rusty Russell <rusty@rustcorp.com.au> LKML-Reference: <20100902154816.6cc2f9ad.randy.dunlap@oracle.com> Signed-off-by: Ingo Molnar <mingo@elte.hu>
Diffstat (limited to 'include')
-rw-r--r--include/linux/mutex.h8
1 files changed, 8 insertions, 0 deletions
diff --git a/include/linux/mutex.h b/include/linux/mutex.h
index 878cab4f5fc..f363bc8fdc7 100644
--- a/include/linux/mutex.h
+++ b/include/linux/mutex.h
@@ -78,6 +78,14 @@ struct mutex_waiter {
# include <linux/mutex-debug.h>
#else
# define __DEBUG_MUTEX_INITIALIZER(lockname)
+/**
+ * mutex_init - initialize the mutex
+ * @mutex: the mutex to be initialized
+ *
+ * Initialize the mutex to unlocked state.
+ *
+ * It is not allowed to initialize an already locked mutex.
+ */
# define mutex_init(mutex) \
do { \
static struct lock_class_key __key; \