Skip to content

Commit

Permalink
docs: update link for ESP ROM ELF releases
Browse files Browse the repository at this point in the history
  • Loading branch information
Lapshin committed Sep 1, 2022
1 parent 779d880 commit 8abef17
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 4 deletions.
1 change: 0 additions & 1 deletion docs/conf_common.py
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,6 @@


linkcheck_ignore = ['https://webhome.phy.duke.edu/~rgb/General/dieharder.php', # Certificate error
'https://dl.espressif.com/dl/esp32s3_rom.elf', # Not published
'https://docs.espressif.com/projects/esptool/en/latest/esp32c2/espefuse/index.html', # Not published
]

Expand Down
4 changes: 1 addition & 3 deletions docs/en/api-guides/core_dump.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
Core Dump
=========

{IDF_TARGET_ROM_ELF:default="(File for this target is not published yet)", esp32="https://dl.espressif.com/dl/esp32_rom.elf", esp32s2="https://dl.espressif.com/dl/esp32s2_rom.elf", esp32s3="https://dl.espressif.com/dl/esp32s3_rom.elf", esp32c3="https://dl.espressif.com/dl/esp32c3_rev3_rom.elf"}

Overview
--------

Expand Down Expand Up @@ -134,7 +132,7 @@ ROM Functions in Backtraces
It is possible situation that at the moment of crash some tasks or/and crashed task itself have one or more ROM functions in their callstacks.
Since ROM is not part of the program ELF it will be impossible for GDB to parse such callstacks, because it tries to analyse functions' prologues to accomplish that.
In that case callstack printing will be broken with error message at the first ROM function.
To overcome this issue you can use ROM ELF provided by Espressif ({IDF_TARGET_ROM_ELF}) and pass it to ``espcoredump.py``.
To overcome this issue, you can use the `ROM ELF <https://github.com/espressif/esp-rom-elfs/releases>`_ provided by Espressif. You can find the {IDF_TARGET_PATH_NAME}'s corresponding ROM ELF file from the list of released archives. The ROM ELF file can then be passed to ``espcoredump.py``. More details about ROM ELFs can be found `here <https://github.com/espressif/esp-rom-elfs/blob/master/README.md>`_.

Dumping variables on demand
---------------------------
Expand Down

0 comments on commit 8abef17

Please sign in to comment.