Skip to content

resolve rustdoc incompatibility with rust.download-rustc=true + rust.channel= beta/stable #126153

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
merged 2 commits into from
Jun 10, 2024
Merged

resolve rustdoc incompatibility with rust.download-rustc=true + rust.channel= beta/stable #126153

merged 2 commits into from
Jun 10, 2024

Conversation

onur-ozkan
Copy link
Contributor

@onur-ozkan onur-ozkan commented Jun 8, 2024 •
edited
Loading

Previously, we were unable to use rust.download-rustc with the beta or stable
channel settings through rust.channel due to breaking rustdoc UI tests.
This was because when using a precompiled nightly compiler from CI, we must use the
channel of precompiled compiler and ignore rust.channel from the configuration.

This change addresses that issue in Builder::doc_rust_lang_org_channel and allows rustdoc
UI tests to work with the precompiled compiler even if the channel specified in config.toml is
"beta" or "stable".

Blocker for #122709

@rustbot
Copy link
Collaborator

rustbot commented Jun 8, 2024

r? @Mark-Simulacrum

rustbot has assigned @Mark-Simulacrum.
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

@rustbot
Copy link
Collaborator

rustbot commented Jun 8, 2024

This PR modifies src/bootstrap/src/core/config.

If appropriate, please update CONFIG_CHANGE_HISTORY in src/bootstrap/src/utils/change_tracker.rs.

@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 Jun 8, 2024
@onur-ozkan onur-ozkan force-pushed the fix-rustdoc-issue-with-ci-rustc branch from 32fe89b to 5719f75 Compare June 8, 2024 10:07
onur-ozkan
onur-ozkan commented Jun 8, 2024
View reviewed changes
src/bootstrap/src/core/config/config.rs
}
}

// FIXME: handle download-rustc incompatible options.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

We already have several incompatibility checks for download-rustc, but I believe we can further expand them. I'm unsure about which options we can check, so I'll leave this FIXME to revisit later.

Mark-Simulacrum
Mark-Simulacrum reviewed Jun 9, 2024
View reviewed changes
Copy link
Member

@Mark-Simulacrum Mark-Simulacrum left a comment

Choose a reason for hiding this comment

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

r=me with channel detection fixed

src/bootstrap/src/core/builder.rs Outdated

pub fn doc_rust_lang_org_channel(&self) -> String {
let channel = match &*self.config.channel {
// When using precompiled nightly compiler from CI, we need to use CI rustc's channel and
Copy link
Member

Choose a reason for hiding this comment

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

The downloaded compiler isn't nightly if it's being downloaded while building a new beta, right? So I think this needs to use the logic we have for detecting channel...

onur-ozkan added 2 commits June 9, 2024 22:48
@onur-ozkan
fix Builder::doc_rust_lang_org_channel
e61d3b8 
Previously, we were unable to use `rust.download-rustc` with the beta or stable
channel settings through `rust.channel` due to breaking rustdoc UI tests.
This was because when using a precompiled nightly compiler from CI, we must use the
channel of precompiled compiler and ignore `rust.channel` from the configuration.

This change addresses that issue in `Builder::doc_rust_lang_org_channel` and allows rustdoc
UI tests to work with the precompiled compiler even if the channel specified in config.toml is
"beta" or "stable".

Signed-off-by: onur-ozkan <[email protected]>
@onur-ozkan
remove the outdated incompatibility check
99c5476 
This check is no longer needed as rustdoc ui tests works with any
channel + precompiled compiler.

Signed-off-by: onur-ozkan <[email protected]>
@onur-ozkan onur-ozkan force-pushed the fix-rustdoc-issue-with-ci-rustc branch from 5719f75 to 99c5476 Compare June 9, 2024 19:49
@onur-ozkan
Copy link
Contributor Author

@bors r=Mark-Simulacrum rollup

@bors
Copy link
Collaborator

bors commented Jun 9, 2024

📌 Commit 99c5476 has been approved by Mark-Simulacrum

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 Jun 9, 2024
@bors
Copy link
Collaborator

bors commented Jun 10, 2024

⌛ Testing commit 99c5476 with merge d2fb97f...

@bors
Copy link
Collaborator

bors commented Jun 10, 2024

☀️ Test successful - checks-actions
Approved by: Mark-Simulacrum
Pushing d2fb97f to master...

@bors bors added the merged-by-bors This PR was explicitly merged by bors. label Jun 10, 2024
@bors bors merged commit d2fb97f into rust-lang:master Jun 10, 2024
@rustbot rustbot added this to the 1.81.0 milestone Jun 10, 2024
@onur-ozkan onur-ozkan deleted the fix-rustdoc-issue-with-ci-rustc branch June 10, 2024 04:54
@rust-timer
Copy link
Collaborator

Finished benchmarking commit (d2fb97f): comparison URL.

Overall result: ❌ regressions - no action needed

@rustbot label: -perf-regression

Instruction count

This is a highly reliable metric that was used to determine the overall result at the top of this comment.

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

Max RSS (memory usage)

Results (primary 4.9%)

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

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

Cycles

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

Binary size

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

Bootstrap: missing data
Artifact size: 319.73 MiB -> 319.81 MiB (0.03%)

@onur-ozkan onur-ozkan mentioned this pull request Jun 12, 2024
Merged
@onur-ozkan onur-ozkan mentioned this pull request Oct 21, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Mark-Simulacrum Mark-Simulacrum Mark-Simulacrum left review comments

Assignees

@Mark-Simulacrum Mark-Simulacrum

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)
Projects
None yet
Milestone
1.81.0
Development

Successfully merging this pull request may close these issues.
5 participants
@onur-ozkan @rustbot @bors @rust-timer @Mark-Simulacrum