commit 725c6c8fc05b8883f30da4580f416711498992a3
parent b53e6eed0175ca59579a723a3f1ea47d02158e4e
Author: Drew DeVault <sir@cmpwn.com>
Date: Tue, 19 Oct 2021 14:05:08 +0200
iobus: join lines in README
I guess the doc parser doesn't handle this
Signed-off-by: Drew DeVault <sir@cmpwn.com>
Diffstat:
1 file changed, 3 insertions(+), 6 deletions(-)
diff --git a/iobus/README b/iobus/README
@@ -8,13 +8,10 @@ the host platform, such as io_uring or kqueue.
The core of iobus is the event loop. The application using iobus will generally
follow these steps:
-- Create an iobus with [[new]], and optionally register a set of [[io::file]]s
- or buffers with the bus using [[register_file]] or [[register_buffer]].
+- Create an iobus with [[new]], and optionally register a set of [[io::file]]s or buffers with the bus using [[register_file]] or [[register_buffer]].
- Create I/O handles (e.g. via [[read]]) and [[enqueue]] or [[submit]] them.
-- Dispatch the bus with [[dispatch]], blocking until at least one operation is
- complete and returning its [[result]].
-- Process the results of the completed I/O operation (e.g. with [[endread]]),
- mark it as [[done]], then re-enter the event loop.
+- Dispatch the bus with [[dispatch]], blocking until at least one operation is complete and returning its [[result]].
+- Process the results of the completed I/O operation (e.g. with [[endread]]), mark it as [[done]], then re-enter the event loop.
The event loop will resemble the following:
