io-uring.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jeff Moyer <jmoyer@redhat.com>
To: axboe@kernel.dk, io-uring@vger.kernel.org
Subject: [liburing patch] document IORING_SETUP_CQSIZE
Date: Thu, 07 Nov 2019 16:18:57 -0500	[thread overview]
Message-ID: <x49ftizz8ou.fsf@segfault.boston.devel.redhat.com> (raw)

Add text in the io_uring_setup man page for the IORING_SETUP_CQSIZE
option.

Signed-off-by: Jeff Moyer <jmoyer@redhat.com>

diff --git a/man/io_uring_setup.2 b/man/io_uring_setup.2
index 9ab0143..c6e3dec 100644
--- a/man/io_uring_setup.2
+++ b/man/io_uring_setup.2
@@ -131,6 +131,13 @@ field of the
 This flag is only meaningful when
 .B IORING_SETUP_SQPOLL
 is specified.
+.TP
+.B IORING_SETUP_CQSIZE
+Create the completion queue with
+.IR "struct io_uring_params.cq_entries"
+entries.  The value must be greater than
+.IR entries ,
+and may be rounded up to the next power-of-two.
 .PP
 If no flags are specified, the io_uring instance is setup for
 interrupt driven I/O.  I/O may be submitted using
@@ -300,11 +307,15 @@ params is outside your accessible address space.
 The resv array contains non-zero data, p.flags contains an unsupported
 flag,
 .I entries
-is out of bounds, or
+is out of bounds,
 .B IORING_SETUP_SQ_AFF
 was specified, but
 .B IORING_SETUP_SQPOLL
-was not.
+was not, or
+.B IORING_SETUP_CQSIZE
+was specified, but
+.I io_uring_params.cq_entries
+was invalid.
 .TP
 .B EMFILE
 The per-process limit on the number of open file descriptors has been


             reply	other threads:[~2019-11-07 21:19 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-11-07 21:18 Jeff Moyer [this message]
2019-11-07 21:24 ` [liburing patch] document IORING_SETUP_CQSIZE Jens Axboe

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=x49ftizz8ou.fsf@segfault.boston.devel.redhat.com \
    --to=jmoyer@redhat.com \
    --cc=axboe@kernel.dk \
    --cc=io-uring@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).