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.

Sign up for GitHub

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

Jump to bottom

rustdoc: Cleanup parent module tracking for doc links #109312

Merged
merged 2 commits into from
Mar 22, 2023
Merged

rustdoc: Cleanup parent module tracking for doc links #109312

merged 2 commits into from
Mar 22, 2023

Conversation

petrochenkov
Copy link
Contributor

Keep ids of the documented items themselves, not their parent modules. Parent modules can be retreived from those ids when necessary.

Fixes #108501.
That issue could be fixed in a more local way, but this refactoring is something that I wanted to do since #93805 anyway.

@rustbot
Copy link
Collaborator

rustbot commented Mar 18, 2023

r? @GuillaumeGomez

(rustbot has picked a reviewer for you, use r? to override)

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. 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 18, 2023
@petrochenkov petrochenkov mentioned this pull request Mar 18, 2023
Closed
@petrochenkov
Copy link
Contributor Author

Passing the item_id, inner_doc pair may be slightly less efficient than passing item_id, module_id because the fn module_id logic is run once per every doc link this way, and not once per doc comment.
If perf run shows regressions I'll revert this part.
@bors try @rust-timer queue

@rust-timer

This comment has been minimized.

Sign in to view
@rustbot rustbot added the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Mar 18, 2023
@bors
Copy link
Contributor

bors commented Mar 18, 2023

⌛ Trying commit ed5473a5b2322f4aeb467b9f4ef352d99ea40231 with merge ab4ad6967df3019f280a46e6079e57fe9942cc8d...

@rust-log-analyzer

This comment has been minimized.

Sign in to view
@bors
Copy link
Contributor

bors commented Mar 18, 2023

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

@rust-timer

This comment has been minimized.

Sign in to view
@petrochenkov petrochenkov 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 Mar 18, 2023
@rust-timer
Copy link
Collaborator

Finished benchmarking commit (ab4ad6967df3019f280a46e6079e57fe9942cc8d): comparison URL.

Overall result: ✅ improvements - no action needed

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.

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

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
Regressions ❌
(secondary)		 - - 0
Improvements ✅
(primary)		 -0.4% [-0.4%, -0.4%] 1
Improvements ✅
(secondary)		 - - 0
All ❌✅ (primary) -0.4% [-0.4%, -0.4%] 1

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.9% [0.9%, 0.9%] 1
Regressions ❌
(secondary)		 - - 0
Improvements ✅
(primary)		 -2.0% [-2.2%, -1.8%] 2
Improvements ✅
(secondary)		 - - 0
All ❌✅ (primary) -1.1% [-2.2%, 0.9%] 3

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)		 - - 0
Regressions ❌
(secondary)		 - - 0
Improvements ✅
(primary)		 -0.5% [-0.5%, -0.4%] 4
Improvements ✅
(secondary)		 - - 0
All ❌✅ (primary) -0.5% [-0.5%, -0.4%] 4

@rustbot rustbot removed the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Mar 19, 2023
@petrochenkov
Copy link
Contributor Author

Reverted part of the changes as described in #109312 (comment).
@rustbot ready

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Mar 19, 2023
@rust-log-analyzer

This comment was marked as resolved.

Sign in to view
@petrochenkov petrochenkov mentioned this pull request Mar 20, 2023
Merged
@GuillaumeGomez
Copy link
Member

Thanks!

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Mar 20, 2023

📌 Commit ae47810 has been approved by GuillaumeGomez

It is now in the queue for this repository.

@bors 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 Mar 20, 2023
Dylan-DPC added a commit to Dylan-DPC/rust that referenced this pull request Mar 21, 2023
@Dylan-DPC
Rollup merge of rust-lang#109312 - petrochenkov:docice5, r=GuillaumeG…
61df888 
…omez

rustdoc: Cleanup parent module tracking for doc links

Keep ids of the documented items themselves, not their parent modules. Parent modules can be retreived from those ids when necessary.

Fixes rust-lang#108501.
That issue could be fixed in a more local way, but this refactoring is something that I wanted to do since rust-lang#93805 anyway.
@Dylan-DPC Dylan-DPC mentioned this pull request Mar 21, 2023
Closed
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Mar 21, 2023
@matthiaskrgr
Rollup merge of rust-lang#109312 - petrochenkov:docice5, r=GuillaumeG…
86c02fb 
…omez

rustdoc: Cleanup parent module tracking for doc links

Keep ids of the documented items themselves, not their parent modules. Parent modules can be retreived from those ids when necessary.

Fixes rust-lang#108501.
That issue could be fixed in a more local way, but this refactoring is something that I wanted to do since rust-lang#93805 anyway.
@matthiaskrgr matthiaskrgr mentioned this pull request Mar 21, 2023
Closed
Nilstrieb added a commit to Nilstrieb/rust that referenced this pull request Mar 21, 2023
@Nilstrieb
Rollup merge of rust-lang#109312 - petrochenkov:docice5, r=GuillaumeG…
3d6676a 
…omez

rustdoc: Cleanup parent module tracking for doc links

Keep ids of the documented items themselves, not their parent modules. Parent modules can be retreived from those ids when necessary.

Fixes rust-lang#108501.
That issue could be fixed in a more local way, but this refactoring is something that I wanted to do since rust-lang#93805 anyway.
@Nilstrieb Nilstrieb mentioned this pull request Mar 21, 2023
Closed
Nilstrieb added a commit to Nilstrieb/rust that referenced this pull request Mar 21, 2023
@Nilstrieb
Rollup merge of rust-lang#109312 - petrochenkov:docice5, r=GuillaumeG…
c0648d6 
…omez

rustdoc: Cleanup parent module tracking for doc links

Keep ids of the documented items themselves, not their parent modules. Parent modules can be retreived from those ids when necessary.

Fixes rust-lang#108501.
That issue could be fixed in a more local way, but this refactoring is something that I wanted to do since rust-lang#93805 anyway.
@Nilstrieb Nilstrieb mentioned this pull request Mar 21, 2023
Closed
@Nilstrieb
Copy link
Member

Needs to be rebased: #109439 (comment)
@bors r-

@bors bors 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-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Mar 21, 2023
@petrochenkov
rustdoc: Cleanup parent module tracking for doc links
d3a5541 
Keep ids of the documented items themselves, not their parent modules.
Parent modules can be retreived from those ids when necessary.
@petrochenkov
rustdoc: Factor out some doc link resolution code into a separate fun…
0f45d85 
…ction
@petrochenkov
Copy link
Contributor Author

@bors r=GuillaumeGomez

@bors
Copy link
Contributor

bors commented Mar 21, 2023

📌 Commit 0f45d85 has been approved by GuillaumeGomez

It is now in the queue for this repository.

@bors 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-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Mar 21, 2023
Dylan-DPC added a commit to Dylan-DPC/rust that referenced this pull request Mar 21, 2023
@Dylan-DPC
Rollup merge of rust-lang#109312 - petrochenkov:docice5, r=GuillaumeG…
1f62643 
…omez

rustdoc: Cleanup parent module tracking for doc links

Keep ids of the documented items themselves, not their parent modules. Parent modules can be retreived from those ids when necessary.

Fixes rust-lang#108501.
That issue could be fixed in a more local way, but this refactoring is something that I wanted to do since rust-lang#93805 anyway.
@Dylan-DPC Dylan-DPC mentioned this pull request Mar 21, 2023
Closed
Dylan-DPC added a commit to Dylan-DPC/rust that referenced this pull request Mar 22, 2023
@Dylan-DPC
Rollup merge of rust-lang#109312 - petrochenkov:docice5, r=GuillaumeG…
b3e6cbb 
…omez

rustdoc: Cleanup parent module tracking for doc links

Keep ids of the documented items themselves, not their parent modules. Parent modules can be retreived from those ids when necessary.

Fixes rust-lang#108501.
That issue could be fixed in a more local way, but this refactoring is something that I wanted to do since rust-lang#93805 anyway.
@Dylan-DPC Dylan-DPC mentioned this pull request Mar 22, 2023
Closed
@Dylan-DPC Dylan-DPC mentioned this pull request Mar 22, 2023
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Mar 22, 2023
@bors
Auto merge of rust-lang#109496 - Dylan-DPC:rollup-u8rsi3h, r=Dylan-DPC
a266f11 
Rollup of 11 pull requests

Successful merges:

 - rust-lang#100311 (Fix handling of trailing bare CR in str::lines)
 - rust-lang#108997 (Change text -> rust highlighting in sanitizer.md)
 - rust-lang#109179 (move Option::as_slice to intrinsic)
 - rust-lang#109187 (Render source page layout with Askama)
 - rust-lang#109280 (Remove `VecMap`)
 - rust-lang#109295 (refactor `fn bootstrap::builder::Builder::compiler_for` logic)
 - rust-lang#109312 (rustdoc: Cleanup parent module tracking for doc links)
 - rust-lang#109317 (Update links for custom discriminants.)
 - rust-lang#109405 (RPITITs are `DefKind::Opaque` with new lowering strategy)
 - rust-lang#109414 (Do not consider synthesized RPITITs on missing items checks)
 - rust-lang#109435 (Detect uninhabited types early in const eval)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit af3bd22 into rust-lang:master Mar 22, 2023
@rustbot rustbot added this to the 1.70.0 milestone Mar 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@GuillaumeGomez GuillaumeGomez GuillaumeGomez approved these changes

Assignees

@GuillaumeGomez GuillaumeGomez

Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. 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.
Projects
None yet
Milestone
1.70.0
Development

Successfully merging this pull request may close these issues.

Unexpected compiler error when comiling kube-rs docs on nightly
7 participants
@petrochenkov @rustbot @rust-timer @bors @rust-log-analyzer @GuillaumeGomez @Nilstrieb