diff options
| author | Maxime Chevalier-Boisvert <maxime.chevalierboisvert@shopify.com> | 2021-08-24 16:11:43 -0400 |
|---|---|---|
| committer | Alan Wu <XrXr@users.noreply.github.com> | 2021-10-20 18:19:39 -0400 |
| commit | 7f2828d1c86c5508a49260bcecbfc2e78c00e49f (patch) | |
| tree | bd0678f9c74de543d067ba7eeba188c65b23efd0 /README.md | |
| parent | 0dc3bba6f2b2b1b23e1ec9dd2ec29f932c292db0 (diff) | |
| download | ruby-7f2828d1c86c5508a49260bcecbfc2e78c00e49f.tar.gz | |
Update README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 6 |
1 files changed, 3 insertions, 3 deletions
@@ -46,13 +46,13 @@ git clone https://github.com/Shopify/yjit cd yjit ``` -The YJIT `ruby` binary can be built with either GCC or Clang. We recommend enabling debug symbols so that assertions are enabled during development as this makes debugging easier. Enabling debug mode will also make it possible for you to disassemble code generated by YJIT, and get access to stat counters. More detailed build instructions are provided in the [Ruby README](https://github.com/ruby/ruby#how-to-compile-and-install). - +The YJIT `ruby` binary can be built with either GCC or Clang. For development, we recommend enabling debug symbols so that assertions are enabled as this makes debugging easier. Enabling debug mode will also make it possible for you to disassemble code generated by YJIT. However, this causes a performance hit. For maximum performance, compile with GCC, without the `DRUBY_DEBUG` or `YJIT_STATS` build options. More detailed build instructions are provided in the [Ruby README](https://github.com/ruby/ruby#how-to-compile-and-install. To support disassembly of the generated code, `libcapstone` is also required (`brew install capstone` on MacOS, `sudo apt-get install -y libcapstone-dev` on Ubuntu/Debian). ``` +# Configure with debugging/stats options for development, build and install ./autogen.sh -./configure cppflags=-DRUBY_DEBUG --prefix=$HOME/.rubies/ruby-yjit +./configure cppflags="-DRUBY_DEBUG -DYJIT_STATS" --prefix=$HOME/.rubies/ruby-yjit make -j16 install ``` |