Skip to content

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

Merged
bors merged 1 commit into
rust-lang:masterfrom
notriddle:notriddle/item-right-docblock-short
Aug 27, 2022
Merged

rustdoc: omit start/end tags for empty item description blocks#101018
bors merged 1 commit into
rust-lang:masterfrom
notriddle:notriddle/item-right-docblock-short

Conversation

@notriddle

@notriddlenotriddle commented Aug 26, 2022

Copy link
Copy Markdown
Contributor

Related to #100952

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

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

rust-highfive commented Aug 26, 2022

Copy link
Copy Markdown
Contributor

r? @jsha

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

@rust-highfiverust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Aug 26, 2022
@notriddle
notriddleforce-pushed the notriddle/item-right-docblock-short branch from 19b4eb8 to e5faf89CompareAugust 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
notriddleforce-pushed the notriddle/item-right-docblock-short branch from e5faf89 to e7b7f88CompareAugust 26, 2022 03:30
@Kobzol

Kobzol commented Aug 26, 2022

Copy link
Copy Markdown
Member

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

@bors try @rust-timer queue

@rust-timer

rust-timer commented Aug 26, 2022

Copy link
Copy Markdown
Collaborator

Awaiting bors try build completion.

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

@rustbotrustbot added the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Aug 26, 2022
@bors

bors commented Aug 26, 2022

Copy link
Copy Markdown
Collaborator

⌛ Trying commit e7b7f88 with merge f7f69613c7530190f98c240aca2c79322fa2f41a...

@bors

bors commented Aug 26, 2022

Copy link
Copy Markdown
Collaborator

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

@rust-timer

rust-timer commented Aug 26, 2022

Copy link
Copy Markdown
Collaborator

Queued f7f69613c7530190f98c240aca2c79322fa2f41a with parent 8a13871, future comparison URL.

@rust-timer

rust-timer commented Aug 26, 2022

Copy link
Copy Markdown
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.

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

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

mean1rangecount2
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

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

Kobzol commented Aug 26, 2022

Copy link
Copy Markdown
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.

@notriddle

notriddle commented Aug 26, 2022

Copy link
Copy Markdown
ContributorAuthor

r? @GuillaumeGomez

@GuillaumeGomez

GuillaumeGomez commented Aug 26, 2022

Copy link
Copy Markdown
Member

This is great, thanks!

@GuillaumeGomez

GuillaumeGomez commented Aug 26, 2022

Copy link
Copy Markdown
Member

@bors r+ rollup

@bors

bors commented Aug 26, 2022

Copy link
Copy Markdown
Collaborator

📌 Commit e7b7f88 has been approved by GuillaumeGomez

It is now in the queue for this repository.

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

GuillaumeGomez commented Aug 26, 2022

Copy link
Copy Markdown
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-errorscompiler-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 ofrust-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.
@JohnTitorJohnTitor 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 ofrust-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:masterAug 27, 2022
@rustbotrustbot 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 freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@GuillaumeGomezGuillaumeGomezGuillaumeGomez approved these changes

Assignees

@GuillaumeGomezGuillaumeGomez

Labels

S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-rustdocRelevant 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