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       -f file
53              Read filenames and options -I, -R  and  -Q  from  a  _CoqProject
54              FILE.
55
56       -I/-Q/-R options
57              Have  the  same  effects  on  load path and modules names as for
58              other coq commands (coqtop, coqc).
59
60       -coqlib directory
61              Indicates where is the Coq library. The default value  has  been
62              determined  at  installation  time,  and  therefore  this option
63              should not be used under normal circumstances.
64
65       -dumpgraph[box] file
66              Dumps a dot dependency graph in file file.
67
68       -exclude-dir dir
69              Skips subdirectory dir during -R/-Q search.
70
71       -sort  Output the given file name ordered by dependencies.
72
73       -boot  For coq developpers, prints dependencies over coq library  files
74              (omitted by default).
75
76
77

SEE ALSO

79       ocamlc(1), coqc(1), make(1).
80
81

NOTES

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

EXAMPLES

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

BUGS

139       Please report any bug to coq-bugs@pauillac.inria.fr
140
141
142
143Coq tools                        28 March 1995                          COQ(1)