Skip to content

Commit 2205ed5

Browse files
committed
show proper warning about not running doctests
1 parent ba3b354 commit 2205ed5

File tree

5 files changed

+24
-6
lines changed

5 files changed

+24
-6
lines changed

cargo-miri/bin.rs

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -442,6 +442,9 @@ fn phase_cargo_miri(mut args: env::Args) {
442442
let runner_env_name = format!("CARGO_TARGET_{}_RUNNER", target.to_uppercase().replace('-', "_"));
443443
cmd.env(runner_env_name, &miri_path);
444444

445+
// Set rustdoc to us as well, so we can make it do nothing (see issue #584).
446+
cmd.env("RUSTDOC", &miri_path);
447+
445448
// Run cargo.
446449
if verbose {
447450
cmd.env("MIRI_VERBOSE", ""); // This makes the other phases verbose.
@@ -571,7 +574,7 @@ fn phase_cargo_rustc(args: env::Args) {
571574
}
572575
}
573576

574-
fn phase_cargo_runner(binary: &str, binary_args: env::Args) {
577+
fn phase_cargo_runner(binary: &Path, binary_args: env::Args) {
575578
let verbose = std::env::var_os("MIRI_VERBOSE").is_some();
576579

577580
let file = File::open(&binary)
@@ -659,10 +662,25 @@ fn main() {
659662
// binary crates for later interpretation.
660663
// - When we are executed due to CARGO_TARGET_RUNNER, we start interpretation based on the
661664
// flags that were stored earlier.
665+
// On top of that, we are also called as RUSTDOC, but that is just a stub currently.
662666
match args.next().as_deref() {
663667
Some("miri") => phase_cargo_miri(args),
664668
Some("rustc") => phase_cargo_rustc(args),
665-
Some(binary) => phase_cargo_runner(binary, args),
669+
Some(arg) => {
670+
// We have to distinguish the "runner" and "rustfmt" cases.
671+
// As runner, the first argument is the binary (a file that should exist, with an absolute path);
672+
// as rustfmt, the first argument is a flag (`--something`).
673+
let binary = Path::new(arg);
674+
if binary.exists() {
675+
assert!(!arg.starts_with("--")); // not a flag
676+
phase_cargo_runner(binary, args);
677+
} else if arg.starts_with("--") {
678+
// We are rustdoc.
679+
eprintln!("Running doctests is not currently supported by Miri.")
680+
} else {
681+
show_error(format!("`cargo-miri` called with unexpected first argument `{}`; please only invoke this binary through `cargo miri`", arg));
682+
}
683+
}
666684
_ => show_error(format!("`cargo-miri` called without first argument; please only invoke this binary through `cargo miri`")),
667685
}
668686
}

test-cargo-miri/Cargo.toml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,4 @@ rand = { version = "0.7", features = ["small_rng"] }
1212
num_cpus = "1.10.1"
1313

1414
[lib]
15-
test = false
16-
doctest = false # FIXME: doctests should be skipped automatically until we can run them...
15+
test = false # test that this is respected (will show in the output)

test-cargo-miri/run-test.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,11 +78,11 @@ def test_cargo_miri_test():
7878
)
7979
test("cargo miri test (test target)",
8080
cargo_miri("test") + ["--test", "test", "--", "--format=pretty"],
81-
"test.stdout.ref4", "test.stderr.ref"
81+
"test.stdout.ref4", "test.stderr.ref2"
8282
)
8383
test("cargo miri test (bin target)",
8484
cargo_miri("test") + ["--bin", "cargo-miri-test", "--", "--format=pretty"],
85-
"test.stdout.ref5", "test.stderr.ref"
85+
"test.stdout.ref5", "test.stderr.ref2"
8686
)
8787

8888
os.chdir(os.path.dirname(os.path.realpath(__file__)))

test-cargo-miri/test.stderr.ref

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Running doctests is not currently supported by Miri.

test-cargo-miri/test.stderr.ref2

Whitespace-only changes.

0 commit comments

Comments
 (0)