From 35c0b3c34dda7c185ac91500a68a33374bbe24ee Mon Sep 17 00:00:00 2001 From: espoal Date: Wed, 14 Jan 2026 14:02:03 +0100 Subject: [PATCH] Buffers documentation Improve buf_ring_* and register_buffers man pages Signed-off-by: espoal --- man/io_uring_register_buffers.3 | 6 ++++++ man/io_uring_setup_buf_ring.3 | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/man/io_uring_register_buffers.3 b/man/io_uring_register_buffers.3 index dfb292da2..0706ef80d 100644 --- a/man/io_uring_register_buffers.3 +++ b/man/io_uring_register_buffers.3 @@ -95,6 +95,12 @@ return 0. return number of buffers updated. On failure they return .BR -errno . + +.SH NOTES +When possible prefer to use the newer and more efficient +.BR io_uring_register_buf_ring (3) +API. + .SH SEE ALSO .BR io_uring_register (2), .BR io_uring_get_sqe (3), diff --git a/man/io_uring_setup_buf_ring.3 b/man/io_uring_setup_buf_ring.3 index 63175ee45..5453503b9 100644 --- a/man/io_uring_setup_buf_ring.3 +++ b/man/io_uring_setup_buf_ring.3 @@ -80,12 +80,18 @@ returns a pointer to the buffer ring. On failure it returns and sets .I *err to -errno. + .SH NOTES Note that even if the kernel supports this feature, registering a provided buffer ring may still fail with .B -EINVAL if the host is a 32-bit architecture and the memory being passed in resides in high memory. + +Remember that you need to call +.BR io_uring_buf_ring_add (3) +to make the allocated buffers available to the kernel. + .SH SEE ALSO .BR io_uring_register_buf_ring (3), .BR io_uring_buf_ring_init (3),