From 1b66353a8dfbbedfef62feadd051c10ab8bf8400 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benjamin=20Cab=C3=A9?= Date: Fri, 23 Aug 2024 18:47:19 +0200 Subject: [PATCH] samples: posix: 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é --- samples/posix/env/README.rst | 6 +++--- samples/posix/eventfd/README.rst | 6 +++--- samples/posix/gettimeofday/README.rst | 6 +++--- samples/posix/philosophers/README.rst | 6 +++--- samples/posix/uname/README.rst | 6 +++--- 5 files changed, 15 insertions(+), 15 deletions(-) diff --git a/samples/posix/env/README.rst b/samples/posix/env/README.rst index 6ece6691f79..2f020ba6b88 100644 --- a/samples/posix/env/README.rst +++ b/samples/posix/env/README.rst @@ -1,7 +1,7 @@ -.. _posix-env-sample: +.. zephyr:code-sample:: posix-env + :name: Environment Variables -POSIX Environment Variables -########################### + Manipulate environment variables from a Zephyr application. Overview ******** diff --git a/samples/posix/eventfd/README.rst b/samples/posix/eventfd/README.rst index c6947d6e57c..d2e6a48c9be 100644 --- a/samples/posix/eventfd/README.rst +++ b/samples/posix/eventfd/README.rst @@ -1,7 +1,7 @@ -.. _posix-eventfd-sample: +.. zephyr:code-sample:: posix-eventfd + :name: eventfd() -POSIX eventfd() -############### + Use ``eventfd()`` to create a file descriptor for event notification. Overview ******** diff --git a/samples/posix/gettimeofday/README.rst b/samples/posix/gettimeofday/README.rst index a9cd4771818..868579d62c9 100644 --- a/samples/posix/gettimeofday/README.rst +++ b/samples/posix/gettimeofday/README.rst @@ -1,7 +1,7 @@ -.. _posix-gettimeofday-sample: +.. zephyr:code-sample:: posix-gettimeofday + :name: gettimeofday() with clock initialization -POSIX gettimeofday() with clock initialization over SNTP -######################################################## + Use ``gettimeofday()`` with clock initialization over SNTP. Overview ******** diff --git a/samples/posix/philosophers/README.rst b/samples/posix/philosophers/README.rst index a480d4398a7..604fb8858dd 100644 --- a/samples/posix/philosophers/README.rst +++ b/samples/posix/philosophers/README.rst @@ -1,7 +1,7 @@ -.. _posix-philosophers-sample: +.. zephyr:code-sample:: posix-philosophers + :name: POSIX Philosophers -POSIX Philosophers -################## + Implement a solution to the Dining Philosophers problem using the POSIX API. Overview ******** diff --git a/samples/posix/uname/README.rst b/samples/posix/uname/README.rst index a7d6c69946b..e0f9514ef0b 100644 --- a/samples/posix/uname/README.rst +++ b/samples/posix/uname/README.rst @@ -1,7 +1,7 @@ -.. _posix-uname-sample: +.. zephyr:code-sample:: posix-uname + :name: uname() -POSIX uname() -############# + Use ``uname()`` to acquire system information and output it to the console. Overview ********