Add a comment: the usage of MRB_DUMP_GENERAL_FAILURE.

mruby · Jan 9, 2013 · d5b8dc5 · d5b8dc5
1 parent 86b3200
commit d5b8dc5
Showing 1 changed file with 5 additions and 1 deletion.
diff --git 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