Skip to content

Commit 6c11344

Browse files
authored
Fix #14052 (Premium Manual: document how to generate metrics report) (danmar#7724)
1 parent 11d1a75 commit 6c11344

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

man/manual-premium.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1298,8 +1298,44 @@ Description of the options:
12981298
- `--output-file`: html filename that the report should be written to
12991299
- `results.xml`: The xml output from cppcheck
13001300

1301+
## Metrics
1302+
1303+
To generate metrics add option `--premium=metrics`. The metrics are saved in the xml v3 report.
1304+
Example:
1305+
1306+
cppcheck --premium=metrics test.c --xml-version=3 2> res.xml
1307+
1308+
We provide a small simple python script that creates a metrics report in CSV format:
1309+
1310+
python3 HISReport.py -f res.xml -j path/to/cppcheck-id-mapping.json -o test.csv
1311+
1312+
the `cppcheck-id-mapping.json` is provided in the cppcheck premium installation folder, i.e.
1313+
`/opt/cppcheckpremium` or `C:\Program Files\Cppcheck Premium`.
1314+
1315+
We do not have a ready-made solution to generate a html/pdf report. You can easily tweak our
1316+
HISReport.py script so that it generates html and get the report exactly as you want.
1317+
13011318
## Licenses
13021319

1320+
### Commercial Terms
1321+
13031322
Information about Cppcheck Premium licenses:
13041323
https://www.cppcheck.com/plans-pricing
13051324

1325+
### Installation / Registration
1326+
1327+
This is described on the Cppcheck Premium website:
1328+
https://www.cppcheck.com
1329+
1330+
### Troubleshooting
1331+
1332+
If your license does not work you can get some details about the license validation by executing
1333+
premiumaddon binary with the `--debug` option.
1334+
1335+
Windows:
1336+
1337+
premiumaddon.exe --debug
1338+
1339+
Linux/Mac:
1340+
1341+
premiumaddon --debug

0 commit comments

Comments
 (0)