add guidelines for future-incompat lints

This commit is contained in:
Mark Mansi 2019-11-05 10:51:36 -06:00 committed by Who? Me?!
parent 27f0854e6c
commit 2dabf0f58d
1 changed files with 9 additions and 0 deletions

View File

@ -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