summaryrefslogtreecommitdiffstats
path: root/tokio/src/lib.rs
diff options
context:
space:
mode:
authorCarl Lerche <me@carllerche.com>2019-11-22 15:55:10 -0800
committerGitHub <noreply@github.com>2019-11-22 15:55:10 -0800
commit7b4c999341809588a427a9a80d310ee4aa1c1a21 (patch)
tree13e7638b2ec0ad90fbdbaf4f7100d8a2f8841703 /tokio/src/lib.rs
parente1b1e216c506a01a1f4ca579adae02f85b8db82b (diff)
default all feature flags to off (#1811)
Changes the set of `default` feature flags to `[]`. By default, only core traits are included without specifying feature flags. This makes it easier for users to pick the components they need. For convenience, a `full` feature flag is included that includes all components. Tests are configured to require the `full` feature. Testing individual feature flags will need to be moved to a separate crate. Closes #1791
Diffstat (limited to 'tokio/src/lib.rs')
-rw-r--r--tokio/src/lib.rs7
1 files changed, 7 insertions, 0 deletions
diff --git a/tokio/src/lib.rs b/tokio/src/lib.rs
index c213ee89..cd7a62ea 100644
--- a/tokio/src/lib.rs
+++ b/tokio/src/lib.rs
@@ -52,6 +52,13 @@
//! control what features are present, so that unused code can be eliminated.
//! This documentation also lists what feature flags are necessary to enable each API.
//!
+//! The easiest way to get started is to enable all features. Do this by
+//! enabling the `full` feature flag:
+//!
+//! ```toml
+//! tokio = { version = "0.2", features = ["full"] }
+//! ```
+//!
//! [features]: https://doc.rust-lang.org/cargo/reference/manifest.html#the-features-section
//!
//! ## Working With Tasks