diff options
| author | Jeff Moyer <jmoyer@redhat.com> | 2019-01-25 17:38:51 -0500 |
|---|---|---|
| committer | Jens Axboe <axboe@kernel.dk> | 2019-01-26 06:40:48 -0700 |
| commit | 9688b4a00f14d1c519d52ad94763ce9af8e72614 (patch) | |
| tree | c1c75d82c6e909c62693efd4ee722c5279bf78b2 /man | |
| parent | 2a8e5b105c6ec560bf65cae2d94ba3acce7a7915 (diff) | |
man: fixup description of fixed files I/O
The man page suggests that IOSQE_FIXED_FILE must be specified for all
sqes when the io_uring instance has files registered. This is not
the case, so clear that up.
Also fix a typo (few->new) while we're in there.
Signed-off-by: Jeff Moyer <jmoyer@redhat.com>
Signed-off-by: Jens Axboe <axboe@kernel.dk>
Diffstat (limited to 'man')
| -rw-r--r-- | man/io_uring_enter.2 | 12 | ||||
| -rw-r--r-- | man/io_uring_register.2 | 13 |
2 files changed, 12 insertions, 13 deletions
diff --git a/man/io_uring_enter.2 b/man/io_uring_enter.2 index dc81fc4..7a3498d 100644 --- a/man/io_uring_enter.2 +++ b/man/io_uring_enter.2 @@ -146,13 +146,13 @@ The .I flags field is a bit mask. Currently, the only supported flag is .B IOSQE_FIXED_FILE. -This flag must be specified for io_uring instances that registered -files using the -.BR io_uring_register(2) -system call. When specified, +When this flag is specified, .I fd -contains an index into the files array registered with the io_uring -instance. +is an index into the files array registered with the io_uring instance (see the +.B IORING_REGISTER_FILES +section of the +.BR io_uring_register(2) +man page). .I ioprio specifies the I/O priority. See diff --git a/man/io_uring_register.2 b/man/io_uring_register.2 index 3ae3098..1f8d5d3 100644 --- a/man/io_uring_register.2 +++ b/man/io_uring_register.2 @@ -103,20 +103,19 @@ contains a pointer to an array of .I nr_args file descriptors (signed 32 bit integers). -When used, the application must set +To make use of the registered files, the .B IOSQE_FIXED_FILE -in the +flag must be set in the .I flags member of the -.I struct io_uring_sqe. -Then, +.I struct io_uring_sqe, +and the .I fd -is set to the index of the buffer in the array supplied to -.B IORING_REGISTER_FILES. +member is set to the index of the file in the file descriptor array. Files are automatically unregistered when the io_uring instance is torn down. An application need only unregister if it wishes to -register a few set of fds. +register a new set of fds. .TP .BR IORING_UNREGISTER_FILES This operation requires no argument, and |