Skip to content

OS Extension traits have confusing available-on annotation #144681

@Darksonn

Description

@Darksonn

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

No one assigned

    Labels

    A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsO-androidOperating system: AndroidO-linuxOperating system: LinuxT-rustdocRelevant 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.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions