1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add documentation for RubyVM::InstructionSequence#to_binary_format and RubyVM::InstructionSequence.from_binary_format

Browse Source 
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@52990 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
ko1 2015-12-09 02:41:14 +00:00
parent a422462a18
commit eef8beb695
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
iseq.c
View File

@ -2343,6 +2343,11 @@ rb_iseqw_local_variables(VALUE iseqval)
* String extra_data will be saved with binary data. * String extra_data will be saved with binary data.
* You can access this data with * You can access this data with
* RubyVM::InstructionSequence.from_binary_format_extra_data(binary). * 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 static VALUE
iseqw_to_binary_format(int argc, VALUE *argv, VALUE self) 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 * Load an iseq object from binary format String object
* created by RubyVM::InstructionSequence.to_binary_format. * 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 static VALUE
iseqw_s_from_binary_format(VALUE self, VALUE str) iseqw_s_from_binary_format(VALUE self, VALUE str)