Sync the man page with recent addition of few wrappers.

This commit is contained in:
rmind 2008-10-31 11:55:40 +00:00
parent 18387ac741
commit a2d73f8239
1 changed files with 34 additions and 4 deletions

View File

@ -1,4 +1,4 @@
.\" $NetBSD: sched.3,v 1.5 2008/06/22 08:24:26 wiz Exp $
.\" $NetBSD: sched.3,v 1.6 2008/10/31 11:55:40 rmind 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 June 16, 2008
.Dd October 31, 2008
.Dt SCHED 3
.Os
.Sh NAME
@ -83,7 +83,7 @@ contains at least one member:
.It Fa sched_priority
Specifies the priority of the process.
.El
.Ss FUNCTIONS
.Sh FUNCTIONS
.Bl -tag -width compact
.It Fn sched_setparam pid param
Sets the scheduling parameters for the process specified by
@ -135,6 +135,17 @@ scheduling policy.
.It Fn sched_yield
Yields a processor voluntarily and gives other threads a chance to run
without waiting for an involuntary preemptive switch.
.It Fn sched_setaffinity_np pid size cpuset
Set the affinity mask specified by
.Fa cpuset
for the process specified by
.Fa pid .
At least one valid CPU must be set in the mask.
.It Fn sched_getaffinity_np pid size cpuset
Get the affinity mask of the process specified by
.Fa pid
into the
.Fa cpuset .
.El
.Sh RETURN VALUES
.Fn sched_setparam ,
@ -167,6 +178,15 @@ return the maximal/minimal priority value on success.
Otherwise, \-1 is returned and
.Va errno
is set to indicate the error.
.Pp
The
.Fn sched_setaffinity_np
and
.Fn sched_getaffinity_np
return 0 on success.
Otherwise, \-1 is returned and
.Va errno
is set to indicate the error.
.Sh ERRORS
The
.Fn sched_setparam
@ -224,13 +244,23 @@ and value of
.Fa pid
is not zero.
.El
.Sh NOTES
Portable applications should not use
.Fn sched_setaffinity_np
and
.Fn sched_getaffinity_np
functions.
.Sh SEE ALSO
.Xr affinity 3 ,
.Xr cpuset 3 ,
.Xr pset 3 ,
.Xr schedctl 8
.Sh STANDARDS
These functions conform to
These functions, except
.Fn sched_setaffinity_np
and
.Fn sched_getaffinity_np ,
are expected to conform the
.St -p1003.1-2001
standard.
.Sh HISTORY