moparisthebest/curl
1
0
Fork 0
mirror of https://github.com/moparisthebest/curl synced 2024-12-22 08:08:50 -05:00
Code Issues Releases Wiki Activity

CHECKSRC.md: clarified, explained the whitelist file

Browse Source
This commit is contained in:
Daniel Stenberg 2016-05-02 11:18:59 +02:00
parent 1135340214
commit acc2aeb407
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/CHECKSRC.md
View File

@ -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.