Generate Ruleset XML

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

Arguments Description

XML Arguments

<XML ARGS>
-gen_rulepool_xml | [-gen_ruleset_xml <RULESET ARGS>] [-rulepool_xml_include <attribute>] [-custom_rules <jars>]
<XML ARGS> Description
-gen_rulepool_xml                        [Optional] Generate the XML ruleset with all available rules.
-gen_ruleset_xml                         [Optional] Generate the XML ruleset with all the rules from the specified predefined ruleset.
-rulepool_xml_include <attribute>        [Optional] Specify which rule attributes should be displayed in the generated XML ruleset.
                                                    Must be a comma separated list of: complete_rule_info,name,title,severity,disable,description,parameters,commented_parameters,parameters_info.
-custom_rules <jars>                     [Optional] The path to jars containing custom rules.

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.

Examples

  • Generate the XML ruleset of all the available rules:

verissimo.sh -gen_rulepool_xml

  • Generate the XML ruleset of all the available rules, displaying default title and parameters for each rule:

verissimo.sh -gen_rulepool_xml -rulepool_xml_include title,parameters

  • Generate an XML ruleset of all available rules not in the specified ruleset XML:

verissimo.sh -gen_ruleset_xml -ruleset my_ruleset.xml -list_unused_available_rules