Skip to content

Commit c8bfa3d

Browse files
committed
Clean-up docs
1 parent 5e7ff5a commit c8bfa3d

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

io-uring-bufring/README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
11
# io-uring-bufring
22

3-
bufring abstraction that can be used with io-uring-bearer or io-uring directly.
3+
io_uring buffer ring mapping abstraction that can be used with io-uring-bearer or io-uring directly.
4+
5+
Note that this mapped ring of buffers does not handle data itself but you will need to pair
6+
it with thing like [hugepage] or [anonymous mmap] where this crate maps the underlying memory
7+
into a buffer ring that the linux kernel understands.
8+
9+
See the [bearer test](./src/ring_buf/ring_buf_test.rs) for an example.
10+
11+
[hugepage]: https://github.com/yaws-rs/ylibc/tree/main/hugepage
12+
[anonymous_mmap]: https://github.com/yaws-rs/ylibc/tree/main/anonymous_mmap

0 commit comments

Comments
 (0)