Rename `tests/rustdoc` into `tests/rustdoc-html` #150645

GuillaumeGomez · 2026-01-03T12:08:40Z

As discussed on zulip, renaming this testsuite better reflects what they actually test. Later on, it could also allow us to add an alias to run all rustdoc tests at once.

r? @camelid

rustbot · 2026-01-03T12:08:43Z

Some changes occurred in src/tools/opt-dist

cc @Kobzol

Some changes occurred in src/tools/compiletest

cc @jieyouxu

fmease

Could you please also update the dev-guide in this PR (in a separate commit is fine) which is a subtree in this repo, namely in src/doc/rustc-dev-guide/.

E.g., renaming src/doc/rustc-dev-guide/src/rustdoc-internals/rustdoc-test-suite.md to src/doc/rustc-dev-guide/src/rustdoc-internals/rustdoc-html-test-suite.md & updating chapter name, link texts etc. Highly appreciated! :)

View changes since this review

GuillaumeGomez · 2026-01-03T15:02:22Z

Sure!

rustbot · 2026-01-03T15:09:14Z

The rustc-dev-guide subtree was changed. If this PR only touches the dev guide consider submitting a PR directly to rust-lang/rustc-dev-guide otherwise thank you for updating the dev guide with your changes.

cc @BoxyUwU, @jieyouxu, @Kobzol, @tshepang

fmease

Two more things, then r=me unless you'd like to get reviews from others, too.

View changes since this review

src/bootstrap/src/core/build_steps/test.rs

src/tools/compiletest/src/common.rs

rustbot · 2026-01-03T19:07:38Z

compiletest directives have been modified. Please add or update docs for the
new or modified directive in src/doc/rustc-dev-guide/.

fmease · 2026-01-03T19:47:42Z

src/bootstrap/src/core/builder/cli_paths/snapshots/x_test_librustdoc_rustdoc_html.snap

As you can see from the test expectation changes, running ./x test librustdoc rustdoc no longer tests tests/rustdoc (since it no longer exists).

You should update the expression from rustdoc to rustdoc-html, rename this file and rebless the snap. Similarly for the other test file.

(If we ever introduce rustdoc as an alias for all rustdoc-* test suites, we can change the rustdoc-html back to rustdoc in these two tests (or just keep them and add new ones))

fmease · 2026-01-03T19:52:27Z

src/bootstrap/src/core/builder/tests.rs

        [build] rustc 0 <host> -> RustdocGUITest 1 <host>
        [test] rustdoc-gui 1 <host>
        [test] compiletest-incremental 1 <host>
-        [build] rustc 1 <host> -> rustc 2 <host>


Hmm, I'm slightly worried about this disappearing... I don't see why that has happened (similarly for the other tests in this file). I haven't looked closely at these tests & I'm not super familar with bootstrap's innards, so I might be missing sth.

Let's wait for @Kobzol to have a look to ensure I didn't break something.

I suspect this is because x test rustdoc also tries to run unit tests for src/tools/rustdoc, despite that being a stub crate with no tests in it.

Actually, looking at the results of running x test src/tools/rustdoc on main, I have no idea what's going on. 🤷‍♂️

Ah, x test src/tools/rustdoc is effectively treated as an alias for x test src/librustdoc, so it's running the unit tests and doctests for src/librustdoc.

Zalathar · 2026-01-05T04:46:16Z

src/bootstrap/src/core/builder/cli_paths/tests.rs

-    (x_test_librustdoc_rustdoc, "test librustdoc rustdoc"),
-    (x_test_rustdoc, "test rustdoc"),


IMO we should leave these two lines untouched, and instead add a new line for (x_test_rustdoc_html, "test rustdoc-html").

The primary purpose of these existing lines is to capture the weird aliasing behaviour of src/librustdoc and src/tools/rustdoc, so it’s expected that renaming tests/rustdoc will affect the snapshots.

Sure, done!

Kobzol

Changes LGTM (with #150645 (comment) changed).

View changes since this review

bors · 2026-01-06T04:53:33Z

☔ The latest upstream changes (presumably #150640) made this pull request unmergeable. Please resolve the merge conflicts.

rust-bors · 2026-01-06T04:54:36Z

☔ The latest upstream changes made this pull request unmergeable. Please resolve the merge conflicts.

…stdoc-html`

rustbot · 2026-01-07T13:23:41Z

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.

GuillaumeGomez · 2026-01-07T13:32:52Z

Ready to go then! Setting a priority of 1 seems it updates so many files...

Thanks for the reviews!

@bors r=Kobzol,Zalathar p=1

bors · 2026-01-07T13:32:55Z

📌 Commit 8256623 has been approved by Kobzol,Zalathar

It is now in the queue for this repository.

bors · 2026-01-07T13:32:56Z

🌲 The tree is currently closed for pull requests below priority 1000. This pull request will be tested once the tree is reopened.

rust-bors · 2026-01-07T13:32:57Z

📌 Commit 8256623 has been approved by Kobzol,Zalathar

It is now in the queue for this repository.

🌲 The tree is currently closed for pull requests below priority 50. This pull request will be tested once the tree is reopened.

rust-bors · 2026-01-07T19:35:46Z

☀️ Test successful - CI
Approved by: Kobzol,Zalathar
Pushing fc546b9 to main...

rust-log-analyzer · 2026-01-07T19:47:56Z

A job failed! Check out the build log: (web) (plain enhanced) (plain)

Click to see the possible cause of the failure (guessed by this bot)

     Running `target/release/citool post-merge-report fc546b94ad5d499753c190b733128f49fb18e1d5`
error: the following required arguments were not provided:
  <CURRENT>

Usage: citool post-merge-report <PARENT> <CURRENT>

For more information, try '--help'.
##[error]Process completed with exit code 2.
Post job cleanup.

rust-timer · 2026-01-08T01:21:14Z

Finished benchmarking commit (fc546b9): comparison URL.

Overall result: ❌ regressions - no action needed

@rustbot label: -perf-regression

Instruction count

Our most reliable metric. Used to determine the overall result above. However, even this metric can be noisy.

	mean	range	count
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	0.6%	[0.5%, 0.6%]	3
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-	-	0
All ❌✅ (primary)	-	-	0

Max RSS (memory usage)

Results (primary -1.9%, 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)	-1.9%	[-1.9%, -1.9%]	1
Improvements ✅ (secondary)	-2.4%	[-2.4%, -2.4%]	1
All ❌✅ (primary)	-1.9%	[-1.9%, -1.9%]	1

Cycles

Results (secondary 2.2%)

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

Binary size

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

Bootstrap: 474.983s -> 487.524s (2.64%)
Artifact size: 390.84 MiB -> 390.86 MiB (0.01%)

rustbot assigned camelid Jan 3, 2026

This comment has been minimized.

Sign in to view

GuillaumeGomez force-pushed the rename-rustdoc-tests branch from e2f1bcc to 29e47c2 Compare January 3, 2026 12:29

rustbot added the A-tidy Area: The tidy tool label Jan 3, 2026

This comment has been minimized.

Sign in to view

fmease approved these changes Jan 3, 2026

View reviewed changes

GuillaumeGomez force-pushed the rename-rustdoc-tests branch from 29e47c2 to ccbf24e Compare January 3, 2026 15:09

rustbot added the A-rustc-dev-guide Area: rustc-dev-guide label Jan 3, 2026

fmease reviewed Jan 3, 2026

View reviewed changes

src/bootstrap/src/core/build_steps/test.rs Outdated Show resolved Hide resolved

src/bootstrap/src/core/build_steps/test.rs Outdated Show resolved Hide resolved

src/tools/compiletest/src/common.rs Outdated Show resolved Hide resolved

GuillaumeGomez force-pushed the rename-rustdoc-tests branch from ccbf24e to 2254355 Compare January 3, 2026 19:07

fmease reviewed Jan 3, 2026

View reviewed changes

fmease self-assigned this Jan 3, 2026

fmease reviewed Jan 3, 2026

View reviewed changes

This comment has been minimized.

Sign in to view

GuillaumeGomez force-pushed the rename-rustdoc-tests branch from 2254355 to 324ccf0 Compare January 3, 2026 23:09

Zalathar reviewed Jan 5, 2026

View reviewed changes

Kobzol approved these changes Jan 5, 2026

View reviewed changes

GuillaumeGomez added 2 commits January 7, 2026 14:23

Rename tests/rustdoc into tests/rustdoc-html

a928f33

Update rustc-dev-guide about tests/rustdoc renamed into `tests/ru…

8256623

…stdoc-html`

GuillaumeGomez force-pushed the rename-rustdoc-tests branch from 324ccf0 to 8256623 Compare January 7, 2026 13:23

rust-bors bot added the S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. label Jan 7, 2026

rust-bors bot removed the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jan 7, 2026

This comment has been minimized.

Sign in to view

rust-bors bot added the merged-by-bors This PR was explicitly merged by bors. label Jan 7, 2026

rust-bors bot merged commit fc546b9 into rust-lang:main Jan 7, 2026
12 checks passed

rustbot added this to the 1.94.0 milestone Jan 7, 2026

rust-bors bot mentioned this pull request Jan 7, 2026

Finish transition from semitransparent to semiopaque for rustc_macro_transparency #150561

Open

		(x_test_librustdoc_rustdoc, "test librustdoc rustdoc"),
		(x_test_rustdoc, "test rustdoc"),

Uh oh!

Rename tests/rustdoc into tests/rustdoc-html #150645

Rename tests/rustdoc into tests/rustdoc-html #150645

Conversation

GuillaumeGomez commented Jan 3, 2026

Uh oh!

rustbot commented Jan 3, 2026

Uh oh!

This comment has been minimized.

This comment has been minimized.

fmease left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez commented Jan 3, 2026

Uh oh!

rustbot commented Jan 3, 2026

Uh oh!

fmease left a comment • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rustbot commented Jan 3, 2026

Uh oh!

fmease Jan 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fmease Jan 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

Choose a reason for hiding this comment

Uh oh!

Zalathar Jan 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Kobzol left a comment • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bors commented Jan 6, 2026

Uh oh!

rust-bors bot commented Jan 6, 2026

Uh oh!

rustbot commented Jan 7, 2026

Uh oh!

GuillaumeGomez commented Jan 7, 2026

Uh oh!

bors commented Jan 7, 2026

Uh oh!

bors commented Jan 7, 2026

Uh oh!

rust-bors bot commented Jan 7, 2026

Uh oh!

This comment has been minimized.

rust-bors bot commented Jan 7, 2026

Uh oh!

Uh oh!

rust-log-analyzer commented Jan 7, 2026

Uh oh!

rust-timer commented Jan 8, 2026

Overall result: ❌ regressions - no action needed

Rename `tests/rustdoc` into `tests/rustdoc-html` #150645

Rename `tests/rustdoc` into `tests/rustdoc-html` #150645

fmease left a comment •

edited

Loading

fmease left a comment •

edited by rustbot

Loading

fmease Jan 3, 2026 •

edited

Loading

fmease Jan 3, 2026 •

edited

Loading

Zalathar Jan 5, 2026 •

edited

Loading

Kobzol left a comment •

edited by rustbot

Loading