Commits

camlspotter committed f0f9c47

doc fix

  • Participants
  • Parent commits f6f89d7

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 subexpression type queries (caml-types.el), definition seaches and code refactoring (TypeRex and OCamlSpotter). If you want to use development tools, you have to:
 
-* Rebuild all the software from the source, adding -annot/-bin-annot option to compiler flags in build scripts i.e. Makefile/OCamlBuild/OMakefile.
+* Rebuild all the software from their source, adding -annot/-bin-annot option 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.
 Synopsis
 ==============================
 
+Stay in the source code directory of ``<package>``, then
+
 ::
 
     spotinstall <packages>
 
 The command checks the files in the installation directory of OCamlFind package <package>, and if there are corresponding annotation files in the current and its sub directories, copy them to the installation directory.
 
-If <package> is ocaml, spotinstall works bit differently and copies the annotation files build under OCaml compiler source tree.
+If ``<package>`` is ``ocaml``, spotinstall works bit differently and copies the annotation files built under OCaml compiler source tree.
 
 
 Notes