Put a documentation about MJIT [ci skip]

1 files changed, 16 insertions, 0 deletions

diff --git a/doc/mjit/mjit.md b/doc/mjit/mjit.md
new file mode 100644
index 0000000000..4d345a95ae
--- /dev/null
+++ b/doc/mjit/mjit.md
@@ -0,0 +1,16 @@
+# MJIT
+
+Here are some tips that might be useful when you work on MJIT:
+
+## Always run make install
+
+Always run `make install` before running MJIT. It could easily cause a SEGV if you don't.
+MJIT looks for the installed header for security reasons.
+
+## --mjit-debug vs --mjit-debug=-ggdb3
+
+`--mjit-debug=[flags]` allows you to specify arbitrary flags while keeping other compiler flags like `-O3`,
+which is useful for profiling benchmarks.
+
+`--mjit-debug` alone, on the other hand, disables `-O3` and adds debug flags.
+If you're debugging MJIT, what you need to use is not `--mjit-debug=-ggdb3` but `--mjit-debug`.