describe call stack overwritten problem of mrb_get_backtrace; close #1661

1 files changed, 7 insertions, 0 deletions

diff --git a/src/backtrace.c b/src/backtrace.c
index 8edc27776..a221d5e5c 100644
--- a/src/backtrace.c
+++ b/src/backtrace.c
@@ -129,6 +129,13 @@ mrb_output_backtrace(mrb_state *mrb, struct RObject *exc, output_stream_func fun
   }
 }
 
+/* mrb_print_backtrace/mrb_get_backtrace:
+
+   function to retrieve backtrace information from the exception.
+   note that if you call method after the exception, call stack will be
+   overwritten.  So invoke these functions just after detecting exceptions.
+*/   
+
 void
 mrb_print_backtrace(mrb_state *mrb)
 {