Skip to content

Commit 76c266c

Browse files
committed
samples: uuid: fix README issues
- use zephyr-app-commands - fix bullet list formatting - cross-reference UUID doxygen group Signed-off-by: Benjamin Cabé <[email protected]>
1 parent 7ae44ec commit 76c266c

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

samples/subsys/uuid/README.rst

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,11 @@
66
Overview
77
********
88

9-
This sample app demonstrates the use of the UUID utilities to generate and manipulate UUIDs
10-
accordingly to IETF RFC 9562.
9+
This sample app demonstrates the use of the :c:group:`uuid` utilities to generate and manipulate
10+
UUIDs accordingly to IETF RFC 9562.
1111

1212
The following functionality is demonstrated:
13+
1314
- UUIDv4 generation
1415
- UUIDv5 generation from namespace and data
1516
- UUID conversion from/to string and to base64 and base64 URL safe formats
@@ -18,6 +19,7 @@ Requirements
1819
************
1920

2021
This sample relies on the following modules:
22+
2123
- MbedTLS for the UUIDv5 hash functions
2224
- Base64 for the base64 encoding of UUIDs
2325
- Entropy source for the pseudo-random generation of UUIDv4
@@ -26,11 +28,11 @@ Building and Running
2628
********************
2729

2830
Use the standard ``west`` commands to build and flash this application.
29-
For example for ``native_sim`` build with:
30-
```
31-
west build -p -b native_sim samples/subsys/uuid
32-
```
33-
Then run with:
34-
```
35-
west build -t run
36-
```
31+
For example, for ``native_sim``:
32+
33+
.. zephyr-app-commands::
34+
:zephyr-app: samples/subsys/uuid
35+
:host-os: unix
36+
:board: native_sim
37+
:goals: run
38+
:compact:

0 commit comments

Comments
 (0)