From dbe9e16da0f4bf0b3f6f481c6fa526da50d8d094 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ulysse=20G=C3=A9rard?= Date: Fri, 18 Jun 2021 15:09:32 +0200 Subject: [PATCH] Add documentation for new fields MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Ulysse Gérard --- doc/dune-files.rst | 27 +++++++++++++++++---------- 1 file changed, 17 insertions(+), 10 deletions(-) diff --git a/doc/dune-files.rst b/doc/dune-files.rst index 6f25b299ca91..2f78859eb972 100644 --- a/doc/dune-files.rst +++ b/doc/dune-files.rst @@ -1858,7 +1858,7 @@ Note that this feature is still experimental and needs to be enabled in your .. code:: scheme - (using mdx 0.1) + (using mdx 0.2) ; Version 0.2 of the stanza requires mdx >= 1.9.0 The syntax is as follows: @@ -1872,23 +1872,30 @@ Where ```` are: list of globs (see the :ref:`Glob language specification ` ). It defaults to ``*.md``. -- ``(packages )`` are the local dune packages that your documentation - code blocks depend on. I.e. if your documentation examples depend on a public - executable or library defined from a local package, it has to be specified in - the stanza. +- ``(deps )`` (since version 0.2) to specify the dependencies + of your documentation code blocks. See the :ref:`deps-field` section for more + details. + +- ``(packages )`` (deprecated in version 0.2) are the local dune + packages that your documentation code blocks depend on. I.e. if your + documentation examples depend on a public executable or library defined from + a local package, it has to be specified in the stanza. - ``(preludes )`` are the prelude files you want to pass to MDX. See `MDX's documentation `__ for more details on preludes. +- ``(libraries )`` (since version 0.2) are libraries that should be + statically linked in the MDX test executable. + - ``(enabled_if )`` is the same as the corresponding field of `library`_. -- ``(package )`` specifies which package to attach this stanza to - (similarly to when ``(package)`` is attached to a ``(rule)`` stanza. When - ``-p`` is passed, ``(mdx)`` stanzas with an other package will be ignored. - Note that this is feature is completely separate from ``(packages)``, which - specifies some dependencies. +- ``(package )`` (since Dune 2.9) specifies which package to attach + this stanza to (similarly to when ``(package)`` is attached to a ``(rule)`` + stanza. When ``-p`` is passed, ``(mdx)`` stanzas with an other package will + be ignored. Note that this is feature is completely separate from + ``(packages)``, which specifies some dependencies. .. _plugin: