File: README

package info (click to toggle)
otags 4.05.1-1
  • links: PTS, VCS
  • area: main
  • in suites: buster, sid
  • size: 424 kB
  • ctags: 356
  • sloc: ml: 1,267; sh: 212; makefile: 194
file content (72 lines) | stat: -rw-r--r-- 2,886 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

     Otags III: TAGS generation for emacs and vi from OCaml sources

===========================================================================
===========================================================================

Summary
=======

Otags can be used to build TAGS tables for emacs and vi/vim, like etags
does, but for OCaml source code. It is based on the official
OCaml parser from the compiler-libs library. Otags is therefore more
accurate than an regexp based tagger for OCaml: otags finds references
to constructors of sum types, fields of records, etc. The downside of
the parser approach is that you can only tag syntactically correct
files. (Previous versions of otags supported camlp4 syntax extensions
- this version only supports OCaml standard syntax without -pp or -ppx
preprocessors.)

===========================================================================
===========================================================================

USAGE
=====

To build an emacs TAGS table for ocaml.ml do:

   otags ocaml.ml

Most important options are -r for recursive directory tagging and
-vi for generating vi/vim tags tables.

For more examples and all details visit the man page in the doc
subdirectory or online at http://askra.de/otags/otags.man.html

===========================================================================
===========================================================================

CREDITS / HISTORY
=================

The first camlp4 based OCaml tagger has been written by Cuihtlauac
Alvarado (http://perso.rd.francetelecom.fr/alvarado) and Jean-Francois
Monin (http://www-verimag.imag.fr/~monin). Around 2005 I took over and
released a few versions for OCaml 3.09. All otags versions released up
to 3.09.3.3 were written for the original camlp4, which is now
available as camlp5.

For 3.11 I rewrote otags from scratch for the new camlp4 and released
several versions under the name "otags reloaded". The modular
structure of camlp4 made it possible to switch the parsing engine at
runtime between files and to parse all syntax supported by camlp4 at
full native speed without external camlp4 processes. However, the
increasing incompatibility between camlp4 and OCaml and camlp4's
sloppiness on parsing locations created more and more difficulties.
For instance, otags 4.02 failed on the OCaml standard library because
camlp4 was unable to digest the attribute annotations in there.

Starting from 4.03, otags is based on the standard OCaml parser from
the compiler-libs library and has been renamed to "otags III". Support
for -pp or -ppx preprocessors is not yet available.

===========================================================================
===========================================================================

Contact
=======

Please send bug reports, comments, patches, donations to 
Hendrik Tews <otags@askra.de>