vhdl-style-guide/docs
Jukka Hertzog 00e59113f7
Merge pull request #1559 from JHertz5/issue-1555
Issue#1555: Added index constraint rules to rules index
2026-05-29 08:10:46 +01:00
..
developing Minor improvements in documentation 2024-10-05 17:56:25 +02:00
editor_integration Issue#1150: Fixing minor documentation issues. (#1151) 2024-03-26 19:46:14 -05:00
img Issue#1135: Adding documentation for rules which can not be automatically mixed. (#1136) 2024-04-16 20:13:31 -05:00
processes Updating release process documentation. 2024-12-07 14:59:55 -06:00
rule_groups Merge remote-tracking branch 'origin/master' into issue-1503 2026-05-23 17:35:55 +01:00
theory_of_operation Fixing tox style errors. 2024-10-20 18:35:25 -05:00
tool_integration Issue#1281: Typo corrections (#1282) 2024-11-10 07:55:57 -06:00
after_rules.rst Issue#1377: Improved consistency of formatting of keywords in documentation. 2024-12-28 17:06:35 +00:00
aggregate_rules.rst Issue#1280: Updated documentation. 2024-12-12 20:29:32 +00:00
alias_declaration_rules.rst Issue#1135: Adding documentation for rules which can not be automatically mixed. (#1136) 2024-04-16 20:13:31 -05:00
architecture_rules.rst Issue#1479: Modified `architecture_025` to accept regular expressions as names (#1487) 2025-09-03 07:19:16 -05:00
array_constraint_rules.rst Issue#1488: Doc corrections. 2025-08-24 22:44:10 +01:00
assert_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
attribute_declaration_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
attribute_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
attribute_specification_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
bit_string_literal_rules.rst Issue#1236: Rule for case in hexadecimal constants and base specifier (#1237) 2024-10-07 20:09:53 -05:00
block_comment_rules.rst Issue#1135: Adding documentation for rules which can not be automatically mixed. (#1136) 2024-04-16 20:13:31 -05:00
block_rules.rst Issue#1220: Documentation typo and link fixes. (#1221) 2024-09-08 19:41:38 -05:00
case_generate_alternative_rules.rst Issue#1391: Added docs for blank line rules for case generates. 2025-09-01 21:11:59 +01:00
case_generate_statement_rules.rst Issue#1391: Added docs for blank line rules for case generates. 2025-09-01 21:11:59 +01:00
case_rules.rst Issue#1392: Minor formatting fix in `case_300` documentation. (#1393) 2025-01-18 06:53:37 -06:00
choice_rules.rst Issue#1280: Updated documentation. 2024-12-12 20:29:32 +00:00
code_tags.rst Issue#1377: Improved consistency of formatting of keywords in documentation. 2024-12-28 17:06:35 +00:00
comment_rules.rst Fix comment indentation at end of scope (#1452) 2025-07-06 15:12:10 -05:00
component_rules.rst Issue#1178: Adding rule component_022 to add or remove optional component_simple_name. (#1179) 2024-06-14 07:04:07 -05:00
concurrent_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
conditional_expressions_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
conditional_waveforms_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
conf.py Fixing warnings during doc generation. (#1465) 2025-07-10 21:49:37 -05:00
configuring.rst Issue#1504: Added rules to restrict library and package names. (#1506) 2025-09-04 06:32:41 -05:00
configuring_array_multiline_structure_rules.rst Merge branch 'master' into issue-1503 2025-09-14 17:54:41 +01:00
configuring_blank_lines.rst Issue#1391: Added docs for blank line rules for case generates. 2025-09-01 21:11:59 +01:00
configuring_block_comments.rst Issue#1525: Removed extra lines from config example. 2025-12-30 21:06:55 +00:00
configuring_comment_indenting.rst Fix comment indentation at end of scope (#1452) 2025-07-06 15:12:10 -05:00
configuring_comment_keywords.rst Issue#927: Adding checks for keywords in comments. (#934) 2023-04-11 10:48:39 -05:00
configuring_conditional_multiline_indent_rules.rst Issue#1220: Documentation typo and link fixes. (#1221) 2024-09-08 19:41:38 -05:00
configuring_consecutive_blank_line_rules.rst Updates for issue #846 (#848) 2022-10-21 06:41:17 -05:00
configuring_disabled_rules.rst Issue#1504: Added rules to restrict library and package names. (#1506) 2025-09-04 06:32:41 -05:00
configuring_identifier_alignment_rules.rst Issue#1287: Added documentation for alignment rules for protected type body 2024-10-24 21:57:39 +01:00
configuring_indent_rules.rst Issue#1541: Corrected the examples and default value errors in the documentation. 2026-02-04 20:29:42 +08:00
configuring_indentation.rst Issue#1220: Documentation typo and link fixes. (#1221) 2024-09-08 19:41:38 -05:00
configuring_keyword_alignment_rules.rst Merge branch 'master' into issue-1503 2025-09-14 17:54:41 +01:00
configuring_length_rules.rst style: apply codespell 2024-03-24 21:16:34 +02:00
configuring_library_and_package_name_restriction_rules.rst Issue#1504: Added rules to restrict library and package names. (#1506) 2025-09-04 06:32:41 -05:00
configuring_move_token_rules.rst Issue#1009: Updating multiline alignment rules to accept booleans for paramters (#1018) 2023-10-22 06:46:42 -05:00
configuring_multiline_assert_rule.rst Issue#1541: Corrected the examples and default value errors in the documentation. 2026-02-04 20:29:42 +08:00
configuring_multiline_constraint_rules.rst Issue#1230: Updated documentation with corrections. (#1231) 2024-10-02 21:52:52 -05:00
configuring_multiline_indent_rules.rst Merge branch 'master' into issue-1503 2025-09-14 17:54:41 +01:00
configuring_number_of_signals_in_signal_declaration.rst Issue#1281: Typo corrections (#1282) 2024-11-10 07:55:57 -06:00
configuring_number_of_variables_in_variable_declaration.rst Fixing warnings during doc generation. (#1465) 2025-07-10 21:49:37 -05:00
configuring_optional_items.rst Issue#1459: Added architecture specification enforcement for entity instantiations (#1460) 2025-07-06 16:44:10 -05:00
configuring_overview.rst Issue#1230: Updated documentation with corrections. (#1231) 2024-10-02 21:52:52 -05:00
configuring_port_map_new_line.rst Issue#1377: Improved consistency of formatting of keywords in documentation. 2024-12-28 17:06:35 +00:00
configuring_port_mode_alignment.rst Issue#1150: Fixing minor documentation issues. (#1151) 2024-03-26 19:46:14 -05:00
configuring_pragmas.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
configuring_prefix_and_suffix_rules.rst Issue 1402 (#1406) 2025-03-06 06:02:15 -06:00
configuring_previous_line_rules.rst Issue#1391: Added docs for blank line rules for case generates. 2025-09-01 21:11:59 +01:00
configuring_procedure_call_statement_rules.rst Issue#1106 Corrections to procedure call docs. (#1109) 2024-01-21 12:42:40 -06:00
configuring_rule_groups.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
configuring_selected_assignment_structure_rules.rst Issue#1220: Documentation typo and link fixes. (#1221) 2024-09-08 19:41:38 -05:00
configuring_simple_multiline_structure_rules.rst Issue#1541: Corrected the examples and default value errors in the documentation. 2026-02-04 20:29:42 +08:00
configuring_subprogram_specification_statement_rules.rst Issue#1103: Adding structure rules for subprogram specifications. (#1108) 2024-01-27 09:35:04 -06:00
configuring_type_of_instantiations.rst Issue#1413: Fixing incorrect reference to rule in documentation. (#1414) 2025-09-01 09:51:24 -05:00
configuring_uppercase_and_lowercase_rules.rst Add new rule variable_500 to check case of keyword "shared" (#1464) 2025-07-08 19:43:04 -05:00
configuring_use_clause_indenting.rst Issue#1163: Fixing documentation on use clause indenting configuration. (#1164) 2024-04-04 20:16:45 -05:00
configuring_user_error_messages.rst Issue#1358: Adding user_error_message option. (#1387) 2025-03-02 12:14:53 -06:00
configuring_vhdl_reserved_words.rst Issue 1474: Add 2019 standard and its reserved keywords (#1476) 2025-09-02 21:25:48 -05:00
configuring_whitespace_after_comment_rules.rst style: remove trailing spaces 2024-03-24 21:16:35 +02:00
configuring_whitespace_rules.rst Merge remote-tracking branch 'origin/master' into issue-1492 2025-09-11 23:41:04 +01:00
constant_rules.rst Issue#1514: Corrected minor documentation mistakes for constant_001 and constant_007. 2025-09-14 15:42:21 +01:00
constrained_array_definition_rules.rst Issue#1492: Removed constrained_array_definition_100, shuffled other rules names down. 2025-09-11 23:39:42 +01:00
context_ref_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
context_rules.rst Issue#1377: Improved consistency of formatting of keywords in documentation. 2024-12-28 17:06:35 +00:00
continuous_integration_servers.rst style: apply codespell 2024-03-24 21:16:34 +02:00
contributing.rst Minor improvements in documentation 2024-10-05 17:56:25 +02:00
declarative_part_rules.rst Issue 864 (#895) 2022-12-13 18:05:24 -06:00
delay_mechanism_rules.rst Issue#1377: Improved consistency of formatting of keywords in documentation. 2024-12-28 17:06:35 +00:00
element_association_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
entity_rules.rst Issue#1377: Improved consistency of formatting of keywords in documentation. 2024-12-28 17:06:35 +00:00
entity_specification_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
example_configuration_json_file.json style: apply json 2024-03-24 21:16:35 +02:00
exit_statement_rules.rst Issue#1283: Split indent rules to treat labels separately from keywords (#1292) 2024-11-16 19:19:30 -06:00
exponent_rules.rst Issue#1377: Improved consistency of formatting of keywords in documentation. 2024-12-28 17:06:35 +00:00
external_constant_name_rules.rst Issue#1377: Improved consistency of formatting of keywords in documentation. 2024-12-28 17:06:35 +00:00
external_signal_name_rules.rst Issue#1377: Improved consistency of formatting of keywords in documentation. 2024-12-28 17:06:35 +00:00
external_variable_name_rules.rst Issue#1377: Improved consistency of formatting of keywords in documentation. 2024-12-28 17:06:35 +00:00
file_open_information_rules.rst Issue#1397: Added whitespace rules for file declarations (#1484) 2025-09-04 06:40:06 -05:00
file_rules.rst Issue#1397: Added whitespace rules for file declarations (#1484) 2025-09-04 06:40:06 -05:00
file_type_definition_rules.rst Issue#1383: Added case rules for file declarations (#1396) 2025-01-19 17:18:53 -06:00
for_generate_statement_rules.rst Issue#1385: Documentation correction for deprecated rules. 2025-01-04 21:09:49 +00:00
for_loop_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
formatting_terminal_output.rst Issue#1150: Fixing minor documentation issues. (#1151) 2024-03-26 19:46:14 -05:00
function_rules.rst Merge remote-tracking branch 'origin/master' into issue-1366 2024-12-30 09:31:44 +00:00
gallery.rst Minor updates to documentation. 2022-10-12 07:51:48 -05:00
generate_rules.rst Issue#1135: Adding documentation for rules which can not be automatically mixed. (#1136) 2024-04-16 20:13:31 -05:00
generic_map_rules.rst Issue#1333: Updated documentation. 2024-12-14 22:53:59 +00:00
generic_rules.rst Issue#1232: Updated documentation for rule generic_017. 2024-12-20 18:59:47 +00:00
icons.rst Issue#1135: Adding documentation for rules which can not be automatically mixed. (#1136) 2024-04-16 20:13:31 -05:00
ieee_rules.rst Issue#1377: Improved consistency of formatting of keywords in documentation. 2024-12-28 17:06:35 +00:00
if_generate_statement_rules.rst Issue#1377: Improved consistency of formatting of keywords in documentation. 2024-12-28 17:06:35 +00:00
if_rules.rst Issue#1220: Documentation typo and link fixes. (#1221) 2024-09-08 19:41:38 -05:00
includes.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
index.rst Issue#1119: Adding documentation for contributers (#1162) 2024-04-04 06:52:42 -05:00
index_constraint_rules.rst Issue#1488: Doc corrections. 2025-08-24 22:44:10 +01:00
index_subtype_definition_rules.rst #1491: Added docs for new rules. 2025-08-24 19:02:06 +01:00
installing.rst Minor improvements in documentation 2024-10-05 17:56:25 +02:00
instantiation_rules.rst Issue#1459: Added architecture specification enforcement for entity instantiations (#1460) 2025-07-06 16:44:10 -05:00
interface_incomplete_type_declaration_rules.rst Issue 1402 (#1406) 2025-03-06 06:02:15 -06:00
iteration_scheme_rules.rst Issue#1385: Documentation correction for deprecated rules. 2025-01-04 21:09:49 +00:00
length_rules.rst Issue#1135: Adding documentation for rules which can not be automatically mixed. (#1136) 2024-04-16 20:13:31 -05:00
library_rules.rst Issue#1504: Added rules to restrict library and package names. (#1506) 2025-09-04 06:32:41 -05:00
links.rst Issue#1504: Added rules to restrict library and package names. (#1506) 2025-09-04 06:32:41 -05:00
localizing.rst Issue#1230: Updated documentation with corrections. (#1231) 2024-10-02 21:52:52 -05:00
logical_operator_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
loop_statement_rules.rst Issue#1135: Adding documentation for rules which can not be automatically mixed. (#1136) 2024-04-16 20:13:31 -05:00
multiple_configurations.rst Issue#1096: Changing indentStyle to indent_style and indentSize to indent_size (#1115) 2024-02-18 15:17:56 -06:00
next_statement_rules.rst Issue#1283: Split indent rules to treat labels separately from keywords (#1292) 2024-11-16 19:19:30 -06:00
notepad_pp.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
null_statement_rules.rst Issue#1283: Split indent rules to treat labels separately from keywords (#1292) 2024-11-16 19:19:30 -06:00
overview.rst Issue#1411: Adding parsing for PSL. (#1412) 2025-03-12 07:22:48 -05:00
package_body_rules.rst Issue#1377: Improved consistency of formatting of keywords in documentation. 2024-12-28 17:06:35 +00:00
package_instantiation_rules.rst Issue#1377: Improved consistency of formatting of keywords in documentation. 2024-12-28 17:06:35 +00:00
package_rules.rst Issue#1377: Improved consistency of formatting of keywords in documentation. 2024-12-28 17:06:35 +00:00
parameter_specification_rules.rst Issue#1385: Updated documentation. 2025-01-04 17:41:24 +00:00
phases.rst
…
port_map_rules.rst Issue#1333: Updated documentation. 2024-12-14 22:53:59 +00:00
port_rules.rst Issue 1475: Add support for VHDL 2019 views (#1477) 2025-09-03 21:36:40 -05:00
pragma_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
pragmas.rst
…
procedure_call_rules.rst Issue#1251: Added rules to enforce case on parameters in functions and procedures (#1254) 2024-11-10 07:36:31 -06:00
procedure_rules.rst Merge remote-tracking branch 'origin/master' into issue-1366 2024-12-30 09:31:44 +00:00
process_rules.rst Issue#1496: Corrected documentation typo. (#1497) 2025-09-04 21:40:42 -05:00
protected_type_body_rules.rst Merge remote-tracking branch 'origin/master' into issue-1287 2024-11-17 02:16:12 +00:00
protected_type_rules.rst Issue#1288: Added indent rules for protected type declarations and bodies (#1294) 2024-11-16 19:24:43 -06:00
range_constraint_rules.rst #1491: Added docs for new rules. 2025-08-24 19:02:06 +01:00
range_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
record_type_definition_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
release_notes.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
report_statement_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
reserved_rules.rst Issue-1225 vsg_rule_doc_gen script does not run. (#1226) 2024-09-08 19:51:31 -05:00
return_statement_rules.rst Issue#1267: Updated rule return_statement_300 to handle label alignment (#1268) 2024-11-09 14:18:19 -06:00
rule_groups.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
rule_severity.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
rules.rst Issue#155: Added index constraint rules to rules index. 2026-05-28 23:38:02 +01:00
selected_assignment_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
sequential_rules.rst Issue#1135: Adding documentation for rules which can not be automatically mixed. (#1136) 2024-04-16 20:13:31 -05:00
shift_operator_rules.rst Issue#1350: Updated documentation for new rules. 2024-12-14 09:23:22 +00:00
signal_rules.rst Issue#1511: Added missing semicolon. 2025-09-14 15:37:01 +01:00
source_file_rules.rst Issue#1135: Adding documentation for rules which can not be automatically mixed. (#1136) 2024-04-16 20:13:31 -05:00
styles.rst Issue#1096: Changing indentStyle to indent_style and indentSize to indent_size (#1115) 2024-02-18 15:17:56 -06:00
subprogram_body_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
subprogram_instantiation_rules.rst Merge remote-tracking branch 'origin/master' into issue-1366 2025-01-04 18:47:29 +00:00
subprogram_kind_rules.rst Issue#1364: Corrected rule fix examples in documentation. 2025-01-01 13:56:46 +00:00
subtype_rules.rst Issue#1232: Updated documentation after reverting the disabling of subtype_002 and type_014. 2024-12-20 19:02:36 +00:00
type_mark_rules.rst Issue#1232: Updated documentation for type_mark_500. 2024-12-20 19:33:25 +00:00
type_rules.rst Issue#1377: Improved consistency of formatting of keywords in documentation. 2024-12-28 17:06:35 +00:00
unbounded_array_definition_rules.rst Issue#1492: Removed constrained_array_definition_100, shuffled other rules names down. 2025-09-11 23:39:42 +01:00
unfixable_rules.rst Issue#1504: Added rules to restrict library and package names. (#1506) 2025-09-04 06:32:41 -05:00
usage.rst Issue#1150: Fixing minor documentation issues. (#1151) 2024-03-26 19:46:14 -05:00
use_clause_rules.rst Issue#1504: Added rules to restrict library and package names. (#1506) 2025-09-04 06:32:41 -05:00
variable_assignment_rules.rst Issue#1135: Adding documentation for rules which can not be automatically mixed. (#1136) 2024-04-16 20:13:31 -05:00
variable_rules.rst Issue#1510: Added docs for new rules to handle multiline variable initialisations. 2025-09-14 17:37:50 +01:00
wait_rules.rst Issue#1283: Split indent rules to treat labels separately from keywords (#1292) 2024-11-16 19:19:30 -06:00
when_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
while_loop_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00
whitespace_rules.rst Merge remote-tracking branch 'origin/master' into issue-1488 2025-09-11 23:34:17 +01:00
with_rules.rst style: apply end-of-file-fixer 2024-03-24 21:16:35 +02:00