From d30878a572ffaebd945c3882cb6efe049d5603bd Mon Sep 17 00:00:00 2001 From: Gabriel Scherer Date: Fri, 15 Jul 2016 21:15:34 -0400 Subject: first draft of HACKING.adoc file [WIP] --- HACKING.adoc | 63 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.adoc | 49 ++++------------------------------------------ 2 files changed, 67 insertions(+), 45 deletions(-) create mode 100644 HACKING.adoc diff --git a/HACKING.adoc b/HACKING.adoc new file mode 100644 index 0000000000..deda1fab25 --- /dev/null +++ b/HACKING.adoc @@ -0,0 +1,63 @@ +This document is a work-in-progress attempt to provide useful +information for people willing to inspect or modify the compiler +distribution's codebase. Feel free to improve it by sending change +proposals for it. + +== Contents + + Changes:: what's new with each release + configure:: configure script + CONTRIBUTING.md:: how to contribute to OCaml + HACKING.adoc:: tips for people modifying the code + INSTALL.adoc:: instructions for installation + LICENSE:: license and copyright notice + Makefile:: main Makefile + Makefile.nt:: MS Windows Makefile + Makefile.shared:: common Makefile + Makefile.tools:: used by manual/ and testsuite/ Makefiles + README.adoc:: this file + README.win32.adoc:: info on the MS Windows ports of OCaml + VERSION:: version string + asmcomp/:: native-code compiler and linker + asmrun/:: native-code runtime library + boot/:: bootstrap compiler + bytecomp/:: bytecode compiler and linker + byterun/:: bytecode interpreter and runtime system + compilerlibs/:: the OCaml compiler as a library + config/:: autoconfiguration stuff + debugger/:: source-level replay debugger + driver/:: driver code for the compilers + emacs/:: editing mode and debugger interface for GNU Emacs + experimental/:: experiments not built by default + flexdll/:: empty (see README.win32.adoc) + lex/:: lexer generator + man/:: man pages + manual/:: system to generate the manual + middle_end/:: the flambda optimisation phase + ocamldoc/:: documentation generator + otherlibs/:: several external libraries + parsing/:: syntax analysis + stdlib/:: standard library + testsuite/:: tests + tools/:: various utilities + toplevel/:: interactive system + typing/:: typechecking + utils/:: utility libraries + yacc/:: parser generator + +== Useful Makefile targets + +Besides the targets listed in link:INSTALL.adoc for build and +installation, the following targets may be of use: + + make runtop:: builds and runs the ocaml toplevel of the distribution + (optionally uses `rlwrap` for readline+history support) + make natruntop:: builds and runs the native ocaml toplevel (experimental) + +== opam compiler script + +The separately-distributed script +https://github.com/gasche/opam-compiler-conf[`opam-compiler-conf`] can +be used to easily build opam switches out of a git branch of the +compiler distribution. This lets you easily install and test opam +packages from an under-modification compiler version. diff --git a/README.adoc b/README.adoc index 480b0250f7..c167f5af7b 100644 --- a/README.adoc +++ b/README.adoc @@ -43,47 +43,6 @@ OCaml is almost upwards compatible with Caml Special Light, except for a few additional reserved keywords that have forced some renaming of standard library functions. -== Contents - - Changes:: what's new with each release - configure:: configure script - CONTRIBUTING.md:: how to contribute to OCaml - INSTALL.adoc:: instructions for installation - LICENSE:: license and copyright notice - Makefile:: main Makefile - Makefile.nt:: MS Windows Makefile - Makefile.shared:: common Makefile - Makefile.tools:: used by manual/ and testsuite/ Makefiles - README.adoc:: this file - README.win32.adoc:: info on the MS Windows ports of OCaml - VERSION:: version string - asmcomp/:: native-code compiler and linker - asmrun/:: native-code runtime library - boot/:: bootstrap compiler - bytecomp/:: bytecode compiler and linker - byterun/:: bytecode interpreter and runtime system - compilerlibs/:: the OCaml compiler as a library - config/:: autoconfiguration stuff - debugger/:: source-level replay debugger - driver/:: driver code for the compilers - emacs/:: editing mode and debugger interface for GNU Emacs - experimental/:: experiments not built by default - flexdll/:: empty (see README.win32.adoc) - lex/:: lexer generator - man/:: man pages - manual/:: system to generate the manual - middle_end/:: the flambda optimisation phase - ocamldoc/:: documentation generator - otherlibs/:: several external libraries - parsing/:: syntax analysis - stdlib/:: standard library - testsuite/:: tests - tools/:: various utilities - toplevel/:: interactive system - typing/:: typechecking - utils/:: utility libraries - yacc/:: parser generator - == Copyright All files marked "Copyright INRIA" in this distribution are copyright 1996, @@ -94,9 +53,9 @@ the conditions stated in file LICENSE. == Installation -See the file link:INSTALL.adoc[] for installation instructions on machines running Unix, -Linux, OS X and Cygwin. For native Microsoft Windows, see -link:README.win32.adoc[]. +See the file link:INSTALL.adoc[] for installation instructions on +machines running Unix, Linux, OS X and Cygwin. For native Microsoft +Windows, see link:README.win32.adoc[]. == Documentation @@ -154,4 +113,4 @@ using (machine type, etc). You can also contact the implementors directly at mailto:caml@inria.fr[]. -For information on contributing to OCaml, see the file CONTRIBUTING.md. +For information on contributing to OCaml, see the file link:CONTRIBUTING.md[]. -- cgit v1.2.1