1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00

sys/luid: Added postcondition to luid_get()

Stated the obvious in the doc: Altering the LUID returned by luid_get() breaks
the guarantee that it is locally unique, as it than could collide with other
LUIDs returned by luid_get().
This commit is contained in:
Marian Buschsieweke 2019-10-29 21:50:39 +01:00
parent 05d338169d
commit 1ba7e8fe22
No known key found for this signature in database
GPG Key ID: 61F64C6599B1539F

View File

@ -75,6 +75,8 @@ extern "C" {
* byte.
*
* @note The resulting LUID will repeat after 255 calls.
* @post The generated LUID must be used unchanged, as it could collide with
* other LUIDs if altered.
*
* @param[out] buf memory location to copy the LUID into. MUST be able to
* hold at least @p len bytes