]> granicus.if.org Git - esp-idf/commitdiff
projects / esp-idf / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: b19afed)
docs: Makes core dump's documentation slightly clearer
authorAlexey Gerenkov <alexey@espressif.com>
Tue, 22 May 2018 13:45:07 +0000 (16:45 +0300)
committerAlexey Gerenkov <alexey@espressif.com>
Tue, 22 May 2018 17:24:29 +0000 (20:24 +0300)
Merges https://github.com/espressif/esp-idf/pull/1968

docs/en/api-guides/core_dump.rst patch | blob | history

diff --git a/docs/en/api-guides/core_dump.rst b/docs/en/api-guides/core_dump.rst
index 47cfd89c07ee38253f2c5417ee7b710bff6e22c6..84eec8297657998911baec493aeb064a74cbdb1f 100644 (file)
--- 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'
 ------------------------------------
 
Unnamed repository; edit this file 'description' to name the repository.