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: omit start/end tags for empty item description blocks #101018

Merged
merged 1 commit into from
Aug 27, 2022
Merged

rustdoc: omit start/end tags for empty item description blocks #101018

merged 1 commit into from
Aug 27, 2022

Conversation

notriddle
Copy link
Contributor

Related to #100952

This is definitely not a complete solution, but it does shrink keysyms/index.html on smithay from 620K to 516K.

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

r? @jsha

(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 Aug 26, 2022
@notriddle notriddle force-pushed the notriddle/item-right-docblock-short branch from 19b4eb8 to e5faf89 Compare August 26, 2022 01:45
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@notriddle
rustdoc: omit start/end tags for empty item description blocks
e7b7f88 
Related to rust-lang#100952

This is definitely not a complete solution, but it does shrink
keysyms/index.html on smithay from 620K to 516K.
@notriddle notriddle force-pushed the notriddle/item-right-docblock-short branch from e5faf89 to e7b7f88 Compare August 26, 2022 03:30
@Kobzol
Copy link
Contributor

Kobzol commented Aug 26, 2022

perf.RLO now tracks the size of generated documentation, let's see if it works :)

@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 Aug 26, 2022
@bors
Copy link
Contributor

bors commented Aug 26, 2022

⌛ Trying commit e7b7f88 with merge f7f69613c7530190f98c240aca2c79322fa2f41a...

@bors
Copy link
Contributor

bors commented Aug 26, 2022

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

@rust-timer
Copy link
Collaborator

Queued f7f69613c7530190f98c240aca2c79322fa2f41a with parent 8a13871, future comparison URL.

@rust-timer
Copy link
Collaborator

Finished benchmarking commit (f7f69613c7530190f98c240aca2c79322fa2f41a): 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-review -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.

mean1 range count2
Regressions ❌
(primary)		 - - 0
Regressions ❌
(secondary)		 - - 0
Improvements ✅
(primary)		 -0.7% [-0.8%, -0.6%] 6
Improvements ✅
(secondary)		 -0.9% [-1.3%, -0.3%] 3
All ❌✅ (primary) -0.7% [-0.8%, -0.6%] 6

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.

mean1 range count2
Regressions ❌
(primary)		 - - 0
Regressions ❌
(secondary)		 2.4% [2.4%, 2.4%] 1
Improvements ✅
(primary)		 -3.0% [-3.0%, -3.0%] 1
Improvements ✅
(secondary)		 - - 0
All ❌✅ (primary) -3.0% [-3.0%, -3.0%] 1

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.

mean1 range count2
Regressions ❌
(primary)		 - - 0
Regressions ❌
(secondary)		 - - 0
Improvements ✅
(primary)		 - - 0
Improvements ✅
(secondary)		 -2.0% [-2.0%, -2.0%] 2
All ❌✅ (primary) - - 0

Footnotes

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

  2. number of relevant changes ↩ ↩2 ↩3

@rustbot rustbot removed the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Aug 26, 2022
@Kobzol
Copy link
Contributor

Kobzol commented Aug 26, 2022

https://perf.rust-lang.org/compare.html?start=8a13871b69924b74cfa1d737f2894068b37ea7ea&end=f7f69613c7530190f98c240aca2c79322fa2f41a&stat=size%3Adoc_bytes Up to 1 % doc size reduction on a few benchmarks. Maybe we could add Smithay as a doc benchmark to rustc-perf.

@notriddle
Copy link
Contributor Author

r? @GuillaumeGomez

@rust-highfive rust-highfive assigned GuillaumeGomez and unassigned jsha Aug 26, 2022
@GuillaumeGomez
Copy link
Member

This is great, thanks!

@GuillaumeGomez
Copy link
Member

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Aug 26, 2022

📌 Commit e7b7f88 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 Aug 26, 2022
@GuillaumeGomez
Copy link
Member

https://perf.rust-lang.org/compare.html?start=8a13871b69924b74cfa1d737f2894068b37ea7ea&end=f7f69613c7530190f98c240aca2c79322fa2f41a&stat=size%3Adoc_bytes Up to 1 % doc size reduction on a few benchmarks. Maybe we could add Smithay as a doc benchmark to rustc-perf.

More various kind of crates would be helpful indeed!

@compiler-errors compiler-errors mentioned this pull request Aug 27, 2022
Closed
compiler-errors added a commit to compiler-errors/rust that referenced this pull request Aug 27, 2022
@compiler-errors
Rollup merge of rust-lang#101018 - notriddle:notriddle/item-right-doc…
8468c71 
…block-short, r=GuillaumeGomez

rustdoc: omit start/end tags for empty item description blocks

Related to rust-lang#100952

This is definitely not a complete solution, but it does shrink keysyms/index.html on smithay from 620K to 516K.
@JohnTitor JohnTitor mentioned this pull request Aug 27, 2022
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Aug 27, 2022
@bors
Auto merge of rust-lang#101074 - JohnTitor:rollup-zwznihq, r=JohnTitor
d0e1491 
Rollup of 11 pull requests

Successful merges:

 - rust-lang#96240 (Stabilize `const_ptr_offset_from`.)
 - rust-lang#99784 (Make forward compatibility lint deprecated_cfg_attr_crate_type_name deny by default)
 - rust-lang#100811 (Fix wrong compiletest filters on Windows)
 - rust-lang#100924 (Smaller improvements of tidy and the unicode generator)
 - rust-lang#100953 (Update documentation for `write!` and `writeln!`)
 - rust-lang#101018 (rustdoc: omit start/end tags for empty item description blocks)
 - rust-lang#101044 (rustdoc: remove unused CSS for `hidden-by-*-hider`)
 - rust-lang#101046 (rustdoc: remove incorrect CSS selector `.impl-items table td`)
 - rust-lang#101057 (Merge implementations of HIR fn_decl and fn_sig.)
 - rust-lang#101062 (rustdoc: remove empty extern_crates and type="text/javascript" on script)
 - rust-lang#101063 (Merge duplicated CSS rules)

Failed merges:

 - rust-lang#101055 (Use smaller span for suggestions)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 6ccad25 into rust-lang:master Aug 27, 2022
@rustbot rustbot added this to the 1.65.0 milestone Aug 27, 2022
@notriddle notriddle deleted the notriddle/item-right-docblock-short branch August 27, 2022 15:21
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-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
1.65.0
Development

Successfully merging this pull request may close these issues.
9 participants
@notriddle @rust-highfive @rust-log-analyzer @Kobzol @rust-timer @bors @GuillaumeGomez @jsha @rustbot