vhdl-style-guide/docs/example.rst

77 lines
4.3 KiB
ReStructuredText

.. code-block:: bash
$ vsg -f PIC.vhd
=======================================================================================
File: PIC.vhd
=======================================================================================
Phase 5 of 7... Reporting
Total Rules Checked: 208
Total Violations: 523
----------------------------+------------+---------------------------------------------
Violation | line(s) | Solution
----------------------------+------------+---------------------------------------------
comment_002 | 51 | Align comment with previous line.
comment_002 | 52 | Align comment with previous line.
comment_002 | 54 | Align comment with previous line.
comment_002 | 55 | Align comment with previous line.
comment_003 | 76-256 | Align comments within process.
sequential_005 | 87-93 | Align "<=" within the group of lines.
sequential_005 | 102-103 | Align "<=" within the group of lines.
sequential_005 | 105-108 | Align "<=" within the group of lines.
sequential_005 | 110-113 | Align "<=" within the group of lines.
sequential_005 | 115-118 | Align "<=" within the group of lines.
sequential_005 | 120-124 | Align "<=" within the group of lines.
sequential_005 | 129-133 | Align "<=" within the group of lines.
sequential_005 | 160-161 | Align "<=" within the group of lines.
sequential_005 | 173-174 | Align "<=" within the group of lines.
comment_002 | 183 | Align comment with previous line.
sequential_005 | 225-226 | Align "<=" within the group of lines.
sequential_005 | 238-239 | Align "<=" within the group of lines.
----------------------------+------------+---------------------------------------------
NOTE: Refer to online documentation at http://... for more information.
$ vsg -f PIC.vhd
=======================================================================================
File: PIC.vhd
=======================================================================================
Phase 7 of 7... Reporting
Total Rules Checked: 208
Total Violations: 0
$ vsg -f PIC.vhd
File: PIC.vhd
==============
Phase 1... Reporting
Phase 2... Reporting
Phase 3... Reporting
Phase 4... Reporting
Phase 5... Reporting
comment_002 | 51 | Ensure proper alignment of comment with previous line.
comment_002 | 52 | Ensure proper alignment of comment with previous line.
comment_002 | 54 | Ensure proper alignment of comment with previous line.
comment_002 | 55 | Ensure proper alignment of comment with previous line.
comment_003 | 76-256 | Inconsistent alignment of comments within process.
sequential_005 | 87-93 | Inconsistent alignment of "<=" in group of lines.
sequential_005 | 102-103 | Inconsistent alignment of "<=" in group of lines.
sequential_005 | 105-108 | Inconsistent alignment of "<=" in group of lines.
sequential_005 | 110-113 | Inconsistent alignment of "<=" in group of lines.
sequential_005 | 115-118 | Inconsistent alignment of "<=" in group of lines.
sequential_005 | 120-124 | Inconsistent alignment of "<=" in group of lines.
sequential_005 | 129-133 | Inconsistent alignment of "<=" in group of lines.
sequential_005 | 160-161 | Inconsistent alignment of "<=" in group of lines.
sequential_005 | 173-174 | Inconsistent alignment of "<=" in group of lines.
comment_002 | 183 | Ensure proper alignment of comment with previous line.
sequential_005 | 225-226 | Inconsistent alignment of "<=" in group of lines.
sequential_005 | 238-239 | Inconsistent alignment of "<=" in group of lines.
Phase 6... Not executed
Phase 7... Not executed
==============
Total Rules Checked: 204
Total Failures: 523