adafruit-mirror/zephyr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 7

samples: hello_world: use zephyr:code-sample directive

Browse source 
Adds missing code-sample directive to the Hello World sample in
preparation for upcoming changes to the Zephyr documentation that will
be leveraging the provided description and metadata.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This commit is contained in:
Benjamin Cabé 2024-09-11 22:26:10 +02:00 committed by Alberto Escolar
parent f1374b7fa6
commit 9a16b93868
393 changed files with 600 additions and 597 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
boards/96boards/aerocore2/doc/index.rst
View file

@ -311,7 +311,7 @@ You should see following confirmation on your Linux host:
usb 1-2.1: SerialNumber: 3574364C3034
Then build and flash an application. Here is an example for the
:ref:`hello_world` application.
:zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/96boards/argonkey/doc/index.rst
View file

@ -145,7 +145,7 @@ Programming and Debugging
Building
========
Here is an example for building the :ref:`hello_world` application.
Here is an example for building the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/96boards/carbon/doc/stm32f401xe.rst
View file

@ -299,7 +299,7 @@ You should see following confirmation on your Linux host:
usb 1-2.1: SerialNumber: 3574364C3034
Then build and flash an application. Here is an example for the
:ref:`hello_world` application.
:zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/96boards/neonkey/doc/index.rst
View file

@ -135,7 +135,7 @@ Programming and Debugging
Building
========
Here is an example for building the :ref:`hello_world` application.
Here is an example for building the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

4
boards/96boards/nitrogen/doc/index.rst
View file

@ -273,7 +273,7 @@ and install a more recent version of pyOCD.
Flashing an Application to 96Boards Nitrogen
============================================
Here is an example for the :ref:`hello_world` application. This
Here is an example for the :zephyr:code-sample:`hello_world` application. This
requires installing the :ref:`pyocd-debug-host-tools`.
.. zephyr-app-commands::
@ -302,7 +302,7 @@ Debugging with GDB
==================
You can debug an application in the usual way. Here is an example for the
:ref:`hello_world` application. This also requires pyOCD.
:zephyr:code-sample:`hello_world` application. This also requires pyOCD.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

6
boards/96boards/stm32_sensor_mez/doc/index.rst
View file

@ -181,7 +181,7 @@ Programming and Debugging
Building
========
Here is an example for building the :ref:`hello_world` application.
Here is an example for building the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
@ -198,7 +198,7 @@ included in the Zephyr SDK.
Flashing an application to 96Boards STM32 Sensor Mezzanine
----------------------------------------------------------
Here is an example for the :ref:`hello_world` application.
Here is an example for the :zephyr:code-sample:`hello_world` application.
Run a serial host program to connect with your 96Boards STM32 Sensor Mezzanine
board.
@ -224,7 +224,7 @@ Debugging
=========
You can debug an application in the usual way. Here is an example for the
:ref:`hello_world` application.
:zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/96boards/wistrio/doc/96b_wistrio.rst
View file

@ -148,7 +148,7 @@ More detailed information on activating the ROM bootloader can be found in
Chapter 29 of Application note `AN2606`_. The ROM bootloader supports flashing
via UART, and I2C protocols.
Here is an example for building and flashing the :ref:`hello_world` application using `stm32flash`_ command line utility:
Here is an example for building and flashing the :zephyr:code-sample:`hello_world` application using `stm32flash`_ command line utility:
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/adafruit/feather_m0_basic_proto/doc/index.rst
View file

@ -110,7 +110,7 @@ the reset button twice.
Flashing
========
#. Build the Zephyr kernel and the :ref:`hello_world` sample application:
#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application:
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/adafruit/feather_m0_lora/doc/index.rst
View file

@ -119,7 +119,7 @@ the reset button twice.
Flashing
========
#. Build the Zephyr kernel and the :ref:`hello_world` sample application:
#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application:
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/adafruit/grand_central_m4_express/doc/index.rst
View file

@ -111,7 +111,7 @@ The bootloader can be entered by quickly tapping the reset button twice.
Flashing
========
#. Build the Zephyr kernel and the :ref:`hello_world` sample application:
#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application:
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/adafruit/itsybitsy_m4_express/doc/index.rst
View file

@ -122,7 +122,7 @@ will be entered automatically when you run :code:`west flash`.
Flashing
========
#. Build the Zephyr kernel and the :ref:`hello_world` sample application:
#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application:
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

4
boards/adafruit/nrf52_adafruit_feather/doc/index.rst
View file

@ -118,10 +118,10 @@ found in :ref:`nordic_segger_flashing`. Then build and flash
applications as usual (see :ref:`build_an_application` and
:ref:`application_run` for more details).
Here is an example for the :ref:`hello_world` application.
Here is an example for the :zephyr:code-sample:`hello_world` application.
#. Build the Zephyr kernel and the :ref:`hello_world` sample application:
#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application:
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/adafruit/trinket_m0/doc/index.rst
View file

@ -114,7 +114,7 @@ will be entered automatically when you run :code:`west flash`.
Flashing
========
#. Build the Zephyr kernel and the :ref:`hello_world` sample application:
#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application:
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

4
boards/adi/eval_adin1110ebz/doc/index.rst
View file

@ -145,7 +145,7 @@ program to connect with your ADI board. For example:
$ minicom -D /dev/serial/by-id/usb-ADI_EVAL-ADIN1110EBZ_AVAS_XXXXXX-if00-port0
where XXXXXX is the serial number of the connected device.
Then, build and flash in the usual way. Here is an example for the :ref:`hello_world` application.
Then, build and flash in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
@ -161,7 +161,7 @@ You should see the following message on the console:
Debugging
=========
You can debug an application in the usual way. Here is an example for the :ref:`hello_world`
You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world`
application.
.. zephyr-app-commands::

4
boards/adi/eval_adin2111ebz/doc/index.rst
View file

@ -146,7 +146,7 @@ program to connect with your ADI board. For example:
$ minicom -D /dev/serial/by-id/usb-ADI_EVAL-ADIN2111EBZ_XXXXXX-12-if00-port0
where XXXXXX is the serial number of the connected device.
Then, build and flash in the usual way. Here is an example for the :ref:`hello_world` application.
Then, build and flash in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
@ -162,7 +162,7 @@ You should see the following message on the console:
Debugging
=========
You can debug an application in the usual way. Here is an example for the :ref:`hello_world`
You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world`
application.
.. zephyr-app-commands::

4
boards/adi/max32690fthr/doc/index.rst
View file

@ -98,7 +98,7 @@ Logic levels are fixed to VDDIO (1.8V).
Once the debug probe is connected to your host computer, then you can run the
``west flash`` command to write a firmware image into flash. Here is an example
for the :ref:`hello_world` application.
for the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
@ -118,7 +118,7 @@ Debugging
Once the debug probe is connected to your host computer, then you can run the
``west debug`` command to write a firmware image into flash and start a debug
session. Here is an example for the :ref:`hello_world` application.
session. Here is an example for the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/adi/sdp_k1/doc/index.rst
View file

@ -151,7 +151,7 @@ Run a serial host program to connect with your board:
$ minicom -D /dev/serial/by-id/usb-ARM_DAPLink_CMSIS-DAP_<...>
Here is an example for the :ref:`hello_world` application.
Here is an example for the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

4
boards/alientek/pandora_stm32l475/doc/index.rst
View file

@ -182,7 +182,7 @@ board. For example:
$ minicom -D /dev/ttyACM0
Then, build and flash in the usual way. Here is an example for the
:ref:`hello_world` application.
:zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
@ -199,7 +199,7 @@ Debugging
=========
You can debug an application in the usual way. Here is an example for the
:ref:`hello_world` application.
:zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/altr/max10/doc/index.rst
View file

@ -147,7 +147,7 @@ Flashing Kernel into UFM
------------------------
The usual ``flash`` target will work with the ``altera_max10`` board
configuration. Here is an example for the :ref:`hello_world`
configuration. Here is an example for the :zephyr:code-sample:`hello_world`
application.
.. zephyr-app-commands::

2
boards/ambiq/apollo3_evb/doc/index.rst
View file

@ -60,7 +60,7 @@ Flashing an application
-----------------------
Connect your device to your host computer using the JLINK USB port.
The sample application :ref:`hello_world` is used for this example.
The sample application :zephyr:code-sample:`hello_world` is used for this example.
Build the Zephyr kernel and application, then flash it to the device:
.. zephyr-app-commands::

2
boards/ambiq/apollo3p_evb/doc/index.rst
View file

@ -60,7 +60,7 @@ Flashing an application
-----------------------
Connect your device to your host computer using the JLINK USB port.
The sample application :ref:`hello_world` is used for this example.
The sample application :zephyr:code-sample:`hello_world` is used for this example.
Build the Zephyr kernel and application, then flash it to the device:
.. zephyr-app-commands::

2
boards/ambiq/apollo4p_blue_kxr_evb/doc/index.rst
View file

@ -68,7 +68,7 @@ Flashing an application
-----------------------
Connect your device to your host computer using the JLINK USB port.
The sample application :ref:`hello_world` is used for this example.
The sample application :zephyr:code-sample:`hello_world` is used for this example.
Build the Zephyr kernel and application, then flash it to the device:
.. zephyr-app-commands::

2
boards/ambiq/apollo4p_evb/doc/index.rst
View file

@ -63,7 +63,7 @@ Flashing an application
-----------------------
Connect your device to your host computer using the JLINK USB port.
The sample application :ref:`hello_world` is used for this example.
The sample application :zephyr:code-sample:`hello_world` is used for this example.
Build the Zephyr kernel and application, then flash it to the device:
.. zephyr-app-commands::

2
boards/andestech/adp_xc7k_ae350/doc/index.rst
View file

@ -226,7 +226,7 @@ Building
========
You can build applications in the usual way. Here is an example for
the :ref:`hello_world` application.
the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/arduino/due/doc/index.rst
View file

@ -175,7 +175,7 @@ Applications for the ``arduino_due`` board configuration can be built
and flashed in the usual way (see :ref:`build_an_application` and
:ref:`application_run` for more details).
Here is an example for the :ref:`hello_world` application. After
Here is an example for the :zephyr:code-sample:`hello_world` application. After
building the application, press the Reset button before running the
flash command, so the board will boot into the SAM-BA bootloader and
be prepared to receive the new program.

2
boards/arduino/giga_r1/doc/index.rst
View file

@ -130,7 +130,7 @@ First, connect the Arduino GIGA R1 board to your host computer using the USB
port to prepare it for flashing. Double click the ``RST`` button to put the
board into the Arduino Bootloader mode. Then build and flash your application.
Here is an example for the :ref:`hello_world` application.
Here is an example for the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/arduino/mkrzero/doc/index.rst
View file

@ -130,7 +130,7 @@ bootloader can be entered by quickly tapping the reset button twice.
Flashing
========
#. Build the Zephyr kernel and the :ref:`hello_world` sample application:
#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application:
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/arduino/nano_33_iot/doc/index.rst
View file

@ -118,7 +118,7 @@ will be entered automatically when you run :code:`west flash`.
Flashing
========
#. Build the Zephyr kernel and the :ref:`hello_world` sample application:
#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application:
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

4
boards/arduino/nicla_sense_me/doc/index.rst
View file

@ -95,7 +95,7 @@ Flashing
First, connect the Arduino Nicla Sense ME board to your host computer using
the USB port to prepare it for flashing. Then build and flash your application.
Here is an example for the :ref:`hello_world` application.
Here is an example for the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
@ -118,7 +118,7 @@ Debugging
=========
You can debug an application in the usual way. Here is an example for the
:ref:`hello_world` application.
:zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/arduino/nicla_vision/doc/index.rst
View file

@ -137,7 +137,7 @@ First, connect the Arduino Nicla Vision board to your host computer using the US
port to prepare it for flashing. Double click the ``RST`` button to put the
board into the Arduino Bootloader mode. Then build and flash your application.
Here is an example for the :ref:`hello_world` application.
Here is an example for the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/arduino/portenta_h7/doc/index.rst
View file

@ -114,7 +114,7 @@ First, connect the Arduino Portenta H7 board to your host computer using
the USB port to prepare it for flashing. Double tap the button to put the board
into the Arduino Bootloader mode. Then build and flash your application.
Here is an example for the :ref:`hello_world` application.
Here is an example for the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/arduino/zero/doc/index.rst
View file

@ -118,7 +118,7 @@ OpenOCD.
Flashing
========
#. Build the Zephyr kernel and the :ref:`hello_world` sample application:
#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application:
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/arm/mps2/doc/mps2_an385.rst
View file

@ -253,7 +253,7 @@ V2M MPS2 provides:
Flashing an application to V2M MPS2
-----------------------------------
Here is an example for the :ref:`hello_world` application.
Here is an example for the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/arm/mps2/doc/mps2_an521.rst
View file

@ -489,7 +489,7 @@ MPS2+ AN521 provides:
- A Serial Port which is J10 on MPS2+ board
Build applications as described above.
Here is an example for the :ref:`hello_world` application built as
Here is an example for the :zephyr:code-sample:`hello_world` application built as
a secure-only application for CPU0.
.. zephyr-app-commands::

2
boards/arm/mps3/doc/index.rst
View file

@ -142,7 +142,7 @@ Building an application
-----------------------
You can build applications in the usual way. Here is an example for
the :ref:`hello_world` application.
the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/arm/v2m_beetle/doc/index.rst
View file

@ -229,7 +229,7 @@ Flashing an application to V2M Beetle
-------------------------------------
You can build applications in the usual way. Here is an example for
the :ref:`hello_world` application.
the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/arm/v2m_musca_b1/doc/index.rst
View file

@ -308,7 +308,7 @@ Building a secure only application
You can build applications in the usual way. Here is an example for
the :ref:`hello_world` application.
the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

4
boards/arm/v2m_musca_s1/doc/index.rst
View file

@ -301,7 +301,7 @@ Building a secure only application
----------------------------------
You can build applications in the usual way. Here is an example for
the :ref:`hello_world` application.
the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
@ -318,7 +318,7 @@ Open a serial terminal (minicom, putty, etc.) with the following settings:
Uploading an application to V2M Musca-S1
----------------------------------------
To upload the :ref:`hello_world` application to the board, no extra steps are
To upload the :zephyr:code-sample:`hello_world` application to the board, no extra steps are
required. You can directly upload ``build/zephyr/zephyr.hex``, which is
generated by Zephyr's build system.

6
boards/atmel/sam/sam4e_xpro/doc/index.rst
View file

@ -122,7 +122,7 @@ Using OpenOCD
-------------
#. Connect the SAM4E Xplained Pro board to your host computer using the USB
debug port. Then build and flash the :ref:`hello_world` application.
debug port. Then build and flash the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
@ -138,7 +138,7 @@ Using SAM-BA bootloader
#. Open the ``ERASE`` jumper.
#. Connect the SAM4E Xplained Pro board to your host computer using the SoC
USB port. Then build and flash the :ref:`hello_world` application.
USB port. Then build and flash the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
@ -175,7 +175,7 @@ Debugging
=========
You can debug an application in the usual way. Here is an example for the
:ref:`hello_world` application.
:zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

4
boards/atmel/sam/sam4l_ek/doc/index.rst
View file

@ -140,7 +140,7 @@ Flashing
- Stop bits: 1
#. Connect the SAM4L-EK board to your host computer using the USB debug port.
Then build and flash the :ref:`hello_world` application.
Then build and flash the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
@ -153,7 +153,7 @@ Debugging
=========
You can debug an application in the usual way. Here is an example for the
:ref:`hello_world` application.
:zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

6
boards/atmel/sam/sam4s_xplained/doc/index.rst
View file

@ -111,7 +111,7 @@ Using JLink
accessible from your path.
#. Connect the SAM4S Xplained board to your host computer using the USB debug
port. Then build and flash the :ref:`hello_world` application.
port. Then build and flash the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
@ -128,7 +128,7 @@ Using SAM-BA bootloader
#. Open the ``J25`` jumper.
#. Connect the SAM4S Xplained board to your host computer using the SoC USB
port. Then build and flash the :ref:`hello_world` application.
port. Then build and flash the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
@ -167,7 +167,7 @@ Debugging
=========
You can debug an application in the usual way. Here is an example for the
:ref:`hello_world` application.
:zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

4
boards/atmel/sam/sam_e70_xplained/doc/index.rst
View file

@ -141,7 +141,7 @@ Flashing
- Stop bits: 1
#. Connect the SAM E70 Xplained board to your host computer using the
USB debug port. Then build and flash the :ref:`hello_world`
USB debug port. Then build and flash the :zephyr:code-sample:`hello_world`
application.
.. zephyr-app-commands::
@ -171,7 +171,7 @@ Debugging
=========
You can debug an application in the usual way. Here is an example for the
:ref:`hello_world` application.
:zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

4
boards/atmel/sam/sam_v71_xult/doc/index.rst
View file

@ -144,7 +144,7 @@ Flashing
- Stop bits: 1
#. Connect the SAM V71 Xplained Ultra board to your host computer using the
USB debug port. Then build and flash the :ref:`hello_world`
USB debug port. Then build and flash the :zephyr:code-sample:`hello_world`
application.
.. zephyr-app-commands::
@ -174,7 +174,7 @@ Debugging
=========
You can debug an application in the usual way. Here is an example for the
:ref:`hello_world` application.
:zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/atmel/sam0/samd20_xpro/doc/index.rst
View file

@ -110,7 +110,7 @@ OpenOCD.
Flashing
========
#. Build the Zephyr kernel and the :ref:`hello_world` sample application:
#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application:
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/atmel/sam0/samr21_xpro/doc/index.rst
View file

@ -174,7 +174,7 @@ OpenOCD.
Flashing
========
#. Build the Zephyr kernel and the :ref:`hello_world` sample application:
#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application:
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/bbc/microbit/doc/index.rst
View file

@ -77,7 +77,7 @@ Flashing
Build and flash applications as usual (see :ref:`build_an_application` and
:ref:`application_run` for more details).
Here is an example for the :ref:`hello_world` application.
Here is an example for the :zephyr:code-sample:`hello_world` application.
First, run your favorite terminal program to listen for output.

2
boards/bbc/microbit_v2/doc/index.rst
View file

@ -71,7 +71,7 @@ Flashing
Build and flash applications as usual (see :ref:`build_an_application` and
:ref:`application_run` for more details).
Here is an example for the :ref:`hello_world` application.
Here is an example for the :zephyr:code-sample:`hello_world` application.
First, run your favorite terminal program to listen for output.

2
boards/blues/swan_r5/doc/index.rst
View file

@ -198,7 +198,7 @@ Programming and Debugging
Connect Swan to your host computer using the USB port.
Then build and flash an application. Here is an example for the
:ref:`hello_world` application.
:zephyr:code-sample:`hello_world` application.
Run a serial host program to connect with your Swan:

2
boards/bytesatwork/bytesensi_l/doc/index.rst
View file

@ -134,7 +134,7 @@ Flashing
The byteSENSI-L board can be flashed with the SEGGER JLink programmer.
You can build and flash applications in the usual way. Here is an example for
the :ref:`hello_world` application.
the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/circuitdojo/feather/doc/index.rst
View file

@ -111,7 +111,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash
applications as usual (see :ref:`build_an_application` and
:ref:`application_run` for more details).
Here is an example for the :ref:`hello_world` application.
Here is an example for the :zephyr:code-sample:`hello_world` application.
First, run your favorite terminal program to listen for output.

2
boards/contextualelectronics/abc/doc/index.rst
View file

@ -93,7 +93,7 @@ Flashing
Flashing Zephyr onto the ``contextualelectronics_abc`` board requires
an external programmer. The programmer is attached to the SWD header.
Build the Zephyr kernel and the :ref:`hello_world` sample application.
Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

4
boards/cypress/cy8ckit_062_ble/doc/index.rst
View file

@ -154,7 +154,7 @@ and J12 that can be used with Segger J-Link [default].
A watchdog timer is enabled by default. To disable it call Cy_WDT_Unlock() and
Cy_WDT_Disable().
#. Build the Zephyr kernel and the :ref:`hello_world` sample application:
#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application:
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
@ -248,7 +248,7 @@ connections may not allow the correct use of shields. The default board
revision (0.0.0) allows use of default connections. The use of Arduino headers
are only possible after rework the board and using the revision 1.0.0.
#. Build the Zephyr kernel and the :ref:`hello_world` sample application for
#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application for
board revision 1.0.0:
.. zephyr-app-commands::

4
boards/digilent/arty_a7/doc/index.rst
View file

@ -159,7 +159,7 @@ etc.):
Flashing
========
Here is an example for building and flashing the :ref:`hello_world` application
Here is an example for building and flashing the :zephyr:code-sample:`hello_world` application
for the Cortex-M1 reference design:
.. zephyr-app-commands::
@ -191,7 +191,7 @@ dump :file:`zephyr.mem` file suitable for initialising the block RAM using
Debugging
=========
Here is an example for the :ref:`hello_world` application.
Here is an example for the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

6
boards/digilent/zybo/doc/index.rst
View file

@ -77,7 +77,7 @@ Clone and build Das U-Boot for the Digilent Zybo:
Flashing
========
Here is an example for running the :ref:`hello_world` application via JTAG.
Here is an example for running the :zephyr:code-sample:`hello_world` application via JTAG.
Ensure the board is configured for JTAG boot, open a serial terminal, turn on/reset the board (press
the ``PS-SRST`` button), and initialize the Zynq-7000 series SoC by uploading and running the U-Boot
@ -97,7 +97,7 @@ You should see the following message in the terminal:
*** Booting Zephyr OS vx.xx.x-xxx-gxxxxxxxxxxxx ***
Hello World! zybo
Another option is to load and run the :ref:`hello_world` application via U-Boot. Copy
Another option is to load and run the :zephyr:code-sample:`hello_world` application via U-Boot. Copy
``u-boot/spl/boot.bin``, ``u-boot/u-boot.img``, and ``zephyr/zephyr.bin`` to a FAT32 formatted
microSD card, insert the card in the ``SD MICRO`` slot on the Zybo board, ensure the board is
configured for ``SD`` boot, and turn on the board.
@ -116,7 +116,7 @@ Once U-boot is done initializing, load an run the Zephyr application:
Debugging
=========
Here is an example for the :ref:`hello_world` application.
Here is an example for the :zephyr:code-sample:`hello_world` application.
Ensure the board is configured for JTAG boot, open a serial terminal, turn on/reset the board (press
the ``PS-SRST`` button), and initialize the Zynq-7000 series SoC by uploading and running the U-Boot

4
boards/dragino/lsn50/doc/index.rst
View file

@ -149,7 +149,7 @@ Dragino LSN50 board requires an external debugger.
Flashing an application to Dragino LSN50
----------------------------------------
Here is an example for the :ref:`hello_world` application.
Here is an example for the :zephyr:code-sample:`hello_world` application.
Connect the Dragino LSN50 to a STLinkV2 to your host computer using the USB port, then
run a serial host program to connect with your board. For example:
@ -175,7 +175,7 @@ Debugging
=========
You can debug an application in the usual way. Here is an example for the
:ref:`hello_world` application.
:zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

4
boards/dragino/nbsn95/doc/index.rst
View file

@ -148,7 +148,7 @@ Dragino NBSN95 board requires an external debugger.
Flashing an application to Dragino NBSN95
-----------------------------------------
Here is an example for the :ref:`hello_world` application.
Here is an example for the :zephyr:code-sample:`hello_world` application.
Connect the Dragino NBSN95 to a STLinkV2 to your host computer using the USB port, then
run a serial host program to connect with your board. For example:
@ -174,7 +174,7 @@ Debugging
=========
You can debug an application in the usual way. Here is an example for the
:ref:`hello_world` application.
:zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/electronut/nrf52840_blip/doc/index.rst
View file

@ -141,7 +141,7 @@ Flashing
Applications are flashed and run as usual (see :ref:`build_an_application` and
:ref:`application_run` for more details).
Here is an example for the :ref:`hello_world` application.
Here is an example for the :zephyr:code-sample:`hello_world` application.
First, run your favorite terminal program to listen for output.

2
boards/electronut/nrf52840_papyr/doc/nrf52840_papyr.rst
View file

@ -151,7 +151,7 @@ debugger (see _Bumpy).
Applications are flashed and run as usual (see :ref:`build_an_application` and
:ref:`application_run` for more details).
Here is an example for the :ref:`hello_world` application.
Here is an example for the :zephyr:code-sample:`hello_world` application.
First, run your favorite terminal program to listen for output.

6
boards/espressif/esp32_devkitc_wroom/doc/index.rst
View file

@ -213,7 +213,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and
:goals: build
The usual ``flash`` target will work with the ``esp32_devkitc_wroom`` board
configuration. Here is an example for the :ref:`hello_world`
configuration. Here is an example for the :zephyr:code-sample:`hello_world`
application.
.. zephyr-app-commands::
@ -264,14 +264,14 @@ to the external programmer (e.g. a Flyswatter2):
Further documentation can be obtained from the SoC vendor in `JTAG debugging for ESP32`_.
Here is an example for building the :ref:`hello_world` application.
Here is an example for building the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
:board: esp32_devkitc_wroom/esp32/procpu
:goals: build flash
You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application.
You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

6
boards/espressif/esp32_devkitc_wrover/doc/index.rst
View file

@ -213,7 +213,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and
:goals: build
The usual ``flash`` target will work with the ``esp32_devkitc_wrover`` board
configuration. Here is an example for the :ref:`hello_world`
configuration. Here is an example for the :zephyr:code-sample:`hello_world`
application.
.. zephyr-app-commands::
@ -264,14 +264,14 @@ to the external programmer (e.g. a Flyswatter2):
Further documentation can be obtained from the SoC vendor in `JTAG debugging for ESP32`_.
Here is an example for building the :ref:`hello_world` application.
Here is an example for building the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
:board: esp32_devkitc_wrover/esp32/procpu
:goals: build flash
You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application.
You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

6
boards/espressif/esp32_ethernet_kit/doc/index.rst
View file

@ -530,7 +530,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and
:goals: build
The usual ``flash`` target will work with the ``esp32_ethernet_kit`` board
configuration. Here is an example for the :ref:`hello_world`
configuration. Here is an example for the :zephyr:code-sample:`hello_world`
application.
.. zephyr-app-commands::
@ -563,7 +563,7 @@ The Zephyr SDK uses a bundled version of OpenOCD by default. You can overwrite t
``-DOPENOCD=<path/to/bin/openocd> -DOPENOCD_DEFAULT_PATH=<path/to/openocd/share/openocd/scripts>``
parameter when building.
Here is an example for building the :ref:`hello_world` application.
Here is an example for building the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
@ -571,7 +571,7 @@ Here is an example for building the :ref:`hello_world` application.
:goals: build flash
:gen-args: -DOPENOCD=<path/to/bin/openocd> -DOPENOCD_DEFAULT_PATH=<path/to/openocd/share/openocd/scripts>
You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application.
You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

6
boards/espressif/esp32c3_devkitc/doc/index.rst
View file

@ -195,7 +195,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and
:goals: build
The usual ``flash`` target will work with the ``esp32c3_devkitc`` board
configuration. Here is an example for the :ref:`hello_world`
configuration. Here is an example for the :zephyr:code-sample:`hello_world`
application.
.. zephyr-app-commands::
@ -228,7 +228,7 @@ The Zephyr SDK uses a bundled version of OpenOCD by default. You can overwrite t
``-DOPENOCD=<path/to/bin/openocd> -DOPENOCD_DEFAULT_PATH=<path/to/openocd/share/openocd/scripts>``
parameter when building.
Here is an example for building the :ref:`hello_world` application.
Here is an example for building the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
@ -236,7 +236,7 @@ Here is an example for building the :ref:`hello_world` application.
:goals: build flash
:gen-args: -DOPENOCD=<path/to/bin/openocd> -DOPENOCD_DEFAULT_PATH=<path/to/openocd/share/openocd/scripts>
You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application.
You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

6
boards/espressif/esp32c3_devkitm/doc/index.rst
View file

@ -195,7 +195,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and
:goals: build
The usual ``flash`` target will work with the ``esp32c3_devkitm`` board
configuration. Here is an example for the :ref:`hello_world`
configuration. Here is an example for the :zephyr:code-sample:`hello_world`
application.
.. zephyr-app-commands::
@ -228,7 +228,7 @@ The Zephyr SDK uses a bundled version of OpenOCD by default. You can overwrite t
``-DOPENOCD=<path/to/bin/openocd> -DOPENOCD_DEFAULT_PATH=<path/to/openocd/share/openocd/scripts>``
parameter when building.
Here is an example for building the :ref:`hello_world` application.
Here is an example for building the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
@ -236,7 +236,7 @@ Here is an example for building the :ref:`hello_world` application.
:goals: build flash
:gen-args: -DOPENOCD=<path/to/bin/openocd> -DOPENOCD_DEFAULT_PATH=<path/to/openocd/share/openocd/scripts>
You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application.
You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

6
boards/espressif/esp32c3_rust/doc/index.rst
View file

@ -240,7 +240,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and
:goals: build
The usual ``flash`` target will work with the ``esp32c3_rust`` board
configuration. Here is an example for the :ref:`hello_world`
configuration. Here is an example for the :zephyr:code-sample:`hello_world`
application.
.. zephyr-app-commands::
@ -273,7 +273,7 @@ The Zephyr SDK uses a bundled version of OpenOCD by default. You can overwrite t
``-DOPENOCD=<path/to/bin/openocd> -DOPENOCD_DEFAULT_PATH=<path/to/openocd/share/openocd/scripts>``
parameter when building.
Here is an example for building the :ref:`hello_world` application.
Here is an example for building the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
@ -281,7 +281,7 @@ Here is an example for building the :ref:`hello_world` application.
:goals: build flash
:gen-args: -DOPENOCD=<path/to/bin/openocd> -DOPENOCD_DEFAULT_PATH=<path/to/openocd/share/openocd/scripts>
You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application.
You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

6
boards/espressif/esp32c6_devkitc/doc/index.rst
View file

@ -229,7 +229,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and
:goals: build
The usual ``flash`` target will work with the ``esp32c6_devkitc`` board
configuration. Here is an example for the :ref:`hello_world`
configuration. Here is an example for the :zephyr:code-sample:`hello_world`
application.
.. zephyr-app-commands::
@ -262,7 +262,7 @@ The Zephyr SDK uses a bundled version of OpenOCD by default. You can overwrite t
``-DOPENOCD=<path/to/bin/openocd> -DOPENOCD_DEFAULT_PATH=<path/to/openocd/share/openocd/scripts>``
parameter when building.
Here is an example for building the :ref:`hello_world` application.
Here is an example for building the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
@ -270,7 +270,7 @@ Here is an example for building the :ref:`hello_world` application.
:goals: build flash
:gen-args: -DOPENOCD=<path/to/bin/openocd> -DOPENOCD_DEFAULT_PATH=<path/to/openocd/share/openocd/scripts>
You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application.
You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

6
boards/espressif/esp32s2_devkitc/doc/index.rst
View file

@ -192,7 +192,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and
:goals: build
The usual ``flash`` target will work with the ``esp32s2_devkitc`` board
configuration. Here is an example for the :ref:`hello_world`
configuration. Here is an example for the :zephyr:code-sample:`hello_world`
application.
.. zephyr-app-commands::
@ -235,14 +235,14 @@ The following table shows the pin mapping between ESP32-S2 board and JTAG interf
Further documentation can be obtained from the SoC vendor in `JTAG debugging for ESP32-S2`_.
Here is an example for building the :ref:`hello_world` application.
Here is an example for building the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
:board: esp32s2_devkitc
:goals: build flash
You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application.
You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

6
boards/espressif/esp32s2_saola/doc/index.rst
View file

@ -192,7 +192,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and
:goals: build
The usual ``flash`` target will work with the ``esp32s2_saola`` board
configuration. Here is an example for the :ref:`hello_world`
configuration. Here is an example for the :zephyr:code-sample:`hello_world`
application.
.. zephyr-app-commands::
@ -235,14 +235,14 @@ The following table shows the pin mapping between ESP32-S2 board and JTAG interf
Further documentation can be obtained from the SoC vendor in `JTAG debugging for ESP32-S2`_.
Here is an example for building the :ref:`hello_world` application.
Here is an example for building the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
:board: esp32s2_saola
:goals: build flash
You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application.
You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

6
boards/espressif/esp32s3_devkitc/doc/index.rst
View file

@ -231,7 +231,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and
:goals: build
The usual ``flash`` target will work with the ``esp32s3_devkitc`` board
configuration. Here is an example for the :ref:`hello_world`
configuration. Here is an example for the :zephyr:code-sample:`hello_world`
application.
.. zephyr-app-commands::
@ -262,14 +262,14 @@ ESP32-S3 has a built-in JTAG circuitry and can be debugged without any additiona
Further documentation can be obtained from the SoC vendor in `JTAG debugging for ESP32-S3`_.
Here is an example for building the :ref:`hello_world` application.
Here is an example for building the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
:board: esp32s3_devkitc/esp32s3/procpu
:goals: build flash
You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application.
You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

6
boards/espressif/esp32s3_devkitm/doc/index.rst
View file

@ -231,7 +231,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and
:goals: build
The usual ``flash`` target will work with the ``esp32s3_devkitm`` board
configuration. Here is an example for the :ref:`hello_world`
configuration. Here is an example for the :zephyr:code-sample:`hello_world`
application.
.. zephyr-app-commands::
@ -262,14 +262,14 @@ ESP32-S3 has a built-in JTAG circuitry and can be debugged without any additiona
Further documentation can be obtained from the SoC vendor in `JTAG debugging for ESP32-S3`_.
Here is an example for building the :ref:`hello_world` application.
Here is an example for building the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
:board: esp32s3_devkitm/esp32s3/procpu
:goals: build flash
You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application.
You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

6
boards/espressif/esp8684_devkitm/doc/index.rst
View file

@ -187,7 +187,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and
:goals: build
The usual ``flash`` target will work with the ``esp8684_devkitm`` board
configuration. Here is an example for the :ref:`hello_world`
configuration. Here is an example for the :zephyr:code-sample:`hello_world`
application.
.. zephyr-app-commands::
@ -220,7 +220,7 @@ The Zephyr SDK uses a bundled version of OpenOCD by default. You can overwrite t
``-DOPENOCD=<path/to/bin/openocd> -DOPENOCD_DEFAULT_PATH=<path/to/openocd/share/openocd/scripts>``
parameter when building.
Here is an example for building the :ref:`hello_world` application.
Here is an example for building the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
@ -228,7 +228,7 @@ Here is an example for building the :ref:`hello_world` application.
:goals: build flash
:gen-args: -DOPENOCD=<path/to/bin/openocd> -DOPENOCD_DEFAULT_PATH=<path/to/openocd/share/openocd/scripts>
You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application.
You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

6
boards/espressif/esp_wrover_kit/doc/index.rst
View file

@ -598,7 +598,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and
:goals: build
The usual ``flash`` target will work with the ``esp_wrover_kit`` board
configuration. Here is an example for the :ref:`hello_world`
configuration. Here is an example for the :zephyr:code-sample:`hello_world`
application.
.. zephyr-app-commands::
@ -634,7 +634,7 @@ headers are on the right side of the board as viewed from the power
switch, next to similar headers for SPI and UART. See
`ESP-WROVER-32 V3 Getting Started Guide`_ for details.
Here is an example for building the :ref:`hello_world` application.
Here is an example for building the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
@ -642,7 +642,7 @@ Here is an example for building the :ref:`hello_world` application.
:goals: build flash
:gen-args: -DOPENOCD=<path/to/bin/openocd> -DOPENOCD_DEFAULT_PATH=<path/to/openocd/share/openocd/scripts>
You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application.
You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/ezurio/bl5340_dvk/doc/index.rst
View file

@ -379,7 +379,7 @@ applications as usual (:ref:`build_an_application` and
Further information on how to install the nRF Command Line Tools can
be found in :ref:`nordic_segger_flashing`.
Here is an example for the :ref:`hello_world` application running on the
Here is an example for the :zephyr:code-sample:`hello_world` application running on the
BL5340's application core.
First, run your favorite terminal program to listen for output.

2
boards/ezurio/bl652_dvk/doc/bl652_dvk.rst
View file

@ -214,7 +214,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash
applications as usual (see :ref:`build_an_application` and
:ref:`application_run` for more details).
Here is an example for the :ref:`hello_world` application.
Here is an example for the :zephyr:code-sample:`hello_world` application.
First, run your favorite terminal program to listen for output.

2
boards/ezurio/bl653_dvk/doc/bl653_dvk.rst
View file

@ -120,7 +120,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash
applications as usual (see :ref:`build_an_application` and
:ref:`application_run` for more details).
Here is an example for the :ref:`hello_world` application.
Here is an example for the :zephyr:code-sample:`hello_world` application.
First, run your favorite terminal program to listen for output.

2
boards/ezurio/bl654_dvk/doc/bl654_dvk.rst
View file

@ -131,7 +131,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash
applications as usual (see :ref:`build_an_application` and
:ref:`application_run` for more details).
Here is an example for the :ref:`hello_world` application.
Here is an example for the :zephyr:code-sample:`hello_world` application.
First, run your favorite terminal program to listen for output.

2
boards/ezurio/bl654_sensor_board/doc/bl654_sensor_board.rst
View file

@ -145,7 +145,7 @@ as usual (see :ref:`build_an_application` and :ref:`application_run` for more
details). If using a Ezurio USB-SWD Programmer Board, see the
`pyOCD website`_ to find details about the software and how to install it.
Here is an example for the :ref:`hello_world` application.
Here is an example for the :zephyr:code-sample:`hello_world` application.
First, run your favorite terminal program to listen for output - note that an
external UART is required to be connected to the BL654 sensor board's UART, if

2
boards/ezurio/bt510/doc/bt510.rst
View file

@ -187,7 +187,7 @@ Then build and flash applications as usual (see :ref:`build_an_application` and
$ ninja flash
Here is an example for the :ref:`hello_world` application.
Here is an example for the :zephyr:code-sample:`hello_world` application.
First, run your favorite terminal program to listen for output.

2
boards/ezurio/bt610/doc/bt610.rst
View file

@ -545,7 +545,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash
applications as usual (see :ref:`build_an_application` and
:ref:`application_run` for more details).
Here is an example for the :ref:`hello_world` application.
Here is an example for the :zephyr:code-sample:`hello_world` application.
First, run your favorite terminal program to listen for output.

2
boards/ezurio/mg100/doc/index.rst
View file

@ -174,7 +174,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash
applications as usual (see :ref:`build_an_application` and
:ref:`application_run` for more details).
Here is an example for the :ref:`hello_world` application.
Here is an example for the :zephyr:code-sample:`hello_world` application.
First, run your favorite terminal program to listen for output.

2
boards/ezurio/pinnacle_100_dvk/doc/index.rst
View file

@ -144,7 +144,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash
applications as usual (see :ref:`build_an_application` and
:ref:`application_run` for more details).
Here is an example for the :ref:`hello_world` application.
Here is an example for the :zephyr:code-sample:`hello_world` application.
First, run your favorite terminal program to listen for output.

2
boards/ezurio/rm1xx_dvk/doc/index.rst
View file

@ -143,7 +143,7 @@ found in :ref:`nordic_segger_flashing`. Then build and flash
applications as usual (see :ref:`build_an_application` and
:ref:`application_run` for more details).
Here is an example for the :ref:`hello_world` application.
Here is an example for the :zephyr:code-sample:`hello_world` application.
First, run your favorite terminal program to listen for output.

2
boards/fanke/fk7b0m1_vbt6/doc/index.rst
View file

@ -145,7 +145,7 @@ To begin, connect the ST-Link Debug Programmer to the FK7B0M1-VBT6 board using t
interface. Next, connect the ST-Link to your host computer via a USB port.
Once this setup is complete, you can proceed to build and flash your application to the board
Here is an example for the :ref:`hello_world` application.
Here is an example for the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/franzininho/esp32s2_franzininho/doc/index.rst
View file

@ -148,7 +148,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and
:goals: build
The usual ``flash`` target will work with the ``esp32s2_franzininho`` board
configuration. Here is an example for the :ref:`hello_world`
configuration. Here is an example for the :zephyr:code-sample:`hello_world`
application.
.. zephyr-app-commands::

4
boards/gd/gd32a503v_eval/doc/index.rst
View file

@ -119,7 +119,7 @@ The GD32A503V-EVAL includes an onboard programmer/debugger (GD-Link) which
allow flash programming and debug over USB. There are also program and debug
headers J2 and J100 that can be used with any ARM compatible tools.
#. Build the Zephyr kernel and the :ref:`hello_world` sample application:
#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application:
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
@ -168,7 +168,7 @@ The GD32A503 MCU have a ROM bootloader which allow flash programming. User
should install `GD32 ISP Console`_ software at some Linux path. The recommended
is :code:`$HOME/.local/bin`.
#. Build the Zephyr kernel and the :ref:`hello_world` sample application:
#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application:
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

4
boards/gd/gd32e103v_eval/doc/index.rst
View file

@ -111,7 +111,7 @@ The GD32E103V-EVAL includes an onboard programmer/debugger (GD-Link) which
allow flash programming and debug over USB. There are also program and debug
headers J1 and J100 that can be used with any ARM compatible tools.
#. Build the Zephyr kernel and the :ref:`hello_world` sample application:
#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application:
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
@ -160,7 +160,7 @@ The GD32E103 MCU have a ROM bootloader which allow flash programming. User
should install `GD32 ISP Console`_ software at some Linux path. The recommended
is :code:`$HOME/.local/bin`.
#. Build the Zephyr kernel and the :ref:`hello_world` sample application:
#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application:
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/gd/gd32e507v_start/doc/index.rst
View file

@ -94,7 +94,7 @@ provided you install the necessary CMSIS-Pack:
J-Link can also be used to program the board using the SWD interface exposed in
the JP1 header.
#. Build the Zephyr kernel and the :ref:`hello_world` sample application:
#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application:
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/gd/gd32e507z_eval/doc/index.rst
View file

@ -102,7 +102,7 @@ provided you install the necessary CMSIS-Pack:
J-Link can also be used to program the board using the JTAG interface exposed in
the JP2 header.
#. Build the Zephyr kernel and the :ref:`hello_world` sample application:
#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application:
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/gd/gd32f350r_eval/doc/index.rst
View file

@ -87,7 +87,7 @@ The GD32F350R-EVAL includes an onboard programmer/debugger (GD-Link) which
allows flash programming and debugging over USB. There is also a SWD header
(J3) which can be used with tools like Segger J-Link.
#. Build the Zephyr kernel and the :ref:`hello_world` sample application:
#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application:
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

4
boards/gd/gd32f403z_eval/doc/index.rst
View file

@ -114,7 +114,7 @@ The GD32F403Z-EVAL includes an onboard programmer/debugger (GD-Link) which
allow flash programming and debug over USB. There are also program and debug
headers J1 and J100 that can be used with any ARM compatible tools.
#. Build the Zephyr kernel and the :ref:`hello_world` sample application:
#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application:
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
@ -163,7 +163,7 @@ The GD32F403 MCU have a ROM bootloader which allow flash programming. User
should install `GD32 ISP Console`_ software at some Linux path. The recommended
is :code:`$HOME/.local/bin`.
#. Build the Zephyr kernel and the :ref:`hello_world` sample application:
#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application:
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/gd/gd32f407v_start/doc/index.rst
View file

@ -96,7 +96,7 @@ if not installed yet.
Also, J-Link can be used to program the board via the SWD interface
(PA13/SWDIO and PA14/SWCLK in the JP6 header).
#. Build the Zephyr kernel and the :ref:`hello_world` sample application:
#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application:
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/gd/gd32f450i_eval/doc/index.rst
View file

@ -112,7 +112,7 @@ The GD32F450I-EVAL includes an onboard programmer/debugger (GD-Link) which
allows flash programming and debugging over USB. There is also a JTAG header
(J1) which can be used with tools like Segger J-Link.
#. Build the Zephyr kernel and the :ref:`hello_world` sample application:
#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application:
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/gd/gd32f450v_start/doc/index.rst
View file

@ -89,7 +89,7 @@ The GD32F450V-START includes an onboard programmer/debugger (GD-Link) which
allows flash programming and debugging over USB. There is also a SWD header
(JP100) which can be used with tools like Segger J-Link.
#. Build the Zephyr kernel and the :ref:`hello_world` sample application:
#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application:
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/gd/gd32f450z_eval/doc/index.rst
View file

@ -107,7 +107,7 @@ The GD32F450Z-EVAL includes an onboard programmer/debugger (GD-Link) which
allows flash programming and debugging over USB. There is also a JTAG header
(J1) which can be used with tools like Segger J-Link.
#. Build the Zephyr kernel and the :ref:`hello_world` sample application:
#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application:
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/gd/gd32f470i_eval/doc/index.rst
View file

@ -111,7 +111,7 @@ The GD32F470I-EVAL includes an onboard programmer/debugger (GD-Link) which
allows flash programming and debugging over USB. There is also a JTAG header
(J1) which can be used with tools like Segger J-Link.
#. Build the Zephyr kernel and the :ref:`hello_world` sample application:
#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application:
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/gd/gd32l233r_eval/doc/index.rst
View file

@ -88,7 +88,7 @@ The GD32L233R-EVAL includes an onboard programmer/debugger (GD-Link) which
allows flash programming and debugging over USB. There is also a SWD header
which can be used with tools like Segger J-Link(latest version required).
#. Build the Zephyr kernel and the :ref:`hello_world` sample application:
#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application:
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/gd/gd32vf103c_starter/doc/index.rst
View file

@ -83,7 +83,7 @@ The GD32VF103C-STARTER includes an onboard programmer/debugger (GD-Link) which
allows flash programming and debugging over USB. There is also a JTAG header
(JP1) which can be used with tools like Segger J-Link.
#. Build the Zephyr kernel and the :ref:`hello_world` sample application:
#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application:
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

2
boards/gd/gd32vf103v_eval/doc/index.rst
View file

@ -93,7 +93,7 @@ The GD32VF103V-EVAL includes an onboard programmer/debugger (GD-Link) which
allows flash programming and debugging over USB. There is also a JTAG header
(JP1) which can be used with tools like Segger J-Link.
#. Build the Zephyr kernel and the :ref:`hello_world` sample application:
#. Build the Zephyr kernel and the :zephyr:code-sample:`hello_world` sample application:
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

6
boards/hardkernel/odroid_go/doc/index.rst
View file

@ -192,7 +192,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and
:goals: build
The usual ``flash`` target will work with the ``odroid_go`` board
configuration. Here is an example for the :ref:`hello_world`
configuration. Here is an example for the :zephyr:code-sample:`hello_world`
application.
.. zephyr-app-commands::
@ -225,7 +225,7 @@ The Zephyr SDK uses a bundled version of OpenOCD by default. You can overwrite t
``-DOPENOCD=<path/to/bin/openocd> -DOPENOCD_DEFAULT_PATH=<path/to/openocd/share/openocd/scripts>``
parameter when building.
Here is an example for building the :ref:`hello_world` application.
Here is an example for building the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
@ -233,7 +233,7 @@ Here is an example for building the :ref:`hello_world` application.
:goals: build flash
:gen-args: -DOPENOCD=<path/to/bin/openocd> -DOPENOCD_DEFAULT_PATH=<path/to/openocd/share/openocd/scripts>
You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application.
You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

6
boards/heltec/heltec_wifi_lora32_v2/doc/index.rst
View file

@ -136,7 +136,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and
:goals: build
The usual ``flash`` target will work with the ``heltec_wifi_lora32_v2`` board
configuration. Here is an example for the :ref:`hello_world`
configuration. Here is an example for the :zephyr:code-sample:`hello_world`
application.
.. zephyr-app-commands::
@ -169,7 +169,7 @@ The Zephyr SDK uses a bundled version of OpenOCD by default. You can overwrite t
``-DOPENOCD=<path/to/bin/openocd> -DOPENOCD_DEFAULT_PATH=<path/to/openocd/share/openocd/scripts>``
parameter when building.
Here is an example for building the :ref:`hello_world` application.
Here is an example for building the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
@ -177,7 +177,7 @@ Here is an example for building the :ref:`hello_world` application.
:goals: build flash
:gen-args: -DOPENOCD=<path/to/bin/openocd> -DOPENOCD_DEFAULT_PATH=<path/to/openocd/share/openocd/scripts>
You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application.
You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

6
boards/heltec/heltec_wireless_stick_lite_v3/doc/index.rst
View file

@ -250,7 +250,7 @@ Build and flash applications as usual (see :ref:`build_an_application` and
:goals: build
The usual ``flash`` target will work with the ``heltec_wireless_stick_lite_v3`` board
configuration. Here is an example for the :ref:`hello_world`
configuration. Here is an example for the :zephyr:code-sample:`hello_world`
application.
.. zephyr-app-commands::
@ -283,7 +283,7 @@ The Zephyr SDK uses a bundled version of OpenOCD by default. You can overwrite t
``-DOPENOCD=<path/to/bin/openocd> -DOPENOCD_DEFAULT_PATH=<path/to/openocd/share/openocd/scripts>``
parameter when building.
Here is an example for building the :ref:`hello_world` application.
Here is an example for building the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world
@ -291,7 +291,7 @@ Here is an example for building the :ref:`hello_world` application.
:goals: build flash
:gen-args: -DOPENOCD=<path/to/bin/openocd> -DOPENOCD_DEFAULT_PATH=<path/to/openocd/share/openocd/scripts>
You can debug an application in the usual way. Here is an example for the :ref:`hello_world` application.
You can debug an application in the usual way. Here is an example for the :zephyr:code-sample:`hello_world` application.
.. zephyr-app-commands::
:zephyr-app: samples/hello_world

Some files were not shown because too many files have changed in this diff Show more