JAL-1854 tweaks to rules and README

diff --git a/utils/checkstyle/README.txt b/utils/checkstyle/README.txt
index 119c68e..e38064e 100644 (file)
--- a/utils/checkstyle/README.txt
+++ b/utils/checkstyle/README.txt
@@ -79,4 +79,7 @@ Tips
        If a rule doesn't behave as you expected, read its documentation carefully, including
        the use and default value of any properties.
        
-       To highlight a single rule's findings, you could temporarily raise its severity to error.
+       To highlight a single rule's findings, you can 'Configure Contents' of the Problems view
+       and filter on Text Contains <rule name> (case-sensitive). 
+       Here you should select 'Use item limits' with a value of, say, 500,     or Eclipse may 
+       labour to display all warnings.

diff --git a/utils/checkstyle/checkstyle.xml b/utils/checkstyle/checkstyle.xml
index 7ca2d26..8a5f14f 100644 (file)
--- a/utils/checkstyle/checkstyle.xml
+++ b/utils/checkstyle/checkstyle.xml
@@ -27,14 +27,6 @@
                <property name="checkFormat" value="$1"/>
        </module>
 
-       <!--
-               Maximum line count for source files
-       -->
-       <module name="FileLength">
-               <property name="max" value="1200"/>
-               <property name="fileExtensions" value="java"/>
-       </module>
-
        <!-- 
                Check language bundles have the same keys and no duplicates
                (ensure Checkstyle is configured to scan non-source files)
@@ -47,6 +39,15 @@
            <property name="fileExtensions" value="properties" />
                <property name="severity" value="error"/>
        </module>
+
+       <!--
+               Maximum line count for source files
+               (note this can't be inside TreeWalker)
+       -->
+       <module name="FileLength">
+               <property name="max" value="1200"/>
+               <property name="fileExtensions" value="java"/>
+       </module>
        
        <module name="TreeWalker">
 
@@ -429,12 +430,20 @@
                <module name="HiddenField"/> 
 
                <!-- 
-                       Check that proper logging is used and never printing to System.out.
+                       Check that proper logging is used.
                        This may be suppressed in the class that provides logging functions.
                -->
                <module name="RegexpSinglelineJava">
+                       <property name="id" value="NoSysout" />
                        <property name="format" value="System\.out\.println"/>
                        <property name="ignoreComments" value="true"/>
+                       <message key="regexp.exceeded" value="Should use jalview.bin.Cache.log for logging"/>
+               </module>
+               <module name="RegexpSinglelineJava">
+                       <property name="id" value="NoSyserr" />
+                       <property name="format" value="System\.err\.println"/>
+                       <property name="ignoreComments" value="true"/>
+                       <message key="regexp.exceeded" value="Should use jalview.bin.Cache.log for logging"/>
                </module>
 
                <!--