zephyr/samples/microkernel/test/test_timer/README.txt
Allan Stephens e3108813cc Revise misleading instructions in sample project README.txt files
Removes the instruction directing users to issue "make pristine"
before building a sample project, as this should be unnecessary
under normal circumstances and can cause the user to unexpectedly
lose their current configuration information. In its place, a section
on troubleshooting is added that describes how to rebuild a project
using the desired configuration.

Change-Id: I4eaace2888000c3ec5d101c27a38c74c2987312e
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2016-02-05 20:14:14 -05:00

46 lines
1.5 KiB
Plaintext

Title: Microkernel low resolution timer test suite
Description:
This test verifies the following low resolution microkernel timer APIs operate
as expected:
task_timer_alloc (), task_timer_free()
task_timer_start(), task_timer_restart(), task_timer_stop()
task_node_tick_delta(), task_node_tick_get_32()
--------------------------------------------------------------------------------
Building and Running Project:
This microkernel project outputs to the console. It can be built and executed
on QEMU as follows:
make microkernel.qemu
--------------------------------------------------------------------------------
Troubleshooting:
Problems caused by out-dated project information can be addressed by
issuing one of the following commands then rebuilding the project:
make clean # discard results of previous builds
# but keep existing configuration info
or
make pristine # discard results of previous builds
# and restore pre-defined configuration info
--------------------------------------------------------------------------------
Sample Output:
Starting timer tests
===================================================================
Test the allocation of timers.
Test the one shot feature of a timer.
Test that a timer does not start.
Test the periodic feature of a timer
Test the stopping of a timer
===================================================================
VXMICRO PROJECT EXECUTION SUCCESSFUL