doc: add a hint to cpu_conf.h

This commit is contained in:
Oleg Hahm 2016-04-21 15:00:13 +02:00
parent 435685cf4a
commit 1319c5e874

View File

@ -105,6 +105,9 @@ struct _thread {
/** /**
* @def THREAD_STACKSIZE_DEFAULT * @def THREAD_STACKSIZE_DEFAULT
* @brief A reasonable default stack size that will suffice most smaller tasks * @brief A reasonable default stack size that will suffice most smaller tasks
*
* @note This value must be defined by the CPU specific implementation, please
* take a look at @c cpu/$CPU/include/cpu_conf.h
*/ */
#ifndef THREAD_STACKSIZE_DEFAULT #ifndef THREAD_STACKSIZE_DEFAULT
#error THREAD_STACKSIZE_DEFAULT must be defined per CPU #error THREAD_STACKSIZE_DEFAULT must be defined per CPU
@ -116,6 +119,9 @@ struct _thread {
/** /**
* @def THREAD_STACKSIZE_IDLE * @def THREAD_STACKSIZE_IDLE
* @brief Size of the idle task's stack in bytes * @brief Size of the idle task's stack in bytes
*
* @note This value must be defined by the CPU specific implementation, please
* take a look at @c cpu/$CPU/include/cpu_conf.h
*/ */
#ifndef THREAD_STACKSIZE_IDLE #ifndef THREAD_STACKSIZE_IDLE
#error THREAD_STACKSIZE_IDLE must be defined per CPU #error THREAD_STACKSIZE_IDLE must be defined per CPU
@ -128,6 +134,9 @@ struct _thread {
* @def THREAD_EXTRA_STACKSIZE_PRINTF * @def THREAD_EXTRA_STACKSIZE_PRINTF
* @ingroup conf * @ingroup conf
* @brief Size of the task's printf stack in bytes * @brief Size of the task's printf stack in bytes
*
* @note This value must be defined by the CPU specific implementation, please
* take a look at @c cpu/$CPU/include/cpu_conf.h
*/ */
#ifndef THREAD_EXTRA_STACKSIZE_PRINTF #ifndef THREAD_EXTRA_STACKSIZE_PRINTF
#error THREAD_EXTRA_STACKSIZE_PRINTF must be defined per CPU #error THREAD_EXTRA_STACKSIZE_PRINTF must be defined per CPU