summaryrefslogtreecommitdiff
path: root/docs/CHECKSRC.md
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2016-05-02 11:18:59 +0200
committerDaniel Stenberg <daniel@haxx.se>2016-05-02 11:18:59 +0200
commitacc2aeb40754713b8b00fd84d000c2730d0131db (patch)
tree848be047d2cb82fa3b50b363bb1e19718f2156fd /docs/CHECKSRC.md
parent1135340214ed786385c9902142593efd4d1fb449 (diff)
downloadcurl-acc2aeb40754713b8b00fd84d000c2730d0131db.tar.gz
CHECKSRC.md: clarified, explained the whitelist file
Diffstat (limited to 'docs/CHECKSRC.md')
-rw-r--r--docs/CHECKSRC.md16
1 files changed, 9 insertions, 7 deletions
diff --git a/docs/CHECKSRC.md b/docs/CHECKSRC.md
index f30681b75..591e066f6 100644
--- a/docs/CHECKSRC.md
+++ b/docs/CHECKSRC.md
@@ -18,11 +18,11 @@ when, for example, one of the files is generated.
## What does checksrc warn for?
-checksrc does check and verify the entire style guide, but the script is an
-effort to detect the most common mistakes and syntax mistakes that
-contributers make before they get accustomed to our code style. Heck, many of
-us regulars do the mistakes too and this script helps us keep the code in
-shape.
+checksrc does not check and verify the code against the entire style guide,
+but the script is instead an effort to detect the most common mistakes and
+syntax mistakes that contributers make before they get accustomed to our code
+style. Heck, many of us regulars do the mistakes too and this script helps us
+keep the code in shape.
checksrc.pl -h
@@ -117,6 +117,8 @@ instances are ignored and nothing extra.
### Directory wide ignore patterns
-`checksrc.whitelist` describe!
-
+This is a method we've transitioned away from. Use inline ignores as far as
+possible.
+Make a `checksrc.whitelist` file in the directory of the source code with the
+false positive, and include the full offending line into this file.