report_waivers - 2024.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
UG835
Release Date
2024-05-30
Version
2024.1 English

Report status of DRC/METHODOLOGY/CDC/LINT message waivers

Syntax

report_waivers [‑file <arg>] [‑type <arg>] [‑write_valid_waivers]
    [‑write_ignored_waivers] [‑append] [‑return_string]
    [‑show_msgs_with_no_waivers] [‑quiet] [‑verbose]

Usage

Name Description
[-file] Name of file to report waivers
[-type] Type of waiver - ALL, DRC, METHODOLOGY, CDC, LINT
[-write_valid_waivers] (special) Specifies writing out the specific waivers which were used in the last report_drc/methodology/cdc/lint run(s)
[-write_ignored_waivers] (special) Specifies writing out the specific waivers which were NOT used in the last report_drc/methodology/cdc/lint run(s)
[-append] Append the current report results to the file specified with -file
[-return_string] Return report results as a string object
[-show_msgs_with_no_waivers] Also list report_drc/methodology/cdc/lint messages which have no defined waivers
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution

Categories

Waiver, Report, Object

Description

Reports DRC, METHODOLOGY, and CDC violation messages and displays what waivers are in place in the current design.

In addition, the report_drc, report_methodology, and report_cdc commands have options to run the reports on waived violations or checks.

Arguments

-file <arg> - (Optional) Write the waivers report into the specified file. The specified file will be overwritten if one already exists.

Note: If the path is not specified as part of the file name, the file will be written into the current working directory, or the directory from which the tool was launched.

-type <arg> - (Optional) Specifies the type of waiver to report. Currently supports DRC, METHODOLOGY, and CDC. If the -type is not specified, all waivers will be reported.

-write_valid_waivers <arg> - (Optional) This option requires the use of the -file option, and writes the valid waivers that were used during the last run of the DRC, methodology, or CDC reports.

-write_ignored_waivers <arg> - (Optional) This option requires the use of the -file option, and writes the waivers that were NOT used during the last run of the DRC, methodology, or CDC reports.

-append - (Optional) Append the output of the report to the specified file rather than overwriting it.

Note: The -append option can only be used with the -file option.

-return_string - (Optional) Directs the report output to a Tcl string rather than to the standard output. The Tcl string can be captured by a variable definition and parsed or otherwise processed.

Note: This argument cannot be used with the -file option.

-show_msgs_with_no_waivers - (Optional) By default the report_waivers command will hide data for all DRC, METHODOLOGY, and CDC violations, which do not have waivers defined. This options restores the reporting of violation messages which have no defined waivers.

-quiet - (Optional) Execute the command quietly, returning no messages from the command. The command also returns TCL_OK regardless of any errors encountered during execution.
Note: Any errors encountered on the command-line, while launching the command, will be returned. Only errors occurring inside the command will be trapped.
-verbose - (Optional) Temporarily override any message limits and return all messages from this command.
Note: Message limits can be defined with the set_msg_config command.

Examples

This example reports all waivers in the current design:

report_waivers