summaryrefslogtreecommitdiffstats
path: root/share/man
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2006-10-16 14:35:31 +0000
committerru <ru@FreeBSD.org>2006-10-16 14:35:31 +0000
commita58f62cb8322338088db8ec438e3ab536661af0b (patch)
tree7a6925f68e8617d03dbcc0e7af631fb0c3c27c44 /share/man
parent9a7ddac59ad48ee1b12b63eba29c6904028d622e (diff)
downloadFreeBSD-src-a58f62cb8322338088db8ec438e3ab536661af0b.zip
FreeBSD-src-a58f62cb8322338088db8ec438e3ab536661af0b.tar.gz
Bring manpage up-to-date with respect to the scheduling priority
range, and mention the SCHED_OTHER scheduling policy. Submitted by: davidxu PR: docs/37843 MFC after: 3 days
Diffstat (limited to 'share/man')
-rw-r--r--share/man/man3/pthread_schedparam.331
1 files changed, 19 insertions, 12 deletions
diff --git a/share/man/man3/pthread_schedparam.3 b/share/man/man3/pthread_schedparam.3
index c248f69..ff73a85 100644
--- a/share/man/man3/pthread_schedparam.3
+++ b/share/man/man3/pthread_schedparam.3
@@ -26,7 +26,8 @@
.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $FreeBSD$
-.Dd May 1, 2000
+.\"
+.Dd October 16, 2006
.Dt PTHREAD_SCHEDPARAM 3
.Os
.Sh NAME
@@ -50,15 +51,18 @@ and
functions set and get the scheduling parameters of individual threads.
The scheduling policy for a thread can either be
.Dv SCHED_FIFO
-(first in, first out) or
+(first in, first out),
.Dv SCHED_RR
-(round-robin).
-The thread priority (accessed via
+(round-robin), or
+.Dv SCHED_OTHER
+(timesharing).
+Valid thread priorities (accessed via
.Va param->sched_priority )
-must be at least
-.Dv PTHREAD_MIN_PRIORITY
-and no more than
-.Dv PTHREAD_MAX_PRIORITY .
+must be within the range returned by the
+.Xr sched_get_priority_min 2
+and
+.Xr sched_get_priority_max 2
+system calls.
.Sh RETURN VALUES
If successful, these functions return 0.
Otherwise, an error number is returned to indicate the error.
@@ -69,12 +73,12 @@ function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
Invalid value for
-.Va policy .
+.Fa policy .
.It Bq Er ENOTSUP
Invalid value for scheduling parameters.
.It Bq Er ESRCH
Non-existent thread
-.Va thread .
+.Fa thread .
.El
.Pp
The
@@ -83,12 +87,15 @@ function will fail if:
.Bl -tag -width Er
.It Bq Er ESRCH
Non-existent thread
-.Va thread .
+.Fa thread .
.El
+.Sh SEE ALSO
+.Xr sched_get_priority_max 2 ,
+.Xr sched_get_priority_min 2
.Sh STANDARDS
The
.Fn pthread_setschedparam
and
.Fn pthread_getschedparam
functions conform to
-.St -susv2
+.St -susv2 .
OpenPOWER on IntegriCloud