From a9ed8f8e2332b8f5bbf8a1be43fac7763c98050f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benjamin=20Cab=C3=A9?= Date: Fri, 18 Apr 2025 15:43:20 +0200 Subject: [PATCH] samples: uuid: fix README issues MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - use zephyr-app-commands - fix bullet list formatting - cross-reference UUID doxygen group Signed-off-by: Benjamin Cabé --- samples/subsys/uuid/README.rst | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/samples/subsys/uuid/README.rst b/samples/subsys/uuid/README.rst index 3e399af2d55f..c020063389ec 100644 --- a/samples/subsys/uuid/README.rst +++ b/samples/subsys/uuid/README.rst @@ -6,10 +6,11 @@ Overview ******** -This sample app demonstrates the use of the UUID utilities to generate and manipulate UUIDs -accordingly to IETF RFC 9562. +This sample app demonstrates the use of the :c:group:`uuid` utilities to generate and manipulate +UUIDs accordingly to IETF RFC 9562. The following functionality is demonstrated: + - UUIDv4 generation - UUIDv5 generation from namespace and data - UUID conversion from/to string and to base64 and base64 URL safe formats @@ -18,6 +19,7 @@ Requirements ************ This sample relies on the following modules: + - MbedTLS for the UUIDv5 hash functions - Base64 for the base64 encoding of UUIDs - Entropy source for the pseudo-random generation of UUIDv4 @@ -26,11 +28,11 @@ Building and Running ******************** Use the standard ``west`` commands to build and flash this application. -For example for ``native_sim`` build with: -``` -west build -p -b native_sim samples/subsys/uuid -``` -Then run with: -``` -west build -t run -``` +For example, for ``native_sim``: + +.. zephyr-app-commands:: + :zephyr-app: samples/subsys/uuid + :host-os: unix + :board: native_sim + :goals: run + :compact: