Tidy: detect ui tests subdirectory changes so `tests/ui/README.md` stays in sync by reddevilmidzy · Pull Request #150474 · rust-lang/rust

reddevilmidzy · 2025-12-29T01:36:20Z

There's an issue where tests/ui/README.md isn't updated whenever the ui subdirectory changes.
I've added subdirectory change detection to tidy ~~added a new mention to triage.toml to notify tests/ui/README.md to also be updated~~.

r? @Urgau

rustbot · 2025-12-29T01:36:23Z

triagebot.toml has been modified, there may have been changes to the review queue.

cc @davidtwco, @wesleywiser

src/tools/tidy/src/ui_tests.rs

triagebot.toml

src/tools/tidy/src/ui_tests.rs

Urgau · 2025-12-29T17:59:20Z

Looks good to me, but I will let the final review to a T-bootstrap member.

Btw, could you make the title and description a bit more descriptive.

r? bootstrap

reddevilmidzy · 2025-12-30T00:10:22Z

Okay, thank you for the review:)

Zalathar · 2025-12-30T01:48:23Z

I don't quite understand the purpose of having a separate ui_suites.txt.

If the goal is to keep tests/ui/README.md in sync with the subdirectories, wouldn't it make more sense to compare the list of subdirectories to the list of headings in the readme?

reddevilmidzy · 2025-12-30T02:47:31Z

I don't quite understand the purpose of having a separate ui_suites.txt.

If the goal is to keep tests/ui/README.md in sync with the subdirectories, wouldn't it make more sense to compare the list of subdirectories to the list of headings in the readme?

Ah, since the initial suggestion was to "add comments when subdirectories change," so we implemented it by creating a ui_suites.txt file so that triagebot could leave comments.

If we wanted to include directory change detection in tidy and force modifications to tests/ui/README.md, comparing the subtitles of tests/ui/README.md would be a better approach, as you suggested.

I will change it.

Urgau · 2025-12-30T09:55:27Z

I don't quite understand the purpose of having a separate ui_suites.txt.

If the goal is to keep tests/ui/README.md in sync with the subdirectories, wouldn't it make more sense to compare the list of subdirectories to the list of headings in the readme?

Parsing a Markdown file is non-trivial and tidy currently doesn't have a dependency on pulldown-cmark. I'm not sure we would want to add such dependency to tidy, so we would have to approximate it.

But in general yes, looking at tests/ui/README.md is probably better.

Zalathar · 2025-12-30T10:13:17Z

Given that this is an in-tree tidy check for a single file that we already control, I don't think we need to actually parse Markdown.

We can just assume that tests/ui/README.md will be written in a predictable style, and use a relatively-simple regex to extract directory names from lines that start with ##.

If somebody tries to modify the readme in a way that would break the tidy check, well, maybe they shouldn't be doing that.

Zalathar · 2026-01-02T00:44:22Z

@rustbot author

reddevilmidzy · 2026-01-02T11:22:48Z

Unified by removing '/' at the end of the title and added directories that did not have descriptions.

created:

tidy [ui_tests (tests)]: ui subdirectory `tests/ui/annotate-moves` created
tidy [ui_tests (tests)]: ui subdirectory `tests/ui/any` created
tidy [ui_tests (tests)]: ui subdirectory `tests/ui/collections` created
tidy [ui_tests (tests)]: ui subdirectory `tests/ui/deref` created
tidy [ui_tests (tests)]: ui subdirectory `tests/ui/dist` created
tidy [ui_tests (tests)]: ui subdirectory `tests/ui/eii` created
tidy [ui_tests (tests)]: ui subdirectory `tests/ui/float` created
tidy [ui_tests (tests)]: ui subdirectory `tests/ui/fn_traits` created
tidy [ui_tests (tests)]: ui subdirectory `tests/ui/higher-ranked-trait-bounds` created
tidy [ui_tests (tests)]: ui subdirectory `tests/ui/loop-match` created
tidy [ui_tests (tests)]: ui subdirectory `tests/ui/offload` created
tidy [ui_tests (tests)]: ui subdirectory `tests/ui/pin` created
tidy [ui_tests (tests)]: ui subdirectory `tests/ui/pin-ergonomics` created
tidy [ui_tests (tests)]: ui subdirectory `tests/ui/reborrow` created
tidy [ui_tests (tests)]: ui subdirectory `tests/ui/rust-2018` created
tidy [ui_tests (tests)]: ui subdirectory `tests/ui/rust-2021` created
tidy [ui_tests (tests)]: ui subdirectory `tests/ui/rust-2024` created
tidy [ui_tests (tests)]: ui subdirectory `tests/ui/sanitize-attr` created
tidy [ui_tests (tests)]: ui subdirectory `tests/ui/scalable-vectors` created
tidy [ui_tests (tests)]: ui subdirectory `tests/ui/sized-hierarchy` created
tidy [ui_tests (tests)]: ui subdirectory `tests/ui/stack-probes` created
tidy [ui_tests (tests)]: ui subdirectory `tests/ui/unstable-feature-bound` created

deleted

tidy [ui_tests (tests)]: ui subdirectory `tests/ui/rust-{2018,2021,2024}` deleted
tidy [ui_tests (tests)]: ui subdirectory `tests/ui/typeof` deleted

thank you for the review:)
@rustbot ready

reddevilmidzy · 2026-01-02T11:41:49Z

Ah, I will add a task to check the alignment. @rustbot author

reddevilmidzy · 2026-01-18T14:54:10Z

tests/ui/README.md

+## `tests/ui/reflection/`
+
+Exercises the `#![feature(type_info)]` feature.
+
+See [Tracking Issue for type_info #146922](https://github.com/rust-lang/rust/issues/146922)
+


This directory was also added within two weeks.😄

reddevilmidzy · 2026-01-18T16:07:22Z

@rustbot ready

Zalathar · 2026-01-28T11:04:02Z

Nitpick: Could you please reorder the commits, so that the readme changes come before adding the tidy check?

That way, every individual commit should successfully pass tests, which is a nice property to have.

After that, I think we should be good to go.

@rustbot author

rustbot · 2026-01-28T13:03:37Z

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.

reddevilmidzy

Thank you for the review! @Zalathar

@rustbot ready

View changes since this review

reddevilmidzy · 2026-01-28T14:03:45Z

tests/ui/README.md

+## `tests/ui/trimmed-paths/`
+
+Tests for the `#[doc(hidden)]` items.
+


Rearranged the commit order and added this section,

Zalathar · 2026-01-29T00:17:43Z

Thanks for your patience. 🙌

@bors r+

rust-bors · 2026-01-29T00:17:46Z

📌 Commit a085410 has been approved by Zalathar

It is now in the queue for this repository.

@Urgau

…thar Tidy: detect ui tests subdirectory changes so `tests/ui/README.md` stays in sync close: rust-lang#150399 There's an issue where `tests/ui/README.md` isn't updated whenever the ui subdirectory changes. I've added subdirectory change detection to tidy ~~added a new mention to `triage.toml` to notify `tests/ui/README.md` to also be updated~~. r? @Urgau

Rollup of 8 pull requests Successful merges: - #150474 (Tidy: detect ui tests subdirectory changes so `tests/ui/README.md` stays in sync) - #150572 (Improve move error diagnostic for `AsyncFn` closures) - #151596 (Fix -Zmir-enable-passes to detect unregistered enum names in declare_passes macro) - #151802 (Make `QueryDispatcher::Qcx` an associated type) - #151559 ([rustdoc] Add a marker to tell users that there are hidden (deprecated) items in the search results) - #151665 (Fix contrast ratio for `Since` element in rustodoc dark theme) - #151798 (Update `askama` to `0.15.3`) - #151800 (Subscribe myself to translation diagnostics)

Rollup of 12 pull requests Successful merges: - #150474 (Tidy: detect ui tests subdirectory changes so `tests/ui/README.md` stays in sync) - #150572 (Improve move error diagnostic for `AsyncFn` closures) - #151596 (Fix -Zmir-enable-passes to detect unregistered enum names in declare_passes macro) - #151802 (Make `QueryDispatcher::Qcx` an associated type) - #149110 (Implement `cast_slice` for raw pointer types) - #151559 ([rustdoc] Add a marker to tell users that there are hidden (deprecated) items in the search results) - #151665 (Fix contrast ratio for `Since` element in rustdoc dark theme) - #151785 (Stabilize feature(push_mut)) - #151798 (Update `askama` to `0.15.3`) - #151800 (Subscribe myself to translation diagnostics) - #151804 (Document, sort, and tweak spellcheck entries in `typos.toml`) - #151805 (Fix grammar in `env::current_exe()#Security`)

@Urgau

Rollup merge of #150474 - reddevilmidzy:tidy-sub-dir, r=Zalathar Tidy: detect ui tests subdirectory changes so `tests/ui/README.md` stays in sync close: #150399 There's an issue where `tests/ui/README.md` isn't updated whenever the ui subdirectory changes. I've added subdirectory change detection to tidy ~~added a new mention to `triage.toml` to notify `tests/ui/README.md` to also be updated~~. r? @Urgau

rustbot assigned Urgau Dec 29, 2025

reddevilmidzy commented Dec 29, 2025

View reviewed changes

src/tools/tidy/src/ui_tests.rs Outdated Show resolved Hide resolved

reddevilmidzy commented Dec 29, 2025

View reviewed changes

src/tools/tidy/src/ui_tests.rs Outdated Show resolved Hide resolved

Urgau reviewed Dec 29, 2025

View reviewed changes

reddevilmidzy force-pushed the tidy-sub-dir branch from d6dc370 to a2945a2 Compare December 29, 2025 14:09

rustbot assigned Zalathar and unassigned Urgau Dec 29, 2025

reddevilmidzy changed the title ~~Add subdirectory change detection to tidy~~ Tidy: detect subdirectory changes so tests/ui/README.md stays in sync Dec 30, 2025

reddevilmidzy changed the title ~~Tidy: detect subdirectory changes so tests/ui/README.md stays in sync~~ Tidy: detect ui tests subdirectory changes so tests/ui/README.md stays in sync Dec 30, 2025

rustbot 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-review Status: Awaiting review from the assignee but also interested parties. labels Jan 2, 2026

reddevilmidzy force-pushed the tidy-sub-dir branch 2 times, most recently from 7f0149f to 4bbba21 Compare January 2, 2026 11:16

This comment has been minimized.

Sign in to view

rustbot 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 Jan 2, 2026

This comment has been minimized.

Sign in to view

reddevilmidzy commented Jan 18, 2026

View reviewed changes

rustbot 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 Jan 18, 2026

rustbot 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-review Status: Awaiting review from the assignee but also interested parties. labels Jan 28, 2026

reddevilmidzy added 3 commits January 28, 2026 21:25

Add section to tests/ui/README.md

7e6d3a2

Reorder tests/ui/README.md

500dc3c

Add subdirectory change detection to tidy

a085410

reddevilmidzy force-pushed the tidy-sub-dir branch from d6a97fa to a085410 Compare January 28, 2026 13:03

reddevilmidzy commented Jan 28, 2026

View reviewed changes

rustbot 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 Jan 28, 2026

rust-bors bot 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 Jan 29, 2026

Zalathar mentioned this pull request Jan 29, 2026

Rollup of 8 pull requests #151803

Closed

Zalathar mentioned this pull request Jan 29, 2026

Rollup of 12 pull requests #151809

Merged

rust-bors bot merged commit dd43c88 into rust-lang:main Jan 29, 2026
11 checks passed

rustbot added this to the 1.95.0 milestone Jan 29, 2026

reddevilmidzy deleted the tidy-sub-dir branch January 29, 2026 11:59

github-actions bot mentioned this pull request Jan 30, 2026

Toolchain upgrade to nightly-2026-02-09 flux-rs/flux#1345

Open

		## `tests/ui/trimmed-paths/`

		Tests for the `#[doc(hidden)]` items.

Uh oh!

Conversation

reddevilmidzy commented Dec 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rustbot commented Dec 29, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Urgau commented Dec 29, 2025

Uh oh!

reddevilmidzy commented Dec 30, 2025

Uh oh!

Zalathar commented Dec 30, 2025

Uh oh!

reddevilmidzy commented Dec 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Urgau commented Dec 30, 2025

Uh oh!

Zalathar commented Dec 30, 2025

Uh oh!

Zalathar commented Jan 2, 2026

Uh oh!

This comment has been minimized.

reddevilmidzy commented Jan 2, 2026

Uh oh!

reddevilmidzy commented Jan 2, 2026

Uh oh!

This comment has been minimized.

reddevilmidzy Jan 18, 2026

Choose a reason for hiding this comment

Uh oh!

reddevilmidzy commented Jan 18, 2026

Uh oh!

Zalathar commented Jan 28, 2026

Uh oh!

rustbot commented Jan 28, 2026

Uh oh!

reddevilmidzy 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!

reddevilmidzy Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

Zalathar commented Jan 29, 2026

Uh oh!

rust-bors bot commented Jan 29, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

reddevilmidzy commented Dec 29, 2025 •

edited

Loading

reddevilmidzy commented Dec 30, 2025 •

edited

Loading

reddevilmidzy left a comment •

edited by rustbot

Loading