← Back to branch summary

~ubuntu-branches/ubuntu/trusty/ocaml-tools/trusty-proposed

« back to all changes in this revision

Viewing changes to ocamldot/README

  • Committer: Package Import Robot
  • Author(s): Mehdi Dogguy, Ralf Treinen, Stefano Zacchiroli, Stéphane Glondu, Mehdi Dogguy
  • Date: 2012-01-04 22:23:43 UTC
  • mfrom: (1.2.5)
  • Revision ID: package-import@ubuntu.com-20120104222343-ubnsxad00bzk26v0
Tags: 20120103-1
http://bugs.debian.org/583937
[ Ralf Treinen ]
* Fixed typo in long description (closes: #583937)

[ Stefano Zacchiroli ]
* remove myself from Uploaders

[ Stéphane Glondu ]
* Switch packaging to git

[ Mehdi Dogguy ]
* Add myself to Uploaders.
* New release
  - retintroduce ocamldot since its functionality is not provided
    by ocamldoc.
* Fix typo in README.Debian
* Fix copyright-refers-to-deprecated-bsd-license-file
* Bump Standards-Version to 3.9.2, no further changes required
* Fix debian-rules-missing-recommended-target build-{arch,indep}
* Convert to 3.0 (quilt) source format

Show diffs side-by-side

added added

removed removed

Lines of Context:
ocamldot/README
 
1
Ocamldot generates program dependency graphs for ocaml programs.
 
2
 
 
3
The dependency graph output by ocamldot can be rendered by a separate
 
4
program, dot.  Dot is freely available from
 
5
 
 
6
  http://www.research.att.com/sw/tools/graphviz/
 
7
 
 
8
Ocamldot is designed to process the output of ocamldep.  A typical use
 
9
would be
 
10
 
 
11
  ocamldep *.ml | ocamldot > dep.dot
 
12
 
 
13
or
 
14
 
 
15
  ocamldep *.ml > .depend
 
16
  ocamldot .depend > dep.dot
 
17
 
 
18
This will output a dot graph into the file dep.dot.  You can then use
 
19
the program dotty to view, edit, and print the graph.
 
20
 
 
21
Ocamldot has the following options:
 
22
 
 
23
  -fullgraph   draw the full graph (default is to draw only the kernel)
 
24
  -landscape   output in landscape format (default is portrait)
 
25
  -lr          draw graph from left to right (default is top to bottom)
 
26
  -r <r>       use <r> as a root in the graph; nodes reachable from <r>
 
27
               will be shown
 
28
 
 
29
(The transitive kernel of a dag is the smallest subset of the dag
 
30
whose transitive closure is the same as the transitive closure of the
 
31
dag.  For example, the kernel of A->B, A->C, B->C is just the two
 
32
edges A->B, B->C.)
 
33
 
 
34
-Trevor Jim