summaryrefslogtreecommitdiff
path: root/man/io_uring_register_buffers.3
diff options
context:
space:
mode:
authorStefan Roesch <shr@fb.com>2021-11-17 12:02:04 -0800
committerJens Axboe <axboe@kernel.dk>2021-11-17 13:06:20 -0700
commit2a4091133858c659fb1cb7f42642ebcb44032e86 (patch)
tree0bb2b22fe6dfcd3a7711fd7ef17c062c69db7c24 /man/io_uring_register_buffers.3
parenta973e500d5eaf9ccf28a6acaec738f6eb4221683 (diff)
downloadliburing-2a4091133858c659fb1cb7f42642ebcb44032e86.tar.gz
liburing-2a4091133858c659fb1cb7f42642ebcb44032e86.tar.bz2
liburing: add missing man pages
Add missing man pages for liburing functions. Signed-off-by: Stefan Roesch <shr@fb.com> Signed-off-by: Jens Axboe <axboe@kernel.dk>
Diffstat (limited to 'man/io_uring_register_buffers.3')
-rw-r--r--man/io_uring_register_buffers.334
1 files changed, 34 insertions, 0 deletions
diff --git a/man/io_uring_register_buffers.3 b/man/io_uring_register_buffers.3
new file mode 100644
index 0000000..48cc506
--- /dev/null
+++ b/man/io_uring_register_buffers.3
@@ -0,0 +1,34 @@
+.\" Copyright (C) 2021 Stefan Roesch <shr@fb.com>
+.\"
+.\" SPDX-License-Identifier: LGPL-2.0-or-later
+.\"
+.TH io_uring_register_buffers 3 "November 15, 2021" "liburing-2.1" "liburing Manual"
+.SH NAME
+io_uring_register_buffers - register buffers for fixed buffer operations
+.fi
+.SH SYNOPSIS
+.nf
+.BR "#include <liburing.h>"
+.PP
+.BI "int io_uring_register_buffers(struct io_uring *ring,"
+.BI " const struct iovec *iovecs,
+.BI " unsigned nr_iovecs)"
+.PP
+.SH DESCRIPTION
+.PP
+The io_uring_register_buffers() function registers
+.I nr_iovecs
+number of buffers defined by the array
+.I iovecs
+belonging to the
+.I ring.
+
+After the caller has registered the buffers, they can be used with one of the
+fixed buffers functions.
+
+.SH RETURN VALUE
+On success
+.BR io_uring_register_buffers (3)
+returns 0. On failure it returns -errno.
+.SH SEE ALSO
+.BR io_uring_get_sqe (3), io_uring_unregister_buffers (3) \ No newline at end of file