Skip to content
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

Rework the driver docs #2162

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

bjorn3
Copy link
Member

@bjorn3 bjorn3 commented Dec 15, 2024

The removal of driver queries has changed the way rustc_interface can be used. I've also changed things a bit to fix things that were wrong in the docs even before the driver query removal. And finally this is now recommends using rustc_driver over rustc_interface like most tools are already doing. The rustc_driver api is a bit more stable and much easier to use when you don't need the flexibility of rustc_interface as is the case almost all the time. Rustdoc is one of the few tools that needs the flexibility of rustc_interface.

Blocked on rust-lang/rust#134302 and testing the updated examples.

The removal of driver queries has changed the way rustc_interface can be
used. I've also changed things a bit to fix things that were wrong in
the docs even before the driver query removal. And finally this is now
recommends using rustc_driver over rustc_interface like most tools are
already doing. The rustc_driver api is a bit more stable and much easier
to use when you don't need the flexibility of rustc_interface as is the
case almost all the time. Rustdoc is one of the few tools that needs the
flexibility of rustc_interface.
@bjorn3 bjorn3 added the A-custom-driver Area: custom driver label Dec 15, 2024
@jieyouxu jieyouxu added the S-blocked Status: this PR is blocked waiting for something label Dec 15, 2024
@jieyouxu jieyouxu self-assigned this Dec 15, 2024
@jieyouxu jieyouxu added T-compiler Relevant to compiler team A-driver Area: rustc driver labels Dec 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-custom-driver Area: custom driver A-driver Area: rustc driver S-blocked Status: this PR is blocked waiting for something T-compiler Relevant to compiler team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants