X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=utils%2Fcheckstyle%2FREADME.txt;fp=resources%2Fcheckstyle%2FREADME.txt;h=119c68e4e2c18d741a91e8830c64e32216d7673d;hb=78d4775e4450ba6579c5d9824a78ad99cbccda22;hp=1c2aced59c47ee9b025663b911498184117a3048;hpb=ae707520df1c029de552b137b1b4e420a23cadaa;p=jalview.git

diff --git a/resources/checkstyle/README.txt b/utils/checkstyle/README.txt
similarity index 90%
rename from resources/checkstyle/README.txt
rename to utils/checkstyle/README.txt
index 1c2aced..119c68e 100644
--- a/resources/checkstyle/README.txt
+++ b/utils/checkstyle/README.txt
@@ -18,7 +18,7 @@ Config
 	This includes confining its scope to src/*.java and resources/*.properties.
 	This can be modified interactively through the checkstyle properties editor.
 	
-	Checkstyle config files in resources/checkstyle:
+	Checkstyle config files in utils/checkstyle:
 		checkstyle.xml          : main configuration file with selected checkstyle modules
 		checkstyle-suppress.xml : rules to exclude certain checks / files
 		import-control.xml      : package import rules
@@ -36,6 +36,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)
 
 Checkstyle rules
 ----------------
@@ -49,13 +50,13 @@ Checkstyle rules
 	
 Suppressing findings
 --------------------
-	If there are warnings you judge it ok to suppress, your options are
-	(from most global to most local scope):
+	If there are warnings you judge it ok to suppress (false positives), 
+	your options are (from most global to most local impact):
 	- remove the rule entirely
 	- adjust its properties
 	- add an entry in checkstyle-suppress.xml to skip the file for the rule
 	- add comments around the reported source lines
-		// CHECKSTYLE.OFF: RuleName
+		// CHECKSTYLE.OFF: RuleName 'a comment to justify suppression'
 		source code here
 		// CHECKSTYLE.ON: RuleName
 	The suppression should be as localised as possible, to avoid false negatives.