Skip to content

bootstrap: Ensure documentation is built before tarball is created #150845

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

Open
alistair23 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

bootstrap: Ensure documentation is built before tarball is created #150845

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
2 changes: 1 addition & 1 deletion src/bootstrap/src/core/build_steps/dist.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ impl Step for Docs {
// FIXME: explicitly enumerate the steps that should be executed here, and gather their
// documentation, rather than running all default steps and then read their output
// from a shared directory.
builder.run_default_doc_steps();
builder.run_host_default_doc_steps();
Comment on lines 83 to +86
Copy link
Member

@jieyouxu jieyouxu Jan 13, 2026

Choose a reason for hiding this comment

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

cc @Kobzol (do you remember any more context about the default doc steps here?)

Copy link
Member

@Kobzol Kobzol Jan 13, 2026

Choose a reason for hiding this comment

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

Just that we should eventually get rid of this cursed function and explicitly enumerate the Doc steps to run.. 😆


let dest = "share/doc/rust/html";

Expand Down
5 changes: 5 additions & 0 deletions src/bootstrap/src/core/builder/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1117,6 +1117,11 @@ impl<'a> Builder<'a> {
self.run_step_descriptions(&Builder::get_step_descriptions(self.kind), &self.paths);
}

/// Run all default documentation steps to build documentation.
pub fn run_host_default_doc_steps(&self) {
self.run_step_descriptions(&Builder::get_step_descriptions(Kind::Doc), &self.paths);
}

/// Run all default documentation steps to build documentation.
pub fn run_default_doc_steps(&self) {
self.run_step_descriptions(&Builder::get_step_descriptions(Kind::Doc), &[]);
Expand Down
Loading