aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGabriel Krisman Bertazi <krisman@suse.de>2024-04-03 12:44:13 -0400
committerJens Axboe <axboe@kernel.dk>2024-04-05 20:09:05 -0600
commite4cfc721761a85ea6a257c77572546292d04bf79 (patch)
tree6ead07164581c26927bd0cfc46b41de176395847
parent501c78df8e76f3f6350207a2a1c89814bba4eb2d (diff)
downloadliburing-e4cfc721761a85ea6a257c77572546292d04bf79.tar.gz
man/io_uring_setup.2: Improve IORING_SETUP_REGISTERED_FD_ONLY documentation
Document that IORING_SETUP_REGISTERED_FD_ONLY depends on IORING_SETUP_NO_MMAP being set. Closes: https://github.com/axboe/liburing/issues/1087 Signed-off-by: Gabriel Krisman Bertazi <krisman@suse.de> Link: https://lore.kernel.org/r/20240403164413.16398-3-krisman@suse.de Signed-off-by: Jens Axboe <axboe@kernel.dk>
-rw-r--r--man/io_uring_setup.27
1 files changed, 7 insertions, 0 deletions
diff --git a/man/io_uring_setup.2 b/man/io_uring_setup.2
index f65c1f2..888e82b 100644
--- a/man/io_uring_setup.2
+++ b/man/io_uring_setup.2
@@ -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
@@ -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