Resets or removes a message control rule previously defined by the set_msg_config command.
Syntax
reset_msg_config [‑string <args>] [‑id <arg>] [‑severity <arg>] [‑limit]
[‑suppress] [‑count] [‑default_severity] [‑regexp] [‑quiet] [‑verbose]
Usage
Name | Description |
---|---|
[-string]
|
A qualifier, only a rule created with a matching string qualifier will be reset/removed Default: empty |
[-id]
|
A qualifier, only a rule created with a matching id qualifier will be reset/removed |
[-severity]
|
A qualifier, only a rule created with a matching severity qualifier will be reset/removed |
[-limit]
|
reset the limit values for message controls that match the given qualifiers for the current project |
[-suppress]
|
stop suppressing messages that match the given qualifiers for the current project |
[-count]
|
reset the count of messages for all message controls that match the given qualifiers for the current project. This will prevent messages from being suppressed by a -limit control until the message count once again exceeds the specified limit. |
[-default_severity]
|
reset the message severity of all messages controls for the current project that match the given qualifiers to their default value |
[-regexp]
|
The values used for -string are full regular expressions |
[-quiet]
|
Ignore command errors |
[-verbose]
|
Suspend message limits during command execution |
Categories
Description
This command restores the default settings of the message limits or severity for messages returned by the Vivado® tool, or can unsuppress previously suppressed messages, as configured by the set_msg_config
command.
You can only perform one reset action for each reset_msg_config
command. An error is returned if more than one action is attempted in a single reset_msg_config
command.
reset_msg_config
command. Multiple qualifiers have an AND relationship; only the messages matching the qualifiers will be reset.
To report the current rule configurations for messages, use the get_msg_config
command.
Arguments
-string
<args> - (Optional) Apply the selected operation only to messages that contain the given list of strings. Strings must be enclosed in braces, and multiple strings can be specified separated by spaces:
{{Vivado} {Synthesis}}
-id <arg>
- (Optional) Reset messages matching the specified message ID. The message ID is included in all returned messages. For example, "Common 17-54" and "Netlist 29-28".
-severity <arg>
- Reset messages with the specified message severity. There are five message severities:
-
ERROR
- An ERROR condition implies an issue has been encountered which will render design results unusable and cannot be resolved without user intervention. -
{CRITICAL WARNING}
- A CRITICAL WARNING message indicates that certain input/constraints will either not be applied or are outside the best practices for a FPGA family. User action is strongly recommended.Note: Since this is a two word value, it must be enclosed in {}. -
WARNING
- A WARNING message indicates that design results may be sub-optimal because constraints or specifications may not be applied as intended. User action may be taken or may be reserved. -
INFO
- An INFO message is the same as a STATUS message, but includes a severity and message ID tag. An INFO message includes a message ID to allow further investigation through answer records if needed. -
STATUS
- A STATUS message communicates general status of the process and feedback to the user regarding design processing. A STATUS message does not include a message ID.
-limit
- (Optional) Reset the message limit for messages matching the string, ID, or severity qualifiers.
-suppress
- (Optional) Reset, or unsuppress messages matching the string, ID, or severity qualifiers.
-count
- (Optional) Reset the message count for messages matching the string, ID, or severity qualifiers.
-default_severity
- (Optional) Restore the default message severity for messages matching the string, ID, or severity qualifiers.
-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.
-verbose
- (Optional) Temporarily override any message limits and return all messages from this command.
set_msg_config
command.Examples
set_msg_config -id "Common 17-81" -new_severity "CRITICAL WARNING"
reset_msg_config -id "Common 17-81" -default_severity
set_msg_config -id "Common 17-361" -severity INFO -new_severity WARNING
get_msg_config -rules
---------------------
Message control rules currently in effect are:
Rule Name Rule Current Message Count
1 set_msg_config -ruleid {1} -id {Common 17-361} -severity {INFO} -new_severity {WARNING} 0
---------------------
reset_msg_config -id "Common 17-361" -default_severity
reset_msg_config -ruleid {1}
reset_msg_config
commands is needed to reset the message.