Commit d98d38f2 authored Oct 29, 2008 by Arjan van de Ven Committed by Ingo Molnar Oct 30, 2008

mutex: improve header comment to be actually informative about the API



Impact: improve documentation

It's nice to say that mutex_trylock follows the spin_trylock convention.
It's a lot nicer if the comment also says which that is...  make it so.

Signed-off-by: Arjan van de Ven <arjan@linux.intel.com>
Signed-off-by: Ingo Molnar <mingo@elte.hu>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>

parent d1a76187

include/linux/mutex.h

+2 −0

Original line number	Diff line number	Diff line
		@@ -144,6 +144,8 @@ extern int __must_check mutex_lock_killable(struct mutex *lock);
		/*
		* NOTE: mutex_trylock() follows the spin_trylock() convention,
		* not the down_trylock() convention!
		*
		* Returns 1 if the mutex has been acquired successfully, and 0 on contention.
		*/
		extern int mutex_trylock(struct mutex *lock);
		extern void mutex_unlock(struct mutex *lock);