From 1056a7da64a59e86f037c9edfb96a424e8a78110 Mon Sep 17 00:00:00 2001 From: Roland Dobai Date: Fri, 7 Jan 2022 11:54:53 +0100 Subject: [PATCH] Docs: Fix long lines in the coredump documentation --- docs/en/api-guides/core_dump.rst | 26 ++++++++++++++++++++++---- 1 file changed, 22 insertions(+), 4 deletions(-) diff --git a/docs/en/api-guides/core_dump.rst b/docs/en/api-guides/core_dump.rst index 4fe2c18d28..d3fda3abed 100644 --- a/docs/en/api-guides/core_dump.rst +++ b/docs/en/api-guides/core_dump.rst @@ -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. 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 info_corefile `` -or ``espcoredump.py -p dbg_corefile `` +The example of generic command to analyze core dump from flash is: + +.. code-block:: bash + + espcoredump.py -p info_corefile + +or + +.. code-block:: bash + + espcoredump.py -p dbg_corefile 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 -then run the following command: ``espcoredump.py --chip info_corefile -t b64 -c `` -or ``espcoredump.py --chip dbg_corefile -t b64 -c `` +then run the following command: + +.. code-block:: bash + + espcoredump.py --chip {IDF_TARGET_PATH_NAME} info_corefile -t b64 -c + +or + +.. code-block:: bash + + espcoredump.py --chip {IDF_TARGET_PATH_NAME} dbg_corefile -t b64 -c Base64-encoded body of core dump will be between the following header and footer::