OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/samples/synchronization/README.rst

55 lines
1.2 KiB
ReStructuredText
Raw Normal View History

doc: application porting guide to the unified kernel Change-Id: I463b50336f6438ed5dc4ae60bf0d3f7b6e1118a5 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-01-14 06:43:33 +08:00
.. _synchronization_sample:
doc: synchronization: move to rst syntax Change-Id: I3f3868e213704f2d34ff06bd94d4d62d20881e4b Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-01-05 21:43:33 +08:00
Synchronization Sample
######################
Overview
doc: fix .rst files canonical heading order The headings on some .rst files were not following the expected heading order of using # for h1, * for h2, = for h3, and - for h4 This patch fixes that, and the doc/templates/*.tmpl files created for folks to use as templates for creating board and sample docs. Change-Id: I0263b005648558d5ea41a681ceaa4798c9594dd9 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-01-21 07:58:05 +08:00
********
doc: synchronization: move to rst syntax Change-Id: I3f3868e213704f2d34ff06bd94d4d62d20881e4b Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-01-05 21:43:33 +08:00
samples: fixed typo in README.rst Per ISSM team feedbacks: “demostrating” >> “demonstrating” “demonstates” >> ”demonstrates” Signed-off-by: Sharron LIU <sharron.liu@intel.com>
2017-06-08 10:11:20 +08:00
A simple application that demonstrates basic sanity of the kernel.
doc: synchronization: move to rst syntax Change-Id: I3f3868e213704f2d34ff06bd94d4d62d20881e4b Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-01-05 21:43:33 +08:00
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
doc: fix .rst files canonical heading order The headings on some .rst files were not following the expected heading order of using # for h1, * for h2, = for h3, and - for h4 This patch fixes that, and the doc/templates/*.tmpl files created for folks to use as templates for creating board and sample docs. Change-Id: I0263b005648558d5ea41a681ceaa4798c9594dd9 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-01-21 07:58:05 +08:00
********************
doc: synchronization: move to rst syntax Change-Id: I3f3868e213704f2d34ff06bd94d4d62d20881e4b Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-01-05 21:43:33 +08:00
This project outputs to the console. It can be built and executed
on QEMU as follows:
samples: misc: Convert doc to CMake Convert misc samples doc to CMake. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2017-11-12 17:11:39 +08:00
.. zephyr-app-commands::
:zephyr-app: samples/synchronization
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 00:32:31 +08:00
:host-os: unix
samples: misc: Convert doc to CMake Convert misc samples doc to CMake. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2017-11-12 17:11:39 +08:00
:board: qemu_x86
:goals: run
:compact:
doc: synchronization: move to rst syntax Change-Id: I3f3868e213704f2d34ff06bd94d4d62d20881e4b Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-01-05 21:43:33 +08:00
samples: synch: Add Thread Stack Guards conf This patch adds the Thread Stack Guards configuration option to the synchronization sample. This is meant to be an easy way to prove that the MPU can be dynamically programmed on the supported platforms. Change-Id: I77fbe6af3303ff8a2904768abd4cc9797f03c092 Signed-off-by: Vincenzo Frascino <vincenzo.frascino@linaro.org>
2017-03-29 18:39:17 +08:00
On the supported ARM MCUs the project can be built with the MPU and the Thread
Stack Guard feature enabled:
samples: misc: Convert doc to CMake Convert misc samples doc to CMake. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2017-11-12 17:11:39 +08:00
.. zephyr-app-commands::
:zephyr-app: samples/synchronization
:board: v2m_beetle
:conf: prj_stack_guard.conf
:goals: build flash
:compact:
samples: synch: Add Thread Stack Guards conf This patch adds the Thread Stack Guards configuration option to the synchronization sample. This is meant to be an easy way to prove that the MPU can be dynamically programmed on the supported platforms. Change-Id: I77fbe6af3303ff8a2904768abd4cc9797f03c092 Signed-off-by: Vincenzo Frascino <vincenzo.frascino@linaro.org>
2017-03-29 18:39:17 +08:00
doc: synchronization: move to rst syntax Change-Id: I3f3868e213704f2d34ff06bd94d4d62d20881e4b Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-01-05 21:43:33 +08:00
Sample Output
doc: fix .rst files canonical heading order The headings on some .rst files were not following the expected heading order of using # for h1, * for h2, = for h3, and - for h4 This patch fixes that, and the doc/templates/*.tmpl files created for folks to use as templates for creating board and sample docs. Change-Id: I0263b005648558d5ea41a681ceaa4798c9594dd9 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-01-21 07:58:05 +08:00
=============
doc: synchronization: move to rst syntax Change-Id: I3f3868e213704f2d34ff06bd94d4d62d20881e4b Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-01-05 21:43:33 +08:00
.. 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>