check-code: explain what to do when a check-code rule mismatches
authorSimon Heimberg <simohe@besonet.ch>
Tue, 07 Jan 2014 22:29:44 +0100
changeset 20241 8071b4eddefa
parent 20240 60c4d76b79b5
child 20242 2dad90bdf29d
check-code: explain what to do when a check-code rule mismatches In the past several approaches were used when a check-code rule triggered without a good reason. Not all of them looked nice, some were even wrong. Suggest some good practices which should be used instead.
contrib/check-code.py
--- a/contrib/check-code.py	Tue Jan 07 22:29:39 2014 +0100
+++ b/contrib/check-code.py	Tue Jan 07 22:29:44 2014 +0100
@@ -7,6 +7,18 @@
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
+"""style and portability checker for Mercurial
+
+when a rule triggers wrong, do one of the following (prefer one from top):
+ * do the work-around the rule suggests
+ * doublecheck that it is a false match
+ * improve the rule pattern
+ * add an ignore pattern to the rule (3rd arg) which matches your good line
+   (you can append a short comment and match this, like: #re-raises, # no-py24)
+ * change the pattern to a warning and list the exception in test-check-code-hg
+ * ONLY use no--check-code for skipping entire files from external sources
+"""
+
 import re, glob, os, sys
 import keyword
 import optparse