Welcome to vhdl-style-guide’s documentation!

Contents:

• Overview
  • Why VSG?
  • Key Benefits
  • Key Features
  • Known Limitations
• Gallery
  • Entities
  • Architectures
  • Component Declarations
  • Component Instantiations
  • Concurrent Signal Assignments
• Installation
  • PIP
  • GitHub
• Usage
  • Use Cases
  • Error Codes
• Formatting Terminal Output
  • VSG
  • Syntastic
  • Summary
• Styles
  • Style Descriptions
  • Adjusting built in styles
• Configuring
  • Overview
  • Multiple configurations
  • Configuring Array Multiline Structure Rules
  • Configuring Blank Lines
  • Configuring Block Comments
  • Configuring Comment Keywords
  • Configuring Conditional Multiline Indent Rules
  • Configuring Consecutive Blank Line Rules
  • Configuring Disabled Rules
  • Configuring Identifier Alignment Rules
  • Configuring Indentation
  • Configuring Indent Rules
  • Configuring Keyword Alignment Rules
  • Configuring Length Rules
  • Configuring Move Token Rules
  • Configuring Multiline Assert Rule
  • Configuring Multiline Constraint Rules
  • Configuring Multiline Indent Rules
  • Configuring Number of Signals in Signal Declaration
  • Configuring Optional Items
  • Configuring Port Map New Line
  • Configuring Port Mode Alignment
  • Configuring Pragmas
  • Configuring Prefix and Suffix Rules
  • Configuring Previous Line Rules
  • Configuring Procedure Call Statement Rules
  • Configuring Rule Groups
  • Configuring Simple Multiline Structure Rules
  • Configuring Subprogram Specification Statement Rules
  • Configuring Type of Instantiations
  • Configuring Uppercase and Lowercase Rules
  • Configuring Use Clause Indenting
  • Configuring Whitespace Rules
  • Configuring Whitespace After Comment Rules
  • Configuring VHDL Reserved Words
• Code Tags
  • Full rule exclusion
  • Individual Rule Exclusions
  • Next Line Rule Exclusions
  • Comments in code tags
• Continuous Integration Servers
  • JUnit Report
  • Code Quality Report
• Editor Integration
  • VIM
  • NeoVim
  • VSCode
• Tool Integration
  • Generic Tool Integration
  • pre-commit Integration
• Pragmas
• Localizing
  • Example: Create rule to check for entity and architectures in the same file.
  • Understanding the Rule class
  • Violation dictionary
  • Rule creation guidelines
• Phases
  • Phase - Structural
  • Phase - Whitespace
  • Phase - Vertical Spacing
  • Phase - Indentation
  • Phase - Alignment
  • Phase - Capitalization
  • Phase - Naming conventions
  • Subphases
• Rule Severity
  • Configuring Severity Levels
  • Defining Severity Levels
• Rule Groups
  • Overview
  • Alignment Rule Group
  • Blank Line Rule Group
  • Case Rule Group
  • Case::Keyword Rule Group
  • Case::Label Rule Group
  • Case::Name Rule Group
  • Length Rule Group
  • Indent Rule Group
  • Naming Rule Group
  • Structure Rule Group
  • Structure::Optional Rule Group
  • Whitespace Rule Group
• Rules
  • After Rules
  • Aggregate Rules
  • Alias Declaration Rules
  • Architecture Rules
  • Array Constraint Rules
  • Assert Rules
  • Attribute Rules
  • Attribute Declaration Rules
  • Attribute Specification Rules
  • Bit String Literal Rules
  • Block Rules
  • Block Comment Rules
  • Case Rules
  • Case Generate Alternative Rules
  • Case Generate Statement Rules
  • Choice Rules
  • Comment Rules
  • Component Rules
  • Concurrent Rules
  • Conditional Expressions Rules
  • Conditional Waveforms Rules
  • Constant Rules
  • Constrained Array Definition Rules
  • Context Rules
  • Context Reference Rules
  • Declarative Part Rules
  • Delay Mechanism Rules
  • Element Association Rules
  • Entity Rules
  • Entity Specification Rules
  • Exit Rules
  • Exponent Rules
  • External Constant Name Rules
  • External Signal Name Rules
  • External Variable Name Rules
  • File Rules
  • File Open Information Rules
  • File Type Definition Rules
  • For Loop Rules
  • For Generate Statement Rules
  • Function Rules
  • Generate Rules
  • Generic Rules
  • Generic Map Rules
  • Ieee Rules
  • If Rules
  • If Generate Statement Rules
  • Index Subtype Definition Rules
  • Instantiation Rules
  • Iteration Scheme Rules
  • Length Rules
  • Library Rules
  • Logical Operator Rules
  • Loop Statement Rules
  • Next Statement Rules
  • Null Statement Rules
  • Package Rules
  • Package Body Rules
  • Package Instantiation Rules
  • Parameter Specification Rules
  • Port Rules
  • Port Map Rules
  • Pragma Rules
  • Procedure Rules
  • Procedure Call Rules
  • Process Rules
  • Protected Type Rules
  • Protected Type Body Rules
  • Range Constraint Rules
  • Range Rules
  • Record Type Definition Rules
  • Report Statement Rules
  • Reserved Rules
  • Return Statement Rules
  • Selected Assignment Rules
  • Sequential Rules
  • Signal Rules
  • Shift Operator Rules
  • Source File Rules
  • Subprogram Body Rules
  • Subprogram Instantiation Rules
  • Subprogram Kind Rules
  • Subtype Rules
  • Type Rules
  • Type Mark Rules
  • Unfixable Rules
  • Unbounded Array Definition Rules
  • Use Clause Rules
  • Variable Rules
  • Variable Assignment Rules
  • Wait Rules
  • When Rules
  • While Loop Rules
  • Whitespace Rules
  • With Rules
• Contributing
  • Bug Reports
  • Code Base Improvements
  • Feature Requests
  • Pull Requests
  • Quality Control
• Theory of Operation
  • Tokenizing
  • Tokens
  • Classifying
  • Internal Data Structure
  • Rule Selection
  • Rule Directory Structure
• Processes
  • Project Board
  • Branch Creation
  • Release Process
• Developing
  • Development Environment
  • Helpful Tools
  • Adding a rule
  • Prepare for pull request
• Release Notes