Commits

camlspotter committed 75d314e

added doc and files in tests_use

Comments (0)

Files changed (4)

 You first days after joining a large OCaml project should be this kind
 of manual value definition spotting with find + grep commands. Yes,
 actually it is very educational: you can learn a lot about the project
-struggling in the source tree (only if your collegues have organized
+struggling in the source tree (only if your colleagues have organized
 things very well :-P), but it is still a dull job...
 
 To say short, OCamlSpotter is a tool which does this dull job
 
       Retrieve various annotation information from .spot or .spit files
       of the source code position or identifier, specified by the
-      search spec. Information is prited to stdout. They are:
+      search spec. Information is printed to stdout. They are:
 
       Spot: file:pos
           The definition position of the object which the search spec
       XType: type     
           The type of the object which the search spec points to, if
           available. In XType, paths are printed with position
-          informaiton: for example, "unit__6" instead of "unit".
+          information: for example, "unit__6" instead of "unit".
 
       Use: kind, name
           The kind and the name with id numbers of the identifier 
           i.e. types, paths, etc.
 
 
+Value usage analysis (Experimental)
+===================================
+
+SYNOPSIS
+
+      ocamlspot use [search] [target files and dirs]
+            search ::= [file]:[pos] | [file]:[kind]:[path]
+            pos ::= l[line]c[column_bytes] | b[bytes] | [bytes]
+            kind ::= v|t|e|m|mt|c|ct
+            
+            where
+              v  : value
+	      t  : type
+	      e  : exception
+	      m  : module
+	      mt : module type
+	      c  : class
+	      ct : class type
+
+DESCRIPTION
+
+      ocamlspot use does opposite of ocamlspot query: search the uses of
+      the identifier specified by the search spec.
+
+      After the search spec, the search target path names can be specified.
+      If a target is a directory, the search is performed recursively
+      in the directory.
+
 Spot creation w/o real compilation
 ==================================
 
       .annot/.spot/.spit files using the compilation information already
       stored in .spot/.spit files.
 
+===============================
+ocamlspot.el emacs interface
+===============================
+
+...
+
 =====================
 Bugs and future works
 =====================

ocamlspot/tests_use/.depend

+dummy.cmi:
+test1.cmo:
+test1.cmx:
+test2.cmo: test1.cmo
+test2.cmx: test1.cmx

ocamlspot/tests_use/Makefile

 beforedepend::
 
 depend: beforedepend
-	$(CAMLRUN) ../../tools/ocamldep $(INCLUDES) -I dir1 -I dir2 *.mli *.ml */*.mli */*.ml > .depend
+	$(CAMLRUN) ../../tools/ocamldep $(INCLUDES) *.mli *.ml */*.mli */*.ml > .depend
 
 Makefile.targets: *.ml *.mli
 	echo TARGETS= \\ > $@

ocamlspot/tests_use/dummy.mli

Empty file added.