diff --git a/man/manual.docbook b/man/manual.docbook index d73794c84..0b9e2901a 100644 --- a/man/manual.docbook +++ b/man/manual.docbook @@ -458,4 +458,38 @@ int a(int sz) [except2.cpp:7]: (error) Throwing exception in invalid state, p points at deallocated memory + + + html report + + You can convert the xml output from cppcheck into a html report. + You'll need python and the pygments module + (http://pygments.org/) for this to work. In the Cppcheck source + tree there is a folder "htmlreport" that contains a script that transforms + a Cppcheck xml file into html output. + + This command generates the help screen: + + htmlreport/cppcheck-htmlreport -h + + The output screen says: + + Usage: cppcheck-htmlreport [options] + +Options: + -h, --help show this help message and exit + --file=FILE The cppcheck xml output file to read defects from. + Default is reading from stdin. + --report-dir=REPORT_DIR + The directory where the html report content is written. + --source-dir=SOURCE_DIR + Base directory where source code files can be found. + + An example usage: + + ./cppcheck gui/test.cpp --xml 2> err.xml +htmlreport/cppcheck-htmlreport --file=err.xml --report-dir=test1 --source-dir=. + + +