Ekdohibs
/
ocaml
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

BOOTSTRAP.adoc: clarify some points (closes #9278).

master
Daniel Bünzli 2020-02-16 17:54:18 +01:00
parent edabf2008c
commit 083ceec87f
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
BOOTSTRAP.adoc
View File

@ -6,10 +6,10 @@ update the binaries in the link:boot/[] directory.
A bootstrap is required for example when something changes in the A bootstrap is required for example when something changes in the
runtime system (the magic number of bytecode executables, the format of runtime system (the magic number of bytecode executables, the format of
bytecode instructions, the set of available primitives) or when the bytecode instructions, the set of available primitives) or when the
format of .cmi files is modified. In particular, given that the .cmi format of OCaml compilation object files like .cmi files is modified. In
files contain information related to types, modifying the way a type is particular, given that the .cmi files contain information related to
represented will modify the format of .cmi files and thus require a types, modifying the way a type is represented will modify the format
bootstrap. of .cmi files and thus require a bootstrap.
Here is how to perform a change that requires a bootstrap: Here is how to perform a change that requires a bootstrap:
@ -56,3 +56,7 @@ This will rebuild runtime/ocamlrun, ocamlc, etc.
If you notice that this procedure fails for a given change you are If you notice that this procedure fails for a given change you are
trying to implement, please report it so that the procedure can be trying to implement, please report it so that the procedure can be
updated to also cope with your change. updated to also cope with your change.
If you want to upstream your changes, indicate in the message of the
commit that the changes need a bootstrap. Perform the bootstrap and
commit the result of the bootstrap separately, after that commit.