Skip to content

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

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
Open
GuillaumeGomez wants to merge 2 commits into
base: main
Choose a base branch
from
Open

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

GuillaumeGomez wants to merge 2 commits into from
+77 −90

Conversation

@GuillaumeGomez
Copy link
Member

@GuillaumeGomez GuillaumeGomez commented Jan 3, 2026

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
Copy link
Collaborator

rustbot commented Jan 3, 2026

Some changes occurred in src/tools/opt-dist

cc @Kobzol

Some changes occurred in src/tools/compiletest

cc @jieyouxu

@rustbot rustbot added A-CI Area: Our Github Actions CI A-compiletest Area: The compiletest test runner A-meta Area: Issues & PRs about the rust-lang/rust repository itself A-testsuite Area: The testsuite used to check the correctness of rustc S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) T-infra Relevant to the infrastructure team, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output. labels Jan 3, 2026
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@rustbot rustbot added the A-tidy Area: The tidy tool label Jan 3, 2026
@rust-log-analyzer

This comment has been minimized.

Sign in to view
fmease
fmease approved these changes Jan 3, 2026
View reviewed changes
Copy link
Member

@fmease fmease left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Member Author

GuillaumeGomez commented Jan 3, 2026

Sure!

@rustbot
Copy link
Collaborator

rustbot commented Jan 3, 2026

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

@rustbot rustbot added the A-rustc-dev-guide Area: rustc-dev-guide label Jan 3, 2026
fmease
fmease reviewed Jan 3, 2026
View reviewed changes
Copy link
Member

@fmease fmease left a comment •
edited by rustbot
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

View changes since this review

@rustbot
Copy link
Collaborator

rustbot commented Jan 3, 2026

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

fmease
fmease reviewed Jan 3, 2026
View reviewed changes
src/bootstrap/src/core/builder/cli_paths/snapshots/x_test_librustdoc_rustdoc_html.snap
Copy link
Member

@fmease fmease Jan 3, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

@fmease fmease Jan 3, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(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 fmease self-assigned this Jan 3, 2026
fmease
fmease reviewed Jan 3, 2026
View reviewed changes
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>
Copy link
Member

@fmease fmease Jan 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member Author

@GuillaumeGomez GuillaumeGomez Jan 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@rust-log-analyzer

This comment has been minimized.

Sign in to view
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@fmease fmease fmease approved these changes

Assignees

@fmease fmease

@camelid camelid

Labels

A-CI Area: Our Github Actions CI A-compiletest Area: The compiletest test runner A-meta Area: Issues & PRs about the rust-lang/rust repository itself A-rustc-dev-guide Area: rustc-dev-guide A-testsuite Area: The testsuite used to check the correctness of rustc A-tidy Area: The tidy tool S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) T-infra Relevant to the infrastructure team, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@GuillaumeGomez @rustbot @rust-log-analyzer @fmease @camelid