From d2c9649acf30008a8623990004ea8bd35eb9e69c Mon Sep 17 00:00:00 2001 From: chrysn Date: Thu, 2 Jul 2020 08:11:59 +0200 Subject: [PATCH] doc: Give examples of what DEVELHELP does See-Also: https://github.com/RIOT-OS/RIOT/pull/14378#issuecomment-652639994 --- doc.txt | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/doc.txt b/doc.txt index 6c816f396d..5088a563b3 100644 --- a/doc.txt +++ b/doc.txt @@ -28,9 +28,21 @@ * @def DEVELHELP * @brief This global macro activates functionality to help developers. * - * Additional code parts such as (extensive) debug output and sanity - * checks using assertions. To activate it set environment variable - * `DEVELHELP=1`, or disable explicitly with `DEVELHELP=0`. + * To activate it set environment variable `DEVELHELP=1`, or disable explicitly + * with `DEVELHELP=0`. + * + * The following list of what `DEVELHELP=1` enables is not comprehensive, but + * should give a rough impression of what to expect: + * + * * Many runtime checks are enabled (stack overflow protection, warnings when + * sending messages to invalid PIDs, …), some of which just log errors to + * stdout, some even halt the system. + * * Some structures contain additional information, e.g. threads store their + * names and stack sizes. + * * Some error paths that are active even at `DEVELHELP=0` perform more + * complex tasks to give useful output. + * * On a panic, the system halts (or enters the bootloader) instead of + * restarting. */ #if DOXYGEN # define DEVELHELP