Mirrors/rust
1
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2026-04-26 13:01:27 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2844 from rust-lang/aj/rustc-internals-docs-clarity

Browse Source 
Mentions rustc-docs for rustc_private
This commit is contained in:
Tshepang Mbambo
2026-04-22 09:50:10 +02:00
committed by GitHub
parent c9711095bc 6f511f1218
commit f9566d6b10
1 changed files with 15 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/doc/rustc-dev-guide/src/rustc-driver/external-rustc-drivers.md
+15 -2
View File
@@ -71,9 +71,22 @@ When developing out-of-tree projects that use `rustc_private` crates, you can co
This configuration allows `rust-analyzer` to properly recognize and provide IDE support for `rustc_private` crates in out-of-tree projects.
### Getting Specific Nightly Documentation for `rustc_private`
### Getting Nightly Documentation for `rustc_private`
The nightly-rustc internal crates' documentation is only available for the latest nightly. If you depend on compiler internals from an older nightly, you may want to refer to the internal documentation from that particular nightly. The only way to do this is to generate the documentation locally. For example, to get documentation for `nightly-2025-11-08`:
#### Latest Nightly
For the latest nightly, you can install the `rustc-docs` component and open it directly in your browser:
```sh
rustup component add rustc-docs
rustup doc --rustc-docs
```
> Note: The `rustc-docs` component is only available for recent nightly toolchains and may not be present for every nightly date. It was first introduced in [PR #75560](https://github.com/rust-lang/rust/pull/75560) (August 2020).
#### Older Nightlies
If you depend on compiler internals from an older nightly, you may want to refer to the internal documentation from that particular nightly. The only way to do this is to generate the documentation locally. For example, to get documentation for `nightly-2025-11-08`:
Get the Git commit hash for that nightly: