File: include.rst

package info (click to toggle)
ocaml-dune 3.20.2-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 33,564 kB
  • sloc: ml: 175,178; asm: 28,570; ansic: 5,251; sh: 1,096; lisp: 625; makefile: 148; python: 125; cpp: 48; javascript: 10
file content (27 lines) | stat: -rw-r--r-- 768 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
include
-------

The ``include`` stanza allows including the contents of another file in the
current ``dune`` file. The included file cannot be generated and must
be present in the source tree. To include generated files, 
use the :ref:`dynamic_include` stanza instead. This feature is intended 
for use in conjunction with promotion, when parts of a ``dune`` file are to be generated.

For instance:

.. code:: dune

    (include dune.inc)

    (rule (with-stdout-to dune.inc.gen (run ./gen-dune.exe)))

    (rule
     (alias  runtest)
     (action (diff dune.inc dune.inc.gen)))

With this ``dune`` file, running Dune as follows will replace the ``dune.inc``
file in the source tree by the generated one:

.. code:: console

    $ dune build @runtest --auto-promote