From 88175d1779ed5475b3c4ec483670c8b15ae79a2f Mon Sep 17 00:00:00 2001
From: naruse <naruse@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
Date: Wed, 4 Nov 2009 13:42:03 +0000
Subject: Add rdoc about objects can't Marshal#dump.  [ruby-core:23314]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@25650 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
---
 marshal.c | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'marshal.c')

diff --git a/marshal.c b/marshal.c
index ed59bfb639..f4558cac8f 100644
--- a/marshal.c
+++ b/marshal.c
@@ -890,6 +890,12 @@ clear_dump_arg(struct dump_arg *arg)
  *     data = Marshal.dump(o)
  *     obj = Marshal.load(data)
  *     obj.sayHello   #=> "hello\n"
+ *
+ * Marshal can't dump following objects:
+ * * anonymous Class/Module.
+ * * objects which related to its system (ex: Dir, File::Stat, IO, File, Socket and so on)
+ * * an instance of MatchData, Data, Method, UnboundMethod, Proc, Thread, ThreadGroup, Continuation
+ * * objects which defines singleton methods
  */
 static VALUE
 marshal_dump(int argc, VALUE *argv)
-- 
cgit v1.2.3