diff mbox series

[liburing,3/4] man: note about notification generation

Message ID 4ae18336994f973d2e5e111479844c79547d7922.1663759148.git.asml.silence@gmail.com (mailing list archive)
State New
Headers show
Series zc changes | expand

Commit Message

Pavel Begunkov Sept. 21, 2022, 11:21 a.m. UTC 
Add a small note to clarify expectations on when to expect a
notification.

Signed-off-by: Pavel Begunkov <asml.silence@gmail.com>
---
 man/io_uring_enter.2 | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/man/io_uring_enter.2 b/man/io_uring_enter.2
index d87f254..e0ce051 100644
--- a/man/io_uring_enter.2
+++ b/man/io_uring_enter.2
@@ -1091,7 +1091,10 @@  long time, e.g. waiting for a TCP ACK, and having a separate cqe for request
 completions allows userspace to push more data without extra delays. Note,
 notifications are only responsible for controlling the lifetime of the buffers,
 and as such don't mean anything about whether the data has atually been sent
-out or received by the other end.
+out or received by the other end. Even errored requests may generate a
+notification, and the user must check for
+.B IORING_CQE_F_MORE
+rather than relying on the result.
 
 .I fd
 must be set to the socket file descriptor,