Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rustdoc: include impl generics / self in search index #96652

Merged
merged 4 commits into from
May 29, 2022

Conversation

notriddle
Copy link
Contributor

@notriddle notriddle commented May 2, 2022

Fixes #92205

@rustbot rustbot added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label May 2, 2022
@rust-highfive
Copy link
Collaborator

Some changes occurred in clean/types.rs.

cc @camelid

@rust-highfive
Copy link
Collaborator

r? @CraftSpider

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

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 2, 2022
@camelid
Copy link
Member

camelid commented May 4, 2022

cc #92339

Does this PR cover that one? I've been meaning to finish it but haven't gotten to it, so I'd be happy to be able to close it since it's been sitting for so long.

@notriddle
Copy link
Contributor Author

@camelid

No, this PR does not address impl Trait or raw pointers. It should be completely orthogonal to both of those.

@notriddle
Copy link
Contributor Author

r? @camelid

@rust-highfive rust-highfive assigned camelid and unassigned CraftSpider May 16, 2022
@bors
Copy link
Contributor

bors commented May 21, 2022

☔ The latest upstream changes (presumably #97239) made this pull request unmergeable. Please resolve the merge conflicts.

@rust-log-analyzer

This comment has been minimized.

@rust-log-analyzer

This comment has been minimized.

@bors
Copy link
Contributor

bors commented May 25, 2022

☔ The latest upstream changes (presumably #97365) made this pull request unmergeable. Please resolve the merge conflicts.

Copy link
Member

@camelid camelid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left some general feedback about code architecture, but unfortunately I don't think I understand the search index well enough to review this.

r? @GuillaumeGomez

src/librustdoc/formats/cache.rs Outdated Show resolved Hide resolved
src/librustdoc/formats/cache.rs Outdated Show resolved Hide resolved
src/librustdoc/formats/cache.rs Outdated Show resolved Hide resolved
@GuillaumeGomez
Copy link
Member

Looks good to me apart comments from @camelid. :)

@notriddle
Copy link
Contributor Author

I agree that these aren’t great, so to actually fix them, I’m going to need to change how the parent _stack works. Right now, it doesn’t actually include the impl (which carries the generics I care about), but instead it gets translated to point at the type.

@GuillaumeGomez
Copy link
Member

Is it ready for a final review?

@notriddle
Copy link
Contributor Author

Yeah, I think so.

@GuillaumeGomez
Copy link
Member

Thanks!

@bors: r+ rollup=iffy

@bors
Copy link
Contributor

bors commented May 28, 2022

📌 Commit 718269a has been approved by GuillaumeGomez

@bors bors removed the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 28, 2022
@bors bors added the S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. label May 28, 2022
@bors
Copy link
Contributor

bors commented May 29, 2022

⌛ Testing commit 718269a with merge 0acc4a3...

@bors
Copy link
Contributor

bors commented May 29, 2022

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

@bors bors added the merged-by-bors This PR was explicitly merged by bors. label May 29, 2022
@bors bors merged commit 0acc4a3 into rust-lang:master May 29, 2022
@rustbot rustbot added this to the 1.63.0 milestone May 29, 2022
@rust-timer
Copy link
Collaborator

Finished benchmarking commit (0acc4a3): comparison url.

Instruction count

  • Primary benchmarks: 😿 relevant regressions found
  • Secondary benchmarks: 😿 relevant regressions found
mean1 max count2
Regressions 😿
(primary)
0.5% 1.0% 3
Regressions 😿
(secondary)
1.1% 1.1% 3
Improvements 🎉
(primary)
N/A N/A 0
Improvements 🎉
(secondary)
N/A N/A 0
All 😿🎉 (primary) 0.5% 1.0% 3

Max RSS (memory usage)

Results
  • Primary benchmarks: mixed results
  • Secondary benchmarks: no relevant changes found
mean1 max count2
Regressions 😿
(primary)
1.6% 1.6% 1
Regressions 😿
(secondary)
N/A N/A 0
Improvements 🎉
(primary)
-1.6% -2.2% 3
Improvements 🎉
(secondary)
N/A N/A 0
All 😿🎉 (primary) -0.8% -2.2% 4

Cycles

Results
  • Primary benchmarks: 😿 relevant regressions found
  • Secondary benchmarks: no relevant changes found
mean1 max count2
Regressions 😿
(primary)
2.2% 2.5% 3
Regressions 😿
(secondary)
N/A N/A 0
Improvements 🎉
(primary)
N/A N/A 0
Improvements 🎉
(secondary)
N/A N/A 0
All 😿🎉 (primary) 2.2% 2.5% 3

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

Footnotes

  1. the arithmetic mean of the percent change 2 3

  2. number of relevant changes 2 3

@rustbot rustbot added the perf-regression Performance regression. label May 29, 2022
@notriddle notriddle deleted the notriddle/self branch May 29, 2022 12:43
@pnkfelix
Copy link
Member

visiting for weekly performance triage.

Benchmark Profile Scenario % Change Significance Factor?
serde-1.0.136 doc full 0.96% 7.36x
syn-1.0.89 doc full 0.44% 3.01x
diesel-1.4.8 doc full 0.24% 1.60x

This regressed doc-generation for a few primary benchmarks, but I think that might be a inherent cost of a change like this. I'm going to mark it as triaged based on that assumption.

@rustbot label: perf-regression-triaged

@rustbot rustbot added the perf-regression-triaged The performance regression has been triaged. label May 31, 2022
@GuillaumeGomez
Copy link
Member

It's expected because it increases the size of the search index because we add information into it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merged-by-bors This PR was explicitly merged by bors. perf-regression Performance regression. perf-regression-triaged The performance regression has been triaged. S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

rustdoc: Use the concrete type of self in the search-index
10 participants