Markup: .Ss -> .Sh, .Fa -> .Fn, offset indent, and use lists in two places

for clarity.
This commit is contained in:
jruoho 2010-05-06 10:40:43 +00:00
parent 7399a74f7a
commit 5df5911ae4
1 changed files with 17 additions and 8 deletions

View File

@ -1,4 +1,4 @@
.\" $NetBSD: pset.3,v 1.10 2009/01/29 00:54:54 rmind Exp $
.\" $NetBSD: pset.3,v 1.11 2010/05/06 10:40:43 jruoho Exp $
.\"
.\" Copyright (c) 2008 The NetBSD Foundation, Inc.
.\" All rights reserved.
@ -27,7 +27,7 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd January 28, 2009
.Dd May 6, 2010
.Dt PSET 3
.Os
.Sh NAME
@ -53,7 +53,7 @@ or threads.
After processes or threads are bound to a group of processors by
the API, the group henceforth runs only those processes or threads.
This section describes the functions used to control processor sets.
.Ss FUNCTIONS
.Sh FUNCTIONS
.Bl -tag -width compact
.It Fn pset_create psid
Creates a processor set, and returns its ID into
@ -70,6 +70,9 @@ into
if the pointer is not
.Dv NULL .
.Pp
The following actions can be specified:
.Bl -enum -offset 2n
.It
If
.Fa psid
is set to
@ -77,7 +80,7 @@ is set to
then the current processor set ID will be returned into
.Fa psid ,
and no assignment will be performed.
.Pp
.It
If
.Fa psid
is set to
@ -85,12 +88,13 @@ is set to
then the processor set ID of the calling process will be used, and
.Fa psid
will be ignored.
.Pp
.It
If
.Fa psid
is set to
.Dv PS_NONE ,
any assignment to the processor will be cleared.
.El
.It Fn pset_bind psid type id opsid
Dedicates the processor set specified by
.Fa psid
@ -105,13 +109,16 @@ if the pointer is not
.Nx
supports the following types of targets specified by
.Fa type :
.Bl -tag -width P_PID
.Bl -tag -width P_LWPID -offset 2n
.It Dv P_PID
Process identified by the PID.
.It Dv P_LWPID
Thread of the calling process indentified by the LID.
.El
.Pp
The following actions can be specified:
.Bl -enum -offset 2n
.It
If
.Fa psid
is set to
@ -121,17 +128,19 @@ then the current processor set ID to which the target is bound or
will be returned in
.Fa opsid ,
and no binding will be performed.
.It
If
.Fa psid
is set to
.Dv PS_MYID ,
then the processor set ID of the calling process will be used.
.Pp
.It
If
.Fa psid
is set to
.Dv PS_NONE ,
the specified target will be unbound from the processor set.
.El
.It Fn pset_destroy psid
Destroys the processor set specified by
.Fa psid .
@ -146,7 +155,7 @@ the processor set ID of the caller thread will be used.
.El
.Sh NOTES
The
.Fa pset_bind
.Fn pset_bind
function can return the current processor set ID to which the
target is bound, or
.Dv PS_NONE .