diff options
| author | Nick Mathewson <nickm@torproject.org> | 2019-03-12 09:32:22 -0400 |
|---|---|---|
| committer | Nick Mathewson <nickm@torproject.org> | 2019-03-13 09:27:29 -0400 |
| commit | e2512950b69d5f9f030673a15e8cf72b930538c7 (patch) | |
| tree | 5ef0933271748bc3fd5c477de5912f14cfff1348 /doc | |
| parent | f0302d51abf2f4c6d7660b82ad5038d1cbf9e5d7 (diff) | |
| download | tor-e2512950b69d5f9f030673a15e8cf72b930538c7.tar.gz tor-e2512950b69d5f9f030673a15e8cf72b930538c7.zip | |
Improve failure message from check-best-practices
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/HACKING/HelpfulTools.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/HACKING/HelpfulTools.md b/doc/HACKING/HelpfulTools.md index d499238526..cba57e875d 100644 --- a/doc/HACKING/HelpfulTools.md +++ b/doc/HACKING/HelpfulTools.md @@ -371,3 +371,18 @@ source code. Here's how to use it: 6. See the Doxygen manual for more information; this summary just scratches the surface. + +Style and best-pratices checking +-------------------------------- + +We use scripts to check for various problems in the formatting and style +of our source code. The "check-spaces" test detects a bunch of violations +of our coding style on the local level. The "check-best-practices" test +looks for violations of some of our complexity guidelines. + +You can tell the tool about exceptions to the complexity guidelines via its +exceptions file (scripts/maint/practracker/exceptions.txt). But before you +do this, consider whether you shouldn't fix the underlying problem. Maybe +that file really _is_ too big. Maybe that function really _is_ doing too +much. (On the other hand, for stable release series, it is sometimes better +to leave things unrefactored.) |