From e5760b35a5c107654884dac31f7fad3ac1addf16 Mon Sep 17 00:00:00 2001 From: Peter Dragun Date: Thu, 4 Apr 2024 11:07:49 +0200 Subject: [PATCH] docs(tools/coredump): add information about standalone tool for advanced users Closes https://github.com/espressif/esp-idf/issues/13433 --- .gitlab/CODEOWNERS | 1 + docs/en/api-guides/core_dump.rst | 13 +++++++++++++ 2 files changed, 14 insertions(+) diff --git a/.gitlab/CODEOWNERS b/.gitlab/CODEOWNERS index 9ae29cd8f2..7c8a7dd05b 100644 --- a/.gitlab/CODEOWNERS +++ b/.gitlab/CODEOWNERS @@ -153,6 +153,7 @@ /docs/ @esp-idf-codeowners/docs /docs/**/api-guides/tools/ @esp-idf-codeowners/tools +/docs/en/api-guides/core_dump.rst @esp-idf-codeowners/debugging /docs/en/api-guides/jtag-debugging/ @esp-idf-codeowners/debugging /docs/**/api-reference/bluetooth/ @esp-idf-codeowners/bluetooth /docs/**/api-reference/network/ @esp-idf-codeowners/network @esp-idf-codeowners/wifi diff --git a/docs/en/api-guides/core_dump.rst b/docs/en/api-guides/core_dump.rst index d163a33f9c..e8867f5604 100644 --- a/docs/en/api-guides/core_dump.rst +++ b/docs/en/api-guides/core_dump.rst @@ -98,6 +98,11 @@ or idf.py coredump-debug +.. note:: + + The ``idf.py coredump-info`` and ``idf.py coredump-debug`` commands are wrappers around the `esp-coredump` tool for easier use in the ESP-IDF environment. For more information see :ref:`core_dump_commands` section. + + Core Dump to UART ----------------- @@ -184,6 +189,8 @@ or idf.py coredump-debug -c +.. _core_dump_commands: + Core Dump Commands ------------------ @@ -192,6 +199,12 @@ ESP-IDF provides special commands to help to retrieve and analyze core dumps: * ``idf.py coredump-info`` - prints crashed task's registers, call stack, list of available tasks in the system, memory regions, and contents of memory stored in core dump (TCBs and stacks). * ``idf.py coredump-debug`` - creates core dump ELF file and runs GDB debug session with this file. You can examine memory, variables, and task states manually. Note that since not all memory is saved in the core dump, only the values of variables allocated on the stack are meaningful. +For advanced users who want to pass additional arguments or use custom ELF files, it is possible to use the `esp-coredump `_ tool directly. For more information, use in ESP-IDF environment: + +.. code-block:: bash + + esp-coredump --help + ROM Functions in Backtraces ---------------------------