Miscellaneous-EntityMarker

Reports a (suppressed) issue per entity of a configurable type

Required inputs: IR

This rule generates one issue per entity under analysis and immediately suppresses the issue. Relevant entities can be selected with a set of Physical IR types. The rule is useful for checking completeness of the analysis. Note that you have to import the suppressed issues via /Results/Dashboard/import_suppressed_issues into the database.

Possible Messages

Key	Text	Severity	Disabled
included_entity	{} is checked.	None	False

Options

• This rule shares the following common options: exclude_in_macros, exclude_messages_in_system_headers, excludes, extend_exclude_to_macro_invocations, includes, justification_checker, languages, post_processing, provider, report_at, severity

• The following places define options that affect this rule: Stylechecks, Analysis-GlobalOptions

entity_type

entity_type : set[bauhaus.ir.PIR_Class_Name] = set()

Types of entities to report. Any Physical IR node kind is possible.

 

use_baseclass_name_in_message

use_baseclass_name_in_message : bool = True

If set to true, includes the exact name of the type configured as entity_type in any issue message. Otherwise uses the actual type of the Physical IR node, which may be derived from the types configured as entity_type and may be very specific technical descriptions of the entity.