diff options
| author | Columbus240 | 2020-09-12 22:39:00 +0200 |
|---|---|---|
| committer | Columbus240 | 2020-09-12 23:00:19 +0200 |
| commit | f1cf2c07f6d3bc041fba8f0d048b32d642837815 (patch) | |
| tree | 8acb948abbf265b909ea6846efed2860e5b0db8a /BUILDING.md | |
| parent | a8be1e2551bc4fbda9c45792c0dad5743c18fefd (diff) | |
Docs: Mention "opam pin" and reword a detail
opam pin is useful in the development workflow.
About the rewording: The tests of Sail check the behavior of Sail and
not whether it is installed correctly, because the instructions above
that paragraph don’t install Sail, they just build it.
These circumstances weren’t represented appropriately by the text.
Diffstat (limited to 'BUILDING.md')
| -rw-r--r-- | BUILDING.md | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/BUILDING.md b/BUILDING.md index 88bcfbcc..7e63de0c 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -127,7 +127,7 @@ To build Sail with interactive support we need two more commands opam install linenoise make isail ``` -To test Sail is installed correctly, execute the following from the +To test if Sail behaves correctly, execute the following from the root directory of the sail repository. You may also need to set $LEM_DIR to the root of the lem repository for the lem tests. Some of the C backend tests will fail if valgrind isn't installed. Some tests will @@ -136,3 +136,12 @@ fail if cvc4 isn’t installed. export SAIL_DIR=$PWD test/run_tests.sh ``` + +To install Sail using OPAM from the git repo, use `opam pin` as follows. +``` +opam pin add sail /path/to/local/sail/repo +``` +This way, you can make the most recent changes to Sail easily available to programs +that use it. To rebuild this installation of Sail, use `opam upgrade` as usual. +If you want to do more complicated things, `opam pin --help` might be of +interest. |