From 2e62ccba45b10bcdf43c38b36f30f5cd86b3a4ca Mon Sep 17 00:00:00 2001 From: John Hawthorn Date: Fri, 21 May 2021 12:33:37 -0700 Subject: [PATCH 1/2] Recommend installing libcapstone --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 7b7139e3c89f93..a6424abcdc379c 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,8 @@ git clone https://github.com/Shopify/ruby.git yjit cd yjit ``` +To support disassembly, libcapstone is also required (`brew install capstone` on macos). + 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). ``` From cd6c5fa23500ad475474f467fb9d27c3111a5bf7 Mon Sep 17 00:00:00 2001 From: Maxime Chevalier-Boisvert Date: Fri, 21 May 2021 17:51:38 -0400 Subject: [PATCH 2/2] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a6424abcdc379c..d55ddca7473a54 100644 --- a/README.md +++ b/README.md @@ -37,10 +37,10 @@ git clone https://github.com/Shopify/ruby.git yjit cd yjit ``` -To support disassembly, libcapstone is also required (`brew install capstone` on macos). - 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). +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). + ``` ./autogen.sh ./configure cppflags=-DRUBY_DEBUG --prefix=$HOME/.rubies/ruby-yjit