rustdoc: Don't pass `RenderOptions` to `DocContext` #147832

aDotInTheVoid · 2025-10-17T22:01:01Z

RenderOptions is full of HTML specific fields. The only ones that DocContext needs are document_private and document_hidden, which are accessable via Cache anyway.

Part of a larger campeign against RenderOption:
https://rust-lang.zulipchat.com/#narrow/channel/266220-t-rustdoc/topic/Using.20.60RenderOptions.60.20in.20less.20places.2E/with/545705812

rustbot · 2025-10-17T22:01:06Z

r? @notriddle

rustbot has assigned @notriddle.
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

aDotInTheVoid · 2025-10-17T22:02:12Z

src/librustdoc/core.rs


+    // Remnence of processing crate attributes for passes to run.
+    // To be removed in https://github.com/rust-lang/rust/pull/146495.
+    if clean::hir_attr_lists(tcx.get_all_attrs(rustc_hir::def_id::CRATE_DEF_ID), sym::doc)


CC @fmease. I'd rather this didn't need to wait for the FCP in #146495, so I've moved the code here. As noted, it has no tests 👻

Fine by me. Ideally my PR would've come first but alas. The source code comment is a bit too assertive, after all the pFCP-merge might not go through.

Removed: https://github.com/rust-lang/rust/compare/abb2d7598941974f414f182bf82562f6644fcc37..937ecd5d1570b3e2044b51b4fd884b7d7b10f986

fmease · 2025-10-31T00:32:39Z

(just double-checking)

@bors try @rust-timer queue

rustdoc: Don't pass `RenderOptions` to `DocContext`

rust-bors · 2025-10-31T02:47:51Z

☀️ Try build successful (CI)
Build commit: 64dd2c7 (64dd2c7a3a0c0326d0673dbc173b2a96a5c1cbdd, parent: d5419f1e97b90741d51841f800d3c697c662567d)

rust-timer · 2025-10-31T04:15:06Z

Finished benchmarking commit (64dd2c7): comparison URL.

Overall result: no relevant changes - no action needed

Benchmarking this pull request means it may be perf-sensitive – we'll automatically label it not fit for rolling up. You can override this, but we strongly advise not to, due to possible 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 (secondary -4.3%)

A less reliable metric. May be of interest, but not used to determine the overall result above.

	mean	range	count
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	-	-	0
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-4.3%	[-4.5%, -4.1%]	2
All ❌✅ (primary)	-	-	0

Cycles

Results (secondary -2.4%)

A less reliable metric. May be of interest, but not used to determine the overall result above.

	mean	range	count
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	-	-	0
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-2.4%	[-2.4%, -2.4%]	1
All ❌✅ (primary)	-	-	0

Binary size

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

Bootstrap: 473.872s -> 476.054s (0.46%)
Artifact size: 390.40 MiB -> 390.34 MiB (-0.02%)

fmease · 2025-11-10T20:43:27Z

Blocked on #146495 getting merged.

rustbot · 2025-11-11T18:27:01Z

This PR was rebased onto a different main commit. Here's a range-diff highlighting what actually changed.

Rebasing is a normal part of keeping PRs up to date, so no action is needed—this note is just to help reviewers.

aDotInTheVoid · 2025-11-11T18:29:30Z

Rebased.

@bors r=GuillaumeGomez

bors · 2025-11-11T18:29:32Z

📌 Commit 6f1cecf has been approved by GuillaumeGomez

It is now in the queue for this repository.

…aumeGomez rustdoc: Don't pass `RenderOptions` to `DocContext` `RenderOptions` is full of HTML specific fields. The only ones that `DocContext` needs are `document_private` and `document_hidden`, which are accessable via `Cache` anyway. Part of a larger campeign against `RenderOption`: https://rust-lang.zulipchat.com/#narrow/channel/266220-t-rustdoc/topic/Using.20.60RenderOptions.60.20in.20less.20places.2E/with/545705812

bors · 2025-11-11T21:43:05Z

⌛ Testing commit 6f1cecf with merge ae7173e...

fmease · 2025-11-11T21:44:23Z

@bors r-

bors · 2025-11-11T21:52:59Z

💔 Test failed - checks-actions

`RenderOptions` is full of HTML specific fields. The only ones that `DocContext` needs are `document_private` and `document_hidden`, which are accessable via `Cache` anyway. Part of a larger campeign against `RenderOptions`: https://rust-lang.zulipchat.com/#narrow/channel/266220-t-rustdoc/topic/Using.20.60RenderOptions.60.20in.20less.20places.2E/with/545705812

aDotInTheVoid · 2025-11-11T23:47:19Z

@bors r=GuillaumeGomez

bors · 2025-11-11T23:47:21Z

📌 Commit b808f33 has been approved by GuillaumeGomez

It is now in the queue for this repository.

aDotInTheVoid · 2025-11-12T01:04:28Z

@bors rollup=always

…ns, r=GuillaumeGomez rustdoc: Don't pass `RenderOptions` to `DocContext` `RenderOptions` is full of HTML specific fields. The only ones that `DocContext` needs are `document_private` and `document_hidden`, which are accessable via `Cache` anyway. Part of a larger campeign against `RenderOption`: https://rust-lang.zulipchat.com/#narrow/channel/266220-t-rustdoc/topic/Using.20.60RenderOptions.60.20in.20less.20places.2E/with/545705812

Rollup of 16 pull requests Successful merges: - #146627 (Simplify `jemalloc` setup) - #147753 (Suggest add bounding value for RangeTo) - #147832 (rustdoc: Don't pass `RenderOptions` to `DocContext`) - #147974 (Improve diagnostics for buffer reuse with borrowed references) - #148080 ([rustdoc] Fix invalid jump to def macro link generation) - #148465 (Adjust spans into the `for` loops context before creating the new desugaring spans.) - #148500 (Update git index before running diff-index) - #148531 (rustc_target: introduce Abi, Env, Os) - #148536 (cmse: add test for `async` and `const` functions) - #148770 (implement `feature(c_variadic_naked_functions)`) - #148780 (fix filecheck typos in tests) - #148819 (Remove specialized warning for removed target) - #148830 (miri subtree update) - #148833 (Update rustbook dependencies) - #148834 (fix(rustdoc): Color doctest errors) - #148841 (Remove more `#[must_use]` from portable-simd) r? `@ghost` `@rustbot` modify labels: rollup

Rollup merge of #147832 - aDotInTheVoid:rustdoc-format-options, r=GuillaumeGomez rustdoc: Don't pass `RenderOptions` to `DocContext` `RenderOptions` is full of HTML specific fields. The only ones that `DocContext` needs are `document_private` and `document_hidden`, which are accessable via `Cache` anyway. Part of a larger campeign against `RenderOption`: https://rust-lang.zulipchat.com/#narrow/channel/266220-t-rustdoc/topic/Using.20.60RenderOptions.60.20in.20less.20places.2E/with/545705812

Rollup of 16 pull requests Successful merges: - rust-lang/rust#146627 (Simplify `jemalloc` setup) - rust-lang/rust#147753 (Suggest add bounding value for RangeTo) - rust-lang/rust#147832 (rustdoc: Don't pass `RenderOptions` to `DocContext`) - rust-lang/rust#147974 (Improve diagnostics for buffer reuse with borrowed references) - rust-lang/rust#148080 ([rustdoc] Fix invalid jump to def macro link generation) - rust-lang/rust#148465 (Adjust spans into the `for` loops context before creating the new desugaring spans.) - rust-lang/rust#148500 (Update git index before running diff-index) - rust-lang/rust#148531 (rustc_target: introduce Abi, Env, Os) - rust-lang/rust#148536 (cmse: add test for `async` and `const` functions) - rust-lang/rust#148770 (implement `feature(c_variadic_naked_functions)`) - rust-lang/rust#148780 (fix filecheck typos in tests) - rust-lang/rust#148819 (Remove specialized warning for removed target) - rust-lang/rust#148830 (miri subtree update) - rust-lang/rust#148833 (Update rustbook dependencies) - rust-lang/rust#148834 (fix(rustdoc): Color doctest errors) - rust-lang/rust#148841 (Remove more `#[must_use]` from portable-simd) r? `@ghost` `@rustbot` modify labels: rollup

rustbot assigned notriddle Oct 17, 2025

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 Oct 17, 2025

aDotInTheVoid added the C-cleanup Category: PRs that clean code up or issues documenting cleanup. label Oct 17, 2025

aDotInTheVoid commented Oct 17, 2025

View reviewed changes

aDotInTheVoid mentioned this pull request Oct 22, 2025

rustdoc-json: Postcard output #142642

Draft

This comment has been minimized.

Sign in to view

rust-bors bot added a commit that referenced this pull request Oct 31, 2025

Auto merge of #147832 - aDotInTheVoid:rustdoc-format-options, r=<try>

64dd2c7

rustdoc: Don't pass `RenderOptions` to `DocContext`

rustbot added the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Oct 31, 2025

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 Oct 31, 2025

rust-cloud-vms bot force-pushed the rustdoc-format-options branch from abb2d75 to 937ecd5 Compare October 31, 2025 18:14

GuillaumeGomez approved these changes Nov 10, 2025

View reviewed changes

rust-cloud-vms bot force-pushed the rustdoc-format-options branch from 937ecd5 to 3a7fca7 Compare November 11, 2025 18:26

rust-cloud-vms bot force-pushed the rustdoc-format-options branch from 3a7fca7 to 6f1cecf Compare November 11, 2025 18:27

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 Nov 11, 2025

This comment has been minimized.

Sign in to view

bors 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-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Nov 11, 2025

bors 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 Nov 11, 2025

rust-cloud-vms bot force-pushed the rustdoc-format-options branch from 6f1cecf to 42bdde1 Compare November 11, 2025 21:58

This comment has been minimized.

Sign in to view

rust-cloud-vms bot force-pushed the rustdoc-format-options branch from 42bdde1 to b808f33 Compare November 11, 2025 22:00

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 Nov 11, 2025

Zalathar mentioned this pull request Nov 12, 2025

Rollup of 16 pull requests #148851

Merged

bors merged commit 203130b into rust-lang:main Nov 12, 2025
11 checks passed

rustbot added this to the 1.93.0 milestone Nov 12, 2025

rustdoc: Don't pass RenderOptions to DocContext #147832

rustdoc: Don't pass RenderOptions to DocContext #147832

Conversation

aDotInTheVoid commented Oct 17, 2025

Uh oh!

rustbot commented Oct 17, 2025

Uh oh!

aDotInTheVoid Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

fmease Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

aDotInTheVoid Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

fmease commented Oct 31, 2025

Uh oh!

This comment has been minimized.

This comment has been minimized.

rust-bors bot commented Oct 31, 2025

Uh oh!

This comment has been minimized.

rust-timer commented Oct 31, 2025

Overall result: no relevant changes - no action needed

Instruction count

Max RSS (memory usage)

Cycles

Binary size

Uh oh!

fmease commented Nov 10, 2025

Uh oh!

rustbot commented Nov 11, 2025

Uh oh!

aDotInTheVoid commented Nov 11, 2025

Uh oh!

bors commented Nov 11, 2025

Uh oh!

This comment has been minimized.

bors commented Nov 11, 2025

Uh oh!

fmease commented Nov 11, 2025

Uh oh!

bors commented Nov 11, 2025

Uh oh!

This comment has been minimized.

aDotInTheVoid commented Nov 11, 2025

Uh oh!

bors commented Nov 11, 2025

Uh oh!

aDotInTheVoid commented Nov 12, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

rustdoc: Don't pass `RenderOptions` to `DocContext` #147832

rustdoc: Don't pass `RenderOptions` to `DocContext` #147832