From patchwork Sun Mar 3 12:15:13 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alejandro Colomar X-Patchwork-Id: 1907262 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@legolas.ozlabs.org Authentication-Results: legolas.ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=kernel.org header.i=@kernel.org header.a=rsa-sha256 header.s=k20201202 header.b=VpyWwh7p; dkim-atps=neutral Authentication-Results: legolas.ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=sourceware.org (client-ip=2620:52:3:1:0:246e:9693:128c; helo=server2.sourceware.org; envelope-from=libc-alpha-bounces+incoming=patchwork.ozlabs.org@sourceware.org; receiver=patchwork.ozlabs.org) Received: from server2.sourceware.org (server2.sourceware.org [IPv6:2620:52:3:1:0:246e:9693:128c]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (secp384r1) server-digest SHA384) (No client certificate requested) by legolas.ozlabs.org (Postfix) with ESMTPS id 4TnglM2wtXz23fC for ; Sun, 3 Mar 2024 23:15:43 +1100 (AEDT) Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 5FABA3858424 for ; Sun, 3 Mar 2024 12:15:41 +0000 (GMT) X-Original-To: libc-alpha@sourceware.org Delivered-To: libc-alpha@sourceware.org Received: from dfw.source.kernel.org (dfw.source.kernel.org [139.178.84.217]) by sourceware.org (Postfix) with ESMTPS id 93953385840F for ; Sun, 3 Mar 2024 12:15:17 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 93953385840F Authentication-Results: sourceware.org; dmarc=pass (p=none dis=none) header.from=kernel.org Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=kernel.org ARC-Filter: OpenARC Filter v1.0.0 sourceware.org 93953385840F Authentication-Results: server2.sourceware.org; arc=none smtp.remote-ip=139.178.84.217 ARC-Seal: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1709468119; cv=none; b=nwmITncZlEbZd5CgEcqjpvdgQjfXWnDOxZhJL36QLCKwu9a0ZW1DZCQC8URB0yZaJiZyZ2f1aEW5Y40A6u24i28Eox+CCk/rs5d3E1KypePSR0ghmUdPNzYTlc79RJVVZahtLtXVcVxMswYpkEtVBRoqndX2yvWTIdd+MgBEQP4= ARC-Message-Signature: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1709468119; c=relaxed/simple; bh=znTswpelGMVCKaIREHMS0Oy2uhrl8uFK8hZ8/tbG2G0=; h=DKIM-Signature:Date:From:To:Subject:Message-ID:MIME-Version; b=V2mudHECW29SFpHfWyKVYWV6WzL/g5qI1ejmGS16VJfGNepewQ+vxkIPJocqGhcpTEHWek8lzJ8wQ1etbjEEmh9OtTdBaWETBVxMU35HeihdFzGalmHP6Eajbb4Xauv2LzhLw3OLiO0kpIeOfw8XuGMcbgnB3F1KLhsBjB1viKE= ARC-Authentication-Results: i=1; server2.sourceware.org Received: from smtp.kernel.org (transwarp.subspace.kernel.org [100.75.92.58]) by dfw.source.kernel.org (Postfix) with ESMTP id D9B42601BC; Sun, 3 Mar 2024 12:15:16 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 13E83C433C7; Sun, 3 Mar 2024 12:15:14 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1709468116; bh=znTswpelGMVCKaIREHMS0Oy2uhrl8uFK8hZ8/tbG2G0=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=VpyWwh7p7z31Bs02k5AvPhKpyT/KMwOiF6wGTuSd1hw0CDKpolT5juzjgk/b/VXN0 Kol+stM2tmmfIOSfjKZDMAU8eOkBPWqpTlRXxKbDe5da3EUEq0MDTie3fpB1w543Zz eOKEx4W+zYsQkk5JQJsqYm2Mnwxo1ZwdASlc0WYxjxG5gqgwTJR0Vmhy3w/NEvZeBB a8YPPa2Bl6oCNYB2WMTE1I2kYsgUb4YTZNNKaFc6BYUTyOusiF+51693zmYw/X+0ho 3infNrkcTpsJuEMHB5CI7Xo+t1S2kwXdYScdcPSQswCsxTCkuyO2f+QZBLZD+zlHE9 CUsVL6ZORUDrw== Date: Sun, 3 Mar 2024 13:15:13 +0100 From: Alejandro Colomar To: Elliott Hughes , Stefan Puiu , Bruno Haible , linux-man@vger.kernel.org Cc: Alejandro Colomar , GNU C Library , linux-api@vger.kernel.org Subject: [PATCH 2/2] clock_nanosleep.2, nanosleep.2: Use 'duration' rather than 'request' Message-ID: <20240303121454.16994-3-alx@kernel.org> X-Mailer: git-send-email 2.43.0 References: MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: X-Spam-Status: No, score=-10.1 required=5.0 tests=BAYES_00, DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, GIT_PATCH_0, SPF_HELO_NONE, SPF_PASS, TXREP, T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org X-BeenThere: libc-alpha@sourceware.org X-Mailman-Version: 2.1.30 Precedence: list List-Id: Libc-alpha mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libc-alpha-bounces+incoming=patchwork.ozlabs.org@sourceware.org It seems much more clear. Suggested-by: Elliott Hughes Cc: Stefan Puiu Cc: Bruno Haible Signed-off-by: Alejandro Colomar --- 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 .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.