Main Content

Address Results in Polyspace Access Through Bug Fixes or Justifications

This topic describes how to add review information to Polyspace results in the Polyspace Access web interface. For a similar workflow in the user interface of the Polyspace desktop products, see Address Polyspace Results Through Bug Fixes or Justifications (Polyspace Bug Finder).

Once you understand the root cause of a Polyspace® finding, you can fix your code. Otherwise, add review information to your Polyspace results to fix the code later or to justify the result. You can use the information to keep track of your review progress.

If you add review information to your results file, they carry over to the results of the next analysis on the same project. If you add the same information as comments to your code (annotate), they carry over to any subsequent analysis of the code, whether in the same project or not.

Add Review Information in Result Details pane

Set the Status and Severity, and optionally enter notes with more explanations in the Result Details pane. The status indicates your response to the Polyspace result. To create a custom Status, see Open Polyspace Access Results in a Desktop Interface.

If you do not plan to fix your code in response to a result, assign one of the following statuses:

  • Justified

  • No Action Planned

  • Not a Defect

Based on the status, Polyspace considers that you have given due consideration and justified that result (retained the code despite the result).

To facilitate your review workflow, Polyspace Access also classifies analysis findings as:

  • To Do, with a status of Unreviewed.

  • In Progress, with a status of To fix, To investigate, or Other.

  • Done, with a status of Justified, No action planned, or Not a defect.

In the DASHBOARD perspective, findings that are To Do or In Progress are considered as Open Issues. If a Polyspace analysis of your code finds known or acceptable defects or coding rule violations, you can remove the defects or violations from this list of Open Issues in subsequent analyses by assigning one of the justified statuses outlined above.

Comment or Annotate in Code

If you enter code comments or annotations in a specific syntax, the software can read them and populate the Severity, Status, and comment fields in the next analysis of the code. Open your source code in an editor and enter the annotation on the same line as the result.

For the annotation syntax, see Hide Known or Acceptable Polyspace Results.

If you do not specify a status in your annotation, Polyspace assumes that you have set a status of No Action Planned.

Related Topics