generate_reports - 2024.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

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

Generate a set of configurable report objects

Syntax

generate_reports [‑jobs <arg>] [‑quiet] [‑verbose] <report_configs>...

Usage

Name Description
[-jobs] Number of jobs Default: 1
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
<report_configs> List of configurable report objects to generate

Categories

Object, Report

Description

Generates specified report objects as created by the create_report_config command.

Because the report objects are associated with specific steps of synthesis or implementation runs, those steps must be completed prior to the generation of the report. If a step is not completed, or the report is not enabled, then the generate_report command will return an error.

Arguments

-jobs <arg> - (Optional) Specifies the number of jobs to use to generate the specified report objects.

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

<report_configs> - (Required) Specifies the list of report objects to generate. The reports must be specified as objects returned by the get_report_configs command.

Examples

The following example generates the specified report object:

generate_report [get_report_configs post_route_datasheet]
Tip: If the report is already GENERATED according to the STATE property, the report will not be regenerated.