8000 doc: correct doc for (map_workspace_root) by emillon · Pull Request #7775 · ocaml/dune · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

doc: correct doc for (map_workspace_root) #7775

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 22, 2023
Merged

doc: correct doc for (map_workspace_root) #7775

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
58f2328
doc: correct doc for (map_workspace_root)
emillon May 22, 2023
6a9ee87
Merge branch 'main' into doc-map-workspace-root
emillon May 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 3 additions & 10 deletions doc/dune-files.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand U 8327 p @@ -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/<switch>``).

.. _dune-files:

Expand Down
0