Comment (only) in controller:checkstyle to document next steps

[controller.git] / opendaylight / commons / checkstyle / src / main / resources / controller / checkstyle.xml

diff --git a/opendaylight/commons/checkstyle/src/main/resources/controller/checkstyle.xml b/opendaylight/commons/checkstyle/src/main/resources/controller/checkstyle.xml
index 78c38f567848748f37ad8246d2e7f6805b4b10e1..0c3699dca22e0451cb3f6be38101dbaf94acc529 100644 (file)
--- a/opendaylight/commons/checkstyle/src/main/resources/controller/checkstyle.xml
+++ b/opendaylight/commons/checkstyle/src/main/resources/controller/checkstyle.xml
@@ -2,8 +2,28 @@
 <!DOCTYPE module PUBLIC
     "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
     "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
-
 <module name="Checker">
+
+<!--
+     ======================================================================
+        Please do not add new Checkstyle check modules here anymore:
+
+        1. https://git.opendaylight.org/gerrit/#/c/39797/ has aligned
+        odl-parent's common Checkstyle rule set to include these.
+
+        2. As a next step, perhaps you would like to accept odl-parent's
+        Checkstyle definition as errors instead of warnings for Controller?
+        This is possible via violationSeverity=error as documented on
+        https://wiki.opendaylight.org/view/BestPractices/Coding_Guidelines#Checkstyle
+
+        Please contact odlparent-dev@lists.opendaylight.org if you feel
+        a Checkstyle rule is too strict in general and should be reviewed.
+
+        3. Ultimately this entire project (org.opendaylight.controller:checkstyle)
+        should then be deleted, and dependencies to it removed.
+     ======================================================================
+ -->
+
     <module name="FileTabCharacter">
         <property name="eachLine" value="true"/>
     </module>