Skip to content

Commit 0d25e30

Browse files
kartbennashif
authored andcommitted
samples: subsys: use zephyr:code-sample directive
Adds missing code-sample directive to the remaining samples in `samples/subsys` that didn't use it yet 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 b23f43c commit 0d25e30

File tree

7 files changed

+20
-17
lines changed

7 files changed

+20
-17
lines changed

doc/services/debugging/debugmon.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,4 +64,4 @@ Using other custom ISR
6464
======================
6565
In order to provide a custom debug monitor interrupt, override ``z_arm_debug_monitor``
6666
symbol. Additionally, manual configuration of some registers is required
67-
(see :ref:`debug monitor sample<debugmon-sample>`).
67+
(see :zephyr:code-sample:`debugmon` sample).

doc/services/ipc/ipc_service/backends/ipc_service_icbmsg.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,4 +80,4 @@ Swap the MBOX channels, memory regions (``tx-region`` and ``rx-region``), and bl
8080
Samples
8181
=======
8282

83-
* :ref:`ipc_multi_endpoint_sample`
83+
* :zephyr:code-sample:`ipc_multi_endpoint`

samples/subsys/dap/README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
.. _dap-sample:
1+
.. zephyr:code-sample:: cmsis-dap
2+
:name: CMSIS-DAP
23

3-
DAP Sample Application
4-
######################
4+
Implement a custom CMSIS-DAP controller using SWDP interface driver.
55

66
Overview
77
********

samples/subsys/debug/debugmon/README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
.. _debugmon-sample:
1+
.. zephyr:code-sample:: debugmon
2+
:name: Debug Monitor
23

3-
Debug monitor
4-
#############
4+
Configure the Debug Monitor feature on a Cortex-M processor.
55

66
Overview
77
********

samples/subsys/debug/fuzz/README.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1-
Fuzzing Example
2-
###############
1+
.. zephyr:code-sample:: fuzzing
2+
:name: Fuzzing
3+
4+
Integrate fuzz testing with Zephyr apps.
35

46
Overview
57
********
68

79
This is a simple example of fuzz test integration with Zephyr apps
8-
that displays LLVM libfuzzer's most important feature: it's ability to
10+
that displays LLVM libfuzzer's most important feature: its ability to
911
detect and explore deep and complicated call trees by exploiting
1012
coverage information gleaned from instrumented binaries.
1113

samples/subsys/ipc/ipc_service/multi_endpoint/README.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
.. _ipc_multi_endpoint_sample:
1+
.. zephyr:code-sample:: ipc_multi_endpoint
2+
:name: IPC service: Multi-endpoint
3+
:relevant-api: ipc
24

3-
IPC Service - Multi-endpoint Sample Application
4-
###############################################
5+
Use the IPC Service with multiple endpoints.
56

67
This application demonstrates how to use IPC Service with multiple endpoints.
78
By default, it uses the ``icmsg_me`` backend.

samples/subsys/sip_svc/README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
.. _sip_svc_sample:
1+
.. zephyr:code-sample:: sip_svc
2+
:name: Arm SiP Services on Intel Agilex SoC FPGA
23

3-
SiP SVC sample
4-
##############
4+
Use the SiP SVC subsystem to interact with the Secure Device Manager on Intel Agilex SoC FPGA.
55

66
Overview
77
********

0 commit comments

Comments
 (0)