docs: Makes core dump's documentation slightly clearer

Merges https://github.com/espressif/esp-idf/pull/1968
2018-05-22 16:45:07 +03:00 · 2018-05-22 16:45:07 +03:00 · 3fd199c54a
parent b19afed31f
commit 3fd199c54a
1 changed files with 2 additions and 0 deletions
--- a/docs/en/api-guides/core_dump.rst
+++ b/docs/en/api-guides/core_dump.rst
@ -63,6 +63,8 @@ Base64-encoded body of core dump will be between the following header and footer
 <body of base64-encoded core dump, save it to file on disk>
 ================= CORE DUMP END ===================

+The `CORE DUMP START` and `CORE DUMP END` lines must not be included in core dump text file.
+
 Running 'espcoredump.py'
 ------------------------------------