Enable "jump to def" feature on rustc docs #136589
Open
+5
−2
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rustbot
added
S-waiting-on-review
jieyouxu
reviewed
Feb 5, 2025
Noratrieb
reviewed
Feb 5, 2025
| @@ -827,7 +827,7 @@ fn run_required_analyses(tcx: TyCtxt<'_>) { | |||
| if tcx.sess.opts.unstable_opts.input_stats { | |||
| rustc_passes::input_stats::print_hir_stats(tcx); | |||
| } | |||
| #[cfg(debug_assertions)] | |||
| #[cfg(all(not(doc), debug_assertions))] | |||
oli-obk
requested changes
Feb 5, 2025
Comment on lines
831
to
832
| // FIXME: `--generate-link-to-definition` tries to resolve cfged out code | ||
| // see https://github.com/rust-lang/rust/pull/122066#issuecomment-1983049222 |
There was a problem hiding this comment.
Is there an issue tracking getting rid of the cfged-out-code doc generating?
There was a problem hiding this comment.
Not that I know of.
""Normally"" we're supposed to do that already. The HIR visitor might provide it though (which is why it failed in the past), would be interesting to check why.
There was a problem hiding this comment.
So it might be that the cfg doc is not necessary? Can you test that? If it is necessary, please create a tracking issue
There was a problem hiding this comment.
The cfg doc is necessary, otherwise I get:
error[E0433]: failed to resolve: could not resolve path `rustc_passes::hir_id_validator::check_crate`
--> compiler/rustc_interface/src/passes.rs:833:5
|
833 | rustc_passes::hir_id_validator::check_crate(tcx);
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ could not resolve path `rustc_passes::hir_id_validator::check_crate`
|
Opened #136604.
rustbot
added
S-waiting-on-author
This comment has been minimized.
This comment has been minimized.
GuillaumeGomez
force-pushed
the
enable-jump-to-def-compiler
branch
from
646d530 to
e58aa21
Compare
|
Fixed indent and added code comment. |
|
@bors r+ |
bors
added
S-waiting-on-bors
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR enables the rustdoc "jump to def" feature which is visible on the source code pages.
r? @oli-obk