hare

commit de10bdcf4a39b40b707ba7e6b8ddb9871c03bc98
parent 894f7029fe39643c5cba46c81838739762c4b1e3
Author: Drew DeVault <sir@cmpwn.com>
Date:   Wed, 20 Oct 2021 09:43:59 +0200

linux::io_uring: add README

Signed-off-by: Drew DeVault <sir@cmpwn.com>

Diffstat:
A
linux/io_uring/README
 | 
9
+++++++++

1 file changed, 9 insertions(+), 0 deletions(-)
diff --git a/linux/io_uring/README b/linux/io_uring/README
@@ -0,0 +1,9 @@
+The io_uring module provides access to Linux's io_uring subsystem. The
+documentation for this module is somewhat scarce: users are presumed to be
+familiar with io_uring. Thus, it is recommended that a reading of this module is
+paired with the Linux documentation, which may be available from your local
+liburing package under the io_uring_setup, io_uring_enter, and io_uring_register
+man pages.
+
+For a high-level I/O multiplexing interface, which takes advantage of io_uring
+if available, users are encouraged to use [[iobus]] instead.