Move platform support to the rustc book. #75431
Conversation
A few updates: - Some minor wording and formatting changes. - Remove the `cargo` column. - Explain the columns up-front. - Add no-wrap on the target-triple, which looks better to me. - Minor mention on how to install support for a built-in target via rustup.
|
(rust_highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
|
cc @Mark-Simulacrum per discussion at rust-lang/rust-forge#413 (comment). |
|
I'm going to set myself as reviewer here, but I would also like to cc @rust-lang/compiler and @rust-lang/release as the primary teams involved with decisions around platform support. I agree with @ehuss that this is probably a pretty good place. r=me with CI fixed |
|
I did not know that the AppleOS targets don't exist on Linux. I pushed a fix so the test only runs on macOS. I feel a little uncomfortable with that, because in the future if any target is added that doesn't exist on macOS, it won't work. It also seems a little hacky. I can't think of too many other better options. One would be to just manually scan the supported_targets! by just reading that file. WDYT? |
|
I think it may be worth noting that we don't support full cross-compilation (if I'm following you correctly) in the Markdown file somehow, and then the collector can check subsets appropriately (e.g., macOS would test that everything we expect on macOS is indeed present, Linux would do the same, etc.) |
|
Nah. The issue is that I'm using |
|
Right, yes, my point is that if those targets are only present on macOS (i.e., cannot be cross compiled from Linux) we should note that on the platform support page. Then, when the test runs on macOS, it will check to verify the presence of those targets. On Linux it will still check for all other targets, but ignore the mac-specific ones. I am also fine hard coding this into the test runner for now. |
|
Oh, I see! Good point. I'll make that change, though it probably won't be till tomorrow. Thanks for the suggestion! |
|
I'm wondering... would this be a good moment to automatically generate the page? |
ehuss
force-pushed
the
platform-support
branch
from
b5c00aa
to
4776234
Compare
|
Updated with the apple exception. @pietroalbini Do you have ideas on how that would work? I had thought about moving to some kind of structured format (like it used to be), but it didn't seem to really improve things. The concern with computing it is that the data needs to reside somewhere. The tier status doesn't exist anywhere else, and I would be reluctant to add it to the spec definition. Whether or not host and std vs no_std is only encoded through various shell scripts in the CI directory, and I don't think that's really parseable. And the "notes" section would need to go somewhere. One idea I had was to query the rustup manifest to at least check the host and std status, but that would need to be done outside of regular CI runs since the publish happens separately. One possibility is to set up a scheduled task (like once a day) that could query it and then send an alert if something is off (email? issue? zulip?). However, that would only be useful for targets that change their status, and that is extremely rare AFAIK. |
src/tools/tier-check/README.md
Outdated
| This is a script for validating the platform support page in the rustc book. | ||
|
|
||
| The script takes two arguments, the path to the Platform Support source page, | ||
| and the second argument is the path to `rustc`. |
There was a problem hiding this comment.
Could you move this to a doc comment in main.rs?
ehuss
force-pushed
the
platform-support
branch
from
4776234
to
ce71747
Compare
|
@bors r=Mark-Simulacrum |
|
📌 Commit ce71747 has been approved by |
bors
added
S-waiting-on-bors
…lacrum Move platform support to the rustc book. This moves the [Platform Support](https://forge.rust-lang.org/release/platform-support.html) page from the forge to the rustc book. There are several reasons for doing this: * The forge is not really oriented towards end-users (it mostly contains infrastructure, governance and policy, internal team pages, etc.). This platform support page is useful to user to know which targets are supported. * This page can now be updated in-sync with any PRs that add or remove a target, or change its status. * This is now automatically checked on CI to verify the list does not get out of sync. Currently it only checks the presence/absence of an entry, but more sophisticated checks could be added in the future. I'm not 100% certain this is the best location, but I think it fits. I'd like to see the rustc guide continue to grow, including things like linking information and more platform-specific details.
|
☀️ Test successful - checks-actions, checks-azure |
This moves the Platform Support page from the forge to the rustc book. There are several reasons for doing this:
I'm not 100% certain this is the best location, but I think it fits. I'd like to see the rustc guide continue to grow, including things like linking information and more platform-specific details.