-
Notifications
You must be signed in to change notification settings - Fork 13.8k
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.
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
Conversation
rustbot has assigned @Mark-Simulacrum. Use |
compilers.build_compiler() | ||
} | ||
Mode::ToolBootstrap => { | ||
// bootstrap/host tools should be documented with the stage 0 compiler |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
Hmm, this is not the best solution, because ideally we would still allow documenting local stage0 stuff using stage0 rustdoc, but override the rustdoc being used for the actual doc So let's go forward with this, for now. Please let's just add a small comment on top of these stage0 tool_doc invocations that says that they currently use r? @Kobzol |
Is there anyone using stage 0 rustdoc to build docs? |
Is there some way for bootstrap or rustdoc to notice (perhaps in the dist artifacts?) that we used two different versions and bail out? Maybe when we produce the rustc and std doc components we could run such a check? |
All of the docs need to be built with the same rustdoc. Otherwise, any change to the search index breaks everything, because the two rustdocs don't agree on the format.
Okay, I've added the comment. @bors r=Kobzol |
Rollup of 6 pull requests Successful merges: - #142506 (Add `Path::has_trailing_sep` and related methods) - #146886 (Add repr(align(2)) to RcInner and ArcInner) - #147166 (several small `proc_macro` cleanups) - #147172 (bootstrap: build bootstrap docs with in-tree rustdoc) - #147181 (cg_llvm: Replace enum `MetadataType` with a list of `MetadataKindId` constants) - #147187 (remove unnecessary test directives) r? `@ghost` `@rustbot` modify labels: rollup
I guess we'd have to add some metadata to the generated documentation and then check it in a post-dist test. I think that the current bootstrap snapshot test is enough. |
All of the docs need to be built with the same rustdoc. Otherwise, any change to the search index breaks everything, because the two rustdocs don't agree on the format.
Fixes #147142