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: Remove fields_stripped fields (and equivalents) #94053

Merged
merged 3 commits into from
May 23, 2022
Merged

rustdoc: Remove fields_stripped fields (and equivalents) #94053

merged 3 commits into from
May 23, 2022

Conversation

GuillaumeGomez
Copy link
Member

Fixes #90588.

r? @camelid

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

rustdoc-json-types is a public (although nightly-only) API. If possible, consider changing src/librustdoc/json/conversions.rs; otherwise, make sure you bump the FORMAT_VERSION constant.

cc @CraftSpider,@aDotInTheVoid

Some changes occurred in clean/types.rs.

cc @camelid

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Feb 16, 2022
@GuillaumeGomez
Copy link
Member Author

@bors try @rust-timer queue

@rust-timer
Copy link
Collaborator

Awaiting bors try build completion.

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

@rustbot rustbot added the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Feb 16, 2022
@bors
Copy link
Contributor

bors commented Feb 16, 2022

⌛ Trying commit a2c2a87a8a969bff68913fe5e19b03e09fa49cac with merge 4360c1576eea23a5bff62ffa26427cf63e1a0bd5...

@bors
Copy link
Contributor

bors commented Feb 16, 2022

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

@rust-timer
Copy link
Collaborator

Queued 4360c1576eea23a5bff62ffa26427cf63e1a0bd5 with parent a240ccd, future comparison URL.

@rust-timer
Copy link
Collaborator

Finished benchmarking commit (4360c1576eea23a5bff62ffa26427cf63e1a0bd5): comparison url.

Summary: This benchmark run did not return any relevant results.

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 led to changes in compiler perf.

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

@rustbot rustbot removed the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Feb 16, 2022
@GuillaumeGomez
Copy link
Member Author

Seems like there is close to no perf improvement. Well, that's always one field less to worry about. :)

camelid
camelid reviewed Feb 17, 2022
View reviewed changes
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.

Thanks for doing this, I left some comments.

src/librustdoc/clean/types.rs Outdated Show resolved Hide resolved
src/librustdoc/clean/types.rs Outdated Show resolved Hide resolved
src/librustdoc/clean/types.rs Show resolved Hide resolved
src/librustdoc/fold.rs Show resolved Hide resolved
src/librustdoc/html/render/print_item.rs Outdated Show resolved Hide resolved
src/librustdoc/json/conversions.rs Outdated Show resolved Hide resolved
src/librustdoc/clean/types.rs Outdated Show resolved Hide resolved
@camelid camelid 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 Feb 17, 2022
@bors
Copy link
Contributor

bors commented Mar 12, 2022

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

@camelid
Copy link
Member

camelid commented Apr 25, 2022

ping @GuillaumeGomez :)

@GuillaumeGomez
Copy link
Member Author

In my TODO list. :)

@GuillaumeGomez GuillaumeGomez force-pushed the fields-stripped branch 2 times, most recently from 36c22b7 to 29d6770 Compare April 27, 2022 16:09
@GuillaumeGomez
Copy link
Member Author

Finally took the time to update it! The remaining problem was that #[doc(hidden)] enum variants were removed entirely and not just stripped.

@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.

@GuillaumeGomez
Copy link
Member Author

Fixed the merged conflict. Since @camelid is busy, I'll set someone else as reviewer.

r? @notriddle

@rust-highfive rust-highfive assigned notriddle and unassigned camelid May 21, 2022
notriddle
notriddle reviewed May 21, 2022
View reviewed changes
Copy link
Contributor

@notriddle notriddle left a comment

Choose a reason for hiding this comment

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

Should probably write down what we learned somewhere.

src/librustdoc/passes/strip_hidden.rs Outdated Show resolved Hide resolved
@GuillaumeGomez @notriddle
Greatly extend explanations on strip_hidden items
8323b05 
Co-authored-by: Michael Howell <michael@notriddle.com>
@GuillaumeGomez
Copy link
Member Author

I directly added your suggestion because there is nothing for me to change or add. :)

@notriddle
Copy link
Contributor

@bors r+ rollup=never

@notriddle notriddle closed this May 23, 2022
@notriddle notriddle reopened this May 23, 2022
@notriddle
Copy link
Contributor

@bors r+ rollup=never

@bors
Copy link
Contributor

bors commented May 23, 2022

📌 Commit 8323b05 has been approved by notriddle

@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 May 23, 2022
@bors
Copy link
Contributor

bors commented May 23, 2022

⌛ Testing commit 8323b05 with merge 222c572...

@bors
Copy link
Contributor

bors commented May 23, 2022

☀️ Test successful - checks-actions
Approved by: notriddle
Pushing 222c572 to master...

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

Finished benchmarking commit (222c572): comparison url.

Instruction count

This benchmark run did not return any relevant results for this metric.

Max RSS (memory usage)

Results
  • Primary benchmarks: 🎉 relevant improvement found
  • Secondary benchmarks: mixed results
Regressions 😿
(primary)		 Regressions 😿
(secondary)		 Improvements 🎉
(primary)		 Improvements 🎉
(secondary)		 All 😿 🎉
(primary)
count1 0 3 1 1 1
mean2 N/A 1.0% -3.0% -1.4% -3.0%
max N/A 1.1% -3.0% -1.4% -3.0%

Cycles

Results
  • Primary benchmarks: mixed results
  • Secondary benchmarks: 😿 relevant regression found
Regressions 😿
(primary)		 Regressions 😿
(secondary)		 Improvements 🎉
(primary)		 Improvements 🎉
(secondary)		 All 😿 🎉
(primary)
count1 1 1 2 0 3
mean2 1.9% 2.1% -2.5% N/A -1.1%
max 1.9% 2.1% -3.5% N/A -3.5%

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

@rustbot label: -perf-regression

Footnotes

  1. number of relevant changes ↩ ↩2

  2. the arithmetic mean of the percent change ↩ ↩2

@GuillaumeGomez GuillaumeGomez deleted the fields-stripped branch May 23, 2022 22:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@camelid camelid camelid left review comments

@aDotInTheVoid aDotInTheVoid aDotInTheVoid left review comments

@notriddle notriddle notriddle left review comments

Assignees

@notriddle notriddle

Labels
merged-by-bors This PR was explicitly merged by bors. 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
Milestone
1.63.0
Development

Successfully merging this pull request may close these issues.

rustdoc: Remove _stripped fields from clean::{Struct, Variant, ...}
8 participants
@GuillaumeGomez @rust-highfive @rust-timer @bors @camelid @notriddle @aDotInTheVoid @rustbot