fanotify_init.2, fanotify.7: Document FAN_REPORT_TID

[thirdparty/man-pages.git] / man3 / pthread_attr_setschedpolicy.3

diff --git a/man3/pthread_attr_setschedpolicy.3 b/man3/pthread_attr_setschedpolicy.3
index 5a183e70d6dc2c2529fbef4f6cb3d93f0150212d..9b1dd2588d959a3aaf7ec6045235fc8cbd038f14 100644 (file)
--- a/man3/pthread_attr_setschedpolicy.3
+++ b/man3/pthread_attr_setschedpolicy.3
@@ -1,6 +1,7 @@
 .\" Copyright (c) 2008 Linux Foundation, written by Michael Kerrisk
 .\"     <mtk.manpages@gmail.com>
 .\"
+.\" %%%LICENSE_START(VERBATIM)
 .\" Permission is granted to make and distribute verbatim copies of this
 .\" manual provided the copyright notice and this permission notice are
 .\" preserved on all copies.
@@ -20,21 +21,23 @@
 .\"
 .\" Formatted or processed versions of this manual, if unaccompanied by
 .\" the source, must acknowledge the copyright and authors of this work.
+.\" %%%LICENSE_END
 .\"
-.TH PTHREAD_ATTR_SETSCHEDPOLICY 3 2010-02-03 "Linux" "Linux Programmer's Manual"
+.TH PTHREAD_ATTR_SETSCHEDPOLICY 3 2017-09-15 "Linux" "Linux Programmer's Manual"
 .SH NAME
 pthread_attr_setschedpolicy, pthread_attr_getschedpolicy \- set/get
 scheduling policy attribute in thread attributes object
 .SH SYNOPSIS
 .nf
 .B #include <pthread.h>
-
+.PP
 .BI "int pthread_attr_setschedpolicy(pthread_attr_t *" attr \
 ", int " policy );
-.BI "int pthread_attr_getschedpolicy(pthread_attr_t *" attr \
+.BI "int pthread_attr_getschedpolicy(const pthread_attr_t *" attr \
 ", int " *policy );
-.sp
+.PP
 Compile and link with \fI\-pthread\fP.
+.fi
 .SH DESCRIPTION
 The
 .BR pthread_attr_setschedpolicy ()
@@ -46,7 +49,7 @@ to the value specified in
 This attribute determines the scheduling policy of
 a thread created using the thread attributes object
 .IR attr .
-
+.PP
 The supported values for
 .I policy
 are
@@ -55,17 +58,28 @@ are
 and
 .BR SCHED_OTHER ,
 with the semantics described in
-.BR sched_setscheduler (2).
+.BR sched (7).
 .\" FIXME . pthread_setschedparam() places no restriction on the policy,
 .\" but pthread_attr_setschedpolicy() restricts policy to RR/FIFO/OTHER
 .\" http://sourceware.org/bugzilla/show_bug.cgi?id=7013
-
+.PP
 The
 .BR pthread_attr_getschedpolicy ()
 returns the scheduling policy attribute of the thread attributes object
 .IR attr
 in the buffer pointed to by
 .IR policy .
+.PP
+In order for the policy setting made by
+.BR pthread_attr_setschedpolicy ()
+to have effect when calling
+.BR pthread_create (3),
+the caller must use
+.BR pthread_attr_setinheritsched (3)
+to set the inherit-scheduler attribute of the attributes object
+.I attr
+to
+.BR PTHREAD_EXPLICIT_SCHED .
 .SH RETURN VALUE
 On success, these functions return 0;
 on error, they return a nonzero error number.
@@ -77,23 +91,38 @@ can fail with the following error:
 Invalid value in
 .IR policy .
 .PP
-POSIX.1-2001 also documents an optional
+POSIX.1 also documents an optional
 .B ENOTSUP
 error ("attempt was made to set the attribute to an unsupported value") for
 .BR pthread_attr_setschedpolicy ().
 .\" .SH VERSIONS
 .\" Available since glibc 2.0.
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.TS
+allbox;
+lbw30 lb lb
+l l l.
+Interface      Attribute       Value
+T{
+.BR pthread_attr_setschedpolicy (),
+.BR pthread_attr_getschedpolicy ()
+T}     Thread safety   MT-Safe
+.TE
 .SH CONFORMING TO
-POSIX.1-2001.
+POSIX.1-2001, POSIX.1-2008.
 .SH EXAMPLE
 See
 .BR pthread_setschedparam (3).
 .SH SEE ALSO
-.BR sched_setscheduler (2),
+.ad l
+.nh
 .BR pthread_attr_init (3),
 .BR pthread_attr_setinheritsched (3),
 .BR pthread_attr_setschedparam (3),
 .BR pthread_create (3),
 .BR pthread_setschedparam (3),
 .BR pthread_setschedprio (3),
-.BR pthreads (7)
+.BR pthreads (7),
+.BR sched (7)