JAL-1854 Checkstyle updated to 8.12

[jalview.git] / utils / checkstyle / README.txt

diff --git a/utils/checkstyle/README.txt b/utils/checkstyle/README.txt
index e38064e..54f4e48 100644 (file)
--- a/utils/checkstyle/README.txt
+++ b/utils/checkstyle/README.txt
@@ -1,6 +1,8 @@
 Checkstyle for Jalview
 ----------------------
 
 Checkstyle for Jalview
 ----------------------
 

+See
+https://issues.jalview.org/browse/JAL-1854

 http://checkstyle.sourceforge.net/
 GNU LGPL
 
 http://checkstyle.sourceforge.net/
 GNU LGPL
 

@@ -9,8 +11,16 @@ To get the Eclipse Checkstyle plugin
        - Help | Eclipse Marketplace
        - search for checkstyle
        - install eclipse-cs checkstyle plugin
        - Help | Eclipse Marketplace
        - search for checkstyle
        - install eclipse-cs checkstyle plugin

-The current version is 6.19.1 (August 2016).

 
 

+Change Log
+----------
+See http://checkstyle.sourceforge.net/releasenotes.html
+Aug 2016       Initial version used is 6.19.1
+Dec 2018       Updated to 8.12.0 (latest on Eclipse Marketplace, 8.15 is latest release)
+                       SuppressionCommentFilter relocated (changed in 8.1)
+                       FileContentsHolder removed (changed in 8.2)
+                       Updates to import-control.xml for code changes (htsjdk, stackoverflowusers)
+                       

 Config
 ------
 
 Config
 ------
 

@@ -37,6 +47,7 @@ How to use checkstyle
        Option 2: on demand on selected code
                - right-click on a class or package and Checkstyle | Check code with checkstyle
                - (or Clear Checkstyle violations to remove checkstyle warnings)
        Option 2: on demand on selected code
                - right-click on a class or package and Checkstyle | Check code with checkstyle
                - (or Clear Checkstyle violations to remove checkstyle warnings)

+               - recommended to use this as a QA step when changing or reviewing code

 
 Checkstyle rules
 ----------------
 
 Checkstyle rules
 ----------------

@@ -64,11 +75,11 @@ Suppressing findings
 Tips
 ----
        Sometimes checkstyle needs a kick before it will refresh its findings.
 Tips
 ----
        Sometimes checkstyle needs a kick before it will refresh its findings.

-       A whitespace edit in checkstyle.xml usually does this. There may be better ways.
+       Click the 'refresh' icon at top right in Eclipse | Preferences | Checkstyle.

        
        Invalid configuration files may result in checkstyle failing with an error reported
        in the Eclipse log file. 
        
        Invalid configuration files may result in checkstyle failing with an error reported
        in the Eclipse log file. 

-       Help | Installation Details | Configuration takes you to a screen with a 
+       Eclipse | About | Installation Details | Configuration takes you to a screen with a 

        'View Error Log' button.
        
        Sometimes checkstyle can fail silently. Try 'touching' (editing) config files, failing
        'View Error Log' button.
        
        Sometimes checkstyle can fail silently. Try 'touching' (editing) config files, failing