summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorJens Axboe <axboe@kernel.dk>2019-05-01 15:54:29 -0600
committerJens Axboe <axboe@kernel.dk>2019-05-01 15:54:29 -0600
commitff73ac71a171663b5879f7dc3e0eba696239db3e (patch)
tree2bde39669dd7a979d0e7a8f4b25bcd7b275beb14 /man
parent60b330558f75d2093ae81034f01c263cc672ea65 (diff)
downloadliburing-ff73ac71a171663b5879f7dc3e0eba696239db3e.tar.gz
liburing-ff73ac71a171663b5879f7dc3e0eba696239db3e.tar.bz2
man/io_uring_enter.2: clarify io_uring_enter(2) return values
With the recent change to ensure that submission side errors that happen on behalf of an sqe are returned in the form of a cqe rather than -1/errno from the system call, make sure that the man page reflects that. Signed-off-by: Jens Axboe <axboe@kernel.dk>
Diffstat (limited to 'man')
-rw-r--r--man/io_uring_enter.210
1 files changed, 6 insertions, 4 deletions
diff --git a/man/io_uring_enter.2 b/man/io_uring_enter.2
index 02f3736..4e0ab4f 100644
--- a/man/io_uring_enter.2
+++ b/man/io_uring_enter.2
@@ -305,13 +305,15 @@ description of the opcodes above.
.PP
.SH RETURN VALUE
.BR io_uring_enter ()
-returns the number of I/Os successfully submitted. This can be zero
+returns the number of I/Os successfully consumed. This can be zero
if
.I to_submit
-was zero, if there were invalid entries in the submission queue, or if
-the submission queue was empty.
+was zero or if the submission queue was empty. The errors below that refer to
+an error in a submission queue entry will be returned though a completion queue
+entry, rather than through the system call itself.
-On error, -1 is returned and
+Errors that occur not on behalf of a submission queue entry are returned via the
+system call directly. On such an error, -1 is returned and
.I errno
is set appropriately.
.PP