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
10 use std::collections::HashSet;
13 use std::path::{Path, PathBuf};
16 use build_helper::{t, up_to_date};
18 use crate::builder::{Builder, Compiler, RunConfig, ShouldRun, Step};
19 use crate::cache::{Interned, INTERNER};
21 use crate::config::{Config, TargetSelection};
22 use crate::tool::{self, prepare_tool_cargo, SourceType, Tool};
23 use crate::util::symlink_dir;
26 ($($name:ident, $path:expr, $book_name:expr;)+) => {
28 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
30 target: TargetSelection,
35 const DEFAULT: bool = true;
37 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
38 let builder = run.builder;
39 run.path($path).default_condition(builder.config.docs)
42 fn make_run(run: RunConfig<'_>) {
43 run.builder.ensure($name {
48 fn run(self, builder: &Builder<'_>) {
49 builder.ensure(RustbookSrc {
51 name: INTERNER.intern_str($book_name),
52 src: INTERNER.intern_path(builder.src.join($path)),
60 // NOTE: When adding a book here, make sure to ALSO build the book by
61 // adding a build step in `src/bootstrap/builder.rs`!
63 CargoBook, "src/tools/cargo/src/doc", "cargo";
64 EditionGuide, "src/doc/edition-guide", "edition-guide";
65 EmbeddedBook, "src/doc/embedded-book", "embedded-book";
66 Nomicon, "src/doc/nomicon", "nomicon";
67 Reference, "src/doc/reference", "reference";
68 RustByExample, "src/doc/rust-by-example", "rust-by-example";
69 RustdocBook, "src/doc/rustdoc", "rustdoc";
72 fn open(builder: &Builder<'_>, path: impl AsRef<Path>) {
73 if builder.config.dry_run || !builder.config.cmd.open() {
77 let path = path.as_ref();
78 builder.info(&format!("Opening doc {}", path.display()));
79 if let Err(err) = opener::open(path) {
80 builder.info(&format!("{}\n", err));
84 // "library/std" -> ["library", "std"]
86 // Used for deciding whether a particular step is one requested by the user on
87 // the `x.py doc` command line, which determines whether `--open` will open that
89 fn components_simplified(path: &PathBuf) -> Vec<&str> {
90 path.iter().map(|component| component.to_str().unwrap_or("???")).collect()
93 fn is_explicit_request(builder: &Builder<'_>, path: &str) -> bool {
97 .map(components_simplified)
98 .any(|requested| requested.iter().copied().eq(path.split('/')))
101 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
102 pub struct UnstableBook {
103 target: TargetSelection,
106 impl Step for UnstableBook {
108 const DEFAULT: bool = true;
110 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
111 let builder = run.builder;
112 run.path("src/doc/unstable-book").default_condition(builder.config.docs)
115 fn make_run(run: RunConfig<'_>) {
116 run.builder.ensure(UnstableBook { target: run.target });
119 fn run(self, builder: &Builder<'_>) {
120 builder.ensure(UnstableBookGen { target: self.target });
121 builder.ensure(RustbookSrc {
123 name: INTERNER.intern_str("unstable-book"),
124 src: INTERNER.intern_path(builder.md_doc_out(self.target).join("unstable-book")),
129 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
131 target: TargetSelection,
132 name: Interned<String>,
133 src: Interned<PathBuf>,
136 impl Step for RustbookSrc {
139 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
143 /// Invoke `rustbook` for `target` for the doc book `name` from the `src` path.
145 /// This will not actually generate any documentation if the documentation has
146 /// already been generated.
147 fn run(self, builder: &Builder<'_>) {
148 let target = self.target;
149 let name = self.name;
151 let out = builder.doc_out(target);
152 t!(fs::create_dir_all(&out));
154 let out = out.join(name);
155 let index = out.join("index.html");
156 let rustbook = builder.tool_exe(Tool::Rustbook);
157 let mut rustbook_cmd = builder.tool_cmd(Tool::Rustbook);
158 if builder.config.dry_run || up_to_date(&src, &index) && up_to_date(&rustbook, &index) {
161 builder.info(&format!("Rustbook ({}) - {}", target, name));
162 let _ = fs::remove_dir_all(&out);
164 builder.run(rustbook_cmd.arg("build").arg(&src).arg("-d").arg(out));
168 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
171 target: TargetSelection,
174 impl Step for TheBook {
176 const DEFAULT: bool = true;
178 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
179 let builder = run.builder;
180 run.path("src/doc/book").default_condition(builder.config.docs)
183 fn make_run(run: RunConfig<'_>) {
184 run.builder.ensure(TheBook {
185 compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
190 /// Builds the book and associated stuff.
192 /// We need to build:
195 /// * Older edition redirects
196 /// * Version info and CSS
199 fn run(self, builder: &Builder<'_>) {
200 let compiler = self.compiler;
201 let target = self.target;
204 builder.ensure(RustbookSrc {
206 name: INTERNER.intern_str("book"),
207 src: INTERNER.intern_path(builder.src.join("src/doc/book")),
210 // building older edition redirects
211 for edition in &["first-edition", "second-edition", "2018-edition"] {
212 builder.ensure(RustbookSrc {
214 name: INTERNER.intern_string(format!("book/{}", edition)),
215 src: INTERNER.intern_path(builder.src.join("src/doc/book").join(edition)),
219 // build the version info page and CSS
220 builder.ensure(Standalone { compiler, target });
222 // build the redirect pages
223 builder.info(&format!("Documenting book redirect pages ({})", target));
224 for file in t!(fs::read_dir(builder.src.join("src/doc/book/redirects"))) {
226 let path = file.path();
227 let path = path.to_str().unwrap();
229 invoke_rustdoc(builder, compiler, target, path);
232 if is_explicit_request(builder, "src/doc/book") {
233 let out = builder.doc_out(target);
234 let index = out.join("book").join("index.html");
235 open(builder, &index);
241 builder: &Builder<'_>,
243 target: TargetSelection,
246 let out = builder.doc_out(target);
248 let path = builder.src.join("src/doc").join(markdown);
250 let header = builder.src.join("src/doc/redirect.inc");
251 let footer = builder.src.join("src/doc/footer.inc");
252 let version_info = out.join("version_info.html");
254 let mut cmd = builder.rustdoc_cmd(compiler);
256 let out = out.join("book");
258 cmd.arg("--html-after-content")
260 .arg("--html-before-content")
262 .arg("--html-in-header")
264 .arg("--markdown-no-toc")
265 .arg("--markdown-playground-url")
266 .arg("https://play.rust-lang.org/")
270 .arg("--markdown-css")
273 if !builder.config.docs_minification {
274 cmd.arg("-Z").arg("unstable-options").arg("--disable-minification");
277 builder.run(&mut cmd);
280 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
281 pub struct Standalone {
283 target: TargetSelection,
286 impl Step for Standalone {
288 const DEFAULT: bool = true;
290 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
291 let builder = run.builder;
292 run.path("src/doc").default_condition(builder.config.docs)
295 fn make_run(run: RunConfig<'_>) {
296 run.builder.ensure(Standalone {
297 compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
302 /// Generates all standalone documentation as compiled by the rustdoc in `stage`
303 /// for the `target` into `out`.
305 /// This will list all of `src/doc` looking for markdown files and appropriately
306 /// perform transformations like substituting `VERSION`, `SHORT_HASH`, and
307 /// `STAMP` along with providing the various header/footer HTML we've customized.
309 /// In the end, this is just a glorified wrapper around rustdoc!
310 fn run(self, builder: &Builder<'_>) {
311 let target = self.target;
312 let compiler = self.compiler;
313 builder.info(&format!("Documenting standalone ({})", target));
314 let out = builder.doc_out(target);
315 t!(fs::create_dir_all(&out));
317 let favicon = builder.src.join("src/doc/favicon.inc");
318 let footer = builder.src.join("src/doc/footer.inc");
319 let full_toc = builder.src.join("src/doc/full-toc.inc");
320 t!(fs::copy(builder.src.join("src/doc/rust.css"), out.join("rust.css")));
322 let version_input = builder.src.join("src/doc/version_info.html.template");
323 let version_info = out.join("version_info.html");
325 if !builder.config.dry_run && !up_to_date(&version_input, &version_info) {
326 let info = t!(fs::read_to_string(&version_input))
327 .replace("VERSION", &builder.rust_release())
328 .replace("SHORT_HASH", builder.rust_info.sha_short().unwrap_or(""))
329 .replace("STAMP", builder.rust_info.sha().unwrap_or(""));
330 t!(fs::write(&version_info, &info));
333 for file in t!(fs::read_dir(builder.src.join("src/doc"))) {
335 let path = file.path();
336 let filename = path.file_name().unwrap().to_str().unwrap();
337 if !filename.ends_with(".md") || filename == "README.md" {
341 let html = out.join(filename).with_extension("html");
342 let rustdoc = builder.rustdoc(compiler);
343 if up_to_date(&path, &html)
344 && up_to_date(&footer, &html)
345 && up_to_date(&favicon, &html)
346 && up_to_date(&full_toc, &html)
347 && (builder.config.dry_run || up_to_date(&version_info, &html))
348 && (builder.config.dry_run || up_to_date(&rustdoc, &html))
353 let mut cmd = builder.rustdoc_cmd(compiler);
354 // Needed for --index-page flag
355 cmd.arg("-Z").arg("unstable-options");
357 cmd.arg("--html-after-content")
359 .arg("--html-before-content")
361 .arg("--html-in-header")
363 .arg("--markdown-no-toc")
365 .arg(&builder.src.join("src/doc/index.md"))
366 .arg("--markdown-playground-url")
367 .arg("https://play.rust-lang.org/")
372 if !builder.config.docs_minification {
373 cmd.arg("--disable-minification");
376 if filename == "not_found.md" {
377 cmd.arg("--markdown-css").arg("https://doc.rust-lang.org/rust.css");
379 cmd.arg("--markdown-css").arg("rust.css");
381 builder.run(&mut cmd);
384 // We open doc/index.html as the default if invoked as `x.py doc --open`
385 // with no particular explicit doc requested (e.g. library/core).
386 if builder.paths.is_empty() || is_explicit_request(builder, "src/doc") {
387 let index = out.join("index.html");
388 open(builder, &index);
393 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
396 pub target: TargetSelection,
401 const DEFAULT: bool = true;
403 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
404 let builder = run.builder;
405 run.all_krates("test").default_condition(builder.config.docs)
408 fn make_run(run: RunConfig<'_>) {
409 run.builder.ensure(Std { stage: run.builder.top_stage, target: run.target });
412 /// Compile all standard library documentation.
414 /// This will generate all documentation for the standard library and its
415 /// dependencies. This is largely just a wrapper around `cargo doc`.
416 fn run(self, builder: &Builder<'_>) {
417 let stage = self.stage;
418 let target = self.target;
419 builder.info(&format!("Documenting stage{} std ({})", stage, target));
420 let out = builder.doc_out(target);
421 t!(fs::create_dir_all(&out));
422 let compiler = builder.compiler(stage, builder.config.build);
424 builder.ensure(compile::Std { compiler, target });
425 let out_dir = builder.stage_out(compiler, Mode::Std).join(target.triple).join("doc");
427 t!(fs::copy(builder.src.join("src/doc/rust.css"), out.join("rust.css")));
429 let run_cargo_rustdoc_for = |package: &str| {
431 builder.cargo(compiler, Mode::Std, SourceType::InTree, target, "rustdoc");
432 compile::std_cargo(builder, target, compiler.stage, &mut cargo);
438 .arg("--markdown-css")
440 .arg("--markdown-no-toc")
442 .arg("unstable-options")
443 .arg("--resource-suffix")
444 .arg(&builder.version)
446 .arg(&builder.src.join("src/doc/index.md"));
448 if !builder.config.docs_minification {
449 cargo.arg("--disable-minification");
452 builder.run(&mut cargo.into());
454 // Only build the following crates. While we could just iterate over the
455 // folder structure, that would also build internal crates that we do
456 // not want to show in documentation. These crates will later be visited
457 // by the rustc step, so internal documentation will show them.
459 // Note that the order here is important! The crates need to be
460 // processed starting from the leaves, otherwise rustdoc will not
461 // create correct links between crates because rustdoc depends on the
462 // existence of the output directories to know if it should be a local
464 let krates = ["core", "alloc", "std", "proc_macro", "test"];
465 for krate in &krates {
466 run_cargo_rustdoc_for(krate);
468 builder.cp_r(&out_dir, &out);
470 // Look for library/std, library/core etc in the `x.py doc` arguments and
471 // open the corresponding rendered docs.
472 for path in builder.paths.iter().map(components_simplified) {
473 if path.get(0) == Some(&"library") {
474 let requested_crate = &path[1];
475 if krates.contains(&requested_crate) {
476 let index = out.join(requested_crate).join("index.html");
477 open(builder, &index);
484 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
487 target: TargetSelection,
490 impl Step for Rustc {
492 const DEFAULT: bool = true;
493 const ONLY_HOSTS: bool = true;
495 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
496 let builder = run.builder;
497 run.krate("rustc-main").default_condition(builder.config.docs)
500 fn make_run(run: RunConfig<'_>) {
501 run.builder.ensure(Rustc { stage: run.builder.top_stage, target: run.target });
504 /// Generates compiler documentation.
506 /// This will generate all documentation for compiler and dependencies.
507 /// Compiler documentation is distributed separately, so we make sure
508 /// we do not merge it with the other documentation from std, test and
509 /// proc_macros. This is largely just a wrapper around `cargo doc`.
510 fn run(self, builder: &Builder<'_>) {
511 let stage = self.stage;
512 let target = self.target;
513 builder.info(&format!("Documenting stage{} compiler ({})", stage, target));
515 if !builder.config.compiler_docs {
516 builder.info("\tskipping - compiler/librustdoc docs disabled");
520 // This is the intended out directory for compiler documentation.
521 let out = builder.compiler_doc_out(target);
522 t!(fs::create_dir_all(&out));
525 let compiler = builder.compiler(stage, builder.config.build);
526 builder.ensure(compile::Rustc { compiler, target });
528 // This uses a shared directory so that librustdoc documentation gets
529 // correctly built and merged with the rustc documentation. This is
530 // needed because rustdoc is built in a different directory from
531 // rustc. rustdoc needs to be able to see everything, for example when
532 // merging the search index, or generating local (relative) links.
533 let out_dir = builder.stage_out(compiler, Mode::Rustc).join(target.triple).join("doc");
534 t!(symlink_dir_force(&builder.config, &out, &out_dir));
535 // Cargo puts proc macros in `target/doc` even if you pass `--target`
536 // explicitly (https://github.com/rust-lang/cargo/issues/7677).
537 let proc_macro_out_dir = builder.stage_out(compiler, Mode::Rustc).join("doc");
538 t!(symlink_dir_force(&builder.config, &out, &proc_macro_out_dir));
540 // Build cargo command.
541 let mut cargo = builder.cargo(compiler, Mode::Rustc, SourceType::InTree, target, "doc");
542 cargo.rustdocflag("--document-private-items");
543 cargo.rustdocflag("--enable-index-page");
544 cargo.rustdocflag("-Zunstable-options");
545 cargo.rustdocflag("-Znormalize-docs");
546 compile::rustc_cargo(builder, &mut cargo, target);
548 // Only include compiler crates, no dependencies of those, such as `libc`.
549 cargo.arg("--no-deps");
551 // Find dependencies for top level crates.
552 let mut compiler_crates = HashSet::new();
553 for root_crate in &["rustc_driver", "rustc_codegen_llvm", "rustc_codegen_ssa"] {
554 compiler_crates.extend(
556 .in_tree_crates(root_crate, Some(target))
558 .map(|krate| krate.name),
562 for krate in &compiler_crates {
563 // Create all crate output directories first to make sure rustdoc uses
565 // FIXME: Cargo should probably do this itself.
566 t!(fs::create_dir_all(out_dir.join(krate)));
567 cargo.arg("-p").arg(krate);
570 builder.run(&mut cargo.into());
574 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
577 target: TargetSelection,
580 impl Step for Rustdoc {
582 const DEFAULT: bool = true;
583 const ONLY_HOSTS: bool = true;
585 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
586 run.krate("rustdoc-tool")
589 fn make_run(run: RunConfig<'_>) {
590 run.builder.ensure(Rustdoc { stage: run.builder.top_stage, target: run.target });
593 /// Generates compiler documentation.
595 /// This will generate all documentation for compiler and dependencies.
596 /// Compiler documentation is distributed separately, so we make sure
597 /// we do not merge it with the other documentation from std, test and
598 /// proc_macros. This is largely just a wrapper around `cargo doc`.
599 fn run(self, builder: &Builder<'_>) {
600 let stage = self.stage;
601 let target = self.target;
602 builder.info(&format!("Documenting stage{} rustdoc ({})", stage, target));
604 // This is the intended out directory for compiler documentation.
605 let out = builder.compiler_doc_out(target);
606 t!(fs::create_dir_all(&out));
608 let compiler = builder.compiler(stage, builder.config.build);
610 if !builder.config.compiler_docs {
611 builder.info("\tskipping - compiler/librustdoc docs disabled");
615 // Build rustc docs so that we generate relative links.
616 builder.ensure(Rustc { stage, target });
619 builder.ensure(tool::Rustdoc { compiler });
621 // Symlink compiler docs to the output directory of rustdoc documentation.
622 let out_dir = builder.stage_out(compiler, Mode::ToolRustc).join(target.triple).join("doc");
623 t!(fs::create_dir_all(&out_dir));
624 t!(symlink_dir_force(&builder.config, &out, &out_dir));
626 // Build cargo command.
627 let mut cargo = prepare_tool_cargo(
638 // Only include compiler crates, no dependencies of those, such as `libc`.
639 cargo.arg("--no-deps");
640 cargo.arg("-p").arg("rustdoc");
641 cargo.arg("-p").arg("rustdoc-json-types");
643 cargo.rustdocflag("--document-private-items");
644 cargo.rustdocflag("--enable-index-page");
645 cargo.rustdocflag("-Zunstable-options");
646 builder.run(&mut cargo.into());
650 #[derive(Ord, PartialOrd, Debug, Copy, Clone, Hash, PartialEq, Eq)]
651 pub struct ErrorIndex {
652 pub target: TargetSelection,
655 impl Step for ErrorIndex {
657 const DEFAULT: bool = true;
658 const ONLY_HOSTS: bool = true;
660 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
661 let builder = run.builder;
662 run.path("src/tools/error_index_generator").default_condition(builder.config.docs)
665 fn make_run(run: RunConfig<'_>) {
666 let target = run.target;
667 run.builder.ensure(ErrorIndex { target });
670 /// Generates the HTML rendered error-index by running the
671 /// `error_index_generator` tool.
672 fn run(self, builder: &Builder<'_>) {
673 builder.info(&format!("Documenting error index ({})", self.target));
674 let out = builder.doc_out(self.target);
675 t!(fs::create_dir_all(&out));
676 let mut index = tool::ErrorIndex::command(builder);
678 index.arg(out.join("error-index.html"));
679 index.arg(&builder.version);
681 builder.run(&mut index);
685 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
686 pub struct UnstableBookGen {
687 target: TargetSelection,
690 impl Step for UnstableBookGen {
692 const DEFAULT: bool = true;
693 const ONLY_HOSTS: bool = true;
695 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
696 let builder = run.builder;
697 run.path("src/tools/unstable-book-gen").default_condition(builder.config.docs)
700 fn make_run(run: RunConfig<'_>) {
701 run.builder.ensure(UnstableBookGen { target: run.target });
704 fn run(self, builder: &Builder<'_>) {
705 let target = self.target;
707 builder.info(&format!("Generating unstable book md files ({})", target));
708 let out = builder.md_doc_out(target).join("unstable-book");
709 builder.create_dir(&out);
710 builder.remove_dir(&out);
711 let mut cmd = builder.tool_cmd(Tool::UnstableBookGen);
712 cmd.arg(builder.src.join("library"));
713 cmd.arg(builder.src.join("compiler"));
714 cmd.arg(builder.src.join("src"));
717 builder.run(&mut cmd);
721 fn symlink_dir_force(config: &Config, src: &Path, dst: &Path) -> io::Result<()> {
725 if let Ok(m) = fs::symlink_metadata(dst) {
726 if m.file_type().is_dir() {
727 fs::remove_dir_all(dst)?;
729 // handle directory junctions on windows by falling back to
731 fs::remove_file(dst).or_else(|_| fs::remove_dir(dst))?;
735 symlink_dir(config, src, dst)
738 #[derive(Ord, PartialOrd, Debug, Copy, Clone, Hash, PartialEq, Eq)]
739 pub struct RustcBook {
740 pub compiler: Compiler,
741 pub target: TargetSelection,
745 impl Step for RustcBook {
747 const DEFAULT: bool = true;
748 const ONLY_HOSTS: bool = true;
750 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
751 let builder = run.builder;
752 run.path("src/doc/rustc").default_condition(builder.config.docs)
755 fn make_run(run: RunConfig<'_>) {
756 run.builder.ensure(RustcBook {
757 compiler: run.builder.compiler(run.builder.top_stage, run.builder.config.build),
763 /// Builds the rustc book.
765 /// The lints are auto-generated by a tool, and then merged into the book
766 /// in the "md-doc" directory in the build output directory. Then
767 /// "rustbook" is used to convert it to HTML.
768 fn run(self, builder: &Builder<'_>) {
769 let out_base = builder.md_doc_out(self.target).join("rustc");
770 t!(fs::create_dir_all(&out_base));
771 let out_listing = out_base.join("src/lints");
772 builder.cp_r(&builder.src.join("src/doc/rustc"), &out_base);
773 builder.info(&format!("Generating lint docs ({})", self.target));
775 let rustc = builder.rustc(self.compiler);
776 // The tool runs `rustc` for extracting output examples, so it needs a
777 // functional sysroot.
778 builder.ensure(compile::Std { compiler: self.compiler, target: self.target });
779 let mut cmd = builder.tool_cmd(Tool::LintDocs);
781 cmd.arg(builder.src.join("compiler"));
783 cmd.arg(&out_listing);
786 cmd.arg("--rustc-target").arg(&self.target.rustc_target_arg());
787 if builder.config.verbose() {
788 cmd.arg("--verbose");
791 cmd.arg("--validate");
793 // If the lib directories are in an unusual location (changed in
794 // config.toml), then this needs to explicitly update the dylib search
796 builder.add_rustc_lib_path(self.compiler, &mut cmd);
797 builder.run(&mut cmd);
798 // Run rustbook/mdbook to generate the HTML pages.
799 builder.ensure(RustbookSrc {
801 name: INTERNER.intern_str("rustc"),
802 src: INTERNER.intern_path(out_base),
804 if is_explicit_request(builder, "src/doc/rustc") {
805 let out = builder.doc_out(self.target);
806 let index = out.join("rustc").join("index.html");
807 open(builder, &index);