itsscb/tracing
1
0
Fork 0
mirror of https://github.com/tokio-rs/tracing.git synced 2025-10-02 15:24:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: Update incorrect tracing-futures feature docs (#2802)

Browse Source 
Co-authored-by: David Barsky <me@davidbarsky.com>
Co-authored-by: Hayden Stainsby <hds@caffeineconcepts.com>
This commit is contained in:
John Vandenberg 2024-12-01 02:49:46 +08:00 committed by Hayden Stainsby
parent 841965bede
commit 4ada2bd794
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
tracing-futures/src/lib.rs
View File

@ -24,10 +24,11 @@
//! This crate provides a number of feature flags that enable compatibility
//! features with other crates in the asynchronous ecosystem:
//!
//! - `tokio`: Enables compatibility with the `tokio` crate, including
//! - `tokio`: Enables compatibility with the `tokio` 0.1 crate, including
//! [`Instrument`] and [`WithSubscriber`] implementations for
//! `tokio::executor::Executor`, `tokio::runtime::Runtime`, and
//! `tokio::runtime::current_thread`. Enabled by default.
//! `tokio::runtime::current_thread`. This is not needed for compatibility
//! with `tokio` v1.
//! - `tokio-executor`: Enables compatibility with the `tokio-executor`
//! crate, including [`Instrument`] and [`WithSubscriber`]
//! implementations for types implementing `tokio_executor::Executor`.
@ -39,8 +40,6 @@
//! crate.
//! - `futures-03`: Enables compatibility with version 0.3.x of the `futures`
//! crate's `Spawn` and `LocalSpawn` traits.
//! - `tokio-alpha`: Enables compatibility with `tokio` 0.2's alpha releases,
//! including the `tokio` 0.2 `Executor` and `TypedExecutor` traits.
//! - `std`: Depend on the Rust standard library.
//!
//! `no_std` users may disable this feature with `default-features = false`:
@ -50,8 +49,9 @@
//! tracing-futures = { version = "0.2.5", default-features = false }
//! ```
//!
//! The `tokio`, `std-future` and `std` features are enabled by default.
//! The `std-future` and `std` features are enabled by default.
//!
//! [`tracing`]: https://crates.io/crates/tracing
//! [span]: tracing::span!
//! [`Subscriber`]: tracing::subscriber
//! [`futures`]: https://crates.io/crates/futures
@ -72,6 +72,7 @@
//!
#![doc(
html_logo_url = "https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png",
html_favicon_url = "https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/favicon.ico",
issue_tracker_base_url = "https://github.com/tokio-rs/tracing/issues/"
)]
#![warn(