Skip to contentSkip to conversation

rtmutex.c: Documentation cleanup

PATCH In review Luis Henriques 1 participant 2 messages Apr 29, 2009

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 rtmutex.c: Documentation cleanup

Two minor updates on functions documentation:
- Updated documentation for function rt_mutex_unlock(), which contained an incorrect name
- Removed extra '*' from comment in function rt_mutex_destroy()

---
 kernel/rtmutex.c |    8 ++++----
 1 files changed, 4 insertions(+), 4 deletions(-)
kernel/rtmutex.c +4 -4
index fec77e7..820c5af 100644
@@ -891,9 +891,9 @@ int __sched rt_mutex_lock_interruptible(struct rt_mutex *lock,
 EXPORT_SYMBOL_GPL(rt_mutex_lock_interruptible);
 
 /**
- * rt_mutex_lock_interruptible_ktime - lock a rt_mutex interruptible
- *				       the timeout structure is provided
- *				       by the caller
+ * rt_mutex_timed_lock - lock a rt_mutex interruptible
+ *			the timeout structure is provided
+ *			by the caller
  *
  * @lock: 		the rt_mutex to be locked
  * @timeout:		timeout structure or NULL (no timeout)
@@ -940,7 +940,7 @@ void __sched rt_mutex_unlock(struct rt_mutex *lock)
 }
 EXPORT_SYMBOL_GPL(rt_mutex_unlock);
 
-/***
+/**
  * rt_mutex_destroy - mark a mutex unusable
  * @lock: the mutex to be destroyed
  *
Signature · 1 line
1.6.2.4
#1 lore raw

[tip:core/locking] locking, rtmutex.c: Documentation cleanup

Commit-ID:  23b94b967f118bef941369238f33c8140be46539
Gitweb:     http://git.kernel.org/tip/23b94b967f118bef941369238f33c8140be46539
Author:     Luis Henriques <[email protected]>
AuthorDate: Wed, 29 Apr 2009 21:54:51 +0100
Committer:  Ingo Molnar <[email protected]>
CommitDate: Wed, 29 Apr 2009 23:20:17 +0200

locking, rtmutex.c: Documentation cleanup

Two minor updates on functions documentation:
- Updated documentation for function rt_mutex_unlock(), which contained an incorrect name
- Removed extra '*' from comment in function rt_mutex_destroy()

[ Impact: cleanup ]

LKML-Reference: <[email protected]>

---
 kernel/rtmutex.c |    8 ++++----
 1 files changed, 4 insertions(+), 4 deletions(-)
kernel/rtmutex.c +4 -4
index 69d9cb9..013882e 100644
@@ -864,9 +864,9 @@ int __sched rt_mutex_lock_interruptible(struct rt_mutex *lock,
 EXPORT_SYMBOL_GPL(rt_mutex_lock_interruptible);
 
 /**
- * rt_mutex_lock_interruptible_ktime - lock a rt_mutex interruptible
- *				       the timeout structure is provided
- *				       by the caller
+ * rt_mutex_timed_lock - lock a rt_mutex interruptible
+ *			the timeout structure is provided
+ *			by the caller
  *
  * @lock: 		the rt_mutex to be locked
  * @timeout:		timeout structure or NULL (no timeout)
@@ -913,7 +913,7 @@ void __sched rt_mutex_unlock(struct rt_mutex *lock)
 }
 EXPORT_SYMBOL_GPL(rt_mutex_unlock);
 
-/***
+/**
  * rt_mutex_destroy - mark a mutex unusable
  * @lock: the mutex to be destroyed
  *