		Search-engine friendly clone of the ACL2 documentation.

Vl-warning

Fundamental warning object used throughout vl2014.

This is a product type introduced by defprod.

type — symbolp: A symbol, most often a keyword symbol, that describes very broadly what kind of warning this is. There is no particular discipline or strategy for assigning types to warnings, but the basic goal is to be able to use these types to filter out or group up similar warnings.
fatalp — booleanp: Indicates whether this error is so severe that the module ought to be thrown away and not subjected to further translation. See the general discussion in warnings for more information on how this is used.
msg — stringp: A more detailed message describing what went wrong. This string should be acceptable to vl-fmt; it is similar to the "format strings" used by ACL2's cw function, but there are some important differences, e.g., not all fmt directives are supported, and extra Verilog-specific directives are available.
args — true-listp: Arguments that will be composed with the tilde directives in msg when the warning is displayed to the user. That is, a directive like ~x0 refers to the first argument, ~x1 to the second, etc.
fn — symbolp: A symbol, intended to be the name of the function that caused the warning. This is intended to be useful for VL debugging, to help make the source of the warning more apparent. Only good discipline (and handy macros) ensure that this is correctly reported.