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: make --passes and --no-defaults have no effect #91900

Merged
merged 1 commit into from
Dec 20, 2021
Merged

rustdoc: make --passes and --no-defaults have no effect #91900

merged 1 commit into from
Dec 20, 2021

Conversation

pitaj
Copy link
Contributor

@pitaj pitaj commented Dec 14, 2021 •
edited

Fixes #91714

One potential issue is that currently there is no stable way to achieve --document-hidden-items. This affects test issue-15347.

I also had to modify the tests issue-42875 and no-compiler-export. Regardless of combinations of --document-hidden-items and --document-private-items, I was unable to get these to pass without the modifications. I left behind a comment noting the change.

@rustbot rustbot added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Dec 14, 2021
@pitaj
Copy link
Contributor Author

pitaj commented Dec 14, 2021

r? @jyn514

jyn514
jyn514 reviewed Dec 14, 2021
View reviewed changes
Copy link
Member

@jyn514 jyn514 left a comment

Choose a reason for hiding this comment

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

This looks great, thanks!

src/test/rustdoc/no-compiler-reexport.rs Outdated Show resolved Hide resolved
jyn514
jyn514 reviewed Dec 14, 2021
View reviewed changes
src/test/rustdoc/no-compiler-reexport.rs Outdated Show resolved Hide resolved
src/test/rustdoc/issue-42875.rs Outdated Show resolved Hide resolved
@jyn514 jyn514 added the S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. label Dec 14, 2021
@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 Dec 14, 2021
jyn514
jyn514 reviewed Dec 14, 2021
View reviewed changes
src/librustdoc/config.rs Outdated Show resolved Hide resolved
src/librustdoc/config.rs Outdated Show resolved Hide resolved
src/librustdoc/core.rs
Comment on lines +426 to +428
msg.help("`#![doc(no_default_passes)]` no longer functions; you may want to use `#![doc(document_private_items)]`");
} else if name.starts_with("passes") {
msg.help("`#![doc(passes = \"...\")]` no longer functions; you may want to use `#![doc(document_private_items)]`");
Copy link
Member

Choose a reason for hiding this comment

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

Ugh, not super happy that this can be configured both through attributes and a CLI flags ... but that's a fight for another day.

src/librustdoc/core.rs Outdated Show resolved Hide resolved
jyn514
jyn514 approved these changes Dec 16, 2021
View reviewed changes
Copy link
Member

@jyn514 jyn514 left a comment

Choose a reason for hiding this comment

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

This looks great! Can you just squash the commits into one? Then it looks to good to merge once the FCP in #91714 finishes :)

@pitaj
rustdoc: remove --passes and --no-defaults
02b94b7 
- flags no longer function, see #44136
- adjust tests to match new behavior
- removed test issue-42875 (covered regression with --no-defaults)
- moved input-format to removed flags
- move all removed flags to bottom
- note flag removal in command help
- remove DefaultPassOption enum (now redundant with `show_coverage`)
@jyn514 jyn514 added S-blocked Status: Marked as blocked ❌ on something else such as an RFC or other implementation work. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 16, 2021
@camelid
Copy link
Member

camelid commented Dec 19, 2021

FCP has completed! @rustbot ready

@rustbot rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Dec 19, 2021
@camelid camelid removed the S-blocked Status: Marked as blocked ❌ on something else such as an RFC or other implementation work. label Dec 19, 2021
@jyn514
Copy link
Member

jyn514 commented Dec 20, 2021

@bors r+

@bors
Copy link
Contributor

bors commented Dec 20, 2021

📌 Commit 02b94b7 has been approved by jyn514

@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 Dec 20, 2021
@bors
Copy link
Contributor

bors commented Dec 20, 2021

⌛ Testing commit 02b94b7 with merge 940a97a...

@bors
Copy link
Contributor

bors commented Dec 20, 2021

☀️ Test successful - checks-actions
Approved by: jyn514
Pushing 940a97a to master...

@bors bors added the merged-by-bors This PR was explicitly merged by bors. label Dec 20, 2021
@bors bors merged commit 940a97a into rust-lang:master Dec 20, 2021
@rustbot rustbot added this to the 1.59.0 milestone Dec 20, 2021
@jyn514
Copy link
Member

jyn514 commented Dec 20, 2021

Thanks for working on this!

@rust-timer
Copy link
Collaborator

Finished benchmarking commit (940a97a): comparison url.

Summary: This change led to moderate relevant mixed results 🤷 in compiler performance.

  • Moderate improvement in instruction counts (up to -0.8% on incr-unchanged builds of externs)
  • Small regression in instruction counts (up to 1.1% on incr-patched: println builds of regression-31157)

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

@rustbot rustbot added the perf-regression Performance regression. label Dec 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@GuillaumeGomez GuillaumeGomez GuillaumeGomez left review comments

@camelid camelid camelid left review comments

@jyn514 jyn514 jyn514 approved these changes

Assignees

@jyn514 jyn514

Labels
merged-by-bors This PR was explicitly merged by bors. perf-regression Performance regression. 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.59.0
Development

Successfully merging this pull request may close these issues.

Make rustdoc --passes and rustdoc --no-defaults have no effect
7 participants
@pitaj @camelid @jyn514 @bors @rust-timer @GuillaumeGomez @rustbot