zephyr/samples/userspace/hello_world_user
Benjamin Cabé 1db9b009a7 doc: samples: Adopt code-sample-category across tree
This commit uses the new .. zephyr:code-sample-category directive to
categorize code samples across the tree.
Updates existing legacy references to manually defined targets to now
use :zephyr:code-sample-category: role instead.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-09-23 12:00:00 +02:00
..
src
CMakeLists.txt
README.rst
prj.conf
sample.yaml

README.rst

.. zephyr:code-sample:: helloworld_user
   :name: Hello World

   Print a simple "Hello World" from userspace.

Overview
********
A simple Hello World example that can be used with any supported board and
prints 'Hello World from UserSpace!' to the console.
If unavailable or unconfigured then 'Hello World from privileged mode.'
is printed instead.

This application can be built into modes:

* single thread
* multi threading

Building and Running
********************

This project outputs 'Hello World from UserSpace!' to the console.
It can be built and executed on QEMU as follows:

.. zephyr-app-commands::
   :zephyr-app: samples/userspace/hello_world_user
   :host-os: unix
   :board: qemu_riscv32
   :goals: run
   :compact:

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

.. code-block:: console

    Hello World from UserSpace! qemu_riscv32

Exit QEMU by pressing :kbd:`CTRL+A` :kbd:`x`.