Commits

camlspotter committed 92b860c

doc update

Comments (0)

Files changed (1)

 
 Many existing OCaml libraries, applications and the compiler itself do not produce or install the annotation files (.annot, .cmt, .cmti, .spot, .spit) which are essential for sub-expression type queries (caml-types.el), definition seaches and code refactoring (TypeRex and OCamlSpotter). If you want to use these development tools, you have to:
 
-* Rebuild all the software from their source, adding -annot and -bin-annot options to compiler flags in build scripts i.e. Makefile/OCamlBuild/OMakefile.
+* Rebuild all the software from their source, adding ``-bin-annot`` options to compiler flags in build scripts i.e. Makefile/OCamlBuild/OMakefile.
 * Install those annotation files together with the library objects and signatures. (Require modification of the build scripts)
 
 for all the programs. In addition,
 
-* OCaml compiler's standard libraries are also need to be compiled with -annot and -bin-annot optinons, so that they can be browsed.
+* OCaml compiler's standard libraries are also need to be compiled with ``-bin-annot`` optinons, so that they can be browsed.
 
 I propose a workaround, consists of two things:
 
-* A very small compiler patch which activates -annot and -bin-annot if OCAML_ANNOT environment variable is defined. (You no longer need to add -annot/-bin-annot to the build scripts.)
+* A very small compiler patch which activates ``-annot`` and ``-bin-annot`` if ``OCAML_ANNOT`` environment variable is defined. (You no longer need to add ``-bin-annot`` to the build scripts.)
 * A small tool to install annotation files to the library destination directory. (You no longer need to add annotation file installation to the build scripts.)
 
-You STILL need to recompile the compiler and the libraries, but no need of changing their build scripts. 
+You *still* need to recompile the compiler and the libraries, but no need of changing their build scripts. 
 
 Annot compiler patch
 ===============================
 
     hg clone -b annot https://bitbucket.org/camlspotter/mutated_ocaml
 
-or included in this directory, ocaml-annot-<version>.patch.
+or included in this directory, ``ocaml-annot-<version>.patch``.
 
 You can also try OPAM compiler switch ``4.00.1+annot``. 
 
 
 OPAM removes compiled source files by default. 
 Upgrade your OPAM at least 0.8.2, 
-then set OPAMKEEPBUILDDIR environment variable with non-empty string.
+then set ``OPAMKEEPBUILDDIR`` environment variable with non-empty string.
 
 
 Install annot files
 Dunno, since I do not use GODI. Good luck. But general keypoints are:
 
 * Keep the compiled source code, or no browsing possible
-* Somehow hook the packager's final installation phase, in order to exec spotinstall command. Probably wrapping ``ocamlfind install`` might be a good idea, though I have not tried it.
+* Somehow hook the packager's final installation phase, in order to exec spotinstall command. Probably wrapping ``ocamlfind install`` for it might be a good idea, though I have not tried it.
 
 How to live with OCaml binary packages from my preferred OS distribution
 =============================================================================