Issue#1350: Updated documentation for new rules.

This commit is contained in:
JHertz5 2024-12-14 09:23:22 +00:00
parent 2fdba1d44e
commit e8e9b01e05
7 changed files with 52 additions and 0 deletions

View File

@ -482,6 +482,8 @@ Rules Enforcing Case
* `selected_assignment_502 <selected_assignment_rules.html#selected-assignment-502>`_
* `selected_assignment_503 <selected_assignment_rules.html#selected-assignment-503>`_
* `shift_operator_500 <shift_operator_rules.html#shift-operator-500>`_
* `signal_002 <signal_rules.html#signal-002>`_
* `signal_004 <signal_rules.html#signal-004>`_

View File

@ -160,6 +160,7 @@ Rules Enforcing Case::Keyword Rule Group
* `selected_assignment_501 <../selected_assignment_rules.html#selected-assignment-501>`_
* `selected_assignment_502 <../selected_assignment_rules.html#selected-assignment-502>`_
* `selected_assignment_503 <../selected_assignment_rules.html#selected-assignment-503>`_
* `shift_operator_500 <../shift_operator_rules.html#shift-operator-500>`_
* `signal_002 <../signal_rules.html#signal-002>`_
* `subtype_500 <../subtype_rules.html#subtype-500>`_
* `subtype_502 <../subtype_rules.html#subtype-502>`_

View File

@ -217,6 +217,7 @@ Rules Enforcing Case Rule Group
* `selected_assignment_501 <../selected_assignment_rules.html#selected-assignment-501>`_
* `selected_assignment_502 <../selected_assignment_rules.html#selected-assignment-502>`_
* `selected_assignment_503 <../selected_assignment_rules.html#selected-assignment-503>`_
* `shift_operator_500 <../shift_operator_rules.html#shift-operator-500>`_
* `signal_002 <../signal_rules.html#signal-002>`_
* `signal_004 <../signal_rules.html#signal-004>`_
* `signal_014 <../signal_rules.html#signal-014>`_

View File

@ -182,3 +182,4 @@ Rules Enforcing Whitespace Rule Group
* `whitespace_011 <../whitespace_rules.html#whitespace-011>`_
* `whitespace_013 <../whitespace_rules.html#whitespace-013>`_
* `whitespace_100 <../whitespace_rules.html#whitespace-100>`_
* `whitespace_101 <../whitespace_rules.html#whitespace-101>`_

View File

@ -75,6 +75,7 @@ The rules are divided into categories depending on the part of the VHDL code bei
selected_assignment_rules.rst
sequential_rules.rst
signal_rules.rst
shift_operator_rules.rst
source_file_rules.rst
subprogram_body_rules.rst
subtype_rules.rst

View File

@ -0,0 +1,25 @@
.. include:: includes.rst
Shift Operator Rules
--------------------
shift_operator_500
##################
|phase_6| |error| |case| |case_keyword|
This rule checks shift operators have proper case.
|configuring_uppercase_and_lowercase_rules_link|
**Violation**
.. code-block:: vhdl
a <= b SLL c;
**Fix**
.. code-block:: vhdl
a <= b sll c;

View File

@ -269,6 +269,27 @@ This rule checks for at least a single space before and after relational operato
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**
.. code-block:: vhdl
if (a = '1')sll(b = '0')
if (a = '0')rol (b = '1')
**Fix**
.. code-block:: vhdl
if (a = '1') sll (b = '0')
if (a = '0') rol (b = '1')
whitespace_200
##############