1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-14 17:13:50 +01:00

core/doc: Thread names are expected to be long-lived

This commit is contained in:
chrysn 2025-05-07 17:12:47 +02:00
parent 96e202f2f0
commit 79071b10f2

View File

@ -260,13 +260,16 @@ struct _thread {
* is considered to be a bad programming practice and we strongly
* discourage you from doing so.
*
* @pre The @p name parameter must stay valid even after the thread has
* terminated (e.g. using a literal).
*
* @param[out] stack start address of the preallocated stack memory
* @param[in] stacksize the size of the thread's stack in bytes
* @param[in] priority priority of the new thread, lower mean higher priority
* @param[in] flags optional flags for the creation of the new thread
* @param[in] task_func pointer to the code that is executed in the new thread
* @param[in] arg the argument to the function
* @param[in] name a human readable descriptor for the thread
* @param[in] name a human readable descriptor for the thread.
*
* @return PID of newly created task on success
* @retval -EINVAL @p priority is greater than or equal to