futex man: add note on using linked timeouts The io_uring wait syscalls do not support passing in a timeout in the request itself, like the sync futex syscalls do. Instead, it is encouraged to use linked timeouts to achieve the same thing. While in there, also fixup some .B$ tags that should've been .BR. Signed-off-by: Jens Axboe <axboe@kernel.dk>
diff --git a/man/io_uring_prep_futex_wait.3 b/man/io_uring_prep_futex_wait.3 index 4de9164..22e9a14 100644 --- a/man/io_uring_prep_futex_wait.3 +++ b/man/io_uring_prep_futex_wait.3
@@ -78,10 +78,15 @@ directly in the CQE .I res field. +.SH NOTES +Unlike the sync futex syscalls that wait on a futex, io_uring does not support +passing in a timeout for the request. Instead, applications are encouraged +to use a linked timeout to abort the futex request at a given time, if desired. .SH SEE ALSO .BR io_uring_get_sqe (3), .BR io_uring_submit (3), -.B$ io_uring_prep_futex_waitv (3), -.B$ io_uring_prep_futex_wake (3), +.BR io_uring_prep_futex_waitv (3), +.BR io_uring_prep_futex_wake (3), +.BR io_uring_prep_link_timeout (3), .BR futex (2) .BR futex2 (2)
diff --git a/man/io_uring_prep_futex_waitv.3 b/man/io_uring_prep_futex_waitv.3 index 4226e81..85c3b7f 100644 --- a/man/io_uring_prep_futex_waitv.3 +++ b/man/io_uring_prep_futex_waitv.3
@@ -62,10 +62,15 @@ directly in the CQE .I res field. +.SH NOTES +Unlike the sync futex syscalls that wait on a futex, io_uring does not support +passing in a timeout for the request. Instead, applications are encouraged +to use a linked timeout to abort the futex request at a given time, if desired. .SH SEE ALSO .BR io_uring_get_sqe (3), .BR io_uring_submit (3), -.B$ io_uring_prep_futex_wait (3), -.B$ io_uring_prep_futex_wake (3), +.BR io_uring_prep_futex_wait (3), +.BR io_uring_prep_futex_wake (3), +.BR io_uring_prep_link_timeout (3), .BR futex (2) .BR futex2 (2)
diff --git a/man/io_uring_prep_futex_wake.3 b/man/io_uring_prep_futex_wake.3 index 3920bf5..4d96e05 100644 --- a/man/io_uring_prep_futex_wake.3 +++ b/man/io_uring_prep_futex_wake.3
@@ -78,7 +78,7 @@ .SH SEE ALSO .BR io_uring_get_sqe (3), .BR io_uring_submit (3), -.B$ io_uring_prep_futex_wait (3), -.B$ io_uring_prep_futex_waitv (3), +.BR io_uring_prep_futex_wait (3), +.BR io_uring_prep_futex_waitv (3), .BR futex (2) .BR futex2 (2)