Skip to content

rustc internals docs clarification#2839

Merged
amanjeev merged 3 commits intomainfrom
aj/rustc-internals-docs-clarity
Apr 19, 2026
Merged

rustc internals docs clarification#2839
amanjeev merged 3 commits intomainfrom
aj/rustc-internals-docs-clarity

Conversation

@amanjeev
Copy link
Copy Markdown
Member

Ran into this recently, so thought maybe adding this to the dev guide makes it clearer and searchable/discoverable.

  • Only latest nightly crates' docs are published
  • How to get an old nightly docs

- Only latest nightly crates' docs are published
- How to get an old nightly docs
@rustbot
Copy link
Copy Markdown
Collaborator

rustbot commented Apr 18, 2026

Thanks for the PR. If you have write access, feel free to merge this PR if it does not need reviews. You can request a review using r? rustc-dev-guide or r? <username>.

@rustbot rustbot added the S-waiting-on-review Status: this PR is waiting for a reviewer to verify its content label Apr 18, 2026
@amanjeev amanjeev self-assigned this Apr 18, 2026
@amanjeev amanjeev requested a review from tshepang April 18, 2026 19:04
Copy link
Copy Markdown
Member

@tshepang tshepang Apr 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see there is a rustup component that includes compiler api docs, rustc-docs

❯ rustup component add rustc-docs
info: downloading component rustc-docs
   rustc-docs installed                       32.34 MiB
❯ rustup doc --rustc-docs
Opening docs named `rustc-docs` in your browser

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In my experience this did not add the internal rustc docs.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the component was added several weeks ago, and yeah, it does not exist for your example nightly

Comment thread src/rustc-driver/external-rustc-drivers.md Outdated
@amanjeev amanjeev requested a review from tshepang April 18, 2026 22:26
@amanjeev amanjeev merged commit e31191f into main Apr 19, 2026
1 check passed
@rustbot rustbot removed the S-waiting-on-review Status: this PR is waiting for a reviewer to verify its content label Apr 19, 2026

### Getting Specific 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`:
Copy link
Copy Markdown
Member

@tshepang tshepang Apr 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • this does not make it clear what nightly-rustc means... I assume that it means from the website
  • it should at least mention that the docs are available via rustup

View changes since the review

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

Successfully merging this pull request may close these issues.

3 participants