mdoc(7) police: minor markup nits.
This commit is contained in:
parent
3a47359931
commit
05cb5024af
Notes:
svn2git
2020-12-20 02:59:44 +00:00
svn path=/head/; revision=97597
@ -41,9 +41,9 @@
|
|||||||
.In sys/param.h
|
.In sys/param.h
|
||||||
.In sys/lock.h
|
.In sys/lock.h
|
||||||
.In sys/mutex.h
|
.In sys/mutex.h
|
||||||
.Ft struct mtx *
|
.Ft "struct mtx *"
|
||||||
.Fn mtx_pool_alloc "void"
|
.Fn mtx_pool_alloc "void"
|
||||||
.Ft struct mtx *
|
.Ft "struct mtx *"
|
||||||
.Fn mtx_pool_find "void *ptr"
|
.Fn mtx_pool_find "void *ptr"
|
||||||
.Ft void
|
.Ft void
|
||||||
.Fn mtx_pool_lock "void *ptr"
|
.Fn mtx_pool_lock "void *ptr"
|
||||||
@ -51,13 +51,13 @@
|
|||||||
.Fn mtx_pool_unlock "void *ptr"
|
.Fn mtx_pool_unlock "void *ptr"
|
||||||
.Sh DESCRIPTION
|
.Sh DESCRIPTION
|
||||||
Mutex pools are designed to be used as short term leaf mutexes;
|
Mutex pools are designed to be used as short term leaf mutexes;
|
||||||
i.e., the last mutex one might acquire before calling
|
i.e., the last mutex one might acquire before calling
|
||||||
.Fn msleep .
|
.Xr msleep 9 .
|
||||||
They operate using a shared pool of mutexes.
|
They operate using a shared pool of mutexes.
|
||||||
A mutex is chosen from the pool based on the supplied pointer,
|
A mutex is chosen from the pool based on the supplied pointer,
|
||||||
which may or may not point to anything valid.
|
which may or may not point to anything valid.
|
||||||
.Pp
|
.Pp
|
||||||
The shared mutex managed by the pool module are standard, non-recursive,
|
The shared mutexes managed by the pool module are standard, non-recursive,
|
||||||
blockable mutexes, and should only be used in appropriate situations.
|
blockable mutexes, and should only be used in appropriate situations.
|
||||||
.Pp
|
.Pp
|
||||||
The caller can lock and unlock mutexes returned by the pool routines, but
|
The caller can lock and unlock mutexes returned by the pool routines, but
|
||||||
@ -74,6 +74,7 @@ carefully accounted for.
|
|||||||
In these cases the private mutex winds up being the true leaf mutex.
|
In these cases the private mutex winds up being the true leaf mutex.
|
||||||
.Pp
|
.Pp
|
||||||
Pool mutexes have the following advantages:
|
Pool mutexes have the following advantages:
|
||||||
|
.Pp
|
||||||
.Bl -enum -offset indent -compact
|
.Bl -enum -offset indent -compact
|
||||||
.It
|
.It
|
||||||
No structural overhead;
|
No structural overhead;
|
||||||
@ -85,10 +86,11 @@ mutexes to interlock destructor operations.
|
|||||||
No initialization or destruction overhead.
|
No initialization or destruction overhead.
|
||||||
.It
|
.It
|
||||||
Can be used with
|
Can be used with
|
||||||
.Fn msleep .
|
.Xr msleep 9 .
|
||||||
.El
|
.El
|
||||||
.Pp
|
.Pp
|
||||||
And the following disadvantages:
|
And the following disadvantages:
|
||||||
|
.Pp
|
||||||
.Bl -enum -offset indent -compact
|
.Bl -enum -offset indent -compact
|
||||||
.It
|
.It
|
||||||
Should generally only be used as leaf mutexes.
|
Should generally only be used as leaf mutexes.
|
||||||
@ -119,9 +121,9 @@ respectively;
|
|||||||
they are a combination of
|
they are a combination of
|
||||||
.Fn mtx_pool_find
|
.Fn mtx_pool_find
|
||||||
and
|
and
|
||||||
.Fn mtx_lock
|
.Xr mtx_lock 9
|
||||||
and
|
and
|
||||||
.Fn mtx_unlock ,
|
.Xr mtx_unlock 9 ,
|
||||||
respectively.
|
respectively.
|
||||||
Since these routines must first find the mutex to operate on,
|
Since these routines must first find the mutex to operate on,
|
||||||
they are not as fast as directly using the pointer (mutex) returned by
|
they are not as fast as directly using the pointer (mutex) returned by
|
||||||
@ -129,8 +131,8 @@ a previous invocation of
|
|||||||
.Fn mtx_pool_find .
|
.Fn mtx_pool_find .
|
||||||
.Pp
|
.Pp
|
||||||
.Sh SEE ALSO
|
.Sh SEE ALSO
|
||||||
.Xr mutex 9 ,
|
.Xr msleep 9 ,
|
||||||
.Xr msleep 9
|
.Xr mutex 9
|
||||||
.Sh HISTORY
|
.Sh HISTORY
|
||||||
These routines first appeared in
|
These routines first appeared in
|
||||||
.Fx 5.0 .
|
.Fx 5.0 .
|
||||||
|
@ -31,7 +31,7 @@
|
|||||||
.Os
|
.Os
|
||||||
.Sh NAME
|
.Sh NAME
|
||||||
.Nm selrecord ,
|
.Nm selrecord ,
|
||||||
.Nm selwakeup ,
|
.Nm selwakeup
|
||||||
.Nd "record and wakeup select requests"
|
.Nd "record and wakeup select requests"
|
||||||
.Sh SYNOPSIS
|
.Sh SYNOPSIS
|
||||||
.In sys/param.h
|
.In sys/param.h
|
||||||
@ -68,7 +68,7 @@ acquires and releases
|
|||||||
.Fn selwakeup
|
.Fn selwakeup
|
||||||
is called by the underlying object handling code in order to notify any waiting
|
is called by the underlying object handling code in order to notify any waiting
|
||||||
threads that an event of interest has occurred.
|
threads that an event of interest has occurred.
|
||||||
If a collision has occurred
|
If a collision has occurred,
|
||||||
.Fn selwakeup
|
.Fn selwakeup
|
||||||
will increment
|
will increment
|
||||||
.Va nselcoll ,
|
.Va nselcoll ,
|
||||||
@ -84,7 +84,7 @@ flag which should be noted by
|
|||||||
.Xr select 2
|
.Xr select 2
|
||||||
and
|
and
|
||||||
.Xr poll 2
|
.Xr poll 2
|
||||||
when they wakeup.
|
when they wake up.
|
||||||
.Pp
|
.Pp
|
||||||
.Fn selwakeup
|
.Fn selwakeup
|
||||||
acquires and releases
|
acquires and releases
|
||||||
@ -92,10 +92,11 @@ acquires and releases
|
|||||||
and may acquire and release
|
and may acquire and release
|
||||||
.Va sched_lock .
|
.Va sched_lock .
|
||||||
.Sh SEE ALSO
|
.Sh SEE ALSO
|
||||||
.Xr poll 2
|
.Xr poll 2 ,
|
||||||
.Xr select 2
|
.Xr select 2
|
||||||
.Sh AUTHORS
|
.Sh AUTHORS
|
||||||
|
.An -nosplit
|
||||||
This man page was written by
|
This man page was written by
|
||||||
.An Chad David Aq davidc@freebsd.org
|
.An Chad David Aq davidc@FreeBSD.org
|
||||||
and
|
and
|
||||||
.An Alfred Perlstein Aq alfred@freebsd.org
|
.An Alfred Perlstein Aq alfred@FreeBSD.org .
|
||||||
|
@ -48,33 +48,44 @@ carriage-control characters to line-printer control sequences,
|
|||||||
and writes them to the standard output.
|
and writes them to the standard output.
|
||||||
.Pp
|
.Pp
|
||||||
The first character of each line is interpreted as a carriage-control
|
The first character of each line is interpreted as a carriage-control
|
||||||
character. The following characters are interpreted as follows:
|
character.
|
||||||
.Bl -tag -width "\*[Lt]space\*[Gt]"
|
The following characters are interpreted as follows:
|
||||||
.It \*[Lt]space\*[Gt]
|
.Bl -tag -width ".Aq space"
|
||||||
|
.It Aq space
|
||||||
Output the rest of the line without change.
|
Output the rest of the line without change.
|
||||||
.It 0
|
.It 0
|
||||||
Output a \*[Lt]newline\*[Gt] character before printing the rest of the line.
|
Output a
|
||||||
|
.Aq newline
|
||||||
|
character before printing the rest of the line.
|
||||||
.It 1
|
.It 1
|
||||||
Output a \*[Lt]formfeed\*[Gt] character before printing the rest of the line.
|
Output a
|
||||||
.It +
|
.Aq formfeed
|
||||||
The trailing \*[Lt]newline\*[Gt] of the previous line is replaced by a \*[Lt]carriage-return\*[Gt]
|
character before printing the rest of the line.
|
||||||
|
.It \&+
|
||||||
|
The trailing
|
||||||
|
.Aq newline
|
||||||
|
of the previous line is replaced by a
|
||||||
|
.Aq carriage-return
|
||||||
before printing the rest of the line.
|
before printing the rest of the line.
|
||||||
.El
|
.El
|
||||||
.Pp
|
.Pp
|
||||||
Lines beginning with characters other than the above are treated as if they
|
Lines beginning with characters other than the above are treated as if they
|
||||||
begin with \*[Lt]space\*[Gt].
|
begin with
|
||||||
|
.Aq space .
|
||||||
.Sh DIAGNOSTICS
|
.Sh DIAGNOSTICS
|
||||||
.Ex -std
|
.Ex -std
|
||||||
.Sh EXAMPLES
|
.Sh EXAMPLES
|
||||||
To view a file containing the output of a
|
To view a file containing the output of a
|
||||||
.Tn FORTRAN
|
.Tn FORTRAN
|
||||||
program:
|
program:
|
||||||
.Dl asa file
|
.Pp
|
||||||
|
.Dl "asa file"
|
||||||
.Pp
|
.Pp
|
||||||
To format the output of a
|
To format the output of a
|
||||||
.Tn FORTRAN
|
.Tn FORTRAN
|
||||||
program and redirect it to a line-printer:
|
program and redirect it to a line-printer:
|
||||||
.Dl a.out | asa | lpr
|
.Pp
|
||||||
|
.Dl "a.out | asa | lpr"
|
||||||
.Sh SEE ALSO
|
.Sh SEE ALSO
|
||||||
.Xr f77 1
|
.Xr f77 1
|
||||||
.Sh STANDARDS
|
.Sh STANDARDS
|
||||||
@ -83,4 +94,5 @@ The
|
|||||||
utility conforms to
|
utility conforms to
|
||||||
.St -p1003.1-2001 .
|
.St -p1003.1-2001 .
|
||||||
.Sh AUTHORS
|
.Sh AUTHORS
|
||||||
J.T. Conklin, Winning Strategies, Inc.
|
.An J.T. Conklin ,
|
||||||
|
Winning Strategies, Inc.
|
||||||
|
Loading…
Reference in New Issue
Block a user