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

rustdoc CURRENT_RUSTC_VERSION shows incorrect version between version bump and stage0 bump #126357

Open
ehuss opened this issue Jun 12, 2024 · 0 comments
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) T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@ehuss
Copy link
Contributor

ehuss commented Jun 12, 2024

Items marked with the stability attribute and CURRENT_RUSTC_VERSION will show the wrong version in nightly rustdoc output in between the version bump and the stage0 bump. That means in this sequence:

  1. Item gets marked with CURRENT_RUSTC_VERSION. Example, on nightly the current rust version is 1.80, which is what rustdoc shows.
  2. Version is bumped example bumps to 1.81.
  3. Nightly docs for CURRENT_RUSTC_VERSION marked items now show 1.81 when they should say 1.80.
  4. Stage0 is bumped, and CURRENT_RUSTC_VERSION placeholders get replaced example. The item is now correctly marked 1.80.

This can be confusing since there can be a window of several days where the wrong version is displayed.

@rustbot rustbot added the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Jun 12, 2024
@jieyouxu jieyouxu added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) C-bug Category: This is a bug. A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools and removed needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. labels Jun 12, 2024
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) T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

3 participants