feedc0de/esp-idf
1
0
Fork 0
forked from espressif/esp-idf
Code Pull Requests Activity

Merge branch 'bugfix/docs_core_dump' into 'master'

Browse Source 
Docs: Fix long lines in the coredump documentation

See merge request espressif/esp-idf!16697
This commit is contained in:
morris
2022-01-08 06:34:27 +00:00
parent 7d43be9675 1056a7da64
commit 9f303290d8
1 changed files with 22 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -92,15 +92,33 @@ There are no special requirements for partition name. It can be chosen according
sub-type should be 'coredump'. Also when choosing partition size note that core dump data structure introduces constant overhead of 20 bytes and per-task overhead of 12 bytes. sub-type should be 'coredump'. Also when choosing partition size note that core dump data structure introduces constant overhead of 20 bytes and per-task overhead of 12 bytes.
This overhead does not include size of TCB and stack for every task. So partition size should be at least 20 + max tasks number x (12 + TCB size + max task stack size) bytes. This overhead does not include size of TCB and stack for every task. So partition size should be at least 20 + max tasks number x (12 + TCB size + max task stack size) bytes.
The example of generic command to analyze core dump from flash is: ``espcoredump.py -p </path/to/serial/port> info_corefile </path/to/program/elf/file>`` The example of generic command to analyze core dump from flash is:
or ``espcoredump.py -p </path/to/serial/port> dbg_corefile </path/to/program/elf/file>``
.. code-block:: bash
espcoredump.py -p </path/to/serial/port> info_corefile </path/to/program/elf/file>
or
.. code-block:: bash
espcoredump.py -p </path/to/serial/port> dbg_corefile </path/to/program/elf/file>
Print core dump to UART Print core dump to UART
----------------------- -----------------------
When this option is selected base64-encoded core dumps are printed on UART upon system panic. In this case user should save core dump text body to some file manually and When this option is selected base64-encoded core dumps are printed on UART upon system panic. In this case user should save core dump text body to some file manually and
then run the following command: ``espcoredump.py --chip <target_chip_type> info_corefile -t b64 -c </path/to/saved/base64/text> </path/to/program/elf/file>`` then run the following command:
or ``espcoredump.py --chip <target_chip_type> dbg_corefile -t b64 -c </path/to/saved/base64/text> </path/to/program/elf/file>``
.. code-block:: bash
espcoredump.py --chip {IDF_TARGET_PATH_NAME} info_corefile -t b64 -c </path/to/saved/base64/text> </path/to/program/elf/file>
or
.. code-block:: bash
espcoredump.py --chip {IDF_TARGET_PATH_NAME} dbg_corefile -t b64 -c </path/to/saved/base64/text> </path/to/program/elf/file>
Base64-encoded body of core dump will be between the following header and footer:: Base64-encoded body of core dump will be between the following header and footer::