From 96e3448228d647c698500de8e6a0a6026097131f Mon Sep 17 00:00:00 2001 From: Rudi Grinberg Date: Fri, 31 Aug 2018 14:03:25 +0300 Subject: [PATCH] Add documentation and change log entry Signed-off-by: Rudi Grinberg --- CHANGES.md | 4 ++++ doc/dune-files.rst | 7 +++++++ 2 files changed, 11 insertions(+) diff --git a/CHANGES.md b/CHANGES.md index 40596326..91d298c8 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -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) ------------------ diff --git a/doc/dune-files.rst b/doc/dune-files.rst index 3c2915ee..ce87c4dc 100644 --- a/doc/dune-files.rst +++ b/doc/dune-files.rst @@ -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 ))`` 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 ```` will be included in the + deprecation notice for the unwrapped modules. + - ``(preprocess )`` specifies how to preprocess files if needed. The default is ``no_processing``. Other options are described in the `Preprocessing specification`_ section