Enable --generate-link-to-definition rustdoc option on std docs - #162808
Draft
GuillaumeGomez wants to merge 1 commit into
Draft
GuillaumeGomez wants to merge 1 commit into
GuillaumeGomez wants to merge 1 commit into
Conversation
GuillaumeGomez
force-pushed
the
std-link-to-def
branch
from
September 15, 2026 12:18
9b47485 to
b8ffb51
Compare
GuillaumeGomez
commented
Sep 15, 2026
| $($code)* | ||
| } | ||
| #[cfg(doc)] | ||
| loop {} |
Member
Author
There was a problem hiding this comment.
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 !.
This comment has been minimized.
This comment has been minimized.
GuillaumeGomez
force-pushed
the
std-link-to-def
branch
from
September 15, 2026 12:27
b8ffb51 to
a514d28
Compare
This comment has been minimized.
This comment has been minimized.
GuillaumeGomez
force-pushed
the
std-link-to-def
branch
from
September 15, 2026 13:10
a514d28 to
9dfeec6
Compare
This comment has been minimized.
This comment has been minimized.
GuillaumeGomez
force-pushed
the
std-link-to-def
branch
from
September 15, 2026 13:50
9dfeec6 to
4e3ffaf
Compare
Collaborator
|
The job Click to see the possible cause of the failure (guessed by this bot) |
Member
Author
|
Seems like some work remains. Gonna convert it to draft for the time being. |
GuillaumeGomez
marked this pull request as draft
September 15, 2026 14:33
JonathanBrouwer
added a commit
to JonathanBrouwer/rust
that referenced
this pull request
Sep 20, 2026
…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
rust-bors Bot
pushed a commit
that referenced
this pull request
Sep 21, 2026
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
jhpratt
added a commit
to jhpratt/rust
that referenced
this pull request
Sep 25, 2026
… 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
JonathanBrouwer
added a commit
to JonathanBrouwer/rust
that referenced
this pull request
Sep 25, 2026
…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
jhpratt
added a commit
to jhpratt/rust
that referenced
this pull request
Sep 26, 2026
…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 Bot
pushed a commit
that referenced
this pull request
Sep 26, 2026
Rollup merge of #163133 - GuillaumeGomez:jump-to-def-incoherent, r=Urgau [rustdoc] Fix invalid jump to def link when `#[rustc_allow_incoherent_impl]` is involved Fixes #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 #162808. r? @Urgau
This branch has not been deployed
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
In the future (unclear at which point), rustdoc plans to get closer to the rust compiler and compile more of the code, making the
stdcode not compile anymore because of all thecfg(doc)in it to present a unified API to our users. To fix it (although incompletely), we can use the--generate-link-to-definitionrustdoc option (which we already use in the compiler docs) which requires to query more information and fails with currentstdcode. This PR fixes these errors and prevent regressions by enabling the new rustdoc option.r? @Amanieu