2121### Initial Plugin Configuration
2222
23231 . Install the [ ` cppcheck ` ] ( http://cppcheck.sourceforge.net/ ) tool using the instructions on its homepage. This plugin
24- does ** not** bundle the ` cppcheck ` tool itself, which must be installed separately.
24+ does ** not** bundle the Cppcheck tool itself, which must be installed separately.
25252 . Install the [ cppcheck plugin] [ cppcheck_plugin ] into CLion.
26- 3 . Configure the plugin with the ** absolute** path to the ` cppcheck ` executable into the ` cppcheck path ` option.
26+ 3 . Configure the plugin with the ** absolute** path to the Cppcheck executable into the ` cppcheck path ` option.
2727 1 . Windows
2828 1 . File | Settings | Cppcheck configuration
2929 2 . Usually the path is ` C:\Program Files (x86)\Cppcheck\cppcheck.exe `
3030 2 . macOS:
3131 1 . CLion | Preferences | Cppcheck configuration
32- 2 . In a terminal run ` which cppcheck ` to find the path to ` cppcheck ` . If you installed it with
32+ 2 . In a terminal run ` which cppcheck ` to find the path to Cppcheck . If you installed it with
3333 [ Homebrew] ( https://brew.sh/ ) , the path will be ` /usr/local/bin/cppcheck ` .
3434 3 . Linux
3535 1 . File | Settings | Cppcheck configuration
36- 2 . In a terminal run ` which cppcheck ` to find the path to ` cppcheck ` . If you installed it with your
36+ 2 . In a terminal run ` which cppcheck ` to find the path to Cppcheck . If you installed it with your
3737 system's package manager, it is probably located at ` /usr/bin/cppcheck ` .
3838
3939[ cppcheck_plugin ] : https://plugins.jetbrains.com/plugin/8143
@@ -50,10 +50,10 @@ See https://github.com/johnthagen/clion-cppcheck/issues for a complete list of t
5050
5151### Analyzing header files
5252
53- ` cppcheck ` is not designed to be run on header files (` .h ` ) directly, as must be done for this
53+ Cppcheck is not designed to be run on header files (` .h ` ) directly, as must be done for this
5454plugin, and as a result may have false positives.
5555
56- When run on header files directly, ` cppcheck ` defaults to C as the language, which will generate
56+ When run on header files directly, Cppcheck defaults to C as the language, which will generate
5757false positives for C++ projects. So ` --language=c++ ` is implicitly added as option when analyzing header files.
5858
5959It will also provide ` unusedFunction ` and ` unusedStructMember ` false positives so these findings are being suppressed.
@@ -64,7 +64,7 @@ https://github.com/johnthagen/clion-cppcheck/issues/52
6464
6565### Analyzing multiple configurations
6666
67- By default ` cppcheck ` tries to determine all the available configurations for a file (i.e. all combination of the used
67+ By default Cppcheck tries to determine all the available configurations for a file (i.e. all combination of the used
6868preprocessor defines). As the plugin doesn't get the current list of defines this may lead to findings shown in code
6969which is shown as disabled in the editor. To check just a specific configuration you can either add defines using ` -D `
7070to the options. Or you can limit the configurations to a single one adding ` --max-configs=1 ` .
@@ -80,7 +80,7 @@ https://github.com/johnthagen/clion-cppcheck/issues/52
8080
8181### Multiple include paths
8282
83- No additional includes path are being passed to ` cppcheck ` for the analysis which might result in false positives or not
83+ No additional includes path are being passed to Cppcheck for the analysis which might result in false positives or not
8484all findings being shown.
8585
8686You can add additional include path using the ` -I <path> ` options.
@@ -91,8 +91,8 @@ https://github.com/johnthagen/clion-cppcheck/issues/55
9191
9292### Batch analysis
9393
94- The batch analysis passes the files individually to ` cppcheck ` just like the highlighting inspections. So if you pass a
95- folder to the batch analysis it might not show the same findings as when passing a folder to ` cppcheck ` itself.
94+ The batch analysis passes the files individually to Cppcheck just like the highlighting inspections. So if you pass a
95+ folder to the batch analysis it might not show the same findings as when passing a folder to ` Cppcheck ` itself.
9696
9797It will also pass all the contents of the folder to the analysis and not just project files. This might lead to
9898unexpected findings.
@@ -112,10 +112,10 @@ https://github.com/johnthagen/clion-cppcheck/issues/53
112112
113113### External libraries / System includes
114114
115- ` cppcheck ` does not support analyzing of external library or system includes. It provides profiles for several external
115+ Cppcheck does not support analyzing of external library or system includes. It provides profiles for several external
116116libraries which describe the contents and behavior of the includes which allows it to finding issues with usage of them
117117in the code. To add such a profile to your analysis you need to specify it via the ` --library=<name> ` option. The
118- available profile can be found in the ` cfg ` folder of your ` cppcheck ` installation.
118+ available profile can be found in the ` cfg ` folder of your ` Cppcheck ` installation.
119119
120120### Global options
121121
@@ -192,7 +192,7 @@ Support Cppcheck >1.89. (Contribution by @SJ-Innovation)
192192
193193### 1.2.0 - 2018-04-11
194194
195- Greatly improve plugin responsiveness to changes by using virtual files to interact with ` cppcheck ` .
195+ Greatly improve plugin responsiveness to changes by using virtual files to interact with Cppcheck .
196196(Contribution by @fastasturtle )
197197
198198### 1.1.0 - 2018-04-02
@@ -238,7 +238,7 @@ Fix execution on Linux.
238238
239239### 1.0.1 - 2016-01-11
240240
241- Fix possible out of bounds line number when `` cppcheck `` gets out of sync with in-memory file.
241+ Fix possible out of bounds line number when Cppcheck gets out of sync with in-memory file.
242242
243243### 1.0.0 - 2016-01-07
244244
0 commit comments