Skip to content

Improve configure docs #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 5, 2024
Merged

Improve configure docs #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down