1 # List of rationales for check suppressions (where known).
2 # This have to precede the list because inline comments are not
3 # supported by clang-tidy.
5 # -cppcoreguidelines-non-private-member-variables-in-classes,
6 # -misc-non-private-member-variables-in-classes,
7 # We intend a gradual transition to conform to this guideline, but it
8 # is not practical to implement yet.
10 # -readability-isolate-declaration,
11 # Declarations like "int a, b;" are readable. Some forms are not, and
12 # those might reasonably be suggested against during code review.
14 # -cppcoreguidelines-avoid-c-arrays,
15 # C arrays are still necessary in many places with legacy code
17 # -cppcoreguidelines-avoid-magic-numbers,
18 # -readability-magic-numbers,
19 # We have many legitimate use cases for magic numbers
21 # -cppcoreguidelines-macro-usage,
22 # We do use too many macros, and we should fix many of them, but there
23 # is no reasonable way to suppress the check e.g. in src/config.h and
24 # configuring the build is a major legitimate use of macros.
26 # -cppcoreguidelines-narrowing-conversions,
27 # -bugprone-narrowing-conversions
28 # We have many cases where int is converted to float and we don't care
29 # enough about such potential loss of precision to use explicit casts
30 # in large numbers of places.
32 # -google-readability-avoid-underscore-in-googletest-name
33 # We need to use underscores for readability for our legacy types
34 # and command-line parameter names
36 # -cppcoreguidelines-init-variables
37 # These shall be fixed eventually, but clang-tidy's automatic fix of
38 # initializing them with zeroes does not usually improve the code in
39 # a meaningful way, and fixing them all manually is cumbersome.
42 # We have way too many functions and methods relying on recursion
44 # -cppcoreguidelines-avoid-non-const-global-variables
45 # There are quite a lot of static variables in the test code that
46 # can not be replaced.
48 # -modernize-avoid-bind
49 # Some code needs to use std::bind and can't be modernized quickly.
50 Checks: clang-diagnostic-*,-clang-analyzer-*,-clang-analyzer-security.insecureAPI.strcpy,
51 bugprone-*,misc-*,readability-*,performance-*,mpi-*,
52 -readability-inconsistent-declaration-parameter-name,
53 -readability-function-size,-readability-else-after-return,
54 modernize-use-nullptr,modernize-use-emplace,
55 modernize-make-unique,modernize-make-shared,
57 modernize-use-override,
58 modernize-redundant-void-arg,modernize-use-bool-literals,
59 cppcoreguidelines-*,-cppcoreguidelines-pro-*,-cppcoreguidelines-owning-memory,
60 -cppcoreguidelines-no-malloc,-cppcoreguidelines-special-member-functions,
61 -cppcoreguidelines-avoid-goto,
62 google-*,-google-build-using-namespace,-google-explicit-constructor,
63 -google-readability-function-size,-google-readability-todo,-google-runtime-int,
64 -cppcoreguidelines-non-private-member-variables-in-classes,
65 -misc-non-private-member-variables-in-classes,
66 -readability-isolate-declaration,
67 -cppcoreguidelines-avoid-c-arrays,
68 -cppcoreguidelines-avoid-magic-numbers,
69 -readability-magic-numbers,
70 -cppcoreguidelines-macro-usage,
71 -cppcoreguidelines-narrowing-conversions,
72 -bugprone-narrowing-conversions,
73 -google-readability-avoid-underscore-in-googletest-name,
74 -cppcoreguidelines-init-variables,
76 -cppcoreguidelines-avoid-non-const-global-variables,
80 - key: cppcoreguidelines-special-member-functions.AllowSoleDefaultDtor
82 - key: modernize-make-unique.IncludeStyle
84 - key: modernize-make-shared.IncludeStyle
86 - key: readability-implicit-bool-conversion.AllowIntegerConditions
88 - key: readability-implicit-bool-conversion.AllowPointerConditions
90 - key: bugprone-dangling-handle.HandleClasses
91 value: std::basic_string_view; nonstd::sv_lite::basic_string_view
92 # Permit passing shard pointers by value for sink parameters
93 - key: performance-unnecessary-copy-initialization.AllowedTypes
95 - key: performance-unnecessary-value-param.AllowedTypes