Skip to content

Commit

Permalink
Add documentation about how the fingerprint is made for Polyspace
Browse files Browse the repository at this point in the history
  • Loading branch information
JokeWaumans committed Jul 5, 2024
1 parent 172b42d commit 87d133d
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -497,11 +497,15 @@ e.g. ``$HOME``, and other variables that depend on the checker type:
Polyspace
Any field of a Polyspace defect can be included by using the corresponding
`column title <Exporting Polyspace Results_>`_ in lowercase as the variable name.
The default template is ``Polyspace: $check``
The default template is ``Polyspace: $check``.

Other
The template should contain ``$description``, which is the default.

The Polyspace checker generates the fingerprint (a unique identifier) for each row in the TSV file that is exported as finding.
Specific columns (``new``, ``status``, ``severity``, ``comment``, and ``key``) are excluded as they might contain transient information.
The remaining values in the row are hashed using a MD5 function to create the fingerprint.

=======================
Issues and New Features
=======================
Expand Down

0 comments on commit 87d133d

Please sign in to comment.