All pages: Replace the 4th argument to .TH by "Linux man-pages (unreleased)"

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

diff --git a/man3/pthread_yield.3 b/man3/pthread_yield.3
index edb4b3766e22df7ef621fd7d4c3a0fae7c4fa3bb..01d4aa6bbcd0751d010b4272c8c721812bf4006b 100644 (file)
--- a/man3/pthread_yield.3
+++ b/man3/pthread_yield.3
@@ -1,30 +1,13 @@
 .\" Copyright (c) 2009 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.
+.\" SPDX-License-Identifier: Linux-man-pages-copyleft
 .\"
-.\" Permission is granted to copy and distribute modified versions of this
-.\" manual under the conditions for verbatim copying, provided that the
-.\" entire resulting derived work is distributed under the terms of a
-.\" permission notice identical to this one.
-.\"
-.\" Since the Linux kernel and libraries are constantly changing, this
-.\" manual page may be incorrect or out-of-date.  The author(s) assume no
-.\" responsibility for errors or omissions, or for damages resulting from
-.\" the use of the information contained herein.  The author(s) may not
-.\" have taken the same level of care in the production of this manual,
-.\" which is licensed free of charge, as they might when working
-.\" professionally.
-.\"
-.\" 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_YIELD 3 2017-11-26 "Linux" "Linux Programmer's Manual"
+.TH PTHREAD_YIELD 3 2021-03-22 "Linux man-pages (unreleased)" "Linux Programmer's Manual"
 .SH NAME
 pthread_yield \- yield the processor
+.SH LIBRARY
+POSIX threads library
+.RI ( libpthread ", " \-lpthread )
 .SH SYNOPSIS
 .nf
 .BR "#define _GNU_SOURCE" "             /* See feature_test_macros(7) */"
@@ -32,9 +15,10 @@ pthread_yield \- yield the processor
 .PP
 .B int pthread_yield(void);
 .fi
-.PP
-Compile and link with \fI\-pthread\fP.
 .SH DESCRIPTION
+.BR Note :
+This function is deprecated; see below.
+.PP
 .BR pthread_yield ()
 causes the calling thread to relinquish the CPU.
 The thread is placed at the end of the run queue for its static
@@ -50,6 +34,8 @@ on error, it returns an error number.
 On Linux, this call always succeeds
 (but portable and future-proof applications should nevertheless
 handle a possible error return).
+.SH VERSIONS
+Since glibc 2.34, this function is marked as deprecated.
 .SH ATTRIBUTES
 For an explanation of the terms used in this section, see
 .BR attributes (7).
@@ -67,7 +53,7 @@ T}    Thread safety   MT-Safe
 .hy
 .ad
 .sp 1
-.SH CONFORMING TO
+.SH STANDARDS
 This call is nonstandard, but present on several other systems.
 Use the standardized
 .BR sched_yield (2)
@@ -79,13 +65,13 @@ On Linux, this function is implemented as a call to
 .PP
 .BR pthread_yield ()
 is intended for use with real-time scheduling policies (i.e.,
-.BR SCHED_FIFO
+.B SCHED_FIFO
 or
 .BR SCHED_RR ).
 Use of
 .BR pthread_yield ()
 with nondeterministic scheduling policies such as
-.BR SCHED_OTHER
+.B SCHED_OTHER
 is unspecified and very likely means your application design is broken.
 .SH SEE ALSO
 .BR sched_yield (2),