NAME [edit section]

= NAME =
vprint

SYNOPSIS [edit section]

= SYNOPSIS =
 * vprint "message"

DESCRIPTION [edit section]

= DESCRIPTION =
This function outputs the message, if the log level is set to 'verbose'
or 'debug' for the current area of Fuego test execution.  This function
should be used to output additional information that might be helpful for 
the user to see about the test execution.  These messages, however, do
not appear by default (since the default log level is 'info').

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

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

EXAMPLES [edit section]

= EXAMPLES =
Here is a sample invocation:
{{{#!YellowBox
    vprint "Just completed step 'foo'."
}}}

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_iprint|iprint]], [[function_wprint|wprint]], [[function_eprint|eprint]]