Skip to content

Unify ui test inline error annotation style #859

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

Open
1 of 3 tasks
WaffleLapkin opened this issue Apr 9, 2025 · 1 comment
Open
1 of 3 tasks

Unify ui test inline error annotation style #859

WaffleLapkin opened this issue Apr 9, 2025 · 1 comment
Labels
major-change A proposal to make a major change to rustc T-compiler Add this label so rfcbot knows to poll the compiler team

Comments

@WaffleLapkin
Copy link
Member

WaffleLapkin commented Apr 9, 2025

Proposal

Currently there are four styles of inline error annotations accepted by our testing infra:

//~ error lowercase, no colon
//~ error: lowercase, colon
//~ ERROR uppercase, no colon
//~ ERROR: uppercase, colon

i.e. you can either use lowercase or uppercase and either include colon or not.

Having multuple styles is not only unnecessary, but also slightly bad. It makes it harder to search for the annotations, it makes contributors (especially new ones) doubt which style to use, it makes it harder to read tests (since you need to recognize different styles).

As @jieyouxu said here, there are multiple places where compiletest is too lax in what it accepts for no real benefit. This is one of them. Others should probably be also addressed.

We should decide on a single style and enforce it. As always with styling decisions different people have different preferences, however enforcing any style would be better than the status quo.

Some data points:

  • @petrochenkov notes that ERROR (uppercase, no colon) is the most popular style.
  • miri and clippy are using ui_test which only accepts ERROR: (uppercase, colon).

Mentors or Reviewers

No mentorship is needed really, since this is a simple change, even if big.

Process

The main points of the Major Change Process are as follows:

  • File an issue describing the proposal.
  • A compiler team member or contributor who is knowledgeable in the area can second by writing @rustbot second.
    • Finding a "second" suffices for internal changes. If however, you are proposing a new public-facing feature, such as a -C flag, then full team check-off is required.
    • Compiler team members can initiate a check-off via @rfcbot fcp merge on either the MCP or the PR.
  • Once an MCP is seconded, the Final Comment Period begins. If no objections are raised after 10 days, the MCP is considered approved.

You can read more about Major Change Proposals on forge.

@WaffleLapkin WaffleLapkin added major-change A proposal to make a major change to rustc T-compiler Add this label so rfcbot knows to poll the compiler team labels Apr 9, 2025
@rustbot
Copy link
Collaborator

rustbot commented Apr 9, 2025

Important

This issue is not meant to be used for technical discussion. There is a Zulip stream for that.
Use this issue to leave procedural comments, such as volunteering to review, indicating that you second the proposal (or third, etc), or raising a concern that you would like to be addressed.

Concerns or objections can formally be registered here by adding a comment.

@rfcbot concern reason-for-concern
<description of the concern>

Concerns can be lifted with:

@rfcbot resolve reason-for-concern

See documentation at https://forge.rust-lang.org

cc @rust-lang/compiler

@rustbot rustbot added the to-announce Announce this issue on triage meeting label Apr 9, 2025
@apiraino apiraino removed the to-announce Announce this issue on triage meeting label Apr 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
major-change A proposal to make a major change to rustc T-compiler Add this label so rfcbot knows to poll the compiler team
Projects
None yet
Development

No branches or pull requests

3 participants