From 9535ddc5370e7fa387d3ffbac0e15bff04a65ebe Mon Sep 17 00:00:00 2001
From: Drew DeVault <sir@cmpwn.com>
Date: Wed, 20 Oct 2021 09:43:59 +0200
Subject: [PATCH] linux::io_uring: add README

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

---
 io_uring/README | 9 +++++++++

diff --git a/io_uring/README b/io_uring/README
new file mode 100644
index 0000000000000000000000000000000000000000..61e21ca249fe98342fd83693e8e6c75b3e64e1e7
--- /dev/null
+++ b/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.

-- 
2.48.1