sylvestre.ledru created this revision.
sylvestre.ledru added reviewers: dkrupp, aaron.ballman.
Herald added subscribers: rnkovacs, whisperity.
Herald added a project: clang.
I took the text from codechecker. Daniel Krupp ( @dkrupp ) wrote it.
Repository:
rG LLVM Github Monorepo
https://reviews.llvm.org/D71963
Files:
clang-tools-extra/docs/clang-tidy/checks/list.rst
Index: clang-tools-extra/docs/clang-tidy/checks/list.rst
===================================================================
--- clang-tools-extra/docs/clang-tidy/checks/list.rst
+++ clang-tools-extra/docs/clang-tidy/checks/list.rst
@@ -403,6 +403,26 @@
`hicpp-use-override <hicpp-use-override.html>`_, `modernize-use-override
<modernize-use-override.html>`_, "Yes", "low"
`hicpp-vararg <hicpp-vararg.html>`_, `cppcoreguidelines-pro-type-vararg
<cppcoreguidelines-pro-type-vararg.html>`_, , "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:
Index: clang-tools-extra/docs/clang-tidy/checks/list.rst
===================================================================
--- clang-tools-extra/docs/clang-tidy/checks/list.rst
+++ clang-tools-extra/docs/clang-tidy/checks/list.rst
@@ -403,6 +403,26 @@
`hicpp-use-override <hicpp-use-override.html>`_, `modernize-use-override <modernize-use-override.html>`_, "Yes", "low"
`hicpp-vararg <hicpp-vararg.html>`_, `cppcoreguidelines-pro-type-vararg <cppcoreguidelines-pro-type-vararg.html>`_, , "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:
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
