diff mbox series

[liburing] Document maximum ring size for io_uring_register_buf_ring

Message ID 20221020115141.3723324-1-dylany@meta.com (mailing list archive)
State New
Headers show
Series [liburing] Document maximum ring size for io_uring_register_buf_ring | expand

Commit Message

Dylan Yudaken Oct. 20, 2022, 11:51 a.m. UTC
The maximum size was not documented, so do that.

Reported-by: Frank Rehwinkel <frankrehwinkel@gmail.com>
Signed-off-by: Dylan Yudaken <dylany@meta.com>
---
 man/io_uring_register_buf_ring.3 | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)


base-commit: 13f3fe3af811d8508676dbd1ef552f2b459e1b21

Comments

Jens Axboe Oct. 20, 2022, 12:47 p.m. UTC | #1
On Thu, 20 Oct 2022 04:51:41 -0700, Dylan Yudaken wrote:
> The maximum size was not documented, so do that.
> 
> 

Applied, thanks!

[1/1] Document maximum ring size for io_uring_register_buf_ring
      (no commit info)

Best regards,
diff mbox series

Patch

diff --git a/man/io_uring_register_buf_ring.3 b/man/io_uring_register_buf_ring.3
index f75063fc9f2c..357a3fb39a0c 100644
--- a/man/io_uring_register_buf_ring.3
+++ b/man/io_uring_register_buf_ring.3
@@ -55,7 +55,8 @@  or similar. The size of the ring is the product of
 and the size of
 .IR "struct io_uring_buf" .
 .I ring_entries
-is the desired size of the ring, and must be a power-of-2 in size.
+is the desired size of the ring, and must be a power-of-2 in size. The maximum size 
+allowed is 2^15 (32768).
 .I bgid
 is the buffer group ID associated with this ring. SQEs that select a buffer
 has a buffer group associated with them in their