Skip to content

Commit 38aea8e

Browse files
committed
doc: don't mention #[test] in cargo-bench doc
This is too details and not for averaged users.
1 parent f691a38 commit 38aea8e

File tree

4 files changed

+12
-12
lines changed

4 files changed

+12
-12
lines changed

src/doc/man/cargo-bench.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ similarly named benchmarks like `foobar`):
3030

3131
Benchmarks are built with the `--test` option to `rustc` which creates a
3232
special executable by linking your code with libtest. The executable
33-
automatically runs all functions annotated with `#[test]` and `#[bench]`
34-
attributes. Cargo passes the `--bench` flag to the test harness to tell
35-
it to run only benchmarks.
33+
automatically runs all functions annotated with `#[bench]` attribute.
34+
Cargo passes the `--bench` flag to the test harness to tell it to run
35+
only benchmarks.
3636

3737
The libtest harness may be disabled by setting `harness = false` in the target
3838
manifest settings, in which case your code will need to provide its own `main`

src/doc/man/generated_txt/cargo-bench.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ DESCRIPTION
2525

2626
Benchmarks are built with the --test option to rustc which creates a
2727
special executable by linking your code with libtest. The executable
28-
automatically runs all functions annotated with #[test] and #[bench]
29-
attributes. Cargo passes the --bench flag to the test harness to tell it
30-
to run only benchmarks.
28+
automatically runs all functions annotated with #[bench] attribute.
29+
Cargo passes the --bench flag to the test harness to tell it to run only
30+
benchmarks.
3131

3232
The libtest harness may be disabled by setting harness = false in the
3333
target manifest settings, in which case your code will need to provide

src/doc/src/commands/cargo-bench.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ similarly named benchmarks like `foobar`):
3030

3131
Benchmarks are built with the `--test` option to `rustc` which creates a
3232
special executable by linking your code with libtest. The executable
33-
automatically runs all functions annotated with `#[test]` and `#[bench]`
34-
attributes. Cargo passes the `--bench` flag to the test harness to tell
35-
it to run only benchmarks.
33+
automatically runs all functions annotated with `#[bench]` attribute.
34+
Cargo passes the `--bench` flag to the test harness to tell it to run
35+
only benchmarks.
3636

3737
The libtest harness may be disabled by setting `harness = false` in the target
3838
manifest settings, in which case your code will need to provide its own `main`

src/etc/man/cargo-bench.1

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ cargo bench \-\- foo \-\-exact
3030
.sp
3131
Benchmarks are built with the \fB\-\-test\fR option to \fBrustc\fR which creates a
3232
special executable by linking your code with libtest. The executable
33-
automatically runs all functions annotated with \fB#[test]\fR and \fB#[bench]\fR
34-
attributes. Cargo passes the \fB\-\-bench\fR flag to the test harness to tell
35-
it to run only benchmarks.
33+
automatically runs all functions annotated with \fB#[bench]\fR attribute.
34+
Cargo passes the \fB\-\-bench\fR flag to the test harness to tell it to run
35+
only benchmarks.
3636
.sp
3737
The libtest harness may be disabled by setting \fBharness = false\fR in the target
3838
manifest settings, in which case your code will need to provide its own \fBmain\fR

0 commit comments

Comments
 (0)