Migrating Vitis Classic IDE Graph Applications to Vitis Unified IDE - 2024.2 English

Migrating Vitis Classic IDE Graph Applications to Vitis Unified IDE - 2024.2 English - UG1702

Vitis Reference Guide (UG1702)

Document ID

UG1702

Release Date

2025-01-15

Version

2024.2 English

Classic Vitis IDE workspaces cannot be opened directly in the Vitis Unified IDE. The classic IDE provides an utility to enable moving a project or workspace into the Vitis Unified IDE. To use this utility, first launch the Vitis classic IDE in the workspace with the following command:

vitis --classic -workspace <workspace>

After Vitis IDE opens the workspace, use the Vitis > Export Workspace to Unified IDE command from the main menu. The tool opens a dialog box listing the projects contained in the workspace, and prompts you for a new workspace to export the projects to. Specify the new workspace location and click Finish. The tool will generate a Python migration script (migrate.py) and write it to the specified workspace folder.

Tip: The Workspace location specified for the export script must be a new empty workspace. If you want to make changes to the classic IDE project and re-export it, you must start with a clean export workspace, without any hidden files.

Note: The migration utility is created to help you speed up the procedure, but you can also recreate the workspace in the Vitis Unified IDE from scratch for migration. The migration utility does not consider all the corner cases and can encounter issues for complex designs.

Figure 1. Export to Vitis Unified IDE

After generating the migration script, a pop-up window will display the location of the script. You will need to run the script in the Vitis Unified IDE by using the vitis -s <script> form of the command as described in Launch Options in the Vitis Reference Guide (UG1702).

vitis -s migrate.py

Table 1. Supported Project Types
Project Type	Limitation	Workaround
Embedded Platforms	Local changes to BSP sources will not be migrated to the new workspace. A new BSP will be created, and the settings are applied on the new BSP.	Copy the sources to the new BSP manually.
	Any embedded software repositories added to the Vitis IDE will not be migrated. A warning is displayed in the wizard if the project has any local SW repos.	All software repositories need to be migrated to lopper first. Refer to Vitis Unified Software Platform Documentation: Embedded Software Development (UG1400) for more information. The path to the migrated repository can be manually added to the migration script prior to running the script.
	IP drivers included in XSAs created with 2023.1 or older releases will not work.	Need to regenerate the XSA.
Embedded Software Applications	Applications referring to platforms that are outside the current workspace cannot be migrated.	Migrate the platform first and update the application to use the new platform before migrating the application.
HW Link	Hardware linker options defined using the Extra V++ command line options will not be migrated through the script.	You will need to manually define these options in the hw_link.cfg for the System project
Accelerated Host applications	Only compile definitions (-D), include path (-I), library paths (-L) and libraries (-l) are migrated for accelerated host applications.	Any other compiler or linker settings from the C/C++ build settings window will need to be set manually in the Application component.