rustdoc: Optimize and refactor doc link resolution by petrochenkov · Pull Request #96135 · rust-lang/rust

petrochenkov · 2022-04-17T00:39:49Z

One more subset of #94857 that should bring perf improvements rather than regressions + a couple more optimizations on top of it.
It's better to read individual commits and their descriptions to understand the changes.
The may_have_doc_links optimization is not very useful here, but it's much more important for #94857.

Closes#96079

rust-highfive · 2022-04-17T00:39:51Z

Hey! It looks like you've submitted a new PR for the library teams!

If this PR contains changes to any rust-lang/rust public library APIs then please comment with r? rust-lang/libs-api @rustbot label +T-libs-api -T-libs to request review from a libs-api team reviewer. If you're unsure where your change falls no worries, just leave it as is and the reviewer will take a look and make a decision to forward on if necessary.

Examples of T-libs-api changes:

Stabilizing library features
Introducing insta-stable changes such as new implementations of existing stable traits on existing stable types
Introducing new or changing existing unstable library APIs (excluding permanently unstable features / features without a tracking issue)
Changing public documentation in ways that create new stability guarantees
Changing observable runtime behavior of library APIs

Some changes occurred in clean/types.rs.

cc @camelid

rust-highfive · 2022-04-17T00:39:53Z

r? @GuillaumeGomez

(rust-highfive has picked a reviewer for you, use r? to override)

petrochenkov · 2022-04-17T00:39:59Z

@bors try @rust-timer queue

rust-timer · 2022-04-17T00:40:00Z

Awaiting bors try build completion.

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

bors · 2022-04-17T00:40:06Z

⌛ Trying commit afd1ce9da528a376d8bf532fc73ea6b30f96081f with merge 17cff29288d7f9f1378ebd548ff5a4994de8c57c...

petrochenkov · 2022-04-17T20:22:19Z

@bors try @rust-timer queue

rust-timer · 2022-04-17T20:22:21Z

Awaiting bors try build completion.

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

bors · 2022-04-17T20:22:27Z

⌛ Trying commit 76077f923a7536b844a854078dcfa093524c5c27 with merge cd5dce912ebe17db000b68c530333a49ad85d462...

bors · 2022-04-17T21:46:55Z

☀️ Try build successful - checks-actions
Build commit: cd5dce912ebe17db000b68c530333a49ad85d462 (cd5dce912ebe17db000b68c530333a49ad85d462)

rust-timer · 2022-04-17T21:46:56Z

Queued cd5dce912ebe17db000b68c530333a49ad85d462 with parent 1ec2c13, future comparison URL.

rust-timer · 2022-04-18T00:23:24Z

Finished benchmarking commit (cd5dce912ebe17db000b68c530333a49ad85d462): comparison url.

Summary:

Primary benchmarks: mixed results
Secondary benchmarks: 🎉 relevant improvements found

	Regressions 😿 (primary)	Regressions 😿 (secondary)	Improvements 🎉 (primary)	Improvements 🎉 (secondary)	All 😿 🎉 (primary)
count¹	6	2	14	19	20
mean²	0.4%	0.5%	-1.2%	-0.8%	-0.7%
max	0.4%	0.7%	-2.1%	-1.0%	-2.1%

If you disagree with this performance assessment, please file an issue in rust-lang/rustc-perf.

Benchmarking this pull request likely means that it is perf-sensitive, so we're automatically marking it as not fit for rolling up. While you can manually mark this PR as fit for rollup, we strongly recommend not doing so since this PR may lead to changes in compiler perf.

Next Steps: If you can justify the regressions found in this try perf run, please indicate this with @rustbot label: +perf-regression-triaged along with sufficient written justification. If you cannot justify the regressions please fix the regressions and do another perf run. If the next run shows neutral or positive results, the label will be automatically removed.

@bors rollup=never
@rustbot label: +S-waiting-on-review -S-waiting-on-perf +perf-regression

number of relevant changes↩
the arithmetic mean of the percent change↩

GuillaumeGomez · 2022-04-18T13:02:46Z

Seems like you're almost done in here! :D

petrochenkov · 2022-04-18T13:11:39Z

@GuillaumeGomez
This PR should be ready.

tt-muncher seems to fluctuate a lot for reasons unrelated to this PR.
stm32f4 has a huge number of items with doc attributes, so the ~0.4% regression from encoding metadata is an expected tradeoff for faster documentation generation.

petrochenkov · 2022-04-19T20:41:59Z

@GuillaumeGomez
Updated with the test from #96216.

Kobzol · 2022-04-19T21:58:12Z

markdown_links is very expensive and is responsible for majority of runtime regression in #94857, preprocess_link is also somewhat expensive.

Are there any specific crates in the benchmark suite that use these doc links a lot? I can try to profile them and look for potential bottlenecks.

GuillaumeGomez · 2022-04-19T22:36:12Z

Thanks @petrochenkov ! Let's go then. :)

@bors: r+

bors · 2022-04-19T22:36:13Z

📌 Commit ca5c752 has been approved by GuillaumeGomez

GuillaumeGomez · 2022-04-19T22:36:21Z

@bors rollup=never

petrochenkov · 2022-04-20T07:00:19Z

@Kobzol
Standard library.
If you build rustdoc with #94857 and run it on hello-world, you'll see markdown_links at the top of the profile inside early_resolve_intra_doc_links.
(It happens because with #94857 rustdoc pulls impl items with their docs from dependency crates too eagerly.)

bors · 2022-04-20T13:34:51Z

⌛ Testing commit ca5c752 with merge d39864d...

bors · 2022-04-20T16:15:48Z

☀️ Test successful - checks-actions
Approved by: GuillaumeGomez
Pushing d39864d to master...

rust-timer · 2022-04-20T17:17:19Z

Finished benchmarking commit (d39864d): comparison url.

Summary:

Primary benchmarks: mixed results
Secondary benchmarks: 🎉 relevant improvements found

	Regressions 😿 (primary)	Regressions 😿 (secondary)	Improvements 🎉 (primary)	Improvements 🎉 (secondary)	All 😿 🎉 (primary)
count¹	6	0	14	20	20
mean²	0.3%	N/A	-1.3%	-0.7%	-0.9%
max	0.3%	N/A	-2.7%	-1.0%	-2.7%

If you disagree with this performance assessment, please file an issue in rust-lang/rustc-perf.

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

number of relevant changes↩
the arithmetic mean of the percent change↩

…nks-filtering, r=notriddle Prevent `<>` links to be interpreted for intra-doc links As discussed in [this thread](rust-lang#96135 (comment)). As mentioned, the intra-doc RFC states that `<>` links shouldn't be potential intra-doc links: https://rust-lang.github.io/rfcs/1946-intra-rustdoc-links.html#no-autolinks-style. I renamed `markdown_links` into `potential_intra_doc_markdown_links` to make it more obvious what it's doing. cc `@petrochenkov` r? `@notriddle`

rustdoc: Optimize IdMap Slightly optimizes `IdMap`, which is hot in `markdown_links` (context [here](rust-lang#96135 (comment))). There are more improvements that can be made near this place, but this seemed like an easy win locally (although I tried it on top of rust-lang#94857, so let's see what happens without that PR). r? `@petrochenkov`

rylev · 2022-04-26T10:44:46Z

@petrochenkov said:

stm32f4 has a huge number of items with doc attributes, so the ~0.4% regression from encoding metadata is an expected tradeoff for faster documentation generation.

Given that besides that benchmark, this is a win (and sometimes a big one), I'll mark this as triaged.

@rustbot label: +perf-regression-triaged

rustdoc: Resolve doc links on fields during early resolution Another subset of rust-lang#94857 which fixesrust-lang#96429. This case regressed in rust-lang#96135 when `may_have_doc_links`-based filtering was introduced. Before that filtering structs could collect traits in scope for their fields, but after the filtering structs won't collect anything if they don't have doc comments on them, so we have to visit fields too.

rust-highfive assigned GuillaumeGomez Apr 17, 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 Apr 17, 2022

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

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

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

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 Apr 17, 2022

This comment was marked as resolved.
Sign in to view

petrochenkov force-pushed the doclink6 branch from afd1ce9 to 76077f9Compare April 17, 2022 20:18

petrochenkov removed the S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. label Apr 17, 2022

rustbot added perf-regression Performance regression. S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-perf Status: Waiting on a perf run to be completed. labels Apr 18, 2022

GuillaumeGomez reviewed Apr 18, 2022
View reviewed changes

Comment threadcompiler/rustc_ast/src/util/comments.rs Outdated

petrochenkov force-pushed the doclink6 branch from 0f79748 to ca5c752Compare April 19, 2022 20:41

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-review Status: Awaiting review from the assignee but also interested parties. labels Apr 19, 2022

bors added the merged-by-bors This PR was explicitly merged by bors. label Apr 20, 2022

bors merged commit d39864d into rust-lang:masterApr 20, 2022

rustbot added this to the 1.62.0 milestone Apr 20, 2022

This was referenced Apr 20, 2022
don't encode only locally used attrs #95562
Merged
Rollup of 6 pull requests #96203
Closed

Kobzol mentioned this pull request Apr 20, 2022
rustdoc: Optimize IdMap #96260
Merged

GuillaumeGomez mentioned this pull request Apr 23, 2022
Remove BadImplStripper code #96337
Closed

rustbot added the perf-regression-triaged The performance regression has been triaged. label Apr 26, 2022

petrochenkov mentioned this pull request Apr 26, 2022
rustdoc: Resolve doc links on fields during early resolution #96447
Merged

petrochenkov deleted the doclink6 branch February 22, 2025 18:30

Uh oh!

Uh oh!

Conversation

petrochenkov commented Apr 17, 2022• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rust-highfive commented Apr 17, 2022

Uh oh!

rust-highfive commented Apr 17, 2022

Uh oh!

petrochenkov commented Apr 17, 2022

Uh oh!

rust-timer commented Apr 17, 2022

Uh oh!

bors commented Apr 17, 2022

Uh oh!

This comment was marked as resolved.

This comment was marked as resolved.

petrochenkov commented Apr 17, 2022

Uh oh!

rust-timer commented Apr 17, 2022

Uh oh!

bors commented Apr 17, 2022

Uh oh!

bors commented Apr 17, 2022

Uh oh!

rust-timer commented Apr 17, 2022

Uh oh!

rust-timer commented Apr 18, 2022

Footnotes

Uh oh!

GuillaumeGomez commented Apr 18, 2022• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

petrochenkov commented Apr 18, 2022

Uh oh!

Uh oh!

petrochenkov commented Apr 19, 2022

Uh oh!

Kobzol commented Apr 19, 2022

Uh oh!

GuillaumeGomez commented Apr 19, 2022

Uh oh!

bors commented Apr 19, 2022

Uh oh!

GuillaumeGomez commented Apr 19, 2022

Uh oh!

petrochenkov commented Apr 20, 2022

Uh oh!

bors commented Apr 20, 2022

Uh oh!

bors commented Apr 20, 2022

Uh oh!

rust-timer commented Apr 20, 2022

Footnotes

Uh oh!

rylev commented Apr 26, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

12 participants

petrochenkov commented Apr 17, 2022•
edited
Loading

GuillaumeGomez commented Apr 18, 2022•
edited
Loading