src/bootstrap/bin/rustdoc.rs

   1 //! Shim which is passed to Cargo as "rustdoc" when running the bootstrap.
   2 //!
   3 //! See comments in `src/bootstrap/rustc.rs` for more information.
   4
   5 // NO-RUSTC-WRAPPER
   6 #![deny(warnings, rust_2018_idioms, unused_lifetimes)]
   7
   8 use std::env;
   9 use std::process::Command;
  10 use std::path::PathBuf;
  11
  12 fn main() {
  13     let args = env::args_os().skip(1).collect::<Vec<_>>();
  14     let rustdoc = env::var_os("RUSTDOC_REAL").expect("RUSTDOC_REAL was not set");
  15     let libdir = env::var_os("RUSTDOC_LIBDIR").expect("RUSTDOC_LIBDIR was not set");
  16     let stage = env::var("RUSTC_STAGE").expect("RUSTC_STAGE was not set");
  17     let sysroot = env::var_os("RUSTC_SYSROOT").expect("RUSTC_SYSROOT was not set");
  18     let mut has_unstable = false;
  19
  20     use std::str::FromStr;
  21
  22     let verbose = match env::var("RUSTC_VERBOSE") {
  23         Ok(s) => usize::from_str(&s).expect("RUSTC_VERBOSE should be an integer"),
  24         Err(_) => 0,
  25     };
  26
  27     let mut dylib_path = bootstrap::util::dylib_path();
  28     dylib_path.insert(0, PathBuf::from(libdir.clone()));
  29
  30     //FIXME(misdreavus): once stdsimd uses cfg(rustdoc) instead of cfg(dox), remove the `--cfg dox`
  31     //arguments here
  32     let mut cmd = Command::new(rustdoc);
  33     cmd.args(&args)
  34         .arg("--cfg")
  35         .arg(format!("stage{}", stage))
  36         .arg("--cfg")
  37         .arg("dox")
  38         .arg("--sysroot")
  39         .arg(&sysroot)
  40         .env(bootstrap::util::dylib_path_var(),
  41              env::join_paths(&dylib_path).unwrap());
  42
  43     // Force all crates compiled by this compiler to (a) be unstable and (b)
  44     // allow the `rustc_private` feature to link to other unstable crates
  45     // also in the sysroot.
  46     if env::var_os("RUSTC_FORCE_UNSTABLE").is_some() {
  47         cmd.arg("-Z").arg("force-unstable-if-unmarked");
  48     }
  49     if let Some(linker) = env::var_os("RUSTC_TARGET_LINKER") {
  50         cmd.arg("--linker").arg(linker).arg("-Z").arg("unstable-options");
  51     }
  52
  53     // Bootstrap's Cargo-command builder sets this variable to the current Rust version; let's pick
  54     // it up so we can make rustdoc print this into the docs
  55     if let Some(version) = env::var_os("RUSTDOC_CRATE_VERSION") {
  56         // This "unstable-options" can be removed when `--crate-version` is stabilized
  57         if !has_unstable {
  58             cmd.arg("-Z")
  59                .arg("unstable-options");
  60         }
  61         cmd.arg("--crate-version").arg(version);
  62         has_unstable = true;
  63     }
  64
  65     // Needed to be able to run all rustdoc tests.
  66     if let Some(_) = env::var_os("RUSTDOC_GENERATE_REDIRECT_PAGES") {
  67         // This "unstable-options" can be removed when `--generate-redirect-pages` is stabilized
  68         if !has_unstable {
  69             cmd.arg("-Z")
  70                .arg("unstable-options");
  71         }
  72         cmd.arg("--generate-redirect-pages");
  73         has_unstable = true;
  74     }
  75
  76     // Needed to be able to run all rustdoc tests.
  77     if let Some(ref x) = env::var_os("RUSTDOC_RESOURCE_SUFFIX") {
  78         // This "unstable-options" can be removed when `--resource-suffix` is stabilized
  79         if !has_unstable {
  80             cmd.arg("-Z")
  81                .arg("unstable-options");
  82         }
  83         cmd.arg("--resource-suffix").arg(x);
  84     }
  85
  86     if verbose > 1 {
  87         eprintln!(
  88             "rustdoc command: {:?}={:?} {:?}",
  89             bootstrap::util::dylib_path_var(),
  90             env::join_paths(&dylib_path).unwrap(),
  91             cmd,
  92         );
  93         eprintln!("sysroot: {:?}", sysroot);
  94         eprintln!("libdir: {:?}", libdir);
  95     }
  96
  97     std::process::exit(match cmd.status() {
  98         Ok(s) => s.code().unwrap_or(1),
  99         Err(e) => panic!("\n\nfailed to run {:?}: {}\n\n", cmd, e),
 100     })
 101 }