Resolve documentation links in rustc and store the results in metadata #94857

petrochenkov · 2022-03-11T17:34:47Z

This PR implements MCP rust-lang/compiler-team#584.

Doc links are now resolved in rustc and stored into metadata, so rustdoc simply retrieves them through a query (local or extern),

Code that is no longer used is removed, and some code that no longer needs to be public is privatized.
The removed code includes resolver cloning, so this PR fixes #83761.

petrochenkov · 2022-03-11T17:35:08Z

@bors try @rust-timer queue

rust-timer · 2022-03-11T17:35:09Z

Awaiting bors try build completion.

@rustbot label: +S-waiting-on-perf

bors · 2022-03-11T17:35:19Z

⌛ Trying commit 2cf9c82db92b289f797a3639fa66646a7f7f7c59 with merge 4ba03cc378a00f3aa7982e3b28bf1be1ee8b5bb1...

jyn514

This is awesome ❤️ thank you so much for pushing this through.

compiler/rustc_resolve/src/lib.rs

src/librustdoc/core.rs

src/librustdoc/passes/collect_intra_doc_links/early.rs

src/test/rustdoc-ui/intra-doc/ambiguity.stderr

petrochenkov · 2022-03-11T20:29:09Z

@jyn514
This is far from being ready for review, I posted the PR in hope to get some upper limit on performance regressions.
So the answer to all of the review comments so far is "what did you expected from an in progress work".

petrochenkov · 2022-03-18T21:37:22Z

@bors try @rust-timer queue

rust-timer · 2022-03-18T21:37:23Z

Awaiting bors try build completion.

@rustbot label: +S-waiting-on-perf

bors · 2022-03-18T21:37:29Z

⌛ Trying commit a212f3f85fc2474fce8a7c6cf94f577a9a3cf558 with merge aa6d1b03317847cb190fc37c0d4674bf18f3a192...

bors · 2023-02-11T15:04:20Z

☀️ Test successful - checks-actions
Approved by: oli-obk
Pushing 5b45024 to master...

rust-timer · 2023-02-11T17:25:13Z

Finished benchmarking commit (5b45024): comparison URL.

Overall result: ❌✅ regressions and improvements - ACTION NEEDED

Next Steps: If you can justify the regressions found in this perf run, please indicate this with @rustbot label: +perf-regression-triaged along with sufficient written justification. If you cannot justify the regressions please open an issue or create a new PR that fixes the regressions, add a comment linking to the newly created issue or PR, and then add the perf-regression-triaged label to this PR.

@rustbot label: +perf-regression
cc @rust-lang/wg-compiler-performance

Instruction count

This is a highly reliable metric that was used to determine the overall result at the top of this comment.

	mean	range	count
Regressions ❌ (primary)	0.6%	[0.3%, 1.5%]	28
Regressions ❌ (secondary)	0.3%	[0.3%, 0.3%]	1
Improvements ✅ (primary)	-2.4%	[-5.7%, -0.6%]	17
Improvements ✅ (secondary)	-3.4%	[-5.2%, -0.6%]	21
All ❌✅ (primary)	-0.6%	[-5.7%, 1.5%]	45

Max RSS (memory usage)

Results

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

	mean	range	count
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	2.7%	[1.2%, 4.2%]	3
Improvements ✅ (primary)	-4.5%	[-7.9%, -1.9%]	15
Improvements ✅ (secondary)	-2.6%	[-8.1%, -1.3%]	20
All ❌✅ (primary)	-4.5%	[-7.9%, -1.9%]	15

Cycles

Results

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

	mean	range	count
Regressions ❌ (primary)	2.0%	[2.0%, 2.0%]	1
Regressions ❌ (secondary)	2.7%	[2.7%, 2.7%]	1
Improvements ✅ (primary)	-3.0%	[-4.9%, -1.8%]	10
Improvements ✅ (secondary)	-3.7%	[-4.7%, -1.7%]	17
All ❌✅ (primary)	-2.6%	[-4.9%, 2.0%]	11

rustdoc: Remove cache for preprocessed markdown links It's quite possible that it's no longer useful after rust-lang#94857 is merged.

…Simulacrum Print disk usage in PGO CI script To diagnose issues like rust-lang#94857 (comment).

rustc/rustdoc: Perform name resolver cleanups enabled by rust-lang#94857 Unblocks rust-lang#105462. r? `@oli-obk`

rylev · 2023-02-14T16:25:28Z

Going to label this as perf triaged based on the analysis here.

@rustbot label: perf-regression-triaged

This is a regression from rust-lang#94857.

… r=petrochenkov rustdoc: Don't crash on `crate` references in blocks This is a regression from rust-lang#94857.

rust-highfive assigned camelid Mar 11, 2022

rustbot added T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Mar 11, 2022

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Mar 11, 2022

rustbot added the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Mar 11, 2022

petrochenkov removed the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Mar 11, 2022

This comment has been minimized.

Sign in to view

This comment was marked as resolved.

Sign in to view

bors added the S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. label Mar 11, 2022

jyn514 reviewed Mar 11, 2022

View reviewed changes

petrochenkov removed the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Mar 11, 2022

This comment was marked as resolved.

Sign in to view

petrochenkov force-pushed the doclink2 branch from 2cf9c82 to ae37b6a Compare March 18, 2022 16:27

This comment was marked as resolved.

Sign in to view

petrochenkov force-pushed the doclink2 branch from ae37b6a to a212f3f Compare March 18, 2022 21:36

rustbot added the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Mar 18, 2022

bors mentioned this pull request Mar 18, 2022

Add use of bool::then in sys/unix/process #95058

Merged

This comment has been minimized.

Sign in to view

This comment was marked as resolved.

Sign in to view

petrochenkov force-pushed the doclink2 branch from a212f3f to c04bc71 Compare March 21, 2022 18:42

bors added the merged-by-bors This PR was explicitly merged by bors. label Feb 11, 2023

bors merged commit 5b45024 into rust-lang:master Feb 11, 2023

rustbot added this to the 1.69.0 milestone Feb 11, 2023

petrochenkov mentioned this pull request Feb 11, 2023

rustc_metadata: Encode the set of "rustdoc-reachable" def ids to metadata #107237

Closed

petrochenkov mentioned this pull request Feb 11, 2023

rustdoc: Remove cache for preprocessed markdown links #107933

Merged

matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Feb 13, 2023

Rollup merge of rust-lang#107922 - Kobzol:ci-print-disk-size, r=Mark-…

8674adc

…Simulacrum Print disk usage in PGO CI script To diagnose issues like rust-lang#94857 (comment).

weiznich mentioned this pull request Feb 13, 2023

Rustdoc Internal Compiler Error for Diesel #107995

Closed

bors added a commit to rust-lang-ci/rust that referenced this pull request Feb 14, 2023

Auto merge of rust-lang#107765 - petrochenkov:nomoclone, r=oli-obk

e9ab787

rustc/rustdoc: Perform name resolver cleanups enabled by rust-lang#94857 Unblocks rust-lang#105462. r? `@oli-obk`

rustbot added the perf-regression-triaged The performance regression has been triaged. label Feb 14, 2023

clubby789 mentioned this pull request Feb 23, 2023

rustdoc ICE: no resolutions for a doc link #108378

Closed

adrianheine added a commit to adrianheine/rust that referenced this pull request Mar 10, 2023

rustdoc: Don't crash on crate references in blocks

652291c

This is a regression from rust-lang#94857.

adrianheine mentioned this pull request Mar 10, 2023

rustdoc: Don't crash on crate references in blocks #108988

Merged

adrianheine added a commit to adrianheine/rust that referenced this pull request Mar 10, 2023

rustdoc: Don't crash on crate references in blocks

c84c5e6

This is a regression from rust-lang#94857.

matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Mar 11, 2023

Rollup merge of rust-lang#108988 - adrianheine:crate-reference-block,…

88554d1

… r=petrochenkov rustdoc: Don't crash on `crate` references in blocks This is a regression from rust-lang#94857.

matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Mar 11, 2023

Rollup merge of rust-lang#108988 - adrianheine:crate-reference-block,…

e12ba73

… r=petrochenkov rustdoc: Don't crash on `crate` references in blocks This is a regression from rust-lang#94857.

petrochenkov mentioned this pull request Mar 13, 2023

resolve: Querify most cstore access methods (subset) #108992

Merged

petrochenkov mentioned this pull request Apr 10, 2023

rustdoc: Correctly merge import's and its target's docs in one more case #109266

Merged

This was referenced Apr 11, 2023

docs.rs failing to resolve links to feature gated items even though all-features is set to true rust-lang/docs.rs#2100

Closed

No way to support cargo -Zrustdoc-map with re-exported docs from a proc-macro #110183

Open

lukas-code mentioned this pull request Apr 16, 2023

[stable] Prepare Rust 1.69.0 #110413

Merged

kadiwa4 mentioned this pull request Apr 16, 2023

ICE in rustdoc (rustc 1.69.0-beta.8) while documenting clap 3.2.23 #110412

Closed

matthiaskrgr mentioned this pull request Nov 14, 2023

ICE: resolve: unreachable!() #117920

Closed

tmandry mentioned this pull request Apr 25, 2024

Nondeterminism encountered in metadata for doc_link_resolutions #124357

Closed

lqd mentioned this pull request Nov 8, 2024

ICE building Leptos 0.7.0 release candidate #132743

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Resolve documentation links in rustc and store the results in metadata #94857

Resolve documentation links in rustc and store the results in metadata #94857

petrochenkov commented Mar 11, 2022 •

edited

Loading

petrochenkov commented Mar 11, 2022

rust-timer commented Mar 11, 2022

bors commented Mar 11, 2022

This comment has been minimized.

This comment has been minimized.

This comment was marked as resolved.

jyn514 left a comment

petrochenkov commented Mar 11, 2022

This comment was marked as resolved.

This comment was marked as resolved.

petrochenkov commented Mar 18, 2022

rust-timer commented Mar 18, 2022

bors commented Mar 18, 2022

This comment has been minimized.

This comment was marked as resolved.

bors commented Feb 11, 2023

rust-timer commented Feb 11, 2023

rylev commented Feb 14, 2023

Resolve documentation links in rustc and store the results in metadata #94857

Resolve documentation links in rustc and store the results in metadata #94857

Conversation

petrochenkov commented Mar 11, 2022 • edited Loading

petrochenkov commented Mar 11, 2022

rust-timer commented Mar 11, 2022

bors commented Mar 11, 2022

This comment has been minimized.

This comment has been minimized.

This comment was marked as resolved.

jyn514 left a comment

Choose a reason for hiding this comment

petrochenkov commented Mar 11, 2022

This comment was marked as resolved.

This comment was marked as resolved.

petrochenkov commented Mar 18, 2022

rust-timer commented Mar 18, 2022

bors commented Mar 18, 2022

This comment has been minimized.

This comment was marked as resolved.

bors commented Feb 11, 2023

rust-timer commented Feb 11, 2023

Overall result: ❌✅ regressions and improvements - ACTION NEEDED

Instruction count

Max RSS (memory usage)

Cycles

rylev commented Feb 14, 2023

petrochenkov commented Mar 11, 2022 •

edited

Loading