configuring_optional_items.rst

Configuring Optional Items

There are optional language items in VHDL. In the Language Reference Manual (LRM) they are denoted with square brackets []. Using many of these optional items improves the readability of VHDL code.

However, it may not fit the current style of existing code bases. The rules checking the optional items can be configured to add or remove them.

Option	Values	Default Value	Description
action	add, remove	add	add = Add the optional item. remove = Remove the optional item.

This is an example of how to configure these options.

rule :
  architecture_010:
     action: 'add'

Note

The following examples are using rule architecture_010.

Example: action set to add

Violation

architecture rtl of fifo is
begin
end fifo;

Violation

architecture rtl of fifo is
begin
end architecture fifo;

Example: action set to remove

Violation

architecture rtl of fifo is
begin
end architecture fifo;

Violation

architecture rtl of fifo is
begin
end fifo;

Rules Enforcing Optional Items

• architecture_010
• architecture_024
• block_002
• block_007
• component_021
• context_021
• context_022
• entity_015
• entity_019
• function_018
• generate_011
• instantiation_033
• loop_statement_007
• package_007
• package_014
• package_body_002
• package_body_003
• procedure_012
• process_012
• process_018
• record_type_definition_005