Add "Benchmarks" section to Guide #3472
Conversation
The `#[bench]` attribute is [currently unstable][1], and is only usable on nightly Rust. However, being able to benchmark code with `cargo bench` is very useful functionality when writing performance-focused code, and something that the Cargo documentation currently glosses over. Some useful information on how to get benchmark tests up and running, with necessary caveats about stability, would likely be very helpful to new users. [1]: rust-lang/rust#29553
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @steveklabnik (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. Please see the contribution instructions for more information. |
|
Thanks for this! I'm kind of conflicted, as it's not totally clear how stable/unstable stuff should work in Cargo's docs. And about half of this is more about Rust than it is about the cargo bits. Which also isn't bad..... i dunno. We certainly need to explain this somehow, though. |
|
☔ The latest upstream changes (presumably #3004) made this pull request unmergeable. Please resolve the merge conflicts. |
|
I'm gonna close this due to inactivity, but feel free to resubmit with a rebase! |
The
#[bench]attribute is currently unstable, and is only usable on nightly Rust.However, being able to benchmark code with
cargo benchis very useful functionality when writing performance-focused code, and something that the Cargo documentation currently glosses over.Some useful information on how to get benchmark tests up and running, with necessary caveats about stability, would likely be very helpful to new users.