From 9902eec01b5307fb10b3d045f9b4eaf3e3929e12 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benjamin=20Cab=C3=A9?= Date: Fri, 23 Aug 2024 18:44:19 +0200 Subject: [PATCH] samples: application_development: use zephyr:code-sample directive MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Describe the samples using code-sample directive in preparation for upcoming changes to the Zephyr documentation that will be leveraging the provided description and metadata. Signed-off-by: Benjamin Cabé --- doc/kernel/code-relocation.rst | 3 +-- .../code_relocation_nocopy/README.rst | 6 +++--- samples/application_development/external_lib/README.rst | 6 +++--- 3 files changed, 7 insertions(+), 8 deletions(-) diff --git a/doc/kernel/code-relocation.rst b/doc/kernel/code-relocation.rst index 73633c2f40e..aea6e11793d 100644 --- a/doc/kernel/code-relocation.rst +++ b/doc/kernel/code-relocation.rst @@ -161,5 +161,4 @@ This test shows how the code relocation feature is used. This test will place .text, .data, .bss from 3 files to various parts in the SRAM using a custom linker file derived from ``include/zephyr/arch/arm/cortex_m/scripts/linker.ld`` -A sample showcasing the NOCOPY flag is provided at -``$ZEPHYR_BASE/samples/application_development/code_relocation_nocopy/`` +A sample showcasing the NOCOPY flag is provided here: :zephyr:code-sample:`code_relocation_nocopy`. diff --git a/samples/application_development/code_relocation_nocopy/README.rst b/samples/application_development/code_relocation_nocopy/README.rst index 9b7ca572a0f..70b923b6240 100644 --- a/samples/application_development/code_relocation_nocopy/README.rst +++ b/samples/application_development/code_relocation_nocopy/README.rst @@ -1,7 +1,7 @@ -.. _code_relocation_nocopy: +.. zephyr:code-sample:: code_relocation_nocopy + :name: Code relocation nocopy -Code relocation nocopy -###################### + Relocate code, data, or bss sections using a custom linker script. Overview ******** diff --git a/samples/application_development/external_lib/README.rst b/samples/application_development/external_lib/README.rst index 8c11421c72e..e2eebf436e9 100644 --- a/samples/application_development/external_lib/README.rst +++ b/samples/application_development/external_lib/README.rst @@ -1,7 +1,7 @@ -.. _external_library: +.. zephyr:code-sample:: external_library + :name: External Library -External Library -################# + Include an external static library into the Zephyr build system. Overview ********