]> git.proxmox.com Git - cargo.git/commitdiff
doc: don't mention `#[test]` in cargo-bench doc
authorWeihang Lo <me@weihanglo.tw>
Sat, 4 Jun 2022 13:43:52 +0000 (21:43 +0800)
committerWeihang Lo <me@weihanglo.tw>
Sat, 4 Jun 2022 13:43:58 +0000 (21:43 +0800)
This is too details and not for averaged users.

src/doc/man/cargo-bench.md
src/doc/man/generated_txt/cargo-bench.txt
src/doc/src/commands/cargo-bench.md
src/etc/man/cargo-bench.1

index d3dc17ee7dea61d4d2fc900fb38fe77a24cb8785..04363314d366e72da244ec004337ae94a7d1594b 100644 (file)
@@ -30,9 +30,9 @@ similarly named benchmarks like `foobar`):
 
 Benchmarks are built with the `--test` option to `rustc` which creates a
 special executable by linking your code with libtest. The executable
-automatically runs all functions annotated with `#[test]` and `#[bench]`
-attributes. Cargo passes the `--bench` flag to the test harness to tell
-it to run only benchmarks.
+automatically runs all functions annotated with `#[bench]` attribute.
+Cargo passes the `--bench` flag to the test harness to tell it to run
+only benchmarks.
 
 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`
index ac15ec48cdc2e5cff31f6e8d65f281880d8b00f5..b2a96c7dacb682db3e82cd5b01751a712fb6866c 100644 (file)
@@ -25,9 +25,9 @@ DESCRIPTION
 
        Benchmarks are built with the --test option to rustc which creates a
        special executable by linking your code with libtest. The executable
-       automatically runs all functions annotated with #[test] and #[bench]
-       attributes. Cargo passes the --bench flag to the test harness to tell it
-       to run only benchmarks.
+       automatically runs all functions annotated with #[bench] attribute.
+       Cargo passes the --bench flag to the test harness to tell it to run only
+       benchmarks.
 
        The libtest harness may be disabled by setting harness = false in the
        target manifest settings, in which case your code will need to provide
index 6460e98deb68223e5f48e399178341d0eb5cc19c..8c0f73554a1b85c332fbe4756162f94fd0461538 100644 (file)
@@ -30,9 +30,9 @@ similarly named benchmarks like `foobar`):
 
 Benchmarks are built with the `--test` option to `rustc` which creates a
 special executable by linking your code with libtest. The executable
-automatically runs all functions annotated with `#[test]` and `#[bench]`
-attributes. Cargo passes the `--bench` flag to the test harness to tell
-it to run only benchmarks.
+automatically runs all functions annotated with `#[bench]` attribute.
+Cargo passes the `--bench` flag to the test harness to tell it to run
+only benchmarks.
 
 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`
index fad633e4bece6a8fa28646800669a1b726ccac5d..976848b5316dcf52ba6409b41f95ff7b2ba3c838 100644 (file)
@@ -30,9 +30,9 @@ cargo bench \-\- foo \-\-exact
 .sp
 Benchmarks are built with the \fB\-\-test\fR option to \fBrustc\fR which creates a
 special executable by linking your code with libtest. The executable
-automatically runs all functions annotated with \fB#[test]\fR and \fB#[bench]\fR
-attributes. Cargo passes the \fB\-\-bench\fR flag to the test harness to tell
-it to run only benchmarks.
+automatically runs all functions annotated with \fB#[bench]\fR attribute.
+Cargo passes the \fB\-\-bench\fR flag to the test harness to tell it to run
+only benchmarks.
 .sp
 The libtest harness may be disabled by setting \fBharness = false\fR in the target
 manifest settings, in which case your code will need to provide its own \fBmain\fR