Open
Description
openedon Feb 7, 2024
This is the tracking issue for changing rustc target docs to be generated based on the existing target triple patterns, ensuring that there's a doc page for every single target.
Discussion in https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/generating.20target.20documentation with a draft implementation in https://github.com/Nilstrieb/target-tier-docs-experiment.
Steps
- Figure out the best format to store the target docs
- Original idea: TOML
- Current choice: Markdown with fixed sections and YAML frontmatter
- Move some of the information into the complier
- Add empty target metadata to every target
- Add unstable way to print descriptions
- As it's contained in the target spec, we can just print the target spec JSON.
- Implement infrastructure for new docs (without using it yet) Introduce infrastructure for generating target docs #121051
- Migrate existing docs to the new format (over several PRs)
- Use the new format for the shipped docs
- Delete the old docs
Future possibilities
- Keep tier, host_tools and std in sync with reality
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Metadata
Assignees
Labels
Area: documentation for any part of the project, including the compiler, standard library, and toolsArea: Concerning the implications of different compiler targetsCategory: A tracking issue for an RFC or an unstable feature.Relevant to the compiler team, which will review and decide on the PR/issue.