Skip to content

Commit

Permalink
Fix markup, move changelog at the end
Browse files Browse the repository at this point in the history
Signed-off-by: Etienne Millon <[email protected]>
  • Loading branch information
emillon committed May 17, 2023
1 parent 6c76d94 commit 961c2ce
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions doc/dune-files.rst
Original file line number Diff line number Diff line change
Expand Up @@ -648,29 +648,29 @@ map_workspace_root
.. dune:stanza:: map_workspace_root
:param: <bool>

.. versionadded:: 3.7

Control references to the file system locations where the project has been
built.

- with ``(map_workspace_root true)``, dune rewrites references to the
workspace root to ``/workspace_root``. Starting with version
3.8, in addition, the installation root directory (usually
``~/.opam/<switch>'') is also rewritten to ``/workspace_root``.
Note that when this mapping is enabled, the debug information produced
by the bytecode compiler gives locations relative to the
workspace root. If the developer chooses a source layout that
mirrors the installation layout, then by mapping paths with
``/workspace_root`` replaced by the install root, the
installed artifacts (e.g. source files) can be found.
This mapping will be done by a combination of an updated
``ocamldebug''' and the new ``dune ocaml debug`` command.
However, if the source layout is different than the install
workspace root to ``/workspace_root``. Note that when this mapping is
enabled, the debug information produced by the bytecode compiler gives
locations relative to the workspace root. If the developer chooses a
source layout that mirrors the installation layout, then by mapping paths
with ``/workspace_root`` replaced by the install root, the installed
artifacts (e.g. source files) can be found. This mapping will be done by a
combination of an updated ``ocamldebug`` and the new ``dune ocaml debug``
command. However, if the source layout is different than the install
layout, this will not work.

- with ``(map_workspace_root false)``, the references are not rewritten.

Starting from language version 3.0, the default is ``true``.
The default is ``(map_workspace_root true)``.

.. versionadded:: 3.0
.. versionchanged:: 3.7
Add a way to disable the mapping.
.. versionchanged:: 3.8
Also rewrite the installation directory (usually ``~/.opam/<switch>``).

.. _dune-files:

Expand Down

0 comments on commit 961c2ce

Please sign in to comment.