[前][次][番号順一覧][スレッド一覧]

ruby-changes:69213

From: Maxime <ko1@a...>
Date: Thu, 21 Oct 2021 08:20:24 +0900 (JST)
Subject: [ruby-changes:69213] ad601cef8a (master): Update README.md

https://git.ruby-lang.org/ruby.git/commit/?id=ad601cef8a

From ad601cef8af4bc93a53c8437be4fe8749191f621 Mon Sep 17 00:00:00 2001
From: Maxime Chevalier-Boisvert <maximechevalierb@g...>
Date: Wed, 5 May 2021 16:36:36 -0400
Subject: Update README.md

Add section documenting command-line arguments
---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/README.md b/README.md
index 0dc76bec4f..fcadb3edc6 100644
--- a/README.md
+++ b/README.md
@@ -57,6 +57,8 @@ make -j16 test-all https://github.com/ruby/ruby/blob/trunk/README.md#L57
 
 ## Usage
 
+### Examples
+
 Once YJIT is built, you can either use `./miniruby` from within your build directory, or switch to the YJIT version of `ruby`
 by using the `chruby` tool:
 
@@ -73,6 +75,17 @@ You can dump statistics about compilation and execution by running YJIT with the https://github.com/ruby/ruby/blob/trunk/README.md#L75
 
 The machine code generated for a given method can be printed by adding `puts YJIT.disasm(method(:method_name))` to a Ruby script. Note that no code will be generated if the method is not compiled.
 
+
+### Options
+
+YJIT supports all command-line options supported by upstream CRuby, but also adds a few YJIT-specific options:
+
+ - `--disable-yjit`: turn off YJIT (enabled by default)
+ - `--yjit-stats`: produce statistics after the execution of a program (must compile with `cppflags=-DRUBY_DEBUG` to use this)
+ - `--yjit-call-threshold=N`: number of calls after which YJIT begins to compile a function (default 2)
+ - `--yjit-version-limit=N`: maximum number of versions to generate per basic block (default 4)
+ - `--yjit-greedy-versioning`: greedy versioning mode (disabled by default, may increase code size)
+
 ## Benchmarking
 
 We have collected a set of benchmarks and implemented a simple benchmarking harness in the [yjit-bench](https://github.com/Shopify/yjit-bench) repository. This benchmarking harness is designed to disable CPU frequency scaling, set process affinity and disable address space randomization so that the variance between benchmarking runs will be as small as possible. Please kindly note that we are at an early stage in this project.
-- 
cgit v1.2.1


--
ML: ruby-changes@q...
Info: http://www.atdot.net/~ko1/quickml/

[前][次][番号順一覧][スレッド一覧]