terminate_runs - 2024.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

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

Terminate the runs

Syntax

terminate_runs [‑quiet] [‑verbose] <runs>...

Usage

Name Description
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
<runs> Runs to terminate

Categories

Project

Description

  • Terminates specified run(s).
  • It does not delete any files/directories under the Run directory.
  • The run's state changes to error (user canceled).

Arguments

<runs> - (Required) The name of the run(s) to be terminated.

-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

The following example terminates the implementation run impl_1.

terminate_runs impl_1 

Note: The Run directory and its contents will not be removed from the file system. Run state will change to error state.

The following example terminates the implementation runs impl_1 and impl_2.

terminate_runs impl_1 impl_2

Note: Once a run is terminated, it has to be reset first before it can be re-launched. To relaunch a terminated run impl_1.

The following example terminates the impl_1 run, then resets and launches the run.

terminate_runs impl_1
reset_runs impl_1
launch_runs impl_1