zephyr/samples/synchronization/README.rst
Carles Cufi 72046a8abc doc: getting_started: Support multi-OS instructions
In order to be able to document the build on Windows and UNIX
systems, slight variations are required on the app commands
that are used throughout the documentation system.

This includes getting rid of the prompt symbol and providing commands
for both UNIX and Windows operating systems.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-01-18 16:53:31 -05:00

55 lines
1.2 KiB
ReStructuredText

.. _synchronization_sample:
Synchronization Sample
######################
Overview
********
A simple application that demonstrates basic sanity of the kernel.
Two threads (A and B) take turns printing a greeting message to the console,
and use sleep requests and semaphores to control the rate at which messages
are generated. This demonstrates that kernel scheduling, communication,
and timing are operating correctly.
Building and Running
********************
This project outputs to the console. It can be built and executed
on QEMU as follows:
.. zephyr-app-commands::
:zephyr-app: samples/synchronization
:host-os: unix
:board: qemu_x86
:goals: run
:compact:
On the supported ARM MCUs the project can be built with the MPU and the Thread
Stack Guard feature enabled:
.. zephyr-app-commands::
:zephyr-app: samples/synchronization
:board: v2m_beetle
:conf: prj_stack_guard.conf
:goals: build flash
:compact:
Sample Output
=============
.. code-block:: console
threadA: Hello World!
threadB: Hello World!
threadA: Hello World!
threadB: Hello World!
threadA: Hello World!
threadB: Hello World!
threadA: Hello World!
threadB: Hello World!
threadA: Hello World!
threadB: Hello World!
<repeats endlessly>