[liburing,2/2] man/io_uring_setup.2: Improve IORING_SETUP_REGISTERED_FD_ONLY documentation

Commit Message

Gabriel Krisman Bertazi April 3, 2024, 4:44 p.m. UTC

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 <[e-mail]>
---
 man/io_uring_setup.2 | 7 +++++++
 1 file changed, 7 insertions(+)

Patch

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