From 5188a360ab9275de4d6661524e24fe49c7e797eb Mon Sep 17 00:00:00 2001 From: Thomas de Zeeuw Date: Sat, 24 Jun 2023 12:53:35 +0200 Subject: [PATCH 1/2] Add GitHub issues to the community section --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index bebd2af71..9fd15f6fe 100644 --- a/README.md +++ b/README.md @@ -138,8 +138,8 @@ Currently supported platforms: * iOS * macOS -There are potentially others. If you find that Mio works on another -platform, submit a PR to update the list! +There are potentially others. If you find that Mio works on another platform, +submit a PR to update the list! Mio can handle interfacing with each of the event systems of the aforementioned platforms. The details of their implementation are further discussed in the @@ -163,9 +163,11 @@ This uses the Windows AFD system to access socket readiness events. ## Community A group of Mio users hang out on [Discord], this can be a good place to go for -questions. +questions. It's also possible to open a [new issue on GitHub] to ask questions, +report bugs or suggest new features. [Discord]: https://discord.gg/tokio +[new issue on GitHub]: https://github.com/tokio-rs/mio/issues/new ## Contributing From 24de81975aff168fbc075338ec5bf660ec94bafc Mon Sep 17 00:00:00 2001 From: Thomas de Zeeuw Date: Sat, 24 Jun 2023 13:06:02 +0200 Subject: [PATCH 2/2] Document unsupported cfg flags --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 9fd15f6fe..7c513863c 100644 --- a/README.md +++ b/README.md @@ -160,6 +160,27 @@ This uses the Windows AFD system to access socket readiness events. [issue #1152]: https://github.com/tokio-rs/mio/issues/1152 [issue #1444]: https://github.com/tokio-rs/mio/issues/1444 +## Unsupported flags + +Mio uses different implementations to support the same functionality dependening +on the platform. Mio generally uses the "best" implementation possible, where +"best" usually means most efficient for Mio's use case. However this means that +the implementation is often specific to a limited number of platforms, meaning +we often have multiple implemetations for the same functionality. In some cases +it might be required to not use the "best" implementation, but another +implementation Mio supports (on other platforms). **Mio does not officially +support secondary implementations on platforms**, however we do have various cfg +flags to force another implementation for these situations. + +Current flags: + * `mio_unsupported_force_poll_poll`, uses an implementation based on `poll(2)` + for `mio::Poll`. + * `mio_unsupported_force_waker_pipe`, uses an implementation based on `pipe(2)` + for `mio::Waker`. + +**Again, Mio does not officially supports this**. Furthermore these flags may +disappear in the future. + ## Community A group of Mio users hang out on [Discord], this can be a good place to go for