All Available Arguments
Argument |
Description |
Tag |
|---|---|---|
all |
Run the All Rules ruleset. |
Ruleset |
autocorrect |
Auto-correct failures for rules that have autocorrect enabled in the specified ruleset. To enable autocorrect for a rule that supports autocorrecting, either specify ‘autocorrect=”on”’ in the ruleset file(see Ruleset File Syntax) or use the ‘-autocorrect_rule’ argument followed by the name of the rule. This argument should be used when you wish to auto-correct only a set of specified rules from the ruleset. Cannot use this argument if ‘-autocorrect_all’ is also used. |
Autocorrect |
autocorrect_all |
Auto-correct failures for all rules supporting autocorrect from the specified ruleset. Cannot use this argument if ‘-autocorrect’ is also used. |
Autocorrect |
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 |
autocorrect_files_location |
Destination directory for the autocorrected files. Only use when -autocorrect_generate_modified_files is specified. Default value: current directory. |
Autocorrect |
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 |
autocorrect_reruns <number> |
Maximum number of reruns when performing autocorrect. Only use when one of -autocorrect, -autocorrect_all is specified. |
Autocorrect |
autocorrect_rule <rule name> |
Enable autocorrect for a rule from the specified ruleset. Can be repeated. Only use when -autocorrect is specified. |
Autocorrect |
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. |
Autocorrect |
baseline_report |
Directory of the baseline HTML report. |
HTML-baseline-report |
basic |
Run the Basic Rules ruleset. |
Ruleset |
body_only |
Removes the header and the footer from the generated HTML Progress Report. |
HTML-progress-report |
check_timeout <seconds> |
Set the timeout value of a check. |
Lint |
cmd <command file> |
Compile using the specified compilation arguments file. |
Compilation |
compare_baseline <dir> |
Directory of the baseline HTML report to be compared with the current report specified by the ‘compare_current’ argument. |
HTML-compare-report |
compare_current <dir> |
Directory of the current HTML report to be compared with the baseline report specified by the ‘compare_baseline’ argument. |
HTML-compare-report |
compare_html_report_location <dir> |
Destination directory for the compare HTML lint report. Default value: current directory. |
HTML-compare-report |
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. |
Compilation |
compliance |
Run the XVM Compliance Rules ruleset. |
Ruleset |
current_html_report_location <dir> |
Destination directory for the current HTML lint report. Default value: current directory. |
HTML-current-report |
custom_report_location <dir> |
Destination directory for the custom lint report. Default value: current directory. |
Custom-report |
custom_rules <jars> |
Path to jars containing custom rules. |
Lint |
dead_code |
Run the Dead Code Rules ruleset. |
Ruleset |
debug_custom_rules <class> |
Name of the custom rule class to be debugged. Only use when -custom_rules is specified. |
Lint |
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. |
Lint |
diff <dir> |
Directory of the HTML report to be differentiated with other reports specified by subsequent ‘diff’ arguments. Must be repeated. |
HTML-diff-report |
dry_run |
Execute a dry run of the verissimo.sh command. Arguments are validated, however the command is not performed. |
Dry-run |
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. |
DVT-IDE |
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. |
Exit-code |
filter_path <path> |
Add an user-defined path to be filtered in the custom report model. |
Custom-report |
force |
Overwrite existing project when running Verissimo in GUI Mode. |
DVT-IDE |
gen_compare_html_report |
Generate the HTML compare report between baseline HTML report and current lint report. Only use when -baseline_report is specified. |
HTML-compare-report |
gen_current_html_report |
Generate the current HTML lint report. Only use when -baseline_report is specified. |
HTML-current-report |
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, CHECKS_JSON, AUTOCORRECT_MODIFIED_FILES_SH, PERFORMANCE_STATS_TEXT, NORMALIZED_LOGS. Can be repeated. See Custom Report. |
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, CHECKS_JSON, AUTOCORRECT_MODIFIED_FILES_SH, PERFORMANCE_STATS_TEXT, NORMALIZED_LOGS. Can be repeated. |
Custom-report-template |
gen_normalized_log |
Generate a log file that excludes volatile information that can vary from run to run, such as time related information. |
Log |
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. |
HTML-progress-report |
gen_html_report |
Generate the HTML lint report. |
HTML-report |
gen_rulepool_doc |
Generate the HTML documentation with all available rules. |
Doc |
gen_rulepool_xml |
Generate the XML ruleset with all available rules. |
XML |
gen_ruleset_doc |
Generate the HTML documentation with all the rules from the specified ruleset. |
Doc |
gen_ruleset_xml |
Generate the XML ruleset with all the rules from the specified predefined ruleset. |
XML |
gen_txt_report |
Print lint failures in the Verissimo output. |
Text-report |
gui |
Run Verissimo in GUI mode. By default Verissimo will be run in the DVT IDE for Eclipse. |
DVT-IDE |
heap_size <size> |
Set the Java heap size. Default is 3072m. |
Java |
help |
Print help and exit. |
Help |
histogram_dump_rules <rule names> |
Comma separated list of rule names for which histogram dumps will be generated. |
Lint |
html_report_location |
Destination directory for the HTML lint report. Default value: current directory. |
HTML-report |
ignore_build_config_errors |
Ignore build configuration errors. |
Compilation |
ignore_compile_errors |
Ignore compile errors, disable printing of compilation errors and continue with linting. |
Compilation |
ignore_lint_errors |
Ignore lint errors and disable printing of lint errors. |
Lint |
ignore_lint_infos |
Ignore lint infos and disable printing of lint infos. |
Lint |
ignore_lint_warnings |
Ignore lint warnings and disable printing of lint warnings. |
Lint |
include_code_date |
Include the committer date in the generated lint report. |
HTML-report-common |
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. |
HTML-report-common |
include_html_code |
Include the linted source code as HTML files in the generated lint report. |
HTML-report-common |
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. |
HTML-report-common |
lang <language> |
Enable support for the specified language. Only used to export the mixed design hierarchy. Available values: vlog, vhdl. Default value: vlog. |
Compilation |
license_queue_timeout <timeout> |
Maximum time in seconds to wait in queue for a license when one is not available. |
License |
list_unused_available_rules |
List available rules not used in current ruleset. |
List-unused-available-rules |
log <log file> |
Log to specified file. |
Log |
manual_checks_status <XML file> |
Manual checks status file. |
Lint |
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. |
HTML-compare-report |
merge <dir> |
Directory of the HTML report to be merged with other reports specified by subsequent ‘merge’ arguments. Must be repeated. |
HTML-merge-report |
noexit |
Do not exit until DVT IDE is closed. Only use when -gui or -vscode is specified. Not supported on Windows. |
DVT-IDE |
non_standard |
Run the Non-Standard ruleset. |
Ruleset |
normalized_log_location <dir> |
Destination directory for the normalized log file. Default value: current directory. |
Log |
open_report <dir> |
Specify the HTML report location to open in DVT IDE. |
HTML-open-report |
ovm |
Run Verissimo XVM rules as OVM. If not specified -uvm will be used. |
Ruleset |
parent_folder <dir> |
Directory that contains HTML reports which are used to generate the HTML Progress Report. |
HTML-progress-report |
performance |
Run the Performance Rules ruleset. |
Ruleset |
prewaive_unchanged_files |
Pre-waives the unchanged files based on the baseline report. |
HTML-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”. |
Compilation |
print_compile_waivers_info |
Prints how many problems each compile waiver has matched. |
Compilation |
process_timeout <seconds> |
Set the timeout value of the complete linting process, including building. |
Lint |
progress_name <name> |
Customize the name of the generated HTML Progress Report. |
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. |
DVT-IDE |
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. |
DVT-IDE |
report_folder <dir> |
Name of the HTML report directory used to generate the HTML Progress Report. Can be repeated. |
HTML-progress-report |
rtl |
Run the RTL Rules ruleset. |
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. |
XML |
ruleset <XML file> |
Set the XML ruleset file. Default value: Basic Rules ruleset. See Rulesets. |
Ruleset |
ruleset_editor |
Generate the Ruleset Editor. The Ruleset Editor is a HTML file which can be opened in Eclipse, VS Code or any browser. |
Ruleset-editor |
run_rule <rule name> |
Use only the rule with the given rule name from specified ruleset. Can be repeated. |
Ruleset-filter |
session_timeout <seconds> |
Set the timeout value of the linting session, without building. |
Lint |
silent |
Turn on minimal output. |
Silent |
since <yyyy-MM-dd / MM.M.m> |
Use only rules added since date yyyy-MM-dd or since version MM.M.m. |
Ruleset-filter |
label <labels> |
Use only rules annotated with the specified labels. |
Ruleset-filter |
stack_size <size> |
Set the Java thread stack size. Default is 4m. |
Java |
thread_dump_interval <milliseconds> |
Set the interval of thread dumps for a rule. Default value: 200ms. Only use when -thread_dump_rules is specified. |
Lint |
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. |
Lint |
thread_dump_rules <rule names> |
Comma separated list of rule names for which thread dumps will be generated. |
Lint |
uvm |
Run Verissimo XVM rules as UVM. |
Ruleset |
uvm_ieee |
Run the UVM IEEE 1800.2-2020 Compliance Rules ruleset. |
Ruleset |
version |
Print version and exit. |
Version |
vscode |
Run Verissimo in the DVT IDE for VS Code. |
DVT-IDE |
waivers <XML file> |
XML waivers file. See Lint Waivers. |
Lint |
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. |
DVT-IDE |
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). |
Exit-code |