diff options
| author | Matthias Krüger <matthias.krueger@famsik.de> | 2022-11-04 06:40:32 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-11-04 06:40:32 +0100 |
| commit | 47bf74302b77e28c3f75ff1bb24557963af240c2 (patch) | |
| tree | 4aa9f6f3413ecc0a7a32a6199811d14bc2ac3ab6 /src | |
| parent | a81a531210a922a6f80e07ef1d9052055f1f860f (diff) | |
| parent | 87b2110f25bed1407a9aded9e263b64dc3315d45 (diff) | |
| download | rust-47bf74302b77e28c3f75ff1bb24557963af240c2.tar.gz rust-47bf74302b77e28c3f75ff1bb24557963af240c2.zip | |
Rollup merge of #103912 - flba-eb:doc_adding_tier3_target, r=davidtwco
Add howto for adding new targets When new targets are added, often a reviewer finds out that e.g. the target-3-tier-policy is not filled out (missing), there is no description etc. This change adds a description of what I've learned while working on #102701. It should make reviews easier in the future with less rework. r? compiler-team
Diffstat (limited to 'src')
| -rw-r--r-- | src/doc/rustc/src/target-tier-policy.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/src/doc/rustc/src/target-tier-policy.md b/src/doc/rustc/src/target-tier-policy.md index 53d0470fa81..df9131ce84a 100644 --- a/src/doc/rustc/src/target-tier-policy.md +++ b/src/doc/rustc/src/target-tier-policy.md @@ -3,6 +3,7 @@ ## Table of Contents * [General](#general) +* [Adding a new target](#adding-a-new-target) * [Tier 3 target policy](#tier-3-target-policy) * [Tier 2 target policy](#tier-2-target-policy) * [Tier 2 with host tools](#tier-2-with-host-tools) @@ -104,6 +105,30 @@ indicates something entirely optional, and does not indicate guidance or recommendations. This language is based on [IETF RFC 2119](https://tools.ietf.org/html/rfc2119). +## Adding a new target + +New targets typically start as Tier 3 and then can be promoted later. +To propose addition of a new target, open a pull request on [`rust-lang/rust`]: + +- Copy the [Tier 3 target policy](#tier-3-target-policy) to the description + and fill it out, see [example][tier3example]. +- Add a new description for the target in `src/doc/rustc/src/platform-support` + using the [template][platform_template]. +- Add the target to the [SUMMARY.md][summary] (allows wildcards) and + [platform-support.md][platformsupport] (must name all targets verbatim). + Link to the created description page. +- Ensure the pull request is assigned to a member of the [Rust compiler team][rust_compiler_team] by commenting: + ```text + r? compiler-team + ``` + +[tier3example]: https://github.com/rust-lang/rust/pull/94872 +[platform_template]: https://github.com/rust-lang/rust/blob/master/src/doc/rustc/src/platform-support/TEMPLATE.md +[summary]: https://github.com/rust-lang/rust/blob/master/src/doc/rustc/src/SUMMARY.md +[platformsupport]: https://github.com/rust-lang/rust/blob/master/src/doc/rustc/src/platform-support.md +[rust_compiler_team]: https://www.rust-lang.org/governance/teams/compiler +[`rust-lang/rust`]: https://github.com/rust-lang/rust + ## Tier 3 target policy At this tier, the Rust project provides no official support for a target, so we |