write_messages - 2024.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
Release Date
2024.1 English

Write Vivado messages to the specified file.


write_messages [‑severity <args>] [‑force] [‑message_db <arg>]
    [‑suppression <arg>] [‑modified_severity <arg>] [‑quiet] [‑verbose]


Name Description
[-severity] Message severity list to query, e.g. "ERROR", "CRITICAL WARNING", "WARNING", "INFO", "STATUS", "ALL" or "OUTPUT".
[-force] Overwrite existing file.
[-message_db] Message source file name, e.g. xst.xmsgs, rds.pb.
[-suppression] Write suppressed messages, e.g. "SUPPRESSED", "UNSUPPRESSED", "ALL". SUPPRESSED : Write only suppressed messages. UNSUPPRESSED : Write unsuppressed messages. ALL : Write both suppressed and unsuppressed messages. Default: ALL
[-modified_severity] Write modified Severity messages, e.g. "MODIFIED", "UNMODIFIED", "ALL". MODIFIED : Write only changed severity messages. UNMODIFIED : Write unchanged severity messages. ALL : Write both changed and unchanged severity messages. Default: ALL
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
[<file>] Filename to output result to.




The write_messages command writes messages to the specified file. The command returns the name of the output file or an error.


-severity - (Optional) Message severity list to query, for example, ERROR, CRITICAL, CRITICAL WARNING, WARNING, INFO, STATUS, ALL, OR OUTPUT.


  • All: Reports all messages with severities ERROR, CRITICAL WARNING, WARNING, INFO, AND STATUS
  • OUTPUT: Reports all the message types which are reported in the vivado.log file.

Default value is : All

-message_db - (Optional) Message source file name, for example, xst.xmsgs or rds.pb.

-suppression - (Optional) Write suppressed messages, for example, SUPPRESSED, UNSUPPRESSED, ALL.
  • SUPPRESSED : Write only suppressed messages
  • UNSUPPRESSED : Write unsuppressed messages
  • ALL : Write both suppressed and unsuppressed messages
  • Default: No
-modified_severity - (Optional) Write modified severity messages, for example, MODIFIED, UNMODIFIED, ALL.
  • MODIFIED: Write only changed severity messages
  • UNMODIFIED : Write unchanged severity messages
  • ALL: Write both changed and unchanged severity messages
  • Default: Both

-force - (Optional) Overwrites an existing file if one exists. If this option is not specified, then the AMD Vivado™ Design Suite does not overwrite an existing file.

<file> - (Required) Specify the name of the memory info file to write. The file can include the path and file extension.
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.
-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.


The following example writes the suppressed messages to the suppressed.log file.
write_messages -suppression SUPPRESSED -file suppressed.log -force