Custom Report
Generate Custom Report
verissimo.sh <COMPILATION ARGS> <RULESET ARGS> [<RULESET FILTER ARGS>] [<LINT ARGS>] [<BASELINE ARGS>] [<EXIT CODE ARGS>] [<AUTOCORRECT ARGS>] <CUSTOM REPORT ARGS>
Arguments Description
Compilation Arguments
-cmd <file> [-compile_waivers <file>] [-ignore_build_config_errors] [-print_compile_waivers_info] [-ignore_compile_errors] | [-print_all_compile_problems]
-cmd <file> Compile using the specified compilation arguments file.
-compile_waivers <file> [Optional] Waive compilation errors using the waivers specified in the XML file.
Waivers specified with this flag will have the highest precedence.
-ignore_build_config_errors [Optional] Ignore build configuration errors.
-print_compile_waivers_info [Optional] Print how many problems each compile waiver has matched.
-print_all_compile_problems [Optional] Print all compile problems.
Does not include waived problems. Include waived problems if -print_compile_waivers_info is specified.
-ignore_compile_errors [Optional] Ignore compile errors, disable printing of compilation errors and continue with linting.
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.
Lint Arguments
[-waivers <XML file>]
[-manual_checks_status <XML file>]
[-custom_rules <jars> [-debug_custom_rules <class>] [-debug_custom_rules_from_files <files>]]
[-check_timeout <seconds>] [-session_timeout <seconds>] [-process_timeout <seconds>]
[-thread_dump_rules <rule names> [-thread_dump_delay <milliseconds>] [-thread_dump_interval <milliseconds>]]
[-histogram_dump_rules <rule names>]
[-lang <language>]
-waivers <XML file> [Optional] XML waivers file.
-manual_checks_status <XML file> [Optional] XML manual checks status file.
-custom_rules <jars> [Optional] Path to jars containing custom rules.
-debug_custom_rules <class> [Optional] Name of the custom rule class to be debugged.
Only use when -custom_rules is specified.
-debug_custom_rules_from_files <files> [Optional] Path of the file containing custom rule class names to be debugged.
Only use when -custom_rules is specified.
-check_timeout <seconds> [Optional] Set the timeout value of a check.
-session_timeout <seconds> [Optional] Set the timeout value of the linting session, without building.
-process_timeout <seconds> [Optional] Set the timeout value of the complete linting process, including building.
-thread_dump_rules <rule names> [Optional] Comma separated list of rule names for which thread dumps will be generated.
-thread_dump_delay <milliseconds> [Optional] Set the delay before a rule will generate thread dumps.
Default value: 0ms.
Only use when -thread_dump_rules is specified.
-thread_dump_interval <milliseconds> [Optional] Set the interval of thread dumps for a rule.
Default value: 200ms.
Only use when -thread_dump_rules is specified.
-histogram_dump_rules <rule names> [Optional] Comma separated list of rule names for which histogram dumps will be generated.
-lang <language> [Optional] Enable support for the specified language. Only used to export the mixed design hierarchy.
Available values: vlog, vhdl.
Default value: vlog.
Baseline Arguments
Exit Code Arguments
[-zero_exit_on_lint_failures] [-fail_on_severity <severity>] [-ignore_lint_errors] [-ignore_lint_warnings] [-ignore_lint_infos]
-zero_exit_on_lint_failures [Optional] Return exit code zero even if some checks fail.
Non-zero exit code is returned only when an internal error occurs
(execution exceptions or wrong arguments).
-fail_on_severity <severity> [Optional] Fail if the result contains checks with severities equal or higher
than the specified severity.
Must be one of: error, warning, info.
Default value: info.
-ignore_lint_errors [Optional] Ignore lint errors and disable printing of lint errors.
-ignore_lint_warnings [Optional] Ignore lint infos and disable printing of lint infos.
-ignore_lint_infos [Optional] Ignore lint warnings and disable printing of lint warnings.
Autocorrect Arguments
[-autocorrect [-autocorrect_rule <rule name>]] | -autocorrect_all [-autocorrect_reruns <number>] [-autocorrect_skip_sanity_checks <rule name>] [-autocorrect_generate_modified_files [-autocorrect_files_location <dir>]] [-autocorrect_checkout <perforce>]
-autocorrect [Optional] Auto-correct failures for all rules that have autocorrect enabled in the specified ruleset.
-autocorrect_rule <rule name> [Optional] Auto-correct failures for the rule with the specified rule name from the provided ruleset.
Can be repeated.
Only use when -autocorrect is specified.
-autocorrect_all [Optional] Auto-correct failures for all rules supporting autocorrect from the specified ruleset.
-autocorrect_reruns <number> [Optional] Maximum number of reruns when performing autocorrect.
Only use when one of -autocorrect, -autocorrect_all is specified.
-autocorrect_skip_sanity_checks <rule name> [Optional] Skip the sanity checks for the autocorrect of the specified rule.
Can be repeated.
Only use when one of -autocorrect, -autocorrect_all is specified.
-autocorrect_generate_modified_files [Optional] Generate new files with the modified code instead of performing autocorrect directly on the original files.
Only use when one of -autocorrect, -autocorrect_all is specified.
-autocorrect_files_location <dir> [Optional] Destination directory for the autocorrected files.
Only use when -autocorrect_generate_modified_files is specified.
Default value: current directory.
-autocorrect_checkout <perforce> [Optional] Checkout files using specified revision control system to enable editing when using autocorrect.
Must be: perforce.
Only use when one of -autocorrect, -autocorrect_all is specified.
Generate Custom Report Arguments
-gen_custom_report <FTL file>|<predefined template name> [-custom_report_location <dir>]
-gen_custom_report <FTL file>|<predefined template name> Generate a custom report using the user-defined specified template or the predefined template name.
Available values for <predefined template name> are: FAILURES_TEXT, FAILURES_JSON, FAILURES_XML,
LINTED_FILES_TEXT, AUTOCORRECT_EDITS_TEXT, WAIVED_FAILURES_CSV, AVAILABLE_CHECKS_CSV,
AUTOCORRECT_MODIFIED_FILES_SH, PERFORMANCE_STATS_TEXT.
Can be repeated.
-custom_report_location <dir> [Optional] Destination directory for the custom lint report.
Default value: current directory.
Examples
Generate a custom report from a custom template ftl file:
verissimo.sh -cmd .dvt/default.build -all -gen_custom_report custom_report.txt.ftl
Generate a custom report using a predefined template:
verissimo.sh -cmd .dvt/default.build -all -gen_custom_report FAILURES_TEXT
Generate Custom Report from HTML Report
verissimo.sh <HTML REPORT LOCATION ARGS> | <MERGE ARGS> | <DIFF ARGS> | <COMPARE ARGS> [<EXIT CODE ARGS>] <CUSTOM REPORT ARGS>
Arguments Description
HTML Report Location Arguments
Exit Code Arguments
[-zero_exit_on_lint_failures] [-fail_on_severity <severity>] [-ignore_lint_errors] [-ignore_lint_warnings] [-ignore_lint_infos]
-zero_exit_on_lint_failures [Optional] Return exit code zero even if some checks fail.
Non-zero exit code is returned only when an internal error occurs
(execution exceptions or wrong arguments).
-fail_on_severity <severity> [Optional] Fail if the result contains checks with severities equal or higher
than the specified severity.
Must be one of: error, warning, info.
Default value: info.
-ignore_lint_errors [Optional] Ignore lint errors and disable printing of lint errors.
-ignore_lint_warnings [Optional] Ignore lint infos and disable printing of lint infos.
-ignore_lint_infos [Optional] Ignore lint warnings and disable printing of lint warnings.
Merge Arguments
-merge <dir> Directory of the HTML report to be merged with other reports specified by subsequent -merge arguments.
Must be repeated.
-info <key=value> [Optional] Place a ‘key=value’ annotation on all hits from a generated HTML report, in order to create filters based on them after a merge between reports.
-html_report_location <dir> [Optional] Destination directory for the HTML lint report.
Default value: current directory.
Diff Arguments
-diff <dir> Directory of the HTML report to be differentiated with other reports specified by subsequent -diff arguments.
Must be repeated.
-info <key=value> [Optional] Place a ‘key=value’ annotation on all hits from a generated HTML report, in order to create filters based on them after a diff between reports.
-html_report_location <dir> [Optional] Destination directory for the HTML lint report.
Default value: current directory.
Compare Arguments
-compare_baseline <dir> -compare_current <dir> [-map <mapping>] [-html_report_location <dir>]
-compare_baseline <dir> Directory of the baseline HTML report to be compared with the current report specified by the ‘compare_current’ argument.
-compare_current <dir> Directory of the current HTML report to be compared with the baseline report specified by the ‘compare_baseline’ argument.
-map <mapping> [Optional] Create a mapping between linted files from current and baseline reports.
The mapping has the format ‘type+current_report_path_pattern=baseline_report_path_pattern’, where the type is one of PERL or SIMPLE.
Default value for type: PERL.
-html_report_location <dir> [Optional] Destination directory for the HTML lint report.
Default value: current directory.
Generate Custom Report Arguments
-gen_custom_report <FTL file>|<predefined template name> [-custom_report_location <dir>]
-gen_custom_report <FTL file>|<predefined template name> Generate a custom report using the user-defined specified template or the predefined template name.
Available values for <predefined template name> are: FAILURES_TEXT, FAILURES_JSON, FAILURES_XML,
LINTED_FILES_TEXT, AUTOCORRECT_EDITS_TEXT, WAIVED_FAILURES_CSV, AVAILABLE_CHECKS_CSV,
AUTOCORRECT_MODIFIED_FILES_SH, PERFORMANCE_STATS_TEXT.
Can be repeated.
-custom_report_location <dir> [Optional] Destination directory for the custom lint report.
Default value: current directory.
Examples
Generate a custom report from a HTML report using a predefined template:
verissimo.sh -html_report_location report_location -gen_custom_report FAILURES_TEXT
Generate a custom report from the result of a diff operation between HTML reports:
verissimo.sh -diff /path/to/report1/verissimo_html_report -diff /path/to/report2/verissimo_html_report report_location -gen_custom_report custom_report.txt.ftl
Generate Custom Report Template
verissimo.sh <CUSTOM REPORT TEMPLATE ARGS>
Arguments Description
Generate Custom Report Template Arguments
-gen_custom_report_ftl <predefined template name> Generate a custom report template using the specified option.
Available values are: FAILURES_TEXT, FAILURES_JSON, FAILURES_XML, LINTED_FILES_TEXT,
AUTOCORRECT_EDITS_TEXT, WAIVED_FAILURES_CSV, AVAILABLE_CHECKS_CSV,
AUTOCORRECT_MODIFIED_FILES_SH, PERFORMANCE_STATS_TEXT.
Can be repeated.
Examples
Generate a predefined custom report template:
verissimo.sh -gen_custom_report_ftl AUTOCORRECT_EDITS_TEXT