Merge remote-tracking branch 'origin/master' into issue-1488

Author: JHertz5

docs/configuring.rst

@@ -19,6 +19,7 @@ Configuring
    configuring_indent_rules.rst
    configuring_keyword_alignment_rules.rst
    configuring_length_rules.rst
+   configuring_library_and_package_name_restriction_rules.rst
    configuring_move_token_rules.rst
    configuring_multiline_assert_rule.rst
    configuring_multiline_constraint_rules.rst

docs/configuring_disabled_rules.rst

@@ -59,10 +59,9 @@ Rules Disabled by Default
 * `generic_map_601 <generic_map_rules.html#generic-map-601>`_
 * `instantiation_600 <instantiation_rules.html#instantiation-600>`_
 * `instantiation_601 <instantiation_rules.html#instantiation-601>`_
-
 * `interface_incomplete_type_declaration_600 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-600>`_
 * `interface_incomplete_type_declaration_601 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-601>`_
-
+* `library_012 <library_rules.html#library-012>`_
 * `loop_statement_006 <loop_statement_rules.html#loop-statement-006>`_
 * `loop_statement_007 <loop_statement_rules.html#loop-statement-007>`_
 * `loop_statement_600 <loop_statement_rules.html#loop-statement-600>`_
@@ -102,6 +101,7 @@ Rules Disabled by Default
 * `type_100 <type_rules.html#type-100>`_
 * `type_200 <type_rules.html#type-200>`_
 * `type_600 <type_rules.html#type-600>`_
+* `use_clause_001 <use_clause_rules.html#use-clause-001>`_
 * `variable_012 <variable_rules.html#variable-012>`_
 * `variable_100 <variable_rules.html#variable-100>`_
 * `variable_600 <variable_rules.html#variable-600>`_

docs/configuring_library_and_package_name_restriction_rules.rst

@@ -0,0 +1,70 @@
+
+.. _configuring-library-and-package-name-restriction-rules:
+
+Configuring Library and Package Name Restriction Rules
+------------------------------------------------------
+
+There are rules which will check for invalid package names in library and use clauses.
+These rules are disabled by default and must be enabled before they will perform any checks.
+
+There is one option for these rules:
+
+.. |names| replace::
+   :code:`names`
+
+.. |default| replace::
+   :code:`std_logic_arith` for **use_clause_001**. None for **library_012**
+
+.. |values__names| replace::
+   List of strings
+
+.. |action__names| replace::
+   Search for libraries and packages with the user defined names
+
++--------------------------------------+-----------------+-----------+------------------------------------------------+
+| Option                               |   Values        | Default   | Description                                    |
++======================================+=================+===========+================================================+
+| |names|                              | |values__names| | |default| | * |action__names|                              |
++--------------------------------------+-----------------+-----------+------------------------------------------------+
+
+This is an example of how to configure the option.
+
+.. code-block:: yaml
+
+   rule :
+     library_012:
+        names:
+          - "work"
+          - "std_logic_arith"
+
+.. NOTE:: All examples below are using the rule **use_clause_001**.
+
+Example: |names| set to list ["std_logic_arith"]
+################################################
+
+The following code would fail with this option:
+
+.. code-Block:: vhdl
+
+   library ieee;
+     use ieee.std_logic_arith.all;
+
+Example: |names| set to ["std_logic_arith", "my_package"]
+##############################################
+
+The following code would fail three times with this option:
+
+.. code-block:: vhdl
+
+   library ieee;
+     use ieee.std_logic_arith.all;
+
+   library work;
+     use work.my_package.all;
+
+
+Rules Enforcing Valid Names
+###########################
+
+* `library_012 <library_rules.html#library-012>`_
+* `use_clause_001 <use_clause_rules.html#use-clause-001>`_

docs/configuring_whitespace_rules.rst

@@ -189,7 +189,12 @@ Rules Enforcing Whitespace
 * `external_variable_name_102 <external_variable_name_rules.html#external-variable-name-102>`_
 * `external_variable_name_103 <external_variable_name_rules.html#external-variable-name-103>`_
 * `external_variable_name_104 <external_variable_name_rules.html#external-variable-name-104>`_
+* `file_open_information_100 <file_open_information_rules.html#file-open-information-100>`_
+* `file_open_information_101 <file_open_information_rules.html#file-open-information-101>`_
+* `file_open_information_102 <file_open_information_rules.html#file-open-information-102>`_
+* `file_open_information_103 <file_open_information_rules.html#file-open-information-103>`_
 * `file_100 <file_rules.html#file-100>`_
+* `file_101 <file_rules.html#file-101>`_
 * `function_100 <function_rules.html#function-100>`_
 * `function_101 <function_rules.html#function-101>`_
 * `generate_002 <generate_rules.html#generate-002>`_

docs/file_open_information_rules.rst

@@ -3,6 +3,90 @@
 File Open Information Rules
 ---------------------------
 
+file_open_information_100
+#########################
+
+|phase_2| |error| |whitespace|
+
+This rule checks for a single space before the **open** keyword.
+
+|configuring_whitespace_rules_link|
+
+**Violation**
+
+.. code-block:: vhdl
+
+   file defaultImage : load_file_type      open read_mode is load_file_name;
+
+**Fix**
+
+.. code-block:: vhdl
+
+   file defaultImage : load_file_type open read_mode is load_file_name;
+
+file_open_information_101
+#########################
+
+|phase_2| |error| |whitespace|
+
+This rule checks for a single space after the **open** keyword.
+
+|configuring_whitespace_rules_link|
+
+**Violation**
+
+.. code-block:: vhdl
+
+   file defaultImage : load_file_type open     read_mode is load_file_name;
+
+**Fix**
+
+.. code-block:: vhdl
+
+   file defaultImage : load_file_type open read_mode is load_file_name;
+
+file_open_information_102
+#########################
+
+|phase_2| |error| |whitespace|
+
+This rule checks for a single space before the **is** keyword.
+
+|configuring_whitespace_rules_link|
+
+**Violation**
+
+.. code-block:: vhdl
+
+   file defaultImage : load_file_type open read_mode     is load_file_name;
+
+**Fix**
+
+.. code-block:: vhdl
+
+   file defaultImage : load_file_type open read_mode is load_file_name;
+
+file_open_information_103
+#########################
+
+|phase_2| |error| |whitespace|
+
+This rule checks for a single space after the **is** keyword.
+
+|configuring_whitespace_rules_link|
+
+**Violation**
+
+.. code-block:: vhdl
+
+   file defaultImage : load_file_type open read_mode is         load_file_name;
+
+**Fix**
+
+.. code-block:: vhdl
+
+   file defaultImage : load_file_type open read_mode is load_file_name;
+
 file_open_information_500
 #########################
 

docs/file_rules.rst

@@ -92,6 +92,27 @@ This rule checks for a single space before the identifier.
 
 **Fix**
 
+.. code-block:: vhdl
+
+   file defaultImage : load_file_type open read_mode is load_file_name;
+
+file_101
+########
+
+|phase_2| |error| |whitespace|
+
+This rule checks for a single space after the identifier.
+
+|configuring_whitespace_rules_link|
+
+**Violation**
+
+.. code-block:: vhdl
+
+   file defaultImage        : load_file_type open read_mode is load_file_name;
+
+**Fix**
+
 .. code-block:: vhdl
 
    file defaultImage : load_file_type open read_mode is load_file_name;

docs/library_rules.rst

@@ -275,6 +275,23 @@ This rule checks the **use** keyword is on its own line.
    context c1 is library ieee;
        use ieee.std_logic_1164.all; end context c1;
 
+library_012
+###########
+
+|phase_7| |disabled| |error| |unfixable| |naming|
+
+This rule checks for libraries that have been restricted by the user.
+
+|configuring_library_and_package_name_restriction_rules_link|
+
+.. NOTE:: This rule is disabled by default.
+
+**Violation**
+
+.. code-block:: vhdl
+
+   library bad_lib;
+
 library_500
 ###########
 

docs/links.rst

@@ -100,3 +100,6 @@
 
 .. |configuring_comment_indenting_link| replace::
    Refer to :ref:`configuring-comment-indenting` for configuration options.
+
+.. |configuring_library_and_package_name_restriction_rules_link| replace::
+   Refer to :ref:`configuring-library-and-package-name-restriction-rules` for configuration options.

docs/port_rules.rst

@@ -566,6 +566,7 @@ This rule checks for missing modes in port declarations.
      WR_EN    : std_logic;
      RD_EN    : std_logic;
      OVERFLOW : std_logic;
+     V_TEST   : some_view;
      DATA     : inout std_logic
    );
 
@@ -577,6 +578,7 @@ This rule checks for missing modes in port declarations.
      WR_EN    : in    std_logic;
      RD_EN    : in    std_logic;
      OVERFLOW : out   std_logic;
+     V_TEST   : view  some_view;
      DATA     : inout std_logic
    );
 

docs/process_rules.rst

@@ -805,7 +805,7 @@ event configuration
 edge configuration
 ^^^^^^^^^^^^^^^^^^
 
-.. NOTE::  Configuration this by setting the *'clock'* attribute to *'edge'*
+.. NOTE::  Configure this by setting the *'clock'* attribute to *'edge'*.
 
    .. code-block:: json