7 | | This list is, by definition, incomplete. Even if you comply with all the below rules does not mean nobody will comment on your C style. Do try to emulate the style of existing/surrounding code. |
| 7 | This document is, by definition, incomplete. Even if you comply with all the below rules does not mean nobody will comment on your C style. Do try to emulate the style of existing/surrounding code. |
| 8 | |
| 9 | === Tool support === |
| 10 | |
| 11 | HelenOS uses the Ccheck tool (https://github.com/jxsvoboda/sycek) to find coding style issues. To run ccheck type {{{make ccheck}}}. To let ccheck try and fix issues, type {{{make ccheck-fix}}}. Ccheck is also run as part of {{{make check}}} and as part of Travis CI on any commit pushed to HelenOS git repo on Github or to any pull request. |
| 12 | |
| 13 | Ccheck can verify compliance with many (but not all) code style rules. Passing ccheck is a minimum requirement if a contribution is to be considered compliant with HelenOS coding standards. |