Skip to content

fix(bootstrap/dist)!: change dist path for rustc-docs to avoid clashing #150289

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
Merged
bors merged 1 commit into from
Jan 1, 2026
Merged

fix(bootstrap/dist)!: change dist path for rustc-docs to avoid clashing #150289

bors merged 1 commit into from
Jan 1, 2026
+1 −1

Conversation

@rami3l
Copy link
Member

@rami3l rami3l commented Dec 22, 2025 •
edited
Loading

Closes #75833, part of rust-lang/rustup#3717:

I'd like to know if we can assign another folder name to rustc-docs?
[...]
@ThePuzzlemaker's share/doc/rust/html/nightly-rustc does look a bit weird to me (nightly-rustc has nothing to do with the current rustc, i.e. the Rustc Book, but they somehow appear similar just looking at the names).

I personally would like to see something like share/doc/rust/html/rustc-docs or share/doc/rust/html/rustc-api for this component.
#75833 (comment)

The TLDR is that currently the "rustc book"'s path clashes with "rustc APIs" (i.e. rustc-docs), so we change the path of the latter to make it distributable via rustup.

I'm new to bootstrap so please feel free to point out any inconsistencies or any extra work I'll need to do to fully land this somewhat breaking change.

@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 Dec 22, 2025
@rustbot
Copy link
Collaborator

rustbot commented Dec 22, 2025

r? @jieyouxu

rustbot has assigned @jieyouxu.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rami3l rami3l mentioned this pull request Dec 22, 2025
Merged
@Kobzol
Copy link
Member

Kobzol commented Dec 22, 2025

rustc-docs is the compiler API documentation that gets deployed to https://doc.rust-lang.org/nightly/std/index.html? If so, we should check whether the thing that deploys it there can deal with the new path (I forgot/don't know where that gets done though).

@rami3l
Copy link
Member Author

rami3l commented Dec 22, 2025 •
edited
Loading

rustc-docs is the compiler API documentation that gets deployed to doc.rust-lang.org/nightly/std/index.html? If so, we should check whether the thing that deploys it there can deal with the new path (I forgot/don't know where that gets done though).

@Kobzol No, that's the rustdoc for nightly std, rather here we're talking about the rustdoc for rustc. Currently the only extra fix I'm aware of is rust-lang/promote-release#101.

@Kobzol
Copy link
Member

Kobzol commented Dec 22, 2025

Sorry, posted the wrong link, I meant https://doc.rust-lang.org/nightly/nightly-rustc/rustc_ast/ast/index.html.

@jieyouxu
Copy link
Member

jieyouxu commented Dec 23, 2025

Seems okay, but this needs to merge with rust-lang/promote-release#101 in relatively-tight lock-step so we minimize the time where rustc docs isn't available; the promote-release side needs infra-admin coordination.

Thread: https://rust-lang.zulipchat.com/#narrow/channel/242791-t-infra/topic/rustc.20docs.20dist.20path/with/565088879

@jieyouxu jieyouxu added T-infra Relevant to the infrastructure team, which will review and decide on the PR/issue. S-waiting-on-t-infra Status: Waiting on infra team labels Dec 23, 2025
@rami3l rami3l mentioned this pull request Dec 28, 2025
Draft
@rami3l
Copy link
Member Author

rami3l commented Dec 28, 2025 •
edited by jieyouxu
Loading

@jieyouxu The preparation PR rust-lang/promote-release#101 has just been accepted and merged.

If I have understood it correctly, it should only take one nightly release to make sure no breakage has been introduced by it and then you can unfreeze this one, many thanks in advance 🙏

we can confirm it works on the next nightly release, and then merge the rust-lang/rust PR after that
rust-lang/promote-release#101 (review)

@jieyouxu
Copy link
Member

jieyouxu commented Dec 29, 2025

Ok cool, I'll wait until Dec 31 to be safe.
@rustbot review

@jieyouxu jieyouxu removed the S-waiting-on-t-infra Status: Waiting on infra team label Dec 29, 2025
jieyouxu
jieyouxu approved these changes Dec 31, 2025
View reviewed changes
Copy link
Member

@jieyouxu jieyouxu left a comment •
edited by rustbot
Loading

Choose a reason for hiding this comment

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

Thanks. Let's try this out since the promote-release side merged.

View changes since this review

@jieyouxu
Copy link
Member

jieyouxu commented Dec 31, 2025

@bors r+ rollup=never

@bors
Copy link
Collaborator

bors commented Dec 31, 2025

📌 Commit a182874 has been approved by jieyouxu

It is now in the queue for this repository.

@bors bors 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 Dec 31, 2025
@bors
Copy link
Collaborator

bors commented Dec 31, 2025

⌛ Testing commit a182874 with merge 4862272...

@bors
Copy link
Collaborator

bors commented Jan 1, 2026

☀️ Test successful - checks-actions
Approved by: jieyouxu
Pushing 4862272 to main...

@bors bors added the merged-by-bors This PR was explicitly merged by bors. label Jan 1, 2026
@bors bors merged commit 4862272 into rust-lang:main Jan 1, 2026
12 checks passed
@rustbot rustbot added this to the 1.94.0 milestone Jan 1, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Jan 1, 2026

What is this? This is an experimental post-merge analysis report that shows differences in test outcomes between the merged PR and its parent PR.

Comparing 8d670b9 (parent) -> 4862272 (this PR)

Test differences

Show 4 test diffs

4 doctest diffs were found. These are ignored, as they are noisy.

Test dashboard

Run

cargo run --manifest-path src/ci/citool/Cargo.toml -- \
    test-dashboard 48622726c4a91c87bf6cd4dbe1000c95df59906e --output-dir test-dashboard

And then open test-dashboard/index.html in your browser to see an overview of all executed tests.

Job duration changes

  1. dist-apple-various: 4674.6s -> 3528.1s (-24.5%)
  2. pr-check-1: 2022.5s -> 1699.4s (-16.0%)
  3. x86_64-gnu-llvm-20-1: 4536.7s -> 3876.3s (-14.6%)
  4. i686-gnu-2: 6223.7s -> 5358.8s (-13.9%)
  5. dist-x86_64-apple: 6504.8s -> 7398.1s (+13.7%)
  6. x86_64-gnu-llvm-20: 4786.3s -> 4189.2s (-12.5%)
  7. x86_64-rust-for-linux: 3066.9s -> 2685.4s (-12.4%)
  8. x86_64-gnu-gcc: 3397.4s -> 2984.4s (-12.2%)
  9. x86_64-gnu-tools: 3614.7s -> 3211.9s (-11.1%)
  10. aarch64-gnu-debug: 4509.2s -> 4015.9s (-10.9%)
How to interpret the job duration changes?

Job durations can vary a lot, based on the actual runner instance
that executed the job, system noise, invalidated caches, etc. The table above is provided
mostly for t-infra members, for simpler debugging of potential CI slow-downs.

@rust-timer
Copy link
Collaborator

rust-timer commented Jan 1, 2026

Finished benchmarking commit (4862272): comparison URL.

Overall result: ❌ regressions - no action needed

@rustbot label: -perf-regression

Instruction count

Our most reliable metric. Used to determine the overall result above. However, even this metric can be noisy.

mean range count
Regressions ❌
(primary)		 - - 0
Regressions ❌
(secondary)		 0.2% [0.2%, 0.2%] 2
Improvements ✅
(primary)		 - - 0
Improvements ✅
(secondary)		 - - 0
All ❌✅ (primary) - - 0

Max RSS (memory usage)

Results (primary 3.1%, secondary -2.9%)

A less reliable metric. May be of interest, but not used to determine the overall result above.

mean range count
Regressions ❌
(primary)		 3.1% [2.6%, 3.3%] 3
Regressions ❌
(secondary)		 - - 0
Improvements ✅
(primary)		 - - 0
Improvements ✅
(secondary)		 -2.9% [-3.2%, -2.5%] 2
All ❌✅ (primary) 3.1% [2.6%, 3.3%] 3

Cycles

Results (primary 2.3%, secondary -0.9%)

A less reliable metric. May be of interest, but not used to determine the overall result above.

mean range count
Regressions ❌
(primary)		 2.3% [2.3%, 2.3%] 1
Regressions ❌
(secondary)		 2.3% [2.3%, 2.3%] 1
Improvements ✅
(primary)		 - - 0
Improvements ✅
(secondary)		 -2.4% [-3.3%, -1.5%] 2
All ❌✅ (primary) 2.3% [2.3%, 2.3%] 1

Binary size

This benchmark run did not return any relevant results for this metric.

Bootstrap: 477.934s -> 477.392s (-0.11%)
Artifact size: 390.83 MiB -> 390.85 MiB (0.01%)

@rami3l
Copy link
Member Author

rami3l commented Jan 1, 2026 •
edited
Loading

It remains to be seen tonight whether the migration (esp. rust-lang/promote-release#101) is working alright.

Once it's confirmed to be okay I'll move on to rust-lang/rustup#3717.

@rami3l rami3l deleted the dist/rustc-docs-dist-path branch January 1, 2026 19:43
This was referenced Jan 2, 2026
Open
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jieyouxu jieyouxu jieyouxu approved these changes

Assignees

@jieyouxu jieyouxu

Labels

merged-by-bors This PR was explicitly merged by bors. 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) T-infra Relevant to the infrastructure team, which will review and decide on the PR/issue.

Projects

None yet

Milestone

1.94.0

Development

Successfully merging this pull request may close these issues.

can't install rustc-docs component: detected conflict: 'share/doc/rust/html/rustc'

6 participants

@rami3l @rustbot @Kobzol @jieyouxu @bors @rust-timer