Skip to content

Commit 3185a0e

Browse files
Copilotludfjig
authored andcommitted
Update documentation to reflect that debug builds are now supported for profiling
Co-authored-by: ludfjig <[email protected]> Signed-off-by: Simon Davies <[email protected]>
1 parent f647ec3 commit 3185a0e

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/benchmarking-hyperlight.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,4 +74,4 @@ Found 1 outliers among 100 measurements (1.00%)
7474
7575
Use `just bench` to run benchmarks with release builds (the only supported configuration). Comparing local benchmark results to github-saved benchmarks doesn't make much sense, since you'd be using different hardware, but you can use `just bench-download os hypervisor [tag] ` to download and extract the GitHub release benchmarks to the correct place folder. You can then run `just bench-ci main` to compare to (and overwrite) the previous release benchmarks. Note that `main` is the name of the baselines stored in GitHub.
7676
77-
**Important**: Benchmarks can only be run with release builds to ensure meaningful performance measurements. Debug builds are not supported for benchmarking.
77+
**Important**: The `just bench` command uses release builds by default to ensure meaningful performance measurements. For profiling purposes, you can compile benchmarks with debug symbols by running `cargo bench` directly.

0 commit comments

Comments
 (0)