Skip to content

Commit 09c8e75

Browse files
authored
improve description of --flamechart and --flamegraph (#8917)
improve description of --flamechart and --flamegraph, explaining the difference
1 parent a33fc1d commit 09c8e75

File tree

1 file changed

+6
-0
lines changed
  • crates/forge/bin/cmd/test

1 file changed

+6
-0
lines changed

crates/forge/bin/cmd/test/mod.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,10 +86,16 @@ pub struct TestArgs {
8686
debug: Option<Regex>,
8787

8888
/// Generate a flamegraph for a single test. Implies `--decode-internal`.
89+
///
90+
/// A flame graph is used to visualize which functions or operations within the smart contract
91+
/// are consuming the most gas overall in a sorted manner.
8992
#[arg(long, conflicts_with = "flamechart")]
9093
flamegraph: bool,
9194

9295
/// Generate a flamechart for a single test. Implies `--decode-internal`.
96+
///
97+
/// A flame chart shows the gas usage over time, illustrating when each function is
98+
/// called (execution order) and how much gas it consumes at each point in the timeline.
9399
#[arg(long, conflicts_with = "flamegraph")]
94100
flamechart: bool,
95101

0 commit comments

Comments
 (0)