All Available Arguments

Argument

Description

all

Run the All Rules ruleset.

autocorrect

Auto-correct failures for all rules that have autocorrect enabled in the specified ruleset.

autocorrect_all

Auto-correct failures for all rules supporting autocorrect from the specified ruleset.

autocorrect_checkout <perforce>

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.

autocorrect_files_location

Destination directory for the autocorrected files. Only use when -autocorrect_generate_modified_files is specified. Default value: current directory.

autocorrect_generate_modified_files

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_reruns <number>

Maximum number of reruns when performing autocorrect. Only use when one of -autocorrect, -autocorrect_all is specified.

autocorrect_rule <rule name>

Autocorrect a rule name from specified ruleset. Can be repeated. Only use when -autocorrect is specified.

autocorrect_skip_sanity_checks <rule name>

Skip the sanity checks for the autocorrect of the specified rule. Can be repeated. Only use when one of -autocorrect, -autocorrect_all is specified.

baseline_report

Directory of the baseline HTML report.

basic

Run the Basic Rules ruleset.

body_only

Removes the header and the footer from the generated HTML Progress Report.

check_timeout <seconds>

Set the timeout value of a check.

cmd <command file>

Compile using the specified compilation arguments file.

compare <dir>

Directory of the HTML report to be compared with the report specified by the next ‘compare’ argument.

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.

compare_html_report_location <dir>

Destination directory for the compare HTML lint report. Default value: current directory.

compile_waivers <file>

Waive compilation errors using the waivers specified in the XML file. Waivers specified with this flag will have the highest precedence. See Compile Waivers.

compliance

Run the XVM Compliance Rules ruleset.

current_html_report_location <dir>

Destination directory for the current HTML lint report. Default value: current directory.

custom_report_location

Destination directory for the custom lint report. Default value: current directory.

custom_rules <jars>

Path to jars containing custom rules.

dead_code

Run the Dead Code Rules ruleset.

debug_custom_rules <class>

Name of the custom rule class to be debugged. Only use when -custom_rules is specified.

debug_custom_rules_from_files <files>

Path of the file containing custom rule class names to be debugged. Only use when -custom_rules is specified.

diff <dir>

Directory of the HTML report to be differentiated with other reports specified by subsequent ‘diff’ arguments. Must be repeated.

dry_run

Execute a dry run of the verissimo.sh command. Arguments are validated, however the command is not performed.

eclipsespace <dir>

Directory of the Eclipse configuration and user area when running Verissimo in GUI Mode. Default value: /home/user/.eclipse. Only use when -vscode is not specified.

fail_on_severity <error | warning | info>

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.

force

Overwrite existing project when running Verissimo in GUI Mode.

gen_compare_html_report

Generate the HTML compare report between baseline HTML report and current lint report. Only use when -baseline_report is specified.

gen_current_html_report

Generate the current HTML lint report. Only use when -baseline_report is specified.

gen_custom_report <FTL file>

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. See Custom Report.

gen_custom_report_ftl <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.

gen_progress_report

Generate the HTML Progress Report with all the given HTML Reports. At least one of -parent_folder or multiple -report_folder must be specified.

gen_html_report

Generate the HTML lint report.

gen_rulepool_doc

Generate the HTML documentation with all available rules.

gen_rulepool_xml

Generate the XML ruleset with all available rules.

gen_ruleset_doc

Generate the HTML documentation with all the rules from the specified ruleset.

gen_ruleset_xml

Generate the XML ruleset with all the rules from the specified predefined ruleset.

gen_txt_report

Print lint failures in the Verissimo output.

gui

Run Verissimo in GUI mode. By default Verissimo will be run in the DVT Eclipse IDE.

heap_size <size>

Set the Java heap size. Default is 3072m.

help

Print help and exit.

histogram_dump_rules <rule names>

Comma separated list of rule names for which histogram dumps will be generated.

html_report_location

Destination directory for the HTML lint report. Default value: current directory.

ignore_build_config_errors

Ignore build configuration errors.

ignore_compile_errors

Ignore compile errors, disable printing of compilation errors and continue with linting.

ignore_lint_errors

Ignore lint errors and disable printing of lint errors.

ignore_lint_infos

Ignore lint infos and disable printing of lint infos.

ignore_lint_warnings

Ignore lint warnings and disable printing of lint warnings.

include_code_date

Include the committer date in the generated lint report.

include_creation_date

Include the creation date of each failure in the generated lint report based on GIT, SVN or Perforce blame information or using the file’s last modification date.

include_html_code

Include the linted source code as HTML files in the generated lint report.

info <key=value>

Place a ‘key=value’ annotation on all hits from a generated HTML report, in order to create filters based on them after a merge of reports.

lang <language>

Enable support for the specified language. Only used to export the mixed design hierarchy. Available values: vlog, vhdl. Default value: vlog.

license_queue_timeout <timeout>

Maximum time in seconds to wait in queue for a license when one is not available.

list_unused_available_rules

List available rules not used in current ruleset.

log <log file>

Log to specified file.

manual_checks_status <XML file>

Manual checks status file.

map <mapping>

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.

merge <dir>

Directory of the HTML report to be merged with other reports specified by subsequent ‘merge’ arguments. Must be repeated.

noexit

Do not exit until DVT IDE is closed. Only use when -gui or -vscode is specified. Not supported on Windows.

non_standard

Run the Non-Standard ruleset.

open_report <dir>

Specify the HTML report location to open in DVT IDE.

ovm

Run Verissimo XVM rules as OVM. If not specified -uvm will be used.

parent_folder <dir>

Directory that contains HTML reports which are used to generate the HTML Progress Report.

performance

Run the Performance Rules ruleset.

prewaive_unchanged_files

Pre-waives the unchanged files based on the baseline report.

print_all_compile_problems

Print all compile problems. Does not include waived problems. Include waived problems if used with “-print_compile_waivers_info”.

print_compile_waivers_info

Prints how many problems each compile waiver has matched.

process_timeout <seconds>

Set the timeout value of the complete linting process, including building.

progress_name <name>

Customize the name of the generated HTML Progress Report.

project <dir>

Directory of the project to be created when running Verissimo in GUI Mode. Default value: dvt_verissimo_project.XXXXX (temporary project directory). Only use when -gui or -vscode is specified.

project_name <name>

Name of the project to be created when running Verissimo in GUI Mode. Default value: project. Only use when -gui or -vscode is specified.

report_folder <dir>

Name of the HTML report directory used to generate the HTML Progress Report. Can be repeated.

rtl

Run the RTL Rules ruleset.

rulepool_xml_include <rule_attributes>

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.

ruleset <XML file>

Set the XML ruleset file. Default value: Basic Rules ruleset. See Rulesets.

ruleset_editor

Generate the Ruleset Rditor. The Ruleset Editor is a HTML file which can be opened in Eclipse, VS Code or any browser.

run_rule <rule name>

Use only the rule with the given rule name from specified ruleset. Can be repeated.

session_timeout <seconds>

Set the timeout value of the linting session, without building.

silent

Turn on minimal output.

since <yyyy-MM-dd / MM.M.m>

Use only rules added since date yyyy-MM-dd or since version MM.M.m.

label <labels>

Use only rules annotated with the specified labels.

stack_size <size>

Set the Java thread stack size. Default is 4m.

thread_dump_interval <milliseconds>

Set the interval of thread dumps for a rule. Default value: 200ms. Only use when -thread_dump_rules is specified.

thread_dump_delay <milliseconds>

Set the delay before a rule will generate thread dumps. Default value: 0ms. Only use when -thread_dump_rules is specified.

thread_dump_rules <rule names>

Comma separated list of rule names for which thread dumps will be generated.

uvm

Run Verissimo XVM rules as UVM.

uvm_ieee

Run the UVM IEEE 1800.2-2020 Compliance Rules ruleset.

version

Print version and exit.

vscode

Run Verissimo in the DVT IDE for VS Code.

waivers <XML file>

XML waivers file. See Lint Waivers.

workspace <dir>

Directory of the eclipse workspace when running Verissimo in GUI Mode. Default value: dvt_verissimo_ws.XXXXX (temporary eclipse directory). Only use when -vscode is not specified.

zero_exit_on_lint_failures

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).