Merge #167

167: fix: add `--coverage-target-only`, to use rustflags only for target r=taiki-e a=haraldh

Use `CARGO_TARGET_{target}_RUSTFLAGS` rather than `RUSTFLAGS`,
if `--target <TRIPLE>` and `--coverage-target-only` is specified.

This is important, if the project uses multiple targets via the cargo
`bindeps` feature, and not all targets can use `instrument-coverage`,
e.g. a microkernel, or an embedded binary.

Signed-off-by: Harald Hoyer <harald@profian.com>

Co-authored-by: Harald Hoyer <harald@profian.com>

README.md

@@ -228,6 +228,13 @@ OPTIONS:
             When this option is used, coverage for proc-macro and build script will not be displayed
             because cargo does not pass RUSTFLAGS to them.
 
+        --coverage-target-only
+            Activate coverage reporting only for the target triple
+
+            Activate coverage reporting only for the target triple specified via `--target`. This is
+            important, if the project uses multiple targets via the cargo bindeps feature, and not
+            all targets can use `instrument-coverage`, e.g. a microkernel, or an embedded binary.
+
     -v, --verbose
             Use verbose output
 

src/cli.rs

@@ -360,6 +360,14 @@ pub(crate) struct BuildOptions {
     /// not be displayed because cargo does not pass RUSTFLAGS to them.
     #[clap(long, value_name = "TRIPLE")]
     pub(crate) target: Option<String>,
+    /// Activate coverage reporting only for the target triple
+    ///
+    /// Activate coverage reporting only for the target triple specified via `--target`.
+    /// This is important, if the project uses multiple targets via the cargo
+    /// bindeps feature, and not all targets can use `instrument-coverage`,
+    /// e.g. a microkernel, or an embedded binary.
+    #[clap(long, requires = "target")]
+    pub(crate) coverage_target_only: bool,
     // TODO: Currently, we are using a subdirectory of the target directory as
     //       the actual target directory. What effect should this option have
     //       on its behavior?

src/main.rs

@@ -281,7 +281,14 @@ fn set_env(cx: &Context, target: &mut impl EnvTarget) {
         }
     }
 
-    target.set("RUSTFLAGS", rustflags);
+    match (cx.build.coverage_target_only, &cx.build.target) {
+        (true, Some(coverage_target)) => target.set(
+            &format!("CARGO_TARGET_{}_RUSTFLAGS", coverage_target.to_uppercase().replace('-', "_")),
+            rustflags,
+        ),
+        _ => target.set("RUSTFLAGS", rustflags),
+    }
+
     if let Some(rustdocflags) = rustdocflags {
         target.set("RUSTDOCFLAGS", rustdocflags);
     }

tests/long-help.txt

@@ -187,6 +187,13 @@ OPTIONS:
             When this option is used, coverage for proc-macro and build script will not be displayed
             because cargo does not pass RUSTFLAGS to them.
 
+        --coverage-target-only
+            Activate coverage reporting only for the target triple
+
+            Activate coverage reporting only for the target triple specified via `--target`. This is
+            important, if the project uses multiple targets via the cargo bindeps feature, and not
+            all targets can use `instrument-coverage`, e.g. a microkernel, or an embedded binary.
+
     -v, --verbose
             Use verbose output
 

tests/short-help.txt

@@ -144,6 +144,9 @@ OPTIONS:
         --target <TRIPLE>
             Build for the target triple
 
+        --coverage-target-only
+            Activate coverage reporting only for the target triple
+
     -v, --verbose
             Use verbose output