Skip to content

Commit

Permalink
Document the debug_printers script
Browse files Browse the repository at this point in the history
Thanks to Chris for explaining this to me!
  • Loading branch information
goldfirere authored and antalsz committed Dec 23, 2022
1 parent 98896e0 commit 83b7c72
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions HACKING.jst.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -54,3 +54,19 @@ where the test file or test dir are specified with respect to the
$ make -f Makefile.jst test-one TEST=typing-local/local.ml
$ make -f Makefile.jst test-one DIR=typing-local

## Debugging

OCaml 4.14 makes `type_expr` abstract, and thus normal debug printing
of types no longer works. However, there is now an installable printer
for types, which we can use to see the types. Here are the instructions:

1. Use the old `Makefile`, not the new `Makefile.jst`. This is an infelicity
we hope to fix.

2. In the `tools` directory, run `make debug_printers.cmo`.

3. In the debugger, execute some instructions, with e.g. `run` or `step`. This forces
the debugger to load the compiler code, required for the next
step.

4. Execute `source tools/debug_printers` to install the printers.

0 comments on commit 83b7c72

Please sign in to comment.