Skip to content

samples: uuid: fix README issues #88800

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 22, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 12 additions & 10 deletions samples/subsys/uuid/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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: