61 lines
1.6 KiB
ReStructuredText
61 lines
1.6 KiB
ReStructuredText
Overview
|
|
--------
|
|
|
|
VHDL Style Guide (VSG) provides coding style guide enforcement for VHDL code.
|
|
|
|
Why VSG?
|
|
########
|
|
|
|
VSG was created after participating in a code review in which a real issue was masked by a coding style issue.
|
|
A finding was created for the style issue, while the real issue was missed.
|
|
When the code was re-reviewed, the real issue was discovered.
|
|
The coding style issue seemed to blind me to the real issue.
|
|
|
|
Depending on your process, style issues can take a lot of time to resolve.
|
|
|
|
1. Create finding/ticket/issue
|
|
2. Disposition finding/ticket/issue
|
|
3. Fix the problem
|
|
4. Verify the problem was fixed
|
|
|
|
Spending less time on style issues leaves more time to analyze code structure.
|
|
Eliminating style issues reduces the amount of time performing code reviews.
|
|
This results in a higher quality code base.
|
|
|
|
Key Benefits
|
|
############
|
|
|
|
* Explicitly define VHDL coding standards
|
|
* Make coding standards visible to everyone
|
|
* Improve code reviews
|
|
* Quickly bring code up to current standards
|
|
|
|
VSG allows the style of the code to be defined and enforced over portions or the entire code base.
|
|
|
|
Key Features
|
|
############
|
|
|
|
* Command line tool
|
|
|
|
* Integrates into continuous integration flow tools
|
|
|
|
* Reports and fixes issues found
|
|
|
|
* Horizontal whitespace
|
|
* Vertical whitespace
|
|
* Upper and lower case
|
|
* Keyword alignments
|
|
* etc...
|
|
|
|
* Fully configurable rules via JSON/YAML configuration file
|
|
|
|
* Disable rules
|
|
* Alter behavior of existing rules
|
|
* Change phase of execution
|
|
|
|
* Localize rule sets
|
|
|
|
* Create your own rules using python
|
|
* Use existing rules as a template
|
|
* Fully integrates into base rule set
|