phase_rustdoc: add a heuristic to make us more certain that this is really rustdoc

This commit is contained in:
Ralf Jung 2024-03-25 14:38:57 +01:00
parent 8afc4862d0
commit 98e1cbbc02
2 changed files with 18 additions and 4 deletions

View File

@ -11,10 +11,18 @@ use std::{env, iter};
use crate::phases::*; use crate::phases::*;
/// Returns `true` if our flags look like they may be for rustdoc, i.e., this is cargo calling us to
/// be rustdoc. It's hard to be sure as cargo does not have a RUSTDOC_WRAPPER or an env var that
/// would let us get a clear signal.
fn looks_like_rustdoc() -> bool {
// The `--test-run-directory` flag only exists for rustdoc and cargo always passes it. Perfect!
env::args().any(|arg| arg == "--test-run-directory")
}
fn main() { fn main() {
// Rustc does not support non-UTF-8 arguments so we make no attempt either. // Rustc does not support non-UTF-8 arguments so we make no attempt either.
// (We do support non-UTF-8 environment variables though.) // (We do support non-UTF-8 environment variables though.)
let mut args = std::env::args(); let mut args = env::args();
// Skip binary name. // Skip binary name.
args.next().unwrap(); args.next().unwrap();
@ -91,10 +99,16 @@ fn main() {
// (see https://github.com/rust-lang/cargo/issues/10886). // (see https://github.com/rust-lang/cargo/issues/10886).
phase_rustc(args, RustcPhase::Build) phase_rustc(args, RustcPhase::Build)
} }
_ => { _ if looks_like_rustdoc() => {
// Everything else must be rustdoc. But we need to get `first` "back onto the iterator", // This is probably rustdoc. But we need to get `first` "back onto the iterator",
// it is some part of the rustdoc invocation. // it is some part of the rustdoc invocation.
phase_rustdoc(iter::once(first).chain(args)); phase_rustdoc(iter::once(first).chain(args));
} }
_ => {
show_error!(
"`cargo-miri` failed to recognize which phase of the build process this is, please report a bug.\nThe command-line arguments were: {:#?}",
Vec::from_iter(env::args()),
);
}
} }
} }

View File

@ -620,7 +620,7 @@ pub fn phase_rustdoc(mut args: impl Iterator<Item = String>) {
// The `--test-builder` and `--runtool` arguments are unstable rustdoc features, // The `--test-builder` and `--runtool` arguments are unstable rustdoc features,
// which are disabled by default. We first need to enable them explicitly: // which are disabled by default. We first need to enable them explicitly:
cmd.arg("-Z").arg("unstable-options"); cmd.arg("-Zunstable-options");
// rustdoc needs to know the right sysroot. // rustdoc needs to know the right sysroot.
cmd.arg("--sysroot").arg(env::var_os("MIRI_SYSROOT").unwrap()); cmd.arg("--sysroot").arg(env::var_os("MIRI_SYSROOT").unwrap());