diff options
Diffstat (limited to 'os')
| -rw-r--r-- | os/kernel/src/chdebug.c | 3 | ||||
| -rw-r--r-- | os/kernel/templates/chconf.h | 2 |
2 files changed, 4 insertions, 1 deletions
diff --git a/os/kernel/src/chdebug.c b/os/kernel/src/chdebug.c index f5e6bef7a..3049e03e7 100644 --- a/os/kernel/src/chdebug.c +++ b/os/kernel/src/chdebug.c @@ -62,7 +62,8 @@ void chDbgTrace(Thread *otp, Thread *ntp) { /**
* @brief Pointer to the panic message.
* @details This pointer is meant to be accessed through the debugger, it is
- * written once and then the system is halted. + * written once and then the system is halted. This variable can be
+ * set to @p NULL if the halt is caused by a stack overflow. */
char *panic_msg;
diff --git a/os/kernel/templates/chconf.h b/os/kernel/templates/chconf.h index 31c3c7a50..41dddd5d4 100644 --- a/os/kernel/templates/chconf.h +++ b/os/kernel/templates/chconf.h @@ -377,6 +377,8 @@ * @note The default is @p FALSE.
* @note The stack check is performed in a architecture/port dependent way. It
* may not be implemented or some ports.
+ * @note The default failure mode is to halt the system with the global
+ * @p panic_msg variable set to @p NULL.
*/
#if !defined(CH_DBG_ENABLE_STACK_CHECK) || defined(__DOXYGEN__)
#define CH_DBG_ENABLE_STACK_CHECK FALSE
|