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

Rendered Rustc book out of sync: wasm32-wasip2 should be documented as Tier-2 target #133206

Closed
ifsheldon opened this issue Nov 19, 2024 · 5 comments · Fixed by #133213
Closed
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools O-wasm Target: WASM (WebAssembly), http://webassembly.org/ T-compiler Relevant to the compiler team, which will review and decide on the PR/issue.

Comments

@ifsheldon
Copy link

Location

Hi! Today I looked up rustc book for the support of wasm32-wasip2 target. I found the website is still documenting wasm32-wasip2 as a Tier-3 target.

Image
Image

And I looked up the source code.

[`wasm32-wasip2`](platform-support/wasm32-wasip2.md) | ✓ | WebAssembly with WASIp2

The table has been updated, but the document of wasm32-wasip2 is still out of date.

These seems a bit weird to me:

  • The table and the specific document for wasm32-wasip2 on the website are both out of date.
  • The table in the source code is up to date, while the specific document is out of date.

This issue may also reflect some procedural issues when promoting a target? I saw #129997 and #129998, but they seem not to be enforcing syncs on the rustc book.

I don't know anything about the publication process of rustc book, but I think it should be at least updated when stable Rust 1.82 was announced.

Summary

The published website of rustc book is out of date, documenting wasm32-wasip2 as a Tier-3 target. The source code of rustc book is also partially out of data and out of sync.

@ifsheldon ifsheldon added the A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools label Nov 19, 2024
@rustbot rustbot added the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Nov 19, 2024
@jieyouxu jieyouxu added T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. O-wasm Target: WASM (WebAssembly), http://webassembly.org/ and removed needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. labels Nov 19, 2024
@jieyouxu
Copy link
Member

cc @alexcrichton

@alexcrichton
Copy link
Member

My mistake, fixed in #133213

@ifsheldon
Copy link
Author

@alexcrichton I think the content in the document should also be updated?

For example:

The default set of WebAssembly features enabled for compilation is currently the

I guess (very likely) this is no longer true. I didn't dig into the differences, though.

@ifsheldon
Copy link
Author

Besides, when will the published Rustc book website get updated? I think it should be updated when a stable release of Rust is announced, so the fixes should be "backported" to 1.82 rustc book?

@alexcrichton
Copy link
Member

I believe that documentation about enabled features is correct, are you seeing otherwise though?

I also believe the book is updated based on releases of Rust. For example there is:

(I could have outdated knowledge though)

matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Nov 19, 2024
…ieyouxu

Correct the tier listing of `wasm32-wasip2`

This target is tier 2, not tier 3, and I forgot to update this.

Closes rust-lang#133206
@bors bors closed this as completed in 616013f Nov 20, 2024
rust-timer added a commit to rust-lang-ci/rust that referenced this issue Nov 20, 2024
Rollup merge of rust-lang#133213 - alexcrichton:fix-tier-listing, r=jieyouxu

Correct the tier listing of `wasm32-wasip2`

This target is tier 2, not tier 3, and I forgot to update this.

Closes rust-lang#133206
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 O-wasm Target: WASM (WebAssembly), http://webassembly.org/ T-compiler Relevant to the compiler team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants