From 0a454bba2ca55fb45cac7b7a5e76876a4c3d1f35 Mon Sep 17 00:00:00 2001 From: eileencodes Date: Mon, 2 Dec 2024 12:17:37 -0500 Subject: [PATCH] Improve configure docs If you pass in the full path including the shared object filename, you'll get a dlopen error on mac. So this updates the docs to make it clear that `--with-shared-gc` must be just a path and not include the filename. --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 12ec6ae..3410c04 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,13 @@ This command will: - **Compiling the MMTk shared library**: Builds `librubygc.mmtk.so` using Rust's Cargo build system. - **Install the shared library**: Copies `librubygc.mmtk.so` into the `mod_gc` directory. -Once it's done, you'll have a shared object `mod_gc/librubygc.mmtk.so` (`modgc/librubygc.mmtk.bundle` on macOS), that can be loaded into any Ruby interpeter built `--with-shared-gc` support. +Once it's done, you'll have a shared object `mod_gc/librubygc.mmtk.so` (`modgc/librubygc.mmtk.bundle` on macOS), that can be loaded into any Ruby interpeter built `--with-shared-gc` support using the path. + +Example: + +``` +./configure --with-shared-gc=$HOME/mmtk/mod_gc +``` Successful builds, when loaded, will display `+GC[mmtk]` in the Ruby version string. This indicates that Ruby has been compiled with shared GC support and that MMTk is loaded.