From 96545e8cd08c5d667d60f3118a651a0cb3b65eec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Hinderer?= Date: Tue, 29 May 2018 16:56:50 +0200 Subject: Document the bootstrap procedure * Remove the now obsolete comments at the beginning of the main Makefile * Move and fix documentation of the bootstrap from INSTALL to HACKING-bootstrap.adoc * Update install instructions --- HACKING.adoc | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) (limited to 'HACKING.adoc') diff --git a/HACKING.adoc b/HACKING.adoc index 368c592ce9..6dfff8c6e6 100644 --- a/HACKING.adoc +++ b/HACKING.adoc @@ -157,13 +157,14 @@ has excellent documentation. === Complete file listing + BOOTSTRAP.adoc:: instructions for bootstrapping Changes:: what's new with each release - configure:: configure script CONTRIBUTING.md:: how to contribute to OCaml HACKING.adoc:: this file INSTALL.adoc:: instructions for installation LICENSE:: license and copyright notice Makefile:: main Makefile + Makefile.common:: common Makefile definitions Makefile.tools:: used by manual/ and testsuite/ Makefiles README.adoc:: general information on the compiler distribution README.win32.adoc:: general information on the Windows ports of OCaml @@ -175,6 +176,7 @@ has excellent documentation. byterun/:: bytecode interpreter and runtime system compilerlibs/:: the OCaml compiler as a library config/:: configuration files + configure:: configure script debugger/:: source-level replay debugger driver/:: driver code for the compilers emacs/:: editing mode and debugger interface for GNU Emacs @@ -185,6 +187,7 @@ has excellent documentation. manual/:: system to generate the manual middle_end/:: the flambda optimisation phase ocamldoc/:: documentation generator + ocamltest/:: test driver otherlibs/:: several additional libraries parsing/:: syntax analysis -- see link:parsing/HACKING.adoc[] stdlib/:: standard library @@ -223,12 +226,12 @@ installation, the following targets may be of use: === Bootstrapping The OCaml compiler is bootstrapped. This means that -previously-compiled bytecode versions of the compiler, dependency -generator and lexer are included in the repository under the +previously-compiled bytecode versions of the compiler and lexer are +included in the repository under the link:boot/[] directory. These bytecode images are used once the bytecode runtime (which is written in C) has been built to compile the standard library and then to build a fresh compiler. Details can be -found in link:INSTALL.adoc#bootstrap[INSTALL.adoc]. +found in link:BOOTSTRAP.adoc[]. === Continuous integration -- cgit v1.2.1