xref: /openbmc/docs/style/cpp/.clang-tidy (revision 12cf111b6a041843bc3a2ba04696471d4301bbb7) 
1Checks: '
2    -*,
3    bugprone-unchecked-optional-access,
4    modernize-use-nullptr,
5    readability-function-size,
6    readability-function-cognitive-complexity
7'
8CheckOptions:
9  - { key: readability-function-size.LineThreshold,             value: 60 } # [1]
10  - { key: readability-function-size.ParameterThreshold,        value: 6 }  # [2]
11  - { key: readability-function-cognitive-complexity.Threshold, value: 25 } # [3]
12
13WarningsAsErrors: '*'
14HeaderFilterRegex: '(?!^subprojects).*'
15
16# [1] https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#f3-keep-functions-short-and-simple
17# [2] https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#f2-a-function-should-perform-a-single-logical-operation
18# [3] https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#f3-keep-functions-short-and-simple
19# However cognitive complexity != cyclomatic complexity. Therefore using the clang-tidy default value,
20# as cyclomatic complexity seems to not be implemented in clang-tidy.
21
22# [1],[2],[3] do not have to be enforced or applied project-wide yet.
23