Skip to content

Commit

Permalink
add guidelines for future-incompat lints
Browse files Browse the repository at this point in the history
  • Loading branch information
mark-i-m committed Nov 5, 2019
1 parent d3bfd4a commit dcd2b0c
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions src/diagnostics.md
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,15 @@ If you need a combination of options that's not supported by the
`declare_lint!` macro, you can always define your own static with a type of
`&Lint` but this is currently linted against in the compiler tree.

#### Guidelines for creating a future incompatibility lint

- Create a lint defaulting to warn as normal, with ideally the same error
message you would normally give.
- Add a suitable reference, typically an RFC or tracking issue. Go ahead
and include the full URL, sort items in ascending order of issue numbers.
- Later, change lint to error.
- Eventually, remove lint.

### Lint Groups

Lints can be turned on in groups. These groups are declared in the
Expand Down

0 comments on commit dcd2b0c

Please sign in to comment.