diff options
author | ru <ru@FreeBSD.org> | 2001-07-11 09:13:12 +0000 |
---|---|---|
committer | ru <ru@FreeBSD.org> | 2001-07-11 09:13:12 +0000 |
commit | a6a8d8e94c3416ac2be5564086b6711fab5cf1fb (patch) | |
tree | 206baa92baf082e97ad39990cf628c3e57e1117d | |
parent | a6c5eadb9c2c57714a0ec47fc78094e5e3e61bf7 (diff) | |
download | FreeBSD-src-a6a8d8e94c3416ac2be5564086b6711fab5cf1fb.zip FreeBSD-src-a6a8d8e94c3416ac2be5564086b6711fab5cf1fb.tar.gz |
mdoc(7) police: fixed markup.
-rw-r--r-- | share/man/man9/BUF_LOCK.9 | 41 | ||||
-rw-r--r-- | share/man/man9/BUF_LOCKFREE.9 | 27 | ||||
-rw-r--r-- | share/man/man9/BUF_LOCKINIT.9 | 26 | ||||
-rw-r--r-- | share/man/man9/BUF_REFCNT.9 | 24 | ||||
-rw-r--r-- | share/man/man9/BUF_TIMELOCK.9 | 48 | ||||
-rw-r--r-- | share/man/man9/BUF_UNLOCK.9 | 29 |
6 files changed, 111 insertions, 84 deletions
diff --git a/share/man/man9/BUF_LOCK.9 b/share/man/man9/BUF_LOCK.9 index 289e72d..9cb929b 100644 --- a/share/man/man9/BUF_LOCK.9 +++ b/share/man/man9/BUF_LOCK.9 @@ -31,33 +31,42 @@ .Os .Sh NAME .Nm BUF_LOCK -.Nd "Locks a buffer" +.Nd "locks a buffer" .Sh SYNOPSIS -.Fd #include <sys/param.h> -.Fd #include <sys/buf.h> +.In sys/param.h +.In sys/buf.h .Ft int .Fn BUF_LOCK "struct buf *bp" "int locktype" .Sh DESCRIPTION The -.Nm -function locks the given buffer. If the lock is already held this -call will block until it can aquire the lock unless LK_NOWAIT is -set. +.Fn BUF_LOCK +function locks the given buffer. +If the lock is already held this +call will block until it can aquire the lock unless +.Dv LK_NOWAIT +is set. .Pp Its arguments are: -.Bl -tag -width locktype -.It Ar bp +.Bl -tag -xwidth ".Fa locktype" +.It Fa bp The buffer to lock. -.It Ar locktype -Flags controlling the type of lock. See lockmgr(9) for details. +.It Fa locktype +Flags controlling the type of lock. +See +.Xr lockmgr 9 +for details. .El .Sh RETURN VALUES -A value of 0 is returned upon success. See lockmgr(9) for +A value of 0 is returned upon success. +See +.Xr lockmgr 9 +for information on non-zero return values. .Sh SEE ALSO -.Xr buf 9 +.Xr buf 9 , +.Xr BUF_TIMELOCK 9 , +.Xr BUF_UNLOCK 9 , .Xr lockmgr 9 -.Xr BUF_UNLOCK 9 -.Xr BUF_TIMELOCK 9 .Sh AUTHORS -This man page was written by Chad David. +This man page was written by +.An Chad David . diff --git a/share/man/man9/BUF_LOCKFREE.9 b/share/man/man9/BUF_LOCKFREE.9 index 7d90a92..62b0848 100644 --- a/share/man/man9/BUF_LOCKFREE.9 +++ b/share/man/man9/BUF_LOCKFREE.9 @@ -31,27 +31,30 @@ .Os .Sh NAME .Nm BUF_LOCKFREE -.Nd "Destroys the buffers lock" +.Nd "destroys the buffers lock" .Sh SYNOPSIS -.Fd #include <sys/param.h> -.Fd #include <sys/buf.h> +.In sys/param.h +.In sys/buf.h .Ft void .Fn BUF_LOCKFREE "struct buf *bp" .Sh DESCRIPTION The -.Nm -macro destroys the buffer lock. The lock must not be held when +.Fn BUF_LOCKFREE +macro destroys the buffer lock. +The lock must not be held when this macro is called or a panic will result. .Pp Its argument is: -.Bl -tag -.It Ar bp +.Bl -tag -xwidth ".Fa bp" +.It Fa bp The buffer whose lock is to be destroyed. +.El .Sh SEE ALSO -.Xr buf 9 +.Xr buf 9 , +.Xr BUF_LOCK 9 , +.Xr BUF_TIMELOCK 9 , +.Xr BUF_UNLOCK 9 , .Xr lockdestroy 9 -.Xr BUF_LOCK 9 -.Xr BUF_TIMELOCK 9 -.Xr BUF_UNLOCK 9 .Sh AUTHORS -This man page was written by Chad David. +This man page was written by +.An Chad David . diff --git a/share/man/man9/BUF_LOCKINIT.9 b/share/man/man9/BUF_LOCKINIT.9 index 073364a..0c61559 100644 --- a/share/man/man9/BUF_LOCKINIT.9 +++ b/share/man/man9/BUF_LOCKINIT.9 @@ -31,27 +31,29 @@ .Os .Sh NAME .Nm BUF_LOCKINIT -.Nd "Unlocks a locked buffer" +.Nd "unlocks a locked buffer" .Sh SYNOPSIS -.Fd #include <sys/param.h> -.Fd #include <sys/buf.h> +.In sys/param.h +.In sys/buf.h .Ft void .Fn BUF_LOCKINIT "struct buf *bp" .Sh DESCRIPTION The -.Nm +.Fn BUF_LOCKINIT macro initializes a buffer lock. .Pp Its argument is: -.Bl -tag -.It Ar bp +.Bl -tag -xwidth ".Fa bp" +.It Fa bp The buffer whose lock it to be initialized. +.El .Sh SEE ALSO -.Xr buf 9 +.Xr buf 9 , +.Xr BUF_LOCK 9 , +.Xr BUF_TIMELOCK 9 , +.Xr BUF_UNLOCK 9 , +.Xr lockinit 9 , .Xr lockmgr 9 -.Xr lockinit 9 -.Xr BUF_LOCK 9 -.Xr BUF_TIMELOCK 9 -.Xr BUF_UNLOCK 9 .Sh AUTHORS -This man page was written by Chad David. +This man page was written by +.An Chad David . diff --git a/share/man/man9/BUF_REFCNT.9 b/share/man/man9/BUF_REFCNT.9 index e0e0cf5c..9794f8c 100644 --- a/share/man/man9/BUF_REFCNT.9 +++ b/share/man/man9/BUF_REFCNT.9 @@ -31,26 +31,28 @@ .Os .Sh NAME .Nm BUF_REFCNT -.Nd "Returns the reference count of the buffer lock" +.Nd "returns the reference count of the buffer lock" .Sh SYNOPSIS -.Fd #include <sys/param.h> -.Fd #include <sys/buf.h> +.In sys/param.h +.In sys/buf.h .Ft int .Fn BUF_REFCNT "struct buf *bp" .Sh DESCRIPTION The -.Nm +.Fn BUF_REFCNT function returns the reference count of the buffer lock. .Pp Its argument is: -.Bl -tag -.It Ar bp +.Bl -tag -xwidth ".Fa bp" +.It Fa bp The buffer whose lock reference count is to be returned. +.El .Sh SEE ALSO -.Xr buf 9 +.Xr buf 9 , +.Xr BUF_LOCK 9 , +.Xr BUF_TIMELOCK 9 , +.Xr BUF_UNLOCK 9 , .Xr lockcount 9 -.Xr BUF_LOCK 9 -.Xr BUF_TIMELOCK 9 -.Xr BUF_UNLOCK 9 .Sh AUTHORS -This man page was written by Chad David. +This man page was written by +.An Chad David . diff --git a/share/man/man9/BUF_TIMELOCK.9 b/share/man/man9/BUF_TIMELOCK.9 index 067e9dd..cb029ee 100644 --- a/share/man/man9/BUF_TIMELOCK.9 +++ b/share/man/man9/BUF_TIMELOCK.9 @@ -31,44 +31,50 @@ .Os .Sh NAME .Nm BUF_TIMELOCK -.Nd "Locks a buffer" +.Nd "locks a buffer" .Sh SYNOPSIS -.Fd #include <sys/param.h> -.Fd #include <sys/buf.h> +.In sys/param.h +.In sys/buf.h .Ft int .Fn BUF_TIMELOCK "struct buf *bp" "int locktype" "char *wmesg" "int catch" "int timo" .Sh DESCRIPTION The -.Nm +.Fn BUF_TIMELOCK function locks the given buffer, and limits the amount of time it will sleep to -.Ar timo +.Fa timo and OR's -.Ar catch +.Fa catch into the sleep priority. -.Ar wmesg +.Fa wmesg is the wmesg used in the sleep. .Pp Its arguments are: -.Bl -tag -width locktype -.It Ar bp +.Bl -tag -xwidth ".Fa locktype" +.It Fa bp The buffer to lock. -.It Ar locktype -Flags controlling the type of lock. See lockmgr(9) for details. -.It Ar wmesg +.It Fa locktype +Flags controlling the type of lock. +See +.Xr lockmgr 9 +for details. +.It Fa wmesg The wmesg used in any sleeps while aquiring the lock. -.It Ar catch +.It Fa catch Priority OR'd into the sleep priority. -.It Ar timo +.It Fa timo The timeout for any sleeps encountered during the lock. .El -.Sh RETURN VALUE -A value of 0 is returned on success. See lockmgr(9) for -details on non-zero return values. +.Sh RETURN VALUES +A value of 0 is returned on success. +See +.Xr lockmgr 9 +for details on non-zero return values. .Sh SEE ALSO -.Xr buf 9 +.Xr buf 9 , +.Xr BUF_LOCK 9 , +.Xr BUF_UNLOCK 9 , .Xr lockmgr 9 -.Xr BUF_LOCK 9 -.Xr BUF_UNLOCK 9 .Sh AUTHORS -This man page was written by Chad David. +This man page was written by +.An Chad David . diff --git a/share/man/man9/BUF_UNLOCK.9 b/share/man/man9/BUF_UNLOCK.9 index 271abca..2dad9d1 100644 --- a/share/man/man9/BUF_UNLOCK.9 +++ b/share/man/man9/BUF_UNLOCK.9 @@ -31,26 +31,31 @@ .Os .Sh NAME .Nm BUF_UNLOCK -.Nd "Unlocks a locked buffer" +.Nd "unlocks a locked buffer" .Sh SYNOPSIS -.Fd #include <sys/param.h> -.Fd #include <sys/buf.h> +.In sys/param.h +.In sys/buf.h .Ft void .Fn BUF_UNLOCK "struct buf *bp" .Sh DESCRIPTION The -.Nm +.Fn BUF_UNLOCK function unlocks a buffer that was previously locked with -BUF_LOCK or BUF_TIMELOCK. +.Fn BUF_LOCK +or +.Fn BUF_TIMELOCK . .Pp Its argument is: -.Bl -tag -.It Ar bp -The buffer to unlock. The buffer must already be locked. +.Bl -tag -xwidth ".Fa bp" +.It Fa bp +The buffer to unlock. +The buffer must already be locked. +.El .Sh SEE ALSO -.Xr buf 9 +.Xr buf 9 , +.Xr BUF_LOCK 9 , +.Xr BUF_TIMELOCK 9 , .Xr lockmgr 9 -.Xr BUF_LOCK 9 -.Xr BUF_TIMELOCK 9 .Sh AUTHORS -This man page was written by Chad David. +This man page was written by +.An Chad David . |