From d7a1f95a6b28ad61219fefd7669df3660b10bcb6 Mon Sep 17 00:00:00 2001
From: ydah <t.yudai92@gmail.com>
Date: Wed, 5 Jun 2024 23:57:38 +0900
Subject: [PATCH] Add a way for memory profiling of Lrama to README.md

---
 README.md | 37 ++++++++++++++++++++++++++++++++++++-
 1 file changed, 36 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 5d87fdf4..35255ee1 100644
--- a/README.md
+++ b/README.md
@@ -128,7 +128,7 @@ $ bundle install
 $ bundle exec rake
 ```
 
-### Profiling Lrama
+### Call-stack Profiling Lrama
 
 #### 1. Create parse.tmp.y in ruby/ruby
 
@@ -166,6 +166,41 @@ $ exe/lrama -o parse.tmp.c --header=parse.tmp.h tmp/parse.tmp.y
 $ stackprof --d3-flamegraph tmp/stackprof-cpu-myapp.dump > tmp/flamegraph.html
 ```
 
+### Memory Profiling Lrama
+
+#### 1. Create parse.tmp.y in ruby/ruby
+
+```shell
+$ ruby tool/id2token.rb parse.y > parse.tmp.y
+$ cp parse.tmp.y dir/lrama/tmp
+```
+
+#### 2. Enable Profiler
+
+```diff
+diff --git a/exe/lrama b/exe/lrama
+index 1aece5d141..f5f94cf7fa 100755
+--- a/exe/lrama
++++ b/exe/lrama
+@@ -3,5 +3,9 @@
+
+ $LOAD_PATH << File.join(__dir__, "../lib")
+ require "lrama"
++require 'memory_profiler'
+
+-Lrama::Command.new.run(ARGV.dup)
++report = MemoryProfiler.report do
++  Lrama::Command.new.run(ARGV.dup)
++end
++report.pretty_print
+```
+
+#### 3. Run Lrama
+
+```shell
+$ exe/lrama -o parse.tmp.c --header=parse.tmp.h tmp/parse.tmp.y > report.txt
+```
+
 ### Build Ruby
 
 1. Install Lrama