DVT IDE for VS Code VHDL User Guide
Rev. 24.1.5, 13 March 2024

Chapter 28. SCM Checkout Hook

You can instruct DVT to perform some actions on any read-only file that gets modified by direct editing or by refactoring:

  1. Create a checkout hook binary named "dvt_checkout_hook*" in the .dvt directory. To customize the location of the binary file, use the "Checkout Hook Binary" preference from File > Preferences > Settings > Extensions > DVT > SCM.

  2. In the newly created binary, add any command you wish to be performed on the read-only files that get modified.

  3. Simply start to modify a read-only file and it will get triggered automatically. Also, you can disable the checkout confirmation by enabling the "Automatically Checkout Files" preference from File > Preferences > Settings > Extensions > DVT > SCM.

  4. Also, you can use the "Checkout Hook Working Directory" preference to customize the working directory of the checkout hook. If this is not specified, it defaults to the project location.