Report

This menu provides options that allow you to generate reports at either the project or translation unit level:

Generate Report for Project

This option reports on the whole of the Active project.

Generate Report for Selected Files

This option reports only on those files or folders that are already selected.

Reports can only be generated for projects that have had file-based analysis performed.

Once you have selected the level of report required, you can select any of the following types of report:

  • The Code Review Report, which summarizes metrics and messages from files, functions and classes. It can also display some code visualizations, includes, calls, relations and function structure. It provides a broad overview of the code.
  • The HIS Metrics Report, which produces metrics according to the HIS (Hersteller

Initiative Software) specifications.

  • The Metrics Data Report, which generates an XML file that you can use as a source of metrics data for further examination.
  • The Rule Compliance Report, which contains data on violations of rules that are specified in a Perforce QAC Project’s Rule Configuration File.
  • The Suppressions Report, which provides information on message diagnostics that have been suppressed during analysis.

If you select the ’Ignore Dependencies’ option, then dependency checking is skipped and reports are able to be produced even for those files for which analyses remain out of date, for example because RCMA is in the toolchain.

If you do select the ’Ignore Dependencies’ option, then you should be aware that, because the dependency checking has not been run (and subsequent analysis has also not been run), the reports may not be ’final’: that is to say, they may not be 100% complete. For this reason, all reports generated using this option are marked as ’Draft’ in the HTML/XML.

Following generation of the selected report, a dialog is displayed confirming the report’s location. The report output is generated within the prqa\configs\<name_of_config>\reports directory of the Perforce QAC Project.

Each report is generated from the generic file results_data.xml, and the associated ’data’ folder (which holds the associated JSON (JavaScript Object Notation) files). The reports, which can be copied and shared with other users, are in the following format:

<name_of_project>_<Report Name>_<datestamp>_<timestamp>.<html/xml>

The option to generate reports for selected C and C++ files and folders can be accessed from the Explorer Context Menu. The option to generate reports for selected C and C++ files and folders can also be selected from the Files Tab.