List Unused Available Rules

verissimo.sh <RULESET ARGS> [<RULESET FILTER ARGS>] <LIST UNUSED AVAILABLE RULES ARGS>

Arguments Description

Ruleset Arguments

<RULESET ARGS>
[-ruleset <XML file>] | [-basic|rtl|dead_code|uvm_ieee|performance|compliance|all|non_standard] [-uvm|ovm]
<RULESET ARGS> Description
-ruleset <XML file>            [Optional] Set the XML ruleset file.
                                          Default value: Basic Rules ruleset.
-all                           [Optional] Run the All Rules ruleset.
-basic                         [Optional] Run the Basic Rules ruleset.
-compliance                    [Optional] Run the XVM Compliance Rules ruleset.
-dead_code                     [Optional] Run the Dead Code Rules ruleset.
-non_standard                  [Optional] Run the Non-Standard ruleset.
-performance                   [Optional] Run the Performance Rules ruleset.
-rtl                           [Optional] Run the RTL Rules ruleset.
-uvm_ieee                      [Optional] Run the UVM IEEE 1800.2-2020 Compliance Rules ruleset.
-uvm|ovm                       [Optional] Run Verissimo XVM rules as UVM|OVM.
                                          Default value: uvm.

Note

See Predefined Rulesets for more details about each predefined ruleset.

Ruleset Filter Arguments

<RULESET FILTER ARGS>
[-since <yyyy-MM-dd / MM.M.m>] [-label <labels>] [-run_rule <rule name>]
<RULESET FILTER ARGS> Description
-since <yyyy-MM-dd / MM.M.m>             [Optional] Use only rules added since date yyyy-MM-dd or since version MM.M.m.
-label <labels>                          [Optional] Use onle rules annotated with the specified labels.
-run_rule <rule name>                    [Optional] Use only the rule with the given rule name from specified ruleset.
                                                    Can be repeated.

List Unused Available Rules Arguments

<LIST UNUSED AVAILABLE RULES ARGS>
-list_unused_available_rules
<LIST UNUSED AVAILABLE RULES ARGS> Description
-list_unused_available_rules        List available rules not used in current ruleset.

Note

Instead of printing all unused available rules, a ruleset XML file or a HTML documentation containing all of them can be generated. See Generate Ruleset XML or Generate Documentation.

Examples

  • List all available rules that are not in the specified ruleset:

verissimo.sh -ruleset my_ruleset.xml -list_unused_available_rules