Skip to content

std::arch docs are missing (404) #61038

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

Closed
kornelski opened this issue May 22, 2019 · 5 comments
Closed

std::arch docs are missing (404) #61038

kornelski opened this issue May 22, 2019 · 5 comments
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools

Comments

@kornelski
Copy link
Contributor

kornelski commented May 22, 2019

The std::arch module is not documented since 1.34 release:

@hellow554
Copy link
Contributor

hellow554 commented May 22, 2019

https://doc.rust-lang.org/1.34.0/src/std/lib.rs.html#361

#[doc(no_inline)]

CC #57808

Docs can now be found in https://doc.rust-lang.org/core/arch/index.html which won't show up at the top for reasons™... :/

@rustbot modify labels: T-doc

@rustbot rustbot added the A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools label May 22, 2019
@hellow554
Copy link
Contributor

@gnzlbg maybe you can enlighten me, why you choose #[doc(no_inline)]?

@gnzlbg
Copy link
Contributor

gnzlbg commented May 22, 2019

maybe you can enlighten me, why you choose #[doc(no_inline)]?

See #57808 (comment) and the conversation around that.

@kornelski
Copy link
Contributor Author

OK. It's intentional.

Google still ranks older version of /std/…/arch higher than latest /core/arch, but that's another problem.

@gnzlbg
Copy link
Contributor

gnzlbg commented May 23, 2019

FWIW I think that we should try to do better here.

In stdsimd itself, we just provide different docs of the crates, one for each target. In libc we do the same. But libstd tries to compile libcore/liballoc/libstd for all targets/target-features/... at once, and then generate a single "doc" web-site containing the info for all of them at once, and to present it nicely. The problem itself is hard, and the current approach has limitations like this one.

@QuietMisdreavus an alternative here would be to not try to generate the docs all at once, but to, e.g., compile the libstd docs for the different targets, generating multiple docs, and then as a post-processing step, manually merge them for the core::arch/std::arch modules.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools
Projects
None yet
Development

No branches or pull requests

4 participants