DVT VHDL IDE User Guide
Rev. 18.1.1, 23 February 2018

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. default.build
4.2. Auto-config
4.3. Emulating compiler invocations
4.4. Multiple .build Files
4.5. Compatibility Modes
4.5.1. Default DVT Compatibility Mode
4.5.2. vcs.vlogan Compatibility Mode
4.5.3. vcs.vhdlan Compatibility Mode
4.5.4. ius.irun Compatibility Mode
4.5.5. questa.vlog Compatibility Mode
4.5.6. questa.vcom Compatibility Mode
4.5.7. gcc Compatibility Mode
4.6. Paths
4.7. Strings
4.8. Comments
4.9. Environment Variables
4.10. Including Other Argument Files
4.11. Build Persistence
4.12. DVT Auto-Linked
4.13. Run a Script Before Build
4.14. All Build Directives
4.15. e Language Test Files
4.16. e Language SPECMAN_PATH
4.17. SystemVerilog OVM or UVM Library Compilation
4.18. Xilinx 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. Content Filters Examples
8.3. 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. External
13. Component Automatic Instantiation
13.1. Autoinstance Using Autocomplete
13.2. Autoinstance Using Drag and Drop
14. Semantic Search
15. Search for References (Usages)
16. Quick Search in Views
16.1. CamelCase
16.2. Simple Regex
16.3. Hierarchical Search
16.4. Search for Members
16.5. Search Port in Design Hierarchy
17. Trace Connections
17.1. Trace Connections from Design Hierarchy
17.2. Trace Connections from Editor
17.3. Trace Connections View
17.4. Trace Path
18. Breadcrumb Navigation Bar
19. Code Factory
20. Refactoring
20.1. Rename Refactoring
20.2. Add New Port to Entity
20.3. Add New Generic to Entity
20.4. Connect Instances Across the Design Hierarchy
20.4.1. Connect Instances Using New Ports
20.4.2. Preview Structural Changes in the Design Hierarchy
20.4.3. Connect Instances Toolbar
21. Diagrams
21.1. Design Diagrams
21.1.1. Schematic Diagrams
21.1.2. Flow Diagrams
21.1.3. Block Diagrams
21.1.4. Finite-State Machine Diagrams
21.1.5. Diagram Filters
21.1.6. Select Instances
21.1.7. Breadcrumb Navigation Bar
21.1.8. Low Power Format Support
21.2. Diagram Actions
21.3. Diagram Toolbar
22. Low Power Format Support
23. Export HTML Documentation
23.1. Export HTML Documentation Wizard
23.2. Comments Formatting
23.2.1. JavaDoc
23.2.2. NaturalDocs
23.3. Customizing Documentation
24. External Tools Integration
24.1. Run Configurations
24.1.1. Run Configuration Session Type
24.1.2. Custom Shortcut and Button for a Run Configuration
24.1.3. Using environment variables in DVT Generic Run Configurations
24.1.4. Using an alias in a DVT Generic Run Configuration
24.1.5. DVT Generic Run Configuration Variables
24.2. Smart Log
24.2.1. Smart Log - Filters
24.2.2. Smart Log - Hyperlinks
24.2.3. Smart Log - Styles
24.3. External Builders
24.3.1. How to define a new external builder
24.3.2. How to invoke external builders
24.3.3. External Builder Output
24.3.4. Source Code Markers - errors warnings
25. Debugger Integration
25.1. Simulation Prerequisites
25.2. Launch a Debug Simulation
25.3. Connect to an Existing Simulation
25.4. Breakpoints
25.5. Threads, Call Stack, Stepping
25.6. Variables
25.7. Watch Expressions
25.8. Debug Specific Configurations
26. Custom Dialogs
26.1. Quick Steps
26.2. Customizing the Dialog Output
26.3. SWT/XML Reference
26.3.1. Layouts
26.3.2. Widgets
26.4. Custom Dialog Snapshots
26.4.1. Custom Dialog Snapshots File Syntax (XML)
27. Command Line Interface
27.1. dvt_cli.sh
27.2. Syntax
27.3. Notes
27.4. Examples
27.5. Makefile Example
27.6. Commands
27.6.1. Create a Project (Mixed-Language Capable)
27.6.2. Create a Project From an Existing Template
27.6.3. Import an Existing Project
27.6.4. List Compiled Files
27.6.5. Launch a Run Configuration
27.6.6. Open a File
27.6.7. Close a File
27.6.8. Open a Custom Dialog
27.6.9. Refresh a project
27.6.10. Quit
27.6.11. Query the running status
27.6.12. Print version
28. Reminders (TODO Markers)
29. Settings Management
29.1. Managed Settings
29.2. Unmanaged Settings
29.3. User and Common Settings Location
29.4. Use Cases
29.4.1. Memory Allocation Thresholds
29.4.2. Workspace Preferences
29.4.3. Run Configurations
29.4.4. Compile Waivers
29.4.5. Content Filters
29.4.6. External Builders
29.4.7. Export HTML Documentation
29.5. Examples
29.6. Deprecated Settings Management (before DVT 3.5)
29.6.1. Workspace Settings
29.6.2. Project Settings
29.6.3. Other Settings
29.6.4. Importing Preferences From a Different Workspace
29.6.5. Customizing Default Settings Using dvt.ini
30. Reference
30.1. Common Shortcuts
30.2. Editor Right Click Menu
30.2.1. Folding
30.2.2. Source
30.2.3. Code Factory
30.2.4. Show
30.2.5. References
30.2.6. Trace
30.2.7. Refactor
30.3. Hyperlinks
30.4. Icons and Decorations
30.4.1. Icons
30.4.2. Decorations
30.4.3. Changing Icon Colors
30.4.4. Project Colors
30.5. Scripts
30.5.1. dvt.sh
30.5.2. dvt_cli.sh
30.5.3. dvt_kit_installer.sh
30.5.4. dvt_plugin_installer.sh
30.6. Syntax Coloring
30.7. Toolbar Actions
30.8. Tooltips
30.9. Views
30.9.1. Code Templates View
30.9.2. Compile Order View
30.9.3. Console View
30.9.4. Design Hierarchy View
30.9.5. Inspect View
30.9.6. Layers View
30.9.7. Outline View
30.9.8. Problems View
30.9.9. Tasks View
30.9.10. Trace Connections View
30.9.11. Types View
31. Application Notes
31.1. FPGA Support
31.1.1. Intel(Altera) Quartus
31.1.2. Xilinx ISE/Vivado
31.2. OSVVM Support
31.3. UVVM Support
32. Tips and Tricks
33. Q & A
33.1. I am new to Eclipse, where should I start from?
33.2. Where can I find DVT Help?
33.3. How do I see and configure the key shortcuts?
33.4. Are there any backup files in Eclipse?
33.5. Workspace in use, cannot launch eclipse...
33.6. Locking is not possible in the directory...
33.7. How to start DVT Eclipse with a different eclipse.ini
33.8. Save could not be completed
33.9. IBM Clearcase Plugin
33.10. DVT is crashing with "Problematic frame ld-linux-x86-64.so.2 _dl_rtld_di_serinfo
33.11. libxul.so undefined symbol
33.12. How to use Working Sets for filtering Problems/Task/Search views?
33.13. How can I do an incremental textual search in any view?
33.14. How do I Access Files Outside Project Dir - Working with Linked Resources
33.15. Mapping Linux to Windows (/proj/ to Z:\proj\)
33.16. Subversive vs Subclipse
33.17. How do I associate a project with both DVT and CDT?
33.18. Can I use vi/vim along with DVT?
33.19. Can I perform dos2unix or unix2dos from DVT?
33.20. How can I configure Eclipse to use a local CVS repository?
33.21. I am using the Common Desktop Environment via Citrix and experiencing crashes. What can I do?
33.22. How do I change the background color of the Editor?
33.23. How do I change the color of the interface?
33.24. How to apply the dark color theme or other themes?
33.25. How do I change the tooltip colors?
33.26. How do I change Internet Proxy Settings?
33.27. Eclipse does not start, there is no Workspace, metadata or log file created
33.28. Workspace permissions
33.29. How to install our server as a service in Windows?
33.30. How do I link mylyn with Bugzilla?
33.31. How do I print source code?
33.32. How do I disable Eclipse Software Sites?
33.33. How do I revert to a previous version?
33.34. What are the most common shortcuts in DVT?
33.35. How does DVT integrate with CVS?
33.36. How to set an environment variable within a Run Configuration?
33.37. How to run a remote Unix command from DVT Eclipse for Windows?
33.38. Rebuild shortcut (Ctrl + Alt + R) does not work
33.39. Sometimes I experience DVT GUI hangs, what should I do?
33.40. Sometimes I experience DVT GUI hangs when switching from another X application to DVT
33.41. I want to use an alias in a DVT Generic Run Configuration, but it's not recognized
33.42. How to set multiple paths as sources of predefined projects ?
33.43. Lines are suddenly changing indentation when I edit text or move the cursor through the editor.
33.44. How to change the directory where the build log file is saved ?
33.45. How to find the DVT logs on Linux/Unix ?
33.46. How to create resource filters ?
33.47. How to create custom shortcut and button for a Run Configuration?
33.48. I know that file.foo is present in the project location, but I can't see it in the Navigator View
33.49. How to copy the full path to the file in the current editor?
33.50. How to adjust the console logs filters matching parameters?
33.51. When I switch to Block (Column) Selection mode the font changes
33.52. In Block (Column) Selection mode I see strange editng artifacts
33.53. How to modify the font size in the code editors?
33.54. How to automatically checkout/lock files from the revision control system ?
33.55. How can I see if a file is read-only?
33.56. How can I open a file in DVT from the terminal?
33.57. How do I change the name of the xterm opened by a DVT Generic Run Configuration?
34. What is New?
35. How to Report an Issue?
36. Legal Notices
37. Third Party Licenses