From 5d1e8ad8e1d713d9d5b490169a10d346dd5af873 Mon Sep 17 00:00:00 2001 From: Alejandro Colomar Date: Wed, 3 May 2023 18:47:27 +0200 Subject: sched_yield.2: Rename NOTES to CAVEATS, and reorder contents Put the last paragraph at the top of the CAVEATS section, since it's probably the most important for readers. This system call is likely not the right one for most programs; let's discourage its use. Link: Cc: Andrew Clayton Signed-off-by: Alejandro Colomar --- man2/sched_yield.2 | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/man2/sched_yield.2 b/man2/sched_yield.2 index 5e5b45a48..4eb858018 100644 --- a/man2/sched_yield.2 +++ b/man2/sched_yield.2 @@ -48,7 +48,18 @@ is available defined .B _POSIX_PRIORITY_SCHEDULING in .IR . -.SH NOTES +.SH CAVEATS +.BR sched_yield () +is intended for use with real-time scheduling policies (i.e., +.B SCHED_FIFO +or +.BR SCHED_RR ). +Use of +.BR sched_yield () +with nondeterministic scheduling policies such as +.B SCHED_OTHER +is unspecified and very likely means your application design is broken. +.PP 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 @@ -61,16 +72,5 @@ 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. -.PP -.BR sched_yield () -is intended for use with real-time scheduling policies (i.e., -.B SCHED_FIFO -or -.BR SCHED_RR ). -Use of -.BR sched_yield () -with nondeterministic scheduling policies such as -.B SCHED_OTHER -is unspecified and very likely means your application design is broken. .SH SEE ALSO .BR sched (7) -- cgit v1.2.3