From 799bd29627c554f83c1ec9b4a226a739632cbc29 Mon Sep 17 00:00:00 2001 From: Gaëtan Gilbert Date: Wed, 20 Nov 2019 15:31:57 +0100 Subject: Document -vos flag for coqdep --- doc/sphinx/practical-tools/coq-commands.rst | 8 ++++++++ man/coqdep.1 | 3 +++ tools/coqdep.ml | 1 + 3 files changed, 12 insertions(+) diff --git a/doc/sphinx/practical-tools/coq-commands.rst b/doc/sphinx/practical-tools/coq-commands.rst index 514f5acc8e..d4a61425e1 100644 --- a/doc/sphinx/practical-tools/coq-commands.rst +++ b/doc/sphinx/practical-tools/coq-commands.rst @@ -308,6 +308,14 @@ In addition, ``coq_makefile`` generates for a file ``foo.v`` a target next, the purpose of this target is to be able to request the minimal working state for editing interactively the file ``foo.v``. +.. warning:: + + When writing a custom build system, be aware that ``coqdep`` only + produces dependencies related to ``.vos`` and ``.vok`` if the + ``-vos`` command line flag is passed. This is to maintain + compatibility with dune (see `ocaml/dune#2642 on github + `_). + **Typical compilation of a set of file using a build system.** Assume a file ``foo.v`` that depends on two files ``f1.v`` and ``f2.v``. The diff --git a/man/coqdep.1 b/man/coqdep.1 index 4639a75677..02c9d4390c 100644 --- a/man/coqdep.1 +++ b/man/coqdep.1 @@ -104,6 +104,9 @@ Skips subdirectory .TP .B \-sort Output the given file name ordered by dependencies. +.TP +.B \-vos +Output dependencies for .vos files (this is not the default as it breaks dune's Coq mode) .TP .B \-boot For coq developers, prints dependencies over coq library files diff --git a/tools/coqdep.ml b/tools/coqdep.ml index b9a8601d10..7a401160db 100644 --- a/tools/coqdep.ml +++ b/tools/coqdep.ml @@ -455,6 +455,7 @@ let usage () = eprintf " -R dir -as logname : add and import dir recursively to coq load path under logical name logname\n"; (* deprecate? *) eprintf " -R dir logname : add and import dir recursively to coq load path under logical name logname\n"; eprintf " -Q dir logname : add (recursively) and open (non recursively) dir to coq load path under logical name logname\n"; + eprintf " -vos : also output dependencies about .vos files\n"; eprintf " -dumpgraph f : print a dot dependency graph in file 'f'\n"; eprintf " -dumpgraphbox f : print a dot dependency graph box in file 'f'\n"; eprintf " -exclude-dir dir : skip subdirectories named 'dir' during -R/-Q search\n"; -- cgit v1.2.3