DVT VHDL IDE User Guide
Rev. 17.1.35, 17 November 2017

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. Naming Conventions
3.8.19. Quickly See the Current Scope in the Status Bar
3.8.20. Fold Code Regions in Order to Improve Readability
3.8.21. 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.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
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. 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. Code Factory
19. Refactoring
19.1. Rename Refactoring
19.2. Add New Port to Entity
19.3. Add New Generic to Entity
19.4. Connect Instances Across the Design Hierarchy
19.4.1. Connect Instances Using New Ports
19.4.2. Preview Structural Changes in the Design Hierarchy
19.4.3. Connect Instances Toolbar
20. Diagrams
20.1. Design Diagrams
20.1.1. Schematic Diagrams
20.1.2. Flow Diagrams
20.1.3. Block Diagrams
20.1.4. Finite-State Machine Diagrams
20.2. Diagram Actions
20.3. Diagram Toolbar
21. Export HTML Documentation
21.1. Export HTML Documentation Wizard
21.2. Comments Formatting
21.2.1. JavaDoc
21.2.2. NaturalDocs
21.3. Customizing Documentation
22. External Tools Integration
22.1. Run Configurations
22.1.1. Run Configuration Session Type
22.1.2. Custom Shortcut and Button for a Run Configuration
22.1.3. Using environment variables in DVT Generic Run Configurations
22.1.4. Using an alias in a DVT Generic Run Configuration
22.1.5. DVT Generic Run Configuration Variables
22.2. Smart Log
22.2.1. Smart Log - Filters
22.2.2. Smart Log - Hyperlinks
22.2.3. Smart Log - Styles
22.3. External Builders
22.3.1. How to define a new external builder
22.3.2. How to invoke external builders
22.3.3. External Builder Output
22.3.4. Source Code Markers - errors warnings
23. Debugger Integration
23.1. Simulation Prerequisites
23.2. Launch a Debug Simulation
23.3. Connect to an Existing Simulation
23.4. Breakpoints
23.5. Threads, Call Stack, Stepping
23.6. Variables
23.7. Watch Expressions
23.8. Debug Specific Configurations
24. Custom Dialogs
24.1. Quick Steps
24.2. Customizing the Dialog Output
24.3. SWT/XML Reference
24.3.1. Layouts
24.3.2. Widgets
24.4. Custom Dialog Snapshots
24.4.1. Custom Dialog Snapshots File Syntax (XML)
25. Command Line Interface
25.1. dvt_cli.sh
25.2. Syntax
25.3. Notes
25.4. Examples
25.5. Makefile Example
25.6. Commands
25.6.1. Create a Project (Mixed-Language Capable)
25.6.2. Create a Project From an Existing Template
25.6.3. Import an Existing Project
25.6.4. List Compiled Files
25.6.5. Launch a Run Configuration
25.6.6. Open a File
25.6.7. Close a File
25.6.8. Open a Custom Dialog
25.6.9. Refresh a project
25.6.10. Quit
25.6.11. Query the running status
25.6.12. Print version
26. Reminders (TODO Markers)
27. Settings Management
27.1. Managed Settings
27.2. Unmanaged Settings
27.3. User and Common Settings Location
27.4. Use Cases
27.4.1. Memory Allocation Thresholds
27.4.2. Workspace Preferences
27.4.3. Run Configurations
27.4.4. Compile Waivers
27.4.5. Content Filters
27.4.6. External Builders
27.4.7. Export HTML Documentation
27.5. Examples
27.6. Deprecated Settings Management (before DVT 3.5)
27.6.1. Workspace Settings
27.6.2. Project Settings
27.6.3. Other Settings
27.6.4. Importing Preferences From a Different Workspace
27.6.5. Customizing Default Settings Using dvt.ini
28. Reference
28.1. Common Shortcuts
28.2. Editor Right Click Menu
28.2.1. Folding
28.2.2. Source
28.2.3. Code Factory
28.2.4. Show
28.2.5. References
28.2.6. Trace
28.2.7. Refactor
28.3. Hyperlinks
28.4. Icons and Decorations
28.4.1. Icons
28.4.2. Decorations
28.4.3. Changing Icon Colors
28.4.4. Project Colors
28.5. Scripts
28.5.1. dvt.sh
28.5.2. dvt_cli.sh
28.5.3. dvt_kit_installer.sh
28.5.4. dvt_plugin_installer.sh
28.6. Syntax Coloring
28.7. Toolbar Actions
28.8. Tooltips
28.9. Views
28.9.1. Code Templates View
28.9.2. Compile Order View
28.9.3. Console View
28.9.4. Design Hierarchy View
28.9.5. Inspect View
28.9.6. Layers View
28.9.7. Outline View
28.9.8. Problems View
28.9.9. Tasks View
28.9.10. Trace Connections View
28.9.11. Types View
29. Tips and Tricks
30. Q & A
30.1. I am new to Eclipse, where should I start from?
30.2. Where can I find DVT Help?
30.3. How do I see and configure the key shortcuts?
30.4. Are there any backup files in Eclipse?
30.5. Workspace in use, cannot launch eclipse...
30.6. Locking is not possible in the directory...
30.7. How to start DVT Eclipse with a different eclipse.ini
30.8. Save could not be completed
30.9. IBM Clearcase Plugin
30.10. DVT is crashing with "Problematic frame ld-linux-x86-64.so.2 _dl_rtld_di_serinfo
30.11. libxul.so undefined symbol
30.12. How to use Working Sets for filtering Problems/Task/Search views?
30.13. How can I do an incremental textual search in any view?
30.14. How do I Access Files Outside Project Dir - Working with Linked Resources
30.15. Mapping Linux to Windows (/proj/ to Z:\proj\)
30.16. Subversive vs Subclipse
30.17. How do I associate a project with both DVT and CDT?
30.18. Can I use vi/vim along with DVT?
30.19. Can I perform dos2unix or unix2dos from DVT?
30.20. How can I configure Eclipse to use a local CVS repository?
30.21. I am using the Common Desktop Environment via Citrix and experiencing crashes. What can I do?
30.22. How do I change the background color of the Editor?
30.23. How do I change the color of the interface?
30.24. How to apply the dark color theme or other themes?
30.25. How do I change the tooltip colors?
30.26. How do I change Internet Proxy Settings?
30.27. Eclipse does not start, there is no Workspace, metadata or log file created
30.28. Workspace permissions
30.29. How to install our server as a service in Windows?
30.30. How do I link mylyn with Bugzilla?
30.31. How do I print source code?
30.32. How do I disable Eclipse Software Sites?
30.33. How do I revert to a previous version?
30.34. What are the most common shortcuts in DVT?
30.35. How does DVT integrate with CVS?
30.36. How to set an environment variable within a Run Configuration?
30.37. How to run a remote Unix command from DVT Eclipse for Windows?
30.38. Rebuild shortcut (Ctrl + Alt + R) does not work
30.39. Sometimes I experience DVT GUI hangs, what should I do?
30.40. Sometimes I experience DVT GUI hangs when switching from another X application to DVT
30.41. I want to use an alias in a DVT Generic Run Configuration, but it's not recognized
30.42. How to set multiple paths as sources of predefined projects ?
30.43. Lines are suddenly changing indentation when I edit text or move the cursor through the editor.
30.44. How to change the directory where the build log file is saved ?
30.45. How to find the DVT logs on Linux/Unix ?
30.46. How to create resource filters ?
30.47. How to create custom shortcut and button for a Run Configuration?
30.48. I know that file.foo is present in the project location, but I can't see it in the Navigator View
30.49. How to copy the full path to the file in the current editor?
30.50. How to adjust the console logs filters matching parameters?
30.51. When I switch to Block (Column) Selection mode the font changes
30.52. In Block (Column) Selection mode I see strange editng artifacts
30.53. How to modify the font size in the code editors?
30.54. How to automatically checkout/lock files from the revision control system ?
30.55. How can I see if a file is read-only?
30.56. How can I open a file in DVT from the terminal?
30.57. How do I change the name of the xterm opened by a DVT Generic Run Configuration?
31. What is New?
32. How to Report an Issue?
33. Legal Notices
34. Third Party Licenses