Merge #164

164: Set cfg(coverage_nightly) when nightly compiler is used r=taiki-e a=taiki-e

Closes #157

Co-authored-by: Taiki Endo <te316e89@gmail.com>

CHANGELOG.md

@@ -11,9 +11,12 @@ Note: In this file, do not use the hard wrap in the middle of a sentence for com
 ## [Unreleased]
 
 - cargo-llvm-cov no longer changes the current directory when running cargo. ([#161](https://github.com/taiki-e/cargo-llvm-cov/pull/161))
+
 - Exclude build script from report by default. ([#163](https://github.com/taiki-e/cargo-llvm-cov/pull/163))
   You can use `--include-build-script` flag to include build script in report.
 
+- Set `cfg(coverage_nightly)` when nightly compiler is used. ([#164](https://github.com/taiki-e/cargo-llvm-cov/pull/164))
+
 ## [0.3.3] - 2022-05-06
 
 - Fix an issue where codes in the target directory are not being properly excluded from reports when using `show-env` subcommand. ([#156](https://github.com/taiki-e/cargo-llvm-cov/pull/156))

README.md

@@ -118,7 +118,11 @@ OPTIONS:
             Hide instantiations from report
 
         --no-cfg-coverage
-            Unset cfg(coverage)
+            Unset cfg(coverage), which is enabled when code is built using cargo-llvm-cov
+
+        --no-cfg-coverage-nightly
+            Unset cfg(coverage_nightly), which is enabled when code is built using cargo-llvm-cov
+            and nightly compiler
 
         --no-report
             Run tests, but don't generate coverage report
@@ -362,12 +366,14 @@ cargo llvm-cov --open --ignore-filename-regex build
 
 To exclude the specific function from coverage, use the [`#[no_coverage]` attribute][rust-lang/rust#84605].
 
-Since `#[no_coverage]` is unstable, it is recommended to use it together with `cfg(coverage)` set by cargo-llvm-cov.
+Since `#[no_coverage]` is unstable, it is recommended to use it together with `cfg(coverage)` or `cfg(coverage_nightly)` set by cargo-llvm-cov.
 
 ```rust
-#![cfg_attr(coverage, feature(no_coverage))]
+// cfg(coverage) is true when code is built using cargo-llvm-cov
+// cfg(coverage_nightly) is true when code is built using cargo-llvm-cov and nightly compiler
+#![cfg_attr(coverage_nightly, feature(no_coverage))]
 
-#[cfg_attr(coverage, no_coverage)]
+#[cfg_attr(coverage_nightly, no_coverage)]
 fn exclude_from_coverage() {
     // ...
 }

src/cargo.rs

@@ -27,6 +27,7 @@ pub(crate) struct Workspace {
 
     cargo: PathBuf,
     rustc: PathBuf,
+    pub(crate) nightly: bool,
     /// Whether `-C instrument-coverage` is available.
     pub(crate) stable_coverage: bool,
 }
@@ -84,6 +85,7 @@ impl Workspace {
             profdata_file,
             cargo: cargo.into(),
             rustc,
+            nightly,
             stable_coverage,
         })
     }

src/cli.rs

@@ -307,9 +307,12 @@ pub(crate) struct LlvmCovOptions {
     /// Hide instantiations from report
     #[clap(long)]
     pub(crate) hide_instantiations: bool,
-    /// Unset cfg(coverage)
+    /// Unset cfg(coverage), which is enabled when code is built using cargo-llvm-cov.
     #[clap(long)]
     pub(crate) no_cfg_coverage: bool,
+    /// Unset cfg(coverage_nightly), which is enabled when code is built using cargo-llvm-cov and nightly compiler.
+    #[clap(long)]
+    pub(crate) no_cfg_coverage_nightly: bool,
     /// Run tests, but don't generate coverage report
     #[clap(long)]
     pub(crate) no_report: bool,

src/main.rs

@@ -248,6 +248,9 @@ fn set_env(cx: &Context, target: &mut impl EnvTarget) {
     if !cx.cov.no_cfg_coverage {
         rustflags.push_str(" --cfg coverage");
     }
+    if cx.ws.nightly && !cx.cov.no_cfg_coverage_nightly {
+        rustflags.push_str(" --cfg coverage_nightly");
+    }
     if cx.build.target.is_none() {
         // https://github.com/dtolnay/trybuild/pull/121
         // https://github.com/dtolnay/trybuild/issues/122
@@ -273,6 +276,9 @@ fn set_env(cx: &Context, target: &mut impl EnvTarget) {
         if !cx.cov.no_cfg_coverage {
             rustdocflags.push_str(" --cfg coverage");
         }
+        if cx.ws.nightly && !cx.cov.no_cfg_coverage_nightly {
+            rustdocflags.push_str(" --cfg coverage_nightly");
+        }
     }
 
     target.set("RUSTFLAGS", rustflags);

tests/long-help.txt

@@ -77,7 +77,11 @@ OPTIONS:
             Hide instantiations from report
 
         --no-cfg-coverage
-            Unset cfg(coverage)
+            Unset cfg(coverage), which is enabled when code is built using cargo-llvm-cov
+
+        --no-cfg-coverage-nightly
+            Unset cfg(coverage_nightly), which is enabled when code is built using cargo-llvm-cov
+            and nightly compiler
 
         --no-report
             Run tests, but don't generate coverage report

tests/short-help.txt

@@ -45,7 +45,11 @@ OPTIONS:
             Hide instantiations from report
 
         --no-cfg-coverage
-            Unset cfg(coverage)
+            Unset cfg(coverage), which is enabled when code is built using cargo-llvm-cov
+
+        --no-cfg-coverage-nightly
+            Unset cfg(coverage_nightly), which is enabled when code is built using cargo-llvm-cov
+            and nightly compiler
 
         --no-report
             Run tests, but don't generate coverage report