Skip to content

bootstrap: build bootstrap docs with in-tree rustdoc #147172

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 30, 2025
Merged

bootstrap: build bootstrap docs with in-tree rustdoc #147172

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions src/bootstrap/src/core/build_steps/doc.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1024,12 +1024,9 @@ macro_rules! tool_doc {
run.builder.ensure(Rustc::from_build_compiler(run.builder, compilers.build_compiler(), target));
compilers.build_compiler()
}
Mode::ToolBootstrap => {
// bootstrap/host tools should be documented with the stage 0 compiler
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe have a comment somewhere emphasizing that everything needs to be documented with the same rustdoc?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's not 100% true. For local usage, you can document them with whatever you want, you only need the same rustdoc when you dist everything together and ship it as a single docs directory.

prepare_doc_compiler(run.builder, run.builder.host_target, 1)
}
Mode::ToolTarget => {
// target tools should be documented with the in-tree compiler
// when shipping multiple docs together in one folder,
// they all need to use the same rustdoc version
prepare_doc_compiler(run.builder, run.builder.host_target, run.builder.top_stage)
}
_ => {
Expand Down Expand Up @@ -1132,7 +1129,11 @@ macro_rules! tool_doc {
tool_doc!(
BuildHelper,
"src/build_helper",
mode = Mode::ToolBootstrap,
// ideally, this would use ToolBootstrap,
// but we distribute these docs together in the same folder
// as a bunch of stage1 tools, and you can't mix rustdoc versions
// because that breaks cross-crate data (particularly search)
mode = Mode::ToolTarget,
is_library = true,
crates = ["build_helper"]
);
Expand Down Expand Up @@ -1175,25 +1176,25 @@ tool_doc!(
// "specialization" feature in its build script when it detects a nightly toolchain.
allow_features: "specialization"
);
tool_doc!(Tidy, "src/tools/tidy", mode = Mode::ToolBootstrap, crates = ["tidy"]);
tool_doc!(Tidy, "src/tools/tidy", mode = Mode::ToolTarget, crates = ["tidy"]);
tool_doc!(
Bootstrap,
"src/bootstrap",
mode = Mode::ToolBootstrap,
mode = Mode::ToolTarget,
is_library = true,
crates = ["bootstrap"]
);
tool_doc!(
RunMakeSupport,
"src/tools/run-make-support",
mode = Mode::ToolBootstrap,
mode = Mode::ToolTarget,
is_library = true,
crates = ["run_make_support"]
);
tool_doc!(
Compiletest,
"src/tools/compiletest",
mode = Mode::ToolBootstrap,
mode = Mode::ToolTarget,
is_library = true,
crates = ["compiletest"]
);
Expand Down
18 changes: 10 additions & 8 deletions src/bootstrap/src/core/builder/tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1158,13 +1158,12 @@ mod snapshot {
[doc] embedded-book (book) <host>
[doc] edition-guide (book) <host>
[doc] style-guide (book) <host>
[build] rustdoc 0 <host>
[doc] rustc 0 <host> -> Tidy 1 <host>
[doc] rustc 0 <host> -> Bootstrap 1 <host>
[doc] rustc 1 <host> -> Tidy 2 <host>
[doc] rustc 1 <host> -> Bootstrap 2 <host>
[doc] rustc 1 <host> -> releases 2 <host>
[doc] rustc 0 <host> -> RunMakeSupport 1 <host>
[doc] rustc 0 <host> -> BuildHelper 1 <host>
[doc] rustc 0 <host> -> Compiletest 1 <host>
[doc] rustc 1 <host> -> RunMakeSupport 2 <host>
[doc] rustc 1 <host> -> BuildHelper 2 <host>
[doc] rustc 1 <host> -> Compiletest 2 <host>
[build] rustc 0 <host> -> RustInstaller 1 <host>
"
);
Expand Down Expand Up @@ -2686,8 +2685,11 @@ mod snapshot {
.path("src/tools/compiletest")
.stage(2)
.render_steps(), @r"
[build] rustdoc 0 <host>
[doc] rustc 0 <host> -> Compiletest 1 <host>
[build] llvm <host>
[build] rustc 0 <host> -> rustc 1 <host>
[build] rustc 1 <host> -> std 1 <host>
[build] rustdoc 1 <host>
[doc] rustc 1 <host> -> Compiletest 2 <host>
");
}

Expand Down
Loading