From 1830f589206f7752da25c2a1c56b0a118e619fc7 Mon Sep 17 00:00:00 2001 From: Peter Dragun Date: Thu, 4 Apr 2024 13:38:24 +0200 Subject: [PATCH] docs(tools/coredump): add warning about core dump usage with encrypted parttion Closes https://github.com/espressif/esp-coredump/issues/8 --- docs/en/api-guides/core_dump.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/en/api-guides/core_dump.rst b/docs/en/api-guides/core_dump.rst index e8867f5604..c544ab9827 100644 --- a/docs/en/api-guides/core_dump.rst +++ b/docs/en/api-guides/core_dump.rst @@ -77,7 +77,8 @@ The core dump partition is automatically declared when using the default partiti .. important:: - If :doc:`../security/flash-encryption` is enabled on the device, please add an ``encrypted`` flag to the core dump partition declaration. + If :doc:`../security/flash-encryption` is enabled on the device, please add an ``encrypted`` flag to the core dump partition declaration. Please note that the core dump cannot be read from encrypted partitions using ``idf.py coredump-info`` or ``idf.py coredump-debug`` commands. + It is recommended to read the core dump from ESP which will automatically decrypt the partition and send it for analysis, which can be done by running e.g. ``idf.py coredump-info -c ``. .. code-block:: none