]> git.lizzy.rs Git - rust.git/commitdiff
Point to platform-support/ for target-specific documentation
authorJosh Triplett <josh@joshtriplett.org>
Tue, 2 Nov 2021 12:52:39 +0000 (13:52 +0100)
committerJosh Triplett <josh@joshtriplett.org>
Tue, 2 Nov 2021 12:52:39 +0000 (13:52 +0100)
Explain that target-specific documentation should appear in a
subdirectory of platform-support, with a link from the target's entry on
the platform-support page.

src/doc/rustc/src/target-tier-policy.md

index 5f22ad2b16f1a512acc6d00ab40b4a96fc60f364..f82a8edd10866b09b1b5d8c07517f03b7cef41e4 100644 (file)
@@ -71,6 +71,12 @@ For a list of all supported targets and their corresponding tiers ("tier 3",
 "tier 2", "tier 2 with host tools", "tier 1", or "tier 1 with host tools"), see
 [platform support](platform-support.md).
 
+Several parts of this policy require providing target-specific documentation.
+Such documentation should typically appear in a subdirectory of the
+platform-support section of this rustc manual, with a link from the target's
+entry in [platform support](platform-support.md). See other documentation in
+that directory for examples.
+
 Note that a target must have already received approval for the next lower tier,
 and spent a reasonable amount of time at that tier, before making a proposal
 for promotion to the next higher tier; this is true even if a target meets the