Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[GIT PULL] Several small man fixes #1027

Merged
merged 4 commits into from
Jan 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions man/io_uring_enter.2
Original file line number Diff line number Diff line change
Expand Up @@ -1533,9 +1533,9 @@ At least one CQE was dropped even with the
.B IORING_FEAT_NODROP
feature, and there are no otherwise available CQEs. This clears the error state
and so with no other changes the next call to
.BR io_uring_setup (2)
.BR io_uring_enter (2)
will not have this error. This error should be extremely rare and indicates the
machine is running critically low on memory and. It may be reasonable for the
machine is running critically low on memory. It may be reasonable for the
application to terminate running unless it is able to safely handle any CQE
being lost.
.TP
Expand Down
12 changes: 6 additions & 6 deletions man/io_uring_prep_futex_waitv.3
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ io_uring_prep_futex_waitv \- prepare a futex waitv request
.B #include <unistd.h>
.B #include <liburing.h>
.PP
.BI "void io_uring_prep_futex_wait(struct io_uring_sqe *" sqe ","
.BI " struct futex_waitv *" futexv ","
.BI " uint32_t " nr_futex ","
.BI " unsigned int " flags ");"
.BI "void io_uring_prep_futex_waitv(struct io_uring_sqe *" sqe ","
.BI " struct futex_waitv *" futexv ","
.BI " uint32_t " nr_futex ","
.BI " unsigned int " flags ");"
.fi
.SH DESCRIPTION
.PP
Expand All @@ -32,9 +32,9 @@ is the number of futexes in that array.
must be set to the io_uring specific futex flags.

Unlike
.BR io_uring_prep_futex (3) ,
.BR io_uring_prep_futex_wait (3),
the desired bitset mask and values are passed in
.I futexv .
.IR futexv .

.I flags
are currently unused and hence
Expand Down
2 changes: 1 addition & 1 deletion man/io_uring_queue_init.3
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ By default, the CQ ring will have twice the number of entries as specified by
for the SQ ring. This is adequate for regular file or storage workloads, but
may be too small for networked workloads. The SQ ring entries do not impose a
limit on the number of in-flight requests that the ring can support, it merely
limits the number that can be submitted to the kernel in one go (batch). if the
limits the number that can be submitted to the kernel in one go (batch). If the
CQ ring overflows, e.g. more entries are generated than fits in the ring before
the application can reap them, then if the kernel supports
.B IORING_FEAT_NODROP
Expand Down
10 changes: 5 additions & 5 deletions man/io_uring_setup.2
Original file line number Diff line number Diff line change
Expand Up @@ -180,19 +180,19 @@ and may be rounded up to the next power-of-two.
If this flag is specified, and if
.IR entries
exceeds
.B IORING_MAX_ENTRIES ,
.BR IORING_MAX_ENTRIES ,
then
.IR entries
will be clamped at
.B IORING_MAX_ENTRIES .
.BR IORING_MAX_ENTRIES .
If the flag
.BR IORING_SETUP_SQPOLL
.B IORING_SETUP_CQSIZE
is set, and if the value of
.IR "struct io_uring_params.cq_entries"
exceeds
.B IORING_MAX_CQ_ENTRIES ,
.BR IORING_MAX_CQ_ENTRIES ,
then it will be clamped at
.B IORING_MAX_CQ_ENTRIES .
.BR IORING_MAX_CQ_ENTRIES .
.TP
.B IORING_SETUP_ATTACH_WQ
This flag should be set in conjunction with
Expand Down