Skip to content

Commit

Permalink
Add missing mention of menhir in build instructions (ocaml-flambda#2435)
Browse files Browse the repository at this point in the history
  • Loading branch information
OlivierNicole authored and samsa1 committed Apr 19, 2024
1 parent db113f3 commit 70fd066
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions HACKING.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,11 +93,12 @@ Depending on the initial changes, it might be necessary to do this multiple time

To rebuild after making changes, you can just type `make`. You need to
have a working OCaml 4.14 or 4.14.1 compiler on your PATH before doing so,
e.g. installed via OPAM.
e.g. installed via OPAM. You also need to have dune and menhir.

<!-- CR someone: investigate this -->
The build currently fails when using the latest version of `dune` (3.11.1).
To install a known-good dune, run `opam pin add dune 3.8.1`.
To install a known-good dune, run `opam pin add dune 3.8.1`. `menhir` should be pinned to a specific
version as well: `opam pin add menhir 20210419`.

There is a special target `make hacking` which starts Dune in polling mode. The rebuild
performed here is equivalent to `make ocamlopt` in the upstream distribution: it rebuilds the
Expand Down Expand Up @@ -362,7 +363,8 @@ thoroughly (e.g. `git clean -dfX`) before reconfiguring with a different prefix.

Then build the compiler with the command `make _install` (this is the default
target plus some setup in preparation for installation). As usual when building,
a 4.14 compiler (and dune) need to be in the path.
a 4.14 compiler (and dune and menhir) need to be in the path. See the warnings above
about the versions of dune and menhir to use.

Now the build part is done, we don't need to stay in the build environment
anymore; the switch creation will likely replace it if your terminal is setup
Expand Down

0 comments on commit 70fd066

Please sign in to comment.