From c22e4f6597d8bc0d8f3f03ec41d47a6b6f837d53 Mon Sep 17 00:00:00 2001 From: John-John Tedro Date: Sat, 11 Jan 2020 20:19:10 +0100 Subject: [PATCH] Add deprecation notices for outdated crates (#2036) (#2097) * Add deprecation notices for outdated crates (#2036) * Add notice about renaming reactor --- tokio-codec/README.md | 6 ++++++ tokio-executor/README.md | 6 ++++++ tokio-fs/README.md | 6 ++++++ tokio-reactor/README.md | 9 +++++++++ tokio-signal/README.md | 6 ++++++ tokio-sync/README.md | 6 ++++++ tokio-tcp/README.md | 6 ++++++ tokio-threadpool/README.md | 10 ++++++++++ tokio-timer/README.md | 6 ++++++ tokio-udp/README.md | 6 ++++++ tokio-uds/README.md | 6 ++++++ 11 files changed, 73 insertions(+) diff --git a/tokio-codec/README.md b/tokio-codec/README.md index e0c1a3858..1325e55af 100644 --- a/tokio-codec/README.md +++ b/tokio-codec/README.md @@ -2,6 +2,12 @@ Utilities for encoding and decoding frames. +This crate is **deprecated in tokio 0.2.x** and has been moved into +[`tokio_util::codec`] of the [`tokio-utils` crate] behind the `codec` feature flag. + +[`tokio::codec`]: https://docs.rs/tokio-util/latest/tokio_util/codec/index.html +[`tokio-utils` crate]: https://docs.rs/tokio-util/latest/tokio_util + [Documentation](https://docs.rs/tokio-codec) ## Usage diff --git a/tokio-executor/README.md b/tokio-executor/README.md index 1a996107a..491b91649 100644 --- a/tokio-executor/README.md +++ b/tokio-executor/README.md @@ -2,6 +2,12 @@ Task execution related traits and utilities. +This crate is **deprecated in tokio 0.2.x** and has been moved and refactored +into various places in the [`tokio::runtime`] module of the [`tokio`] crate. + +[`tokio::runtime`]: https://docs.rs/tokio/latest/tokio/runtime/index.html +[`tokio`]: https://docs.rs/tokio/latest/tokio/index.html + [Documentation](https://docs.rs/tokio-executor/0.1.9/tokio_executor) ## Overview diff --git a/tokio-fs/README.md b/tokio-fs/README.md index 5c871b62f..03c1b7a19 100644 --- a/tokio-fs/README.md +++ b/tokio-fs/README.md @@ -2,6 +2,12 @@ Asynchronous filesystem manipulation operations (and stdin, stdout, stderr). +This crate has been **deprecated in tokio 0.2.x** and has been moved into +[`tokio::fs`] behind the `fs` [feature flag]. + +[`tokio::fs`]: https://docs.rs/tokio/latest/tokio/fs/index.html +[feature flag]: https://docs.rs/tokio/latest/tokio/index.html#feature-flags + [Documentation](https://docs.rs/tokio-fs/0.1.6/tokio_fs) ## Overview diff --git a/tokio-reactor/README.md b/tokio-reactor/README.md index f4041d6a6..e1aa1f42d 100644 --- a/tokio-reactor/README.md +++ b/tokio-reactor/README.md @@ -2,6 +2,15 @@ Event loop that drives Tokio I/O resources. +This crate is **deprecated in tokio 0.2.x** and has been moved and refactored +into various places in the [`tokio::runtime`] and [`tokio::io`] modules of the +[`tokio`] crate. The Reactor has also been renamed the "I/O Driver". + +[`tokio::runtime`]: https://docs.rs/tokio/latest/tokio/runtime/index.html +[`tokio::io`]: https://docs.rs/tokio/latest/tokio/io/index.html +[`tokio`]: https://docs.rs/tokio/latest/tokio/index.html +[`io-driver` feature]: https://docs.rs/tokio/0.2.9/tokio/index.html#feature-flags + [Documentation](https://docs.rs/tokio-reactor/0.1.11/tokio_reactor) ## Overview diff --git a/tokio-signal/README.md b/tokio-signal/README.md index e368fb44b..125939851 100644 --- a/tokio-signal/README.md +++ b/tokio-signal/README.md @@ -2,6 +2,12 @@ Unix signal handling for Tokio. +This crate is **deprecated in tokio 0.2.x** and has been moved into +[`tokio::signal`] behind the `signal` [feature flag]. + +[`tokio::signal`]: https://docs.rs/tokio/latest/tokio/signal/index.html +[feature flag]: https://docs.rs/tokio/latest/tokio/index.html#feature-flags + [Documentation](https://docs.rs/tokio-signal/0.2.8/tokio_signal) ## Usage diff --git a/tokio-sync/README.md b/tokio-sync/README.md index a35d5bc8e..b05a42e5b 100644 --- a/tokio-sync/README.md +++ b/tokio-sync/README.md @@ -2,6 +2,12 @@ Synchronization utilities +This crate is **deprecated in tokio 0.2.x** and has been moved into +[`tokio::sync`] behind the `sync` [feature flag]. + +[`tokio::sync`]: https://docs.rs/tokio/latest/tokio/sync/index.html +[feature flag]: https://docs.rs/tokio/latest/tokio/index.html#feature-flags + [Documentation](https://docs.rs/tokio-sync/0.1.6/tokio_sync/) ## Overview diff --git a/tokio-tcp/README.md b/tokio-tcp/README.md index b211630f9..739e6872c 100644 --- a/tokio-tcp/README.md +++ b/tokio-tcp/README.md @@ -2,6 +2,12 @@ TCP bindings for `tokio`. +This crate is **deprecated in tokio 0.2.x** and has been moved into +[`tokio::tcp`] behind the `tcp` [feature flag]. + +[`tokio::tcp`]: https://docs.rs/tokio/latest/tokio/tcp/index.html +[feature flag]: https://docs.rs/tokio/latest/tokio/index.html#feature-flags + [Documentation](https://docs.rs/tokio-tcp/0.1.3/tokio_tcp) ## License diff --git a/tokio-threadpool/README.md b/tokio-threadpool/README.md index 2a98585a8..effa34351 100644 --- a/tokio-threadpool/README.md +++ b/tokio-threadpool/README.md @@ -3,6 +3,16 @@ A library for scheduling execution of futures concurrently across a pool of threads. +This crate is **deprecated in tokio 0.2.x** and has been moved and refactored +into various places in the [`tokio::runtime`] module of the [`tokio`] crate. +Note that there is no longer a `ThreadPool` type, you are instead encouraged to +make use of the thread pool used by a `Runtime` configured to use the +[threaded scheduler]. + +[`tokio::runtime`]: https://docs.rs/tokio/latest/tokio/runtime/index.html +[`tokio`]: https://docs.rs/tokio/latest/tokio/index.html +[threaded scheduler]: https://docs.rs/tokio/latest/tokio/runtime/index.html#threaded-scheduler + [Documentation](https://docs.rs/tokio-threadpool/0.1.17/tokio_threadpool) ### Why not Rayon? diff --git a/tokio-timer/README.md b/tokio-timer/README.md index 7f894a195..bca6452c0 100644 --- a/tokio-timer/README.md +++ b/tokio-timer/README.md @@ -2,6 +2,12 @@ Timer facilities for Tokio +This crate is **deprecated in tokio 0.2.x** and has been moved into +[`tokio::time`] behind the `time` [feature flag]. + +[`tokio::time`]: https://docs.rs/tokio/latest/tokio/time/index.html +[feature flag]: https://docs.rs/tokio/latest/tokio/index.html#feature-flags + [Documentation](https://docs.rs/tokio-timer/0.2.12/tokio_timer/) ## Overview diff --git a/tokio-udp/README.md b/tokio-udp/README.md index c3ca55eca..d2cf2ea09 100644 --- a/tokio-udp/README.md +++ b/tokio-udp/README.md @@ -2,6 +2,12 @@ UDP bindings for `tokio`. +This crate is **deprecated in tokio 0.2.x** and has been moved into +[`tokio::udp`] behind the `udp` [feature flag]. + +[`tokio::udp`]: https://docs.rs/tokio/latest/tokio/udp/index.html +[feature flag]: https://docs.rs/tokio/latest/tokio/index.html#feature-flags + [Documentation](https://docs.rs/tokio-udp/0.1.5/tokio_udp/) ## License diff --git a/tokio-uds/README.md b/tokio-uds/README.md index 1c6a80c04..7b992d4f5 100644 --- a/tokio-uds/README.md +++ b/tokio-uds/README.md @@ -2,6 +2,12 @@ An implementation of Unix Domain Sockets for Tokio +This crate is **deprecated in tokio 0.2.x** and has been moved into +[`tokio::uds`] behind the `uds` [feature flag]. + +[`tokio::uds`]: https://docs.rs/tokio-util/latest/tokio/uds/index.html +[feature flag]: https://docs.rs/tokio/latest/tokio/index.html#feature-flags + [Documentation](https://docs.rs/tokio-uds/0.2.5/tokio_uds/) ## License