Versioning and Revision Control - 2024.1 English

Vivado Design Suite User Guide: Creating and Packaging Custom IP (UG1118)

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

Custom IP created by the IP packager contains a field for the version. The version information is set in the Identification page of the Package IP window, see Packaging IP.

A major#.minor# numbering scheme unifies the IP version numbers, and a revision number field distinguishes slight changes in the same version. For more information, see the IP Versioning page available from the AMD website.

Each time the IP is re-packaged, if the version is not changed, the IP packager increments the revision number automatically. The Vivado IP catalog supports only a single version of an AMD-created IP per release; however, custom IP is not required to adhere to this behavior.

A custom IP can have multiple versions available in the IP catalog, and you can select any available version. You can also upgrade the currently used version of a custom IP to the latest available version.

Important: The IP packager does not automatically archive and save previous versions of custom IP. Each time the IP is re-packaged, the IP location overwrites the data with the newer version of the IP.

To save a specific version of your IP prior to re-packaging, the recommended flow is to manually copy the packaged IP directory contents to a new location. The IP catalog can point to this new location to ensure the catalog can show both the original and updated version of the custom IP.

For more information on setting the custom IP location, see The Create and Package New IP Wizard.

When using revision control with your custom IP definition, the recommendation is to use an external repository location for your custom IP. By default, the Create and Package New IP wizard chooses a location relative to the project source files. By selecting a location outside of the project, the custom IP is separated from the project structure. Placing the project structure into revision control is not recommended. For more information on setting the custom IP location, see the The Create and Package New IP Wizard.

Video: Review the Vivado Design Suite QuickTake Video: Vivado Design Suite Revision Control. For more information about revision or source control in the Vivado Design Suite, see the Vivado Design Suite User Guide: Design Flows Overview (UG892).