Skip to content

Code Style

Jump to bottom
Josh Hadley edited this page Mar 3, 2021 · 3 revisions

C

  • C code should pass cpplint using the CPPLINT.cfg configuration file in the root of the AFDKO repo. cpplint will be run automatically when code is submitted to the repo, but we recommend checking locally first.

  • For integer variables, please use types with explicit bit widths (i.e. int8_t, int16_t, int32_t, int64_t, uint8_t, uint16_t, uint32_t, uint64_t).

  • For Boolean variables, please use the standard bool from stdbool.h for the type. For Boolean values, please use true and false instead of 1 and 0.

Python

  • All Python code (including test code) should pass flake8 using the .flake8 configuration file in the root of the AFDKO repo. flake8 will be run automatically when code is submitted, but we recommend checking locally first.

  • For Boolean values, please use True and False instead of 1 and 0.

Clone this wiki locally