Fork us on GitHub Follow us on Google+ Follow us on Facebook Follow us on Twitter

Changes between Version 10 and Version 11 of CStyle


Ignore:
Timestamp:
2018-04-16T12:17:37Z (11 months ago)
Author:
Jiri Svoboda
Comment:

Ccheck

Legend:

Unmodified
Added
Removed
Modified
  • CStyle

    v10 v11  
    55Any source contribution to HelenOS must follow the C style rules described below. Even if you are working on a school assignment, we kindly ask you follow our coding style up front. It's a colossal waste of our resources having to update the coding style in order to merge your changes to our mainline.
    66
    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.
     7This 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
     11HelenOS 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
     13Ccheck 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.
    814
    915=== Source file encoding ===