Skip to content

Support --remap-path-prefix for doctest #496

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
taiki-e wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Support --remap-path-prefix for doctest #496

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
74bcb38
Support --remap-path-prefix for doctest
taiki-e May 24, 2026
e30bbb1
Update README.md
taiki-e May 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -331,8 +331,6 @@ OPTIONS:
--remap-path-prefix
Use --remap-path-prefix for workspace root

Note that this does not fully compatible with doctest.

--include-ffi
Include coverage of C/C++ code linked to Rust library/binary

Expand Down
2 changes: 0 additions & 2 deletions docs/cargo-llvm-cov-report.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,8 +185,6 @@ OPTIONS:
--remap-path-prefix
Use --remap-path-prefix for workspace root

Note that this does not fully compatible with doctest.

--include-ffi
Include coverage of C/C++ code linked to Rust library/binary

Expand Down
2 changes: 0 additions & 2 deletions docs/cargo-llvm-cov-run.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,8 +225,6 @@ OPTIONS:
--remap-path-prefix
Use --remap-path-prefix for workspace root

Note that this does not fully compatible with doctest.

--include-ffi
Include coverage of C/C++ code linked to Rust library/binary

Expand Down
2 changes: 0 additions & 2 deletions docs/cargo-llvm-cov-show-env.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,6 @@ OPTIONS:
--remap-path-prefix
Use --remap-path-prefix for workspace root

Note that this does not fully compatible with doctest.

--include-ffi
Include coverage of C/C++ code linked to Rust library/binary

Expand Down
2 changes: 0 additions & 2 deletions docs/cargo-llvm-cov-test.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,8 +281,6 @@ OPTIONS:
--remap-path-prefix
Use --remap-path-prefix for workspace root

Note that this does not fully compatible with doctest.

--include-ffi
Include coverage of C/C++ code linked to Rust library/binary

Expand Down
2 changes: 0 additions & 2 deletions docs/cargo-llvm-cov.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,8 +279,6 @@ OPTIONS:
--remap-path-prefix
Use --remap-path-prefix for workspace root

Note that this does not fully compatible with doctest.

--include-ffi
Include coverage of C/C++ code linked to Rust library/binary

Expand Down
2 changes: 0 additions & 2 deletions src/cli.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,6 @@ pub(crate) struct Args {
pub(crate) verbose: u8,

/// Use --remap-path-prefix for workspace root
///
/// Note that this does not fully compatible with doctest.
pub(crate) remap_path_prefix: bool,

/// Show coverage of the specified dependency instead of the crates in the current workspace.
Expand Down
5 changes: 5 additions & 0 deletions src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,6 +300,11 @@ fn set_env(cx: &Context, env: &mut dyn EnvTarget, IsNextest(is_nextest): IsNexte
cx.ws.config.rustdocflags(&cx.ws.target_for_config)?.unwrap_or_default();
{
push_common_flags(cx, &mut rustdocflags);
// https://github.com/rust-lang/rust/pull/155307
if cx.args.remap_path_prefix {
rustdocflags.push("--remap-path-prefix");
rustdocflags.push(format!("{}/=", cx.ws.metadata.workspace_root));
}
// flags needed for doctest coverage.
// https://doc.rust-lang.org/nightly/rustc/instrument-coverage.html#including-doc-tests
rustdocflags.push("-Z");
Expand Down
Loading