Skip to content

Commit c5f1eeb

Browse files
committed
Document feature flags in module level docs.
1 parent 70390e7 commit c5f1eeb

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

src/lib.rs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,17 @@
2222
//! The [downloader] module provides a component to download blobs from
2323
//! multiple sources and store them in a store.
2424
//!
25+
//! # Feature flags
26+
//!
27+
//! - rpc: Enable the rpc server and client. Enabled by default.
28+
//! - net_protocol: Enable the network protocol. Enabled by default.
29+
//! - downloader: Enable the downloader. Enabled by default.
30+
//! - fs-store: Enable the filesystem store. Enabled by default.
31+
//!
32+
//! - cli: Enable the cli. Disabled by default.
33+
//! - example-iroh: dependencies for examples in this crate. Disabled by default.
34+
//! - test: test utilities. Disabled by default.
35+
//!
2536
//! [BLAKE3]: https://github.com/BLAKE3-team/BLAKE3-specs/blob/master/blake3.pdf
2637
//! [iroh]: https://docs.rs/iroh
2738
#![deny(missing_docs, rustdoc::broken_intra_doc_links)]

0 commit comments

Comments
 (0)