Skip to content

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

Closed
#128266
Closed
Documentation of default value for config.toml's rust.channel is inaccurate#128258
#128266
Labels
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-bugCategory: This is a bug.T-bootstrapRelevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)

Description

@dtolnay
dtolnay
opened on 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.

Activity

  1. Imagedtolnay
    added
    T-bootstrapRelevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)
    A-docsArea: Documentation for any part of the project, including the compiler, standard library, and tools
    C-bugCategory: This is a bug.
    on Jul 27, 2024
  2. Imagerustbot
    added
    needs-triageThis issue may need triage. Remove when done. See docs forge.rust-lang.org/release/issue-triaging
    on Jul 27, 2024
  3. Imageonur-ozkan
    removed
    needs-triageThis issue may need triage. Remove when done. See docs forge.rust-lang.org/release/issue-triaging
    on Jul 27, 2024
  4. Imagematthiaskrgr
    added a commit that references this issue on Jul 27, 2024

    Rollup merge of rust-lang#128266 - onur-ozkan:update-channel-doc, r=d…

    3f0fb36
  5. Imagetgross35
    added a commit that references this issue on Jul 27, 2024

    Rollup merge of rust-lang#128266 - onur-ozkan:update-channel-doc, r=d…

    5f3a603
  6. Imagebors
    closed this as completedin 5f3a603on Jul 27, 2024
  7. Imagerust-timer
    added a commit that references this issue on Jul 27, 2024

    Unrolled build for rust-lang#128266

    99203e4
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-bugCategory: This is a bug.T-bootstrapRelevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions