From 2f59b20df617d25873d61729cec3fc46499b7872 Mon Sep 17 00:00:00 2001 From: Predrag Gruevski <2348618+obi1kenobi@users.noreply.github.com> Date: Mon, 31 Jul 2023 12:33:34 -0400 Subject: [PATCH] Mention that `cargo test --all-targets` excludes doctests Per my proposal here: https://github.com/rust-lang/cargo/issues/6669#issuecomment-1658593167 I tried to keep the edit minimalistic to match the surrounding style. If the maintainers are amenable to it, I think it could also be useful to do one or more of: - Offer concrete guidance on what to do to run actually-all tests (`--all-targets` then separately `--doc`). - Link to the issue at: https://github.com/rust-lang/cargo/issues/6669 - Mention that `cargo test` without `--all-targets` runs doctests by default, which seems not immediately obvious. I'd be happy to attempt to add any of the above that the maintainers feel would be a good fit here. --- src/bin/cargo/commands/test.rs | 2 +- tests/testsuite/cargo_test/help/stdout.log | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/bin/cargo/commands/test.rs b/src/bin/cargo/commands/test.rs index 607655aaf33..424ed3f00d6 100644 --- a/src/bin/cargo/commands/test.rs +++ b/src/bin/cargo/commands/test.rs @@ -34,7 +34,7 @@ pub fn cli() -> Command { "Test all tests", "Test only the specified bench target", "Test all benches", - "Test all targets", + "Test all targets (does not include doctests)", ) .arg(flag("doc", "Test only this library's documentation")) .arg(flag("no-run", "Compile, but don't run tests")) diff --git a/tests/testsuite/cargo_test/help/stdout.log b/tests/testsuite/cargo_test/help/stdout.log index c26eb06197e..7e60fa42444 100644 --- a/tests/testsuite/cargo_test/help/stdout.log +++ b/tests/testsuite/cargo_test/help/stdout.log @@ -17,7 +17,7 @@ Options: --test [] Test only the specified test target --benches Test all benches --bench [] Test only the specified bench target - --all-targets Test all targets + --all-targets Test all targets (does not include doctests) --doc Test only this library's documentation --no-run Compile, but don't run tests --no-fail-fast Run all tests regardless of failure