Skip to content

Commit 3359ea2

Browse files
authored
Format README (#101)
* Wrap README at 99 characters
1 parent 1a9342a commit 3359ea2

File tree

1 file changed

+18
-9
lines changed

1 file changed

+18
-9
lines changed

Diff for: README.md

+18-9
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,26 @@ This project is supported with a free open source license of CLion from
1414
## Installation
1515

1616
- Install the `cppcheck` plugin from the JetBrains Marketplace: https://plugins.jetbrains.com/plugin/8143-cppcheck. See
17-
[Installing, Updating and Uninstalling Repository Plugins](https://www.jetbrains.com/help/clion/managing-plugins.html) for more details.
17+
[Installing, Updating and Uninstalling Repository Plugins](https://www.jetbrains.com/help/clion/managing-plugins.html)
18+
for more details.
1819

19-
- Install Cppcheck. Please refer to https://github.com/danmar/cppcheck#packages on how to obtain a version of Cppcheck for your platform.
20+
- Install Cppcheck. Please refer to https://github.com/danmar/cppcheck#packages on how to obtain a version of Cppcheck
21+
for your platform.
2022

21-
- Go to the `Cppcheck Configuration` section in the settings of your respective JetBrains IDE and put the **absolute** path to the Cppcheck executable in the `Cppcheck Path`.
23+
- Go to the `Cppcheck Configuration` section in the settings of your respective JetBrains IDE and put the **absolute**
24+
path to the Cppcheck executable in the `Cppcheck Path`.
2225

23-
- (Windows) The executable is found in the path you specified during the installation. By default this should be `C:\Program Files\Cppcheck\cppcheck.exe`.
24-
- (Non-Windows) Use `which cppcheck` or `command -v cppcheck` on the command-line to get the location of the executable. The default depends on your system but should usually be `/usr/bin/cppcheck` or `/usr/local/bin/cppcheck`.
26+
- (Windows) The executable is found in the path you specified during the installation. By default this should be
27+
`C:\Program Files\Cppcheck\cppcheck.exe`.
28+
- (Non-Windows) Use `which cppcheck` or `command -v cppcheck` on the command-line to get the location of the executable.
29+
The default depends on your system but should usually be `/usr/bin/cppcheck` or `/usr/local/bin/cppcheck`.
2530

2631
## Usage
2732

2833
### Provided Actions
2934

30-
The plugin provides the `Show Cppcheck XML Output` action which will show the raw XML output of the latest finished analysis.
35+
The plugin provides the `Show Cppcheck XML Output` action which will show the raw XML output of the latest finished
36+
analysis.
3137

3238
## Plugin Configuration
3339

@@ -156,7 +162,8 @@ Deployment.
156162

157163
- Added `Show Cppcheck XML Output` action to show the latest XML output.
158164
- Report execution errors as global inspection errors.
159-
- Display `Cppcheck Path` configuration errors as global inspection errors instead of using a (hard to spot) status bar message.
165+
- Display `Cppcheck Path` configuration errors as global inspection errors instead of using a (hard to spot) status bar
166+
message.
160167
- Display global inspection error and omit the option if the configured `MISRA Addon JSON` does not exist.
161168
- Made plugin verbose level configurable via settings.
162169
- Display all available details for findings in tooltip.
@@ -177,8 +184,10 @@ Deployment.
177184
- Only scan files which actually exist. (Contribution by @firewave)
178185
- Use unique file names for temporary files used for analysis. (Contribution by @firewave)
179186
- Properly handle `debug` messages generated by `--debug-warnings`. (Contribution by @firewave)
180-
- Added `.cl`, `.hxx`, `.tpp` and `.txx` to list of supported file extensions - now matches the ones supported by Cppcheck internally. (Contribution by @firewave)
181-
- Internally suppress `unusedFunction` and `unusedStructMember` (for header files only) warnings to avoid false positives. (Contribution by @firewave)
187+
- Added `.cl`, `.hxx`, `.tpp` and `.txx` to list of supported file extensions - now matches the ones supported by
188+
Cppcheck internally. (Contribution by @firewave)
189+
- Internally suppress `unusedFunction` and `unusedStructMember` (for header files only) warnings to avoid false
190+
positives. (Contribution by @firewave)
182191
- Fixed `information` messages not being shown at all. (Contribution by @firewave)
183192

184193
### 1.5.1 - 2020-11-12

0 commit comments

Comments
 (0)