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.

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

Documentation of default value for config.toml's rust.channel is inaccurate #128258

Closed
dtolnay opened this issue Jul 27, 2024 · 0 comments · Fixed by #128266
Closed

Documentation of default value for config.toml's rust.channel is inaccurate #128258

dtolnay opened this issue Jul 27, 2024 · 0 comments · Fixed by #128266
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-bug Category: This is a bug. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)

Comments

@dtolnay
Copy link
Member

dtolnay commented Jul 27, 2024

On current master:

rust/config.example.toml

Lines 578 to 581 in 7c2012d

# The "channel" for the Rust build to produce. The stable/beta channels only
# allow using stable features, whereas the nightly and dev channels allow using
# nightly features
#channel = "dev"

Same thing on the 1.80.0 release tag: https://github.com/rust-lang/rust/blob/1.80.0/config.example.toml#L582

This default value of "dev" used to be accurate prior to #125181, i.e. with Rust 1.79 and older. The default value comes from this hardcoded value: https://github.com/rust-lang/rust/blob/1.79.0/src/bootstrap/src/core/config/config.rs#L1179.

But post-#125181, the default value varies by how you got your source tarball, or what git branch you are on. It is not accurate for the Rust 1.80.0 release sources to say the default value for rust.channel is "dev", as it's actually "stable" now.

Mentioning @onur-ozkan @clubby789 since you worked on the PR (which I am otherwise happy with).

The change in default also needs to be called out in src/bootstrap/src/utils/change_tracker.rs.

@dtolnay dtolnay added T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-bug Category: This is a bug. labels Jul 27, 2024
@rustbot rustbot added the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Jul 27, 2024
@onur-ozkan onur-ozkan removed the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Jul 27, 2024
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Jul 27, 2024
…tolnay

update `rust.channel` default value documentation

self-explanatory

Resolves rust-lang#128258

r? dtolnay
@bors bors closed this as completed in 5f3a603 Jul 27, 2024
rust-timer added a commit to rust-lang-ci/rust that referenced this issue Jul 27, 2024
Rollup merge of rust-lang#128266 - onur-ozkan:update-channel-doc, r=dtolnay

update `rust.channel` default value documentation

self-explanatory

Resolves rust-lang#128258

r? dtolnay
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-bug Category: This is a bug. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants