-
Notifications
You must be signed in to change notification settings - Fork 13.6k
Open
Labels
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsArea: Documentation for any part of the project, including the compiler, standard library, and toolsO-androidOperating system: AndroidOperating system: AndroidO-linuxOperating system: LinuxOperating system: LinuxT-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.Relevant to the rustdoc team, which will review and decide on the PR/issue.needs-triageThis issue may need triage. Remove it if it has been sufficiently triaged.This issue may need triage. Remove it if it has been sufficiently triaged.
Description
Many extension traits for Linux show the requirements as:
Available on Linux and (Linux or Android) only.
It would be much less confusing if they just said "Available on Linux only."
This is happening because behind the scenes, the std::os::linux
and std::os::android
modules re-export the same underlying traits. However, the traits are only re-exported under the std::os::linux
module on target_os="linux"
, so the docs for the item in std::os::linux
should not talk about Android.
(There is no equivalent issue for target_os="android"
because the traits are not displayed at all in the documentation on Android.)
Examples
Metadata
Metadata
Assignees
Labels
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsArea: Documentation for any part of the project, including the compiler, standard library, and toolsO-androidOperating system: AndroidOperating system: AndroidO-linuxOperating system: LinuxOperating system: LinuxT-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.Relevant to the rustdoc team, which will review and decide on the PR/issue.needs-triageThis issue may need triage. Remove it if it has been sufficiently triaged.This issue may need triage. Remove it if it has been sufficiently triaged.