rustdoc: fix and refactor HTML rendering a bit #121160

fmease · 2024-02-15T19:43:18Z

refactoring: get rid of a bunch of manual f.alternate() branches
- not sure why this wasn't done so already, is this perf-sensitive?
fix an ICE in debug builds of rustdoc
- rustdoc used to crash on empty outlives-bounds: where 'a:
properly escape const generic defaults
actually print empty trait and outlives-bounds (doesn't work for cross-crate reexports yet, will fix that at some other point) since they can have semantic significance
- outlives-bounds: forces lifetime params to be early-bound instead of late-bound which is technically speaking part of the public API
- trait-bounds: can affect the well-formedness, consider
  - makeshift “const-evaluatable” bounds under generic_const_exprs
  - bounds to force wf-checking in light of Normalization can skip WF #100041 (quite artificial I know, I couldn't figure out something better), see rustdoc: fix and refactor HTML rendering a bit #121160 (comment)

rustbot · 2024-02-15T19:43:27Z

rustbot has assigned @GuillaumeGomez.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

fmease · 2024-02-15T19:45:33Z

src/librustdoc/html/format.rs

                    if f.alternate() {
-                        write!(f, " = {default:#}")?;


Previously this was formatting a String with {:#} but # doesn't have any effect on <String as Display>. Furthermore this didn't escape const generic defaults.

Here's a nice picture cuz why not:

Mouahaha. Nice one. :D

fmease · 2024-02-15T19:47:15Z

src/librustdoc/html/format.rs

                        }
-                        bounds_display.truncate(bounds_display.len() - " + ".len());


This would overflow & wrap-around in release which didn't cause any issues but crash in debug builds of rustdoc. Just use the preexisting print_generic_bounds.

GuillaumeGomez · 2024-02-15T19:47:51Z

Let's run a perf check to see if there is a change in perf:

@bors try @rust-timer queue

fmease · 2024-02-15T19:48:43Z

tests/rustdoc/bounds.rs

+    where
+        T:,
+        'a:,
+{}


I gotta run now but I can add more tests demo'ing the importance of showing empty trait bounds, e.g., one involving generic_const_exprs & one affecting wf'cking.

If you have more regression tests, please add them. The more the better.

E.g.,

#![feature(generic_const_exprs)] pub fn foo<const N: usize>() where [(); N + 1]: { let _: [(); N + 1]; }

cc #120994 (comment)

And re well-formedness checking (a bit artificial, I know ^^')

pub fn f() -> <[[[u8]]] as Discard>::Output where <[[[u8]]] as Discard>::Output: {} pub trait Discard { type Output; } impl<T: ?Sized> Discard for T { type Output = (); }

cc #100041

tests/rustdoc/const-generics/generic_const_exprs.rs suffices imo, it demonstrates the use-case perfectly :)

…endering, r=<try> rustdoc: fix and refactor HTML rendering a bit * refactoring: get rid of a bunch of manual `f.alternative()` branches * not sure why this doesn't done yet, is this perf-sensitive? * fix an ICE in debug builds of rustdoc * rustdoc used to crash on empty outlives-bounds: `where 'a:` * properly escape const generic defaults

bors · 2024-02-15T19:49:02Z

⌛ Trying commit 2f6a913 with merge 14c6553...

fmease · 2024-02-15T20:17:13Z

Oops, yeah, was in a hurry to leave for some place and didn't run the test suite locally. Gonna fix the CI errors later.

bors · 2024-02-15T21:16:42Z

☀️ Try build successful - checks-actions
Build commit: 14c6553 (14c6553fbbda663378f1e0346184328ce5707ac8)

bors · 2024-02-15T21:16:43Z

☀️ Try build successful - checks-actions
Build commit: 14c6553 (14c6553fbbda663378f1e0346184328ce5707ac8)

rust-timer · 2024-02-16T04:37:18Z

Finished benchmarking commit (14c6553): comparison URL.

Overall result: no relevant changes - 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 benchmark run did not return any relevant results for this metric.

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

Cycles

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

Binary size

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

Bootstrap: 636.031s -> 637.107s (0.17%)
Artifact size: 306.32 MiB -> 306.31 MiB (-0.00%)

GuillaumeGomez · 2024-02-16T10:43:51Z

No perf change. So once tests are fixed, we can merge. Thanks a lot for this code improvement! :)

GuillaumeGomez · 2024-02-17T21:15:13Z

Thanks!

@bors r+ rollup

bors · 2024-02-17T21:15:15Z

📌 Commit 5fbb1b2 has been approved by GuillaumeGomez

It is now in the queue for this repository.

…-rendering, r=GuillaumeGomez rustdoc: fix and refactor HTML rendering a bit * refactoring: get rid of a bunch of manual `f.alternate()` branches * not sure why this wasn't done so already, is this perf-sensitive? * fix an ICE in debug builds of rustdoc * rustdoc used to crash on empty outlives-bounds: `where 'a:` * properly escape const generic defaults * actually print empty trait and outlives-bounds (doesn't work for cross-crate reexports yet, will fix that at some other point) since they can have semantic significance * outlives-bounds: forces lifetime params to be early-bound instead of late-bound which is technically speaking part of the public API * trait-bounds: can affect the well-formedness, consider * makeshift “const-evaluatable” bounds under `generic_const_exprs` * bounds to force wf-checking in light of rust-lang#100041 (quite artificial I know, I couldn't figure out something better), see rust-lang#121160 (comment)

…llaumeGomez Rollup of 7 pull requests Successful merges: - rust-lang#118264 (Optimize `VecDeque::drain` for (half-)open ranges) - rust-lang#121079 (distribute tool documentations and avoid file conflicts on `x install`) - rust-lang#121100 (Detect when method call on argument could be removed to fulfill failed trait bound) - rust-lang#121160 (rustdoc: fix and refactor HTML rendering a bit) - rust-lang#121198 (Add more checks for `unnamed_fields` during HIR analysis) - rust-lang#121221 (AstConv: Refactor lowering of associated item bindings a bit) - rust-lang#121237 (Use better heuristic for printing Cargo specific diagnostics) r? `@ghost` `@rustbot` modify labels: rollup

Rollup of 7 pull requests Successful merges: - rust-lang#120526 (rustdoc: Correctly handle long crate names on mobile) - rust-lang#121100 (Detect when method call on argument could be removed to fulfill failed trait bound) - rust-lang#121160 (rustdoc: fix and refactor HTML rendering a bit) - rust-lang#121198 (Add more checks for `unnamed_fields` during HIR analysis) - rust-lang#121218 (Fix missing trait impls for type in rustc docs) - rust-lang#121221 (AstConv: Refactor lowering of associated item bindings a bit) - rust-lang#121237 (Use better heuristic for printing Cargo specific diagnostics) r? `@ghost` `@rustbot` modify labels: rollup

Rollup merge of rust-lang#121160 - fmease:rustdoc-fix-n-refactor-html-rendering, r=GuillaumeGomez rustdoc: fix and refactor HTML rendering a bit * refactoring: get rid of a bunch of manual `f.alternate()` branches * not sure why this wasn't done so already, is this perf-sensitive? * fix an ICE in debug builds of rustdoc * rustdoc used to crash on empty outlives-bounds: `where 'a:` * properly escape const generic defaults * actually print empty trait and outlives-bounds (doesn't work for cross-crate reexports yet, will fix that at some other point) since they can have semantic significance * outlives-bounds: forces lifetime params to be early-bound instead of late-bound which is technically speaking part of the public API * trait-bounds: can affect the well-formedness, consider * makeshift “const-evaluatable” bounds under `generic_const_exprs` * bounds to force wf-checking in light of rust-lang#100041 (quite artificial I know, I couldn't figure out something better), see rust-lang#121160 (comment)

fmease marked this pull request as ready for review February 15, 2024 19:43

rustbot assigned GuillaumeGomez Feb 15, 2024

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Feb 15, 2024

fmease commented Feb 15, 2024

View reviewed changes

GuillaumeGomez approved these changes Feb 15, 2024

View reviewed changes

fmease commented Feb 15, 2024

View reviewed changes

This comment has been minimized.

Sign in to view

rustbot added the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Feb 15, 2024

fmease commented Feb 15, 2024

View reviewed changes

This comment has been minimized.

Sign in to view

rustbot removed the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Feb 16, 2024

rustdoc: fix and refactor HTML rendering a bit

5fbb1b2

fmease force-pushed the rustdoc-fix-n-refactor-html-rendering branch from 2f6a913 to 5fbb1b2 Compare February 16, 2024 20:29

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 Feb 17, 2024

GuillaumeGomez mentioned this pull request Feb 17, 2024

Rollup of 7 pull requests #121244

Closed

fmease mentioned this pull request Feb 18, 2024

Rollup of 7 pull requests #121252

Merged

bors merged commit 28c0fa8 into rust-lang:master Feb 18, 2024
11 checks passed

rustbot added this to the 1.78.0 milestone Feb 18, 2024

fmease deleted the rustdoc-fix-n-refactor-html-rendering branch February 18, 2024 08:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

rustdoc: fix and refactor HTML rendering a bit #121160

rustdoc: fix and refactor HTML rendering a bit #121160

fmease commented Feb 15, 2024 •

edited

Loading

rustbot commented Feb 15, 2024

fmease Feb 15, 2024

fmease Feb 15, 2024

GuillaumeGomez Feb 15, 2024

fmease Feb 15, 2024

GuillaumeGomez commented Feb 15, 2024

This comment has been minimized.

fmease Feb 15, 2024

GuillaumeGomez Feb 15, 2024

fmease Feb 15, 2024 •

edited

Loading

fmease Feb 15, 2024 •

edited

Loading

fmease Feb 16, 2024 •

edited

Loading

GuillaumeGomez Feb 17, 2024

bors commented Feb 15, 2024

This comment has been minimized.

fmease commented Feb 15, 2024

bors commented Feb 15, 2024

bors commented Feb 15, 2024

This comment has been minimized.

rust-timer commented Feb 16, 2024

GuillaumeGomez commented Feb 16, 2024

GuillaumeGomez commented Feb 17, 2024

bors commented Feb 17, 2024

		}
		bounds_display.truncate(bounds_display.len() - " + ".len());

rustdoc: fix and refactor HTML rendering a bit #121160

rustdoc: fix and refactor HTML rendering a bit #121160

Conversation

fmease commented Feb 15, 2024 • edited Loading

rustbot commented Feb 15, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GuillaumeGomez commented Feb 15, 2024

This comment has been minimized.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fmease Feb 15, 2024 • edited Loading

Choose a reason for hiding this comment

fmease Feb 15, 2024 • edited Loading

Choose a reason for hiding this comment

fmease Feb 16, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bors commented Feb 15, 2024

This comment has been minimized.

fmease commented Feb 15, 2024

bors commented Feb 15, 2024

bors commented Feb 15, 2024

This comment has been minimized.

rust-timer commented Feb 16, 2024

Overall result: no relevant changes - no action needed

GuillaumeGomez commented Feb 16, 2024

GuillaumeGomez commented Feb 17, 2024

bors commented Feb 17, 2024

fmease commented Feb 15, 2024 •

edited

Loading

fmease Feb 15, 2024 •

edited

Loading

fmease Feb 15, 2024 •

edited

Loading

fmease Feb 16, 2024 •

edited

Loading