NAME [edit section]

= NAME =
report_devlog

SYNOPSIS [edit section]

= SYNOPSIS =
 * report_devlog <logstring>...

DESCRIPTION [edit section]

= DESCRIPTION =
Add an entry to the devlog.  This should be a string describing the operation
being performed.  By conventions, the line provided should be prefixed with
the operation name and a colon, then the description or arguments used with the operation.

See [[Log files]] for more information about the devlog.

EXAMPLES [edit section]

= EXAMPLES =
Here are some sample invocations:
{{{#!YellowBox
    report_devlog "put: $@"
}}}

{{{#!YellowBox
    report_devlog "cmd: $@"
}}}

ENVIRONMENT and ARGUMENTS [edit section]

= ENVIRONMENT and ARGUMENTS =
 * $@ are the strings to add to the log

The following variables are used:
 * FUEGO_LOGS_PATH
 * JOB_NAME
 * Device
 * BUILD_ID
 * BUILD_NUMBER

These are used to construct the output devlog name, which is:
$FUEGO_LOGS_PATH/${JOB_NAME}/devlogs/$Device.$BUILD_ID.$BUILD_NUMBER.txt

RETURN [edit section]

= RETURN =
Returns non-zero on error.

SOURCE [edit section]

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

SEE ALSO [edit section]

= SEE ALSO =
 * [[Log files]]