File tree 3 files changed +42
-2
lines changed
3 files changed +42
-2
lines changed Original file line number Diff line number Diff line change @@ -36,6 +36,16 @@ The libtest harness may be disabled by setting `harness = false` in the target
36
36
manifest settings, in which case your code will need to provide its own `main`
37
37
function to handle running benchmarks.
38
38
39
+
40
+ > **Note**: The
41
+ > link:https://doc.rust-lang.org/nightly/unstable-book/library-features/test.html[`#[bench\]` attribute]
42
+ > is currently unstable and only available on the
43
+ > link:https://doc.rust-lang.org/book/appendix-07-nightly-rust.html[nightly channel].
44
+ > There are some packages available on
45
+ > link:https://crates.io/keywords/benchmark[crates.io] that may help with
46
+ > running benchmarks on the stable channel, such as
47
+ > link:https://crates.io/crates/criterion[Criterion].
48
+
39
49
== OPTIONS
40
50
41
51
=== Benchmark Options
Original file line number Diff line number Diff line change @@ -42,6 +42,20 @@ <h2 id="cargo_bench_description">DESCRIPTION</h2>
42
42
manifest settings, in which case your code will need to provide its own < code > main</ code >
43
43
function to handle running benchmarks.</ p >
44
44
</ div >
45
+ < div class ="quoteblock ">
46
+ < blockquote >
47
+ < div class ="paragraph ">
48
+ < p > < strong > Note</ strong > : The
49
+ < a href ="https://doc.rust-lang.org/nightly/unstable-book/library-features/test.html "> < code > #[bench]</ code > attribute</ a >
50
+ is currently unstable and only available on the
51
+ < a href ="https://doc.rust-lang.org/book/appendix-07-nightly-rust.html "> nightly channel</ a > .
52
+ There are some packages available on
53
+ < a href ="https://crates.io/keywords/benchmark "> crates.io</ a > that may help with
54
+ running benchmarks on the stable channel, such as
55
+ < a href ="https://crates.io/crates/criterion "> Criterion</ a > .</ p >
56
+ </ div >
57
+ </ blockquote >
58
+ </ div >
45
59
</ div >
46
60
</ div >
47
61
< div class ="sect1 ">
Original file line number Diff line number Diff line change 2
2
.\" Title: cargo-bench
3
3
.\" Author: [see the "AUTHOR(S)" section]
4
4
.\" Generator: Asciidoctor 2.0.10
5
- .\" Date: 2020-02-06
5
+ .\" Date: 2020-05-08
6
6
.\" Manual: \ \&
7
7
.\" Source: \ \&
8
8
.\" Language: English
9
9
.\"
10
- .TH "CARGO\- BENCH" "1" "2020-02-06 " "\ \& " "\ \& "
10
+ .TH "CARGO\- BENCH" "1" "2020-05-08 " "\ \& " "\ \& "
11
11
.ie \n( .g .ds Aq \(aq
12
12
.el .ds Aq '
13
13
.ss \n[ .ss ] 0
@@ -59,6 +59,22 @@ the test harness to tell it to run only benchmarks.
59
59
The libtest harness may be disabled by setting \fB harness = false \fP in the target
60
60
manifest settings, in which case your code will need to provide its own \fB main \fP
61
61
function to handle running benchmarks.
62
+ .RS 3
63
+ .ll -.6i
64
+ .sp
65
+ \fB Note \fP : The
66
+ \c
67
+ .URL " https://doc.rust\- lang.org/nightly/unstable\- book/library\- features/test.html" " \fB #[bench] \fP attribute"
68
+ is currently unstable and only available on the
69
+ .URL " https://doc.rust\- lang.org/book/appendix\- 07\- nightly\- rust.html" " nightly channel" " ."
70
+ There are some packages available on
71
+ .URL " https://crates.io/keywords/benchmark" " crates.io" " "
72
+ that may help with
73
+ running benchmarks on the stable channel, such as
74
+ .URL " https://crates.io/crates/criterion" " Criterion" " ."
75
+ .br
76
+ .RE
77
+ .ll
62
78
.SH "OPTIONS"
63
79
.SS "Benchmark Options"
64
80
.sp
You can’t perform that action at this time.
0 commit comments