From 0d25e30de6e737863dae58b79fe6f39709531d85 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benjamin=20Cab=C3=A9?= Date: Tue, 3 Sep 2024 18:48:33 +0200 Subject: [PATCH] samples: subsys: use zephyr:code-sample directive MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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é --- doc/services/debugging/debugmon.rst | 2 +- .../ipc/ipc_service/backends/ipc_service_icbmsg.rst | 2 +- samples/subsys/dap/README.rst | 6 +++--- samples/subsys/debug/debugmon/README.rst | 6 +++--- samples/subsys/debug/fuzz/README.rst | 8 +++++--- samples/subsys/ipc/ipc_service/multi_endpoint/README.rst | 7 ++++--- samples/subsys/sip_svc/README.rst | 6 +++--- 7 files changed, 20 insertions(+), 17 deletions(-) diff --git a/doc/services/debugging/debugmon.rst b/doc/services/debugging/debugmon.rst index ccf5325d135..74fbffed1d5 100644 --- a/doc/services/debugging/debugmon.rst +++ b/doc/services/debugging/debugmon.rst @@ -64,4 +64,4 @@ Using other custom ISR ====================== In order to provide a custom debug monitor interrupt, override ``z_arm_debug_monitor`` symbol. Additionally, manual configuration of some registers is required -(see :ref:`debug monitor sample`). +(see :zephyr:code-sample:`debugmon` sample). diff --git a/doc/services/ipc/ipc_service/backends/ipc_service_icbmsg.rst b/doc/services/ipc/ipc_service/backends/ipc_service_icbmsg.rst index 26b9006ae81..f06f7587df6 100644 --- a/doc/services/ipc/ipc_service/backends/ipc_service_icbmsg.rst +++ b/doc/services/ipc/ipc_service/backends/ipc_service_icbmsg.rst @@ -80,4 +80,4 @@ Swap the MBOX channels, memory regions (``tx-region`` and ``rx-region``), and bl Samples ======= -* :ref:`ipc_multi_endpoint_sample` +* :zephyr:code-sample:`ipc_multi_endpoint` diff --git a/samples/subsys/dap/README.rst b/samples/subsys/dap/README.rst index dcecb9440b5..7d3d117358b 100644 --- a/samples/subsys/dap/README.rst +++ b/samples/subsys/dap/README.rst @@ -1,7 +1,7 @@ -.. _dap-sample: +.. zephyr:code-sample:: cmsis-dap + :name: CMSIS-DAP -DAP Sample Application -###################### + Implement a custom CMSIS-DAP controller using SWDP interface driver. Overview ******** diff --git a/samples/subsys/debug/debugmon/README.rst b/samples/subsys/debug/debugmon/README.rst index 4d3812ad288..7a328fe6367 100644 --- a/samples/subsys/debug/debugmon/README.rst +++ b/samples/subsys/debug/debugmon/README.rst @@ -1,7 +1,7 @@ -.. _debugmon-sample: +.. zephyr:code-sample:: debugmon + :name: Debug Monitor -Debug monitor -############# + Configure the Debug Monitor feature on a Cortex-M processor. Overview ******** diff --git a/samples/subsys/debug/fuzz/README.rst b/samples/subsys/debug/fuzz/README.rst index 0ee086c4493..11caa4708be 100644 --- a/samples/subsys/debug/fuzz/README.rst +++ b/samples/subsys/debug/fuzz/README.rst @@ -1,11 +1,13 @@ -Fuzzing Example -############### +.. zephyr:code-sample:: fuzzing + :name: Fuzzing + + Integrate fuzz testing with Zephyr apps. Overview ******** This is a simple example of fuzz test integration with Zephyr apps -that displays LLVM libfuzzer's most important feature: it's ability to +that displays LLVM libfuzzer's most important feature: its ability to detect and explore deep and complicated call trees by exploiting coverage information gleaned from instrumented binaries. diff --git a/samples/subsys/ipc/ipc_service/multi_endpoint/README.rst b/samples/subsys/ipc/ipc_service/multi_endpoint/README.rst index c3d0c2019fe..654bffc9b2d 100644 --- a/samples/subsys/ipc/ipc_service/multi_endpoint/README.rst +++ b/samples/subsys/ipc/ipc_service/multi_endpoint/README.rst @@ -1,7 +1,8 @@ -.. _ipc_multi_endpoint_sample: +.. zephyr:code-sample:: ipc_multi_endpoint + :name: IPC service: Multi-endpoint + :relevant-api: ipc -IPC Service - Multi-endpoint Sample Application -############################################### + Use the IPC Service with multiple endpoints. This application demonstrates how to use IPC Service with multiple endpoints. By default, it uses the ``icmsg_me`` backend. diff --git a/samples/subsys/sip_svc/README.rst b/samples/subsys/sip_svc/README.rst index 0170ded6e94..d4c853c09ee 100644 --- a/samples/subsys/sip_svc/README.rst +++ b/samples/subsys/sip_svc/README.rst @@ -1,7 +1,7 @@ -.. _sip_svc_sample: +.. zephyr:code-sample:: sip_svc + :name: Arm SiP Services on Intel Agilex SoC FPGA -SiP SVC sample -############## + Use the SiP SVC subsystem to interact with the Secure Device Manager on Intel Agilex SoC FPGA. Overview ********