summaryrefslogtreecommitdiff
path: root/iseq.c
diff options
context:
space:
mode:
authorBenoit Daloze <eregontp@gmail.com>2019-08-19 13:51:00 +0800
committerTakashi Kokubun <takashikkbn@gmail.com>2019-08-19 14:51:00 +0900
commit39a43d9cd09f8c880d0a70d9cb8ede6d7e6ef583 (patch)
tree42cd014a8d4b57ba791255bbdd678828942646cf /iseq.c
parentd76be10df11cf24d7a5a1f88a4aadc6d817db4a7 (diff)
Make it as clear as possible that RubyVM is MRI-specific and only exists on MRI (#2113) [ci skip]
* Make it clear as possible that RubyVM is MRI-specific and only exists on MRI * See [Bug #15743]. * Use "CRuby VM" instead of "Ruby VM" for clarity. * Use YARV rather than "CRuby VM" for documenting RubyVM::InstructionSequence * Avoid introducing a new "CRuby VM" term in documentation
Diffstat (limited to 'iseq.c')
-rw-r--r--iseq.c6
1 files changed, 4 insertions, 2 deletions
diff --git a/iseq.c b/iseq.c
index 7f1e2203cb..5c63922b0d 100644
--- a/iseq.c
+++ b/iseq.c
@@ -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
@@ -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