Skip to content

Commit 6142e0f

Browse files
committed
Issue#1391: Added docs for blank line rules for case generates.
1 parent 3b6612a commit 6142e0f

File tree

5 files changed

+87
-0
lines changed

5 files changed

+87
-0
lines changed

docs/case_generate_alternative_rules.rst

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,61 @@ This rule checks for a single space before the **=>** operator.
5353
5454
when 3 =>
5555
56+
case_generate_alternative_200
57+
#############################
58+
59+
|phase_3| |error| |blank_line|
60+
61+
This rule checks for a blank line below the **=>** keyword.
62+
63+
|configuring_blank_lines_link|
64+
65+
**Violation**
66+
67+
.. code-block:: vhdl
68+
69+
when 0 =>
70+
a <= b;
71+
72+
**Fix**
73+
74+
.. code-block:: vhdl
75+
76+
when 0 =>
77+
78+
a <= b;
79+
80+
case_generate_alternative_201
81+
#############################
82+
83+
|phase_3| |error| |blank_line|
84+
85+
This rule checks for blank lines or comments above the **when** keyword.
86+
87+
|configuring_previous_line_rules_link|
88+
89+
The default style is :code:`allow_comment`.
90+
91+
**Violation**
92+
93+
.. code-block:: vhdl
94+
95+
case data is
96+
when 3 =>
97+
-- Comment
98+
when 4 =>
99+
100+
**Fix**
101+
102+
.. code-block:: vhdl
103+
104+
case data is
105+
106+
when 3 =>
107+
108+
-- Comment
109+
when 4 =>
110+
56111
case_generate_alternative_300
57112
#############################
58113

docs/case_generate_statement_rules.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,32 @@ This rule checks for a single space before the **generate** keyword.
4646
4747
case data generate
4848
49+
case_generate_statement_200
50+
###########################
51+
52+
|phase_3| |error| |blank_line|
53+
54+
This rule checks for blank lines or comments above the **end** keyword.
55+
56+
|configuring_blank_lines_link|
57+
58+
**Violation**
59+
60+
.. code-block:: vhdl
61+
62+
when others =>
63+
null;
64+
end generate;
65+
66+
**Fix**
67+
68+
.. code-block:: vhdl
69+
70+
when others =>
71+
null;
72+
73+
end generate;
74+
4975
case_generate_statement_400
5076
###########################
5177

docs/configuring_blank_lines.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,8 @@ Rules Enforcing Blank Lines
146146
* `case_009 <case_rules.html#case-009>`_
147147
* `case_010 <case_rules.html#case-010>`_
148148
* `case_200 <case_rules.html#case-200>`_
149+
* `case_generate_alternative_200 <case_generate_alternative_rules.html#case-generate-alternative-200>`_
150+
* `case_generate_statement_200 <case_generate_statement_rules.html#case-generate-statement-200>`_
149151
* `component_016 <component_rules.html#component-016>`_
150152
* `component_018 <component_rules.html#component-018>`_
151153
* `constant_200 <constant_rules.html#constant-200>`_

docs/configuring_previous_line_rules.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -241,6 +241,7 @@ Rules Enforcing Previous Lines
241241
* `block_200 <block_rules.html#block-200>`_
242242
* `case_007 <case_rules.html#case-007>`_
243243
* `case_201 <case_rules.html#case-201>`_
244+
* `case_generate_alternative_201 <case_generate_alternative_rules.html#case-generate-alternative-201>`_
244245
* `component_003 <component_rules.html#component-003>`_
245246
* `context_003 <context_rules.html#context-003>`_
246247
* `entity_003 <entity_rules.html#entity-003>`_

docs/rule_groups/blank_line_rule_group.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ Rules Enforcing Blank Line Rule Group
2222
* `case_010 <../case_rules.html#case-010>`_
2323
* `case_200 <../case_rules.html#case-200>`_
2424
* `case_201 <../case_rules.html#case-201>`_
25+
* `case_generate_alternative_200 <../case_generate_alternative_rules.html#case-generate-alternative-200>`_
26+
* `case_generate_alternative_201 <../case_generate_alternative_rules.html#case-generate-alternative-201>`_
27+
* `case_generate_statement_200 <../case_generate_statement_rules.html#case-generate-statement-200>`_
2528
* `component_003 <../component_rules.html#component-003>`_
2629
* `component_016 <../component_rules.html#component-016>`_
2730
* `component_018 <../component_rules.html#component-018>`_

0 commit comments

Comments
 (0)