Script-based Revision Control Methodology - Script-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

Follow these steps to revision control a project using a script-based method:

  1. Keep your source files external to the project. Ideally, store them outside the Vivado build directory.
  2. Use revision control to manage the source repository. Ensure all sources are tracked by the revision control system.
    Important: When Vivado uses these files, keep them writable.
  3. Generate a script that recreates your design.
  4. Place the script under revision control. Update it whenever the design changes to include new sources or capture updated configurations. Manage it like any other design source.
  5. Test your methodology regularly. Rebuild the design from source files using the script to ensure completeness. Frequent rebuilds help you detect and fix revision control issues quickly.