Generate Reports

Monitor quality through reports of analysis results

Polyspace^® provides you with predefined report templates to select specific aspects of your analysis results. Choose a report template that collects adequate information for your requirements. For more information, see Bug Finder and Code Prover report (-report-template) or try different report templates on sample results.

If you have MATLAB^® Report Generator™ installed on your system, you can customize the report templates further to suit your requirements.

DOS/UNIX Command

`polyspace-report-generator`	(DOS/UNIX) Generate reports for Polyspace analysis results stored locally or on Polyspace Access
`polyspace-results-export`	(DOS/UNIX) Export Polyspace results to external formats such as CSV or JSON

MATLAB API

expand all

Functions

polyspace_report Generate reports from Polyspace analysis results

Classes

polyspace.BugFinderResults Read Polyspace Bug Finder results from MATLAB

Polyspace Options

`Generate report`	Specify whether to generate a report after the analysis
`Bug Finder and Code Prover report (-report-template)`	Specify template for generating analysis report
`Output format (-report-output-format)`	Specify output format of generated report

Report Generator Components

expand all

Results Summary

`Code Metrics Summary`	Create table of Polyspace metrics
`Code Verification Summary`	Create table of Polyspace analysis results
`Coding Rules Summary`	Create table with number of coding rule violations
`Defects Summary`	Create table of defects (Bug Finder only)
`Run-time Checks Summary Ordered by File`	Create table with run-time checks ordered by file (Code Prover only)
`Software Quality Objectives - Coding Rules Summary`	Create table of coding rule violations in results downloaded from Polyspace Metrics
`Software Quality Objectives - Run-time Checks Summary`	Create table of results summary for results downloaded from Polyspace Metrics
`Summary By File`	Create table showing summary of Polyspace results by file

Results Details

`Call Hierarchy`	Create table showing call graph in source code
`Code and Verification Information`	Create table of verification times and code characteristics
`Code Metrics Details`	Create table of Polyspace metrics broken down by file and function
`Coding Rules Details`	Create table of coding rule violations broken down by file
`Global Variable Checks`	Create table of global variables (Code Prover only)
`Recursive Functions`	Create table of recursive functions
`Report Customization (Filtering)`	Create filters that apply to your Polyspace reports
`Run-time Checks Details Ordered by Color/File`	Create overrides for global filters in Polyspace reports (Code Prover only)
`Run-time Checks Details Ordered by Review Information`	Create table with run-time checks ordered by review information (Code Prover only)
`Software Quality Objectives - Run-time Checks Details`	Create table of result details for results downloaded from Polyspace Metrics
`Variable Access`	Create table showing global variable access in source code (Code Prover only)
`Variable Checks Details Ordered By Review Information`	Create table with global variable results ordered by review information (Code Prover only)

Appendix

`Acronym Definitions`	Create table of Polyspace acronyms used in report and their full forms
`Configuration Parameters`	Create table of analysis options, assumptions and coding rules configuration

Topics

Create Reports (PDF, Word, HTML)

Generate Reports from Polyspace Results
Generate report from Polyspace results using predefined templates.
Customize Existing Bug Finder Report Template
Modify components of report templates to include only the details you need.

Export Results (Excel, MATLAB)

Export Polyspace Analysis Results
Export results to text file, MATLAB table or JSON format for computing graphs and statistics.
Visualize Bug Finder Analysis Results in MATLAB

Generate graphs from Polyspace analysis results.
- Export Polyspace Analysis Results to Excel by Using MATLAB Scripts