Skip to content
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

Update documentation for tools defaults #112487

Merged
merged 1 commit into from
Jun 11, 2023
Merged

Update documentation for tools defaults #112487

merged 1 commit into from
Jun 11, 2023

Conversation

zwhiteley
Copy link
Contributor

This PR alters the information in the tools profile config to mention that download-rustc uses the stage2 toolchain and not the stage1 toolchain (see https://rust-lang.zulipchat.com/#narrow/stream/122651-general/topic/Unable.20to.20compile.20rustc.20MSVC and rust-lang/rustc-dev-guide#1694).

@rustbot
Copy link
Collaborator

rustbot commented Jun 10, 2023

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @Mark-Simulacrum (or someone else) soon.

Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (S-waiting-on-review and S-waiting-on-author) stays updated, invoking these commands when appropriate:

  • @rustbot author: the review is finished, PR author should check the comments and take action accordingly
  • @rustbot review: the author is ready for a review, this PR will be queued again in the reviewer's queue

@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 10, 2023
jyn514
jyn514 reviewed Jun 10, 2023
View reviewed changes
Copy link
Member

@jyn514 jyn514 left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Do you think it makes sense to also include this comment in the text x setup tools emits? I think it's more likely people will read it if it's printed directly without having to go hunting for it.

src/bootstrap/defaults/config.tools.toml Outdated Show resolved Hide resolved
@zwhiteley
Copy link
Contributor Author

Do you think it makes sense to also include this comment in the text x setup tools emits? I think it's more likely people will read it if it's printed directly without having to go hunting for it.

Yeah I think that would be helpful

@zwhiteley
Improve documentation for tools profile
ab68390 
Make the build process more beginner friendly:

 - Include information explaining that the stage2 toolchain should be
   used (and not the stage1 toolchain) due to the `download-rustc`
   setting.

 - Display a message when the user runs `x setup tools` explaining that
   they should use the stage2 toolchain.
@zwhiteley
Copy link
Contributor Author

@bors r=Mark-Simulacrum

@bors
Copy link
Contributor

bors commented Jun 10, 2023

@zwhiteley: 🔑 Insufficient privileges: Not in reviewers

@jyn514
Copy link
Member

jyn514 commented Jun 11, 2023

@bors r=Mark-Simulacrum rollup

@bors
Copy link
Contributor

bors commented Jun 11, 2023

📌 Commit ab68390 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 11, 2023
@jyn514
Copy link
Member

jyn514 commented Jun 11, 2023

thanks for the PR!

@matthiaskrgr matthiaskrgr mentioned this pull request Jun 11, 2023
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Jun 11, 2023
@bors
Auto merge of rust-lang#112530 - matthiaskrgr:rollup-qee1kc1, r=matth…
37998ab 
…iaskrgr

Rollup of 3 pull requests

Successful merges:

 - rust-lang#112487 (Update documentation for `tools` defaults)
 - rust-lang#112513 (Dont compute `opt_suggest_box_span` span for TAIT)
 - rust-lang#112528 (bootstrap: Don't override `debuginfo-level = 1` to mean `line-tables-only`)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 733617b into rust-lang:master Jun 11, 2023
@rustbot rustbot added this to the 1.72.0 milestone Jun 11, 2023
@bors
Copy link
Contributor

bors commented Jun 11, 2023

⌛ Testing commit ab68390 with merge 37998ab...

rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Jun 11, 2023
@rust-timer
Unrolled build for rust-lang#112487
d5db223
@JohnTitor JohnTitor mentioned this pull request Jun 21, 2023
Merged
@zwhiteley zwhiteley deleted the improve-docs branch July 1, 2023 21:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jyn514 jyn514 jyn514 left review comments

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

Assignees

@Mark-Simulacrum Mark-Simulacrum

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.72.0
Development

Successfully merging this pull request may close these issues.
5 participants
@zwhiteley @rustbot @bors @jyn514 @Mark-Simulacrum