From d5b8dc54a69a90b5f0e304fefcd0d62ca10ec64a Mon Sep 17 00:00:00 2001
From: Masaki Muranaka <monaka@monami-ya.jp>
Date: Wed, 9 Jan 2013 13:33:51 +0900
Subject: Add a comment: the usage of MRB_DUMP_GENERAL_FAILURE.

---
 include/mruby/dump.h | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

(limited to 'include')

diff --git a/include/mruby/dump.h b/include/mruby/dump.h
index 1af24ab64..650651a7e 100644
--- a/include/mruby/dump.h
+++ b/include/mruby/dump.h
@@ -28,7 +28,11 @@ int mrb_bdump_irep(mrb_state *mrb, int n, FILE *f,const char *initname);
 #define DUMP_TYPE_BIN  1
 #define DUMP_TYPE_HEX  2
 
-/* dump/load error code */
+/* dump/load error code
+ *
+ * NOTE: MRB_DUMP_GENERAL_FAILURE is caused by
+ * unspecified issues like malloc failed.
+ */
 #define MRB_DUMP_OK                     0
 #define MRB_DUMP_GENERAL_FAILURE        -1
 #define MRB_DUMP_WRITE_FAULT            -2
-- 
cgit v1.2.3