Enable "jump to def" feature on rustc docs by GuillaumeGomez · Pull Request #136589 · rust-lang/rust

GuillaumeGomez · 2025-02-05T16:24:07Z

This PR enables the rustdoc "jump to def" feature which is visible on the source code pages.

src/bootstrap/src/core/build_steps/doc.rs

Noratrieb · 2025-02-05T16:32:12Z

compiler/rustc_interface/src/passes.rs

        rustc_passes::input_stats::print_hir_stats(tcx);
    }
-    #[cfg(debug_assertions)]
+    #[cfg(all(not(doc), debug_assertions))]


can you add a comment here?

src/bootstrap/src/core/build_steps/doc.rs

oli-obk · 2025-02-05T16:32:09Z

src/bootstrap/src/core/build_steps/doc.rs

        // FIXME: `--generate-link-to-definition` tries to resolve cfged out code
        // see https://github.com/rust-lang/rust/pull/122066#issuecomment-1983049222


Is there an issue tracking getting rid of the cfged-out-code doc generating?

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.

So it might be that the cfg doc is not necessary? Can you test that? If it is necessary, please create a tracking issue

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.

GuillaumeGomez · 2025-02-05T17:21:31Z

Fixed indent and added code comment.

oli-obk · 2025-02-05T20:24:20Z

@bors r+

bors · 2025-02-05T20:24:24Z

📌 Commit e58aa21 has been approved by oli-obk

It is now in the queue for this repository.

…compiler, r=oli-obk Enable "jump to def" feature on rustc docs This PR enables the rustdoc "jump to def" feature which is visible on the source code pages. r? `@oli-obk`

…kingjubilee Rollup of 9 pull requests Successful merges: - rust-lang#135439 (Make `-O` mean `OptLevel::Aggressive`) - rust-lang#136193 (Implement pattern type ffi checks) - rust-lang#136235 (Pretty print pattern type values with transmute if they don't satisfy their pattern) - rust-lang#136311 (Ensure that we never try to monomorphize the upcasting or vtable calls of impossible dyn types) - rust-lang#136315 (Use short ty string for binop and unop errors) - rust-lang#136393 (Fix accidentally not emitting overflowing literals lints anymore in patterns) - rust-lang#136530 (Implement `x perf` directly in bootstrap) - rust-lang#136580 (Couple of changes to run rustc in miri) - rust-lang#136589 (Enable "jump to def" feature on rustc docs) r? `@ghost` `@rustbot` modify labels: rollup

…compiler, r=oli-obk Enable "jump to def" feature on rustc docs This PR enables the rustdoc "jump to def" feature which is visible on the source code pages. r? `@oli-obk`

…iaskrgr Rollup of 7 pull requests Successful merges: - rust-lang#135179 (Make sure to use `Receiver` trait when extracting object method candidate) - rust-lang#136554 (Add `opt_alias_variances` and use it in outlives code) - rust-lang#136556 ([AIX] Update tests/ui/wait-forked-but-failed-child.rs to accomodate exiting and idle processes.) - rust-lang#136589 (Enable "jump to def" feature on rustc docs) - rust-lang#136615 (sys: net: Add UEFI stubs) - rust-lang#136635 (Remove outdated `base_port` calculation in std net test) - rust-lang#136682 (Move two windows process tests to tests/ui) r? `@ghost` `@rustbot` modify labels: rollup

Rollup merge of rust-lang#136589 - GuillaumeGomez:enable-jump-to-def-compiler, r=oli-obk Enable "jump to def" feature on rustc docs This PR enables the rustdoc "jump to def" feature which is visible on the source code pages. r? ``@oli-obk``

…,GuillaumeGomez Re-enable `--generate-link-to-defintion` for tools internal rustdoc ~~These were removed because they used to break the build: rust-lang#122066 (comment), but testing locally it seems to work now.~~ This was re enabled in rust-lang#136589, but only for rustc, not tools. The FIXME that prompted removing this is still present. Do we have an issue with an MCVE for this? CC `@GuillaumeGomez` https://github.com/rust-lang/rust/blob/ac91805f3179fc2225c60e8ccf5a1daa09d43f3d/src/librustdoc/html/render/span_map.rs#L178-L182 try-job: aarch64-apple

…,GuillaumeGomez Re-enable `--generate-link-to-defintion` for tools internal rustdoc ~~These were removed because they used to break the build: rust-lang#122066 (comment), but testing locally it seems to work now.~~ This was re enabled in rust-lang#136589, but only for rustc, not tools. The FIXME that prompted removing this is still present. Do we have an issue with an MCVE for this? CC ``@GuillaumeGomez`` https://github.com/rust-lang/rust/blob/ac91805f3179fc2225c60e8ccf5a1daa09d43f3d/src/librustdoc/html/render/span_map.rs#L178-L182 try-job: aarch64-apple

…,GuillaumeGomez Re-enable `--generate-link-to-defintion` for tools internal rustdoc ~~These were removed because they used to break the build: rust-lang#122066 (comment), but testing locally it seems to work now.~~ This was re enabled in rust-lang#136589, but only for rustc, not tools. The FIXME that prompted removing this is still present. Do we have an issue with an MCVE for this? CC ```@GuillaumeGomez``` https://github.com/rust-lang/rust/blob/ac91805f3179fc2225c60e8ccf5a1daa09d43f3d/src/librustdoc/html/render/span_map.rs#L178-L182 try-job: aarch64-apple

Rollup merge of rust-lang#137693 - aDotInTheVoid:gaming, r=onur-ozkan,GuillaumeGomez Re-enable `--generate-link-to-defintion` for tools internal rustdoc ~~These were removed because they used to break the build: rust-lang#122066 (comment), but testing locally it seems to work now.~~ This was re enabled in rust-lang#136589, but only for rustc, not tools. The FIXME that prompted removing this is still present. Do we have an issue with an MCVE for this? CC ```@GuillaumeGomez``` https://github.com/rust-lang/rust/blob/ac91805f3179fc2225c60e8ccf5a1daa09d43f3d/src/librustdoc/html/render/span_map.rs#L178-L182 try-job: aarch64-apple

…iaskrgr Rollup of 7 pull requests Successful merges: - rust-lang#135179 (Make sure to use `Receiver` trait when extracting object method candidate) - rust-lang#136554 (Add `opt_alias_variances` and use it in outlives code) - rust-lang#136556 ([AIX] Update tests/ui/wait-forked-but-failed-child.rs to accomodate exiting and idle processes.) - rust-lang#136589 (Enable "jump to def" feature on rustc docs) - rust-lang#136615 (sys: net: Add UEFI stubs) - rust-lang#136635 (Remove outdated `base_port` calculation in std net test) - rust-lang#136682 (Move two windows process tests to tests/ui) r? `@ghost` `@rustbot` modify labels: rollup

rustbot assigned oli-obk Feb 5, 2025

jieyouxu reviewed Feb 5, 2025

View reviewed changes

src/bootstrap/src/core/build_steps/doc.rs Outdated Show resolved Hide resolved

Noratrieb reviewed Feb 5, 2025

View reviewed changes

oli-obk requested changes Feb 5, 2025

View reviewed changes

rustbot added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Feb 5, 2025

This comment has been minimized.

Sign in to view

Re-enable "jump to def" feature on rustc docs

e58aa21

GuillaumeGomez force-pushed the enable-jump-to-def-compiler branch from 646d530 to e58aa21 Compare February 5, 2025 16:40

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Feb 5, 2025

workingjubilee mentioned this pull request Feb 6, 2025

Rollup of 9 pull requests #136614

Closed

This was referenced Feb 7, 2025

Rollup of 8 pull requests #136711

Closed

Rollup of 7 pull requests #136713

Merged

bors merged commit 688fc9b into rust-lang:master Feb 8, 2025
6 checks passed

rustbot added this to the 1.86.0 milestone Feb 8, 2025

GuillaumeGomez deleted the enable-jump-to-def-compiler branch February 10, 2025 09:39

GuillaumeGomez mentioned this pull request Feb 26, 2025

Re-enable --generate-link-to-defintion for tools internal rustdoc #137693

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Enable "jump to def" feature on rustc docs#136589

Enable "jump to def" feature on rustc docs#136589
bors merged 1 commit intorust-lang:masterfrom
GuillaumeGomez:enable-jump-to-def-compiler

GuillaumeGomez commented Feb 5, 2025

Uh oh!

Uh oh!

Noratrieb Feb 5, 2025

Uh oh!

GuillaumeGomez Feb 5, 2025

Uh oh!

Uh oh!

oli-obk Feb 5, 2025

Uh oh!

GuillaumeGomez Feb 5, 2025

Uh oh!

oli-obk Feb 5, 2025

Uh oh!

GuillaumeGomez Feb 5, 2025

Uh oh!

This comment has been minimized.

GuillaumeGomez commented Feb 5, 2025

Uh oh!

oli-obk commented Feb 5, 2025

Uh oh!

bors commented Feb 5, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

		// FIXME: `--generate-link-to-definition` tries to resolve cfged out code
		// see https://github.com/rust-lang/rust/pull/122066#issuecomment-1983049222

Uh oh!

Conversation

GuillaumeGomez commented Feb 5, 2025

Uh oh!

Uh oh!

Noratrieb Feb 5, 2025

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez Feb 5, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

oli-obk Feb 5, 2025

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez Feb 5, 2025

Choose a reason for hiding this comment

Uh oh!

oli-obk Feb 5, 2025

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez Feb 5, 2025

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

GuillaumeGomez commented Feb 5, 2025

Uh oh!

oli-obk commented Feb 5, 2025

Uh oh!

bors commented Feb 5, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants