From fe67169dff6a0b6d8a07f20affa1ddb13751ca8f Mon Sep 17 00:00:00 2001 From: "Felix S. Klock II" Date: Fri, 8 Mar 2019 16:57:16 +0100 Subject: [PATCH 1/2] Amend the template from text of RFC 1589 to match current actual practice of future-compatibility lints. --- text/1589-rustc-bug-fix-procedure.md | 52 ++++++++++++++++------------ 1 file changed, 29 insertions(+), 23 deletions(-) diff --git a/text/1589-rustc-bug-fix-procedure.md b/text/1589-rustc-bug-fix-procedure.md index acdc481015e..f9b1a7166bc 100644 --- a/text/1589-rustc-bug-fix-procedure.md +++ b/text/1589-rustc-bug-fix-procedure.md @@ -98,29 +98,31 @@ What follows is a template for tracking issues. --------------------------------------------------------------------------- -This is the **summary issue** for the `YOUR_LINT_NAME_HERE` -future-compatibility warning and other related errors. The goal of -this page is describe why this change was made and how you can fix -code that is affected by it. It also provides a place to ask questions -or register a complaint if you feel the change should not be made. For -more information on the policy around future-compatibility warnings, -see our [breaking change policy guidelines][guidelines]. - -[guidelines]: LINK_TO_THIS_RFC - -#### What is the warning for? - -*Describe the conditions that trigger the warning and how they can be -fixed. Also explain why the change was made.** - -#### When will this warning become a hard error? - -At the beginning of each 6-week release cycle, the Rust compiler team -will review the set of outstanding future compatibility warnings and -nominate some of them for **Final Comment Period**. Toward the end of -the cycle, we will review any comments and make a final determination -whether to convert the warning into a hard error or remove it -entirely. +#### What is this lint about + +*Describe here what kinds of Rust code will cause the lint to trigger.* + +*Motivational text or historical information is also of use, but the +most important thing is to explain what kind of code the lint is +detecting.* + +*You may wish to include a link to this RFC as part of explaining the +lint in some manner, for example:* + +For more information on the policy around future-compatibility +warnings, see our [breaking change policy guidelines][RFC 1589]. + +[RFC 1589]: https://github.com/rust-lang/rfcs/blob/master/text/1589-rustc-bug-fix-procedure.md + +#### How to fix this warning/error + +*Explain here what the developer needs to do to address the warning.* + +#### Current status + +- [ ] PR ? introduces the `YOUR_LINT_NAME_HERE` lint as warn-by-default +- [ ] PR ? makes the `YOUR_LINT_NAME_HERE` lint deny-by-default +- [ ] PR ? makes the `YOUR_LINT_NAE_HERE` lint a hard error --------------------------------------------------------------------------- @@ -278,6 +280,10 @@ policy and not making any sort of breaking change at all: N/A +# Amendments + +* Amended template to match current practice. + [RFC 1122]: https://github.com/rust-lang/rfcs/blob/master/text/1122-language-semver.md From fcf178154e0dd07081889fb1a779a26d271279f6 Mon Sep 17 00:00:00 2001 From: "Felix S. Klock II" Date: Mon, 11 Mar 2019 11:57:26 +0100 Subject: [PATCH 2/2] Address review feedback by putting back the initial paragraph of template. Since that initial paragraph includes the link to RFC 1589, I removed the suggestion (that I added) to include the link from the "What is this lint about" section. --- text/1589-rustc-bug-fix-procedure.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/text/1589-rustc-bug-fix-procedure.md b/text/1589-rustc-bug-fix-procedure.md index f9b1a7166bc..80521ce4b41 100644 --- a/text/1589-rustc-bug-fix-procedure.md +++ b/text/1589-rustc-bug-fix-procedure.md @@ -98,6 +98,16 @@ What follows is a template for tracking issues. --------------------------------------------------------------------------- +This is the **summary issue** for the `YOUR_LINT_NAME_HERE` +future-compatibility warning and other related errors. The goal of +this page is describe why this change was made and how you can fix +code that is affected by it. It also provides a place to ask questions +or register a complaint if you feel the change should not be made. For +more information on the policy around future-compatibility warnings, +see our [breaking change policy guidelines][RFC 1589]. + +[RFC 1589]: https://github.com/rust-lang/rfcs/blob/master/text/1589-rustc-bug-fix-procedure.md + #### What is this lint about *Describe here what kinds of Rust code will cause the lint to trigger.* @@ -106,14 +116,6 @@ What follows is a template for tracking issues. most important thing is to explain what kind of code the lint is detecting.* -*You may wish to include a link to this RFC as part of explaining the -lint in some manner, for example:* - -For more information on the policy around future-compatibility -warnings, see our [breaking change policy guidelines][RFC 1589]. - -[RFC 1589]: https://github.com/rust-lang/rfcs/blob/master/text/1589-rustc-bug-fix-procedure.md - #### How to fix this warning/error *Explain here what the developer needs to do to address the warning.*