summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJens Axboe <axboe@kernel.dk>2022-05-10 14:38:19 -0600
committerJens Axboe <axboe@kernel.dk>2022-05-10 14:39:29 -0600
commite597622672fcfdab486337b5a80be49cfe25a99c (patch)
treeb98fbe0a05ee112cbc711262cee29daa9a08f7bf
parent95bcdd2f4bdd0dc702d9eb77675a31c0f0935dc6 (diff)
downloadliburing-e597622672fcfdab486337b5a80be49cfe25a99c.tar.gz
liburing-e597622672fcfdab486337b5a80be49cfe25a99c.tar.bz2
man: update man pages for waiting on a CQE with a timeout
On older kernels, it was indeed true that you did not need to separately submit before doing a wait, IFF you used a timeout. However, this is not true since kernels supported IORING_ENTER_EXT_ARG. Link: https://github.com/axboe/liburing/issues/579 Signed-off-by: Jens Axboe <axboe@kernel.dk>
-rw-r--r--man/io_uring_wait_cqe_timeout.310
-rw-r--r--man/io_uring_wait_cqes.310
2 files changed, 16 insertions, 4 deletions
diff --git a/man/io_uring_wait_cqe_timeout.3 b/man/io_uring_wait_cqe_timeout.3
index 64e920b..e81018a 100644
--- a/man/io_uring_wait_cqe_timeout.3
+++ b/man/io_uring_wait_cqe_timeout.3
@@ -28,8 +28,14 @@ param is filled in on success.
If
.I ts
-is specified, the application does not need to call io_uring_submit (3) before
-calling io_uring_wait_cqes (3).
+is specified and an older kernel without
+.B IORING_FEAT_EXT_ARG
+is used, the application does not need to call
+.BR io_uring_submit (3)
+before calling
+.BR io_uring_wait_cqes (3).
+For newer kernels with that feature flag set, there is no implied submit
+when waiting for a request.
.SH RETURN VALUE
On success
diff --git a/man/io_uring_wait_cqes.3 b/man/io_uring_wait_cqes.3
index a9a4a0c..2fb727c 100644
--- a/man/io_uring_wait_cqes.3
+++ b/man/io_uring_wait_cqes.3
@@ -35,8 +35,14 @@ param is filled in on success.
If
.I ts
-is specified, the application does not need to call io_uring_submit (3) before
-calling io_uring_wait_cqes (3).
+is specified and an older kernel without
+.B IORING_FEAT_EXT_ARG
+is used, the application does not need to call
+.BR io_uring_submit (3)
+before calling
+.BR io_uring_wait_cqes (3).
+For newer kernels with that feature flag set, there is no implied submit
+when waiting for a request.
.SH RETURN VALUE
On success