6.1.2.14. PrintAMessage

Output a message

This rule outputs informational text during the build and clean actions that can be used to document and structure the build process.

Options

The following places define options that affect this rule: BuildSystemIntegration, Project-GlobalOptions

abort_on_error

abort_on_error : bool = True

If set to true and the build step returns a non-zero exit-code, the build is aborted. Otherwise a non-zero exit-code is logged but the build continues.

 

build_message

build_message : str | None = None

Message to output during the build step

 

clean_message

clean_message : str | None = None

Message to output during the clean step

 

output_stream

output_stream : FileStream = 'STDOUT'

File stream to print message to (stdout or stderr)

 

with_timestamp

with_timestamp : bool = False

Set to true, if you want a timestamp next to your message

 

Option Types

These types are used by options listed above:

FileStream

An enumeration.

 

• STDOUT

• STDERR