1 //! Documentation generation for rustbuilder.
3 //! This module implements generation for all bits and pieces of documentation
4 //! for the Rust project. This notably includes suites like the rust book, the
5 //! nomicon, rust by example, standalone documentation, etc.
7 //! Everything here is basically just a shim around calling either `rustbook` or
13 use std::path::{Path, PathBuf};
15 use crate::builder::{Builder, Compiler, Kind, RunConfig, ShouldRun, Step};
16 use crate::cache::{Interned, INTERNER};
18 use crate::config::{Config, TargetSelection};
19 use crate::tool::{self, prepare_tool_cargo, SourceType, Tool};
20 use crate::util::{symlink_dir, t, up_to_date};
23 macro_rules! submodule_helper {
24 ($path:expr, submodule) => {
27 ($path:expr, submodule = $submodule:literal) => {
33 ($($name:ident, $path:expr, $book_name:expr $(, submodule $(= $submodule:literal)? )? ;)+) => {
35 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
37 target: TargetSelection,
42 const DEFAULT: bool = true;
44 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
45 let builder = run.builder;
46 run.path($path).default_condition(builder.config.docs)
49 fn make_run(run: RunConfig<'_>) {
50 run.builder.ensure($name {
55 fn run(self, builder: &Builder<'_>) {
57 let path = Path::new(submodule_helper!( $path, submodule $( = $submodule )? ));
58 builder.update_submodule(&path);
60 builder.ensure(RustbookSrc {
62 name: INTERNER.intern_str($book_name),
63 src: INTERNER.intern_path(builder.src.join($path)),
71 // NOTE: When adding a book here, make sure to ALSO build the book by
72 // adding a build step in `src/bootstrap/builder.rs`!
73 // NOTE: Make sure to add the corresponding submodule when adding a new book.
74 // FIXME: Make checking for a submodule automatic somehow (maybe by having a list of all submodules
75 // and checking against it?).
77 CargoBook, "src/tools/cargo/src/doc", "cargo", submodule = "src/tools/cargo";
78 ClippyBook, "src/tools/clippy/book", "clippy";
79 EditionGuide, "src/doc/edition-guide", "edition-guide", submodule;
80 EmbeddedBook, "src/doc/embedded-book", "embedded-book", submodule;
81 Nomicon, "src/doc/nomicon", "nomicon", submodule;
82 Reference, "src/doc/reference", "reference", submodule;
83 RustByExample, "src/doc/rust-by-example", "rust-by-example", submodule;
84 RustdocBook, "src/doc/rustdoc", "rustdoc";
85 StyleGuide, "src/doc/style-guide", "style-guide";
88 // "library/std" -> ["library", "std"]
90 // Used for deciding whether a particular step is one requested by the user on
91 // the `x.py doc` command line, which determines whether `--open` will open that
93 pub(crate) fn components_simplified(path: &PathBuf) -> Vec<&str> {
94 path.iter().map(|component| component.to_str().unwrap_or("???")).collect()
97 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
98 pub struct UnstableBook {
99 target: TargetSelection,
102 impl Step for UnstableBook {
104 const DEFAULT: bool = true;
106 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
107 let builder = run.builder;
108 run.path("src/doc/unstable-book").default_condition(builder.config.docs)
111 fn make_run(run: RunConfig<'_>) {
112 run.builder.ensure(UnstableBook { target: run.target });
115 fn run(self, builder: &Builder<'_>) {
116 builder.ensure(UnstableBookGen { target: self.target });
117 builder.ensure(RustbookSrc {
119 name: INTERNER.intern_str("unstable-book"),
120 src: INTERNER.intern_path(builder.md_doc_out(self.target).join("unstable-book")),
125 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
127 target: TargetSelection,
128 name: Interned<String>,
129 src: Interned<PathBuf>,
132 impl Step for RustbookSrc {
135 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
139 /// Invoke `rustbook` for `target` for the doc book `name` from the `src` path.
141 /// This will not actually generate any documentation if the documentation has
142 /// already been generated.
143 fn run(self, builder: &Builder<'_>) {
144 let target = self.target;
145 let name = self.name;
147 let out = builder.doc_out(target);
148 t!(fs::create_dir_all(&out));
150 let out = out.join(name);
151 let index = out.join("index.html");
152 let rustbook = builder.tool_exe(Tool::Rustbook);
153 let mut rustbook_cmd = builder.tool_cmd(Tool::Rustbook);
154 if builder.config.dry_run() || up_to_date(&src, &index) && up_to_date(&rustbook, &index) {
157 builder.info(&format!("Rustbook ({}) - {}", target, name));
158 let _ = fs::remove_dir_all(&out);
160 builder.run(rustbook_cmd.arg("build").arg(&src).arg("-d").arg(out));
164 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
167 target: TargetSelection,
170 impl Step for TheBook {
172 const DEFAULT: bool = true;
174 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
175 let builder = run.builder;
176 run.path("src/doc/book").default_condition(builder.config.docs)
179 fn make_run(run: RunConfig<'_>) {
180 run.builder.ensure(TheBook {
181 compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
186 /// Builds the book and associated stuff.
188 /// We need to build:
191 /// * Older edition redirects
192 /// * Version info and CSS
195 fn run(self, builder: &Builder<'_>) {
196 let relative_path = Path::new("src").join("doc").join("book");
197 builder.update_submodule(&relative_path);
199 let compiler = self.compiler;
200 let target = self.target;
203 builder.ensure(RustbookSrc {
205 name: INTERNER.intern_str("book"),
206 src: INTERNER.intern_path(builder.src.join(&relative_path)),
209 // building older edition redirects
210 for edition in &["first-edition", "second-edition", "2018-edition"] {
211 builder.ensure(RustbookSrc {
213 name: INTERNER.intern_string(format!("book/{}", edition)),
214 src: INTERNER.intern_path(builder.src.join(&relative_path).join(edition)),
218 // build the version info page and CSS
219 let shared_assets = builder.ensure(SharedAssets { target });
221 // build the redirect pages
222 builder.info(&format!("Documenting book redirect pages ({})", target));
223 for file in t!(fs::read_dir(builder.src.join(&relative_path).join("redirects"))) {
225 let path = file.path();
226 let path = path.to_str().unwrap();
228 invoke_rustdoc(builder, compiler, &shared_assets, target, path);
231 let out = builder.doc_out(target);
232 let index = out.join("book").join("index.html");
233 builder.maybe_open_in_browser::<Self>(index);
238 builder: &Builder<'_>,
240 shared_assets: &SharedAssetsPaths,
241 target: TargetSelection,
244 let out = builder.doc_out(target);
246 let path = builder.src.join("src/doc").join(markdown);
248 let header = builder.src.join("src/doc/redirect.inc");
249 let footer = builder.src.join("src/doc/footer.inc");
251 let mut cmd = builder.rustdoc_cmd(compiler);
253 let out = out.join("book");
255 cmd.arg("--html-after-content")
257 .arg("--html-before-content")
258 .arg(&shared_assets.version_info)
259 .arg("--html-in-header")
261 .arg("--markdown-no-toc")
262 .arg("--markdown-playground-url")
263 .arg("https://play.rust-lang.org/")
267 .arg("--markdown-css")
270 if !builder.config.docs_minification {
271 cmd.arg("-Z").arg("unstable-options").arg("--disable-minification");
274 builder.run(&mut cmd);
277 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
278 pub struct Standalone {
280 target: TargetSelection,
283 impl Step for Standalone {
285 const DEFAULT: bool = true;
287 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
288 let builder = run.builder;
289 run.path("src/doc").alias("standalone").default_condition(builder.config.docs)
292 fn make_run(run: RunConfig<'_>) {
293 run.builder.ensure(Standalone {
294 compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
299 /// Generates all standalone documentation as compiled by the rustdoc in `stage`
300 /// for the `target` into `out`.
302 /// This will list all of `src/doc` looking for markdown files and appropriately
303 /// perform transformations like substituting `VERSION`, `SHORT_HASH`, and
304 /// `STAMP` along with providing the various header/footer HTML we've customized.
306 /// In the end, this is just a glorified wrapper around rustdoc!
307 fn run(self, builder: &Builder<'_>) {
308 let target = self.target;
309 let compiler = self.compiler;
310 builder.info(&format!("Documenting standalone ({})", target));
311 let out = builder.doc_out(target);
312 t!(fs::create_dir_all(&out));
314 let version_info = builder.ensure(SharedAssets { target: self.target }).version_info;
316 let favicon = builder.src.join("src/doc/favicon.inc");
317 let footer = builder.src.join("src/doc/footer.inc");
318 let full_toc = builder.src.join("src/doc/full-toc.inc");
320 for file in t!(fs::read_dir(builder.src.join("src/doc"))) {
322 let path = file.path();
323 let filename = path.file_name().unwrap().to_str().unwrap();
324 if !filename.ends_with(".md") || filename == "README.md" {
328 let html = out.join(filename).with_extension("html");
329 let rustdoc = builder.rustdoc(compiler);
330 if up_to_date(&path, &html)
331 && up_to_date(&footer, &html)
332 && up_to_date(&favicon, &html)
333 && up_to_date(&full_toc, &html)
334 && (builder.config.dry_run() || up_to_date(&version_info, &html))
335 && (builder.config.dry_run() || up_to_date(&rustdoc, &html))
340 let mut cmd = builder.rustdoc_cmd(compiler);
341 // Needed for --index-page flag
342 cmd.arg("-Z").arg("unstable-options");
344 cmd.arg("--html-after-content")
346 .arg("--html-before-content")
348 .arg("--html-in-header")
350 .arg("--markdown-no-toc")
352 .arg(&builder.src.join("src/doc/index.md"))
353 .arg("--markdown-playground-url")
354 .arg("https://play.rust-lang.org/")
359 if !builder.config.docs_minification {
360 cmd.arg("--disable-minification");
363 if filename == "not_found.md" {
364 cmd.arg("--markdown-css").arg("https://doc.rust-lang.org/rust.css");
366 cmd.arg("--markdown-css").arg("rust.css");
368 builder.run(&mut cmd);
371 // We open doc/index.html as the default if invoked as `x.py doc --open`
372 // with no particular explicit doc requested (e.g. library/core).
373 if builder.paths.is_empty() || builder.was_invoked_explicitly::<Self>(Kind::Doc) {
374 let index = out.join("index.html");
375 builder.open_in_browser(&index);
380 #[derive(Debug, Clone)]
381 pub struct SharedAssetsPaths {
382 pub version_info: PathBuf,
385 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
386 pub struct SharedAssets {
387 target: TargetSelection,
390 impl Step for SharedAssets {
391 type Output = SharedAssetsPaths;
392 const DEFAULT: bool = false;
394 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
395 // Other tasks depend on this, no need to execute it on its own
399 // Generate shared resources used by other pieces of documentation.
400 fn run(self, builder: &Builder<'_>) -> Self::Output {
401 let out = builder.doc_out(self.target);
403 let version_input = builder.src.join("src").join("doc").join("version_info.html.template");
404 let version_info = out.join("version_info.html");
405 if !builder.config.dry_run() && !up_to_date(&version_input, &version_info) {
406 let info = t!(fs::read_to_string(&version_input))
407 .replace("VERSION", &builder.rust_release())
408 .replace("SHORT_HASH", builder.rust_info().sha_short().unwrap_or(""))
409 .replace("STAMP", builder.rust_info().sha().unwrap_or(""));
410 t!(fs::write(&version_info, &info));
413 builder.copy(&builder.src.join("src").join("doc").join("rust.css"), &out.join("rust.css"));
415 SharedAssetsPaths { version_info }
419 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
422 pub target: TargetSelection,
423 pub format: DocumentationFormat,
428 const DEFAULT: bool = true;
430 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
431 let builder = run.builder;
432 run.all_krates("test").path("library").default_condition(builder.config.docs)
435 fn make_run(run: RunConfig<'_>) {
436 run.builder.ensure(Std {
437 stage: run.builder.top_stage,
439 format: if run.builder.config.cmd.json() {
440 DocumentationFormat::JSON
442 DocumentationFormat::HTML
447 /// Compile all standard library documentation.
449 /// This will generate all documentation for the standard library and its
450 /// dependencies. This is largely just a wrapper around `cargo doc`.
451 fn run(self, builder: &Builder<'_>) {
452 let stage = self.stage;
453 let target = self.target;
454 let out = match self.format {
455 DocumentationFormat::HTML => builder.doc_out(target),
456 DocumentationFormat::JSON => builder.json_doc_out(target),
459 t!(fs::create_dir_all(&out));
461 if self.format == DocumentationFormat::HTML {
462 builder.ensure(SharedAssets { target: self.target });
465 let index_page = builder.src.join("src/doc/index.md").into_os_string();
466 let mut extra_args = match self.format {
467 DocumentationFormat::HTML => vec![
468 OsStr::new("--markdown-css"),
469 OsStr::new("rust.css"),
470 OsStr::new("--markdown-no-toc"),
471 OsStr::new("--index-page"),
474 DocumentationFormat::JSON => vec![OsStr::new("--output-format"), OsStr::new("json")],
477 if !builder.config.docs_minification {
478 extra_args.push(OsStr::new("--disable-minification"));
481 let requested_crates = builder
484 .map(components_simplified)
486 if path.len() >= 2 && path.get(0) == Some(&"library") {
488 Some(path[1].to_owned())
489 } else if !path.is_empty() {
491 Some(path[0].to_owned())
493 // all library crates
497 .collect::<Vec<_>>();
499 doc_std(builder, self.format, stage, target, &out, &extra_args, &requested_crates);
501 // Don't open if the format is json
502 if let DocumentationFormat::JSON = self.format {
506 // Look for library/std, library/core etc in the `x.py doc` arguments and
507 // open the corresponding rendered docs.
508 for requested_crate in requested_crates {
509 if STD_PUBLIC_CRATES.iter().any(|k| *k == requested_crate.as_str()) {
510 let index = out.join(requested_crate).join("index.html");
511 builder.open_in_browser(index);
517 /// Name of the crates that are visible to consumers of the standard library.
518 /// Documentation for internal crates is handled by the rustc step, so internal crates will show
521 /// Order here is important!
522 /// Crates need to be processed starting from the leaves, otherwise rustdoc will not
523 /// create correct links between crates because rustdoc depends on the
524 /// existence of the output directories to know if it should be a local
526 const STD_PUBLIC_CRATES: [&str; 5] = ["core", "alloc", "std", "proc_macro", "test"];
528 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
529 pub enum DocumentationFormat {
534 impl DocumentationFormat {
535 fn as_str(&self) -> &str {
537 DocumentationFormat::HTML => "HTML",
538 DocumentationFormat::JSON => "JSON",
543 /// Build the documentation for public standard library crates.
545 /// `requested_crates` can be used to build only a subset of the crates. If empty, all crates will
548 builder: &Builder<'_>,
549 format: DocumentationFormat,
551 target: TargetSelection,
553 extra_args: &[&OsStr],
554 requested_crates: &[String],
556 builder.info(&format!(
557 "Documenting stage{} std ({}) in {} format",
562 if builder.no_std(target) == Some(true) {
564 "building std documentation for no_std target {target} is not supported\n\
565 Set `docs = false` in the config to disable documentation."
568 let compiler = builder.compiler(stage, builder.config.build);
570 let target_doc_dir_name = if format == DocumentationFormat::JSON { "json-doc" } else { "doc" };
572 builder.stage_out(compiler, Mode::Std).join(target.triple).join(target_doc_dir_name);
574 // This is directory where the compiler will place the output of the command.
575 // We will then copy the files from this directory into the final `out` directory, the specified
576 // as a function parameter.
577 let out_dir = target_dir.join(target.triple).join("doc");
579 let run_cargo_rustdoc_for = |package: &str| {
580 let mut cargo = builder.cargo(compiler, Mode::Std, SourceType::InTree, target, "rustdoc");
581 compile::std_cargo(builder, target, compiler.stage, &mut cargo);
584 .arg(&*target_dir.to_string_lossy())
587 .arg("-Zskip-rustdoc-fingerprint")
590 .arg("unstable-options")
591 .arg("--resource-suffix")
592 .arg(&builder.version)
594 builder.run(&mut cargo.into());
597 for krate in STD_PUBLIC_CRATES {
598 run_cargo_rustdoc_for(krate);
599 if requested_crates.iter().any(|p| p == krate) {
600 // No need to document more of the libraries if we have the one we want.
605 builder.cp_r(&out_dir, &out);
608 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
611 pub target: TargetSelection,
614 impl Step for Rustc {
616 const DEFAULT: bool = true;
617 const ONLY_HOSTS: bool = true;
619 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
620 let builder = run.builder;
621 run.crate_or_deps("rustc-main")
623 .default_condition(builder.config.compiler_docs)
626 fn make_run(run: RunConfig<'_>) {
627 run.builder.ensure(Rustc { stage: run.builder.top_stage, target: run.target });
630 /// Generates compiler documentation.
632 /// This will generate all documentation for compiler and dependencies.
633 /// Compiler documentation is distributed separately, so we make sure
634 /// we do not merge it with the other documentation from std, test and
635 /// proc_macros. This is largely just a wrapper around `cargo doc`.
636 fn run(self, builder: &Builder<'_>) {
637 let stage = self.stage;
638 let target = self.target;
644 let components = components_simplified(path);
645 components.len() >= 2 && components[0] == "compiler"
647 .collect::<Vec<_>>();
649 // This is the intended out directory for compiler documentation.
650 let out = builder.compiler_doc_out(target);
651 t!(fs::create_dir_all(&out));
653 // Build the standard library, so that proc-macros can use it.
654 // (Normally, only the metadata would be necessary, but proc-macros are special since they run at compile-time.)
655 let compiler = builder.compiler(stage, builder.config.build);
656 builder.ensure(compile::Std::new(compiler, builder.config.build));
658 builder.info(&format!("Documenting stage{} compiler ({})", stage, target));
660 // This uses a shared directory so that librustdoc documentation gets
661 // correctly built and merged with the rustc documentation. This is
662 // needed because rustdoc is built in a different directory from
663 // rustc. rustdoc needs to be able to see everything, for example when
664 // merging the search index, or generating local (relative) links.
665 let out_dir = builder.stage_out(compiler, Mode::Rustc).join(target.triple).join("doc");
666 t!(symlink_dir_force(&builder.config, &out, &out_dir));
667 // Cargo puts proc macros in `target/doc` even if you pass `--target`
668 // explicitly (https://github.com/rust-lang/cargo/issues/7677).
669 let proc_macro_out_dir = builder.stage_out(compiler, Mode::Rustc).join("doc");
670 t!(symlink_dir_force(&builder.config, &out, &proc_macro_out_dir));
672 // Build cargo command.
673 let mut cargo = builder.cargo(compiler, Mode::Rustc, SourceType::InTree, target, "doc");
674 cargo.rustdocflag("--document-private-items");
675 // Since we always pass --document-private-items, there's no need to warn about linking to private items.
676 cargo.rustdocflag("-Arustdoc::private-intra-doc-links");
677 cargo.rustdocflag("--enable-index-page");
678 cargo.rustdocflag("-Zunstable-options");
679 cargo.rustdocflag("-Znormalize-docs");
680 cargo.rustdocflag("--show-type-layout");
681 cargo.rustdocflag("--generate-link-to-definition");
682 compile::rustc_cargo(builder, &mut cargo, target);
683 cargo.arg("-Zunstable-options");
684 cargo.arg("-Zskip-rustdoc-fingerprint");
686 // Only include compiler crates, no dependencies of those, such as `libc`.
687 // Do link to dependencies on `docs.rs` however using `rustdoc-map`.
688 cargo.arg("--no-deps");
689 cargo.arg("-Zrustdoc-map");
691 // FIXME: `-Zrustdoc-map` does not yet correctly work for transitive dependencies,
692 // once this is no longer an issue the special case for `ena` can be removed.
693 cargo.rustdocflag("--extern-html-root-url");
694 cargo.rustdocflag("ena=https://docs.rs/ena/latest/");
696 let root_crates = if paths.is_empty() {
698 INTERNER.intern_str("rustc_driver"),
699 INTERNER.intern_str("rustc_codegen_llvm"),
700 INTERNER.intern_str("rustc_codegen_ssa"),
703 paths.into_iter().map(|p| builder.crate_paths[p]).collect()
705 // Find dependencies for top level crates.
706 let compiler_crates = root_crates.iter().flat_map(|krate| {
707 builder.in_tree_crates(krate, Some(target)).into_iter().map(|krate| krate.name)
710 let mut to_open = None;
711 for krate in compiler_crates {
712 // Create all crate output directories first to make sure rustdoc uses
714 // FIXME: Cargo should probably do this itself.
715 t!(fs::create_dir_all(out_dir.join(krate)));
716 cargo.arg("-p").arg(krate);
717 if to_open.is_none() {
718 to_open = Some(krate);
722 builder.run(&mut cargo.into());
723 // Let's open the first crate documentation page:
724 if let Some(krate) = to_open {
725 let index = out.join(krate).join("index.html");
726 builder.open_in_browser(index);
731 macro_rules! tool_doc {
732 ($tool: ident, $should_run: literal, $path: literal, [$($krate: literal),+ $(,)?] $(,)?) => {
733 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
735 target: TargetSelection,
738 impl Step for $tool {
740 const DEFAULT: bool = true;
741 const ONLY_HOSTS: bool = true;
743 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
744 let builder = run.builder;
745 run.crate_or_deps($should_run).default_condition(builder.config.compiler_docs)
748 fn make_run(run: RunConfig<'_>) {
749 run.builder.ensure($tool { target: run.target });
752 /// Generates compiler documentation.
754 /// This will generate all documentation for compiler and dependencies.
755 /// Compiler documentation is distributed separately, so we make sure
756 /// we do not merge it with the other documentation from std, test and
757 /// proc_macros. This is largely just a wrapper around `cargo doc`.
758 fn run(self, builder: &Builder<'_>) {
759 let stage = builder.top_stage;
760 let target = self.target;
762 // This is the intended out directory for compiler documentation.
763 let out = builder.compiler_doc_out(target);
764 t!(fs::create_dir_all(&out));
766 // Build rustc docs so that we generate relative links.
767 builder.ensure(Rustc { stage, target });
768 // Rustdoc needs the rustc sysroot available to build.
769 // FIXME: is there a way to only ensure `check::Rustc` here? Last time I tried it failed
770 // with strange errors, but only on a full bors test ...
771 let compiler = builder.compiler(stage, builder.config.build);
772 builder.ensure(compile::Rustc::new(compiler, target));
776 "Documenting stage{} {} ({})",
778 stringify!($tool).to_lowercase(),
783 // Symlink compiler docs to the output directory of rustdoc documentation.
784 let out_dir = builder.stage_out(compiler, Mode::ToolRustc).join(target.triple).join("doc");
785 t!(fs::create_dir_all(&out_dir));
786 t!(symlink_dir_force(&builder.config, &out, &out_dir));
788 // Build cargo command.
789 let mut cargo = prepare_tool_cargo(
800 cargo.arg("-Zskip-rustdoc-fingerprint");
801 // Only include compiler crates, no dependencies of those, such as `libc`.
802 cargo.arg("--no-deps");
804 cargo.arg("-p").arg($krate);
807 cargo.rustdocflag("--document-private-items");
808 cargo.rustdocflag("--enable-index-page");
809 cargo.rustdocflag("--show-type-layout");
810 cargo.rustdocflag("--generate-link-to-definition");
811 cargo.rustdocflag("-Zunstable-options");
812 builder.run(&mut cargo.into());
818 tool_doc!(Rustdoc, "rustdoc-tool", "src/tools/rustdoc", ["rustdoc", "rustdoc-json-types"],);
823 ["rustfmt-nightly", "rustfmt-config_proc_macro"],
825 tool_doc!(Clippy, "clippy", "src/tools/clippy", ["clippy_utils"]);
826 tool_doc!(Miri, "miri", "src/tools/miri", ["miri"]);
828 #[derive(Ord, PartialOrd, Debug, Copy, Clone, Hash, PartialEq, Eq)]
829 pub struct ErrorIndex {
830 pub target: TargetSelection,
833 impl Step for ErrorIndex {
835 const DEFAULT: bool = true;
836 const ONLY_HOSTS: bool = true;
838 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
839 let builder = run.builder;
840 run.path("src/tools/error_index_generator").default_condition(builder.config.docs)
843 fn make_run(run: RunConfig<'_>) {
844 let target = run.target;
845 run.builder.ensure(ErrorIndex { target });
848 /// Generates the HTML rendered error-index by running the
849 /// `error_index_generator` tool.
850 fn run(self, builder: &Builder<'_>) {
851 builder.info(&format!("Documenting error index ({})", self.target));
852 let out = builder.doc_out(self.target);
853 t!(fs::create_dir_all(&out));
854 let mut index = tool::ErrorIndex::command(builder);
857 index.arg(&builder.version);
859 builder.run(&mut index);
863 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
864 pub struct UnstableBookGen {
865 target: TargetSelection,
868 impl Step for UnstableBookGen {
870 const DEFAULT: bool = true;
871 const ONLY_HOSTS: bool = true;
873 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
874 let builder = run.builder;
875 run.path("src/tools/unstable-book-gen").default_condition(builder.config.docs)
878 fn make_run(run: RunConfig<'_>) {
879 run.builder.ensure(UnstableBookGen { target: run.target });
882 fn run(self, builder: &Builder<'_>) {
883 let target = self.target;
885 builder.info(&format!("Generating unstable book md files ({})", target));
886 let out = builder.md_doc_out(target).join("unstable-book");
887 builder.create_dir(&out);
888 builder.remove_dir(&out);
889 let mut cmd = builder.tool_cmd(Tool::UnstableBookGen);
890 cmd.arg(builder.src.join("library"));
891 cmd.arg(builder.src.join("compiler"));
892 cmd.arg(builder.src.join("src"));
895 builder.run(&mut cmd);
899 fn symlink_dir_force(config: &Config, src: &Path, dst: &Path) -> io::Result<()> {
900 if config.dry_run() {
903 if let Ok(m) = fs::symlink_metadata(dst) {
904 if m.file_type().is_dir() {
905 fs::remove_dir_all(dst)?;
907 // handle directory junctions on windows by falling back to
909 fs::remove_file(dst).or_else(|_| fs::remove_dir(dst))?;
913 symlink_dir(config, src, dst)
916 #[derive(Ord, PartialOrd, Debug, Copy, Clone, Hash, PartialEq, Eq)]
917 pub struct RustcBook {
918 pub compiler: Compiler,
919 pub target: TargetSelection,
923 impl Step for RustcBook {
925 const DEFAULT: bool = true;
926 const ONLY_HOSTS: bool = true;
928 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
929 let builder = run.builder;
930 run.path("src/doc/rustc").default_condition(builder.config.docs)
933 fn make_run(run: RunConfig<'_>) {
934 run.builder.ensure(RustcBook {
935 compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
941 /// Builds the rustc book.
943 /// The lints are auto-generated by a tool, and then merged into the book
944 /// in the "md-doc" directory in the build output directory. Then
945 /// "rustbook" is used to convert it to HTML.
946 fn run(self, builder: &Builder<'_>) {
947 let out_base = builder.md_doc_out(self.target).join("rustc");
948 t!(fs::create_dir_all(&out_base));
949 let out_listing = out_base.join("src/lints");
950 builder.cp_r(&builder.src.join("src/doc/rustc"), &out_base);
951 builder.info(&format!("Generating lint docs ({})", self.target));
953 let rustc = builder.rustc(self.compiler);
954 // The tool runs `rustc` for extracting output examples, so it needs a
955 // functional sysroot.
956 builder.ensure(compile::Std::new(self.compiler, self.target));
957 let mut cmd = builder.tool_cmd(Tool::LintDocs);
959 cmd.arg(builder.src.join("compiler"));
961 cmd.arg(&out_listing);
964 cmd.arg("--rustc-target").arg(&self.target.rustc_target_arg());
965 if builder.is_verbose() {
966 cmd.arg("--verbose");
969 cmd.arg("--validate");
971 if !builder.unstable_features() {
972 // We need to validate nightly features, even on the stable channel.
973 cmd.env("RUSTC_BOOTSTRAP", "1");
975 // If the lib directories are in an unusual location (changed in
976 // config.toml), then this needs to explicitly update the dylib search
978 builder.add_rustc_lib_path(self.compiler, &mut cmd);
979 builder.run(&mut cmd);
980 // Run rustbook/mdbook to generate the HTML pages.
981 builder.ensure(RustbookSrc {
983 name: INTERNER.intern_str("rustc"),
984 src: INTERNER.intern_path(out_base),
987 let out = builder.doc_out(self.target);
988 let index = out.join("rustc").join("index.html");
989 builder.maybe_open_in_browser::<Self>(index);