From 3e1fc3b3512128dd24bfcfbb4fe27c28da0cd818 Mon Sep 17 00:00:00 2001 From: Alice Ryhl Date: Fri, 25 Dec 2020 21:43:09 +0100 Subject: [PATCH 1/2] chore: prepare tokio 1.0.1 release --- tokio/CHANGELOG.md | 20 ++++++++++++++++++++ tokio/Cargo.toml | 4 ++-- tokio/README.md | 1 - tokio/src/lib.rs | 2 +- 4 files changed, 23 insertions(+), 4 deletions(-) diff --git a/tokio/CHANGELOG.md b/tokio/CHANGELOG.md index 36003701cf4..8e66c2f1403 100644 --- a/tokio/CHANGELOG.md +++ b/tokio/CHANGELOG.md @@ -1,3 +1,23 @@ +# 1.0.1 (December 25, 2020) + +This release fixes a soundness hole caused by the combination of `RwLockWriteGuard::map` +and `RwLockWriteGuard::downgrade` by removing the `map` function. This is a breaking +change, but breaking changes are allowed under our semver policy when they are required +to fix a soundness hole. + +Note that we have chosen not to do a deprecation cycle or similar because Tokio 1.0.0 was +released two days ago, and therefore the impact should be minimal. + +Due to the soundness hole, we have also yanked Tokio version 1.0.0. + +### Removed + + - sync: remove `RwLockWriteGuard::map` and `RwLockWriteGuard::try_map` (#3345) + +### Fixed + + - docs: remove stream feature from docs (#3335) + # 1.0.0 (December 23, 2020) Commit to the API and long-term support. diff --git a/tokio/Cargo.toml b/tokio/Cargo.toml index dc7534304bb..0849a369ab2 100644 --- a/tokio/Cargo.toml +++ b/tokio/Cargo.toml @@ -8,12 +8,12 @@ name = "tokio" # - README.md # - Update CHANGELOG.md. # - Create "v1.0.x" git tag. -version = "1.0.0" +version = "1.0.1" edition = "2018" authors = ["Tokio Contributors "] license = "MIT" readme = "README.md" -documentation = "https://docs.rs/tokio/1.0.0/tokio/" +documentation = "https://docs.rs/tokio/1.0.1/tokio/" repository = "https://github.com/tokio-rs/tokio" homepage = "https://tokio.rs" description = """ diff --git a/tokio/README.md b/tokio/README.md index 5896cb747ca..8ee7bbda1b0 100644 --- a/tokio/README.md +++ b/tokio/README.md @@ -29,7 +29,6 @@ the Rust programming language. It is: [Website](https://tokio.rs) | [Guides](https://tokio.rs/tokio/tutorial) | [API Docs](https://docs.rs/tokio/latest/tokio) | -[Roadmap](https://github.com/tokio-rs/tokio/blob/master/ROADMAP.md) | [Chat](https://discord.gg/tokio) ## Overview diff --git a/tokio/src/lib.rs b/tokio/src/lib.rs index c4d59963e2b..2efcaf75961 100644 --- a/tokio/src/lib.rs +++ b/tokio/src/lib.rs @@ -1,4 +1,4 @@ -#![doc(html_root_url = "https://docs.rs/tokio/1.0.0")] +#![doc(html_root_url = "https://docs.rs/tokio/1.0.1")] #![allow( clippy::cognitive_complexity, clippy::large_enum_variant, From ced8f3ff8668f153a26159f6c380a3ed31196cd0 Mon Sep 17 00:00:00 2001 From: Alice Ryhl Date: Fri, 25 Dec 2020 21:45:57 +0100 Subject: [PATCH 2/2] mention RFC --- tokio/CHANGELOG.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/tokio/CHANGELOG.md b/tokio/CHANGELOG.md index 8e66c2f1403..3b46d92e1fe 100644 --- a/tokio/CHANGELOG.md +++ b/tokio/CHANGELOG.md @@ -3,7 +3,7 @@ This release fixes a soundness hole caused by the combination of `RwLockWriteGuard::map` and `RwLockWriteGuard::downgrade` by removing the `map` function. This is a breaking change, but breaking changes are allowed under our semver policy when they are required -to fix a soundness hole. +to fix a soundness hole. (See [this RFC][semver] for more.) Note that we have chosen not to do a deprecation cycle or similar because Tokio 1.0.0 was released two days ago, and therefore the impact should be minimal. @@ -18,6 +18,8 @@ Due to the soundness hole, we have also yanked Tokio version 1.0.0. - docs: remove stream feature from docs (#3335) +[semver]: https://github.com/rust-lang/rfcs/blob/master/text/1122-language-semver.md#soundness-changes + # 1.0.0 (December 23, 2020) Commit to the API and long-term support.