summaryrefslogtreecommitdiff
path: root/docs/reference
diff options
context:
space:
mode:
authorAndrew Leech <andrew@alelec.net>2020-06-01 16:16:25 +1000
committerDamien George <damien.p.george@gmail.com>2020-06-02 15:56:34 +1000
commite54626f4c1b5cb4de0b5dc86d820bb36c1d6499f (patch)
treeb798bffcfcba139f22f66ff1c72dab070b8e26ca /docs/reference
parent8e591d412a9922d71629f4fea74954d547f0c955 (diff)
docs/reference: Add note about multiple exceptions when heap is locked.
Diffstat (limited to 'docs/reference')
-rw-r--r--docs/reference/isr_rules.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/reference/isr_rules.rst b/docs/reference/isr_rules.rst
index 57690ac21..7f466ab42 100644
--- a/docs/reference/isr_rules.rst
+++ b/docs/reference/isr_rules.rst
@@ -43,6 +43,11 @@ for the purpose. Debugging is simplified if the following code is included in an
import micropython
micropython.alloc_emergency_exception_buf(100)
+The emergency exception buffer can only hold one exception stack trace. This means that if a second exception is
+thrown during the handling of an exception while the heap is locked, that second exception's stack trace will
+replace the original one - even if the second exception is cleanly handled. This can lead to confusing exception
+messages if the buffer is later printed.
+
Simplicity
~~~~~~~~~~