Skip to content

Commit 980623b

Browse files
kartbenaescolar
authored andcommitted
samples: hello_world: use zephyr:code-sample directive
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é <[email protected]>
1 parent 98baf29 commit 980623b

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

doc/develop/west/build-flash-debug.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ Setting the Build System Target
145145
To specify the build system target to run, use ``--target`` (or ``-t``).
146146

147147
For example, on host platforms with QEMU, you can use the ``run`` target to
148-
build and run the :ref:`hello_world` sample for the emulated :ref:`qemu_x86
148+
build and run the :zephyr:code-sample:`hello_world` sample for the emulated :ref:`qemu_x86
149149
<qemu_x86>` board in one command::
150150

151151
west build -b qemu_x86 -t run samples/hello_world
@@ -349,7 +349,7 @@ The ``-o`` option is described further in the previous section.
349349
Build a single domain
350350
---------------------
351351

352-
In a multi-domain build with :ref:`hello_world` and `MCUboot`_, you can use
352+
In a multi-domain build with :zephyr:code-sample:`hello_world` and `MCUboot`_, you can use
353353
``--domain hello_world`` to only build this domain::
354354

355355
west build --sysbuild --domain hello_world
@@ -543,7 +543,7 @@ will flash all domains in the order defined by sysbuild.
543543
It is possible to flash the image from a single domain in a multi-domain project
544544
by using ``--domain``.
545545

546-
For example, in a multi-domain build with :ref:`hello_world` and
546+
For example, in a multi-domain build with :zephyr:code-sample:`hello_world` and
547547
`MCUboot`_, you can use the ``--domain hello_world`` domain to only flash
548548
only the image from this domain::
549549

doc/develop/west/sign.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ If you use this feature, you don't need to run ``west sign`` yourself; the
2222
build system will do it for you.
2323

2424
Here is an example workflow, which builds and flashes MCUboot, as well as the
25-
:ref:`hello_world` application for chain-loading by MCUboot. Run these commands
25+
:zephyr:code-sample:`hello_world` application for chain-loading by MCUboot. Run these commands
2626
from the :file:`zephyrproject` workspace you created in the
2727
:ref:`getting_started`.
2828

0 commit comments

Comments
 (0)