Source-based Revision Control Methodology - Source-based Revision Control Methodology - 2026.1 English - UG892

Vivado Design Suite User Guide: Design Flows Overview (UG892)

Document ID
UG892
Release Date
2026-06-23
Version
2026.1 English

The source-based method preserves a Vivado project by separating project sources from generated output products. Files added to the project reside in the project.srcs directory. Tool-generated output products reside in a parallel project.gen directory.

Follow this revision control methodology:

  • Keep source files external to the project, ideally outside the Vivado build directory.
  • Manage revision control of the source repository. All sources are tracked by the revision control system.
    Important: Ensure source files are writable when Vivado uses them.
  • Manage revision control of the project.xpr file and the project.srcs directory.
  • Test your methodology regularly by rebuilding the design from sources using a script to catch revision control issues early.
Note: Before 2020.2, generated files coexisted in the project.srcs directory. You can re-created a project by restoring the project.srcs directory and the project.xpr file. Open the project.xpr file to proceed with synthesis and implementation.