whitespace_rules.rst

Whitespace Rules

whitespace_001

|phase_1| |error| |whitespace|

This rule check for trailing spaces.

Violation

Where periods indicate spaces:

library ieee;....

Fix

library ieee;

whitespace_002

|phase_1| |error| |whitespace|

This rule will check for the existence of tabs in the middle of a line.

Violation

\t\tsignal wr_en\t:\tstd_logic;  --\tWrite Enable

Fix

\t\tsignal wr_en : std_logic;  -- Write Enable

whitespace_003

|phase_2| |error| |whitespace|

This rule checks for spaces before semicolons.

Violation

wr_en : in    std_logic      ;

Fix

wr_en : in    std_logic;

whitespace_004

|phase_2| |error| |whitespace|

This rule checks for spaces before commas.

Violation

wr_en => wr_en    ,
rd_en => rd_en,

Fix

wr_en => wr_en,
rd_en => rd_en,

whitespace_005

|phase_2| |error| |whitespace|

This rule checks for spaces after an open parenthesis.

Note

Spaces before numbers are ignored. This can be disabled by setting the 'ignore_spaces_before_numbers' attribute to 'False'.

Violation

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

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| |whitespace|

This rule checks for spaces before a close parenthesis.

Violation

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

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| |whitespace|

This rule checks for spaces after a comma.

|configuring_whitespace_rules_link|

Violation

proc : process (wr_en,rd_en,overflow) is

Fix

proc : process (wr_en, rd_en, overflow) is

whitespace_008

This rule has been deprecated and replaced with rule index_constraint_100.

whitespace_010

|phase_2| |error| |whitespace|

This rule checks for spaces before and after the concatenate (&) operator.

Violation

a <= b&c;

Fix

a <= b & c;

whitespace_011

|phase_2| |error| |whitespace|

This rule checks for at least a single space before and after math operators +, -, /, * and **.

Violation

a <= b+c;
a <= b-c;
a <= b/c;
a <= b*c;
a <= b**c;
a <= (b+c)-(d-e);

Fix

a <= b + c;
a <= b - c;
a <= b / c;
a <= b * c;
a <= b ** c;
a <= (b + c) - (d - e);

whitespace_012

This rule was a duplicate of whitespace_200 and has been removed.

whitespace_013

|phase_2| |error| |whitespace|

This rule checks for at least a single space before and after logical operators.

Violation

if (a = '1')and(b = '0')
if (a = '0')or (b = '1')

Fix

if (a = '1') and (b = '0')
if (a = '0') or (b = '1')

whitespace_100

|phase_2| |error| |whitespace|

This rule checks for at least a single space before and after relational operators.

Violation

if readAddr>=writeAddr then
if readAddr    >=      writeAddr then

Fix

if readAddr >= writeAddr then
if readAddr >= writeAddr then

whitespace_101

|phase_2| |error| |whitespace|

This rule checks for at least a single space before and after logical operators.

Violation

if (a = '1')sll(b = '0')
if (a = '0')rol (b = '1')

Fix

if (a = '1') sll (b = '0')
if (a = '0') rol (b = '1')

whitespace_102

|phase_2| |error| |whitespace|

This rule checks for a single space before direction keywords.

|configuring_whitespace_rules_link|

Violation

x <= y(7     downto 0);
x <= y(0     to 7);

Fix

x <= y(7 downto 0);
x <= y(0 to 7);

whitespace_103

|phase_2| |error| |whitespace|

This rule checks for a single space after direction keywords.

|configuring_whitespace_rules_link|

Violation

x <= y(7 downto      0);
x <= y(0 to      7);

Fix

x <= y(7 downto 0);
x <= y(0 to 7);

whitespace_200

|phase_3| |error| |blank_line|

This rule enforces a maximum number of consecutive blank lines.

|configuring_consecutive_blank_line_rules|

Violation

a <= b;


c <= d;

Fix

a <= b;

c <= d;