Skip to content

docs: consider whether to distinguish kernel-only alloc methods #407

Closed
@ojeda

Description

@ojeda

From #402 (comment):

The main reason I think the current way is not acceptable is that when we generate the docs for the alloc crate, people may look at the doc and think that it is part of standard Rust library but clearly it isn't.

From #402 (comment):

I replaced the Rust logo with the Rust for Linux one (in the version we sent for the RFC) so that it was clear when the user is navigating from the kernel docs into the Rust ones (e.g. when clicking on Some).

Having also a banner on the specific methods that are kernel-only would also be nice to further clarify

If we want something extra to the logo, e.g. to highlight individual methods, perhaps we can go with some unique to the kernel so that it is even more obvious, e.g. changing slightly the background color or a colored line in the right or left, etc.

Metadata

Metadata

Assignees

No one assigned

    Labels

    • docsRelated to `Documentation/rust/`, `samples/`, generated docs, doctests, typos...

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions