vhdl-style-guide/docs/case_generate_alternative_r...

141 lines
2.1 KiB
ReStructuredText

.. include:: includes.rst
Case Generate Alternative Rules
-------------------------------
case_generate_alternative_100
#############################
|phase_2| |error| |whitespace|
This rule checks for a single space after the **when** keyword.
|configuring_whitespace_rules_link|
**Violation**
.. code-block:: vhdl
case data generate
when 3 =>
**Fix**
.. code-block:: vhdl
case data generate
when 3 =>
case_generate_alternative_101
#############################
|phase_2| |error| |whitespace|
This rule checks for a single space before the **=>** operator.
|configuring_whitespace_rules_link|
**Violation**
.. code-block:: vhdl
case data generate
when 3 =>
**Fix**
.. code-block:: vhdl
case data generate
when 3 =>
case_generate_alternative_200
#############################
|phase_3| |error| |blank_line|
This rule checks for a blank line below the **=>** keyword.
|configuring_blank_lines_link|
**Violation**
.. code-block:: vhdl
when 0 =>
a <= b;
**Fix**
.. code-block:: vhdl
when 0 =>
a <= b;
case_generate_alternative_201
#############################
|phase_3| |error| |blank_line|
This rule checks for blank lines or comments above the **when** keyword.
|configuring_previous_line_rules_link|
The default style is :code:`allow_comment`.
**Violation**
.. code-block:: vhdl
case data is
when 3 =>
-- Comment
when 4 =>
**Fix**
.. code-block:: vhdl
case data is
when 3 =>
-- Comment
when 4 =>
case_generate_alternative_300
#############################
The function of this rule has been superseded with comment indent updates and is handled by rule comment_010.
case_generate_alternative_500
#############################
|phase_6| |error| |case| |case_keyword|
This rule checks the **when** keyword has proper case.
|configuring_uppercase_and_lowercase_rules_link|
**Violation**
.. code-block:: vhdl
WHEN choices =>
**Fix**
.. code-block:: vhdl
when choices =>
case_generate_alternative_501
#############################
This rule has been deprecated and replaced with rule `choice_500 <choice_rules.html#choice-500>`_.