diff --git a/docs/guide/warnings.rst b/docs/guide/warnings.rst index a26b39bf5..3827c9b89 100644 --- a/docs/guide/warnings.rst +++ b/docs/guide/warnings.rst @@ -173,6 +173,8 @@ List Of Warnings This error may be disabled with a lint_off BADSTDPRAGMA metacomment. + Ignoring this warning will cause the pragma to be ignored. + .. option:: BADVLTPRAGMA @@ -189,6 +191,8 @@ List Of Warnings This error may be disabled with a lint_off BADVLTPRAGMA metacomment. + Ignoring this warning will cause the pragma to be ignored. + .. option:: BLKANDNBLK @@ -498,7 +502,8 @@ List Of Warnings .. option:: DEFOVERRIDE - Warns that a macro definition within the code is being overridden by a command line directive: + Warns that a macro definition within the code is being overridden by a + command line directive: For example, running Verilator with :code:`<+define+\=\>` and @@ -1103,8 +1108,6 @@ List Of Warnings .. option:: LITENDIAN - .. TODO better example - The naming of this warning is in contradiction with the common interpretation of little endian. It was therefore renamed to :option:`ASCRANGE`. While :option:`LITENDIAN` remains for @@ -1249,6 +1252,8 @@ List Of Warnings modules' signals seem identical, e.g., multiple modules with a "clk" input. + Ignoring this warning will make multiple tops, as described in (3) above. + .. option:: NEEDTIMINGOPT @@ -1291,6 +1296,9 @@ List Of Warnings :code:`$psprintf` system function is replaced by its standard equivalent :code:`$sformatf`. + Ignoring this warning will only suppress the lint check; it will + simulate correctly. + .. option:: NOTIMING @@ -1420,6 +1428,7 @@ List Of Warnings declared before being used. However, several standard libraries including UVM violate this, and other tools do not warn. + .. option:: PORTSHORT Warns that an output port is connected to a constant. @@ -1467,6 +1476,9 @@ List Of Warnings The portable way to suppress this warning is to use a define value other than zero, when it is to be used in a preprocessor expression. + Ignoring this warning will only suppress the lint check; it will + simulate correctly. + .. option:: PROCASSINIT @@ -1529,7 +1541,7 @@ List Of Warnings inside the protected region will be partly checked for correctness but is otherwise ignored. - Suppressing the warning may make Verilator differ from a simulator that + Ignoring the warning may make Verilator differ from a simulator that accepts the protected code. @@ -1547,6 +1559,9 @@ List Of Warnings Warns that a real number is being implicitly rounded to an integer, with possible loss of precision. + Ignoring this warning will only suppress the lint check; it will + simulate correctly. + Faulty example: .. code-block:: sv @@ -1576,8 +1591,12 @@ List Of Warnings .. option:: REDEFMACRO - Warns that the code has redefined the same macro with a different value, - for example: + Warns that the code has redefined the same macro with a different value. + + Ignoring this warning will only suppress the lint check; it will + simulate correctly. + + For example: .. code-block:: sv :linenos: