Skip to content
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

Force warnings on lints #434

Closed
1 of 3 tasks
Tracked by #85512
rylev opened this issue May 20, 2021 · 3 comments
Closed
1 of 3 tasks
Tracked by #85512

Force warnings on lints #434

rylev opened this issue May 20, 2021 · 3 comments
Labels
major-change A proposal to make a major change to rustc major-change-accepted A major change proposal that was accepted T-compiler Add this label so rfcbot knows to poll the compiler team

Comments

@rylev
Copy link
Member

rylev commented May 20, 2021

Proposal

Add mechanism for forcing lints to trigger.

Summary

  • Add a --force-warn XXX option that is given either a lint or lint group XXX
  • When this command line option is used, all other lint settings the lints covered by XXX will always issue warnings, regardless of whether they are "allowed" by the code or command-line options
  • This command line option is supplied by cargo fix --edition in order to force migration lints etc to be considered

Motivation

We would like to take some existing warnings and make them into errors in the new edition. We anticipate this being a common pattern. The problem is that these warnings, if they already exist, may be marked a #[allow] in various code bases. As a result, cargo fix would not see the migration suggestions and migration would not succeed.

Proposed plan

To become part of a migration, existing lints can be directly added into rust-2021-migration group.

Caveat: Multiple groups

There has been some concern about members of multiple groups.

This plan may mean that they are members of multiple groups. This is generally discouraged for reasons not clearly documented -- Niko's hypothesis is that the reason for this is that (e.g.) the code doesn't consider intersection between two groups, and hence #[allow(group1)] and #[warn(group2)] may result in either allow or warn for any common members, depending on the order in which those directives are processed. Perhaps others can confirm. This seems like an independent bug that should be fixed -- however, using this command line option, it is not a big probem because the members of rust-2021-migrations will be warn regardless of what other groups they may belong to.

There may be confusion in other parts of the code, such as diagnostics.

Also, we don't expect users to commonly add rust_2021_migrations.

This plan means that some lints are members of multiple groups. This has been discouraged but in the past but we currently believe that it should work fine. We should test the scenario where a lint is in two groups and one of those groups is allow.

Alternatives

We could instead introduce a fresh copy of these lints that is a member of rust_2021_migrations. For example, if there is a lint foo, maybe we make a foo_2021 lint that is specifically for the migration. We could perhaps make this convenient to issue in the code by having some option when creating the lint that is like .migration(RUST_2021_MIGRATioN). This could also make the lint into a hard error automatically in the new edition, regardless of the lint level.

Mentors or Reviewers

@nikomatsakis

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.

Comments

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.

@rylev rylev added T-compiler Add this label so rfcbot knows to poll the compiler team major-change A proposal to make a major change to rustc labels May 20, 2021
@rustbot
Copy link
Collaborator

rustbot commented May 20, 2021

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.

cc @rust-lang/compiler @rust-lang/compiler-contributors

@rustbot rustbot added the to-announce Announce this issue on triage meeting label May 20, 2021
@nikomatsakis
Copy link
Contributor

@rustbot second

We've already discussed this plan for some time with @ehuss and others so I'm going to go ahead and second =)

@rustbot rustbot added the final-comment-period The FCP has started, most (if not all) team members are in agreement label May 20, 2021
@apiraino apiraino removed the to-announce Announce this issue on triage meeting label May 27, 2021
@apiraino
Copy link
Contributor

apiraino commented Jun 3, 2021

@rustbot label -final-comment-period +major-change-accepted

@apiraino apiraino closed this as completed Jun 3, 2021
@rustbot rustbot added major-change-accepted A major change proposal that was accepted to-announce Announce this issue on triage meeting and removed final-comment-period The FCP has started, most (if not all) team members are in agreement labels Jun 3, 2021
@apiraino apiraino removed the to-announce Announce this issue on triage meeting label Jun 4, 2021
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 major-change-accepted A major change proposal that was accepted T-compiler Add this label so rfcbot knows to poll the compiler team
Projects
None yet
Development

No branches or pull requests

4 participants