93 lines
2.6 KiB
ReStructuredText
93 lines
2.6 KiB
ReStructuredText
Configuring
|
|
===========
|
|
|
|
Any attribute of any rule can be configured using the --configuration option and a JSON file.
|
|
This is the basic form of a configuration file:
|
|
|
|
.. code-block:: json
|
|
|
|
{
|
|
"rule":{
|
|
"global":{
|
|
"attributeName":"AttributeValue"
|
|
},
|
|
"ruleId_ruleNumber":{
|
|
"attributeName":"AttributeValue"
|
|
}
|
|
}
|
|
}
|
|
|
|
Using **global** will set the attribute for every rule.
|
|
Each rule is addressable by using it's unique **ruleId** and **ruleNumber** combination.
|
|
|
|
.. NOTE::
|
|
If **global** and unique attributes are set at the same time, the unique attribute will take precedent.
|
|
|
|
|
|
Here are a list of attributes that can be altered:
|
|
|
|
+-------------+---------+--------------------------------------------------+
|
|
| Attribute | Values | Description |
|
|
+=============+=========+==================================================+
|
|
| indentSize | Integer | Sets the number of spaces for each indent level. |
|
|
+-------------+---------+--------------------------------------------------+
|
|
| phase | Integer | Sets the phase the rule will run in. |
|
|
+-------------+---------+--------------------------------------------------+
|
|
| disable | Boolean | If set to True, the rule will not run. |
|
|
+-------------+---------+--------------------------------------------------+
|
|
| fixable | Boolean | If set to False, the violation will not be fixed |
|
|
+-------------+---------+--------------------------------------------------+
|
|
|
|
Example: Disabling a rule
|
|
--------------------------
|
|
|
|
Below is an example of a JSON file which disables the rule **entity_004**
|
|
|
|
.. code-block:: json
|
|
|
|
{
|
|
"rule":{
|
|
"entity_004":{
|
|
"disable":"True"
|
|
}
|
|
}
|
|
}
|
|
|
|
We use the configuration using the **--configuration** command line argument:
|
|
|
|
.. code-block:: bash
|
|
|
|
$ vsg -f RAM.vhd --configuration entity_004_disable.json
|
|
|
|
Example: Setting the indent increment size for a single rule
|
|
------------------------------------------------------------
|
|
|
|
The indent increment size is the number of spaces an indent level takes.
|
|
It can be configured on an per rule basis...
|
|
|
|
.. code-block:: json
|
|
|
|
{
|
|
"rule":{
|
|
"entity_004":{
|
|
"indentSize":4
|
|
}
|
|
}
|
|
}
|
|
|
|
Example: Setting the indent increment size for all rules
|
|
--------------------------------------------------------
|
|
|
|
Configure the indent size for all rules by setting the **global** attribute.
|
|
|
|
.. code-block:: json
|
|
|
|
{
|
|
"rule":{
|
|
"global":{
|
|
"indentSize":4
|
|
}
|
|
}
|
|
}
|
|
|