-
Notifications
You must be signed in to change notification settings - Fork 13.4k
Document subdirectories of UI tests with README files #141597
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.
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
base: master
Are you sure you want to change the base?
Conversation
This comment has been minimized.
This comment has been minimized.
7d9b1a5
to
2a001cc
Compare
This comment has been minimized.
This comment has been minimized.
I feel like this is not super useful unless we explicitly establish an index structure to make those docs discoverable, i.e.
and the in r-d-g, describe this convention, and point to entry point |
That is true. Anyone who doesn't want to comb through the directories certainly isn't going to comb through the READMEs. A single one, where specific strings can be searched, is much superior. |
I know I've been confused on what ui subdirectories we have, so an TL;DR of exisiting ui dirs, e.g. # UI test suite
## Subdirectories
- [`foo/`](./foo/): exercises `foo` area of language |
2a001cc
to
3381c61
Compare
@rustbot note pr-description-is-outdated Can you also update PR description, since we don't anymore have specific per-subdir |
@rustbot note stub-out-remaining-subdirs Can you also stub out existing remaining subdirs? E.g. ## `tests/ui/subdir/`: TODO(#141695)
TODO(#141695): add some description |
3381c61
to
6107ff8
Compare
This comment has been minimized.
This comment has been minimized.
6107ff8
to
6ed90f5
Compare
This comment has been minimized.
This comment has been minimized.
6ed90f5
to
bd919b9
Compare
This comment has been minimized.
This comment has been minimized.
bd919b9
to
7e3dd8d
Compare
This comment has been minimized.
This comment has been minimized.
@rustbot note remove pr-description-is-outdated |
@rustbot note remove stub-out-remaining-subdirs |
7e3dd8d
to
b4a4181
Compare
This comment has been minimized.
This comment has been minimized.
b4a4181
to
a46a8e7
Compare
This comment has been minimized.
This comment has been minimized.
a46a8e7
to
0ec6d9b
Compare
This comment has been minimized.
This comment has been minimized.
0ec6d9b
to
f0aa93b
Compare
This comment has been minimized.
This comment has been minimized.
f0aa93b
to
569976d
Compare
This comment has been minimized.
This comment has been minimized.
569976d
to
19c0527
Compare
This comment has been minimized.
This comment has been minimized.
19c0527
to
12e33a0
Compare
This comment has been minimized.
This comment has been minimized.
12e33a0
to
54ce2b8
Compare
The job Click to see the possible cause of the failure (guessed by this bot)
|
Part of #133895 and the 2025 Google Summer of Code associated project.
When adding a new UI test, one is faced with hundreds of subdirectories in
tests/ui
reflecting various categories. Knowing where to put the new test is not trivial, as many of the categories have slightly misleading names. For example,moves
does not only refer to themove
keyword but to functions taking ownership in general, whereasallocator
does not refer to allocation in general but rather to the very specificallocator_api
andglobal_allocator
features.Many contributors will therefore place their test at the top level of ̀
tests/ui
where it will be mixed with hundreds of unrelated tests.This PR is a tentative move towards more clearly defined tag/categories, with a SUMMARY.md file documenting the true purpose of each subdirectory, placed inside
tests/ui
.r? @jieyouxu