archive/ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2025-08-15 13:39:04 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

[DOC] Update JIT options

Browse source
This commit is contained in:
Burdette Lamar 2025-08-11 08:25:07 -05:00 • committed by GitHub
parent ad14632095
commit e0b72ad2f1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 5 additions and 41 deletions
Download patch file Download diff file Expand all files Collapse all files

46
doc/ruby/options.md
View file

@ -672,6 +672,11 @@ $ ruby --internal-encoding=cesu-8 -e 'puts Encoding::default_internal'
CESU-8
```
### `--jit`
Option `--jit` is an alias for option `--yjit`, which enables YJIT;
see additional YJIT options in the [YJIT documentation](rdoc-ref:yjit/yjit.md).
### `--verbose`: Set `$VERBOSE`
Option `--verbose` sets global variable `$VERBOSE` to `true`
@ -681,44 +686,3 @@ and disables input from `$stdin`.
Option `--version` prints the version of the Ruby interpreter, then exits.
## Experimental Options
These options are experimental in the current Ruby release,
and may be modified or withdrawn in later releases.
### `--jit`
Option `-jit` enables JIT compilation with the default option.
#### `--jit-debug`
Option `--jit-debug` enables JIT debugging (very slow);
adds compiler flags if given.
#### `--jit-max-cache=num`
Option `--jit-max-cache=num` sets the maximum number of methods
to be JIT-ed in a cache; default: 100).
#### `--jit-min-calls=num`
Option `jit-min-calls=num` sets the minimum number of calls to trigger JIT
(for testing); default: 10000).
#### `--jit-save-temps`
Option `--jit-save-temps` saves JIT temporary files in $TMP or /tmp (for testing).
#### `--jit-verbose`
Option `--jit-verbose` prints JIT logs of level `num` or less
to `$stderr`; default: 0.
#### `--jit-wait`
Option `--jit-wait` waits until JIT compilation finishes every time (for testing).
#### `--jit-warnings`
Option `--jit-warnings` enables printing of JIT warnings.