diff options
| -rw-r--r-- | .rdoc_options | 1 | ||||
| -rw-r--r-- | yjit.rb | 10 |
2 files changed, 6 insertions, 5 deletions
diff --git a/.rdoc_options b/.rdoc_options index 76c1c8e0db..b8b511efe6 100644 --- a/.rdoc_options +++ b/.rdoc_options @@ -20,5 +20,6 @@ autolink_excluded_words: - Ruby - Set - ZJIT +- YJIT canonical_root: https://docs.ruby-lang.org/en/master @@ -1,14 +1,14 @@ # frozen_string_literal: true # :markup: markdown -# This module allows for introspection of \YJIT, CRuby's just-in-time compiler. +# This module allows for introspection of YJIT, CRuby's just-in-time compiler. # Everything in the module is highly implementation specific and the API might # be less stable compared to the standard library. # -# This module may not exist if \YJIT does not support the particular platform +# This module may not exist if YJIT does not support the particular platform # for which CRuby is built. module RubyVM::YJIT - # Check if \YJIT is enabled. + # Check if YJIT is enabled. def self.enabled? Primitive.cexpr! 'RBOOL(rb_yjit_enabled_p)' end @@ -33,8 +33,8 @@ module RubyVM::YJIT Primitive.rb_yjit_reset_stats_bang end - # Enable \YJIT compilation. `stats` option decides whether to enable \YJIT stats or not. `log` decides - # whether to enable \YJIT compilation logging or not. Optional `mem_size` and `call_threshold` can be + # Enable YJIT compilation. `stats` option decides whether to enable YJIT stats or not. `log` decides + # whether to enable YJIT compilation logging or not. Optional `mem_size` and `call_threshold` can be # provided to override default configuration. # # * `stats`: |