NAME [edit section]

= NAME =
ov_rootfs_logread

SYNOPSIS [edit section]

= SYNOPSIS =
 * ov_rootfs_logread <tmp_dir> "before"|"after"

DESCRIPTION [edit section]

= DESCRIPTION =
This function saves the system log on the target.

It creates a temp directory on the target to hold the log, then invokes a client-side program to save the system logs on the target to a file.
The base-distrib version of this function uses '/sbin/logread' to read the 
log, and the nologger.dist version of this function uses 'cat /var/log/messages'.

The second parameter specifies a suffix to use with the log file.  Internally,
this is always either the string "before" or "after".

EXAMPLES [edit section]

= EXAMPLES =
Here are some sample invocations:
{{{#!YellowBox
    ov_rootfs_logread $@
}}}

Where $@ are the arguments to dump_syslogs.

ENVIRONMENT and ARGUMENTS [edit section]

= ENVIRONMENT and ARGUMENTS =
 * $1 is a tmp directory on the target
 * $2 is the name of the log to save

Variables used are:
 * NODE_NAME
 * BUILD_ID
 * BUILD_NUMBER

These are used to build the filename for the test log on the target.

The full path is: $1/${NODE_NAME}.${BUILD_ID}.${BUILD_NUMBER}.$2

RETURN [edit section]

= RETURN =
Returns non-zero on error.

SOURCE [edit section]

= SOURCE =
Located in ''overlays/base/base-distrib.sh'', and in ''overlays/distribs/nologger.dist''

SEE ALSO [edit section]

= SEE ALSO =
 * [[function_dump_syslogs|dump_syslogs]], [[function_cmd|cmd]]