Skip to content

Minor fix README.md #219

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
udesou merged 3 commits into from
Jan 18, 2025
Merged

Minor fix README.md #219

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4f0406f
Minor fix README.md
udesou Jan 17, 2025
9efc098
Update README.md
udesou Jan 17, 2025
f7b063b
Build the binding when Building Julia
udesou Jan 17, 2025
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
7 changes: 2 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,17 +33,14 @@ The directory structure should look like the diagram below:
```
Your working directory/
├─ mmtk-julia/
│ ├─ julia/
│ └─ mmtk/
├─ julia/ (should be cloned manually)
└─ mmtk-core/ (optional)
```

#### Build Julia binding in Rust

Before building Julia, build the binding in `mmtk-julia`. Set `MMTK_JULIA_DIR` to the absolute path containing the binding's top-level directory and build the binding by running `make release` or `make debug` from that directory.

We currently only support a (non-moving) Immix implementation. We hope to add support for non-moving StickyImmix and the respective moving versions of both collectors in the near future. We also only support x86_64 Linux, more architectures should also be supported in the near future.
Before building Julia, set `MMTK_JULIA_DIR` to the absolute path containing the binding's top-level directory. Run `make -C $MMTK_JULIA_DIR clean` to make sure you have a fresh version of the binding, and to force it to be built when building Julia. We currently only support a (non-moving) Immix implementation. We hope to add support for non-moving StickyImmix and the respective moving versions of both collectors in the near future. We also only support x86_64 Linux, more architectures should also be supported in the near future.
For a release build with debugging information, first add `debug = true` under `[profile.release]` in `mmtk/Cargo.toml`.
Make sure you have the prerequisites for building [MMTk](https://github.com/mmtk/mmtk-core#requirements).

Expand All @@ -67,7 +64,7 @@ export MMTK_JULIA_DIR := <path-to-mmtk-julia>
export MMTK_PLAN := Immix
```

If you have done a debug build of the binding, make sure to also set `MMTK_BUILD=debug` before building Julia.
If you would like to do a debug build of the binding, make sure to also set `MMTK_BUILD=debug` before building Julia.

### Rust FFI bindings from Julia

Expand Down
Loading