Document supported platforms #5483

Darksonn · 2023-02-19T15:37:55Z

Document which platforms are supported.

@Thomasdezeeuw Are there any nuances here that we should be careful about?

View rendered version

tokio/src/lib.rs

Thomasdezeeuw · 2023-02-19T21:23:56Z

Off the top of my head:

FreeBSD can have breaking changes in each major release, so far we've mainly followed the stable releases.
Wine is not supported, it's not listed as such but people of thinks it's the same as supporting Windows (it's not).

Other than that this LGTM.

notgull · 2023-02-19T23:20:46Z

mio also supports DragonflyBSD, NetBSD and OpenBSD. Does tokio not support those platforms?

Wine is not supported, it's not listed as such but people of thinks it's the same as supporting Windows (it's not).

Aren't the latest versions of Wine supported? From tokio-rs/mio#1637 it looks like Wine 7.13+ is supported.

Darksonn · 2023-02-19T23:30:26Z

mio also supports DragonflyBSD, NetBSD and OpenBSD. Does tokio not support those platforms?

We do support them, but I consider them as a different "tier" of support.

I don't see us dropping support for FreeBSD (after all, we even have FreeBSD specific APIs in Tokio and test on it in CI), but the same cannot be said for the other bsds. We will accept patches and bug reports related to them, but if they are too difficult to continue supporting for some reason, we may ultimately decide to drop support. That is how Wine support was originally dropped in mio.

Thomasdezeeuw · 2023-02-20T09:26:50Z

mio also supports DragonflyBSD, NetBSD and OpenBSD. Does tokio not support those platforms?

We don't test any of these platforms in the CI, mainly because rustup doesn't have target for these platforms, so I'd say supporting them is an overstatement. That said, I always try to keep these platforms running, it's just quite hard to keep that up without a CI for them.

Wine is not supported, it's not listed as such but people of thinks it's the same as supporting Windows (it's not).

Aren't the latest versions of Wine supported? From tokio-rs/mio#1637 it looks like Wine 7.13+ is supported.

Not really, Wine still has different behaviour as can be seen by the ignoring of some tests.

carllerche · 2023-02-21T18:09:16Z

This seems fine to me. We probably do want to document "tiers" as well as explicitly.

# 1.26.0 (March 1st, 2023) ### Fixed - sync: don't leak tracing spans in mutex guards ([#5469]) - sync: drop wakers after unlocking the mutex in Notify ([#5471]) - sync: drop wakers outside lock in semaphore ([#5475]) - macros: fix empty `join!` and `try_join!` ([#5504]) ### Added - fs: add `fs::try_exists` ([#4299]) - net: add types for named unix pipes ([#5351]) - sync: add `MappedOwnedMutexGuard` ([#5474]) ### Documented - task: clarify what happens to spawned work during runtime shutdown ([#5394]) - task: clarify `process::Command` docs (#5406) ([#5413]) - sync: add doc aliases for `blocking_*` methods ([#5448]) - task: fix wording with 'unsend' ([#5452]) - signal: updated Documentation for Signals ([#5459]) - sync: fix docs for Send/Sync bounds in broadcast ([#5480]) - io: improve AsyncFd example ([#5481]) - tokio: document supported platforms ([#5483]) - runtime: document the nature of the main future ([#5494]) - sync: document drop behavior for channels ([#5497]) - time: document immediate completion guarantee for timeouts ([#5509]) - runtime: remove extra period in docs ([#5511]) ### Changed - net: use Message Read Mode for named pipes ([#5350]) - chore: update windows-sys to 0.45 ([#5386]) - sync: mark lock guards with `#[clippy::has_significant_drop]` ([#5422]) - sync: reduce contention in watch channel ([#5464]) - time: remove cache padding in timer entries ([#5468]) - time: Improve `Instant::now()` perf with test-util ([#5513]) ### Internal Changes - tests: port proptest fuzz harnesses to use cargo-fuzz ([#5392]) - time: don't store deadline twice in sleep entries ([#5410]) - rt: remove Arc from Clock ([#5434]) - sync: make `notify_waiters` calls atomic ([#5458]) - net: refactor named pipe builders to not use bitfields ([#5477]) - io: use `poll_fn` in `copy_bidirectional` ([#5486]) - fs: add more tests for filesystem functionality ([#5493]) - net: fix test compilation failure ([#5506]) - io: ignore SplitByUtf8BoundaryIfWindows test on miri ([#5507]) ### Unstable - metrics: add a new metric for budget exhaustion yields ([#5517]) [#4299]: #4299 [#5350]: #5350 [#5351]: #5351 [#5386]: #5386 [#5392]: #5392 [#5394]: #5394 [#5410]: #5410 [#5413]: #5413 [#5422]: #5422 [#5434]: #5434 [#5448]: #5448 [#5452]: #5452 [#5458]: #5458 [#5459]: #5459 [#5464]: #5464 [#5468]: #5468 [#5469]: #5469 [#5471]: #5471 [#5474]: #5474 [#5475]: #5475 [#5477]: #5477 [#5480]: #5480 [#5481]: #5481 [#5483]: #5483 [#5486]: #5486 [#5493]: #5493 [#5494]: #5494 [#5497]: #5497 [#5504]: #5504 [#5506]: #5506 [#5507]: #5507 [#5509]: #5509 [#5511]: #5511 [#5513]: #5513 [#5517]: #5517

# 1.26.0 (March 1st, 2023) ### Fixed - macros: fix empty `join!` and `try_join!` ([#5504]) - sync: don't leak tracing spans in mutex guards ([#5469]) - sync: drop wakers after unlocking the mutex in Notify ([#5471]) - sync: drop wakers outside lock in semaphore ([#5475]) ### Added - fs: add `fs::try_exists` ([#4299]) - net: add types for named unix pipes ([#5351]) - sync: add `MappedOwnedMutexGuard` ([#5474]) ### Changed - chore: update windows-sys to 0.45 ([#5386]) - net: use Message Read Mode for named pipes ([#5350]) - sync: mark lock guards with `#[clippy::has_significant_drop]` ([#5422]) - sync: reduce contention in watch channel ([#5464]) - time: remove cache padding in timer entries ([#5468]) - time: Improve `Instant::now()` perf with test-util ([#5513]) ### Internal Changes - io: use `poll_fn` in `copy_bidirectional` ([#5486]) - net: refactor named pipe builders to not use bitfields ([#5477]) - rt: remove Arc from Clock ([#5434]) - sync: make `notify_waiters` calls atomic ([#5458]) - time: don't store deadline twice in sleep entries ([#5410]) ### Unstable - metrics: add a new metric for budget exhaustion yields ([#5517]) ### Documented - io: improve AsyncFd example ([#5481]) - runtime: document the nature of the main future ([#5494]) - runtime: remove extra period in docs ([#5511]) - signal: updated Documentation for Signals ([#5459]) - sync: add doc aliases for `blocking_*` methods ([#5448]) - sync: fix docs for Send/Sync bounds in broadcast ([#5480]) - sync: document drop behavior for channels ([#5497]) - task: clarify what happens to spawned work during runtime shutdown ([#5394]) - task: clarify `process::Command` docs ([#5413]) - task: fix wording with 'unsend' ([#5452]) - time: document immediate completion guarantee for timeouts ([#5509]) - tokio: document supported platforms ([#5483]) [#4299]: #4299 [#5350]: #5350 [#5351]: #5351 [#5386]: #5386 [#5394]: #5394 [#5410]: #5410 [#5413]: #5413 [#5422]: #5422 [#5434]: #5434 [#5448]: #5448 [#5452]: #5452 [#5458]: #5458 [#5459]: #5459 [#5464]: #5464 [#5468]: #5468 [#5469]: #5469 [#5471]: #5471 [#5474]: #5474 [#5475]: #5475 [#5477]: #5477 [#5480]: #5480 [#5481]: #5481 [#5483]: #5483 [#5486]: #5486 [#5494]: #5494 [#5497]: #5497 [#5504]: #5504 [#5509]: #5509 [#5511]: #5511 [#5513]: #5513 [#5517]: #5517

tokio: document supported platforms

1d45aec

Darksonn added T-docs Topic: documentation A-tokio Area: The main tokio crate labels Feb 19, 2023

Darksonn requested review from Thomasdezeeuw and carllerche February 19, 2023 15:38

brody4hire reviewed Feb 19, 2023

View reviewed changes

tokio/src/lib.rs Outdated Show resolved Hide resolved

Reword

9dae1a8

Update wording on FreeBSD and Wine

4a696b8

Refer to mio regarding wine

de7636c

Thomasdezeeuw approved these changes Feb 20, 2023

View reviewed changes

carllerche approved these changes Feb 21, 2023

View reviewed changes

Darksonn merged commit d7b7c61 into tokio-rs:master Feb 21, 2023

Darksonn deleted the doc-supported-platforms branch February 21, 2023 18:57

amab8901 pushed a commit to amab8901/tokio that referenced this pull request Feb 27, 2023

tokio: document supported platforms (tokio-rs#5483)

708f863

Noah-Kennedy mentioned this pull request Mar 1, 2023

chore: prepare for Tokio v1.26.0 release #5521

Merged

This was referenced May 26, 2025

Bump the cargo group across 1 directory with 7 updates SbruiceS/static-analysis#1

Open

⬆️ Bump tokio from 1.21.2 to 1.26.0 in the cargo group across 1 directory fedepujol/nvim-completion#1

Open

This was referenced Jun 3, 2025

build(deps): bump the cargo group across 2 directories with 8 updates AKJUS/attestation-agent#1

Open

Bump the cargo group across 1 directory with 7 updates bassamawada/solana-security-txt#3

Merged

This was referenced Jun 15, 2025

Bump the cargo group across 2 directories with 4 updates hamirmahal/adblock-rust#1

Open

Bump the cargo group across 1 directory with 7 updates quanglong11/solana-security-txt#1

Merged

This was referenced Jul 2, 2025

chore(deps): bump tokio from 1.20.0 to 1.26.0 in /src/Rust SherkeyXD/MaaAssistantArknights#26

Merged

Bump the cargo group across 1 directory with 7 updates AKJUS/ChainX#8

Open

dependabot bot mentioned this pull request Jul 18, 2025

chore(deps): bump the cargo group across 2 directories with 10 updates cpuguy83/containerd-wasm-shims#1

Open

dependabot bot mentioned this pull request Aug 17, 2025

Bump the cargo group across 2 directories with 8 updates oilcrest/cargo-vet#1

Open

dependabot bot mentioned this pull request Sep 6, 2025

Bump the cargo group across 1 directory with 2 updates cocoot/http-proxy-ipv6-pool#1

Open

dependabot bot mentioned this pull request Oct 16, 2025

chore(deps): bump the cargo group across 1 directory with 7 updates master3395/discord-status#2

Open

dependabot bot mentioned this pull request Oct 25, 2025

Bump tokio from 1.25.0 to 1.26.0 in the cargo group across 1 directory x86pup/libreddit#4

Open

dependabot bot mentioned this pull request Nov 12, 2025

Bump the cargo group across 1 directory with 11 updates MetaMask/substrate-contracts-node#2

Open

This was referenced Nov 20, 2025

Bump the cargo group across 1 directory with 5 updates elonen/ldap_authz_proxy#2

Closed

Build(deps): Bump tokio from 1.18.2 to 1.26.0 in /benchmarks/stress dsp-testing/vSMTP#1

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Document supported platforms #5483

Document supported platforms #5483

Uh oh!

Darksonn commented Feb 19, 2023 •

edited

Loading

Uh oh!

Uh oh!

Thomasdezeeuw commented Feb 19, 2023

Uh oh!

notgull commented Feb 19, 2023

Uh oh!

Darksonn commented Feb 19, 2023 •

edited

Loading

Uh oh!

Thomasdezeeuw commented Feb 20, 2023

Uh oh!

carllerche commented Feb 21, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Document supported platforms #5483

Document supported platforms #5483

Uh oh!

Conversation

Darksonn commented Feb 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Thomasdezeeuw commented Feb 19, 2023

Uh oh!

notgull commented Feb 19, 2023

Uh oh!

Darksonn commented Feb 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Thomasdezeeuw commented Feb 20, 2023

Uh oh!

carllerche commented Feb 21, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Darksonn commented Feb 19, 2023 •

edited

Loading

Darksonn commented Feb 19, 2023 •

edited

Loading