alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

docs(tools/coredump): add information about standalone tool for advanced users

Browse Source 
Closes https://github.com/espressif/esp-idf/issues/13433
This commit is contained in:
Peter Dragun 2024-04-04 11:07:49 +02:00
parent 295f908ef2
commit e5760b35a5
2 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitlab/CODEOWNERS
View File

@ -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

13
docs/en/api-guides/core_dump.rst
View File

@ -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 </path/to/saved/base64/text>
.. _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 <https://github.com/espressif/esp-coredump>`_ tool directly. For more information, use in ESP-IDF environment:
.. code-block:: bash
esp-coredump --help
ROM Functions in Backtraces
---------------------------