]> git.ipfire.org Git - thirdparty/man-pages.git/commitdiff
man/man2/futex.2: De-duplicate information about timeouts
authorAlejandro Colomar <alx@kernel.org>
Wed, 28 May 2025 19:21:38 +0000 (21:21 +0200)
committerAlejandro Colomar <alx@kernel.org>
Fri, 30 May 2025 11:14:10 +0000 (13:14 +0200)
And be more explicit about the one case that's different.

Signed-off-by: Alejandro Colomar <alx@kernel.org>
man/man2/futex.2

index f0f115ee1dd750c6b08e44f3bee8b35307aee750..0c7a41de7cf2358720b1f4d8fc3f5f141b39a56c 100644 (file)
@@ -300,14 +300,6 @@ is not NULL, the structure it points to specifies a
 timeout for the wait.
 (This interval will be rounded up to the system clock granularity,
 and is guaranteed not to expire early.)
-The timeout is by default measured according to the
-.B CLOCK_MONOTONIC
-clock, but, since Linux 4.5, the
-.B CLOCK_REALTIME
-clock can be selected by specifying
-.B FUTEX_CLOCK_REALTIME
-in
-.IR futex_op .
 If
 .I timeout
 is NULL, the call blocks indefinitely.
@@ -1093,7 +1085,16 @@ argument provides a timeout for the lock attempt.
 If
 .I timeout
 is not NULL, the structure it points to specifies
-an absolute timeout, measured against the
+an absolute timeout.
+If
+.I timeout
+is NULL, the operation will block indefinitely.
+.IP
+.IR Caveat :
+Unlike other
+.BR futex (2)
+operations,
+the timeout is measured against the
 .B CLOCK_REALTIME
 clock.
 .\" 2016-07-07 response from Thomas Gleixner on LKML:
@@ -1112,9 +1113,6 @@ clock.
 .\" The reason is that phtread_mutex_timedlock() uses absolute timeouts based on
 .\" CLOCK_REALTIME. glibc folks asked to make that the default behaviour back
 .\" then when we added LOCK_PI.
-If
-.I timeout
-is NULL, the operation will block indefinitely.
 .IP
 The
 .IR uaddr2 ,
@@ -1137,12 +1135,6 @@ By default, the (absolute) timeout specified in
 .I timeout
 is measured against the
 .B CLOCK_MONOTONIC
-clock, but if the
-.B FUTEX_CLOCK_REALTIME
-flag is specified in
-.IR futex_op ,
-then the timeout is measured against the
-.B CLOCK_REALTIME
 clock.
 .\"
 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""