NAME [edit section]

= NAME =
iprint

SYNOPSIS [edit section]

= SYNOPSIS =
 * iprint "message"

DESCRIPTION [edit section]

= DESCRIPTION =
This function outputs the message, if the log level is set to 'info',
'verbose', or 'debug' for the current area of Fuego test execution.  The default log level, if none is specified by FUEGO_LOGLEVEL, is 'info'.
So these messages will be output by default in normal Fuego operation.

See [[FUEGO_LOGLEVELS]]
to see how the log level may be set.

Any shell variable can be output as part of the message.

In most cases, we desire the console log for a test to be somewhat sparse.
This is so that the user does not get used to ignoring the output in the
console log.  For this reason, this function should be used somewhat
sparingly.

Debug messages should be output using [[function_dprint|dprint]], and
progress and status messages should be output using [[function_vprint|vprint]].

EXAMPLES [edit section]

= EXAMPLES =
Here is a sample invocation:
{{{#!YellowBox
    iprint "Preparing to execute test..."
}}}

ENVIRONMENT and ARGUMENTS [edit section]

= ENVIRONMENT and ARGUMENTS =
This function is controlled by the value of FUEGO_LOGLEVELS.

RETURN [edit section]

= RETURN =
Returns 0

SOURCE [edit section]

= SOURCE =
Located in ''scripts/common.sh''

SEE ALSO [edit section]

= SEE ALSO =
 * [[function_dprint|dprint]], [[function_vprint|vprint]], [[function_wprint|wprint]], [[function_eprint|eprint]]