Lint

[lint] section specifies the configuration for linter like below:

[lint.naming]
case_enum = "snake"

Available configurations

The `[lint.naming]` section

This section contains configurations of naming conventions.

Configuration	Value	Description
case_enum	case type¹	case style of `enum`
case_function	case type¹	case style of `function`
case_function_inout	case type¹	case style of `inout` argument
case_function_input	case type¹	case style of `input` argument
case_function_output	case type¹	case style of `output` argument
case_instance	case type¹	case style of instance
case_interface	case type¹	case style of `interface`
case_modport	case type¹	case style of `modport`
case_module	case type¹	case style of `module`
case_package	case type¹	case style of `package`
case_parameter	case type¹	case style of `parameter`
case_port_inout	case type¹	case style of `inout` port
case_port_input	case type¹	case style of `input` port
case_port_modport	case type¹	case style of `modport` port
case_port_output	case type¹	case style of `output` port
case_reg	case type¹	case style of register type variable²
case_struct	case type¹	case style of `struct`
case_union	case type¹	case style of `union`
case_var	case type¹	case style of variable
case_wire	case type¹	case style of wire type variable³
prefix_enum	string	prefix of `enum`
prefix_function	string	prefix of `function`
prefix_function_inout	string	prefix of `inout` argument
prefix_function_input	string	prefix of `input` argument
prefix_function_output	string	prefix of `output` argument
prefix_instance	string	prefix of instance
prefix_interface	string	prefix of `interface`
prefix_modport	string	prefix of `modport`
prefix_module	string	prefix of `module`
prefix_package	string	prefix of `package`
prefix_parameter	string	prefix of `parameter`
prefix_port_inout	string	prefix of `inout` port
prefix_port_input	string	prefix of `input` port
prefix_port_modport	string	prefix of `modport` port
prefix_port_output	string	prefix of `output` port
prefix_reg	string	prefix of register type variable²
prefix_struct	string	prefix of `struct`
prefix_union	string	prefix of `union`
prefix_var	string	prefix of variable
prefix_wire	string	prefix of wire type variable³
suffix_enum	string	suffix of `enum`
suffix_function	string	suffix of `function`
suffix_function_inout	string	suffix of `inout` argument
suffix_function_input	string	suffix of `input` argument
suffix_function_output	string	suffix of `output` argument
suffix_instance	string	suffix of instance
suffix_interface	string	suffix of `interface`
suffix_modport	string	suffix of `modport`
suffix_module	string	suffix of `module`
suffix_package	string	suffix of `package`
suffix_parameter	string	suffix of `parameter`
suffix_port_inout	string	suffix of `inout` port
suffix_port_input	string	suffix of `input` port
suffix_port_modport	string	suffix of `modport` port
suffix_port_output	string	suffix of `output` port
suffix_reg	string	suffix of register type variable²
suffix_struct	string	suffix of `struct`
suffix_union	string	suffix of `union`
suffix_var	string	suffix of variable
suffix_wire	string	suffix of wire type variable³
re_forbidden_enum	regex⁴	regex forbidden of `enum`
re_forbidden_function	regex⁴	regex forbidden of `function`
re_forbidden_function_inout	regex⁴	regex forbidden of `inout` argument
re_forbidden_function_input	regex⁴	regex forbidden of `input` argument
re_forbidden_function_output	regex⁴	regex forbidden of `output` argument
re_forbidden_instance	regex⁴	regex forbidden of instance
re_forbidden_interface	regex⁴	regex forbidden of `interface`
re_forbidden_modport	regex⁴	regex forbidden of `modport`
re_forbidden_module	regex⁴	regex forbidden of `module`
re_forbidden_package	regex⁴	regex forbidden of `package`
re_forbidden_parameter	regex⁴	regex forbidden of `parameter`
re_forbidden_port_inout	regex⁴	regex forbidden of `inout` port
re_forbidden_port_input	regex⁴	regex forbidden of `input` port
re_forbidden_port_modport	regex⁴	regex forbidden of `modport` port
re_forbidden_port_output	regex⁴	regex forbidden of `output` port
re_forbidden_reg	regex⁴	regex forbidden of register type variable²
re_forbidden_struct	regex⁴	regex forbidden of `struct`
re_forbidden_union	regex⁴	regex forbidden of `union`
re_forbidden_var	regex⁴	regex forbidden of variable
re_forbidden_wire	regex⁴	regex forbidden of wire type variable³
re_required_enum	regex⁴	regex required of `enum`
re_required_function	regex⁴	regex required of `function`
re_required_function_inout	regex⁴	regex required of `inout` argument
re_required_function_input	regex⁴	regex required of `input` argument
re_required_function_output	regex⁴	regex required of `output` argument
re_required_instance	regex⁴	regex required of instance
re_required_interface	regex⁴	regex required of `interface`
re_required_modport	regex⁴	regex required of `modport`
re_required_module	regex⁴	regex required of `module`
re_required_package	regex⁴	regex required of `package`
re_required_parameter	regex⁴	regex required of `parameter`
re_required_port_inout	regex⁴	regex required of `inout` port
re_required_port_input	regex⁴	regex required of `input` port
re_required_port_modport	regex⁴	regex required of `modport` port
re_required_port_output	regex⁴	regex required of `output` port
re_required_reg	regex⁴	regex required of register type variable²
re_required_struct	regex⁴	regex required of `struct`
re_required_union	regex⁴	regex required of `union`
re_required_var	regex⁴	regex required of variable
re_required_wire	regex⁴	regex required of wire type variable³

The `[lint.portability]` section

This section decides which non-portable constructs are accepted from dependencies.

Configuration	Value	Description
allow_in_dependencies	array of item⁵	non-portable constructs accepted from dependencies

#[allow(initial_assign)] and #[allow(multiple_assign)] opt in to a construct which is not portable, that is, whether it works depends on the target device and the toolchain. In your own code the attribute is always honored. In the code of a dependency it is rejected unless it is listed here, so that a project can’t absorb a library which relies on a construct its own target does not support without noticing. The default is to accept nothing.

[lint.portability]
allow_in_dependencies = ["initial_assign"]

"initial_assign" – assignment in an initial block
"multiple_assign" – assignment from more than one process

"snake" – snake_case
"screaming_snake" – SCREAMING_SNAKE_CASE
"lower_camel" – lowerCamelCase
"upper_camel" – UpperCamelCase

The available values are ↩ ↩2 ↩3 ↩4 ↩5 ↩6 ↩7 ↩8 ↩9 ↩10 ↩11 ↩12 ↩13 ↩14 ↩15 ↩16 ↩17 ↩18 ↩19 ↩20
Register type means that the variable is assigned in always_ff. It will be mapped to flip-flop in synthesis phase. ↩ ↩2 ↩3 ↩4 ↩5
Wire type means that the variable is assigned in always_comb. It will be mapped to wire in synthesis phase. ↩ ↩2 ↩3 ↩4 ↩5
Regular expression string like ".*". The available syntax is here. ↩ ↩2 ↩3 ↩4 ↩5 ↩6 ↩7 ↩8 ↩9 ↩10 ↩11 ↩12 ↩13 ↩14 ↩15 ↩16 ↩17 ↩18 ↩19 ↩20 ↩21 ↩22 ↩23 ↩24 ↩25 ↩26 ↩27 ↩28 ↩29 ↩30 ↩31 ↩32 ↩33 ↩34 ↩35 ↩36 ↩37 ↩38 ↩39 ↩40
The available values are ↩

Keyboard shortcuts

The Veryl Hardware Description Language

Lint

Available configurations

The [lint.naming] section

The [lint.portability] section

The `[lint.naming]` section

The `[lint.portability]` section