From 1d45aec674b41ed4842f485c10a307eb9ad78dbf Mon Sep 17 00:00:00 2001 From: Alice Ryhl Date: Sun, 19 Feb 2023 16:36:05 +0100 Subject: [PATCH 1/4] tokio: document supported platforms --- tokio/src/lib.rs | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/tokio/src/lib.rs b/tokio/src/lib.rs index aa94ff020da..4a3054f1f94 100644 --- a/tokio/src/lib.rs +++ b/tokio/src/lib.rs @@ -384,7 +384,14 @@ //! [unstable features]: https://internals.rust-lang.org/t/feature-request-unstable-opt-in-non-transitive-crate-features/16193#why-not-a-crate-feature-2 //! [feature flags]: https://doc.rust-lang.org/cargo/reference/manifest.html#the-features-section //! -//! ## WASM support +//! ## Supported platforms +//! +//! Tokio supports any platform that mio supports. You can find the list [in +//! mio's documentation][mio-supported]. +//! +//! [mio-supported]: https://crates.io/crates/mio#platforms +//! +//! ### WASM support //! //! Tokio has some limited support for the WASM platform. Without the //! `tokio_unstable` flag, the following features are supported: From 9dae1a8f298b0c06fde2b1d42852a80f30f49ca6 Mon Sep 17 00:00:00 2001 From: Alice Ryhl Date: Sun, 19 Feb 2023 17:37:49 +0100 Subject: [PATCH 2/4] Reword --- tokio/src/lib.rs | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/tokio/src/lib.rs b/tokio/src/lib.rs index 4a3054f1f94..9c3d333e484 100644 --- a/tokio/src/lib.rs +++ b/tokio/src/lib.rs @@ -386,8 +386,23 @@ //! //! ## Supported platforms //! -//! Tokio supports any platform that mio supports. You can find the list [in -//! mio's documentation][mio-supported]. +//! Tokio currently guarantees support for the following platforms: +//! +//! * Linux +//! * Windows +//! * Android (API level 21) +//! * macOS +//! * iOS +//! * FreeBSD +//! +//! Tokio will continue to support these platforms in the future. However, +//! future releases may bump things like the minimum required libc version on +//! Linux or the API level on Android. +//! +//! Beyond the above platforms, Tokio is intended to work on all platforms +//! supported by the mio crate. You can find a longer list [in mio's +//! documentation][mio-supported]. However, these additional platforms may +//! become unsupported in the future. //! //! [mio-supported]: https://crates.io/crates/mio#platforms //! From 4a696b8d2afe3d07301d247f1d7f53c7455d14a9 Mon Sep 17 00:00:00 2001 From: Alice Ryhl Date: Mon, 20 Feb 2023 00:17:02 +0100 Subject: [PATCH 3/4] Update wording on FreeBSD and Wine --- tokio/src/lib.rs | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/tokio/src/lib.rs b/tokio/src/lib.rs index 9c3d333e484..8aa748fab8b 100644 --- a/tokio/src/lib.rs +++ b/tokio/src/lib.rs @@ -396,14 +396,17 @@ //! * FreeBSD //! //! Tokio will continue to support these platforms in the future. However, -//! future releases may bump things like the minimum required libc version on -//! Linux or the API level on Android. +//! future releases may change requirements such as the minimum required libc +//! version on Linux, the API level on Android, or the supported FreeBSD +//! release. //! //! Beyond the above platforms, Tokio is intended to work on all platforms //! supported by the mio crate. You can find a longer list [in mio's //! documentation][mio-supported]. However, these additional platforms may //! become unsupported in the future. //! +//! Note that although Windows is supported, we do not support Wine. +//! //! [mio-supported]: https://crates.io/crates/mio#platforms //! //! ### WASM support From de7636c25aac4566c39c7e423b0a262c74779d57 Mon Sep 17 00:00:00 2001 From: Alice Ryhl Date: Mon, 20 Feb 2023 00:34:20 +0100 Subject: [PATCH 4/4] Refer to mio regarding wine --- tokio/src/lib.rs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/tokio/src/lib.rs b/tokio/src/lib.rs index 8aa748fab8b..688dd0c4d42 100644 --- a/tokio/src/lib.rs +++ b/tokio/src/lib.rs @@ -405,7 +405,8 @@ //! documentation][mio-supported]. However, these additional platforms may //! become unsupported in the future. //! -//! Note that although Windows is supported, we do not support Wine. +//! Note that Wine is considered to be a different platform from Windows. See +//! mio's documentation for more information on Wine support. //! //! [mio-supported]: https://crates.io/crates/mio#platforms //!