Skip to content

Reapply "bootstrap: Enable rustdoc mergeable CCI for std and internal docs" - #163582

Merged
rust-bors[bot] merged 1 commit into
rust-lang:mainfrom
notriddle:revert-revert-mergeable-cci
Oct 2, 2026
Merged

Reapply "bootstrap: Enable rustdoc mergeable CCI for std and internal docs"#163582
rust-bors[bot] merged 1 commit into
rust-lang:mainfrom
notriddle:revert-revert-mergeable-cci

Conversation

@notriddle

@notriddle notriddle commented Oct 1, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Reverts #162339

Re-applies #161716 and #162318

Since a new beta has been released between then and now, the fix applied in #162346 is in beta, so the code should work.

Tracking issue: #130676

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 Oct 1, 2026
@rustbot

This comment has been minimized.

Sign in to view
@notriddle
bootstrap: Enable rustdoc mergeable CCI for std and internal docs
9d32c00 
Takes a different approach to rust-lang#160098, where the internal docs are merged by bootstrap directly invoking rustdoc. This requires bootstrap to gather the list of metadata directories by inspecting cargo's fingerprint files (which aren't stable). The first commit is written by @camelid, but I wrote the other two.

This feature is needed because:

1. The search index (that powers [web-based search](https://doc.rust-lang.org/nightly/nightly-rustc/?search=ty%20-%3E%20rustdoc%3A%3Atype)) needs to contain all of the crates in the nightly-rustc project. In particular, I'd prefer if it contained Clippy, Rustdoc, and Rustc, since those crates share type checker stuff and the ability to search all three at once is convenient.
2. For every crate that rustdoc *currently* documents, it has to load the search index from the doc output dir, and rebuild the search index with the new crate added to it. Loading the search index requires $O(\text{crates})$ work, so doing it once for every crate means we're doing $O(\text{crates}^2)$ work overall.
3. It would be more efficient, *instead*, if each crate wrote its data separately, and then the final search index was generated at the end by merging them all at once. Obviously, this would make the work linear instead of quadratic. For the record, Hoogle and Sherlodoc have a similar index-generating step.
4. We call this "Mergeable Cross-Crate-Information." Cargo stores it in the build directory, and supplies it to Rustdoc in a separate phase that runs after everything else. When we eventually stabilize this feature, it will be invisible to (most) end users. `cargo doc` will just be faster.
5. So, in order for crates to share their cross-crate info, we need them to share a build directory.
6. Tools, like Rustdoc and Cargo, don't normally share a build directory with Rustc.
7. To make them share a build directory while generating documentation, without forcing them to share a build directory while compiling, I added a new mode.

---

This rustdoc feature is unstable but will be stabilized soon, and this is a good way of dogfooding it to make sure it works properly. It should have no effect on the generated docs, but it provides a significant speedup. For example, I measure a 3x speedup locally (3m 11s -> 1m 1s) for `x doc src/tools` -- note that this is with the latest rustdoc perf improvements (rust-lang#159854).

---

This reverts commit c84edb3.
@notriddle
notriddle force-pushed the revert-revert-mergeable-cci branch from b5e7391 to 9d32c00 Compare October 1, 2026 04:27
@rustbot

rustbot commented Oct 1, 2026

Copy link
Copy Markdown
Collaborator

⚠️ Warning ⚠️

  • There are issue links (such as #123) in the commit messages of the following commits.
    Please move them to the PR description, to avoid spamming the issues with references to the commit, and so this bot can automatically canonicalize them to avoid issues with subtrees.

@Kobzol

Kobzol commented Oct 1, 2026

Copy link
Copy Markdown
Member

@bors try jobs=dist-x86_64-linux

rust-bors Bot pushed a commit that referenced this pull request Oct 1, 2026
@bors
Auto merge of #163582 - notriddle:revert-revert-mergeable-cci, r=<try>
b6adfa8 
Reapply "bootstrap: Enable rustdoc mergeable CCI for std and internal docs"


try-job: dist-x86_64-linux
@rust-bors

This comment has been minimized.

Sign in to view
@rust-bors

rust-bors Bot commented Oct 1, 2026

Copy link
Copy Markdown
Contributor

☀️ Try build successful (CI)
Build commit: b6adfa8 (b6adfa845157096820797874c98071fa5f79a959)
Base parent: 6006fd0 (6006fd03947bd7b04ae5cb5f7f9bb66b44dc8c6e)

@Kobzol

Kobzol commented Oct 2, 2026

Copy link
Copy Markdown
Member

I downloaded the rustc docs and tested them locally. Searching for Attribute works now. Hard to say what will happen after deploying it, let's try! Thanks.

@bors r+

@rust-bors

rust-bors Bot commented Oct 2, 2026

Copy link
Copy Markdown
Contributor

📌 Commit 9d32c00 has been approved by Kobzol

It is now in the queue for this repository.

@rust-bors rust-bors Bot added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Oct 2, 2026
@jieyouxu jieyouxu assigned Kobzol and unassigned jieyouxu Oct 2, 2026
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Oct 2, 2026
@JonathanBrouwer
Rollup merge of rust-lang#163582 - notriddle:revert-revert-mergeable-…
2564302 
…cci, r=Kobzol

Reapply "bootstrap: Enable rustdoc mergeable CCI for std and internal docs"

Reverts rust-lang#162339

Re-applies rust-lang#161716 and rust-lang#162318

Since a new beta has been released between then and now, the fix applied in rust-lang#162346 is in beta, so the code should work.

r? @jieyouxu
@JonathanBrouwer JonathanBrouwer mentioned this pull request Oct 2, 2026
Closed
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Oct 2, 2026
@JonathanBrouwer
Rollup merge of rust-lang#163582 - notriddle:revert-revert-mergeable-…
8350fd7 
…cci, r=Kobzol

Reapply "bootstrap: Enable rustdoc mergeable CCI for std and internal docs"

Reverts rust-lang#162339

Re-applies rust-lang#161716 and rust-lang#162318

Since a new beta has been released between then and now, the fix applied in rust-lang#162346 is in beta, so the code should work.

r? @jieyouxu
@JonathanBrouwer JonathanBrouwer mentioned this pull request Oct 2, 2026
Closed
rust-bors Bot pushed a commit that referenced this pull request Oct 2, 2026
@bors
Auto merge of #163656 - JonathanBrouwer:rollup-xoDOplG, r=JonathanBro…
b7c5f5d 
…uwer

Rollup of 13 pull requests

Successful merges:

 - #163317 (Fix incremental compilation for fat LTO)
 - #163582 (Reapply "bootstrap: Enable rustdoc mergeable CCI for std and internal docs")
 - #151793 (Add mul_add_relaxed methods for floating-point types)
 - #162782 (Fix rustdoc ICE caused by mishandling of ambiguity errors)
 - #163010 (Miri can do dirfd now)
 - #163535 (Improve `DocStrings` perf)
 - #163576 (Fix `TypeOutlives` fast-path)
 - #163587 (Several small span improvements)
 - #163612 (fix `ValidateBoundVars`)
 - #163632 (bump rustc-build-sysroot)
 - #163635 (Revert note about signum of NaN)
 - #163644 (Add mailmap entry)
 - #163651 (Remove variants from `feature-gate-autodiff-use` test)
@JonathanBrouwer JonathanBrouwer mentioned this pull request Oct 2, 2026
Merged
rust-bors Bot pushed a commit that referenced this pull request Oct 2, 2026
@bors
Auto merge of #163661 - JonathanBrouwer:rollup-OaJ1qun, r=JonathanBro…
0abfedb 
…uwer

Rollup of 14 pull requests

Successful merges:

 - #163582 (Reapply "bootstrap: Enable rustdoc mergeable CCI for std and internal docs")
 - #151793 (Add mul_add_relaxed methods for floating-point types)
 - #162782 (Fix rustdoc ICE caused by mishandling of ambiguity errors)
 - #163010 (Miri can do dirfd now)
 - #163535 (Improve `DocStrings` perf)
 - #163576 (Fix `TypeOutlives` fast-path)
 - #163587 (Several small span improvements)
 - #163603 (Reorganise reflection intrinsics)
 - #163612 (fix `ValidateBoundVars`)
 - #163632 (bump rustc-build-sysroot)
 - #163635 (Revert note about signum of NaN)
 - #163644 (Add mailmap entry)
 - #163647 (Rename `rustc_driver::run_compiler` to `compiler_entrypoint`)
 - #163651 (Remove variants from `feature-gate-autodiff-use` test)
@rust-bors
rust-bors Bot merged commit e370c54 into rust-lang:main Oct 2, 2026
14 checks passed
rust-bors Bot pushed a commit that referenced this pull request Oct 2, 2026
@bors
Unrolled build for #163582 in rollup 163661
e99ff00 
Rollup merge of #163582 - notriddle:revert-revert-mergeable-cci, r=Kobzol

Reapply "bootstrap: Enable rustdoc mergeable CCI for std and internal docs"

Reverts #162339

Re-applies #161716 and #162318

Since a new beta has been released between then and now, the fix applied in #162346 is in beta, so the code should work.

r? @jieyouxu
@rustbot rustbot added this to the 1.101.0 milestone Oct 2, 2026
@notriddle
notriddle deleted the revert-revert-mergeable-cci branch October 2, 2026 21:44
@notriddle notriddle mentioned this pull request Oct 3, 2026
Open
4 of 6 tasks
flip1995 pushed a commit to flip1995/rust-clippy that referenced this pull request Oct 3, 2026
@bors
Auto merge of #163661 - JonathanBrouwer:rollup-OaJ1qun, r=JonathanBro…
723f8b7 
…uwer

Rollup of 14 pull requests

Successful merges:

 - rust-lang/rust#163582 (Reapply "bootstrap: Enable rustdoc mergeable CCI for std and internal docs")
 - rust-lang/rust#151793 (Add mul_add_relaxed methods for floating-point types)
 - rust-lang/rust#162782 (Fix rustdoc ICE caused by mishandling of ambiguity errors)
 - rust-lang/rust#163010 (Miri can do dirfd now)
 - rust-lang/rust#163535 (Improve `DocStrings` perf)
 - rust-lang/rust#163576 (Fix `TypeOutlives` fast-path)
 - rust-lang/rust#163587 (Several small span improvements)
 - rust-lang/rust#163603 (Reorganise reflection intrinsics)
 - rust-lang/rust#163612 (fix `ValidateBoundVars`)
 - rust-lang/rust#163632 (bump rustc-build-sysroot)
 - rust-lang/rust#163635 (Revert note about signum of NaN)
 - rust-lang/rust#163644 (Add mailmap entry)
 - rust-lang/rust#163647 (Rename `rustc_driver::run_compiler` to `compiler_entrypoint`)
 - rust-lang/rust#163651 (Remove variants from `feature-gate-autodiff-use` test)
@Kobzol

Kobzol commented Oct 4, 2026

Copy link
Copy Markdown
Member

Looks like searching for AST attributes on https://doc.rust-lang.org/nightly/nightly-rustc/?search=attribute now works, good 😆

@github-actions github-actions Bot mentioned this pull request Oct 4, 2026
Draft
github-actions Bot pushed a commit to rust-lang/rustc-dev-guide that referenced this pull request Oct 5, 2026
@bors
Auto merge of #163661 - JonathanBrouwer:rollup-OaJ1qun, r=JonathanBro…
bb2d18c 
…uwer

Rollup of 14 pull requests

Successful merges:

 - rust-lang/rust#163582 (Reapply "bootstrap: Enable rustdoc mergeable CCI for std and internal docs")
 - rust-lang/rust#151793 (Add mul_add_relaxed methods for floating-point types)
 - rust-lang/rust#162782 (Fix rustdoc ICE caused by mishandling of ambiguity errors)
 - rust-lang/rust#163010 (Miri can do dirfd now)
 - rust-lang/rust#163535 (Improve `DocStrings` perf)
 - rust-lang/rust#163576 (Fix `TypeOutlives` fast-path)
 - rust-lang/rust#163587 (Several small span improvements)
 - rust-lang/rust#163603 (Reorganise reflection intrinsics)
 - rust-lang/rust#163612 (fix `ValidateBoundVars`)
 - rust-lang/rust#163632 (bump rustc-build-sysroot)
 - rust-lang/rust#163635 (Revert note about signum of NaN)
 - rust-lang/rust#163644 (Add mailmap entry)
 - rust-lang/rust#163647 (Rename `rustc_driver::run_compiler` to `compiler_entrypoint`)
 - rust-lang/rust#163651 (Remove variants from `feature-gate-autodiff-use` test)
LorrensP-2158466 pushed a commit to LorrensP-2158466/miri that referenced this pull request Oct 6, 2026
@bors
Auto merge of #163661 - JonathanBrouwer:rollup-OaJ1qun, r=JonathanBro…
053a184 
…uwer

Rollup of 14 pull requests

Successful merges:

 - rust-lang/rust#163582 (Reapply "bootstrap: Enable rustdoc mergeable CCI for std and internal docs")
 - rust-lang/rust#151793 (Add mul_add_relaxed methods for floating-point types)
 - rust-lang/rust#162782 (Fix rustdoc ICE caused by mishandling of ambiguity errors)
 - rust-lang/rust#163010 (Miri can do dirfd now)
 - rust-lang/rust#163535 (Improve `DocStrings` perf)
 - rust-lang/rust#163576 (Fix `TypeOutlives` fast-path)
 - rust-lang/rust#163587 (Several small span improvements)
 - rust-lang/rust#163603 (Reorganise reflection intrinsics)
 - rust-lang/rust#163612 (fix `ValidateBoundVars`)
 - rust-lang/rust#163632 (bump rustc-build-sysroot)
 - rust-lang/rust#163635 (Revert note about signum of NaN)
 - rust-lang/rust#163644 (Add mailmap entry)
 - rust-lang/rust#163647 (Rename `rustc_driver::run_compiler` to `compiler_entrypoint`)
 - rust-lang/rust#163651 (Remove variants from `feature-gate-autodiff-use` test)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@Kobzol Kobzol

Labels

S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)

Projects

None yet

Milestone

1.101.0

Development

Successfully merging this pull request may close these issues.

4 participants

@notriddle @rustbot @Kobzol @jieyouxu