Skip to content

Add HACKING.md #13

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.

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 2 commits into from
May 17, 2021
Merged
Changes from 1 commit
Commits
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
Next Next commit
Add HACKING.md
  • Loading branch information
gretay-js committed Apr 26, 2021
commit fd169bbae2e593e08cba428c83d50c44c047a3f8
15 changes: 15 additions & 0 deletions HACKING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Hacking on Flambda backend project for OCaml

This page is intended to keep track of useful information for people who
want to modify Flambda backend.

## Bootstrapping

- Bootstrapping: use the same process as the upstream compiler. In
`ocaml` subdirectory, follow the instructions in
[ocaml/BOOTSTRAP.adoc](ocaml/BOOSTRAP.adoc).

- Changes in `ocaml/asmcomp` and `ocaml/middle_end` directories should
also be applied to the corresponding directories `backend` and
`middle_end`.