rust/src/bootstrap/doc.rs

850 lines
27 KiB
Rust
Raw Normal View History

// Copyright 2016 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
//! Documentation generation for rustbuild.
//!
//! This module implements generation for all bits and pieces of documentation
//! for the Rust project. This notably includes suites like the rust book, the
//! nomicon, standalone documentation, etc.
//!
//! Everything here is basically just a shim around calling either `rustbook` or
//! `rustdoc`.
use std::fs::{self, File};
use std::io::prelude::*;
use std::io;
use std::path::Path;
use std::process::Command;
use Mode;
use util::{cp_r, symlink_dir};
use build_helper::up_to_date;
use builder::{Builder, Step};
use tool::Tool;
use compile;
macro_rules! book {
($($name:ident, $path:expr, $book_name:expr;)+) => {
$(
#[derive(Serialize)]
pub struct $name<'a> {
target: &'a str,
}
impl<'a> Step<'a> for $name<'a> {
type Output = ();
const DEFAULT: bool = true;
fn should_run(_builder: &Builder, path: &Path) -> bool {
path.ends_with($path)
}
fn make_run(builder: &Builder, path: Option<&Path>, _host: &str, target: &str) {
if path.is_none() && !builder.build.config.docs {
// Not a default rule if docs are disabled.
return;
}
builder.ensure($name {
target,
});
}
fn run(self, builder: &Builder) {
builder.ensure(Rustbook {
target: self.target,
name: $book_name,
})
}
}
)+
}
}
book!(
// rules.doc("doc-nomicon", "src/doc/nomicon")
// .dep(move |s| {
// s.name("tool-rustbook")
// .host(&build.build)
// .target(&build.build)
// .stage(0)
// })
// .default(build.config.docs)
// .run(move |s| doc::rustbook(build, s.target, "nomicon"));
Nomicon, "src/doc/book", "nomicon";
// rules.doc("doc-reference", "src/doc/reference")
// .dep(move |s| {
// s.name("tool-rustbook")
// .host(&build.build)
// .target(&build.build)
// .stage(0)
// })
// .default(build.config.docs)
// .run(move |s| doc::rustbook(build, s.target, "reference"));
Reference, "src/doc/reference", "reference";
);
#[derive(Serialize)]
pub struct Rustbook<'a> {
target: &'a str,
name: &'a str,
}
impl<'a> Step<'a> for Rustbook<'a> {
type Output = ();
/// Invoke `rustbook` for `target` for the doc book `name`.
///
/// This will not actually generate any documentation if the documentation has
/// already been generated.
fn run(self, builder: &Builder) {
let src = builder.build.src.join("src/doc");
builder.ensure(RustbookSrc {
target: self.target,
name: self.name,
src: &src,
});
}
}
2017-07-04 17:53:53 -06:00
//rules.doc("doc-unstable-book", "src/doc/unstable-book")
// .dep(move |s| {
// s.name("tool-rustbook")
// .host(&build.build)
// .target(&build.build)
// .stage(0)
// })
// .dep(move |s| s.name("doc-unstable-book-gen"))
// .default(build.config.docs)
// .run(move |s| doc::rustbook_src(build,
// s.target,
// "unstable-book",
// &build.md_doc_out(s.target)));
#[derive(Serialize)]
pub struct UnstableBook<'a> {
target: &'a str,
}
impl<'a> Step<'a> for UnstableBook<'a> {
type Output = ();
const DEFAULT: bool = true;
fn should_run(_builder: &Builder, path: &Path) -> bool {
path.ends_with("src/doc/unstable-book")
}
fn make_run(builder: &Builder, path: Option<&Path>, _host: &str, target: &str) {
if path.is_none() && !builder.build.config.docs {
// Not a default rule if docs are disabled.
return;
}
builder.ensure(UnstableBook {
target,
});
}
fn run(self, builder: &Builder) {
builder.ensure(UnstableBookGen {
target: self.target,
});
builder.ensure(RustbookSrc {
target: self.target,
name: "unstable-book",
src: &builder.build.md_doc_out(self.target),
})
}
}
2017-07-04 17:53:53 -06:00
#[derive(Serialize)]
pub struct RustbookSrc<'a> {
target: &'a str,
name: &'a str,
src: &'a Path,
}
2017-07-04 17:53:53 -06:00
impl<'a> Step<'a> for RustbookSrc<'a> {
type Output = ();
/// Invoke `rustbook` for `target` for the doc book `name` from the `src` path.
///
/// This will not actually generate any documentation if the documentation has
/// already been generated.
fn run(self, builder: &Builder) {
let build = builder.build;
let target = self.target;
let name = self.name;
let src = self.src;
let out = build.doc_out(target);
t!(fs::create_dir_all(&out));
let out = out.join(name);
let src = src.join(name);
let index = out.join("index.html");
let rustbook = builder.tool_exe(Tool::Rustbook);
if up_to_date(&src, &index) && up_to_date(&rustbook, &index) {
return
}
println!("Rustbook ({}) - {}", target, name);
let _ = fs::remove_dir_all(&out);
build.run(builder.tool_cmd(Tool::Rustbook)
.arg("build")
.arg(&src)
.arg("-d")
.arg(out));
}
}
2017-07-04 17:53:53 -06:00
// rules.doc("doc-book", "src/doc/book")
// .dep(move |s| {
// s.name("tool-rustbook")
// .host(&build.build)
// .target(&build.build)
// .stage(0)
// })
// .default(build.config.docs)
// .run(move |s| doc::book(build, s.target, "book"));
#[derive(Serialize)]
pub struct TheBook<'a> {
target: &'a str,
name: &'a str,
}
impl<'a> Step<'a> for TheBook<'a> {
type Output = ();
/// Build the book and associated stuff.
///
/// We need to build:
///
/// * Book (first edition)
/// * Book (second edition)
/// * Index page
/// * Redirect pages
fn run(self, builder: &Builder) {
let build = builder.build;
let target = self.target;
let name = self.name;
// build book first edition
builder.ensure(Rustbook {
target: target,
name: &format!("{}/first-edition", name),
});
// build book second edition
builder.ensure(Rustbook {
target: target,
name: &format!("{}/second-edition", name),
});
// build the index page
let index = format!("{}/index.md", name);
println!("Documenting book index ({})", target);
invoke_rustdoc(builder, target, &index);
// build the redirect pages
println!("Documenting book redirect pages ({})", target);
for file in t!(fs::read_dir(build.src.join("src/doc/book/redirects"))) {
let file = t!(file);
let path = file.path();
let path = path.to_str().unwrap();
invoke_rustdoc(builder, target, path);
}
}
2017-03-07 15:31:41 -05:00
}
fn invoke_rustdoc(builder: &Builder, target: &str, markdown: &str) {
let build = builder.build;
2017-03-07 15:31:41 -05:00
let out = build.doc_out(target);
let compiler = builder.compiler(0, &build.build);
2017-03-07 15:31:41 -05:00
let path = build.src.join("src/doc").join(markdown);
let rustdoc = build.rustdoc(compiler);
2017-03-07 15:31:41 -05:00
let favicon = build.src.join("src/doc/favicon.inc");
let footer = build.src.join("src/doc/footer.inc");
let version_input = build.src.join("src/doc/version_info.html.template");
2017-03-07 15:31:41 -05:00
let version_info = out.join("version_info.html");
if !up_to_date(&version_input, &version_info) {
let mut info = String::new();
t!(t!(File::open(&version_input)).read_to_string(&mut info));
let info = info.replace("VERSION", &build.rust_release())
.replace("SHORT_HASH", build.rust_info.sha_short().unwrap_or(""))
.replace("STAMP", build.rust_info.sha().unwrap_or(""));
t!(t!(File::create(&version_info)).write_all(info.as_bytes()));
}
2017-03-07 15:31:41 -05:00
let mut cmd = Command::new(&rustdoc);
build.add_rustc_lib_path(compiler, &mut cmd);
2017-03-07 15:31:41 -05:00
let out = out.join("book");
t!(fs::copy(build.src.join("src/doc/rust.css"), out.join("rust.css")));
2017-03-07 15:31:41 -05:00
cmd.arg("--html-after-content").arg(&footer)
.arg("--html-before-content").arg(&version_info)
.arg("--html-in-header").arg(&favicon)
.arg("--markdown-playground-url")
.arg("https://play.rust-lang.org/")
.arg("-o").arg(&out)
.arg(&path)
.arg("--markdown-css")
.arg("rust.css");
build.run(&mut cmd);
2017-03-07 14:49:50 -05:00
}
2017-07-04 17:53:53 -06:00
// rules.doc("doc-standalone", "src/doc")
// .dep(move |s| {
// s.name("rustc")
// .host(&build.build)
// .target(&build.build)
// .stage(0)
// })
// .default(build.config.docs)
// .run(move |s| doc::standalone(build, s.target));
#[derive(Serialize)]
pub struct Standalone<'a> {
target: &'a str,
}
impl<'a> Step<'a> for Standalone<'a> {
type Output = ();
const DEFAULT: bool = true;
fn should_run(_builder: &Builder, path: &Path) -> bool {
path.ends_with("src/doc")
}
fn make_run(builder: &Builder, path: Option<&Path>, _host: &str, target: &str) {
if path.is_none() && !builder.build.config.docs {
// Not a default rule if docs are disabled.
return;
}
builder.ensure(Standalone {
target,
});
}
/// Generates all standalone documentation as compiled by the rustdoc in `stage`
/// for the `target` into `out`.
///
/// This will list all of `src/doc` looking for markdown files and appropriately
/// perform transformations like substituting `VERSION`, `SHORT_HASH`, and
/// `STAMP` alongw ith providing the various header/footer HTML we've cutomized.
///
/// In the end, this is just a glorified wrapper around rustdoc!
fn run(self, builder: &Builder) {
let build = builder.build;
let target = self.target;
println!("Documenting standalone ({})", target);
let out = build.doc_out(target);
t!(fs::create_dir_all(&out));
let compiler = builder.compiler(0, &build.build);
let favicon = build.src.join("src/doc/favicon.inc");
let footer = build.src.join("src/doc/footer.inc");
let full_toc = build.src.join("src/doc/full-toc.inc");
t!(fs::copy(build.src.join("src/doc/rust.css"), out.join("rust.css")));
let version_input = build.src.join("src/doc/version_info.html.template");
let version_info = out.join("version_info.html");
if !up_to_date(&version_input, &version_info) {
let mut info = String::new();
t!(t!(File::open(&version_input)).read_to_string(&mut info));
let info = info.replace("VERSION", &build.rust_release())
.replace("SHORT_HASH", build.rust_info.sha_short().unwrap_or(""))
.replace("STAMP", build.rust_info.sha().unwrap_or(""));
t!(t!(File::create(&version_info)).write_all(info.as_bytes()));
}
for file in t!(fs::read_dir(build.src.join("src/doc"))) {
let file = t!(file);
let path = file.path();
let filename = path.file_name().unwrap().to_str().unwrap();
if !filename.ends_with(".md") || filename == "README.md" {
continue
}
let html = out.join(filename).with_extension("html");
let rustdoc = build.rustdoc(compiler);
if up_to_date(&path, &html) &&
up_to_date(&footer, &html) &&
up_to_date(&favicon, &html) &&
up_to_date(&full_toc, &html) &&
up_to_date(&version_info, &html) &&
up_to_date(&rustdoc, &html) {
continue
}
let mut cmd = Command::new(&rustdoc);
build.add_rustc_lib_path(compiler, &mut cmd);
cmd.arg("--html-after-content").arg(&footer)
.arg("--html-before-content").arg(&version_info)
.arg("--html-in-header").arg(&favicon)
.arg("--markdown-playground-url")
.arg("https://play.rust-lang.org/")
.arg("-o").arg(&out)
.arg(&path);
if filename == "not_found.md" {
cmd.arg("--markdown-no-toc")
.arg("--markdown-css")
.arg("https://doc.rust-lang.org/rust.css");
} else {
cmd.arg("--markdown-css").arg("rust.css");
}
build.run(&mut cmd);
}
}
}
2017-07-04 17:53:53 -06:00
// for (krate, path, default) in krates("std") {
// rules.doc(&krate.doc_step, path)
// .dep(|s| s.name("libstd-link"))
// .default(default && build.config.docs)
// .run(move |s| doc::std(build, s.stage, s.target));
// }
#[derive(Serialize)]
pub struct Std<'a> {
stage: u32,
target: &'a str,
}
impl<'a> Step<'a> for Std<'a> {
type Output = ();
const DEFAULT: bool = true;
fn should_run(builder: &Builder, path: &Path) -> bool {
builder.crates("std").into_iter().any(|(_, krate_path)| {
path.ends_with(krate_path)
})
}
fn make_run(builder: &Builder, path: Option<&Path>, _host: &str, target: &str) {
let run = || {
builder.ensure(Std {
stage: builder.top_stage,
target
});
};
if let Some(path) = path {
for (_, krate_path) in builder.crates("std") {
if path.ends_with(krate_path) {
run();
}
}
} else {
if builder.build.config.docs {
run();
}
}
}
/// Compile all standard library documentation.
///
/// This will generate all documentation for the standard library and its
/// dependencies. This is largely just a wrapper around `cargo doc`.
fn run(self, builder: &Builder) {
let build = builder.build;
let stage = self.stage;
let target = self.target;
println!("Documenting stage{} std ({})", stage, target);
let out = build.doc_out(target);
t!(fs::create_dir_all(&out));
let compiler = builder.compiler(stage, &build.build);
let compiler = if build.force_use_stage1(compiler, target) {
builder.compiler(1, compiler.host)
} else {
compiler
};
builder.ensure(compile::Std { compiler, target });
let out_dir = build.stage_out(compiler, Mode::Libstd)
.join(target).join("doc");
let rustdoc = build.rustdoc(compiler);
// Here what we're doing is creating a *symlink* (directory junction on
// Windows) to the final output location. This is not done as an
// optimization but rather for correctness. We've got three trees of
// documentation, one for std, one for test, and one for rustc. It's then
// our job to merge them all together.
//
// Unfortunately rustbuild doesn't know nearly as well how to merge doc
// trees as rustdoc does itself, so instead of actually having three
// separate trees we just have rustdoc output to the same location across
// all of them.
//
// This way rustdoc generates output directly into the output, and rustdoc
// will also directly handle merging.
let my_out = build.crate_doc_out(target);
build.clear_if_dirty(&my_out, &rustdoc);
t!(symlink_dir_force(&my_out, &out_dir));
let mut cargo = build.cargo(compiler, Mode::Libstd, target, "doc");
cargo.arg("--manifest-path")
.arg(build.src.join("src/libstd/Cargo.toml"))
.arg("--features").arg(build.std_features());
// We don't want to build docs for internal std dependencies unless
// in compiler-docs mode. When not in that mode, we whitelist the crates
// for which docs must be built.
if !build.config.compiler_docs {
cargo.arg("--no-deps");
for krate in &["alloc", "collections", "core", "std", "std_unicode"] {
cargo.arg("-p").arg(krate);
// Create all crate output directories first to make sure rustdoc uses
// relative links.
// FIXME: Cargo should probably do this itself.
t!(fs::create_dir_all(out_dir.join(krate)));
}
}
build.run(&mut cargo);
cp_r(&my_out, &out);
}
}
2017-07-04 17:53:53 -06:00
// for (krate, path, default) in krates("test") {
// rules.doc(&krate.doc_step, path)
// .dep(|s| s.name("libtest-link"))
// // Needed so rustdoc generates relative links to std.
// .dep(|s| s.name("doc-crate-std"))
// .default(default && build.config.compiler_docs)
// .run(move |s| doc::test(build, s.stage, s.target));
// }
rustbuild: Fix dist for non-host targets The `rust-std` package that we produce is expected to have not only the standard library but also libtest for compiling unit tests. Unfortunately this does not currently happen due to the way rustbuild is structured. There are currently two main stages of compilation in rustbuild, one for the standard library and one for the compiler. This is primarily done to allow us to fill in the sysroot right after the standard library has finished compiling to continue compiling the rest of the crates. Consequently the entire compiler does not have to explicitly depend on the standard library, and this also should allow us to pull in crates.io dependencies into the build in the future because they'll just naturally build against the std we just produced. These phases, however, do not represent a cross-compiled build. Target-only builds also require libtest, and libtest is currently part of the all-encompassing "compiler build". There's unfortunately no way to learn about just libtest and its dependencies (in a great and robust fashion) so to ensure that we can copy the right artifacts over this commit introduces a new build step, libtest. The new libtest build step has documentation, dist, and link steps as std/rustc already do. The compiler now depends on libtest instead of libstd, and all compiler crates can now assume that test and its dependencies are implicitly part of the sysroot (hence explicit dependencies being removed). This makes the build a tad less parallel as in theory many rustc crates can be compiled in parallel with libtest, but this likely isn't where we really need parallelism either (all the time is still spent in the compiler). All in all this allows the `dist-std` step to depend on both libstd and libtest, so `rust-std` packages produced by rustbuild should start having both the standard library and libtest. Closes #32523
2016-03-27 22:28:10 -07:00
#[derive(Serialize)]
pub struct Test<'a> {
stage: u32,
target: &'a str,
rustbuild: Fix dist for non-host targets The `rust-std` package that we produce is expected to have not only the standard library but also libtest for compiling unit tests. Unfortunately this does not currently happen due to the way rustbuild is structured. There are currently two main stages of compilation in rustbuild, one for the standard library and one for the compiler. This is primarily done to allow us to fill in the sysroot right after the standard library has finished compiling to continue compiling the rest of the crates. Consequently the entire compiler does not have to explicitly depend on the standard library, and this also should allow us to pull in crates.io dependencies into the build in the future because they'll just naturally build against the std we just produced. These phases, however, do not represent a cross-compiled build. Target-only builds also require libtest, and libtest is currently part of the all-encompassing "compiler build". There's unfortunately no way to learn about just libtest and its dependencies (in a great and robust fashion) so to ensure that we can copy the right artifacts over this commit introduces a new build step, libtest. The new libtest build step has documentation, dist, and link steps as std/rustc already do. The compiler now depends on libtest instead of libstd, and all compiler crates can now assume that test and its dependencies are implicitly part of the sysroot (hence explicit dependencies being removed). This makes the build a tad less parallel as in theory many rustc crates can be compiled in parallel with libtest, but this likely isn't where we really need parallelism either (all the time is still spent in the compiler). All in all this allows the `dist-std` step to depend on both libstd and libtest, so `rust-std` packages produced by rustbuild should start having both the standard library and libtest. Closes #32523
2016-03-27 22:28:10 -07:00
}
impl<'a> Step<'a> for Test<'a> {
type Output = ();
const DEFAULT: bool = true;
fn should_run(builder: &Builder, path: &Path) -> bool {
builder.crates("test").into_iter().any(|(_, krate_path)| {
path.ends_with(krate_path)
})
}
fn make_run(builder: &Builder, path: Option<&Path>, _host: &str, target: &str) {
let run = || {
builder.ensure(Test {
stage: builder.top_stage,
target
});
};
if let Some(path) = path {
for (_, krate_path) in builder.crates("test") {
if path.ends_with(krate_path) {
run();
}
}
} else {
if builder.build.config.docs {
run();
}
}
}
/// Compile all libtest documentation.
///
/// This will generate all documentation for libtest and its dependencies. This
/// is largely just a wrapper around `cargo doc`.
fn run(self, builder: &Builder) {
let build = builder.build;
let stage = self.stage;
let target = self.target;
println!("Documenting stage{} test ({})", stage, target);
let out = build.doc_out(target);
t!(fs::create_dir_all(&out));
let compiler = builder.compiler(stage, &build.build);
let compiler = if build.force_use_stage1(compiler, target) {
builder.compiler(1, compiler.host)
} else {
compiler
};
// Build libstd docs so that we generate relative links
builder.ensure(Std { stage, target });
builder.ensure(compile::Test { compiler, target });
let out_dir = build.stage_out(compiler, Mode::Libtest)
.join(target).join("doc");
let rustdoc = build.rustdoc(compiler);
// See docs in std above for why we symlink
let my_out = build.crate_doc_out(target);
build.clear_if_dirty(&my_out, &rustdoc);
t!(symlink_dir_force(&my_out, &out_dir));
let mut cargo = build.cargo(compiler, Mode::Libtest, target, "doc");
cargo.arg("--manifest-path")
.arg(build.src.join("src/libtest/Cargo.toml"));
build.run(&mut cargo);
cp_r(&my_out, &out);
}
}
2017-07-04 17:53:53 -06:00
// for (krate, path, default) in krates("rustc-main") {
// rules.doc(&krate.doc_step, path)
// .dep(|s| s.name("librustc-link"))
// // Needed so rustdoc generates relative links to std.
// .dep(|s| s.name("doc-crate-std"))
// .host(true)
// .default(default && build.config.docs)
// .run(move |s| doc::rustc(build, s.stage, s.target));
// }
//
#[derive(Serialize)]
pub struct Rustc<'a> {
stage: u32,
target: &'a str,
}
impl<'a> Step<'a> for Rustc<'a> {
type Output = ();
const DEFAULT: bool = true;
const ONLY_HOSTS: bool = true;
fn should_run(builder: &Builder, path: &Path) -> bool {
builder.crates("rustc-main").into_iter().any(|(_, krate_path)| {
path.ends_with(krate_path)
})
}
fn make_run(builder: &Builder, path: Option<&Path>, _host: &str, target: &str) {
let run = || {
builder.ensure(Rustc {
stage: builder.top_stage,
target
});
};
if let Some(path) = path {
for (_, krate_path) in builder.crates("rustc-main") {
if path.ends_with(krate_path) {
run();
}
}
} else {
if builder.build.config.compiler_docs {
run();
}
}
}
/// Generate all compiler documentation.
///
/// This will generate all documentation for the compiler libraries and their
/// dependencies. This is largely just a wrapper around `cargo doc`.
fn run(self, builder: &Builder) {
let build = builder.build;
let stage = self.stage;
let target = self.target;
println!("Documenting stage{} compiler ({})", stage, target);
let out = build.doc_out(target);
t!(fs::create_dir_all(&out));
let compiler = builder.compiler(stage, &build.build);
let compiler = if build.force_use_stage1(compiler, target) {
builder.compiler(1, compiler.host)
} else {
compiler
};
// Build libstd docs so that we generate relative links
builder.ensure(Std { stage, target });
builder.ensure(compile::Rustc { compiler, target });
let out_dir = build.stage_out(compiler, Mode::Librustc)
.join(target).join("doc");
let rustdoc = build.rustdoc(compiler);
// See docs in std above for why we symlink
let my_out = build.crate_doc_out(target);
build.clear_if_dirty(&my_out, &rustdoc);
t!(symlink_dir_force(&my_out, &out_dir));
let mut cargo = build.cargo(compiler, Mode::Librustc, target, "doc");
cargo.arg("--manifest-path")
.arg(build.src.join("src/rustc/Cargo.toml"))
.arg("--features").arg(build.rustc_features());
if build.config.compiler_docs {
// src/rustc/Cargo.toml contains bin crates called rustc and rustdoc
// which would otherwise overwrite the docs for the real rustc and
// rustdoc lib crates.
cargo.arg("-p").arg("rustc_driver")
.arg("-p").arg("rustdoc");
} else {
// Like with libstd above if compiler docs aren't enabled then we're not
// documenting internal dependencies, so we have a whitelist.
cargo.arg("--no-deps");
for krate in &["proc_macro"] {
cargo.arg("-p").arg(krate);
}
}
build.run(&mut cargo);
cp_r(&my_out, &out);
}
}
2017-07-04 17:53:53 -06:00
// rules.doc("doc-error-index", "src/tools/error_index_generator")
// .dep(move |s| s.name("tool-error-index").target(&build.build).stage(0))
// .dep(move |s| s.name("librustc-link"))
// .default(build.config.docs)
// .host(true)
// .run(move |s| doc::error_index(build, s.target));
#[derive(Serialize)]
pub struct ErrorIndex<'a> {
target: &'a str,
}
impl<'a> Step<'a> for ErrorIndex<'a> {
type Output = ();
const DEFAULT: bool = true;
const ONLY_HOSTS: bool = true;
fn should_run(_builder: &Builder, path: &Path) -> bool {
path.ends_with("src/tools/error_index_generator")
}
fn make_run(builder: &Builder, path: Option<&Path>, _host: &str, target: &str) {
if path.is_none() && !builder.build.config.docs {
// Not a default rule if docs are disabled.
return;
}
builder.ensure(ErrorIndex {
target,
});
}
/// Generates the HTML rendered error-index by running the
/// `error_index_generator` tool.
fn run(self, builder: &Builder) {
let build = builder.build;
let target = self.target;
builder.ensure(compile::Rustc {
compiler: builder.compiler(0, &build.build),
target,
});
println!("Documenting error index ({})", target);
let out = build.doc_out(target);
t!(fs::create_dir_all(&out));
let mut index = builder.tool_cmd(Tool::ErrorIndex);
index.arg("html");
index.arg(out.join("error-index.html"));
// FIXME: shouldn't have to pass this env var
index.env("CFG_BUILD", &build.build);
build.run(&mut index);
}
}
2017-07-04 17:53:53 -06:00
// rules.doc("doc-unstable-book-gen", "src/tools/unstable-book-gen")
// .dep(move |s| {
// s.name("tool-unstable-book-gen")
// .host(&build.build)
// .target(&build.build)
// .stage(0)
// })
// .dep(move |s| s.name("libstd-link"))
// .default(build.config.docs)
// .host(true)
// .run(move |s| doc::unstable_book_gen(build, s.target));
#[derive(Serialize)]
pub struct UnstableBookGen<'a> {
target: &'a str,
}
impl<'a> Step<'a> for UnstableBookGen<'a> {
type Output = ();
const DEFAULT: bool = true;
const ONLY_HOSTS: bool = true;
fn should_run(_builder: &Builder, path: &Path) -> bool {
path.ends_with("src/doc/unstable-book")
}
fn make_run(builder: &Builder, path: Option<&Path>, _host: &str, target: &str) {
if path.is_none() && !builder.build.config.docs {
// Not a default rule if docs are disabled.
return;
}
builder.ensure(UnstableBookGen {
target,
});
}
fn run(self, builder: &Builder) {
let build = builder.build;
let target = self.target;
builder.ensure(compile::Std {
compiler: builder.compiler(builder.top_stage, &build.build),
target,
});
println!("Generating unstable book md files ({})", target);
let out = build.md_doc_out(target).join("unstable-book");
t!(fs::create_dir_all(&out));
t!(fs::remove_dir_all(&out));
let mut cmd = builder.tool_cmd(Tool::UnstableBookGen);
cmd.arg(build.src.join("src"));
cmd.arg(out);
build.run(&mut cmd);
}
}
fn symlink_dir_force(src: &Path, dst: &Path) -> io::Result<()> {
if let Ok(m) = fs::symlink_metadata(dst) {
if m.file_type().is_dir() {
try!(fs::remove_dir_all(dst));
} else {
// handle directory junctions on windows by falling back to
// `remove_dir`.
try!(fs::remove_file(dst).or_else(|_| {
fs::remove_dir(dst)
}));
}
}
symlink_dir(src, dst)
}