Skip to content

Commit 318e1c0

Browse files
committed
Add docs for feature flags
1 parent f8361cb commit 318e1c0

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/lib.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,12 @@
116116
//! $ inferno-diff-folded folded2 folded1 | inferno-flamegraph --negate > diff1.svg
117117
//! ```
118118
//!
119+
//! # Feature flags
120+
//! All features below are enabled by default
121+
//! - `cli`: Enabled when inferno compiled to a standalone binary and is used from the command line
122+
//! - `multithreaded`: Enables multithreading aggregating values for [`collapse`]
123+
//! - `nameattr`: Allows for adding customizing and adding attributes to the svg of [`flamegraph`]. See the `--nameattr` option for the flamegraph cli
124+
//!
119125
//! # Development
120126
//!
121127
//! This crate was initially developed through [a series of live coding sessions]. If you want to

0 commit comments

Comments
 (0)