diff --git a/clang-tools-extra/docs/clang-tidy/checks/list.rst b/clang-tools-extra/docs/clang-tidy/checks/list.rst --- a/clang-tools-extra/docs/clang-tidy/checks/list.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/list.rst @@ -403,6 +403,26 @@ `hicpp-use-override `_, `modernize-use-override `_, "Yes", "low" `hicpp-vararg `_, `cppcoreguidelines-pro-type-vararg `_, , "low" +Severities +---------- + +.. Severities description are coming from Codechecker too: + https://github.com/Ericsson/codechecker/blob/master/config/config.md + +The following severity levels are defined: + +- **STYLE**: A true positive indicates that the source code is against a specific coding guideline or could improve readability. + Example: LLVM Coding Guideline: Do not use else or else if after something that interrupts control flow (break, return, throw, continue). + +- **LOW**: A true positive indicates that the source code is hard to read/understand or could be easily optimized. + Example: Unused variables, Dead code. + +- **MEDIUM**: A true positive indicates that the source code that may not cause a run-time error (yet), but against intuition and hence prone to error. + Example: Redundant expression in a condition. + +- **HIGH**: A true positive indicates that the source code will cause a run-time error. + Example of this category: out of bounds array access, division by zero, memory leak. + .. toctree:: :glob: :hidden: