rust-lang / rust-lang/rust

rustdoc search does not find `core::arch::x86_64` intrinsics that are also `x86` intrinsics

Open
#148,786 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-rustdoc-search C-bug T-rustdoc T-rustdoc-frontend
Dominant language
Rust
Stars
119k
Forks
16.1k
PR merge metrics
PR metrics pending

Description

Code

The search results only show the functions in the x86 module, but they are also exported by the x86_64 module.

https://doc.rust-lang.org/std/?search=_mm512_set4_epi32

Expected Outcome

The search results show the functions in both modules. It does actually exist

https://doc.rust-lang.org/core/arch/x86_64/fn._mm512_set4_epi32.html

Additional Details

This might just be a general problem with re-exported symbols? But for the intrinsics this is really confusing.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the query for _mm512_set4_epi32 at the linked standard-library search page and compare its results with the linked core::arch::x86_64 documentation. Trace rustdoc's handling of the intrinsic's exported modules; done means the search lists the function under both x86 and x86_64.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation, search
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.