diff options
| author | Nick Mathewson <nickm@torproject.org> | 2019-03-13 09:30:02 -0400 |
|---|---|---|
| committer | Nick Mathewson <nickm@torproject.org> | 2019-03-13 09:30:02 -0400 |
| commit | 17ff69a268f761d0d68bb1201a578555fe460fb8 (patch) | |
| tree | ec35b5a1325be6f7b586341158360c8579bc0684 /doc | |
| parent | 2b5cc8a059b30a47aab29d27b560ff50c741565b (diff) | |
| parent | 504aef6228d3a8460f43b9c9cf2cd4175ce4e1f7 (diff) | |
| download | tor-17ff69a268f761d0d68bb1201a578555fe460fb8.tar.gz tor-17ff69a268f761d0d68bb1201a578555fe460fb8.zip | |
Merge branch 'bug29221_more_squashed'
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.) |