Skip to content

docs: fix snippet-preamble notes and io_uring platform detail #287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sgerbino merged 1 commit into from
Jun 21, 2026
Merged

docs: fix snippet-preamble notes and io_uring platform detail #287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion doc/modules/ROOT/pages/3.tutorials/3e.hash-server.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ hash on a thread pool, and sends the result back. You'll learn how to combine
an `io_context` for network I/O with a `thread_pool` for CPU-bound work,
switching between them mid-coroutine with `capy::run()`.

NOTE: Code snippets assume:
[NOTE]
====
Code snippets assume:
[source,cpp]
----
#include <boost/corosio/io_context.hpp>
Expand All @@ -30,6 +32,7 @@ NOTE: Code snippets assume:
namespace corosio = boost::corosio;
namespace capy = boost::capy;
----
====

== Overview

Expand Down
5 changes: 4 additions & 1 deletion doc/modules/ROOT/pages/3.tutorials/3f.reconnect.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ reconnects with exponential backoff when the connection fails. You'll learn
how to combine timers with sockets for retry logic and how to use stop tokens
for graceful shutdown.

NOTE: Code snippets assume:
[NOTE]
====
Code snippets assume:
[source,cpp]
----
#include <boost/corosio/endpoint.hpp>
Expand All @@ -29,6 +31,7 @@ NOTE: Code snippets assume:
namespace corosio = boost::corosio;
namespace capy = boost::capy;
----
====

== Overview

Expand Down
4 changes: 2 additions & 2 deletions doc/modules/ROOT/pages/4.guide/4c.io-context.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -301,9 +301,9 @@ On Linux, the `io_context` uses epoll:
* Edge-triggered notifications
* Efficient for long-lived connections

==== io_uring — Planned
==== io_uring

Future Linux support will add io_uring for:
Linux also provides an io_uring backend:

* Kernel-level async I/O
* Reduced system calls
Expand Down
Loading