cpp/liburing
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

man/io_uring_enter.2: clarify io_uring_enter(2) return values

Browse Source 
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>
This commit is contained in:
Jens Axboe
2019-05-01 15:54:29 -06:00
parent 60b330558f
commit ff73ac71a1
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
man/io_uring_enter.2
View File

@@ -305,13 +305,15 @@ description of the opcodes above.
.PP .PP
.SH RETURN VALUE .SH RETURN VALUE
.BR io_uring_enter () .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 if
.I to_submit .I to_submit
was zero, if there were invalid entries in the submission queue, or if was zero or if the submission queue was empty. The errors below that refer to
the submission queue was empty. 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 .I errno
is set appropriately. is set appropriately.
.PP .PP