256 lines
3.9 KiB
ReStructuredText
256 lines
3.9 KiB
ReStructuredText
.. include:: icons.rst
|
|
|
|
Whitespace Rules
|
|
----------------
|
|
|
|
whitespace_001
|
|
##############
|
|
|
|
This rule has been depricated.
|
|
|
|
VSG strips trailing spaces when a file is read in.
|
|
|
|
whitespace_002
|
|
##############
|
|
|
|
This rule has been depricated.
|
|
|
|
VSG changes tabs to spaces when a file is read in.
|
|
|
|
whitespace_003
|
|
##############
|
|
|
|
|phase_2| |error|
|
|
|
|
This rule checks for spaces before semicolons.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
wr_en : in std_logic ;
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
wr_en : in std_logic;
|
|
|
|
whitespace_004
|
|
##############
|
|
|
|
|phase_2| |error|
|
|
|
|
This rule checks for spaces before commas.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
wr_en => wr_en ,
|
|
rd_en => rd_en,
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
wr_en => wr_en,
|
|
rd_en => rd_en,
|
|
|
|
whitespace_005
|
|
##############
|
|
|
|
|phase_2| |error|
|
|
|
|
This rule checks for spaces after an open parenthesis.
|
|
|
|
.. NOTE::
|
|
Spaces before numbers are allowed.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
signal data : std_logic_vector(31 downto 0);
|
|
signal byte_enable : std_logic_vector( 3 downto 0);
|
|
signal width : std_logic_vector( g_width - 1 downto 0);
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
signal data : std_logic_vector(31 downto 0);
|
|
signal byte_enable : std_logic_vector( 3 downto 0);
|
|
signal width : std_logic_vector(g_width - 1 downto 0);
|
|
|
|
whitespace_006
|
|
##############
|
|
|
|
|phase_2| |error|
|
|
|
|
This rule checks for spaces before a close parenthesis.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
signal data : std_logic_vector(31 downto 0 );
|
|
signal byte_enable : std_logic_vector( 3 downto 0 );
|
|
signal width : std_logic_vector(g_width - 1 downto 0);
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
signal data : std_logic_vector(31 downto 0);
|
|
signal byte_enable : std_logic_vector( 3 downto 0);
|
|
signal width : std_logic_vector(g_width - 1 downto 0);
|
|
|
|
whitespace_007
|
|
##############
|
|
|
|
|phase_2| |error|
|
|
|
|
This rule checks for spaces after a comma.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
proc : process (wr_en,rd_en,overflow) is
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
proc : process (wr_en, rd_en, overflow) is
|
|
|
|
whitespace_008
|
|
##############
|
|
|
|
|phase_2| |error|
|
|
|
|
This rule checks for spaces after the **std_logic_vector** keyword.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
signal data : std_logic_vector (7 downto 0);
|
|
signal counter : std_logic_vector (7 downto 0);
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
signal data : std_logic_vector(7 downto 0);
|
|
signal counter : std_logic_vector(7 downto 0);
|
|
|
|
whitespace_010
|
|
##############
|
|
|
|
|phase_2| |error|
|
|
|
|
This rule checks for spaces before and after the concate (&) operator.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
a <= b&c;
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
a <= b & c;
|
|
|
|
whitespace_011
|
|
##############
|
|
|
|
|phase_2| |error|
|
|
|
|
This rule checks for at least a single space before and after math operators +, -, /, \* and \*\*.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
a <= b+c;
|
|
a <= b-c;
|
|
a <= b/c;
|
|
a <= b*c;
|
|
a <= b**c;
|
|
a <= (b+c)-(d-e);
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
a <= b + c;
|
|
a <= b - c;
|
|
a <= b / c;
|
|
a <= b * c;
|
|
a <= b ** c;
|
|
a <= (b + c) - (d - e);
|
|
|
|
whitespace_012
|
|
##############
|
|
|
|
|phase_2| |error|
|
|
|
|
This rule enforces a maximum number of consecutive blank lines.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
a <= b;
|
|
|
|
|
|
c <= d;
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
a <= b;
|
|
|
|
c <= d;
|
|
|
|
.. NOTE::
|
|
|
|
The default is set to 1.
|
|
This can be changed by setting the *numBlankLines* attribute to another number.
|
|
|
|
.. code-block:: json
|
|
|
|
{
|
|
"rule":{
|
|
"whitespace_012":{
|
|
"numBlankLines":3
|
|
}
|
|
}
|
|
}
|
|
|
|
whitespace_013
|
|
##############
|
|
|
|
|phase_2| |error|
|
|
|
|
This rule checks for at least a single space before and after logical operators.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
if (a = '1')and(b = '0')
|
|
if (a = '0')or (b = '1')
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
if (a = '1') and (b = '0')
|
|
if (a = '0') or (b = '1')
|