summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMaxime Chevalier-Boisvert <maxime.chevalierboisvert@shopify.com>2022-11-28 16:45:42 -0500
committerGitHub <noreply@github.com>2022-11-28 16:45:42 -0500
commit8a74361b41810b5fda74c573810fa1712c4a7841 (patch)
treecfce72c2c463f275ed99590654cb55ee7281088c /doc
parent612b528c8a5376a46e185bc812b2b86799b87ade (diff)
downloadruby-8a74361b41810b5fda74c573810fa1712c4a7841.tar.gz
Update yjit.md to mention `RUBY_YJIT_ENABLE`
Diffstat (limited to 'doc')
-rw-r--r--doc/yjit/yjit.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/yjit/yjit.md b/doc/yjit/yjit.md
index f4c1b312c2..20eda4fb4d 100644
--- a/doc/yjit/yjit.md
+++ b/doc/yjit/yjit.md
@@ -153,6 +153,9 @@ YJIT supports all command-line options supported by upstream CRuby, but also add
- `--yjit-max-versions=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)
+Note that there is also an environment variable `RUBY_YJIT_ENABLE` which can be used to enable YJIT.
+This can be useful for some deployment scripts where specifying an extra command-line option to Ruby is not practical.
+
### 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.