Add comment for chopstx_mutex_lock.

Signed-off-by: NIIBE Yutaka <gniibe@fsij.org>
2021-10-04 09:26:50 +09:00
parent 5a3a3e98d4
commit d36e9274b1
1 changed files with 3 additions and 1 deletions
--- a/chopstx.c
+++ b/chopstx.c
@@ -949,7 +949,9 @@ chopstx_mutex_lock (chopstx_mutex_t *mutex)
 * chopstx_mutex_unlock - Unlock the mutex
 * @mutex: Mutex
 *
- * Unlock @mutex.
+ * Unlock @mutex.  Note that Chopstx doesn't allow unlocking by
+ * non-owner of the lock.  chopstx_mutex_unlock should be called
+ * by a thread which did chopstx_mutex_lock.
 */
 void
 chopstx_mutex_unlock (chopstx_mutex_t *mutex)