Commits

camlspotter committed c2c465a

doc update

  • Participants
  • Parent commits c8b99a9
  • Branches ocamlspot

Comments (0)

Files changed (2)

File INSTALL-ocamlspot.txt

-1. OCamlSpotter required patching against the original OCaml compiler, 
+1. OCamlSpotter required patching against the original OCaml compiler,
    but now, thanks to the very kind interpretation of the OCaml license
-   by INRIA, OCamlSpot can be distributed as an entire modified source code 
-   tree of OCaml with modificaiton. 
+   by INRIA, OCamlSpot can be distributed as an entire modified source code
+   tree of OCaml with modificaiton.
 
 2. Relax
 
 
   ; load-path
   (setq load-path (cons "WHERE-YOU-HAVE-INSTALLED-THE-ELISP" load-path))
- 
+
   ; set the path of the ocamlspot binary
   (setq ocamlspot-path "WHERE-YOU-HAVE-INSTALLED-THE-BINARIES/ocamlspot")
- 
+
   ; autoload
   (autoload 'ocamlspot-query "ocamlspot" "OCamlSpot")
- 
+
   ; tuareg mode hook (use caml-mode-hook instead if you use caml-mode)
-    (add-hook 'tuareg-mode-hook 
-    	  '(lambda ()
+  (add-hook 'tuareg-mode-hook
+  	  '(lambda ()
   	     (local-set-key "\C-c;" 'ocamlspot-query)
   	     (local-set-key "\C-c\C-t" 'ocamlspot-type)
              (local-set-key "\C-c\C-y" 'ocamlspot-type-and-copy)
   	     (local-set-key "\C-c\C-u" 'ocamlspot-use)
   	     (local-set-key "\C-ct" 'caml-types-show-type)))
- 
+
 10. How to use
 
-  Compiler your ML project by this patched compiler with -annot option to create .spot files. Open one of the source files in Emacs and place the cursor at the name whose definition is in question. Type C-c; will show you the defintion.
+  Compile your ML project by this patched compiler with -annot option to create .spot files. Open one of the source files in Emacs and place the cursor at the name whose definition is in question. Type C-c; will show you the defintion.
 
 11. bug report
 

File README-ocamlspot.txt

    locations in emacs.
 
  - Interfaces for other editors such as vi can be built easily, if you
-   want. I do not want.
+   want. 
    
 Spotting / Definition analysis
 ==============================
 	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.
+      environment. If your source code contains multi-byte characters,
+      you might need to count chars by yourself. In Emacs, ocamlspot.el
+      does the job for you.
 
 
       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
+      the path names obtained from XType: fields. No elisp wrapper
       is not available for it, though.
 
         Example: