Intel® Quartus® Prime Pro Edition User Guide: Scripting

ID 683432
Date 10/04/2021
Public

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

Document Table of Contents

3.1.24.35. project_clean (::quartus::project)

The following table displays information for the project_clean Tcl command:

Tcl Package and Version

Belongs to ::quartus::project

Syntax project_clean [-h | -help] [-long_help] [-current_version] [-revision <revision_name> ]
Arguments -h | -help Short help
-long_help Long help with examples and possible return values
-current_version Only clean project files for the current Quartus version.
-revision <revision_name> Revision to clean (if omitted, all revisions of the open project are cleaned). Revision name can contain wildcards (i.e., '*').
Description

Cleans database and compiler-generated output for the specified revision (or all revisions if no revision is specified). Cleaning revisions removes database and other files generated by the Quartus Prime software, including report and programming files. This command closes the currently open project before cleaning. Specifically, this cleans all of the following files/folders (for all matching revisions): <revision>.*.rpt <revision>.*.rpt.htm <revision>.*.rpt.htm_files <revision>.*.msf <revision>.*.smsg <revision>.*.summary <revision>.jdi <revision>.pin <revision>.pof <revision>.sof <revision>.done <revision>.sld (all revision files in the qdb and persona directories)

Example Usage
project_clean -revision "foo"   # Cleans revision "foo"
project_clean -revision "foo*"  # Cleans all revisions starting with "foo" (e.g., "foo", "foobar")
project_clean                         # Cleans all revisions in project
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful
TCL_ERROR 1 ERROR: Failed when attempting to remove database files in <string> for revision <string>.
TCL_ERROR 1 ERROR: Failed when attempting to remove file <string> for revision <string>.
TCL_ERROR 1 ERROR: Couldn't delete file or folder named '<string>'.
TCL_ERROR 1 ERROR: Couldn't open configuration settings...the settings object is currently locked.
TCL_ERROR 1 ERROR: Can't access revision '<string>'. The revision may not exist, or there may be an error in the revision settings.
TCL_ERROR 1 ERROR: You must open a project before you can use this command.

Did you find the information on this page useful?

Characters remaining:

Feedback Message