diff options
| author | David Gwynne <dlg@cvs.openbsd.org> | 2014-02-13 13:16:41 +0000 |
|---|---|---|
| committer | David Gwynne <dlg@cvs.openbsd.org> | 2014-02-13 13:16:41 +0000 |
| commit | 6732462e78bb9a6003921efc212936deecfb7ab1 (patch) | |
| tree | b3c1ab6adfab7b038692886094cd7dd13b905e68 /share/man | |
| parent | 463d19dbea3acf1ad240aecd563259c07c886356 (diff) | |
use the return values section to document return values
Diffstat (limited to 'share/man')
| -rw-r--r-- | share/man/man9/mutex.9 | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/share/man/man9/mutex.9 b/share/man/man9/mutex.9 index 888bafd9ff4..22b2ad7a100 100644 --- a/share/man/man9/mutex.9 +++ b/share/man/man9/mutex.9 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mutex.9,v 1.20 2014/02/13 13:12:32 dlg Exp $ +.\" $OpenBSD: mutex.9,v 1.21 2014/02/13 13:16:40 dlg Exp $ .\" .\" Copyright (c) 2005 Pedro Martelletto <pedro@ambientworks.net> .\" All rights reserved. @@ -63,8 +63,6 @@ function acquires a mutex, spinning if necessary. The .Fn mtx_enter_try function attempts to acquire a mutex. -If it succeeds in acquiring the mutex it will return non-zero, otherwise -it will return 0. .Pp The .Fn mtx_leave @@ -99,6 +97,12 @@ can be called during autoconf, from process context, or from any interrupt context at or below the interrupt level .Fa mtxp was initialised with. +.Sh RETURN VALUES +The +.Fn mtx_enter_try +function will return non-zero If it succeeds in acquiring the mutex +.Fa mtxp , +otherwise it will return 0. .Sh SEE ALSO .Xr lockmgr 9 , .Xr msleep 9 , |