michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: kernel: thread stack is not the same as stack object

Browse source 
Fix mixup of stack objects and thread stacks.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2021-05-17 12:40:01 -04:00
commit 9440a1c2b8
2 changed files with 13 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

3
doc/reference/kernel/threads/index.rst
View file

@ -542,3 +542,6 @@ API Reference
.. doxygengroup:: thread_apis
:project: Zephyr
.. doxygengroup:: thread_stack_api
:project: Zephyr

12
include/sys/thread_stack.h
View file

@ -10,6 +10,14 @@
* @brief Macros for declaring thread stacks
*/
/**
* @brief Thread Stack APIs
* @ingroup kernel_apis
* @defgroup thread_stack_api Thread Stack APIs
* @{
* @}
*/
#ifndef ZEPHYR_INCLUDE_SYS_THREAD_STACK_H
#define ZEPHYR_INCLUDE_SYS_THREAD_STACK_H
@ -107,7 +115,7 @@ static inline char *z_stack_ptr_align(char *ptr)
#define K_KERNEL_STACK_EXTERN(sym) extern k_thread_stack_t sym[]
/**
* @addtogroup stack_apis
* @addtogroup thread_stack_api
* @{
*/
@ -364,7 +372,7 @@ static inline char *Z_KERNEL_STACK_BUFFER(k_thread_stack_t *sym)
#define K_THREAD_STACK_EXTERN(sym) extern k_thread_stack_t sym[]
/**
* @addtogroup stack_apis
* @addtogroup thread_stack_api
* @{
*/