Skip to content

Make it as clear as possible that RubyVM is MRI-specific and only exists on MRI #2113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
k0kubun merged 4 commits into from
Aug 19, 2019
Merged

Make it as clear as possible that RubyVM is MRI-specific and only exists on MRI #2113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b5e6a1d
Make it clear as possible that RubyVM is MRI-specific and only exists…
eregon Apr 7, 2019
a7111cb
Use YARV rather than "CRuby VM" for documenting RubyVM::InstructionSe…
eregon Apr 7, 2019
bacf54d
Avoid introducing a new "CRuby VM" term in documentation
eregon Apr 7, 2019
ab7b8c0
Merge branch 'master' into clarify-doc-rubyvm
k0kubun Aug 19, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions ast.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -776,11 +776,16 @@ Init_ast(void)
* AbstractSyntaxTree provides methods to parse Ruby code into
* abstract syntax trees. The nodes in the tree
* are instances of RubyVM::AbstractSyntaxTree::Node.
*
* This class is MRI specific as it exposes implementation details
* of the MRI abstract syntax tree.
*/
rb_mAST = rb_define_module_under(rb_cRubyVM, "AbstractSyntaxTree");
/*
* RubyVM::AbstractSyntaxTree::Node instances are created by parse methods in
* RubyVM::AbstractSyntaxTree.
*
* This class is MRI specific.
*/
rb_cNode = rb_define_class_under(rb_mAST, "Node", rb_cObject);

Expand Down
2 changes: 1 addition & 1 deletion eval.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ extern ID ruby_static_id_cause;
(BUILTIN_TYPE(obj) == T_CLASS || BUILTIN_TYPE(obj) == T_MODULE))

/*!
* Initializes the Ruby VM and builtin libraries.
* Initializes the VM and builtin libraries.
Copy link
Copy Markdown
Member Author

@eregon eregon Apr 7, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I dropped Ruby because it's clear from the function name, and just VM is used in other cases as well such as ruby_finalize and ruby_cleanup.

* @retval 0 if succeeded.
* @retval non-zero an error occurred.
*/
Expand Down
6 changes: 4 additions & 2 deletions iseq.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3456,14 +3456,14 @@ succ_index_lookup(const struct succ_index_table *sd, int x)
* Document-class: RubyVM::InstructionSequence
*
* The InstructionSequence class represents a compiled sequence of
* instructions for the Ruby Virtual Machine. Not all implementations of Ruby
* instructions for the Virtual Machine used in MRI. Not all implementations of Ruby
* may implement this class, and for the implementations that implement it,
* the methods defined and behavior of the methods can change in any version.
*
* With it, you can get a handle to the instructions that make up a method or
* a proc, compile strings of Ruby code down to VM instructions, and
* disassemble instruction sequences to strings for easy inspection. It is
* mostly useful if you want to learn how the Ruby VM works, but it also lets
* mostly useful if you want to learn how YARV works, but it also lets
* you control various settings for the Ruby iseq compiler.
*
* You can find the source for the VM instructions in +insns.def+ in the Ruby
Expand All @@ -3472,6 +3472,8 @@ succ_index_lookup(const struct succ_index_table *sd, int x)
* The instruction sequence results will almost certainly change as Ruby
* changes, so example output in this documentation may be different from what
* you see.
*
* Of course, this class is MRI specific.
*/

void
Expand Down
23 changes: 18 additions & 5 deletions vm.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2913,9 +2913,13 @@ Init_VM(void)
/*
* Document-class: RubyVM
*
* The RubyVM module provides some access to Ruby internals.
* The RubyVM module only exists on MRI. +RubyVM+ is not defined in
* other Ruby implementations such as JRuby and TruffleRuby.
*
* The RubyVM module provides some access to MRI internals.
* This module is for very limited purposes, such as debugging,
* prototyping, and research. Normal users must not use it.
* This module is not portable between Ruby implementations.
*/
rb_cRubyVM = rb_define_class("RubyVM", rb_cObject);
rb_undef_alloc_func(rb_cRubyVM);
Expand Down Expand Up @@ -2945,7 +2949,10 @@ Init_VM(void)
rb_gc_register_mark_object(fcore);
rb_mRubyVMFrozenCore = fcore;

/* RubyVM::MJIT */
/* ::RubyVM::MJIT
* Provides access to the Method JIT compiler of MRI.
* Of course, this module is MRI specific.
*/
mjit = rb_define_module_under(rb_cRubyVM, "MJIT");
rb_define_singleton_method(mjit, "enabled?", mjit_enabled_p, 0);
rb_define_singleton_method(mjit, "pause", mjit_pause_m, -1);
Expand Down Expand Up @@ -3134,7 +3141,10 @@ Init_VM(void)
rb_define_singleton_method(rb_cRubyVM, "USAGE_ANALYSIS_REGISTER_CLEAR", usage_analysis_register_clear, 0);
#endif

/* ::RubyVM::OPTS, which shows vm build options */
/* ::RubyVM::OPTS
* An Array of VM build options.
* This constant is MRI specific.
*/
rb_define_const(rb_cRubyVM, "OPTS", opts = rb_ary_new());

#if OPT_DIRECT_THREADED_CODE
Expand All @@ -3161,11 +3171,14 @@ Init_VM(void)
rb_ary_push(opts, rb_str_new2("block inlining"));
#endif

/* ::RubyVM::INSTRUCTION_NAMES */
/* ::RubyVM::INSTRUCTION_NAMES
* A list of bytecode instruction names in MRI.
* This constant is MRI specific.
*/
rb_define_const(rb_cRubyVM, "INSTRUCTION_NAMES", rb_insns_name_array());

/* ::RubyVM::DEFAULT_PARAMS
* This constant variable shows VM's default parameters.
* This constant exposes the VM's default parameters.
* Note that changing these values does not affect VM execution.
* Specification is not stable and you should not depend on this value.
* Of course, this constant is MRI specific.
Expand Down