Enable `--generate-link-to-definition` rustdoc option on std docs by GuillaumeGomez · Pull Request #162808 · rust-lang/rust

GuillaumeGomez · 2026-09-15T12:17:16Z

In the future (unclear at which point), rustdoc plans to get closer to the rust compiler and compile more of the code, making the std code not compile anymore because of all the cfg(doc) in it to present a unified API to our users. To fix it (although incompletely), we can use the --generate-link-to-definition rustdoc option (which we already use in the compiler docs) which requires to query more information and fails with current std code. This PR fixes these errors and prevent regressions by enabling the new rustdoc option.

r? @Amanieu

GuillaumeGomez · 2026-09-15T12:18:54Z

+            $($code)*
+	}
+	#[cfg(doc)]
+	loop {}


This is a little hack to ensure that the code is not compiled and won't fail compilation whatever the return type since loop returns !.

View changes since the review

GuillaumeGomez · 2026-09-15T14:33:33Z

Seems like some work remains. Gonna convert it to draft for the time being.

@Urgau

…Urgau [rustdoc] Correctly handle `dyn` trait methods linking for jump to def feature Part of the missing pieces for rust-lang#162808 to work. The issue was that in case we had the method of a dyn trait, we tried to use the dyn trait as is and couldn't generate a correct href to its `DefId`. If we get the trait in the `dyn`, it works just as expected. r? @Urgau

@Urgau

Rollup merge of #163036 - GuillaumeGomez:dyn-jump-to-def, r=Urgau [rustdoc] Correctly handle `dyn` trait methods linking for jump to def feature Part of the missing pieces for #162808 to work. The issue was that in case we had the method of a dyn trait, we tried to use the dyn trait as is and couldn't generate a correct href to its `DefId`. If we get the trait in the `dyn`, it works just as expected. r? @Urgau

@Urgau

… r=Urgau [rustdoc] Correctly check that an item is not `doc(hidden)` with `--generate-link-to-definition` Needed for rust-lang#162808. The problem was that we only checked the item itself, not any of its parents. Fixed by adding a loop. r? @Urgau

@Urgau

Rollup merge of #163268 - GuillaumeGomez:jump-to-def-hidden, r=Urgau [rustdoc] Correctly check that an item is not `doc(hidden)` with `--generate-link-to-definition` Needed for #162808. The problem was that we only checked the item itself, not any of its parents. Fixed by adding a loop. r? @Urgau

@Urgau

…ent, r=Urgau [rustdoc] Fix invalid jump to def link when `#[rustc_allow_incoherent_impl]` is involved Fixes rust-lang#163112. Problem here is that the method is not available in the crate where the type is defined. So `def_path` is actually problematic here as it resolves to the end item, which is not what we want. So instead, I made a simplified version of the `rustc_middle::ty::print::pretty::try_print_visible_def_path_recur` function. It's also needed for rust-lang#162808. r? @Urgau

rust-bors · 2026-10-26T13:24:02Z

📌 Commit a39251d has been approved by Amanieu

It is now in the queue for this repository.

bjorn3 · 2026-10-26T16:51:33Z

"everybody loops" returns?

View changes since the review

I'm not sure I understand the question so I'll answer to "Is it an issue to use this attribute macro if the function returns something other than ()". Answer: loop returns !, so it covers every types. It's a little trick we used at some point in rustdoc to remove function bodies (before we realized you could have impl inside any block).

I was referring to the old everybody loops pass that rustdoc used to have, but then removed because it broke with RPIT. Seems like we have pretty much gone full circle except now you have to opt-in to the loop replacement instead.

JonathanBrouwer · 2026-10-26T18:55:51Z

💔 I suspect this PR failed tests as part of a rollup
@bors r-

After fixing the problem, consider running a try job for the failed job before re-approving.

Link to failure: #165000 (comment)

rust-bors · 2026-10-26T18:56:04Z

This pull request was unapproved.

This PR was contained in a rollup (#165000), which was unapproved.

View changes since this unapproval

GuillaumeGomez · 2026-10-26T22:27:00Z

@bors try jobs=test-aarch64-msvc-2,test-x86_64-msvc-1

GuillaumeGomez · 2026-10-26T22:28:34Z

Wait, why is my new commit not there? And why is it "processing updates". Github...

@bors cancel

rust-bors · 2026-10-26T22:28:37Z

❗ There is currently no auto build in progress on this PR.

Hint: There is a pending try build on this PR. Maybe you meant to cancel it? You can do that using @bors try cancel.

GuillaumeGomez · 2026-10-26T22:28:54Z

@bors try cancel

rust-bors · 2026-10-26T22:28:58Z

Try build cancelled. Cancelled workflows:

https://github.com/rust-lang/rust/actions/runs/40412594351

Hint: if you want to run another try build, you do not need to manually cancel the previous one. Just run @bors try and bors will cancel the previous build automatically.

GuillaumeGomez · 2026-10-26T22:33:59Z

@bors try jobs=test-aarch64-msvc-2,test-x86_64-msvc-1

rust-bors · 2026-10-27T01:16:25Z

☀️ Try build successful (CI)
Build commit: d4bb448 (d4bb4483838d5949ab8a87788a9b85170ae97c2e)
Base parent: 846e51f (846e51f66b1e7b49ba9e3988c58ccfe5817ce0a9)

…td::no_code` macro

…th separator

rustbot · 2026-10-27T08:52:30Z

This PR was rebased onto a different main commit. Here's a range-diff highlighting what actually changed.

Rebasing is a normal part of keeping PRs up to date, so no action is needed—this note is just to help reviewers.

GuillaumeGomez · 2026-10-27T08:52:43Z

Rebased just in case.

Also let's retry the previous jobs.

@bors try jobs=test-aarch64-msvc-2,test-x86_64-msvc-1

rust-bors · 2026-10-27T11:41:29Z

☀️ Try build successful (CI)
Build commit: 03d6406 (03d64068769d4d9c80471f4da26af97100968c35)
Base parent: 16d1ffa (16d1ffac17ad8b739e32483ac2e65fe7e1804977)

GuillaumeGomez · 2026-10-27T12:20:25Z

@bors r=Amanieu

rust-bors · 2026-10-27T12:20:28Z

📌 Commit 6623b95 has been approved by Amanieu

It is now in the queue for this repository.

rustbot assigned Amanieu Sep 15, 2026

GuillaumeGomez force-pushed the std-link-to-def branch from 9b47485 to b8ffb51 Compare September 15, 2026 12:18

GuillaumeGomez commented Sep 15, 2026

View reviewed changes

This comment has been minimized.

Sign in to view

GuillaumeGomez force-pushed the std-link-to-def branch from b8ffb51 to a514d28 Compare September 15, 2026 12:27

This comment has been minimized.

Sign in to view

GuillaumeGomez force-pushed the std-link-to-def branch from a514d28 to 9dfeec6 Compare September 15, 2026 13:10

This comment has been minimized.

Sign in to view

GuillaumeGomez force-pushed the std-link-to-def branch from 9dfeec6 to 4e3ffaf Compare September 15, 2026 13:50

rustbot added O-wasi Operating system: Wasi, Webassembly System Interface O-wasm Target: WASM (WebAssembly), http://webassembly.org/ labels Sep 15, 2026

This comment has been minimized.

Sign in to view

GuillaumeGomez marked this pull request as draft September 15, 2026 14:33

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 Sep 15, 2026

GuillaumeGomez mentioned this pull request Sep 19, 2026

[rustdoc] Correctly handle dyn trait methods linking for jump to def feature #163036

Merged

This was referenced Sep 21, 2026

[rustdoc] Fix invalid jump to def link when #[rustc_allow_incoherent_impl] is involved #163133

Merged

[rustdoc] Correctly check that an item is not doc(hidden) with --generate-link-to-definition #163268

Merged

This was referenced Oct 26, 2026

Rollup of 9 pull requests #164991

Closed

Rollup of 12 pull requests #165000

Closed

bjorn3 reviewed Oct 26, 2026

View reviewed changes

This comment has been minimized.

Sign in to view

GuillaumeGomez added 5 commits October 27, 2026 09:52

Enable --generate-link-to-definition rustdoc option on std docs

800ff08

Create new builtin rustc macro rustdoc_skip_body and replace the `s…

f6db3da

…td::no_code` macro

Disable unused_macros check on rustdoc_skip_body

4d2c7ad

Ignore more std functions body

b8a7bef

Stop using Path on Windows to generate URLs because of wrong \ pa…

6623b95

…th separator

This comment has been minimized.

Sign in to view

This was referenced Oct 27, 2026

Rollup of 24 pull requests #165038

Closed

Rollup of 22 pull requests #165051

Closed

Rollup of 21 pull requests #165056

Open

Conversation

GuillaumeGomez commented Sep 15, 2026 • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

GuillaumeGomez Sep 15, 2026 • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

GuillaumeGomez commented Sep 15, 2026

Uh oh!

rust-bors Bot commented Oct 26, 2026

Uh oh!

bjorn3 Oct 26, 2026 • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez Oct 26, 2026

Choose a reason for hiding this comment

Uh oh!

bjorn3 Oct 26, 2026

Choose a reason for hiding this comment

Uh oh!

JonathanBrouwer commented Oct 26, 2026

Uh oh!

rust-bors Bot commented Oct 26, 2026

Uh oh!

GuillaumeGomez commented Oct 26, 2026

Uh oh!

This comment has been minimized.

GuillaumeGomez commented Oct 26, 2026

Uh oh!

rust-bors Bot commented Oct 26, 2026

Uh oh!

GuillaumeGomez commented Oct 26, 2026

Uh oh!

rust-bors Bot commented Oct 26, 2026

Uh oh!

GuillaumeGomez commented Oct 26, 2026

Uh oh!

This comment has been minimized.

This comment has been minimized.

rust-bors Bot commented Oct 27, 2026

Uh oh!

rustbot commented Oct 27, 2026

Uh oh!

GuillaumeGomez commented Oct 27, 2026

Uh oh!

This comment has been minimized.

rust-bors Bot commented Oct 27, 2026

Uh oh!

GuillaumeGomez commented Oct 27, 2026

Uh oh!

rust-bors Bot commented Oct 27, 2026

Uh oh!

This branch has not been deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

GuillaumeGomez commented Sep 15, 2026 •

edited by rustbot

Loading

GuillaumeGomez Sep 15, 2026 •

edited by rustbot

Loading

bjorn3 Oct 26, 2026 •

edited by rustbot

Loading