Skip to content

Commit e3435d1

Browse files
committed
Auto merge of #6345 - dlaehnemann:docs_correct-profile-usage-info, r=ehuss
docs: correct profile usage of `cargo test --release` From trying it out on a project (see <varlociraptor/varlociraptor#54 (comment)>), I have realised that the `profile` usage by `cargo test --release` differs from what is documented in the cargo book. So here comes my correction suggestion...
2 parents 0273e73 + a472e7c commit e3435d1

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

src/doc/src/reference/manifest.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -341,7 +341,8 @@ incremental = true # whether or not incremental compilation is enabled
341341
overflow-checks = true # use overflow checks for integer arithmetic.
342342
# Passes the `-C overflow-checks=...` flag to the compiler.
343343

344-
# The release profile, used for `cargo build --release`.
344+
# The release profile, used for `cargo build --release` (and the dependencies
345+
# for `cargo test --release`, including the local library or binary).
345346
[profile.release]
346347
opt-level = 3
347348
debug = false
@@ -353,7 +354,8 @@ panic = 'unwind'
353354
incremental = false
354355
overflow-checks = false
355356

356-
# The testing profile, used for `cargo test`.
357+
# The testing profile, used for `cargo test` (for `cargo test --release` see
358+
# the `release` and `bench` profiles).
357359
[profile.test]
358360
opt-level = 0
359361
debug = 2
@@ -365,7 +367,8 @@ panic = 'unwind'
365367
incremental = true
366368
overflow-checks = true
367369

368-
# The benchmarking profile, used for `cargo bench` and `cargo test --release`.
370+
# The benchmarking profile, used for `cargo bench` (and the test targets and
371+
# unit tests for `cargo test --release`).
369372
[profile.bench]
370373
opt-level = 3
371374
debug = false

0 commit comments

Comments
 (0)