DVT VHDL IDE User Guide
Rev. 19.1.24, 11 July 2019

DVT VHDL IDE User Guide

Table of Contents

1. Installation Checklist
1.1. Install DVT Using a pre-packed Distribution
1.2. Install DVT Using the Update Site
1.3. Check the DVT License
2. Predefined Projects
3. Getting Started
3.1. What is a Workspace
3.2. What is a Project
3.3. Project Natures
3.4. Workspace and Workbench
3.5. Refresh
3.6. Linked Resources
3.7. Backup and Local History
3.8. Basic Tutorial
3.8.1. Switch to the DVT Perspective
3.8.2. Open a Project
3.8.3. Configure the Build
3.8.4. Build the Project
3.8.5. Inspect the Compilation Errors
3.8.6. See Comments in Tooltips
3.8.7. Use Hyperlinks to Move Around in the Code
3.8.8. Quickly Open a Type (Entity, Architecture)
3.8.9. Quickly Open a File
3.8.10. Quickly Move Inside the Editor
3.8.11. Inspect the Design Hierarchy
3.8.12. Browse Through All the Available Types (Entities, Architectures)
3.8.13. Search for Entities
3.8.14. Use Content Assist (Autocomplete)
3.8.15. Use Code Templates
3.8.16. Use Component Auto Instance
3.8.17. Track Tasks using TODO Markers
3.8.18. Quickly See the Current Scope in the Status Bar
3.8.19. Fold Code Regions in Order to Improve Readability
3.8.20. Access the Context Sensitive Help
4. Build Configurations
4.1. Non-top files
4.2. default.build
4.3. Auto-config
4.4. Emulating compiler invocations
4.5. Multiple .build Files
4.6. Compatibility Modes
4.6.1. Default DVT Compatibility Mode
4.6.2. vcs.vlogan Compatibility Mode
4.6.3. vcs.vhdlan Compatibility Mode
4.6.4. ius.irun Compatibility Mode
4.6.5. ius.perspec Compatibility Mode
4.6.6. questa.vlog Compatibility Mode
4.6.7. questa.vcom Compatibility Mode
4.6.8. gcc Compatibility Mode
4.7. Paths
4.8. Strings
4.9. Comments
4.10. Environment Variables
4.11. Including Other Argument Files
4.12. Build Persistence
4.13. DVT Auto-Linked
4.14. Run a Script Before Build
4.15. All Build Directives
4.16. e Language Test Files
4.17. e Language SPECMAN_PATH
4.18. SystemVerilog OVM or UVM Library Compilation
4.19. Xilinx Libraries Compilation
4.20. Intel(Altera) Quartus Libraries Compilation
5. Compile Checks
5.1. Compile Waivers
5.2. Semantic Checks
5.3. Naming Conventions Checking
5.4. Non Standard Checks
6. Content Assist (Autocomplete)
6.1. Content assist for CamelCase and Underscore
6.2. Component Automatic Instantiation
6.3. Code Templates
6.4. Generate Case Statement Using Autocomplete
7. Quick Fix Proposals
7.1. Add Case Choice
7.2. Add Generic to Entity
7.3. Add Port
7.4. Add Signal to Sensitivity List
7.5. Correct Spelling In Comments and Strings
7.6. Create File From Build Config Editor
7.7. Declare Enum Value
7.8. Declare Variable
7.9. Did You Mean
7.10. Fully Qualify Type
7.11. Import Type
7.12. Replace Deprecated Package
7.13. Remove Library Clause
7.14. Remove Signal from Sensitivity List
7.15. Remove Signal Never Used
7.16. Update Entity Instance
7.17. Waive Compilation Problems
8. Content Filters
8.1. Content Filters XML syntax
8.2. Filtering by element type
8.3. Content Filters Examples
8.4. Predefined Content Filters
9. Code Templates
9.1. Code Templates in Autocomplete
9.2. Global Code Templates
9.3. Project Level Code Templates
9.4. Code Templates View
10. File Templates
11. Project Templates
11.1. What is a project template?
11.2. How to generate code from a project template
11.2.1. Step 1. Specify Directories
11.2.2. Step 2. Specify Parameters
11.3. template.config
11.4. Add from Template
12. Code Formatting
12.1. Capitalization
12.2. Whitespace
12.3. Indentation
12.4. Vertical Alignment
12.5. Line Wrapping
12.6. Disable Format for Code Sections
12.7. Format Multiple Files
12.8. External
13. Component Automatic Instantiation
13.1. Autoinstance Using Autocomplete
13.2. Autoinstance Using Drag and Drop
14. Semantic Search
15. Show Usages, Readers or Writers
16. Show Instances
17. Quick Search in Views
17.1. CamelCase
17.2. Simple Regex
17.3. Hierarchical Search
17.4. Search for Members
17.5. Search Port in Design Hierarchy
18. Trace Connections
18.1. Trace Connections from Design Hierarchy
18.2. Trace Connections from Editor
18.3. Trace Connections View
18.4. Trace Path
19. Breadcrumb Navigation Bar
19.1. Design Breadcrumb
19.2. Scope Breadcrumb
20. Code Factory
21. Refactoring
21.1. Rename Refactoring
21.2. Extract to Variable
21.3. Add New Port to Entity
21.4. Add New Generic to Entity
21.5. Connect Instances Across the Design Hierarchy
21.5.1. Connect Instances Using New Ports
21.5.2. Preview Structural Changes in the Design Hierarchy
21.5.3. Connect Instances Toolbar
22. Diagrams
22.1. Design Diagrams
22.1.1. Schematic Diagrams
22.1.2. Flow Diagrams
22.1.3. Block Diagrams
22.1.4. Finite-State Machine Diagrams
22.1.5. Diagram Filters
22.1.6. Design Diagram Actions
22.1.7. Breadcrumb Navigation Bar
22.1.8. Low Power Format Support
22.2. Diagram Actions
22.3. Diagram Toolbar
23. Low Power Format Support
23.1. Supply Network Diagram
24. Export HTML Documentation
24.1. Export HTML Documentation Wizard
24.2. Comments Formatting
24.2.1. JavaDoc
24.2.2. NaturalDocs
24.3. Customizing Documentation
25. External Tools Integration
25.1. Run Configurations
25.1.1. Run Configuration Session Type
25.1.2. Custom Shortcut and Button for a Run Configuration
25.1.3. Using environment variables in DVT Generic Run Configurations
25.1.4. Using an alias in a DVT Generic Run Configuration
25.1.5. DVT Generic Run Configuration Variables
25.2. Smart Log
25.2.1. Smart Log - Filters
25.2.2. Smart Log - Hyperlinks
25.2.3. Smart Log - Styles
25.3. External Builders
25.3.1. How to define a new external builder
25.3.2. How to invoke external builders
25.3.3. External Builder Output
25.3.4. Source Code Markers - errors warnings
26. Debugger Integration
26.1. Simulation Prerequisites
26.2. Launch a Debug Simulation
26.3. Connect to an Existing Simulation
26.4. Breakpoints
26.5. Threads, Call Stack, Stepping
26.6. Variables
26.7. Watch Expressions
26.8. Debug Specific Configurations
27. Custom Dialogs
27.1. Quick Steps
27.2. Customizing the Dialog Output
27.3. SWT/XML Reference
27.3.1. Layouts
27.3.2. Widgets
27.4. Custom Dialog Snapshots
27.4.1. Custom Dialog Snapshots File Syntax (XML)
28. Command Line Interface
28.1. dvt_cli.sh
28.2. Syntax
28.3. Notes
28.4. Examples
28.5. Makefile Example
28.6. Commands
28.6.1. Create a Project (Mixed-Language Capable)
28.6.2. Create a Project From an Existing Template
28.6.3. Import an Existing Project
28.6.4. List Compiled Files
28.6.5. Compare Files
28.6.6. Launch a Run Configuration
28.6.7. Open a File
28.6.8. Close a File
28.6.9. Open a Custom Dialog
28.6.10. Refresh a Project
28.6.11. Rebuild a Project
28.6.12. Print Edited File
28.6.13. Quit
28.6.14. Query the running status
28.6.15. Print version
29. Reminders (TODO Markers)
30. Settings Management
30.1. Managed Settings
30.2. Unmanaged Settings
30.3. User and Common Settings Location
30.4. Use Cases
30.4.1. Memory Allocation Thresholds
30.4.2. Workspace Preferences
30.4.3. Run Configurations
30.4.4. Compile Waivers
30.4.5. Content Filters
30.4.6. External Builders
30.4.7. Export HTML Documentation
30.4.8. Custom Pragmas
30.5. Examples
30.6. Deprecated Settings Management (before DVT 3.5)
30.6.1. Workspace Settings
30.6.2. Project Settings
30.6.3. Other Settings
30.6.4. Importing Preferences From a Different Workspace
30.6.5. Customizing Default Settings Using dvt.ini
31. Reference
31.1. Common Shortcuts
31.2. Custom Pragmas
31.3. Editor Right Click Menu
31.3.1. Folding
31.3.2. Source
31.3.3. Code Factory
31.3.4. Show
31.3.5. References
31.3.6. Trace
31.3.7. Refactor
31.4. Hyperlinks
31.4.1. Hyperlinks in Comments
31.5. Icons and Decorations
31.5.1. Icons
31.5.2. Decorations
31.5.3. Changing Icon Colors
31.5.4. Project Colors
31.6. Scripts
31.6.1. dvt.sh
31.6.2. dvt_cli.sh
31.6.3. dvt_kit_installer.sh
31.6.4. dvt_plugin_installer.sh
31.7. Syntax Coloring
31.8. Toolbar Actions
31.9. Tooltips
31.10. Views
31.10.1. Code Templates View
31.10.2. Compile Order View
31.10.3. Console View
31.10.4. Design Hierarchy View
31.10.5. Inspect View
31.10.6. Layers View
31.10.7. Outline View
31.10.8. Problems View
31.10.9. Tasks View
31.10.10. Trace Connections View
31.10.11. Types View
32. Application Notes
32.1. C/C++ support
32.2. FPGA Support
32.2.1. Intel(Altera) Quartus
32.2.2. Xilinx ISE/Vivado
32.3. OSVVM Support
32.4. UVVM Support
32.5. Generating External Tool Scripts from the DVT Build Configuration
33. Tips and Tricks
34. Q & A
34.1. I am new to Eclipse, where should I start from?
34.2. Where can I find DVT Help?
34.3. How do I see and configure the key shortcuts?
34.4. Are there any backup files in Eclipse?
34.5. Workspace in use, cannot launch eclipse...
34.6. Locking is not possible in the directory...
34.7. How to start DVT Eclipse with a different eclipse.ini
34.8. Save could not be completed
34.9. IBM Clearcase Plugin
34.10. DVT is crashing with "Problematic frame ld-linux-x86-64.so.2 _dl_rtld_di_serinfo
34.11. libxul.so undefined symbol
34.12. How to use Working Sets for filtering Problems/Task/Search views?
34.13. How do I Access Files Outside Project Dir - Working with Linked Resources
34.14. Mapping Linux to Windows (/proj/ to Z:\proj\)
34.15. Subversive vs Subclipse
34.16. How do I associate a project with both DVT and CDT?
34.17. Can I use vi/vim along with DVT?
34.18. Can I perform dos2unix or unix2dos from DVT?
34.19. How can I configure Eclipse to use a local CVS repository?
34.20. I am using the Common Desktop Environment via Citrix and experiencing crashes. What can I do?
34.21. How do I change the background color of the Editor?
34.22. How to apply the dark color theme or other themes?
34.23. How do I change the tooltip colors?
34.24. How do I change Internet Proxy Settings?
34.25. Eclipse does not start, there is no Workspace, metadata or log file created
34.26. Workspace permissions
34.27. How do I link mylyn with Bugzilla?
34.28. How do I print source code?
34.29. How do I disable Eclipse Software Sites?
34.30. How do I revert to a previous version?
34.31. What are the most common shortcuts in DVT?
34.32. How does DVT integrate with CVS?
34.33. How to set an environment variable within a Run Configuration?
34.34. How to run a remote Unix command from DVT Eclipse for Windows?
34.35. Rebuild shortcut (Ctrl + Alt + R) does not work
34.36. Sometimes I experience DVT GUI hangs, what should I do?
34.37. Sometimes I experience DVT GUI hangs when switching from another X application to DVT
34.38. I want to use an alias in a DVT Generic Run Configuration, but it's not recognized
34.39. How to set multiple paths as sources of predefined projects ?
34.40. Lines are suddenly changing indentation when I edit text or move the cursor through the editor.
34.41. How to change the directory where the build log file is saved ?
34.42. How to find the DVT logs on Linux/Unix ?
34.43. How to create resource filters ?
34.44. How to create custom shortcut and button for a Run Configuration?
34.45. I know that file.foo is present in the project location, but I can't see it in the Navigator View
34.46. How to copy the full path to the file in the current editor?
34.47. How to adjust the console logs filters matching parameters?
34.48. When I switch to Block (Column) Selection mode the font changes
34.49. In Block (Column) Selection mode I see strange editng artifacts
34.50. How to modify the font size in the code editors?
34.51. How to automatically checkout/lock files from the revision control system ?
34.52. How can I see if a file is read-only?
34.53. How can I open a file in DVT from the terminal?
34.54. How can I open a file in DVT from Questa?
34.55. How do I change the name of the xterm opened by a DVT Generic Run Configuration?
35. What is New?
36. How to Report an Issue?
37. Legal Notices
38. Third Party Licenses