From 58f2328d3dd78995e6732b93ddd8795d29c18c17 Mon Sep 17 00:00:00 2001 From: Etienne Millon Date: Mon, 22 May 2023 15:06:26 +0200 Subject: [PATCH] doc: correct doc for (map_workspace_root) Change the documentation for `(map_workspace_root)` so that it matches the existing situation. See #7743 which had been incorrectly merged. Signed-off-by: Etienne Millon --- doc/dune-files.rst | 13 +++---------- 1 file changed, 3 insertions(+), 10 deletions(-) diff --git a/doc/dune-files.rst b/doc/dune-files.rst index 3d049be6039..06221c85cbd 100644 --- a/doc/dune-files.rst +++ b/doc/dune-files.rst @@ -653,24 +653,17 @@ map_workspace_root - with ``(map_workspace_root true)``, dune rewrites references to the 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. + enabled, the debug information produced by the bytecode compiler is + incorrect, as the location information is lost. - with ``(map_workspace_root false)``, the references are not rewritten. The default is ``(map_workspace_root true)``. .. versionadded:: 3.0 + Initial version with the mapping always enabled. .. versionchanged:: 3.7 Add a way to disable the mapping. - .. versionchanged:: 3.8 - Also rewrite the installation directory (usually ``~/.opam/``). .. _dune-files: