kernel: documentatation for _setup_new_thread()
Add a note in the documentatation of _setup_new_thread() function stating that the caller is responsible for providing a size argument that corresponds to the availabe thread stack area. Signed-off-by: Ioannis Glaropoulos <Ioannis.Glaropoulos@nordicsemi.no>
This commit is contained in:
parent
bfc47b6c2a
commit
d69c2f8129
1 changed files with 5 additions and 0 deletions
|
@ -338,6 +338,11 @@ static inline size_t adjust_stack_size(size_t stack_size)
|
|||
|
||||
#endif /* CONFIG_STACK_POINTER_RANDOM */
|
||||
|
||||
/*
|
||||
* Note:
|
||||
* The caller must guarantee that the stack_size passed here corresponds
|
||||
* to the amount of stack memory available for the thread.
|
||||
*/
|
||||
void _setup_new_thread(struct k_thread *new_thread,
|
||||
k_thread_stack_t *stack, size_t stack_size,
|
||||
k_thread_entry_t entry,
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue