Installation instructions do not expose all packages

[ivanperez-keera]

Description

The current installation instructions do not expose all packages, meaning that users can only access whatever is re-exported by the package copilot. This prevents users from accessing many key features of Copilot, and from compiling many specifications.

Type

• Bug: Installation instructions are insufficient for standard use cases.

Additional context

None.

Requester

• Ivan Perez.

Method to check presence of bug

Install Copilot using instructions in the README:

$ cabal v2-install --lib copilot

Try to compile a specification in one of the examples:

$ runhaskell copilot/examples/Heater.hs
copilot/examples/Heater.hs:11:1: error: [GHC-87110]
    Could not load module `Copilot.Compile.C99'.
    It is a member of the hidden package `copilot-c99-4.2'.
    You can run `:set -package copilot-c99' to expose it.
    (Note: this unloads all the modules in the current scope.)
    Use :set -v to see a list of the files searched for.
   |
11 | import Copilot.Compile.C99
   | ^^^^^^^^^^^^^^^^^^^^^^^^^^

Expected result

The specification can be compiled and executed correctly, producing C code.

Desired result

The specification can be compiled and executed correctly, producing C code.

Proposed solution

Modify installation instructions to expose all packages in the Copilot project.

Further notes

None.

[ivanperez-keera]

Change Manager: Confirmed that the issue exists.

[ivanperez-keera]

Technical Lead: Confirmed that the issue should be addressed.

[ivanperez-keera]

Technical Lead: Issue scheduled for fixing in Copilot 4.3.

Fix assigned to: @ivanperez-keera .