Skip to content

Latest commit

 

History

History
219 lines (126 loc) · 3.65 KB

subtype_rules.rst

File metadata and controls

219 lines (126 loc) · 3.65 KB

Subtype Rules

subtype_001

|phase_4| |error| |indent|

This rule checks for indentation of the subtype keyword.

Violation

architecture rtl of fifo is

     subtype read_size is range 0 to 9;
subtype write_size is range 0 to 9;

begin

Fix

architecture rtl of fifo is

  subtype read_size is range 0 to 9;
  subtype write_size is range 0 to 9;

begin

subtype_002

|phase_6| |error| |case|

This rule checks for consistent capitalization of subtype names.

Violation

subtype read_size is range 0 to 9;
subtype write_size is range 0 to 9;

signal read  : READ_SIZE;
signal write : write_size;

constant read_sz  : read_size := 8;
constant write_sz : WRITE_size := 1;

Fix

subtype read_size is range 0 to 9;
subtype write_size is range 0 to 9;

signal read  : read_size;
signal write : write_size;

constant read_sz  : read_size := 8;
constant write_sz : write_size := 1;

subtype_003

This rule was deprecated and replaced with rules:

subtype_004

|phase_7| |disabled| |error| |naming|

This rule checks for valid prefixes in subtype identifiers. The default new subtype prefix is st_.

|configuring_prefix_and_suffix_rules_link|

Violation

subtype my_subtype is range 0 to 9;

Fix

subtype st_my_subtype is range 0 to 9;

subtype_100

|phase_2| |disabled| |error| |whitespace|

This rule checks for a single space before the identifier.

|configuring_whitespace_rules_link|

Violation

subtype         my_subtype is range 0 to 9;

Fix

subtype my_subtype is range 0 to 9;

subtype_500

|phase_6| |error| |case| |case_keyword|

This rule checks the subtype keyword has proper case.

|configuring_uppercase_and_lowercase_rules_link|

Violation

SUBTYPE interface is record
Subtype interface is record
subtype interface is record

Fix

subtype interface is record
subtype interface is record
subtype interface is record

subtype_501

|phase_6| |error| |case| |case_name|

This rule checks the identifier has proper case.

|configuring_uppercase_and_lowercase_rules_link|

Violation

subtype INTERFACE is record
subtype Interface is record
subtype interface is record

Fix

subtype interface is record
subtype interface is record
subtype interface is record

subtype_502

|phase_6| |error| |case| |case_keyword|

This rule checks the is keyword has proper case.

|configuring_uppercase_and_lowercase_rules_link|

Violation

subtype interface IS record
subtype interface Is record
subtype interface is record

Fix

subtype interface is record
subtype interface is record
subtype interface is record

subtype_600

|phase_7| |disabled| |error| |naming|

This rule checks for valid suffixes in subtype identifiers. The default new subtype suffix is _st.

|configuring_prefix_and_suffix_rules_link|

Violation

subtype my_subtype is range 0 to 9;

Fix

subtype my_subtype_st is range 0 to 9;