Merge pull request #2358 from input-output-hk/dlachaume/add-features-documentation-in-client-lib

Docs: add features documentation for `mithril-client` library

Author: dlachaume

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-client"
-version = "0.11.12"
+version = "0.11.13"
 description = "Mithril client library"
 authors = { workspace = true }
 edition = { workspace = true }
@@ -93,7 +93,7 @@ default = ["native-tls", "rug-backend", "enable-http-compression"]
 # Full feature set
 full = ["fs"]
 
-# Enable file system releated functionnality, right now that mean ony snapshot download
+# Enable file system related functionality, right now that mean only snapshot download
 fs = ["flate2", "flume", "tar", "tokio/rt", "zstd"]
 portable = []                                       # deprecated, will be removed soon
 unstable = []
@@ -109,12 +109,12 @@ rustls-tls-manual-roots = ["reqwest/rustls-tls-manual-roots"]
 rustls-tls-webpki-roots = ["reqwest/rustls-tls-webpki-roots"]
 rustls-tls-native-roots = ["reqwest/rustls-tls-native-roots"]
 
-# Support compressed traffic with `request`
+# Support compressed traffic with `reqwest`
 enable-http-compression = ["reqwest/gzip", "reqwest/zstd", "reqwest/deflate", "reqwest/brotli"]
 
-# Enables `rug-backend` features for `mithril-common` dependency
+# Enables usage of `rug` numerical backend in `mithril-stm` (dependency of `mithril-common`).
 rug-backend = ["mithril-common/rug-backend"]
-# Enables `num-integer-backend` features for `mithril-common` dependency
+# Enables usage of `num-integer` numerical backend in `mithril-stm` (dependency of `mithril-common`)
 # by default it's `rug-backend`
 num-integer-backend = ["mithril-common/num-integer-backend"]
 

mithril-client/Cargo.toml

@@ -62,6 +62,30 @@
 //! #    Ok(())
 //! # }
 //! ```
+//!
+//! ## Optional Features
+//!
+//! The following are a list of [Cargo features](https://doc.rust-lang.org/stable/cargo/reference/manifest.html#the-features-section) that can be
+//! enabled or disabled:
+//!
+//! - **fs**: Enables file system related functionalities.
+//! - **unstable**: Enables experimental or in-development `mithril-client` features that may change.
+//! - **rug-backend** *(enabled by default)*: Enables usage of `rug` numerical backend in `mithril-stm` (dependency of `mithril-common`).
+//! - **num-integer-backend**: Enables usage of `num-integer` numerical backend in `mithril-stm` (dependency of `mithril-common`).
+//!
+//! To allow fine tuning of the http queries, the following [Reqwest](https://docs.rs/reqwest/latest/reqwest/#optional-features) features are re-exported:
+//! - **native-tls** *(enabled by default)*: Enables TLS functionality provided by `native-tls`.
+//! - **native-tls-vendored**: Enables the `vendored` feature of `native-tls`.
+//! - **native-tls-alpn**: Enables the `alpn` feature of `native-tls`.
+//! - **rustls-tls**: Enables TLS functionality provided by `rustls`.
+//!   Equivalent to `rustls-tls-webpki-roots`.
+//! - **rustls-tls-manual-roots**: Enables TLS functionality provided by `rustls`,
+//!   without setting any root certificates. Roots have to be specified manually.
+//! - **rustls-tls-webpki-roots**: Enables TLS functionality provided by `rustls`,
+//!   while using root certificates from the `webpki-roots` crate.
+//! - **rustls-tls-native-roots**: Enables TLS functionality provided by `rustls`,
+//!   while using root certificates from the `rustls-native-certs` crate.
+//! - **enable-http-compression** *(enabled by default)*: Enables compressed traffic with `reqwest`.
 
 macro_rules! cfg_fs {
     ($($item:item)*) => {