From eef8beb695477bdadbf25a87adf973143c366156 Mon Sep 17 00:00:00 2001 From: ko1 Date: Wed, 9 Dec 2015 02:41:14 +0000 Subject: add documentation for RubyVM::InstructionSequence#to_binary_format and RubyVM::InstructionSequence.from_binary_format git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@52990 b2dd03c8-39d4-4d8f-98ff-823fe69b080e --- iseq.c | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'iseq.c') diff --git a/iseq.c b/iseq.c index 6376934b4e..e6f4fdd8d5 100644 --- a/iseq.c +++ b/iseq.c @@ -2343,6 +2343,11 @@ rb_iseqw_local_variables(VALUE iseqval) * String extra_data will be saved with binary data. * You can access this data with * RubyVM::InstructionSequence.from_binary_format_extra_data(binary). + * + * Note that the translated binary data is not portable. + * You can not move this binary data to another machine. + * You can not use the binary data whcih is created by another + * version/another architecture of Ruby. */ static VALUE iseqw_to_binary_format(int argc, VALUE *argv, VALUE self) @@ -2358,6 +2363,12 @@ iseqw_to_binary_format(int argc, VALUE *argv, VALUE self) * * Load an iseq object from binary format String object * created by RubyVM::InstructionSequence.to_binary_format. + * + * This loader does not have a verifier, so that loading broken/modified + * binary causes critical problem. + * + * You should not load binary data provided by others. + * You should use binary data translated by yourself. */ static VALUE iseqw_s_from_binary_format(VALUE self, VALUE str) -- cgit v1.2.3