Generate Documentation
verissimo.sh <DOC ARGS> [<RULESET FILTER ARGS>] [<LIST UNUSED AVAILABLE RULES ARGS>]
Arguments Description
Documentation Arguments
-gen_rulepool_doc [Optional] Generate the HTML documentation with all available rules.
-gen_ruleset_doc [Optional] Generate the HTML documentation with all the rules from the specified ruleset.
-custom_rules <jars> [Optional] The path to jars containing custom rules.
Ruleset Arguments
[-ruleset <XML file>] | [-basic|rtl|dead_code|uvm_ieee|performance|compliance|all|non_standard] [-uvm|ovm]
-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
-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
Examples
Generate the HTML documentation of all the available rules:
verissimo.sh -gen_rulepool_doc
Generate the HTML documentation for a specific ruleset:
verissimo.sh -gen_ruleset_doc -ruleset my_ruleset.xml