Skip to content

Commit 50e43ce

Browse files
committed
docs: consistently describe default features
Consistently describe te default features, include that *ring* is default enabled.
1 parent 4f5e24d commit 50e43ce

File tree

1 file changed

+16
-18
lines changed

1 file changed

+16
-18
lines changed

rustls/src/lib.rs

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -242,28 +242,26 @@
242242
//! Here's a list of what features are exposed by the rustls crate and what
243243
//! they mean.
244244
//!
245-
//! - `logging`: this makes the rustls crate depend on the `log` crate.
246-
//! rustls outputs interesting protocol-level messages at `trace!` and `debug!`
247-
//! level, and protocol-level errors at `warn!` and `error!` level. The log
248-
//! messages do not contain secret key data, and so are safe to archive without
249-
//! affecting session security. This feature is in the default set.
250-
//!
251-
//! - `tls12`: enables support for TLS version 1.2. This feature is in the default
252-
//! set. Note that, due to the additive nature of Cargo features and because it
253-
//! is enabled by default, other crates in your dependency graph could re-enable
254-
//! it for your application. If you want to disable TLS 1.2 for security reasons,
255-
//! consider explicitly enabling TLS 1.3 only in the config builder API.
256-
//!
257-
//! - `read_buf`: When building with Rust Nightly, adds support for the unstable
245+
//! - `logging` (enabled by default): make the rustls crate depend on the `log` crate.
246+
//! rustls outputs interesting protocol-level messages at `trace!` and `debug!` level,
247+
//! and protocol-level errors at `warn!` and `error!` level. The log messages do not
248+
//! contain secret key data, and so are safe to archive without affecting session security.
249+
//!
250+
//! - `tls12` (enabled by default): enable support for TLS version 1.2. Note that, due to the
251+
//! additive nature of Cargo features and because it is enabled by default, other crates
252+
//! in your dependency graph could re-enable it for your application. If you want to disable
253+
//! TLS 1.2 for security reasons, consider explicitly enabling TLS 1.3 only in the config
254+
//! builder API.
255+
//!
256+
//! - `read_buf`: when building with Rust Nightly, adds support for the unstable
258257
//! `std::io::ReadBuf` and related APIs. This reduces costs from initializing
259258
//! buffers. Will do nothing on non-Nightly releases.
260259
//!
261-
//! - `ring`: this makes the rustls crate depend on the *ring* crate,
262-
//! which is used for cryptography by default
263-
//! Without this feature, these items must be provided externally to the core
264-
//! rustls crate: see [`crate::crypto::CryptoProvider`].
260+
//! - `ring` (enabled by default): makes the rustls crate depend on the *ring* crate, which is
261+
//! used for cryptography by default. Without this feature, these items must be provided
262+
//! externally to the core rustls crate: see [`crate::crypto::CryptoProvider`].
265263
//!
266-
//! - `aws_lc_rs`: this makes the rustls crate depend on the aws-lc-rs crate,
264+
//! - `aws_lc_rs`: makes the rustls crate depend on the aws-lc-rs crate,
267265
//! which can be used for cryptography as an alternative to *ring*.
268266
//! Use `rustls::crypto::aws_lc_rs::default_provider()` as a `CryptoProvider`
269267
//! when making a `ClientConfig` or `ServerConfig` to use aws-lc-rs

0 commit comments

Comments
 (0)