Commits

camlspotter  committed b5e5042

document

  • Participants
  • Parent commits b62ba0a
  • Branches ocamlspot

Comments (0)

Files changed (1)

File ocamlspot/README.txt

       File-name-only search show the position independent information
       of the module specified by [file].
 
+        Example:
+
+	$ ocamlspot -i ocamlspot.ml
+	Compile: ../ocamlc -nostdlib -I ../stdlib -annot -annot -w Ae -warn-error Ae -I ../parsing -I ../utils -I ../typing -I ../driver -I ../bytecomp -I ../tools -I ../toplevel/ -I ../otherlibs/unix -c ocamlspot.ml
+	Included_dirs:
+	  /..../ocaml/ocamlspot/
+	  /..../ocaml/ocamlspot/../stdlib
+	  /..../ocaml/ocamlspot/../parsing
+	  /..../ocaml/ocamlspot/../utils
+	  /..../ocaml/ocamlspot/../typing
+	  /..../ocaml/ocamlspot/../driver
+	  /..../ocaml/ocamlspot/../bytecomp
+	  /..../ocaml/ocamlspot/../tools
+	  /..../ocaml/ocamlspot/../toplevel/
+	  /..../ocaml/ocamlspot/../otherlibs/unix
+	BYE!
 
       By-position search has the form [file]:[pos]. [file] is the path
       of the target ml/mli file and [pos] is the position in the
       compatibility) by the bytes from the beginning of the source
       code. 
 
+        Example:
+
+	$ ocamlspot ocamlspot.ml:l129c14
+	Tree: l129c8b4035:l129c28b4055           # pos of the inner most node
+	In_module: With_pos.Fix
+	Use: Type, Path__360.t__G
+	Type: Path.t
+	XType: Path__360.t__G                    # type with ident id numbers
+	Spot: /..../ocaml/typing/path.ml:l15c5b875:l18c19b949 # the definition
+	BYE!
+
       Note that bytes are not chars in multi-byte-character
       environment. OCaml is completely free from such mess and you
       might need to count chars by yourself.
 
 
-      By-path search
+      By-path search shows the definition spot of the given path 
+      with ident id numbers. It will be useful with conjunction with 
+      the path names obtained from XType: fields. No fancy elisp wrapper
+      is not available for it, though.
+
+        Example:
+
+	# checking a type named Path__360.t__G
+	$ ocamlspot ocamlspot.ml:t:Path__360.t__G  
+	Spot: /..../ocaml/typing/path.ml:l15c5b875:l18c19b949
+	BYE!
 
 OPTIONS