Skip to content

Commit

Permalink
man/io_uring_setup.2: Improve IORING_SETUP_REGISTERED_FD_ONLY documen…
Browse files Browse the repository at this point in the history
…tation

Document that IORING_SETUP_REGISTERED_FD_ONLY depends on
IORING_SETUP_NO_MMAP being set.

Closes: #1087
Signed-off-by: Gabriel Krisman Bertazi <[email protected]>
Link: https://lore.kernel.org/r/[email protected]
Signed-off-by: Jens Axboe <[email protected]>
  • Loading branch information
krisman authored and axboe committed Apr 6, 2024
1 parent 501c78d commit e4cfc72
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions man/io_uring_setup.2
Original file line number Diff line number Diff line change
Expand Up @@ -325,6 +325,9 @@ file descriptor. The caller will need to use
.B IORING_REGISTER_USE_REGISTERED_RING
when calling
.BR io_uring_register (2).
This flag only makes sense when used alongside with
.B IORING_SETUP_NO_MMAP,
which also needs to be set.
Available since 6.5.

.TP
Expand Down Expand Up @@ -690,6 +693,10 @@ was not, or
was specified, but
.I io_uring_params.cq_entries
was invalid.
.B IORING_SETUP_REGISTERED_FD_ONLY
was specified, but
.B IORING_SETUP_NO_MMAP
was not.
.TP
.B EMFILE
The per-process limit on the number of open file descriptors has been
Expand Down

0 comments on commit e4cfc72

Please sign in to comment.