michaelh/zephyr
1
0
Fork 0
Code Releases Activity

samples: uuid: fix README issues

Browse source 
- use zephyr-app-commands
- fix bullet list formatting
- cross-reference UUID doxygen group

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This commit is contained in:
Benjamin Cabé 2025-04-18 15:43:20 +02:00 • committed by Benjamin Cabé
commit 76c266c0a7
1 changed files with 12 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

22
samples/subsys/uuid/README.rst
View file

@ -6,10 +6,11 @@
Overview Overview
******** ********
This sample app demonstrates the use of the UUID utilities to generate and manipulate UUIDs This sample app demonstrates the use of the :c:group:`uuid` utilities to generate and manipulate
accordingly to IETF RFC 9562. UUIDs accordingly to IETF RFC 9562.
The following functionality is demonstrated: The following functionality is demonstrated:
- UUIDv4 generation - UUIDv4 generation
- UUIDv5 generation from namespace and data - UUIDv5 generation from namespace and data
- UUID conversion from/to string and to base64 and base64 URL safe formats - 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: This sample relies on the following modules:
- MbedTLS for the UUIDv5 hash functions - MbedTLS for the UUIDv5 hash functions
- Base64 for the base64 encoding of UUIDs - Base64 for the base64 encoding of UUIDs
- Entropy source for the pseudo-random generation of UUIDv4 - 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. Use the standard ``west`` commands to build and flash this application.
For example for ``native_sim`` build with: For example, for ``native_sim``:
```
west build -p -b native_sim samples/subsys/uuid .. zephyr-app-commands::
``` :zephyr-app: samples/subsys/uuid
Then run with: :host-os: unix
``` :board: native_sim
west build -t run :goals: run
``` :compact: