diff --git a/docs/guide/warnings.rst b/docs/guide/warnings.rst index 2e79f4e62..ac0ca9329 100644 --- a/docs/guide/warnings.rst +++ b/docs/guide/warnings.rst @@ -442,6 +442,16 @@ List Of Warnings Other tools with similar warnings: Veriable's forbid_defparam_rule. +.. option:: DEPRECATED + + Warning that a Verilator metacomment, or configuration file command uses + syntax that has been deprecated. Upgrade the code to the replacement + that should be suggested by the warning message. + + Ignoring this warning will only suppress the lint check, it will + simulate correctly. + + .. option:: DETECTARRAY .. TODO better example @@ -502,6 +512,16 @@ List Of Warnings generated C++ code to add appropriate prints to see what is going on. +.. option:: ENDCAPSULATED + + Warns that a class member is declared is local or protected, but is + being accessed from outside that class (if local) or a derrived class + (if protected). + + Ignoring this warning will only suppress the lint check, it will + simulate correctly. + + .. option:: ENDLABEL Warns that a label attached to a "end"-something statement does not @@ -928,6 +948,29 @@ List Of Warnings This error may be disabled with a lint_off PINNOTFOUND metacomment. +.. option:: PORTSHORT + + Warns that an output port is connected to a constant. + + .. code-block:: sv + :linenos: + :emphasize-lines: 5-6 + + module a; + sub sub + (.out(1'b1)); //<--- error PORTSHORT + endmodule + + module sub (output out); + assign out = '1; + endmodule + + In the example above, out is an output but is connected to a constant + implying it is an input. + + This error may be disabled with a lint_off PORTSHORT metacomment. + + .. option:: PKGNODECL .. TODO better example