`-jsf-coding-rules`

Check for violations of JSF C++ rules

Description

Specify whether to check for violation of JSF^® AV C++ rules (JSF++:2005)¹ . Each value of the option corresponds to a subset of rules to check.

Set Option

Set the option using one of these methods:

Polyspace Platform user interface (desktop products only): This option does not exist in the project configuration. Activate checkers by using the options Use custom checkers file and Checkers activation file (-checkers-activation-file).
Command line and options file: Use the option -jsf-coding-rules. See Command-Line Information.

Why Use This Option

Use this option to specify the subset of JSF C++ rules to check for.

After analysis, the Results List pane lists the coding standard violations. On the Source pane, for every coding rule violation, Polyspace^® assigns a symbol to the keyword or identifier relevant to the violation.

Settings

Default: shall-rules

shall-rules

Check all Shall rules. Shall rules are mandatory requirements and require verification.

shall-will-rules

Check all Shall and Will rules. Will rules are intended to be mandatory requirements but do not require verification.

all-rules

Check all Shall, Will, and Should rules. Should rules are advisory rules.

from-file

Specify an XML file where you configure a custom selection of checkers for this coding standard. To create a configuration file, click , then select the rules and recommendations you want to check for this coding standard from the right pane of the Checkers selection window. Save the file.

To use or update an existing configuration file, in the Checkers selection window, enter the full path to the file in the field provided or click Browse.

If you set the option to from-file, enable Set checkers by file (-checkers-selection-file).

Tips

If your project uses a setting other than generic for Compilation toolchain (Static analysis), some rules might not be completely checked. For example, AV Rule 8: “All code shall conform to ISO/IEC 14882:2002(E) standard C++.”

Dependencies

This option is available only if you set Source code language (-lang) to CPP or C-CPP.

For projects with mixed C and C++ code, the JSF C++ checker analyzes only .cpp files.

Command-Line Information

Use the command -jsf-coding-rules in the command line to check for violations of JSF C++ rules.

Parameter: -jsf-coding-rules

Value: shall-rules | shall-will-rules | all-rules | from-file

Example (Bug Finder): polyspace-bug-finder -sources file_name -jsf-coding-rules all-rules

Example (Bug Finder Server): polyspace-bug-finder-server -sources file_name -jsf-coding-rules all-rules

Alternatively, enable all or specific JSF C++ rules through a checkers activation XML file. See Checkers activation file (-checkers-activation-file).

Version History

expand all

R2021b: Using text format for coding rules file will not be supported

Since R2019a, the file where you define a custom selection of coding standard checkers uses the XML format. Use of a text file for this purpose results in an error. You can save custom selections for all the coding standards that Polyspace supports in the same file.

Desktop interface:

If you have a project that contains custom coding standard selection files in text format, Polyspace automatically updates and consolidates those files into a single XML file. If your project has conflicting configurations that refer to the same custom selection file, the software saves the consolidated coding standard selection for each configuration to separate XML files.

To update your text files to the XML format manually, in the Coding Standards & Code Metrics node of the Configuration pane, click . In the Checkers selection window, select the files then click Save Changes. Polyspace consolidates the files into a single XML files, and saves this file as filename.xml, where filename is the name of the first selected file alphabetically. For instance, if you select foo.conf and bar.conf, they are saved as bar.conf.xml.

Command-line/ IDEs:

In the command-line or in the IDE extensions, using text files as input to -jsf-coding-rules results in an error. To select a custom selection of JSF C++ rules, use an XML file.

Use the file jsf_av_cpp.xml as a template to create the XML file where you define a custom selection of coding standard checkers. This template file is in polyspaceroot\polyspace\examples\doc_cxx\coding_standards_XML. Here, polyspaceserverroot is the root installation folder for the Polyspace products, for instance, C:\Program Files\Polyspace\R2026a. To update your script, see this table

Option	Use Instead
`-jsf-coding-rules "custom_standard.conf"`	`-checkers-selection-file "custom_standard.conf.xml" -jsf-coding-rules from-file`

See:

Check for and Review Coding Standard Violations
Configure Checkers (Polyspace as You Code)

Example of Configuration File in XML Format

R2019b: Use of text format for coding rules file will not be supported

Since R2019a, the file where you define a custom selection of coding standard checkers uses the XML format. You can save custom selections for all the coding standards that Polyspace supports in the same file. If you use a text file, Polyspace issues a warning and converts the text file to XML.