info/GNU_which: Add some explanations.

[linuxjm/jm.git] / manual / LDP_man-pages / original / man2 / sched_yield.2

diff --git a/manual/LDP_man-pages/original/man2/sched_yield.2 b/manual/LDP_man-pages/original/man2/sched_yield.2
index 057e675..ae697b7 100644 (file)
--- a/manual/LDP_man-pages/original/man2/sched_yield.2
+++ b/manual/LDP_man-pages/original/man2/sched_yield.2
@@ -1,7 +1,6 @@
-.\" Hey Emacs! This file is -*- nroff -*- source.
-.\"
 .\" Copyright (C) Tom Bjorkholm & Markus Kuhn, 1996
 .\"
+.\" %%%LICENSE_START(GPLv2+_DOC_FULL)
 .\" This is free documentation; you can redistribute it and/or
 .\" modify it under the terms of the GNU General Public License as
 .\" published by the Free Software Foundation; either version 2 of
@@ -18,28 +17,28 @@
 .\" GNU General Public License for more details.
 .\"
 .\" You should have received a copy of the GNU General Public
-.\" License along with this manual; if not, write to the Free
-.\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
-.\" USA.
+.\" License along with this manual; if not, see
+.\" <http://www.gnu.org/licenses/>.
+.\" %%%LICENSE_END
 .\"
 .\" 1996-04-01 Tom Bjorkholm <tomb@mydata.se>
 .\"            First version written
 .\" 1996-04-10 Markus Kuhn <mskuhn@cip.informatik.uni-erlangen.de>
 .\"            revision
 .\"
-.TH SCHED_YIELD 2 2008-10-18 "Linux" "Linux Programmer's Manual"
+.TH SCHED_YIELD 2 2017-09-15 "Linux" "Linux Programmer's Manual"
 .SH NAME
 sched_yield \- yield the processor
 .SH SYNOPSIS
 .B #include <sched.h>
-.sp
+.PP
 .B int sched_yield(void);
 .SH DESCRIPTION
 .BR sched_yield ()
 causes the calling thread to relinquish the CPU.
 The thread is moved to the end of the queue for its static
 priority and a new thread gets to run.
-.SH "RETURN VALUE"
+.SH RETURN VALUE
 On success,
 .BR sched_yield ()
 returns 0.
@@ -50,20 +49,21 @@ is set appropriately.
 In the Linux implementation,
 .BR sched_yield ()
 always succeeds.
-.SH "CONFORMING TO"
-POSIX.1-2001.
+.SH CONFORMING TO
+POSIX.1-2001, POSIX.1-2008.
 .SH NOTES
 If the calling thread is the only thread in the highest
 priority list at that time,
 it will continue to run after a call to
 .BR sched_yield ().
-
+.PP
 POSIX systems on which
 .BR sched_yield ()
 is available define
 .B _POSIX_PRIORITY_SCHEDULING
-in \fI<unistd.h>\fP.
-
+in
+.IR <unistd.h> .
+.PP
 Strategic calls to
 .BR sched_yield ()
 can improve performance by giving other threads or processes
@@ -76,9 +76,25 @@ unnecessarily or inappropriately
 schedulable threads are still held by the caller),
 since doing so will result in unnecessary context switches,
 which will degrade system performance.
-.SH "SEE ALSO"
-.BR sched_setscheduler (2)
-for a description of Linux scheduling.
 .PP
-.I Programming for the real world \- POSIX.4
-by Bill O. Gallmeister, O'Reilly & Associates, Inc., ISBN 1-56592-074-0
+.BR sched_yield ()
+is intended for use with real-time scheduling policies (i.e.,
+.BR SCHED_FIFO
+or
+.BR SCHED_RR ).
+Use of
+.BR sched_yield ()
+with nondeterministic scheduling policies such as
+.BR SCHED_OTHER
+is unspecified and very likely means your application design is broken.
+.SH SEE ALSO
+.BR sched (7)
+.SH COLOPHON
+This page is part of release 5.10 of the Linux
+.I man-pages
+project.
+A description of the project,
+information about reporting bugs,
+and the latest version of this page,
+can be found at
+\%https://www.kernel.org/doc/man\-pages/.