diff --git a/docs/analyzer/checker_and_analyzer_configuration.md b/docs/analyzer/checker_and_analyzer_configuration.md index 8e707c2cf2..637d513660 100644 --- a/docs/analyzer/checker_and_analyzer_configuration.md +++ b/docs/analyzer/checker_and_analyzer_configuration.md @@ -9,7 +9,7 @@ all checkers. Listing the available configuration options: `CodeChecker analyzers --analyzer-config clangsa --details` -Setting analyzer configuration opions: +Setting analyzer configuration options: `CodeChecker analyze --analyzer-config ` You can find a comprehensive list of analyzer configuration options at the @@ -201,14 +201,14 @@ As of CodeChecker 6.20, Codechecker can now execute the Cppcheck analyzer. ## Analyzer Configuration -The Cppcheck analyzer can be configured with --analyzer-config cppcheck:* paramterers. +The Cppcheck analyzer can be configured with --analyzer-config cppcheck:* parameters. The supported analyzer configuration items can be listed with `CodeChecker analyzers --analyzer-config cppcheck --details` As of CodeChecker 6.20, the following options are supported: * `cppcheck:addons` A list of Cppcheck addon files. -* `cppcheck:libraries` A list of Cppcheck library definiton files. +* `cppcheck:libraries` A list of Cppcheck library definition files. * `cppcheck:platform` The platform configuration .xml file. * `cppcheck:inconclusive` Enable inconclusive reports. diff --git a/docs/analyzer/false_positives.md b/docs/analyzer/false_positives.md index 6c16fb5db3..baa60600e1 100644 --- a/docs/analyzer/false_positives.md +++ b/docs/analyzer/false_positives.md @@ -12,7 +12,7 @@ properties of the code. Suppressing a result will not help its understanding. Making the code more obvious for the tool, however, makes the analysis more precise. As a bonus, such code is sometimes also more readable for developers. -This guide introduces tips and tricks how to make the code easier to analyze. +This guide introduces tips and tricks on how to make the code easier to analyze. Table of Contents ================= @@ -157,7 +157,7 @@ lack of context or the code being too complex to the analyzer. This might result in false positives like uninitialized variables or division by zero. -Let us look at the the following example: +Let us look at the following example: ```cpp int avg(List *l) { @@ -290,7 +290,7 @@ static void f(void) { } ``` -Tha analyzer might not be able to tell that the value of `allc` is always +The analyzer might not be able to tell that the value of `allc` is always the same as the length of the array `allv`. Rewriting the code and marking `allc` `const` will solve this issue. @@ -481,7 +481,7 @@ double f(int i) { The second version makes it clear even though the return value is a floating point value the loss of precision during integer division is intentional. Adding a comment why this is intentional would make this even clearer. -Such edits makes the code easier to understand for fellow developers. +Such edits make the code easier to understand for fellow developers. # Suppress or skip results diff --git a/docs/analyzer/gcc_incompatibilities.md b/docs/analyzer/gcc_incompatibilities.md index de0ba1d1d8..61a7849bc0 100644 --- a/docs/analyzer/gcc_incompatibilities.md +++ b/docs/analyzer/gcc_incompatibilities.md @@ -48,12 +48,12 @@ even if it is built with GCC and configured to use GCC's libstdc++ (https://bugs.launchpad.net/ubuntu/+source/llvm-toolchain-3.8/+bug/1573778). The practical difficulty in CodeChecker is that we're appending the implicit -include paths of the compiler which is used during the comiplation of the -analyzed project in the logging phase. The reason of this is that we'd like to +include paths of the compiler which is used during the compilation of the +analyzed project in the logging phase. The reason for this is that we'd like to see the same build environment during the analysis. However, Clang also has its own implicit include paths. These are almost the same of GCC's paths except for `include-fixed` directories because these are GCC specific. Unfortunately some -projects require the additiion of these paths but some do not. So +projects require the addition of these paths but some do not. So `--keep-gcc-include-fixed` flag can control whether we should keep these during the analysis. There is another unanswered question: currently the GCC implicit include paths are added with `-isystem` flag. This appends the paths _before_ @@ -195,7 +195,7 @@ compilation error if vector instructions are used as well. Part of the GCC Quad-Precision Math Library Application Programming Interface (API). - All math functions in this lib (acosq, asinq) uses the type `__float128`. + All math functions in this lib (acosq, asinq) use the type `__float128`. We can use the library with Clang by adding gcc's intrinsic system include, for instance: ```