Skip to content

Commit

Permalink
samples: cpp_synchronization: Change sample description to rst format
Browse files Browse the repository at this point in the history
Rename README.txt to README.rst and change format to rst.

Signed-off-by: Joakim Andersson <[email protected]>
  • Loading branch information
joerchan authored and carlescufi committed May 15, 2020
1 parent 44bcf98 commit 54ce249
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 62 deletions.
1 change: 1 addition & 0 deletions samples/classic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,5 @@ platforms:

hello_world/*
synchronization/*
cpp_synchronization/*
philosophers/*
60 changes: 60 additions & 0 deletions samples/cpp_synchronization/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
.. _cpp_synchronization:

C++ Synchronization
###################

Overview
********
The sample project illustrates usage of pure virtual class, member
functions with different types of arguments, global objects constructor
invocation.

A simple application demonstrates basic sanity of the kernel. The main thread
and a cooperative thread take turns printing a greeting message to the console,
and use timers 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 kernel project outputs to the console. It can be built and executed
on QEMU as follows:

.. zephyr-app-commands::
:zephyr-app: samples/cpp_synchronization
:host-os: unix
:board: qemu_x86
:goals: run
:compact:

Sample Output
=============

.. code-block:: console
Create semaphore 0x001042b0
Create semaphore 0x001042c4
main: Hello World!
coop_thread_entry: Hello World!
main: Hello World!
coop_thread_entry: Hello World!
main: Hello World!
coop_thread_entry: Hello World!
main: Hello World!
coop_thread_entry: Hello World!
main: Hello World!
coop_thread_entry: Hello World!
main: Hello World!
coop_thread_entry: Hello World!
main: Hello World!
coop_thread_entry: Hello World!
main: Hello World!
coop_thread_entry: Hello World!
main: Hello World!
coop_thread_entry: Hello World!
main: Hello World!
<repeats endlessly>
Exit QEMU by pressing :kbd:`CTRL+A` :kbd:`x`.
62 changes: 0 additions & 62 deletions samples/cpp_synchronization/README.txt

This file was deleted.

0 comments on commit 54ce249

Please sign in to comment.