[PATCH 2/2] clock_nanosleep.2, nanosleep.2: Use 'duration' rather than 'request'
flat view
STALE945d
From: Alejandro Colomar <alx@kernel.org>
Date: 2024-03-03 12:15:16
Also in:
linux-man
Subsystem:
the rest · Maintainer:
Linus Torvalds
It seems much more clear. Suggested-by: Elliott Hughes <redacted> Cc: Stefan Puiu <redacted> Cc: Bruno Haible <redacted> Signed-off-by: Alejandro Colomar <alx@kernel.org> --- man2/clock_nanosleep.2 | 20 ++++++++++---------- man2/nanosleep.2 | 12 ++++++------ 2 files changed, 16 insertions(+), 16 deletions(-)
diff --git a/man2/clock_nanosleep.2 b/man2/clock_nanosleep.2
index 5bda50e18..0eedc1277 100644
--- a/man2/clock_nanosleep.2
+++ b/man2/clock_nanosleep.2@@ -19,7 +19,7 @@ .SH SYNOPSIS .nf .P .BI "int clock_nanosleep(clockid_t " clockid ", int " flags , -.BI " const struct timespec *" request , +.BI " const struct timespec *" duration , .BI " struct timespec *_Nullable " remain ); .fi .P
@@ -94,7 +94,7 @@ .SH DESCRIPTION If .I flags is 0, then the value specified in -.I request +.I duration is interpreted as an interval relative to the current value of the clock specified by .IR clockid .
@@ -104,11 +104,11 @@ .SH DESCRIPTION is .BR TIMER_ABSTIME , then -.I request +.I duration is interpreted as an absolute time as measured by the clock, .IR clockid . If -.I request +.I duration is less than or equal to the current value of the clock, then .BR clock_nanosleep ()
@@ -117,7 +117,7 @@ .SH DESCRIPTION .BR clock_nanosleep () suspends the execution of the calling thread until either at least the time specified by -.I request +.I duration has elapsed, or a signal is delivered that causes a signal handler to be called or that terminates the process.
@@ -138,7 +138,7 @@ .SH DESCRIPTION .BR clock_nanosleep () again and complete a (relative) sleep. .SH RETURN VALUE -On successfully sleeping for the requested interval, +On successfully sleeping for the requested duration, .BR clock_nanosleep () returns 0. If the call is interrupted by a signal handler or encounters an error,
@@ -146,7 +146,7 @@ .SH RETURN VALUE .SH ERRORS .TP .B EFAULT -.I request +.I duration or .I remain specified an invalid address.
@@ -179,8 +179,8 @@ .SH HISTORY Linux 2.6, glibc 2.1. .SH NOTES -If the interval specified in -.I request +If the +.I duration is not an exact multiple of the granularity underlying clock (see .BR time (7)), then the interval will be rounded up to the next multiple.
@@ -216,7 +216,7 @@ .SH NOTES is .BR TIMER_ABSTIME . (An absolute sleep can be restarted using the same -.I request +.I duration argument.) .P POSIX.1 specifies that
diff --git a/man2/nanosleep.2 b/man2/nanosleep.2
index a8d9f5a8a..6272c21e6 100644
--- a/man2/nanosleep.2
+++ b/man2/nanosleep.2@@ -22,7 +22,7 @@ .SH SYNOPSIS .nf .B #include <time.h> .P -.BI "int nanosleep(const struct timespec *" req , +.BI "int nanosleep(const struct timespec *" duration , .BI " struct timespec *_Nullable " rem ); .fi .P
@@ -39,7 +39,7 @@ .SH DESCRIPTION .BR nanosleep () suspends the execution of the calling thread until either at least the time specified in -.I *req +.I *duration has elapsed, or the delivery of a signal that triggers the invocation of a handler in the calling thread or that terminates the process.
@@ -80,7 +80,7 @@ .SH DESCRIPTION and it makes the task of resuming a sleep that has been interrupted by a signal handler easier. .SH RETURN VALUE -On successfully sleeping for the requested interval, +On successfully sleeping for the requested duration, .BR nanosleep () returns 0. If the call is interrupted by a signal handler or encounters an error,
@@ -139,7 +139,7 @@ .SH VERSIONS .BR nanosleep () function; ... Consequently, these time services shall expire when the requested relative -interval elapses, independently of the new or old value of the clock. +duration elapses, independently of the new or old value of the clock. .RE .SH STANDARDS POSIX.1-2008.
@@ -158,8 +158,8 @@ .SH HISTORY This special extension was removed in Linux 2.5.39, and is thus not available in Linux 2.6.0 and later kernels. .SH NOTES -If the interval specified in -.I req +If the +.I duration is not an exact multiple of the granularity underlying clock (see .BR time (7)), then the interval will be rounded up to the next multiple.
--
2.43.0
Attachments
- signature.asc [application/pgp-signature] 833 bytes