Skip to content

Commit e1e6ff3

Browse files
committed
Add documentation for the new (subst ...) stanza
Signed-off-by: Kate <kit.ty.kate@disroot.org>
1 parent d4fa53b commit e1e6ff3

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

doc/dune-files.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -228,6 +228,26 @@ where ``<setting>`` is one of:
228228
- ``(enabled_for <languages>)`` can be used to restrict the languages that are
229229
considered for formatting.
230230

231+
.. _subst:
232+
233+
subst
234+
----------
235+
236+
Starting in dune 3.0, :ref:`dune-subst` can be explicitly disabled or enabled.
237+
By default it is enabled.
238+
controlled by using
239+
240+
.. code:: scheme
241+
242+
(subst <setting>)
243+
244+
where ``<setting>`` is one of:
245+
246+
- ``disabled``, meaning that any call of `dune subst` in this project is
247+
forbidden and will result in an error.
248+
249+
- ``enabled``, allowing substitutions explicitly. This is the default.
250+
231251
.. _generate_opam_files:
232252

233253
generate_opam_files

0 commit comments

Comments
 (0)