Skip to content

Add commandline example and filtering section to profiling docs#87

Open
laundmo wants to merge 1 commit into
criterion-rs:masterfrom
laundmo:patch-1
Open

Add commandline example and filtering section to profiling docs#87
laundmo wants to merge 1 commit into
criterion-rs:masterfrom
laundmo:patch-1

Conversation

@laundmo

@laundmo laundmo commented May 24, 2026

Copy link
Copy Markdown

moved over from: bheisler/criterion.rs#907

The current profiling docs lack some non-obvious information to help users get started with profiling far more easily:

  • Where the benchmark executable can be found
  • How to filter to specific benchmarks, to profile them individually

This PR adds some basic docs for these, and a tl;dr: example command.

Note: i was not aware criterion had moved, and for me the original bheisler mdbook site is the one which keeps showing up. I dont know the history of this fork/continuation, but if its possible to ask bheisler to redirect from the bheisler mdbook site to this new one that'd likely alleviate a lot of confusion.

@lemmih

lemmih commented May 25, 2026

Copy link
Copy Markdown
Contributor

Looks fine. Can merge once the typo has been fixed.

Yes, we should redirect from https://bheisler.github.io/criterion.rs/book/ to https://criterion-rs.github.io/book/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants