Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

samples: hello_world: use zephyr:code-sample directive #78304

Merged
merged 2 commits into from
Sep 16, 2024
+607 −604
Merged

samples: hello_world: use zephyr:code-sample directive #78304

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cfa5338
doc: misc Sphinx/ReST lint fixes
kartben Sep 14, 2024
117a483
samples: hello_world: use zephyr:code-sample directive
kartben Sep 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion boards/96boards/aerocore2/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion boards/96boards/argonkey/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion boards/96boards/carbon/doc/stm32f401xe.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion boards/96boards/neonkey/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions boards/96boards/nitrogen/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions boards/96boards/stm32_sensor_mez/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion boards/96boards/wistrio/doc/96b_wistrio.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions boards/acrn/acrn/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ Zephyr's is capable of running as a guest under the x86 ACRN
hypervisor (see https://projectacrn.org/). The process for getting
this to work is somewhat involved, however.

ACRN hypervisor supports a hybrid scenario where Zephyr runs in a so-
called "pre-launched" mode. This means Zephyr will access the ACRN
ACRN hypervisor supports a hybrid scenario where Zephyr runs in a so-called
"pre-launched" mode. This means Zephyr will access the ACRN
hypervisor directly without involving the SOS VM. This is the most
practical user scenario in the real world because Zephyr's real-time
and safety capability can be assured without influence from other
Expand Down
2 changes: 1 addition & 1 deletion boards/adafruit/feather_m0_basic_proto/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion boards/adafruit/feather_m0_lora/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion boards/adafruit/grand_central_m4_express/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion boards/adafruit/itsybitsy_m4_express/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions boards/adafruit/nrf52_adafruit_feather/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion boards/adafruit/trinket_m0/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions boards/adi/eval_adin1110ebz/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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::
Expand Down
4 changes: 2 additions & 2 deletions boards/adi/eval_adin2111ebz/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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::
Expand Down
4 changes: 2 additions & 2 deletions boards/adi/max32690fthr/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion boards/adi/sdp_k1/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions boards/alientek/pandora_stm32l475/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion boards/altr/max10/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down
2 changes: 1 addition & 1 deletion boards/ambiq/apollo3_evb/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down
2 changes: 1 addition & 1 deletion boards/ambiq/apollo3p_evb/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down
2 changes: 1 addition & 1 deletion boards/ambiq/apollo4p_blue_kxr_evb/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down
2 changes: 1 addition & 1 deletion boards/ambiq/apollo4p_evb/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down
2 changes: 1 addition & 1 deletion boards/andestech/adp_xc7k_ae350/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion boards/arduino/due/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion boards/arduino/giga_r1/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion boards/arduino/mkrzero/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion boards/arduino/nano_33_iot/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions boards/arduino/nicla_sense_me/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion boards/arduino/nicla_vision/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion boards/arduino/portenta_h7/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion boards/arduino/zero/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion boards/arm/mps2/doc/mps2_an385.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion boards/arm/mps2/doc/mps2_an521.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down
Loading
Loading