From 9a5723f13d835019ea64a4fdc7bc30435f296e02 Mon Sep 17 00:00:00 2001 From: Mark Mansi Date: Tue, 5 Nov 2019 10:51:36 -0600 Subject: [PATCH] add guidelines for future-incompat lints --- src/diagnostics.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/diagnostics.md b/src/diagnostics.md index 62baa7b60..9cfd5a3e1 100644 --- a/src/diagnostics.md +++ b/src/diagnostics.md @@ -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