= NAME =
dump_syslogs

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

= DESCRIPTION =
Save the current system log, on the target.

There are two syslogs saved, one before the test and one after.
By subtracting these two from each other, one can tell what system log
operations occurred during the execution of the test.

This function uses [[function_ov_rootfs_logread|ov_rootfs_logread]] to save
the system log in the /tmp directory on the target.

= EXAMPLES =
Here are some sample invocations:
{{{#!YellowBox
    dump_syslogs ${fuego_test_tmp} before
}}}

= ENVIRONMENT and ARGUMENTS =
 * $1 is a temp dir on the target - the location where the log should be saved
 * $2 specifies which syslog to retrieve (either the 'before' syslog or the 'after' syslog).

Note that [[function_post_test|post_test]] may use the value of FUEGO_TARGET_TMP to set the value for $1 ($test_temp_dir).


= RETURN =
Returns non-zero on error.

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

= SEE ALSO =
 * [[function_pre_test|pre_test]], [[function_post_test|post_test]], [[function_ov_rootfs_logread|ov_rootfs_logread]]