X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=utils%2Fcheckstyle%2FREADME.txt;h=54f4e48eef1be77bcaec3738399ba5683793588c;hb=3975a73e927fe1adb8f3411f22c10a3e5e74ec73;hp=119c68e4e2c18d741a91e8830c64e32216d7673d;hpb=78d4775e4450ba6579c5d9824a78ad99cbccda22;p=jalview.git

diff --git a/utils/checkstyle/README.txt b/utils/checkstyle/README.txt
index 119c68e..54f4e48 100644
--- a/utils/checkstyle/README.txt
+++ b/utils/checkstyle/README.txt
@@ -1,6 +1,8 @@
 Checkstyle for Jalview
 ----------------------
 
+See
+https://issues.jalview.org/browse/JAL-1854
 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
-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
 ------
 
@@ -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)
+		- recommended to use this as a QA step when changing or reviewing code
 
 Checkstyle rules
 ----------------
@@ -64,11 +75,11 @@ Suppressing 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. 
-	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
@@ -79,4 +90,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.