-
Notifications
You must be signed in to change notification settings - Fork 880
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 of rustc
internals
#3717
Comments
@Ethiraric Thanks a lot for filing this issue! However, Since you're developing a particular project (which is |
Thank you for your reply! Unless I am mistaken, In the documentation that is generated for clippy items, any reference to one of rustc's internal crates redirects to doc.rust-lang.org. I understand that |
@Ethiraric I'm sorry to hear that! On Rustup's side we simply open the prebuilt docs downloaded from the official server with your default browser. The path of the docs relative to your toolchain distribution (by default under rustup/src/toolchain/toolchain.rs Lines 295 to 304 in ce3c09a
... which just means Lines 1545 to 1563 in b4b9a2e
You should be able to find all the docs over there on your disk, actually. Your feature request is still valid, I think, but it would be a more involved process. We should look at whether to ship these docs offline, and if so, in which distributions (just nightly, I assume?), and how exactly to build them. In short, we also have to inform t-release to make some changes to the main Rust repo. PS: I've created a new thread on Zulip: https://rust-lang.zulipchat.com/#narrow/stream/241545-t-release/topic/Ship.20Rustc.20internal.20API.20docs.20with.20Rustup.3F |
I see. Thanks for all the details! ❤️ If there is something I, as a newcomer to this repository, can act upon, do feel free to reach out to me! I'll fall back to downloading a copy of |
Getting rustc docs into rustup is absolutely doable; the starting point is to get that into the docs packages that we download. |
Oops, looks like it's already there on the server, but Rustup is refusing to install that component (rust-lang/rust#75833)! info: installing component 'rustc-docs'
info: rolling back changes
error: failed to install component: 'rustc-docs-x86_64-unknown-linux-gnu', detected conflict: '"share/doc/rust/html/rustc"' |
Problem you are trying to solve
I've been trying my hands at solving some
clippy
issues recently and userustup doc --std
frequently, but I see no option to get the documentation ofrustc
/nightly-rustc
itself. Unless I separately downloadrustc
's source, I can't access the documentation.What I'm looking for would be the local copy of https://doc.rust-lang.org/stable/nightly-rustc/
I have found nowhere in a
--help
something that would lead me to that documentation locally.Solution you'd like
Having a subcommand such as
rustup doc --rustc-doc
would ideally be the best solution.Notes
I wouldn't mind tackling this issue if given a bit of guidance and it's not too complex to solve.
The text was updated successfully, but these errors were encountered: