Skip to content

Commit

Permalink
Merge branch 'master' into fix-readme-typo
Browse files Browse the repository at this point in the history
  • Loading branch information
hds authored Dec 1, 2024
2 parents 6a38b98 + 66cafe5 commit 356ba36
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 23 deletions.
5 changes: 2 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down
5 changes: 1 addition & 4 deletions tracing-attributes/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
4 changes: 1 addition & 3 deletions tracing-core/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
5 changes: 1 addition & 4 deletions tracing-error/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
9 changes: 4 additions & 5 deletions tracing-futures/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand All @@ -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`:
Expand All @@ -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
Expand Down
5 changes: 1 addition & 4 deletions tracing/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down

0 comments on commit 356ba36

Please sign in to comment.