From ac6f0b71e63206562acfdb8cec8e8e0331cb1f79 Mon Sep 17 00:00:00 2001 From: Max Prokhorov Date: Sun, 29 Nov 2020 01:15:01 +0300 Subject: [PATCH] docs: mention exception decoder in the bug report --- .github/ISSUE_TEMPLATE/bug_report.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index f833756e..f389c88e 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -16,7 +16,7 @@ assignees: '' *Fulfilling this template will help developers and contributors to address the issue. Try to be as specific and extensive as possible. If the information provided is not enough the issue will likely be closed.* -*You can now remove this line and the above ones. Text in italic is meant to be replaced by your own words. If any of the sections below are not relevant to the issue (for instance, the screenshots) then you can delete them.* +*You can now remove this line and the above ones. Text in italic is meant to be replaced by your own words. If any of the sections below are not relevant to the issue (for instance, the screenshots or crash report) then you can delete them.* **Bug description** *A clear and concise description of what the bug is.* @@ -38,6 +38,25 @@ assignees: '' * *Flash mode* * *Device brand, model and version* +**Crash report** +*Save the crash postmortem message, which may look something like:* +> Exception (28): +> epc1=0x4021e698 epc2=0x00000000 epc3=0x00000000 excvaddr=0x00000000 depc=0x00000000 +> +> ctx: sys +> sp: 3ffffc90 end: 3fffffb0 offset: 01a0 +> \>\>\>stack\>\>\> +> ... +> \<\<\ + +*And, use one of the following tools to decode it:* +- *https://github.com/mcspr/EspArduinoExceptionDecoder* +- *https://github.com/me-no-dev/EspExceptionDecoder (when using Arduino IDE)* + +*When using PlatformIO, it is also possible to use a built-in exception decoder when device's serial connection is available:* +- `pio device monitor --echo -e $environment -f esp8266_exception_decoder` + **Tools used** * *Desktop operating system* * *Browser & version*