Skip to content

Commit 9d5ada5

Browse files
rlepigreAlizter
authored andcommitted
Add documentation for (generate_project_file).
Also fix a few documentation typos. Signed-off-by: Rodolphe Lepigre <[email protected]>
1 parent 638d810 commit 9d5ada5

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

doc/coq.rst

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ The Coq theory stanza is very similar in form to the OCaml
6767
(plugins <ocaml_plugins>)
6868
(flags <coq_flags>)
6969
(modules_flags <flags_map>)
70+
(generate_project_file)
7071
(coqdep_flags <coqdep_flags>)
7172
(coqdoc_flags <coqdoc_flags>)
7273
(coqdoc_header <coqdoc_header>)
@@ -190,8 +191,16 @@ The semantics of the fields are:
190191
- If the ``(mode vos)`` field is present, only Coq compiled interface files
191192
``.vos`` will be produced for the theory. This is mainly useful in conjunction
192193
with ``dune coq top``, since this makes the compilation of dependencies much
193-
faster, at the cost of skipping proof checking. (Appeared in :ref:`Coq lang
194-
0.8<coq-lang>`).
194+
faster, at the cost of skipping proof checking.
195+
(Appeared in :ref:`Coq lang 0.8<coq-lang>`)
196+
197+
- If the ``(generate_project_file)`` is present, a ``_CoqProject`` file is
198+
generated in the Coq theory's directory (it is promoted to the source tree).
199+
This file should be suitable for editor compatibility, and it provides an
200+
alternative to using ``dune coq top``. It is however limited in two ways: it
201+
is incompatible with the ``(modules_flags ...)`` field, and it cannot be
202+
used for two Coq theories declared in the same directory.
203+
(Appeared in :ref:`Coq lang 0.11<coq-lang>`)
195204

196205
Coq Dependencies
197206
~~~~~~~~~~~~~~~~
@@ -369,9 +378,9 @@ The Coq lang can be modified by adding the following to a
369378
The supported Coq language versions (not the version of Coq) are:
370379

371380
- ``0.11``: Support for the ``(coqdoc_header ...)`` and ``(coqdoc_footer ...)``
372-
fields.
381+
fields, and for ``_CoqProject`` file generation.
373382
- ``0.10``: Support for the ``(coqdep_flags ...)`` field.
374-
- ``0.9``: Support for per-module flags with the ``(module_flags ...)``` field.
383+
- ``0.9``: Support for per-module flags with the ``(modules_flags ...)``` field.
375384
- ``0.8``: Support for composition with installed Coq theories;
376385
support for ``vos`` builds.
377386

0 commit comments

Comments
 (0)