Avoid referring to ez-conf-lib:exe #27759
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The `ez-conf-lib:exe` variable is set in `ez-conf-lib.config` generated while building the `ez-conf-lib` package, and is set to the absolute path to the `ez-conf-lib` script. This causes a problem if the opam switch where `ez-conf-lib` is installed to is ever moved, as the absolute path will no longer refer to the correct place. This also creates problems for dune package management which moves all installed artifacts of a package after running its install command. The fix is to refer to the `ez-conf-lib` script directly by specifying its path relative to the `lib` directory where it is installed. Signed-off-by: Stephen Sherratt <[email protected]>
gridbugs
added a commit
to gridbugs/ez-conf-lib
that referenced
this pull request
Apr 15, 2025
This package used to provide a variable `exe` containing the absolute path to the `ez-conf-lib` script inside the current opam switch. The problem with using an absolute path here is it means the switch is not portable. This causes problems for dune packag emanagement where all packages are first installed to a temporary sandbox and then moved to a final location afterwards. Clients of ez-conf-lib are updated to refer to the script without using the exe variable in: ocaml/opam-repository#27759 Signed-off-by: Stephen Sherratt <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
ez-conf-lib:exevariable is set inez-conf-lib.configgenerated while building theez-conf-libpackage, and is set to the absolute path to theez-conf-libscript. This causes a problem if the opam switch whereez-conf-libis installed to is ever moved, as the absolute path will no longer refer to the correct place. This also creates problems for dune package management which moves all installed artifacts of a package after running its install command.The fix is to refer to the
ez-conf-libscript directly by specifying its path relative to thelibdirectory where it is installed.This is intended to fix ocaml/dune#11598 (that issue is closed because we implemented a hacky workaround in dune's overlay repo).
CC @nberth who authored these packgaes.