docs: add note about configuring panic/system reset for task WDT

Closes #10995
espressif · Mar 16, 2023 · 86c647e · 86c647e
1 parent c77b575
commit 86c647e
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/docs/en/api-reference/system/wdts.rst b/docs/en/api-reference/system/wdts.rst
@@ -112,6 +112,11 @@ The following config options control TWDT configuration. They are all enabled by
     - :ref:`CONFIG_ESP_TASK_WDT_CHECK_IDLE_TASK_CPU0` - {IDF_TARGET_IDLE_TASK} is subscribed to the TWDT during startup. If this option is disabled, it is still possible to subscribe the idle task by calling :cpp:func:`esp_task_wdt_init` again.
     :not CONFIG_FREERTOS_UNICORE: - :ref:`CONFIG_ESP_TASK_WDT_CHECK_IDLE_TASK_CPU1` - CPU1 Idle task is subscribed to the TWDT during startup.
 
+.. note::
+
+    On a TWDT timeout the default behaviour is to simply print a warning and a backtrace before continuing running the app. If you want a timeout to cause a panic and a system reset then this can be configured through :ref:`CONFIG_ESP_TASK_WDT_PANIC`.
+
+
 .. only:: SOC_XT_WDT_SUPPORTED
 
   XTAL32K Watchdog Timer (XTWDT)