Issue #837 (#903): Adding listing of rules in rule groups.

This commit is contained in:
Jeremiah Leary 2022-12-21 11:51:29 -06:00 committed by GitHub
parent 715d8f4330
commit 2f12bbd4dc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
16 changed files with 1154 additions and 43 deletions

View File

@ -1,48 +1,20 @@
Rule Groups
===========
Rule groups allow for easier configuration of rules that perform similar functions.
Using rule groups can make upgrading VSG versions easier as new rules are added.
.. toctree::
:maxdepth: 1
The following is a list of the rule groups:
rule_groups/overview.rst
rule_groups/alignment_rule_group.rst
rule_groups/blank_line_rule_group.rst
rule_groups/case_rule_group.rst
rule_groups/case_keyword_rule_group.rst
rule_groups/case_label_rule_group.rst
rule_groups/case_name_rule_group.rst
rule_groups/length_rule_group.rst
rule_groups/indent_rule_group.rst
rule_groups/naming_rule_group.rst
rule_groups/structure_rule_group.rst
rule_groups/structure_optional_rule_group.rst
rule_groups/whitespace_rule_group.rst
+-------------------------+---------------------------------------------------------+
| Group | Description |
+-------------------------+---------------------------------------------------------+
| alignment | Horizontal alignment rules. |
+-------------------------+---------------------------------------------------------+
| blank_line | Vertical alignment rules. |
+-------------------------+---------------------------------------------------------+
| case | All rules involving lower and upper casing. |
+-------------------------+---------------------------------------------------------+
| case::keyword | Casing rules for VHDL keywords. |
+-------------------------+---------------------------------------------------------+
| case::label | Casing rules for labels. |
+-------------------------+---------------------------------------------------------+
| case::name | Casing rules for identifiers, etc... |
+-------------------------+---------------------------------------------------------+
| length | Rules restricting length. |
+-------------------------+---------------------------------------------------------+
| indent | Rules involving line indents. |
+-------------------------+---------------------------------------------------------+
| naming | Rules for constraining how identifiers etc.. are named. |
+-------------------------+---------------------------------------------------------+
| structure | Rules dictating the structure of the code. |
+-------------------------+---------------------------------------------------------+
| structure::optional | Rules for optional VHDL language items. |
+-------------------------+---------------------------------------------------------+
| whitespace | Rules for managing whitespace. |
+-------------------------+---------------------------------------------------------+
Subgroups
---------
Groups with double colons (::) are considered subgroups.
This allows for finer control of group rules.
For example, the case of keywords, labels and names can be set independently.
Configuring Groups
------------------
Refer to the section `Configuring a Rule Group <configuring_rule_groups.html>`_ for information on how to configure rule groups.

View File

@ -0,0 +1,82 @@
Alignment Rule Group
____________________
Rules Enforcing Alignment Rule Group
####################################
* `after_002 <after_rules.html#after-002>`_
* `architecture_026 <architecture_rules.html#architecture-026>`_
* `architecture_027 <architecture_rules.html#architecture-027>`_
* `architecture_029 <architecture_rules.html#architecture-029>`_
* `architecture_400 <architecture_rules.html#architecture-400>`_
* `assert_400 <assert_rules.html#assert-400>`_
* `block_400 <block_rules.html#block-400>`_
* `block_401 <block_rules.html#block-401>`_
* `block_402 <block_rules.html#block-402>`_
* `case_011 <case_rules.html#case-011>`_
* `case_generate_statement_400 <case_generate_statement_rules.html#case-generate-statement-400>`_
* `component_017 <component_rules.html#component-017>`_
* `component_020 <component_rules.html#component-020>`_
* `concurrent_003 <concurrent_rules.html#concurrent-003>`_
* `concurrent_006 <concurrent_rules.html#concurrent-006>`_
* `concurrent_008 <concurrent_rules.html#concurrent-008>`_
* `concurrent_009 <concurrent_rules.html#concurrent-009>`_
* `concurrent_400 <concurrent_rules.html#concurrent-400>`_
* `concurrent_401 <concurrent_rules.html#concurrent-401>`_
* `constant_012 <constant_rules.html#constant-012>`_
* `constant_014 <constant_rules.html#constant-014>`_
* `declarative_part_400 <declarative_part_rules.html#declarative-part-400>`_
* `entity_017 <entity_rules.html#entity-017>`_
* `entity_018 <entity_rules.html#entity-018>`_
* `entity_020 <entity_rules.html#entity-020>`_
* `function_012 <function_rules.html#function-012>`_
* `function_015 <function_rules.html#function-015>`_
* `generate_400 <generate_rules.html#generate-400>`_
* `generate_401 <generate_rules.html#generate-401>`_
* `generate_402 <generate_rules.html#generate-402>`_
* `generate_403 <generate_rules.html#generate-403>`_
* `generate_404 <generate_rules.html#generate-404>`_
* `generate_405 <generate_rules.html#generate-405>`_
* `if_009 <if_rules.html#if-009>`_
* `instantiation_010 <instantiation_rules.html#instantiation-010>`_
* `instantiation_029 <instantiation_rules.html#instantiation-029>`_
* `library_009 <library_rules.html#library-009>`_
* `package_019 <package_rules.html#package-019>`_
* `package_400 <package_rules.html#package-400>`_
* `package_401 <package_rules.html#package-401>`_
* `package_402 <package_rules.html#package-402>`_
* `package_body_400 <package_body_rules.html#package-body-400>`_
* `package_body_401 <package_body_rules.html#package-body-401>`_
* `package_body_402 <package_body_rules.html#package-body-402>`_
* `procedure_010 <procedure_rules.html#procedure-010>`_
* `procedure_401 <procedure_rules.html#procedure-401>`_
* `procedure_410 <procedure_rules.html#procedure-410>`_
* `procedure_411 <procedure_rules.html#procedure-411>`_
* `procedure_412 <procedure_rules.html#procedure-412>`_
* `procedure_call_400 <procedure_call_rules.html#procedure-call-400>`_
* `procedure_call_401 <procedure_call_rules.html#procedure-call-401>`_
* `process_020 <process_rules.html#process-020>`_
* `process_028 <process_rules.html#process-028>`_
* `process_031 <process_rules.html#process-031>`_
* `process_033 <process_rules.html#process-033>`_
* `process_034 <process_rules.html#process-034>`_
* `process_035 <process_rules.html#process-035>`_
* `process_400 <process_rules.html#process-400>`_
* `process_401 <process_rules.html#process-401>`_
* `report_statement_400 <report_statement_rules.html#report-statement-400>`_
* `selected_assignment_400 <selected_assignment_rules.html#selected-assignment-400>`_
* `sequential_004 <sequential_rules.html#sequential-004>`_
* `sequential_400 <sequential_rules.html#sequential-400>`_
* `sequential_401 <sequential_rules.html#sequential-401>`_
* `sequential_402 <sequential_rules.html#sequential-402>`_
* `signal_012 <signal_rules.html#signal-012>`_
* `signal_400 <signal_rules.html#signal-400>`_
* `subprogram_body_400 <subprogram_body_rules.html#subprogram-body-400>`_
* `subprogram_body_401 <subprogram_body_rules.html#subprogram-body-401>`_
* `type_400 <type_rules.html#type-400>`_
* `variable_400 <variable_rules.html#variable-400>`_
* `variable_assignment_004 <variable_assignment_rules.html#variable-assignment-004>`_
* `variable_assignment_400 <variable_assignment_rules.html#variable-assignment-400>`_
* `variable_assignment_401 <variable_assignment_rules.html#variable-assignment-401>`_

View File

@ -0,0 +1,87 @@
Blank Line Rule Group
---------------------
Rules Enforcing Blank Line Rule Group
#####################################
* `architecture_003 <architecture_rules.html#architecture-003>`_
* `architecture_015 <architecture_rules.html#architecture-015>`_
* `architecture_016 <architecture_rules.html#architecture-016>`_
* `architecture_017 <architecture_rules.html#architecture-017>`_
* `architecture_018 <architecture_rules.html#architecture-018>`_
* `architecture_200 <architecture_rules.html#architecture-200>`_
* `block_200 <block_rules.html#block-200>`_
* `block_201 <block_rules.html#block-201>`_
* `block_202 <block_rules.html#block-202>`_
* `block_203 <block_rules.html#block-203>`_
* `block_204 <block_rules.html#block-204>`_
* `block_205 <block_rules.html#block-205>`_
* `case_007 <case_rules.html#case-007>`_
* `case_009 <case_rules.html#case-009>`_
* `case_010 <case_rules.html#case-010>`_
* `case_200 <case_rules.html#case-200>`_
* `case_201 <case_rules.html#case-201>`_
* `component_003 <component_rules.html#component-003>`_
* `component_016 <component_rules.html#component-016>`_
* `component_018 <component_rules.html#component-018>`_
* `concurrent_010 <concurrent_rules.html#concurrent-010>`_
* `context_003 <context_rules.html#context-003>`_
* `context_023 <context_rules.html#context-023>`_
* `context_024 <context_rules.html#context-024>`_
* `context_025 <context_rules.html#context-025>`_
* `entity_003 <entity_rules.html#entity-003>`_
* `entity_016 <entity_rules.html#entity-016>`_
* `entity_200 <entity_rules.html#entity-200>`_
* `entity_201 <entity_rules.html#entity-201>`_
* `entity_202 <entity_rules.html#entity-202>`_
* `entity_203 <entity_rules.html#entity-203>`_
* `function_006 <function_rules.html#function-006>`_
* `generate_003 <generate_rules.html#generate-003>`_
* `generate_004 <generate_rules.html#generate-004>`_
* `generic_019 <generic_rules.html#generic-019>`_
* `if_006 <if_rules.html#if-006>`_
* `if_007 <if_rules.html#if-007>`_
* `if_008 <if_rules.html#if-008>`_
* `if_010 <if_rules.html#if-010>`_
* `if_011 <if_rules.html#if-011>`_
* `if_030 <if_rules.html#if-030>`_
* `if_031 <if_rules.html#if-031>`_
* `instantiation_004 <instantiation_rules.html#instantiation-004>`_
* `instantiation_019 <instantiation_rules.html#instantiation-019>`_
* `library_003 <library_rules.html#library-003>`_
* `library_007 <library_rules.html#library-007>`_
* `loop_statement_200 <loop_statement_rules.html#loop-statement-200>`_
* `loop_statement_201 <loop_statement_rules.html#loop-statement-201>`_
* `loop_statement_202 <loop_statement_rules.html#loop-statement-202>`_
* `loop_statement_203 <loop_statement_rules.html#loop-statement-203>`_
* `package_003 <package_rules.html#package-003>`_
* `package_011 <package_rules.html#package-011>`_
* `package_012 <package_rules.html#package-012>`_
* `package_body_200 <package_body_rules.html#package-body-200>`_
* `package_body_201 <package_body_rules.html#package-body-201>`_
* `package_body_202 <package_body_rules.html#package-body-202>`_
* `package_body_203 <package_body_rules.html#package-body-203>`_
* `port_001 <port_rules.html#port-001>`_
* `port_022 <port_rules.html#port-022>`_
* `port_024 <port_rules.html#port-024>`_
* `port_map_200 <port_map_rules.html#port-map-200>`_
* `procedure_200 <procedure_rules.html#procedure-200>`_
* `process_011 <process_rules.html#process-011>`_
* `process_015 <process_rules.html#process-015>`_
* `process_021 <process_rules.html#process-021>`_
* `process_022 <process_rules.html#process-022>`_
* `process_023 <process_rules.html#process-023>`_
* `process_026 <process_rules.html#process-026>`_
* `process_027 <process_rules.html#process-027>`_
* `record_type_definition_200 <record_type_definition_rules.html#record-type-definition-200>`_
* `record_type_definition_201 <record_type_definition_rules.html#record-type-definition-201>`_
* `subprogram_body_201 <subprogram_body_rules.html#subprogram-body-201>`_
* `subprogram_body_202 <subprogram_body_rules.html#subprogram-body-202>`_
* `subprogram_body_203 <subprogram_body_rules.html#subprogram-body-203>`_
* `subprogram_body_204 <subprogram_body_rules.html#subprogram-body-204>`_
* `subprogram_body_205 <subprogram_body_rules.html#subprogram-body-205>`_
* `type_010 <type_rules.html#type-010>`_
* `type_011 <type_rules.html#type-011>`_
* `whitespace_200 <whitespace_rules.html#whitespace-200>`_

View File

@ -0,0 +1,136 @@
Case::Keyword Rule Group
------------------------
Rules Enforcing Case::Keyword Rule Group
########################################
* `alias_declaration_500 <alias_declaration_rules.html#alias-declaration-500>`_
* `alias_declaration_501 <alias_declaration_rules.html#alias-declaration-501>`_
* `architecture_004 <architecture_rules.html#architecture-004>`_
* `architecture_009 <architecture_rules.html#architecture-009>`_
* `architecture_019 <architecture_rules.html#architecture-019>`_
* `architecture_020 <architecture_rules.html#architecture-020>`_
* `architecture_021 <architecture_rules.html#architecture-021>`_
* `architecture_028 <architecture_rules.html#architecture-028>`_
* `attribute_500 <attribute_rules.html#attribute-500>`_
* `attribute_declaration_500 <attribute_declaration_rules.html#attribute-declaration-500>`_
* `attribute_specification_500 <attribute_specification_rules.html#attribute-specification-500>`_
* `attribute_specification_502 <attribute_specification_rules.html#attribute-specification-502>`_
* `attribute_specification_503 <attribute_specification_rules.html#attribute-specification-503>`_
* `block_501 <block_rules.html#block-501>`_
* `block_502 <block_rules.html#block-502>`_
* `block_503 <block_rules.html#block-503>`_
* `block_504 <block_rules.html#block-504>`_
* `block_505 <block_rules.html#block-505>`_
* `case_014 <case_rules.html#case-014>`_
* `case_015 <case_rules.html#case-015>`_
* `case_016 <case_rules.html#case-016>`_
* `case_017 <case_rules.html#case-017>`_
* `case_018 <case_rules.html#case-018>`_
* `case_generate_alternative_500 <case_generate_alternative_rules.html#case-generate-alternative-500>`_
* `case_generate_alternative_501 <case_generate_alternative_rules.html#case-generate-alternative-501>`_
* `case_generate_statement_500 <case_generate_statement_rules.html#case-generate-statement-500>`_
* `case_generate_statement_501 <case_generate_statement_rules.html#case-generate-statement-501>`_
* `component_004 <component_rules.html#component-004>`_
* `component_006 <component_rules.html#component-006>`_
* `component_010 <component_rules.html#component-010>`_
* `component_014 <component_rules.html#component-014>`_
* `conditional_expressions_500 <conditional_expressions_rules.html#conditional-expressions-500>`_
* `conditional_expressions_501 <conditional_expressions_rules.html#conditional-expressions-501>`_
* `conditional_waveforms_500 <conditional_waveforms_rules.html#conditional-waveforms-500>`_
* `conditional_waveforms_501 <conditional_waveforms_rules.html#conditional-waveforms-501>`_
* `constant_002 <constant_rules.html#constant-002>`_
* `context_004 <context_rules.html#context-004>`_
* `context_013 <context_rules.html#context-013>`_
* `context_014 <context_rules.html#context-014>`_
* `context_015 <context_rules.html#context-015>`_
* `context_ref_003 <context_ref_rules.html#context-ref-003>`_
* `entity_004 <entity_rules.html#entity-004>`_
* `entity_006 <entity_rules.html#entity-006>`_
* `entity_010 <entity_rules.html#entity-010>`_
* `entity_014 <entity_rules.html#entity-014>`_
* `entity_500 <entity_rules.html#entity-500>`_
* `entity_specification_500 <entity_specification_rules.html#entity-specification-500>`_
* `entity_specification_501 <entity_specification_rules.html#entity-specification-501>`_
* `exponent_500 <exponent_rules.html#exponent-500>`_
* `file_002 <file_rules.html#file-002>`_
* `for_generate_statement_500 <for_generate_statement_rules.html#for-generate-statement-500>`_
* `for_generate_statement_501 <for_generate_statement_rules.html#for-generate-statement-501>`_
* `function_004 <function_rules.html#function-004>`_
* `function_005 <function_rules.html#function-005>`_
* `function_013 <function_rules.html#function-013>`_
* `function_014 <function_rules.html#function-014>`_
* `function_502 <function_rules.html#function-502>`_
* `generate_009 <generate_rules.html#generate-009>`_
* `generate_010 <generate_rules.html#generate-010>`_
* `generate_500 <generate_rules.html#generate-500>`_
* `generate_501 <generate_rules.html#generate-501>`_
* `generic_009 <generic_rules.html#generic-009>`_
* `generic_017 <generic_rules.html#generic-017>`_
* `generic_map_001 <generic_map_rules.html#generic-map-001>`_
* `ieee_500 <ieee_rules.html#ieee-500>`_
* `if_generate_statement_500 <if_generate_statement_rules.html#if-generate-statement-500>`_
* `if_generate_statement_501 <if_generate_statement_rules.html#if-generate-statement-501>`_
* `if_generate_statement_502 <if_generate_statement_rules.html#if-generate-statement-502>`_
* `if_generate_statement_503 <if_generate_statement_rules.html#if-generate-statement-503>`_
* `if_025 <if_rules.html#if-025>`_
* `if_026 <if_rules.html#if-026>`_
* `if_027 <if_rules.html#if-027>`_
* `if_028 <if_rules.html#if-028>`_
* `if_029 <if_rules.html#if-029>`_
* `if_034 <if_rules.html#if-034>`_
* `instantiation_027 <instantiation_rules.html#instantiation-027>`_
* `instantiation_031 <instantiation_rules.html#instantiation-031>`_
* `iteration_scheme_500 <iteration_scheme_rules.html#iteration-scheme-500>`_
* `iteration_scheme_501 <iteration_scheme_rules.html#iteration-scheme-501>`_
* `library_004 <library_rules.html#library-004>`_
* `library_005 <library_rules.html#library-005>`_
* `logical_operator_500 <logical_operator_rules.html#logical-operator-500>`_
* `loop_statement_500 <loop_statement_rules.html#loop-statement-500>`_
* `loop_statement_501 <loop_statement_rules.html#loop-statement-501>`_
* `loop_statement_502 <loop_statement_rules.html#loop-statement-502>`_
* `package_004 <package_rules.html#package-004>`_
* `package_006 <package_rules.html#package-006>`_
* `package_013 <package_rules.html#package-013>`_
* `package_018 <package_rules.html#package-018>`_
* `package_body_500 <package_body_rules.html#package-body-500>`_
* `package_body_501 <package_body_rules.html#package-body-501>`_
* `package_body_503 <package_body_rules.html#package-body-503>`_
* `package_body_504 <package_body_rules.html#package-body-504>`_
* `package_body_505 <package_body_rules.html#package-body-505>`_
* `package_body_506 <package_body_rules.html#package-body-506>`_
* `port_017 <port_rules.html#port-017>`_
* `port_018 <port_rules.html#port-018>`_
* `port_019 <port_rules.html#port-019>`_
* `port_map_001 <port_map_rules.html#port-map-001>`_
* `procedure_008 <procedure_rules.html#procedure-008>`_
* `procedure_009 <procedure_rules.html#procedure-009>`_
* `procedure_500 <procedure_rules.html#procedure-500>`_
* `procedure_502 <procedure_rules.html#procedure-502>`_
* `procedure_503 <procedure_rules.html#procedure-503>`_
* `procedure_504 <procedure_rules.html#procedure-504>`_
* `procedure_505 <procedure_rules.html#procedure-505>`_
* `procedure_call_501 <procedure_call_rules.html#procedure-call-501>`_
* `process_004 <process_rules.html#process-004>`_
* `process_005 <process_rules.html#process-005>`_
* `process_008 <process_rules.html#process-008>`_
* `process_009 <process_rules.html#process-009>`_
* `process_013 <process_rules.html#process-013>`_
* `range_001 <range_rules.html#range-001>`_
* `range_002 <range_rules.html#range-002>`_
* `record_type_definition_500 <record_type_definition_rules.html#record-type-definition-500>`_
* `record_type_definition_501 <record_type_definition_rules.html#record-type-definition-501>`_
* `record_type_definition_502 <record_type_definition_rules.html#record-type-definition-502>`_
* `report_statement_500 <report_statement_rules.html#report-statement-500>`_
* `report_statement_501 <report_statement_rules.html#report-statement-501>`_
* `selected_assignment_500 <selected_assignment_rules.html#selected-assignment-500>`_
* `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>`_
* `signal_002 <signal_rules.html#signal-002>`_
* `type_002 <type_rules.html#type-002>`_
* `type_013 <type_rules.html#type-013>`_
* `use_clause_503 <use_clause_rules.html#use-clause-503>`_
* `variable_002 <variable_rules.html#variable-002>`_

View File

@ -0,0 +1,18 @@
Case::Label Rule Group
----------------------
Rules Enforcing Case::Label Rule Group
######################################
* `block_500 <block_rules.html#block-500>`_
* `block_506 <block_rules.html#block-506>`_
* `generate_005 <generate_rules.html#generate-005>`_
* `generate_012 <generate_rules.html#generate-012>`_
* `instantiation_008 <instantiation_rules.html#instantiation-008>`_
* `loop_statement_503 <loop_statement_rules.html#loop-statement-503>`_
* `loop_statement_504 <loop_statement_rules.html#loop-statement-504>`_
* `procedure_call_500 <procedure_call_rules.html#procedure-call-500>`_
* `process_017 <process_rules.html#process-017>`_
* `process_019 <process_rules.html#process-019>`_

View File

@ -0,0 +1,47 @@
Case::Name Rule Group
---------------------
Rules Enforcing Case::Name Rule Group
#####################################
* `alias_declaration_502 <alias_declaration_rules.html#alias-declaration-502>`_
* `architecture_011 <architecture_rules.html#architecture-011>`_
* `architecture_013 <architecture_rules.html#architecture-013>`_
* `architecture_014 <architecture_rules.html#architecture-014>`_
* `attribute_declaration_501 <attribute_declaration_rules.html#attribute-declaration-501>`_
* `attribute_declaration_502 <attribute_declaration_rules.html#attribute-declaration-502>`_
* `attribute_specification_501 <attribute_specification_rules.html#attribute-specification-501>`_
* `component_008 <component_rules.html#component-008>`_
* `component_012 <component_rules.html#component-012>`_
* `constant_004 <constant_rules.html#constant-004>`_
* `context_012 <context_rules.html#context-012>`_
* `context_016 <context_rules.html#context-016>`_
* `context_ref_500 <context_ref_rules.html#context-ref-500>`_
* `context_ref_501 <context_ref_rules.html#context-ref-501>`_
* `entity_008 <entity_rules.html#entity-008>`_
* `entity_012 <entity_rules.html#entity-012>`_
* `entity_specification_503 <entity_specification_rules.html#entity-specification-503>`_
* `function_017 <function_rules.html#function-017>`_
* `function_506 <function_rules.html#function-506>`_
* `generic_007 <generic_rules.html#generic-007>`_
* `generic_map_002 <generic_map_rules.html#generic-map-002>`_
* `instantiation_009 <instantiation_rules.html#instantiation-009>`_
* `instantiation_028 <instantiation_rules.html#instantiation-028>`_
* `library_500 <library_rules.html#library-500>`_
* `package_008 <package_rules.html#package-008>`_
* `package_010 <package_rules.html#package-010>`_
* `package_body_502 <package_body_rules.html#package-body-502>`_
* `package_body_507 <package_body_rules.html#package-body-507>`_
* `port_010 <port_rules.html#port-010>`_
* `port_map_002 <port_map_rules.html#port-map-002>`_
* `procedure_501 <procedure_rules.html#procedure-501>`_
* `procedure_506 <procedure_rules.html#procedure-506>`_
* `signal_004 <signal_rules.html#signal-004>`_
* `type_004 <type_rules.html#type-004>`_
* `type_500 <type_rules.html#type-500>`_
* `use_clause_500 <use_clause_rules.html#use-clause-500>`_
* `use_clause_501 <use_clause_rules.html#use-clause-501>`_
* `use_clause_502 <use_clause_rules.html#use-clause-502>`_
* `variable_004 <variable_rules.html#variable-004>`_

View File

@ -0,0 +1,197 @@
Case Rule Group
---------------
Rules Enforcing Case Rule Group
###############################
* `alias_declaration_500 <alias_declaration_rules.html#alias-declaration-500>`_
* `alias_declaration_501 <alias_declaration_rules.html#alias-declaration-501>`_
* `alias_declaration_502 <alias_declaration_rules.html#alias-declaration-502>`_
* `alias_declaration_503 <alias_declaration_rules.html#alias-declaration-503>`_
* `architecture_004 <architecture_rules.html#architecture-004>`_
* `architecture_009 <architecture_rules.html#architecture-009>`_
* `architecture_011 <architecture_rules.html#architecture-011>`_
* `architecture_013 <architecture_rules.html#architecture-013>`_
* `architecture_014 <architecture_rules.html#architecture-014>`_
* `architecture_019 <architecture_rules.html#architecture-019>`_
* `architecture_020 <architecture_rules.html#architecture-020>`_
* `architecture_021 <architecture_rules.html#architecture-021>`_
* `architecture_028 <architecture_rules.html#architecture-028>`_
* `architecture_600 <architecture_rules.html#architecture-600>`_
* `architecture_601 <architecture_rules.html#architecture-601>`_
* `attribute_500 <attribute_rules.html#attribute-500>`_
* `attribute_declaration_500 <attribute_declaration_rules.html#attribute-declaration-500>`_
* `attribute_declaration_501 <attribute_declaration_rules.html#attribute-declaration-501>`_
* `attribute_declaration_502 <attribute_declaration_rules.html#attribute-declaration-502>`_
* `attribute_specification_500 <attribute_specification_rules.html#attribute-specification-500>`_
* `attribute_specification_501 <attribute_specification_rules.html#attribute-specification-501>`_
* `attribute_specification_502 <attribute_specification_rules.html#attribute-specification-502>`_
* `attribute_specification_503 <attribute_specification_rules.html#attribute-specification-503>`_
* `block_500 <block_rules.html#block-500>`_
* `block_501 <block_rules.html#block-501>`_
* `block_502 <block_rules.html#block-502>`_
* `block_503 <block_rules.html#block-503>`_
* `block_504 <block_rules.html#block-504>`_
* `block_505 <block_rules.html#block-505>`_
* `block_506 <block_rules.html#block-506>`_
* `case_014 <case_rules.html#case-014>`_
* `case_015 <case_rules.html#case-015>`_
* `case_016 <case_rules.html#case-016>`_
* `case_017 <case_rules.html#case-017>`_
* `case_018 <case_rules.html#case-018>`_
* `case_generate_alternative_500 <case_generate_alternative_rules.html#case-generate-alternative-500>`_
* `case_generate_alternative_501 <case_generate_alternative_rules.html#case-generate-alternative-501>`_
* `case_generate_statement_500 <case_generate_statement_rules.html#case-generate-statement-500>`_
* `case_generate_statement_501 <case_generate_statement_rules.html#case-generate-statement-501>`_
* `component_004 <component_rules.html#component-004>`_
* `component_006 <component_rules.html#component-006>`_
* `component_008 <component_rules.html#component-008>`_
* `component_010 <component_rules.html#component-010>`_
* `component_012 <component_rules.html#component-012>`_
* `component_014 <component_rules.html#component-014>`_
* `conditional_expressions_500 <conditional_expressions_rules.html#conditional-expressions-500>`_
* `conditional_expressions_501 <conditional_expressions_rules.html#conditional-expressions-501>`_
* `conditional_waveforms_500 <conditional_waveforms_rules.html#conditional-waveforms-500>`_
* `conditional_waveforms_501 <conditional_waveforms_rules.html#conditional-waveforms-501>`_
* `constant_002 <constant_rules.html#constant-002>`_
* `constant_004 <constant_rules.html#constant-004>`_
* `constant_013 <constant_rules.html#constant-013>`_
* `context_004 <context_rules.html#context-004>`_
* `context_012 <context_rules.html#context-012>`_
* `context_013 <context_rules.html#context-013>`_
* `context_014 <context_rules.html#context-014>`_
* `context_015 <context_rules.html#context-015>`_
* `context_016 <context_rules.html#context-016>`_
* `context_ref_003 <context_ref_rules.html#context-ref-003>`_
* `context_ref_500 <context_ref_rules.html#context-ref-500>`_
* `context_ref_501 <context_ref_rules.html#context-ref-501>`_
* `entity_004 <entity_rules.html#entity-004>`_
* `entity_006 <entity_rules.html#entity-006>`_
* `entity_008 <entity_rules.html#entity-008>`_
* `entity_010 <entity_rules.html#entity-010>`_
* `entity_012 <entity_rules.html#entity-012>`_
* `entity_014 <entity_rules.html#entity-014>`_
* `entity_500 <entity_rules.html#entity-500>`_
* `entity_600 <entity_rules.html#entity-600>`_
* `entity_specification_500 <entity_specification_rules.html#entity-specification-500>`_
* `entity_specification_501 <entity_specification_rules.html#entity-specification-501>`_
* `entity_specification_503 <entity_specification_rules.html#entity-specification-503>`_
* `exponent_500 <exponent_rules.html#exponent-500>`_
* `file_002 <file_rules.html#file-002>`_
* `for_generate_statement_500 <for_generate_statement_rules.html#for-generate-statement-500>`_
* `for_generate_statement_501 <for_generate_statement_rules.html#for-generate-statement-501>`_
* `function_004 <function_rules.html#function-004>`_
* `function_005 <function_rules.html#function-005>`_
* `function_010 <function_rules.html#function-010>`_
* `function_013 <function_rules.html#function-013>`_
* `function_014 <function_rules.html#function-014>`_
* `function_017 <function_rules.html#function-017>`_
* `function_502 <function_rules.html#function-502>`_
* `function_506 <function_rules.html#function-506>`_
* `generate_005 <generate_rules.html#generate-005>`_
* `generate_009 <generate_rules.html#generate-009>`_
* `generate_010 <generate_rules.html#generate-010>`_
* `generate_012 <generate_rules.html#generate-012>`_
* `generate_500 <generate_rules.html#generate-500>`_
* `generate_501 <generate_rules.html#generate-501>`_
* `generic_007 <generic_rules.html#generic-007>`_
* `generic_009 <generic_rules.html#generic-009>`_
* `generic_017 <generic_rules.html#generic-017>`_
* `generic_map_001 <generic_map_rules.html#generic-map-001>`_
* `generic_map_002 <generic_map_rules.html#generic-map-002>`_
* `ieee_500 <ieee_rules.html#ieee-500>`_
* `if_generate_statement_500 <if_generate_statement_rules.html#if-generate-statement-500>`_
* `if_generate_statement_501 <if_generate_statement_rules.html#if-generate-statement-501>`_
* `if_generate_statement_502 <if_generate_statement_rules.html#if-generate-statement-502>`_
* `if_generate_statement_503 <if_generate_statement_rules.html#if-generate-statement-503>`_
* `if_025 <if_rules.html#if-025>`_
* `if_026 <if_rules.html#if-026>`_
* `if_027 <if_rules.html#if-027>`_
* `if_028 <if_rules.html#if-028>`_
* `if_029 <if_rules.html#if-029>`_
* `if_034 <if_rules.html#if-034>`_
* `instantiation_008 <instantiation_rules.html#instantiation-008>`_
* `instantiation_009 <instantiation_rules.html#instantiation-009>`_
* `instantiation_027 <instantiation_rules.html#instantiation-027>`_
* `instantiation_028 <instantiation_rules.html#instantiation-028>`_
* `instantiation_031 <instantiation_rules.html#instantiation-031>`_
* `iteration_scheme_500 <iteration_scheme_rules.html#iteration-scheme-500>`_
* `iteration_scheme_501 <iteration_scheme_rules.html#iteration-scheme-501>`_
* `library_004 <library_rules.html#library-004>`_
* `library_005 <library_rules.html#library-005>`_
* `library_500 <library_rules.html#library-500>`_
* `logical_operator_500 <logical_operator_rules.html#logical-operator-500>`_
* `loop_statement_500 <loop_statement_rules.html#loop-statement-500>`_
* `loop_statement_501 <loop_statement_rules.html#loop-statement-501>`_
* `loop_statement_502 <loop_statement_rules.html#loop-statement-502>`_
* `loop_statement_503 <loop_statement_rules.html#loop-statement-503>`_
* `loop_statement_504 <loop_statement_rules.html#loop-statement-504>`_
* `package_004 <package_rules.html#package-004>`_
* `package_006 <package_rules.html#package-006>`_
* `package_008 <package_rules.html#package-008>`_
* `package_010 <package_rules.html#package-010>`_
* `package_013 <package_rules.html#package-013>`_
* `package_018 <package_rules.html#package-018>`_
* `package_body_500 <package_body_rules.html#package-body-500>`_
* `package_body_501 <package_body_rules.html#package-body-501>`_
* `package_body_502 <package_body_rules.html#package-body-502>`_
* `package_body_503 <package_body_rules.html#package-body-503>`_
* `package_body_504 <package_body_rules.html#package-body-504>`_
* `package_body_505 <package_body_rules.html#package-body-505>`_
* `package_body_506 <package_body_rules.html#package-body-506>`_
* `package_body_507 <package_body_rules.html#package-body-507>`_
* `port_010 <port_rules.html#port-010>`_
* `port_017 <port_rules.html#port-017>`_
* `port_018 <port_rules.html#port-018>`_
* `port_019 <port_rules.html#port-019>`_
* `port_map_001 <port_map_rules.html#port-map-001>`_
* `port_map_002 <port_map_rules.html#port-map-002>`_
* `procedure_007 <procedure_rules.html#procedure-007>`_
* `procedure_008 <procedure_rules.html#procedure-008>`_
* `procedure_009 <procedure_rules.html#procedure-009>`_
* `procedure_500 <procedure_rules.html#procedure-500>`_
* `procedure_501 <procedure_rules.html#procedure-501>`_
* `procedure_502 <procedure_rules.html#procedure-502>`_
* `procedure_503 <procedure_rules.html#procedure-503>`_
* `procedure_504 <procedure_rules.html#procedure-504>`_
* `procedure_505 <procedure_rules.html#procedure-505>`_
* `procedure_506 <procedure_rules.html#procedure-506>`_
* `procedure_507 <procedure_rules.html#procedure-507>`_
* `procedure_call_500 <procedure_call_rules.html#procedure-call-500>`_
* `procedure_call_501 <procedure_call_rules.html#procedure-call-501>`_
* `process_004 <process_rules.html#process-004>`_
* `process_005 <process_rules.html#process-005>`_
* `process_008 <process_rules.html#process-008>`_
* `process_009 <process_rules.html#process-009>`_
* `process_013 <process_rules.html#process-013>`_
* `process_017 <process_rules.html#process-017>`_
* `process_019 <process_rules.html#process-019>`_
* `range_001 <range_rules.html#range-001>`_
* `range_002 <range_rules.html#range-002>`_
* `record_type_definition_500 <record_type_definition_rules.html#record-type-definition-500>`_
* `record_type_definition_501 <record_type_definition_rules.html#record-type-definition-501>`_
* `record_type_definition_502 <record_type_definition_rules.html#record-type-definition-502>`_
* `report_statement_500 <report_statement_rules.html#report-statement-500>`_
* `report_statement_501 <report_statement_rules.html#report-statement-501>`_
* `selected_assignment_500 <selected_assignment_rules.html#selected-assignment-500>`_
* `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>`_
* `signal_002 <signal_rules.html#signal-002>`_
* `signal_004 <signal_rules.html#signal-004>`_
* `signal_014 <signal_rules.html#signal-014>`_
* `subtype_002 <subtype_rules.html#subtype-002>`_
* `type_002 <type_rules.html#type-002>`_
* `type_004 <type_rules.html#type-004>`_
* `type_013 <type_rules.html#type-013>`_
* `type_014 <type_rules.html#type-014>`_
* `type_500 <type_rules.html#type-500>`_
* `use_clause_500 <use_clause_rules.html#use-clause-500>`_
* `use_clause_501 <use_clause_rules.html#use-clause-501>`_
* `use_clause_502 <use_clause_rules.html#use-clause-502>`_
* `use_clause_503 <use_clause_rules.html#use-clause-503>`_
* `variable_002 <variable_rules.html#variable-002>`_
* `variable_004 <variable_rules.html#variable-004>`_
* `variable_011 <variable_rules.html#variable-011>`_

View File

@ -0,0 +1,3 @@
/#.*>/ {
s/-/_/g
}

View File

@ -0,0 +1,92 @@
Indent Rule Group
-----------------
Rules Enforcing Indent Rule Group
#################################
* `alias_declaration_300 <alias_declaration_rules.html#alias-declaration-300>`_
* `architecture_001 <architecture_rules.html#architecture-001>`_
* `architecture_007 <architecture_rules.html#architecture-007>`_
* `architecture_008 <architecture_rules.html#architecture-008>`_
* `assert_001 <assert_rules.html#assert-001>`_
* `attribute_declaration_300 <attribute_declaration_rules.html#attribute-declaration-300>`_
* `attribute_specification_300 <attribute_specification_rules.html#attribute-specification-300>`_
* `block_300 <block_rules.html#block-300>`_
* `block_301 <block_rules.html#block-301>`_
* `block_302 <block_rules.html#block-302>`_
* `case_001 <case_rules.html#case-001>`_
* `case_013 <case_rules.html#case-013>`_
* `comment_010 <comment_rules.html#comment-010>`_
* `component_001 <component_rules.html#component-001>`_
* `component_009 <component_rules.html#component-009>`_
* `concurrent_001 <concurrent_rules.html#concurrent-001>`_
* `constant_001 <constant_rules.html#constant-001>`_
* `context_001 <context_rules.html#context-001>`_
* `context_020 <context_rules.html#context-020>`_
* `context_ref_001 <context_ref_rules.html#context-ref-001>`_
* `entity_001 <entity_rules.html#entity-001>`_
* `entity_009 <entity_rules.html#entity-009>`_
* `entity_300 <entity_rules.html#entity-300>`_
* `exit_statement_300 <exit_statement_rules.html#exit-statement-300>`_
* `file_001 <file_rules.html#file-001>`_
* `function_001 <function_rules.html#function-001>`_
* `function_008 <function_rules.html#function-008>`_
* `function_016 <function_rules.html#function-016>`_
* `function_300 <function_rules.html#function-300>`_
* `generate_001 <generate_rules.html#generate-001>`_
* `generate_006 <generate_rules.html#generate-006>`_
* `generate_007 <generate_rules.html#generate-007>`_
* `generate_016 <generate_rules.html#generate-016>`_
* `generate_018 <generate_rules.html#generate-018>`_
* `generic_002 <generic_rules.html#generic-002>`_
* `generic_004 <generic_rules.html#generic-004>`_
* `generic_008 <generic_rules.html#generic-008>`_
* `if_generate_statement_300 <if_generate_statement_rules.html#if-generate-statement-300>`_
* `if_generate_statement_301 <if_generate_statement_rules.html#if-generate-statement-301>`_
* `if_001 <if_rules.html#if-001>`_
* `if_012 <if_rules.html#if-012>`_
* `if_013 <if_rules.html#if-013>`_
* `if_014 <if_rules.html#if-014>`_
* `instantiation_001 <instantiation_rules.html#instantiation-001>`_
* `iteration_scheme_300 <iteration_scheme_rules.html#iteration-scheme-300>`_
* `iteration_scheme_301 <iteration_scheme_rules.html#iteration-scheme-301>`_
* `library_001 <library_rules.html#library-001>`_
* `library_008 <library_rules.html#library-008>`_
* `loop_statement_300 <loop_statement_rules.html#loop-statement-300>`_
* `loop_statement_301 <loop_statement_rules.html#loop-statement-301>`_
* `loop_statement_302 <loop_statement_rules.html#loop-statement-302>`_
* `package_001 <package_rules.html#package-001>`_
* `package_015 <package_rules.html#package-015>`_
* `package_body_300 <package_body_rules.html#package-body-300>`_
* `package_body_301 <package_body_rules.html#package-body-301>`_
* `port_002 <port_rules.html#port-002>`_
* `port_004 <port_rules.html#port-004>`_
* `port_015 <port_rules.html#port-015>`_
* `procedure_001 <procedure_rules.html#procedure-001>`_
* `procedure_002 <procedure_rules.html#procedure-002>`_
* `procedure_003 <procedure_rules.html#procedure-003>`_
* `procedure_004 <procedure_rules.html#procedure-004>`_
* `procedure_005 <procedure_rules.html#procedure-005>`_
* `procedure_006 <procedure_rules.html#procedure-006>`_
* `procedure_call_300 <procedure_call_rules.html#procedure-call-300>`_
* `procedure_call_301 <procedure_call_rules.html#procedure-call-301>`_
* `procedure_call_302 <procedure_call_rules.html#procedure-call-302>`_
* `process_001 <process_rules.html#process-001>`_
* `process_003 <process_rules.html#process-003>`_
* `process_006 <process_rules.html#process-006>`_
* `record_type_definition_300 <record_type_definition_rules.html#record-type-definition-300>`_
* `record_type_definition_301 <record_type_definition_rules.html#record-type-definition-301>`_
* `report_statement_300 <report_statement_rules.html#report-statement-300>`_
* `selected_assignment_300 <selected_assignment_rules.html#selected-assignment-300>`_
* `sequential_001 <sequential_rules.html#sequential-001>`_
* `signal_001 <signal_rules.html#signal-001>`_
* `subtype_001 <subtype_rules.html#subtype-001>`_
* `type_001 <type_rules.html#type-001>`_
* `type_005 <type_rules.html#type-005>`_
* `type_012 <type_rules.html#type-012>`_
* `type_016 <type_rules.html#type-016>`_
* `variable_001 <variable_rules.html#variable-001>`_
* `variable_assignment_001 <variable_assignment_rules.html#variable-assignment-001>`_
* `wait_001 <wait_rules.html#wait-001>`_

View File

@ -0,0 +1,11 @@
Length Rule Group
-----------------
Rules Enforcing Length Rule Group
#################################
* `length_001 <length_rules.html#length-001>`_
* `length_002 <length_rules.html#length-002>`_
* `length_003 <length_rules.html#length-003>`_

View File

@ -0,0 +1,51 @@
Naming Rule Group
-----------------
Rules Enforcing Naming Rule Group
#################################
* `alias_declaration_600 <alias_declaration_rules.html#alias-declaration-600>`_
* `alias_declaration_601 <alias_declaration_rules.html#alias-declaration-601>`_
* `architecture_025 <architecture_rules.html#architecture-025>`_
* `block_600 <block_rules.html#block-600>`_
* `block_601 <block_rules.html#block-601>`_
* `constant_015 <constant_rules.html#constant-015>`_
* `constant_600 <constant_rules.html#constant-600>`_
* `generate_017 <generate_rules.html#generate-017>`_
* `generate_600 <generate_rules.html#generate-600>`_
* `generic_020 <generic_rules.html#generic-020>`_
* `generic_600 <generic_rules.html#generic-600>`_
* `generic_map_600 <generic_map_rules.html#generic-map-600>`_
* `generic_map_601 <generic_map_rules.html#generic-map-601>`_
* `instantiation_600 <instantiation_rules.html#instantiation-600>`_
* `instantiation_601 <instantiation_rules.html#instantiation-601>`_
* `loop_statement_600 <loop_statement_rules.html#loop-statement-600>`_
* `loop_statement_601 <loop_statement_rules.html#loop-statement-601>`_
* `package_016 <package_rules.html#package-016>`_
* `package_017 <package_rules.html#package-017>`_
* `package_body_600 <package_body_rules.html#package-body-600>`_
* `package_body_601 <package_body_rules.html#package-body-601>`_
* `port_011 <port_rules.html#port-011>`_
* `port_025 <port_rules.html#port-025>`_
* `port_600 <port_rules.html#port-600>`_
* `port_601 <port_rules.html#port-601>`_
* `port_602 <port_rules.html#port-602>`_
* `port_603 <port_rules.html#port-603>`_
* `port_604 <port_rules.html#port-604>`_
* `port_605 <port_rules.html#port-605>`_
* `port_606 <port_rules.html#port-606>`_
* `port_607 <port_rules.html#port-607>`_
* `port_608 <port_rules.html#port-608>`_
* `port_609 <port_rules.html#port-609>`_
* `process_036 <process_rules.html#process-036>`_
* `process_600 <process_rules.html#process-600>`_
* `signal_008 <signal_rules.html#signal-008>`_
* `signal_600 <signal_rules.html#signal-600>`_
* `subtype_004 <subtype_rules.html#subtype-004>`_
* `subtype_600 <subtype_rules.html#subtype-600>`_
* `type_015 <type_rules.html#type-015>`_
* `type_600 <type_rules.html#type-600>`_
* `variable_012 <variable_rules.html#variable-012>`_
* `variable_600 <variable_rules.html#variable-600>`_

View File

@ -0,0 +1,49 @@
Overview
========
Rule groups allow for easier configuration of rules that perform similar functions.
Using rule groups can make upgrading VSG versions easier as new rules are added.
The following is a list of the rule groups:
+-------------------------+---------------------------------------------------------+
| Group | Description |
+-------------------------+---------------------------------------------------------+
| alignment | Horizontal alignment rules. |
+-------------------------+---------------------------------------------------------+
| blank_line | Vertical alignment rules. |
+-------------------------+---------------------------------------------------------+
| case | All rules involving lower and upper casing. |
+-------------------------+---------------------------------------------------------+
| case::keyword | Casing rules for VHDL keywords. |
+-------------------------+---------------------------------------------------------+
| case::label | Casing rules for labels. |
+-------------------------+---------------------------------------------------------+
| case::name | Casing rules for identifiers, etc... |
+-------------------------+---------------------------------------------------------+
| length | Rules restricting length. |
+-------------------------+---------------------------------------------------------+
| indent | Rules involving line indents. |
+-------------------------+---------------------------------------------------------+
| naming | Rules for constraining how identifiers etc.. are named. |
+-------------------------+---------------------------------------------------------+
| structure | Rules dictating the structure of the code. |
+-------------------------+---------------------------------------------------------+
| structure::optional | Rules for optional VHDL language items. |
+-------------------------+---------------------------------------------------------+
| whitespace | Rules for managing whitespace. |
+-------------------------+---------------------------------------------------------+
Subgroups
---------
Groups with double colons (::) are considered subgroups.
This allows for finer control of group rules.
For example, the case of keywords, labels and names can be set independently.
Configuring Groups
------------------
Refer to the section `Configuring a Rule Group <configuring_rule_groups.html>`_ for information on how to configure rule groups.

View File

@ -0,0 +1,20 @@
Structure::Optional Rule Group
------------------------------
Rules Enforcing Structure::Optional Rule Group
##############################################
* `architecture_010 <architecture_rules.html#architecture-010>`_
* `architecture_024 <architecture_rules.html#architecture-024>`_
* `block_002 <block_rules.html#block-002>`_
* `block_007 <block_rules.html#block-007>`_
* `component_021 <component_rules.html#component-021>`_
* `context_021 <context_rules.html#context-021>`_
* `context_022 <context_rules.html#context-022>`_
* `entity_019 <entity_rules.html#entity-019>`_
* `generate_011 <generate_rules.html#generate-011>`_
* `instantiation_033 <instantiation_rules.html#instantiation-033>`_
* `process_012 <process_rules.html#process-012>`_
* `record_type_definition_005 <record_type_definition_rules.html#record-type-definition-005>`_

View File

@ -0,0 +1,170 @@
Structure Rule Group
--------------------
Rules Enforcing Structure Rule Group
####################################
* `after_001 <after_rules.html#after-001>`_
* `after_003 <after_rules.html#after-003>`_
* `alias_declaration_001 <alias_rules.html#alias-declaration-001>`_
* `architecture_005 <architecture_rules.html#architecture-005>`_
* `architecture_006 <architecture_rules.html#architecture-006>`_
* `architecture_010 <architecture_rules.html#architecture-010>`_
* `architecture_024 <architecture_rules.html#architecture-024>`_
* `assert_002 <assert_rules.html#assert-002>`_
* `assert_003 <assert_rules.html#assert-003>`_
* `assert_004 <assert_rules.html#assert-004>`_
* `assert_005 <assert_rules.html#assert-005>`_
* `block_001 <block_rules.html#block-001>`_
* `block_002 <block_rules.html#block-002>`_
* `block_003 <block_rules.html#block-003>`_
* `block_004 <block_rules.html#block-004>`_
* `block_005 <block_rules.html#block-005>`_
* `block_006 <block_rules.html#block-006>`_
* `block_007 <block_rules.html#block-007>`_
* `block_comment_001 <block_comment_rules.html#block-comment-001>`_
* `block_comment_002 <block_comment_rules.html#block-comment-002>`_
* `block_comment_003 <block_comment_rules.html#block-comment-003>`_
* `case_012 <case_rules.html#case-012>`_
* `case_019 <case_rules.html#case-019>`_
* `case_020 <case_rules.html#case-020>`_
* `comment_011 <comment_rules.html#comment-011>`_
* `component_005 <component_rules.html#component-005>`_
* `component_019 <component_rules.html#component-019>`_
* `component_021 <component_rules.html#component-021>`_
* `concurrent_005 <concurrent_rules.html#concurrent-005>`_
* `concurrent_007 <concurrent_rules.html#concurrent-007>`_
* `concurrent_011 <concurrent_rules.html#concurrent-011>`_
* `concurrent_012 <concurrent_rules.html#concurrent-012>`_
* `constant_007 <constant_rules.html#constant-007>`_
* `constant_016 <constant_rules.html#constant-016>`_
* `constant_017 <constant_rules.html#constant-017>`_
* `context_005 <context_rules.html#context-005>`_
* `context_006 <context_rules.html#context-006>`_
* `context_007 <context_rules.html#context-007>`_
* `context_008 <context_rules.html#context-008>`_
* `context_009 <context_rules.html#context-009>`_
* `context_010 <context_rules.html#context-010>`_
* `context_011 <context_rules.html#context-011>`_
* `context_021 <context_rules.html#context-021>`_
* `context_022 <context_rules.html#context-022>`_
* `context_ref_005 <context_ref_rules.html#context-ref-005>`_
* `entity_005 <entity_rules.html#entity-005>`_
* `entity_015 <entity_rules.html#entity-015>`_
* `entity_019 <entity_rules.html#entity-019>`_
* `entity_021 <entity_rules.html#entity-021>`_
* `entity_022 <entity_rules.html#entity-022>`_
* `entity_023 <entity_rules.html#entity-023>`_
* `entity_024 <entity_rules.html#entity-024>`_
* `entity_025 <entity_rules.html#entity-025>`_
* `entity_026 <entity_rules.html#entity-026>`_
* `entity_027 <entity_rules.html#entity-027>`_
* `entity_028 <entity_rules.html#entity-028>`_
* `entity_029 <entity_rules.html#entity-029>`_
* `function_009 <function_rules.html#function-009>`_
* `generate_011 <generate_rules.html#generate-011>`_
* `generate_015 <generate_rules.html#generate-015>`_
* `generate_019 <generate_rules.html#generate-019>`_
* `generic_010 <generic_rules.html#generic-010>`_
* `generic_013 <generic_rules.html#generic-013>`_
* `generic_016 <generic_rules.html#generic-016>`_
* `generic_018 <generic_rules.html#generic-018>`_
* `generic_021 <generic_rules.html#generic-021>`_
* `generic_map_003 <generic_map_rules.html#generic-map-003>`_
* `generic_map_004 <generic_map_rules.html#generic-map-004>`_
* `generic_map_005 <generic_map_rules.html#generic-map-005>`_
* `generic_map_008 <generic_map_rules.html#generic-map-008>`_
* `if_002 <if_rules.html#if-002>`_
* `if_020 <if_rules.html#if-020>`_
* `if_021 <if_rules.html#if-021>`_
* `if_022 <if_rules.html#if-022>`_
* `if_023 <if_rules.html#if-023>`_
* `if_024 <if_rules.html#if-024>`_
* `if_035 <if_rules.html#if-035>`_
* `if_036 <if_rules.html#if-036>`_
* `instantiation_005 <instantiation_rules.html#instantiation-005>`_
* `instantiation_012 <instantiation_rules.html#instantiation-012>`_
* `instantiation_023 <instantiation_rules.html#instantiation-023>`_
* `instantiation_033 <instantiation_rules.html#instantiation-033>`_
* `instantiation_034 <instantiation_rules.html#instantiation-034>`_
* `instantiation_035 <instantiation_rules.html#instantiation-035>`_
* `library_010 <library_rules.html#library-010>`_
* `library_011 <library_rules.html#library-011>`_
* `loop_statement_001 <loop_statement_rules.html#loop-statement-001>`_
* `loop_statement_002 <loop_statement_rules.html#loop-statement-002>`_
* `loop_statement_003 <loop_statement_rules.html#loop-statement-003>`_
* `loop_statement_004 <loop_statement_rules.html#loop-statement-004>`_
* `loop_statement_005 <loop_statement_rules.html#loop-statement-005>`_
* `loop_statement_006 <loop_statement_rules.html#loop-statement-006>`_
* `loop_statement_007 <loop_statement_rules.html#loop-statement-007>`_
* `package_005 <package_rules.html#package-005>`_
* `package_007 <package_rules.html#package-007>`_
* `package_014 <package_rules.html#package-014>`_
* `package_body_001 <package_body_rules.html#package-body-001>`_
* `package_body_002 <package_body_rules.html#package-body-002>`_
* `package_body_003 <package_body_rules.html#package-body-003>`_
* `port_012 <port_rules.html#port-012>`_
* `port_013 <port_rules.html#port-013>`_
* `port_014 <port_rules.html#port-014>`_
* `port_016 <port_rules.html#port-016>`_
* `port_021 <port_rules.html#port-021>`_
* `port_023 <port_rules.html#port-023>`_
* `port_026 <port_rules.html#port-026>`_
* `port_027 <port_rules.html#port-027>`_
* `port_map_003 <port_map_rules.html#port-map-003>`_
* `port_map_004 <port_map_rules.html#port-map-004>`_
* `port_map_005 <port_map_rules.html#port-map-005>`_
* `port_map_008 <port_map_rules.html#port-map-008>`_
* `port_map_009 <port_map_rules.html#port-map-009>`_
* `procedure_011 <procedure_rules.html#procedure-011>`_
* `procedure_call_001 <procedure_call_rules.html#procedure-call-001>`_
* `procedure_call_002 <procedure_call_rules.html#procedure-call-002>`_
* `procedure_call_003 <procedure_call_rules.html#procedure-call-003>`_
* `process_010 <process_rules.html#process-010>`_
* `process_012 <process_rules.html#process-012>`_
* `process_016 <process_rules.html#process-016>`_
* `process_018 <process_rules.html#process-018>`_
* `process_029 <process_rules.html#process-029>`_
* `process_030 <process_rules.html#process-030>`_
* `process_032 <process_rules.html#process-032>`_
* `record_type_definition_001 <record_type_definition_rules.html#record-type-definition-001>`_
* `record_type_definition_002 <record_type_definition_rules.html#record-type-definition-002>`_
* `record_type_definition_003 <record_type_definition_rules.html#record-type-definition-003>`_
* `record_type_definition_004 <record_type_definition_rules.html#record-type-definition-004>`_
* `record_type_definition_005 <record_type_definition_rules.html#record-type-definition-005>`_
* `record_type_definition_006 <record_type_definition_rules.html#record-type-definition-006>`_
* `record_type_definition_007 <record_type_definition_rules.html#record-type-definition-007>`_
* `report_statement_001 <report_statement_rules.html#report-statement-001>`_
* `report_statement_002 <report_statement_rules.html#report-statement-002>`_
* `selected_assignment_001 <selected_assignment_rules.html#selected-assignment-001>`_
* `selected_assignment_002 <selected_assignment_rules.html#selected-assignment-002>`_
* `selected_assignment_003 <selected_assignment_rules.html#selected-assignment-003>`_
* `selected_assignment_004 <selected_assignment_rules.html#selected-assignment-004>`_
* `selected_assignment_005 <selected_assignment_rules.html#selected-assignment-005>`_
* `selected_assignment_006 <selected_assignment_rules.html#selected-assignment-006>`_
* `selected_assignment_007 <selected_assignment_rules.html#selected-assignment-007>`_
* `selected_assignment_008 <selected_assignment_rules.html#selected-assignment-008>`_
* `selected_assignment_009 <selected_assignment_rules.html#selected-assignment-009>`_
* `selected_assignment_010 <selected_assignment_rules.html#selected-assignment-010>`_
* `selected_assignment_011 <selected_assignment_rules.html#selected-assignment-011>`_
* `selected_assignment_012 <selected_assignment_rules.html#selected-assignment-012>`_
* `sequential_006 <sequential_rules.html#sequential-006>`_
* `sequential_007 <sequential_rules.html#sequential-007>`_
* `sequential_008 <sequential_rules.html#sequential-008>`_
* `sequential_009 <sequential_rules.html#sequential-009>`_
* `signal_007 <signal_rules.html#signal-007>`_
* `signal_015 <signal_rules.html#signal-015>`_
* `signal_017 <signal_rules.html#signal-017>`_
* `source_file_001 <source_file_rules.html#source-file-001>`_
* `type_008 <type_rules.html#type-008>`_
* `type_009 <type_rules.html#type-009>`_
* `type_017 <type_rules.html#type-017>`_
* `type_018 <type_rules.html#type-018>`_
* `variable_007 <variable_rules.html#variable-007>`_
* `variable_017 <variable_rules.html#variable-017>`_
* `variable_assignment_006 <variable_assignment_rules.html#variable-assignment-006>`_
* `variable_assignment_007 <variable_assignment_rules.html#variable-assignment-007>`_
* `variable_assignment_008 <variable_assignment_rules.html#variable-assignment-008>`_
* `when_001 <when_rules.html#when-001>`_

View File

@ -0,0 +1,141 @@
Alignment Rule Group
--------------------
Rules Enforcing Alignment Rule Group
####################################
* `alias_declaration_100 <alias_declaration_rules.html#alias-declaration-100>`_
* `alias_declaration_101 <alias_declaration_rules.html#alias-declaration-101>`_
* `alias_declaration_102 <alias_declaration_rules.html#alias-declaration-102>`_
* `architecture_012 <architecture_rules.html#architecture-012>`_
* `architecture_022 <architecture_rules.html#architecture-022>`_
* `architecture_030 <architecture_rules.html#architecture-030>`_
* `architecture_031 <architecture_rules.html#architecture-031>`_
* `architecture_032 <architecture_rules.html#architecture-032>`_
* `architecture_033 <architecture_rules.html#architecture-033>`_
* `attribute_declaration_100 <attribute_declaration_rules.html#attribute-declaration-100>`_
* `attribute_declaration_101 <attribute_declaration_rules.html#attribute-declaration-101>`_
* `attribute_specification_100 <attribute_specification_rules.html#attribute-specification-100>`_
* `attribute_specification_101 <attribute_specification_rules.html#attribute-specification-101>`_
* `block_100 <block_rules.html#block-100>`_
* `block_101 <block_rules.html#block-101>`_
* `case_002 <case_rules.html#case-002>`_
* `case_003 <case_rules.html#case-003>`_
* `case_004 <case_rules.html#case-004>`_
* `case_005 <case_rules.html#case-005>`_
* `case_006 <case_rules.html#case-006>`_
* `comment_004 <comment_rules.html#comment-004>`_
* `comment_100 <comment_rules.html#comment-100>`_
* `component_002 <component_rules.html#component-002>`_
* `component_007 <component_rules.html#component-007>`_
* `component_011 <component_rules.html#component-011>`_
* `component_013 <component_rules.html#component-013>`_
* `concurrent_002 <concurrent_rules.html#concurrent-002>`_
* `concurrent_004 <concurrent_rules.html#concurrent-004>`_
* `conditional_expressions_100 <conditional_expressions_rules.html#conditional-expressions-100>`_
* `conditional_expressions_101 <conditional_expressions_rules.html#conditional-expressions-101>`_
* `conditional_expressions_102 <conditional_expressions_rules.html#conditional-expressions-102>`_
* `conditional_expressions_103 <conditional_expressions_rules.html#conditional-expressions-103>`_
* `conditional_waveforms_100 <conditional_waveforms_rules.html#conditional-waveforms-100>`_
* `conditional_waveforms_101 <conditional_waveforms_rules.html#conditional-waveforms-101>`_
* `conditional_waveforms_102 <conditional_waveforms_rules.html#conditional-waveforms-102>`_
* `conditional_waveforms_103 <conditional_waveforms_rules.html#conditional-waveforms-103>`_
* `constant_005 <constant_rules.html#constant-005>`_
* `constant_006 <constant_rules.html#constant-006>`_
* `constant_010 <constant_rules.html#constant-010>`_
* `constant_100 <constant_rules.html#constant-100>`_
* `context_002 <context_rules.html#context-002>`_
* `context_017 <context_rules.html#context-017>`_
* `context_018 <context_rules.html#context-018>`_
* `context_019 <context_rules.html#context-019>`_
* `context_ref_002 <context_ref_rules.html#context-ref-002>`_
* `element_association_100 <element_association_rules.html#element-association-100>`_
* `element_association_101 <element_association_rules.html#element-association-101>`_
* `entity_002 <entity_rules.html#entity-002>`_
* `entity_007 <entity_rules.html#entity-007>`_
* `entity_011 <entity_rules.html#entity-011>`_
* `entity_013 <entity_rules.html#entity-013>`_
* `entity_specification_100 <entity_specification_rules.html#entity-specification-100>`_
* `entity_specification_101 <entity_specification_rules.html#entity-specification-101>`_
* `function_100 <function_rules.html#function-100>`_
* `function_101 <function_rules.html#function-101>`_
* `generate_002 <generate_rules.html#generate-002>`_
* `generate_008 <generate_rules.html#generate-008>`_
* `generate_013 <generate_rules.html#generate-013>`_
* `generate_014 <generate_rules.html#generate-014>`_
* `generic_003 <generic_rules.html#generic-003>`_
* `generic_005 <generic_rules.html#generic-005>`_
* `generic_006 <generic_rules.html#generic-006>`_
* `generic_014 <generic_rules.html#generic-014>`_
* `generic_map_006 <generic_map_rules.html#generic-map-006>`_
* `generic_map_007 <generic_map_rules.html#generic-map-007>`_
* `if_003 <if_rules.html#if-003>`_
* `if_004 <if_rules.html#if-004>`_
* `if_005 <if_rules.html#if-005>`_
* `if_015 <if_rules.html#if-015>`_
* `instantiation_002 <instantiation_rules.html#instantiation-002>`_
* `instantiation_003 <instantiation_rules.html#instantiation-003>`_
* `instantiation_032 <instantiation_rules.html#instantiation-032>`_
* `iteration_scheme_100 <iteration_scheme_rules.html#iteration-scheme-100>`_
* `iteration_scheme_101 <iteration_scheme_rules.html#iteration-scheme-101>`_
* `library_002 <library_rules.html#library-002>`_
* `library_006 <library_rules.html#library-006>`_
* `loop_statement_100 <loop_statement_rules.html#loop-statement-100>`_
* `loop_statement_101 <loop_statement_rules.html#loop-statement-101>`_
* `loop_statement_102 <loop_statement_rules.html#loop-statement-102>`_
* `loop_statement_103 <loop_statement_rules.html#loop-statement-103>`_
* `loop_statement_104 <loop_statement_rules.html#loop-statement-104>`_
* `package_002 <package_rules.html#package-002>`_
* `package_009 <package_rules.html#package-009>`_
* `package_body_100 <package_body_rules.html#package-body-100>`_
* `package_body_101 <package_body_rules.html#package-body-101>`_
* `port_003 <port_rules.html#port-003>`_
* `port_007 <port_rules.html#port-007>`_
* `port_008 <port_rules.html#port-008>`_
* `port_009 <port_rules.html#port-009>`_
* `port_020 <port_rules.html#port-020>`_
* `port_map_007 <port_map_rules.html#port-map-007>`_
* `procedure_100 <procedure_rules.html#procedure-100>`_
* `procedure_101 <procedure_rules.html#procedure-101>`_
* `procedure_call_100 <procedure_call_rules.html#procedure-call-100>`_
* `procedure_call_101 <procedure_call_rules.html#procedure-call-101>`_
* `process_002 <process_rules.html#process-002>`_
* `process_007 <process_rules.html#process-007>`_
* `process_014 <process_rules.html#process-014>`_
* `process_024 <process_rules.html#process-024>`_
* `process_025 <process_rules.html#process-025>`_
* `record_type_definition_100 <record_type_definition_rules.html#record-type-definition-100>`_
* `record_type_definition_101 <record_type_definition_rules.html#record-type-definition-101>`_
* `report_statement_100 <report_statement_rules.html#report-statement-100>`_
* `report_statement_101 <report_statement_rules.html#report-statement-101>`_
* `selected_assignment_100 <selected_assignment_rules.html#selected-assignment-100>`_
* `selected_assignment_101 <selected_assignment_rules.html#selected-assignment-101>`_
* `selected_assignment_102 <selected_assignment_rules.html#selected-assignment-102>`_
* `selected_assignment_103 <selected_assignment_rules.html#selected-assignment-103>`_
* `selected_assignment_104 <selected_assignment_rules.html#selected-assignment-104>`_
* `selected_assignment_105 <selected_assignment_rules.html#selected-assignment-105>`_
* `selected_assignment_106 <selected_assignment_rules.html#selected-assignment-106>`_
* `selected_assignment_107 <selected_assignment_rules.html#selected-assignment-107>`_
* `sequential_002 <sequential_rules.html#sequential-002>`_
* `sequential_003 <sequential_rules.html#sequential-003>`_
* `signal_005 <signal_rules.html#signal-005>`_
* `signal_006 <signal_rules.html#signal-006>`_
* `type_006 <type_rules.html#type-006>`_
* `type_007 <type_rules.html#type-007>`_
* `variable_005 <variable_rules.html#variable-005>`_
* `variable_006 <variable_rules.html#variable-006>`_
* `variable_assignment_002 <variable_assignment_rules.html#variable-assignment-002>`_
* `variable_assignment_003 <variable_assignment_rules.html#variable-assignment-003>`_
* `whitespace_001 <whitespace_rules.html#whitespace-001>`_
* `whitespace_002 <whitespace_rules.html#whitespace-002>`_
* `whitespace_003 <whitespace_rules.html#whitespace-003>`_
* `whitespace_004 <whitespace_rules.html#whitespace-004>`_
* `whitespace_005 <whitespace_rules.html#whitespace-005>`_
* `whitespace_006 <whitespace_rules.html#whitespace-006>`_
* `whitespace_007 <whitespace_rules.html#whitespace-007>`_
* `whitespace_008 <whitespace_rules.html#whitespace-008>`_
* `whitespace_010 <whitespace_rules.html#whitespace-010>`_
* `whitespace_011 <whitespace_rules.html#whitespace-011>`_
* `whitespace_013 <whitespace_rules.html#whitespace-013>`_

View File

@ -99,6 +99,41 @@ class testDocGen(unittest.TestCase):
self.assertEqual(lExpected, lActual)
def test_rule_group_links(self):
self.maxDiff = None
oVhdlFile = vhdlFile.vhdlFile([''])
oRuleList = rule_list.rule_list(oVhdlFile, None, None)
lActual = []
dConfigurationFiles = {}
for oRule in oRuleList.rules:
for sGroup in oRule.groups:
dConfigurationFiles[sGroup] = []
for oRule in oRuleList.rules:
for sGroup in oRule.groups:
dConfigurationFiles[sGroup].append(oRule.unique_id)
for sKey in list(dConfigurationFiles.keys()):
sFileName = sKey.replace('::', '_') + '_rule_group.rst'
sFullPathFileName = os.path.join(sResultsDir,'..','..','..','docs','rule_groups',sFileName)
# print(sFullPathFileName)
lFile = []
utils.read_file(sFullPathFileName, lFile)
lActual = []
bStartProcessing = False
for sLine in lFile:
if bStartProcessing:
if sLine.startswith('*'):
lLine = sLine.split()
lActual.append(lLine[1][1:])
if sLine.startswith('Rules Enforcing'):
bStartProcessing = True
# print(dConfigurationFiles[sKey])
self.assertEqual(dConfigurationFiles[sKey], lActual)
def test_alias_declaration_rules_doc(self):
lExpected, lActual = compare_files('alias_declaration')