From 681c3da057c9d895cea70cbed68ac86b3c9b1627 Mon Sep 17 00:00:00 2001 From: TriplEight Date: Sat, 29 Apr 2023 15:24:16 +0200 Subject: [PATCH 1/4] document --profile --cargo-profile --config-path --- README.md | 10 ++++++++-- docs/cargo-llvm-cov-run.txt | 8 +++++++- docs/cargo-llvm-cov-test.txt | 8 +++++++- docs/cargo-llvm-cov.txt | 8 +++++++- 4 files changed, 29 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6fcded77..858b8f0e 100644 --- a/README.md +++ b/README.md @@ -247,7 +247,13 @@ OPTIONS: Build artifacts in release mode, with optimizations --profile - Build artifacts with the specified profile + Nextest profile to use + + --config-file + Path to the Nextest config file [default: workspace-root/.config/nextest.toml] + + --cargo-profile + Build artifacts with the specified cargo profile -F, --features Space or comma separated list of features to activate @@ -345,7 +351,7 @@ By default, run tests (via `cargo test`), and print the coverage summary to stdo cargo llvm-cov ``` -Currently, doc tests are disabled by default because nightly-only features are required to make coverage work for doc tests. see [#2] for more. +Currently, doc tests are disabled by default because nightly-only features are required to make coverage work for doc tests. See [#2] for more. To run `cargo run` instead of `cargo test`, use `run` subcommand. diff --git a/docs/cargo-llvm-cov-run.txt b/docs/cargo-llvm-cov-run.txt index 66205331..e0910951 100644 --- a/docs/cargo-llvm-cov-run.txt +++ b/docs/cargo-llvm-cov-run.txt @@ -148,7 +148,13 @@ OPTIONS: Build artifacts in release mode, with optimizations --profile - Build artifacts with the specified profile + Nextest profile to use + + --config-file + Path to the Nextest config file [default: workspace-root/.config/nextest.toml] + + --cargo-profile + Build artifacts with the specified cargo profile -F, --features Space or comma separated list of features to activate diff --git a/docs/cargo-llvm-cov-test.txt b/docs/cargo-llvm-cov-test.txt index 2e38fa3c..ed40bbcd 100644 --- a/docs/cargo-llvm-cov-test.txt +++ b/docs/cargo-llvm-cov-test.txt @@ -204,7 +204,13 @@ OPTIONS: Build artifacts in release mode, with optimizations --profile - Build artifacts with the specified profile + Nextest profile to use + + --config-file + Path to the Nextest config file [default: workspace-root/.config/nextest.toml] + + --cargo-profile + Build artifacts with the specified cargo profile -F, --features Space or comma separated list of features to activate diff --git a/docs/cargo-llvm-cov.txt b/docs/cargo-llvm-cov.txt index d0ea3fc7..ad88ef45 100644 --- a/docs/cargo-llvm-cov.txt +++ b/docs/cargo-llvm-cov.txt @@ -202,7 +202,13 @@ OPTIONS: Build artifacts in release mode, with optimizations --profile - Build artifacts with the specified profile + Nextest profile to use + + --config-file + Path to the Nextest config file [default: workspace-root/.config/nextest.toml] + + --cargo-profile + Build artifacts with the specified cargo profile -F, --features Space or comma separated list of features to activate From ad7abb9e5639b73ef824659076c93ef2269b19d6 Mon Sep 17 00:00:00 2001 From: TriplEight Date: Sat, 29 Apr 2023 15:27:28 +0200 Subject: [PATCH 2/4] also docline --- docs/cargo-llvm-cov-report.txt | 8 +++++++- docs/cargo-llvm-cov-test.txt | 4 ++-- src/cli.rs | 2 +- 3 files changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/cargo-llvm-cov-report.txt b/docs/cargo-llvm-cov-report.txt index e63220dc..467b1cdb 100644 --- a/docs/cargo-llvm-cov-report.txt +++ b/docs/cargo-llvm-cov-report.txt @@ -117,7 +117,13 @@ OPTIONS: Build artifacts in release mode, with optimizations --profile - Build artifacts with the specified profile + Nextest profile to use + + --config-file + Path to the Nextest config file [default: workspace-root/.config/nextest.toml] + + --cargo-profile + Build artifacts with the specified cargo profile -F, --features Space or comma separated list of features to activate diff --git a/docs/cargo-llvm-cov-test.txt b/docs/cargo-llvm-cov-test.txt index ed40bbcd..4c69c7d5 100644 --- a/docs/cargo-llvm-cov-test.txt +++ b/docs/cargo-llvm-cov-test.txt @@ -206,10 +206,10 @@ OPTIONS: --profile Nextest profile to use - --config-file + --config-file Path to the Nextest config file [default: workspace-root/.config/nextest.toml] - --cargo-profile + --cargo-profile Build artifacts with the specified cargo profile -F, --features diff --git a/src/cli.rs b/src/cli.rs index a62bcd28..2a2dcfc1 100644 --- a/src/cli.rs +++ b/src/cli.rs @@ -83,7 +83,7 @@ pub(crate) struct Args { // pub(crate) jobs: Option, /// Build artifacts in release mode, with optimizations pub(crate) release: bool, - /// Build artifacts with the specified profile + /// Nextest profile to use pub(crate) profile: Option, // /// Space or comma separated list of features to activate // pub(crate) features: Vec, From b210bb1427c85a4b27a99bd873ab7e9b6ba2f37d Mon Sep 17 00:00:00 2001 From: TriplEight Date: Sat, 29 Apr 2023 15:51:18 +0200 Subject: [PATCH 3/4] fix to review --- README.md | 5 +++-- docs/cargo-llvm-cov-report.txt | 8 +------- docs/cargo-llvm-cov-run.txt | 8 +------- docs/cargo-llvm-cov-test.txt | 8 +------- docs/cargo-llvm-cov.txt | 5 +++-- 5 files changed, 9 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 858b8f0e..0250aad4 100644 --- a/README.md +++ b/README.md @@ -247,13 +247,14 @@ OPTIONS: Build artifacts in release mode, with optimizations --profile - Nextest profile to use + If used with Nextest, specifies Nextest profile to use, can be cusomized in the Nextest config file + If used with cargo, specifies cargo compilation profile to use --config-file Path to the Nextest config file [default: workspace-root/.config/nextest.toml] --cargo-profile - Build artifacts with the specified cargo profile + If used with Nextest, build artifacts with the specified cargo profile -F, --features Space or comma separated list of features to activate diff --git a/docs/cargo-llvm-cov-report.txt b/docs/cargo-llvm-cov-report.txt index 467b1cdb..e63220dc 100644 --- a/docs/cargo-llvm-cov-report.txt +++ b/docs/cargo-llvm-cov-report.txt @@ -117,13 +117,7 @@ OPTIONS: Build artifacts in release mode, with optimizations --profile - Nextest profile to use - - --config-file - Path to the Nextest config file [default: workspace-root/.config/nextest.toml] - - --cargo-profile - Build artifacts with the specified cargo profile + Build artifacts with the specified profile -F, --features Space or comma separated list of features to activate diff --git a/docs/cargo-llvm-cov-run.txt b/docs/cargo-llvm-cov-run.txt index e0910951..66205331 100644 --- a/docs/cargo-llvm-cov-run.txt +++ b/docs/cargo-llvm-cov-run.txt @@ -148,13 +148,7 @@ OPTIONS: Build artifacts in release mode, with optimizations --profile - Nextest profile to use - - --config-file - Path to the Nextest config file [default: workspace-root/.config/nextest.toml] - - --cargo-profile - Build artifacts with the specified cargo profile + Build artifacts with the specified profile -F, --features Space or comma separated list of features to activate diff --git a/docs/cargo-llvm-cov-test.txt b/docs/cargo-llvm-cov-test.txt index 4c69c7d5..2e38fa3c 100644 --- a/docs/cargo-llvm-cov-test.txt +++ b/docs/cargo-llvm-cov-test.txt @@ -204,13 +204,7 @@ OPTIONS: Build artifacts in release mode, with optimizations --profile - Nextest profile to use - - --config-file - Path to the Nextest config file [default: workspace-root/.config/nextest.toml] - - --cargo-profile - Build artifacts with the specified cargo profile + Build artifacts with the specified profile -F, --features Space or comma separated list of features to activate diff --git a/docs/cargo-llvm-cov.txt b/docs/cargo-llvm-cov.txt index ad88ef45..e4d4a270 100644 --- a/docs/cargo-llvm-cov.txt +++ b/docs/cargo-llvm-cov.txt @@ -202,13 +202,14 @@ OPTIONS: Build artifacts in release mode, with optimizations --profile - Nextest profile to use + If used with Nextest, specifies Nextest profile to use, can be cusomized in the Nextest config file + If used with cargo, specifies cargo compilation profile to use --config-file Path to the Nextest config file [default: workspace-root/.config/nextest.toml] --cargo-profile - Build artifacts with the specified cargo profile + If used with Nextest, build artifacts with the specified cargo profile -F, --features Space or comma separated list of features to activate From a4a01bb1122187be504ea02dcfc6d4b0bba9c417 Mon Sep 17 00:00:00 2001 From: TriplEight Date: Sat, 29 Apr 2023 15:52:35 +0200 Subject: [PATCH 4/4] return the previous docline --- src/cli.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/cli.rs b/src/cli.rs index 2a2dcfc1..a62bcd28 100644 --- a/src/cli.rs +++ b/src/cli.rs @@ -83,7 +83,7 @@ pub(crate) struct Args { // pub(crate) jobs: Option, /// Build artifacts in release mode, with optimizations pub(crate) release: bool, - /// Nextest profile to use + /// Build artifacts with the specified profile pub(crate) profile: Option, // /// Space or comma separated list of features to activate // pub(crate) features: Vec,