Intel® Quartus® Prime Pro Edition User Guide: Scripting

ID 683432
Date 12/04/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

4.1.30.42. qed::sanitize_workspace (::quartus::qed)

The following table displays information for the qed::sanitize_workspace Tcl command:

Tcl Package and Version

Belongs to ::quartus::qed

Syntax qed::sanitize_workspace [-h | -help] [-long_help]
Arguments -h | -help Short help
  -long_help Long help with examples and possible return values
Description
Runs a variety of checks on projects and project groups to ensure
they are in a "clean" state.

After you run the "qed::sanitize_workspace" command, the following
conditions will be true:

* Every project will be part of at least one project group. If you have
    not created a project group, a default project group is created.
* If any project objects exist in the workspace, at least one
    project group will exist. If you have not created a project group
    object, a default project group will be created.
* No empty project groups will exist. Any project group that does not
    contain any projects will be deleted.

You should use the "qed::sanitize_workspace" command after you add
projects to the workspace, create a project group, edit properties of
projects or project groups, or delete objects.
Example Usage
    qed::sanitize_workspace
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful