diff --git a/src/doc/man/cargo-bench.adoc b/src/doc/man/cargo-bench.adoc index c65c66c9ea9..79acc6f2674 100644 --- a/src/doc/man/cargo-bench.adoc +++ b/src/doc/man/cargo-bench.adoc @@ -36,6 +36,16 @@ The libtest harness may be disabled by setting `harness = false` in the target manifest settings, in which case your code will need to provide its own `main` function to handle running benchmarks. + +> **Note**: The +> link:https://doc.rust-lang.org/nightly/unstable-book/library-features/test.html[`#[bench\]` attribute] +> is currently unstable and only available on the +> link:https://doc.rust-lang.org/book/appendix-07-nightly-rust.html[nightly channel]. +> There are some packages available on +> link:https://crates.io/keywords/benchmark[crates.io] that may help with +> running benchmarks on the stable channel, such as +> link:https://crates.io/crates/criterion[Criterion]. + == OPTIONS === Benchmark Options diff --git a/src/doc/man/generated/cargo-bench.html b/src/doc/man/generated/cargo-bench.html index bdba100732a..d97adce558f 100644 --- a/src/doc/man/generated/cargo-bench.html +++ b/src/doc/man/generated/cargo-bench.html @@ -42,6 +42,20 @@
main
function to handle running benchmarks.
+++++Note: The +
+#[bench]
attribute +is currently unstable and only available on the +nightly channel. +There are some packages available on +crates.io that may help with +running benchmarks on the stable channel, such as +Criterion.