michaelh/zephyr
1
0
Fork 0
Code Releases Activity

kernel: clarify k_thread_create() docs

Browse source 
Thread objects were moved out of the stack a long time ago.

Replacing this incorrect information is some clarification
on acceptable size values to pass in.

Signed-off-by: Andrew Boie <andrew.p.boie@intel.com>
This commit is contained in:
Andrew Boie 2020-04-23 16:19:00 -07:00 • committed by Anas Nashif
commit 82b5940fa0
1 changed files with 3 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

7
include/kernel.h
View file

@ -781,10 +781,9 @@ extern void k_thread_foreach_unlocked(
* K_FP_REGS, and K_SSE_REGS. Multiple options may be specified by separating
* them using "|" (the logical OR operator).
*
* Historically, users often would use the beginning of the stack memory region
* to store the struct k_thread data, although corruption will occur if the
* stack overflows this region and stack protection features may not detect this
* situation.
* The stack_size parameter must be the same size value used when the stack
* object was defined, or the return value of K_THREAD_STACK_SIZEOF() on the
* stack object.
*
* @param new_thread Pointer to uninitialized struct k_thread
* @param stack Pointer to the stack space.