Skip to content

Commit 71a1a3d

Browse files
tokio: update outdated unstable features section (#7839)
1 parent df73fa2 commit 71a1a3d

2 files changed

Lines changed: 5 additions & 12 deletions

File tree

tokio/src/lib.rs

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -320,7 +320,7 @@
320320
//! Beware though that this will pull in many extra dependencies that you may not
321321
//! need.
322322
//!
323-
//! - `full`: Enables all features listed below except `test-util` and `tracing`.
323+
//! - `full`: Enables all features listed below except `test-util` and unstable features.
324324
//! - `rt`: Enables `tokio::spawn`, the current-thread scheduler,
325325
//! and non-scheduler utilities.
326326
//! - `rt-multi-thread`: Enables the heavier, multi-threaded, work-stealing scheduler.
@@ -330,7 +330,7 @@
330330
//! `UdpSocket`, as well as (on Unix-like systems) `AsyncFd` and (on
331331
//! FreeBSD) `PollAio`.
332332
//! - `time`: Enables `tokio::time` types and allows the schedulers to enable
333-
//! the built in timer.
333+
//! the built-in timer.
334334
//! - `process`: Enables `tokio::process` types.
335335
//! - `macros`: Enables `#[tokio::main]` and `#[tokio::test]` macros.
336336
//! - `sync`: Enables all `tokio::sync` types.
@@ -351,16 +351,10 @@
351351
//! Some feature flags are only available when specifying the `tokio_unstable` flag:
352352
//!
353353
//! - `tracing`: Enables tracing events.
354+
//! - `io-uring`: Enables `io-uring` (Linux only).
355+
//! - `taskdump`: Enables `taskdump` (Linux only).
354356
//!
355-
//! Likewise, some parts of the API are only available with the same flag:
356-
//!
357-
//! - [`task::Builder`]
358-
//! - Some methods on [`task::JoinSet`]
359-
//! - [`runtime::RuntimeMetrics`]
360-
//! - [`runtime::Builder::on_task_spawn`]
361-
//! - [`runtime::Builder::on_task_terminate`]
362-
//! - [`runtime::Builder::unhandled_panic`]
363-
//! - [`runtime::TaskMeta`]
357+
//! Likewise, this flag enables access to unstable APIs.
364358
//!
365359
//! This flag enables **unstable** features. The public API of these features
366360
//! may break in 1.x releases. To enable these features, the `--cfg

tokio/src/runtime/task/mod.rs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,6 @@ mod harness;
189189
use self::harness::Harness;
190190

191191
mod id;
192-
#[cfg_attr(not(tokio_unstable), allow(unreachable_pub, unused_imports))]
193192
pub use id::{id, try_id, Id};
194193

195194
#[cfg(feature = "rt")]

0 commit comments

Comments
 (0)