Merge branch 'master' into only-pad-if-writing

CONTRIBUTING.md

@@ -214,7 +214,7 @@ be viewed by clicking the `details` link on the
 ### Building Documentation
 
 Tracing's documentation uses nightly-only RustDoc features and lints, like
-`doc(cfg)` and `broken_intra_doc_lints`. These features are enabled by 
+`doc(cfg)` and `broken_intra_doc_lints`. These features are enabled by
 passing `--cfg docsrs` to RustDoc. Therefore, in order to build Tracing's
 documentation the same way it would be built by docs.rs, it's necessary to
 use the following command:
@@ -430,8 +430,7 @@ When releasing a new version of a crate, follow these steps:
 2. **Update Cargo metadata.** After releasing any path dependencies, update the
    `version` field in `Cargo.toml` to the new version, and the `documentation`
    field to the docs.rs URL of the new version.
-3. **Update other documentation links.** Update the `#![doc(html_root_url)]`
-   attribute in the crate's `lib.rs` and the "Documentation" link in the crate's
+3. **Update the "Documentation" link in the crate's
    `README.md` to point to the docs.rs URL of the new version.
 4. **Update the changelog for the crate.** Each crate in the Tokio repository
    has its own `CHANGELOG.md` in that crate's subdirectory. Any changes to that

README.md

@@ -477,6 +477,7 @@ Tracing.
 * [RustConf 2019 talk][rust-conf-2019-08-video] and [slides][rust-conf-2019-08-slides], August 2019
 * [Are we observable yet? @ RustyDays talk][rusty-days-2020-08-video] and [slides][rusty-days-2020-08-slides], August 2020
 * [Crabs with instruments!][tremorcon-2021-09], September 2021
+* [Decrusting the tracing crate by Jon Gjengset][decrusting-tracing-2024-02], February 2024
 
 [bay-rust-2019-03]: https://www.youtube.com/watch?v=j_kXRg3zlec
 [rust-conf-2019-08-video]: https://www.youtube.com/watch?v=JjItsfqFIdo
@@ -487,6 +488,7 @@ Tracing.
 [custom-logging-part-1]: https://burgers.io/custom-logging-in-rust-using-tracing
 [custom-logging-part-2]: https://burgers.io/custom-logging-in-rust-using-tracing-part-2
 [tremorcon-2021-09]: https://www.youtube.com/watch?v=ZC7fyqshun8
+[decrusting-tracing-2024-02]: https://www.youtube.com/watch?v=21rtHinFA40
 
 Help us expand this list! If you've written or spoken about Tracing, or
 know of resources that aren't listed, please open a pull request adding them.

examples/README.md

@@ -46,11 +46,11 @@ This directory contains a collection of examples that demonstrate the use of the
   + `futures-proxy-server`: Demonstrates the use of `tracing-futures` by
     implementing a simple proxy server, based on [this example][tokio-proxy]
     from `tokio`.
-  + `async_fn`: Demonstrates how asynchronous functions can be
+  + `async-fn`: Demonstrates how asynchronous functions can be
      instrumented.
   + `echo`: Demonstrates a `tracing`-instrumented variant of Tokio's `echo` example.
 - **tracing-flame**:
-  + `infero-flame`: Demonstrates the use of `tracing-flame` to generate a flamegraph
+  + `inferno-flame`: Demonstrates the use of `tracing-flame` to generate a flamegraph
      from spans.
 - **tracing-tower**:
   + `tower-client`: Demonstrates the use of `tracing-tower` to instrument a

tracing-attributes/Cargo.toml

@@ -2,10 +2,7 @@
 name = "tracing-attributes"
 # When releasing to crates.io:
 # - Remove path dependencies
-# - Update html_root_url.
-# - Update doc url
-#   - Cargo.toml
-#   - README.md
+# - Update doc url in README.md.
 # - Update CHANGELOG.md.
 # - Create "v0.2.x" git tag.
 version = "0.2.0"

tracing-core/Cargo.toml

@@ -3,9 +3,7 @@ name = "tracing-core"
 # When releasing to crates.io:
 # - Remove path dependencies
 # - Update html_root_url.
-# - Update doc url
-#   - Cargo.toml
-#   - README.md
+# - Update doc url in README.md.
 # - Update CHANGELOG.md.
 # - Create "v0.2.x" git tag.
 version = "0.2.0"

tracing-error/Cargo.toml

@@ -2,10 +2,7 @@
 name = "tracing-error"
 # When releasing to crates.io:
 # - Remove path dependencies
-# - Update html_root_url.
-# - Update doc url
-#   - Cargo.toml
-#   - README.md
+# - Update doc url in README.md.
 # - Update CHANGELOG.md.
 # - Create "v0.2.x" git tag
 version = "0.2.0"

tracing-futures/src/lib.rs

@@ -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 [`WithCollector`] 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 [`WithCollector`]
 //!    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,7 +49,7 @@
 //!   tracing-futures = { version = "0.2.3", 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]: mod@tracing::span

tracing/Cargo.toml

@@ -2,10 +2,7 @@
 name = "tracing"
 # When releasing to crates.io:
 # - Remove path dependencies
-# - Update html_root_url.
-# - Update doc url
-#   - Cargo.toml
-#   - README.md
+# - Update doc url in README.md.
 # - Update CHANGELOG.md.
 # - Create "v0.2.x" git tag
 version = "0.2.0"