vhdl-style-guide/docs/context_ref_rules.rst

244 lines
3.4 KiB
ReStructuredText

.. include:: includes.rst
Context Reference Rules
-----------------------
context_ref_001
###############
|phase_4| |error| |indent|
This rule checks the indent of the **context** keyword.
**Violation**
.. code-block:: vhdl
library ieee;
context c1;
**Fix**
.. code-block:: vhdl
library ieee;
context c1;
context_ref_002
###############
|phase_2| |error| |whitespace|
This rule checks for a single space between the **context** keyword and the context selected name.
|configuring_whitespace_rules_link|
**Violation**
.. code-block:: vhdl
context c1;
**Fix**
.. code-block:: vhdl
context c1;
context_ref_003
###############
|phase_6| |error| |case| |case_keyword|
This rule checks the **context** keyword has proper case.
|configuring_uppercase_and_lowercase_rules_link|
**Violation**
.. code-block:: vhdl
CONTEXT c1;
**Fix**
.. code-block:: vhdl
context c1;
context_ref_004
###############
This rule has been split into the following rules:
* :ref:`context_ref_500`
* :ref:`context_ref_501`
context_ref_005
###############
|phase_1| |error| |structure|
This rule checks the **context** keyword is on its own line.
**Violation**
.. code-block:: vhdl
context c1 is library ieee; context con1; end context c1;
library ieee; context con2;
**Fix**
.. code-block:: vhdl
context c1 is library ieee;
context con1; end context c1;
library ieee;
context con2;
context_ref_006
###############
This rule checks the semicolon is on the same line as the context selected name.
.. NOTE:: This rule has not been implemented yet.
**Violation**
.. code-block:: vhdl
context c1
;
context
c1
;
**Fix**
.. code-block:: vhdl
context c1;
context
c1;
context_ref_007
###############
This rule checks for code after the semicolon.
.. NOTE:: This rule has not been implemented yet.
**Violation**
.. code-block:: vhdl
context c1; -- Comments are allowed
context c1; library ieee; -- This is not allowed
**Fix**
.. code-block:: vhdl
context c1; -- Comments are allowed
context c1;
library ieee; -- This is not allowed
context_ref_008
###############
This rule checks the context selected name is on the same line as the **context** keyword.
.. NOTE:: This rule has not been implemented yet.
**Violation**
.. code-block:: vhdl
context
c1
;
**Fix**
.. code-block:: vhdl
context c1
;
context_ref_009
###############
This rule checks for multiple selected names in a single reference.
.. NOTE:: This rule has not been implemented yet.
**Violation**
.. code-block:: vhdl
context c1, c2, c3; -- Comment 1
context c1,
c2,
c3;
.. code-block:: vhdl
context c1;
context c2;
context c3;
context c1;
context c2;
context c3;
context_ref_500
###############
|phase_6| |error| |case| |case_name|
This rule checks the library name called out in the selected name has proper case.
|configuring_uppercase_and_lowercase_rules_link|
**Violation**
.. code-block:: vhdl
context my_LIB.all;
**Fix**
.. code-block:: vhdl
context my_lib.all;
context_ref_501
###############
|phase_6| |error| |case| |case_name|
This rule checks the context name called out in the selected name has proper case.
|configuring_uppercase_and_lowercase_rules_link|
**Violation**
.. code-block:: vhdl
context my_lib.INTERFACES;
**Fix**
.. code-block:: vhdl
context my_lib.interfaces;