1COQ(1)                      General Commands Manual                     COQ(1)
2
3
4

NAME

6       coqdep - Compute inter-module dependencies for Coq and Caml programs
7
8

SYNOPSIS

10       coqdep [ -w ] [ -I directory ] [ -coqlib directory ] [ -c ] [ -i ] [ -D
11       ] [ -slash ] filename ...  directory ...
12
13

DESCRIPTION

15       coqdep compute inter-module dependencies for Coq and Caml programs, and
16       prints  the dependencies on the standard output in a format readable by
17       make.  When a directory is given as argument, it is recursively  looked
18       at.
19
20       Dependencies of Coq modules are computed by looking at Require commands
21       (Require, Require Export, Require Import), Declare ML  Module  commands
22       and  Load  commands.  Dependencies  relative  to  modules  from the Coq
23       library are not printed except if -boot is given.
24
25       Dependencies of Caml modules are computed by looking at open directives
26       and the dot notation module.value.
27
28

OPTIONS

30       -c     Prints  the dependencies of Caml modules.  (On Caml modules, the
31              behaviour is exactly the same as ocamldep).
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52       -I/-Q/-R options
53              Have the same effects on load path and modules  names  than  for
54              other coq commands (coqtop, coqc).
55
56       -coqlib directory
57              Indicates  where  is the Coq library. The default value has been
58              determined at  installation  time,  and  therefore  this  option
59              should not be used under normal circumstances.
60
61       -dumpgraph[box] file
62              Dumps a dot dependency graph in file file.
63
64       -exclude-dir dir
65              Skips subdirectory dir during -R/-Q search.
66
67       -sort  Output the given file name ordered by dependencies.
68
69       -boot  For  coq developpers, prints dependencies over coq library files
70              (omitted by default).
71
72
73

SEE ALSO

75       ocamlc(1), coqc(1), make(1).
76
77

NOTES

79       Lexers (for Coq and Caml) correctly handle nested comments and strings.
80
81       The treatment of symbolic links is primitive.
82
83       If two files have the same name, in two different directories, a  warn‐
84       ing is printed on standard error.
85
86       There is no way to limit the scope of the recursive search for directo‐
87       ries.
88
89

EXAMPLES

91       Consider the files (in the same directory):
92
93            A.ml B.ml C.ml D.ml X.v Y.v and Z.v
94
95       where
96
97       +      D.ml contains the commands `open A', `open B' and `type t = C.t'
98              ;
99
100       +      Y.v contains the command `Require X' ;
101
102       +      Z.v  contains  the  commands  `Require X' and `Declare ML Module
103              "D"'.
104
105       To get the dependencies of the Coq files:
106
107              example% coqdep -I . *.v
108              Z.vo: Z.v ./X.vo ./D.cmo
109              Y.vo: Y.v ./X.vo
110              X.vo: X.v
111
112       With a warning:
113
114              example% coqdep -w -I . *.v
115              Z.vo: Z.v ./X.vo ./D.cmo
116              Y.vo: Y.v ./X.vo
117              X.vo: X.v
118              ### Warning : In file Z.v, the ML modules declaration should be
119              ### Declare ML Module "A" "B" "C" "D".
120
121       To get only the Caml dependencies:
122
123              example% coqdep -c -I . *.ml
124              D.cmo: D.ml ./A.cmo ./B.cmo ./C.cmo
125              D.cmx: D.ml ./A.cmx ./B.cmx ./C.cmx
126              C.cmo: C.ml
127              C.cmx: C.ml
128              B.cmo: B.ml
129              B.cmx: B.ml
130              A.cmo: A.ml
131              A.cmx: A.ml
132
133

BUGS

135       Please report any bug to coq-bugs@pauillac.inria.fr
136
137
138
139Coq tools                        28 March 1995                          COQ(1)