Skip to content

Generate macro expansion for rust compiler crates docs #151092

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

Jump to bottom
Open
GuillaumeGomez wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Generate macro expansion for rust compiler crates docs #151092

GuillaumeGomez wants to merge 2 commits into from
+5 −0

Conversation

@GuillaumeGomez
Copy link
Member

@GuillaumeGomez GuillaumeGomez commented Jan 13, 2026

Re-enable #150022, which was disabled in #149831 because some fixes hadn't been merged then.

r? @jieyouxu

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) labels Jan 13, 2026
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@jieyouxu
Copy link
Member

jieyouxu commented Jan 14, 2026 •
edited
Loading

Unfortunately it seems to still ICE :(

EDIT: oh, that's against the beta rustdoc. Do we need to wait until the next release when nightly rustdoc gets promoted to beta?

@jieyouxu jieyouxu added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jan 14, 2026
@GuillaumeGomez
Copy link
Member Author

GuillaumeGomez commented Jan 14, 2026

Oh a new bug. Perfect! =D

@GuillaumeGomez
Copy link
Member Author

GuillaumeGomez commented Jan 14, 2026

Unfortunately it seems to still ICE :(

EDIT: oh, that's against the beta rustdoc. Do we need to wait until the next release when nightly rustdoc gets promoted to beta?

Wait really? That's super weird. Let me check a bit if I can reproduce locally.

@GuillaumeGomez
Copy link
Member Author

GuillaumeGomez commented Jan 14, 2026

I can reproduce locally so I think we found a new bug, perfect. =D

@GuillaumeGomez
Copy link
Member Author

GuillaumeGomez commented Jan 14, 2026

Just checked locally and rediscovered that stage 1 compiler docs uses beta rustdoc. So stage 2 works just fine. Well, nothing else to be done except waiting for new release (which is in less than 2 weeks so it's fine 😄).

@jieyouxu jieyouxu added S-blocked Status: Blocked on something else such as an RFC or other implementation work. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jan 14, 2026
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@GuillaumeGomez GuillaumeGomez force-pushed the generate-macro-expansion-compiler-crates-docs branch from b545b49 to e79792c Compare January 15, 2026 15:55
@GuillaumeGomez
Copy link
Member Author

GuillaumeGomez commented Jan 15, 2026

CI passed! \o/

Thanks a lot @bjorn3 for the idea!

bjorn3
bjorn3 reviewed Jan 15, 2026
View reviewed changes
src/bootstrap/src/core/build_steps/doc.rs
// If there is any bug, please comment out the next line.
cargo.rustdocflag("--generate-link-to-definition");
// FIXME: Currently, `--generate-macro-expansion` option is buggy in `beta` rustdoc. To
// allow CI to pass, we only enable the option in stage 2 and higher.
Copy link
Member

@bjorn3 bjorn3 Jan 15, 2026

Choose a reason for hiding this comment

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

Maybe add cfg(bootstrap) to this comment to remind someone to remove it in the bootstrap bump PR.

@jieyouxu jieyouxu added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-blocked Status: Blocked on something else such as an RFC or other implementation work. labels Jan 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bjorn3 bjorn3 bjorn3 left review comments

Assignees

@jieyouxu jieyouxu

Labels

S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@GuillaumeGomez @rust-log-analyzer @jieyouxu @bjorn3 @rustbot