Skip to content

Fix documentation grammar and outdated platform details #197

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
Mar 9, 2026
Merged

Fix documentation grammar and outdated platform details #197

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
16 changes: 12 additions & 4 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 @@ -282,17 +282,25 @@ On Windows, the `io_context` uses I/O Completion Ports:
* Efficient thread pool utilization
* Native async I/O with zero-copy potential

=== Linux (io_uring) — Planned
=== Linux (epoll)

Future Linux support will use io_uring for:
On Linux, the `io_context` uses epoll:

* Scalable to large numbers of file descriptors
* Edge-triggered notifications
* Efficient for long-lived connections

==== io_uring — Planned

Future Linux support will add io_uring for:

* Kernel-level async I/O
* Reduced system calls
* Support for more operation types

=== macOS (kqueue) — Planned
=== macOS / FreeBSD (kqueue)

Future macOS support will use kqueue for:
On macOS and FreeBSD, the `io_context` uses kqueue:

* Efficient event notification
* File descriptor monitoring
Expand Down
2 changes: 1 addition & 1 deletion doc/modules/ROOT/pages/4.guide/4e.tcp-acceptor.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ namespace corosio = boost::corosio;

== Overview

An tcp_acceptor binds to a local endpoint and waits for clients to connect:
A tcp_acceptor binds to a local endpoint and waits for clients to connect:

[source,cpp]
----
Expand Down
Loading