Commits

camlspotter  committed 2bf46d3

added docs to README

  • Participants
  • Parent commits ada61ae
  • Branches ocamlspot

Comments (0)

Files changed (1)

File README-ocamlspot.txt

 ====================================
 
   Camel spotter: Oh, it was extremely interesting, very, very -
-    quite... it was dull; dull, dull, dull, oh God it was dull. 
-    Sitting in the Waterloo waiting room. ...
+  quite... it was dull; dull, dull, dull, oh God it was dull. 
+  Sitting in the Waterloo waiting room. ...
 
                                      from You're No Fun Anymore, 
                                     Monty Python's Flying Circus
 automatically for you and permits your energy for something more
 "interesting" like Yeti spotting:
 
+===============================
+Summary
+===============================
+
  - The -annot option of ocamlc and ocamlopt is extended and creates 
    <module>.spot files (<module>.spit for .mli), which record the
    location information of the names defined and used in the module.
  - ocamlspot.el provides interactive ocaml-spotting of definition 
    locations in emacs.
 
- - Interfaces for other editors such as vi can be built easily, if you
-   want. I do not want.
+ - Interfaces for other editors such as Vim can be built easily.
+   A small sample for Vim is available (ocamlspot.vim).
    
+===============================
+ocamlc compiler modifications
+===============================
+
+ - The -annot option of ocamlc and ocamlopt is extended and creates 
+   <module>.spot files (<module>.spit for .mli), which record the
+   location information of the names defined and used in the module.
+
+ - Existence of OCAML_ANNOT environment variable turns on .annot, .spot
+   and .spit file creation, even without -annot option to the compiler.
+   It is good for compiling OCaml softwares with .spot+.spit files without
+   modifying Makefiles.
+
+===============================
+ocamlspot query application
+===============================
+
+
 Compilation information
 ===============================
 
           i.e. types, paths, etc.
 
 
+Spot creation w/o real compilation
+==================================
+
+SYNOPSIS
+
+      ocamlspot typecheck <args>
+      ocamlspot recheck <targets>
+
+DESCRIPTION
+
+      ocamlspot typecheck <args> is as same as ocamlc <args>, but it does
+      not create object files but only .annot/.spot/.spit files 
+      independently. Useful if you want to stick to the official OCaml 
+      compiler to create object files.
+
+      ocamlspot recheck <targets> redos the typecheck and creation of
+      .annot/.spot/.spit files using the compilation information already
+      stored in .spot/.spit files.
+
+=====================
 Bugs and future works
 =====================
 
 This software contain lots of bugs and todos.
 
+=======
 License
 =======
 
 Read LICENSE file in this directory. 
 
+======
 Author
 ======
 
   Jun FURUSE (jun.furuse@gmail.com). Bug reports and comments are
   welcome. Patches are appreciated. Donating camel related gadgets is
-  the most wonderful. Complaints might be simply ignored.
+  the most wonderful.