Skip to content

Commit 23a62aa

Browse files
authored
premium-manual.md: clarify 'compliance report' and 'Licenses' sections (#7043)
1 parent 9ddcc58 commit 23a62aa

File tree

1 file changed

+13
-19
lines changed

1 file changed

+13
-19
lines changed

man/manual-premium.md

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1176,45 +1176,39 @@ the `Compliance report...` in the `File` menu.
11761176
### Command line
11771177

11781178
There is a tool `compliance-report` that is distributed with Cppcheck Premium. To see
1179-
all available options run `compliance-report` in a terminal with any options.
1179+
all available options run `compliance-report` in a terminal with no options.
11801180

11811181
Below is example usage to generate a Misra C 2012 compliance report.
11821182

1183-
1. Execute cppcheck and save warnings in an xml file. Save the checkers report.
1183+
`cppcheck --premium=misra-c-2012 --xml-version=3 src 2> results.xml`
11841184

1185-
`cppcheck --premium=misra-c-2012 --checkers-report=r.txt --xml src 2> results.xml`
1186-
1187-
2. Use `compliance-report` to convert the files to an html report.
1188-
1189-
`compliance-report --misra-c-2012 --project-name=Device --project-version=2.3 --checkers-report=r.txt --output-file=report.html results.xml`
1185+
`compliance-report --misra-c-2012 --project-name=Device --project-version=2.3 --output-file=report.html results.xml`
11901186

11911187
Description of the options:
11921188

11931189
* `--misra-c-2012`: Generate a compliance report for misra-c-2012
11941190
* `--project-name`: The name of the project
11951191
* `--project-version`: The version of the project
1196-
* `--checkers-report`: Provide the checkers report generated by Cppcheck
11971192
* `--output-file`: html filename that the report should be written to
11981193
* `results.xml`: The xml output from cppcheck
11991194

12001195
## Licenses
12011196

12021197
### Individual license
12031198

1204-
A license that is connected to your computer. You can check any code you want.
1205-
1206-
### LOC license
1199+
A license that is connected to your computer.
12071200

1208-
A license that allows you to run cppcheck on a limited number of lines of code. It can only be used for certain licensed paths in a repository.
1201+
After installing you run a register tool that will create a license file
1202+
which is locked to your computer.
12091203

1210-
#### Running analysis
1204+
### Enterprise license
12111205

1212-
Commands:
1206+
You receive a license file. Copy that to one of these paths:
12131207

1214-
cd check-path
1208+
* Windows:
1209+
* C:\\ProgramData\\Cppcheck Solutions AB\\
12151210

1216-
# Calculate lines of code and validate the license
1217-
premiumaddon --check-loc-license some-path/license-file > cppcheck-premium-loc
1211+
* Linux:
1212+
* /etc/cppcheckpremium/
1213+
* ~/.cppcheckpremium/
12181214

1219-
# Run cppcheck analysis
1220-
cppcheck <usual cppcheck parameters>

0 commit comments

Comments
 (0)