Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for aarch64 claims that anything from arm_shared is unstable #1268

Open
pthariensflame opened this issue Dec 17, 2021 · 5 comments

Comments

@pthariensflame
Copy link
Contributor

In the current nightly documentation for core::arch::aarch64 and for its contained items, the definitions from arm_shared that are reexported by aarch64 are shown as unstable, despite being able to inspect the source and thus prove otherwise. Everything defined within aarch64 directly seems to be displayed properly; it's only the things shared with arm that are misbehaving here.

Screenshots for proof

Main module page, affected parts

Screen Shot 2021-12-16 at 8 22 40 PM Screen Shot 2021-12-16 at 8 23 28 PM

Individual item pages, affected parts

Screen Shot 2021-12-16 at 8 15 44 PM Screen Shot 2021-12-16 at 8 24 00 PM

Main module page, unaffected parts

Screen Shot 2021-12-16 at 8 32 51 PM Screen Shot 2021-12-16 at 8 34 22 PM

Individual item pages, unaffected parts

Screen Shot 2021-12-16 at 8 37 12 PM Screen Shot 2021-12-16 at 8 36 15 PM
@Amanieu
Copy link
Member

Amanieu commented Dec 18, 2021

The issue here is that we have only stabilized these intrinsics on aarch64, but not on arm. This is done using an attribute like:

#[cfg_attr(target_arch = "aarch64", stable(feature = "neon_intrinsics", since = "1.59.0"))]

However the Rust docs are built on x86_64, which means that the cfg does not trigger and the function is marked as unstable.

I'm not sure what we should do here:

  • Ignore the problem until it solves itself when the arm intrinsics are also stabilized?
  • Change the cfg to not(target_arch = "arm") so it appears as stable in the docs? But then the docs are still misleading on arm.

@pthariensflame
Copy link
Contributor Author

Does rustdoc not have a way to write, say, #[doc(stable)], under a cfg_attr if needed?

@pthariensflame
Copy link
Contributor Author

Alternatively, could rustdoc for core::arch be built on all stabilized platforms and then recomposed with the rest of core?

@Amanieu
Copy link
Member

Amanieu commented Dec 19, 2021

At this point it's probably easier to just move ahead with the stabilization of arm intrinisics.

@Amanieu
Copy link
Member

Amanieu commented Oct 25, 2022

Partially fixed by #1345.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants