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 2b7462ac681665e5714fd5550ea1c6c7fe56e7da..0c3699dca22e0451cb3f6be38101dbaf94acc529 100644 (file)
--- a/opendaylight/commons/checkstyle/src/main/resources/controller/checkstyle.xml
+++ b/opendaylight/commons/checkstyle/src/main/resources/controller/checkstyle.xml
@@ -1,25 +1,45 @@
-<?xml version="1.0"?>\r
-<!DOCTYPE module PUBLIC\r
-    "-//Puppy Crawl//DTD Check Configuration 1.2//EN"\r
-    "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">\r
-\r
-<module name="Checker">\r
-    <module name="FileTabCharacter">\r
-        <property name="eachLine" value="true"/>\r
-    </module>\r
-\r
-    <module name="RegexpSingleline">\r
-        <!-- \s matches whitespace character, $ matches end of line. -->\r
-        <property name="format" value="\s+$"/>\r
-        <property name="message" value="Line has trailing spaces."/>\r
-    </module>\r
-    <module name="TreeWalker">\r
-       <module name="RedundantImport"/>\r
-       <module name="UnusedImports"/>\r
-       <module name="AvoidStarImport"/>\r
-       <module name="UpperEll"/>\r
-       <module name="EmptyStatement"/>\r
-       <module name="EqualsHashCode"/>\r
-    </module>\r
-\r
-</module>\r
+<?xml version="1.0"?>
+<!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>
+
+    <module name="RegexpSingleline">
+        <!-- \s matches whitespace character, $ matches end of line. -->
+        <property name="format" value="\s+$"/>
+        <property name="message" value="Line has trailing spaces."/>
+    </module>
+    <module name="TreeWalker">
+       <module name="RedundantImport"/>
+       <module name="UnusedImports"/>
+       <module name="AvoidStarImport"/>
+       <module name="UpperEll"/>
+       <module name="EmptyStatement"/>
+       <module name="EqualsHashCode"/>
+    </module>
+
+</module>