summaryrefslogtreecommitdiff
path: root/yjit.rb
diff options
context:
space:
mode:
Diffstat (limited to 'yjit.rb')
-rw-r--r--yjit.rb7
1 files changed, 7 insertions, 0 deletions
diff --git a/yjit.rb b/yjit.rb
index 79511685d1..cbd2ea1e44 100644
--- a/yjit.rb
+++ b/yjit.rb
@@ -1,3 +1,10 @@
+# This module allows for introspection on YJIT, CRuby's experimental in-process
+# just-in-time compiler. This module is for development purposes only;
+# everything in this module is highly implementation specific and comes with no
+# API stability guarantee whatsoever.
+#
+# This module is only defined when YJIT has support for the particular platform
+# on which CRuby is built.
module YJIT
if defined?(Disasm)
def self.disasm(iseq, tty: $stdout && $stdout.tty?)