matthieu
/
dune
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add documentation and change log entry 

Signed-off-by: Rudi Grinberg <rudi.grinberg@gmail.com>
This commit is contained in:
Rudi Grinberg 2018-08-31 14:03:25 +03:00
parent 868ecbc632
commit 96e3448228
2 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CHANGES.md
View File

@ -38,6 +38,10 @@ next
- Improve message suggesting to remove parentheses (#1196, fix #1173, @emillon)
- Add `(wrapped (transition "..message.."))` as an option that will generate
wrapped modules but keep unwrapped modules with a deprecation message to
preserve compatibility. (#1188, fix #985, @rgrinberg)
1.1.1 (08/08/2018)
------------------

7
doc/dune-files.rst
View File

@ -96,6 +96,13 @@ to use the :ref:`include_subdirs` stanza.
only intended for libraries that manually prefix all their modules by the
library name and to ease porting of existing projects to dune
- ``(wrapped (transition <message>))`` Is the same as ``(wrapped true)`` except
that it will also generate unwrapped (not prefixed by the library name)
modules to preserve compatibility. This is useful for libraries that would
like to transition from ``(wrapped false)`` to ``(wrapped true)`` without
breaking compatibility for users. The ``<message>`` will be included in the
deprecation notice for the unwrapped modules.
- ``(preprocess <preprocess-spec>)`` specifies how to preprocess files if
needed. The default is ``no_processing``. Other options are described in the
`Preprocessing specification`_ section