aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJens Axboe <axboe@kernel.dk>2022-06-18 08:52:11 -0600
committerJens Axboe <axboe@kernel.dk>2022-06-18 08:52:11 -0600
commita2dece6ae57bdb521770f9b746089c865933b553 (patch)
tree45fe06acfd45dfeb1cc0a3582cabbdb5f4539d7c
parent06e8cf2e7c8391826457a29da92771f184d8c514 (diff)
downloadliburing-a2dece6ae57bdb521770f9b746089c865933b553.tar.gz
man/io_uring_prep_cancel.3: clarify the NOTES section a bit more
Signed-off-by: Jens Axboe <axboe@kernel.dk>
-rw-r--r--man/io_uring_prep_cancel.312
1 files changed, 7 insertions, 5 deletions
diff --git a/man/io_uring_prep_cancel.3 b/man/io_uring_prep_cancel.3
index 3201445..3c9f2df 100644
--- a/man/io_uring_prep_cancel.3
+++ b/man/io_uring_prep_cancel.3
@@ -103,13 +103,15 @@ One of the fields set in the SQE was invalid.
The execution state of the request has progressed far enough that cancelation
is no longer possible. This should normally mean that it will complete shortly,
either successfully, or interrupted due to the cancelation.
-
.SH NOTES
-
-Although the cancelation request uses async request syntax, the kernel part isn't async at all. It is guaranteed that a CQE is always generated by the time the cancel request has been submitted. If the cancelation is succeed, the request targeted for cancelation will have been posted by the time submission returns. For
+Although the cancelation request uses async request syntax, the kernel side of
+the cancelation is always run synchronously. It is guaranteed that a CQE is
+always generated by the time the cancel request has been submitted. If the
+cancelation is successful, the completion for the request targeted for
+cancelation will have been posted by the time submission returns. For
.B -EALREADY
-it may take a bit of time to do so.
-
+it may take a bit of time to do so. For this case, the caller must wait for the
+canceled request to post its completion event.
.SH SEE ALSO
.BR io_uring_prep_poll_remove (3),
.BR io_uring_get_sqe (3),