Skip to content

Move Copilot.Compile.Bluespec.External out of shared directory. Refs #36. #38

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.

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 3 commits into from
Mar 20, 2025

Conversation

RyanGlScott
Copy link
Collaborator

@RyanGlScott RyanGlScott commented Mar 20, 2025

The non-public Copilot.Compiler.Bluespec.External module lives under a shared/ directory so that it be imported by both the library code and the test suite code. This is a questionable design, as it means that the code for the library is not self-contained in a single src/ directory. (There exists a similar problem for the test suite.)

This commit moves Copilot.Compiler.Bluespec.External from shared/ to src/. It also creates a duplicate version of the module under the name Test.Copilot.Compiler.Bluespec.External. This code duplication is not ideal, but it is better than the previous status quo. The task of de-duplicating it will be deferred to a separate issue (#3).

Fixes #36.

The non-public `Copilot.Compiler.Bluespec.External` module lives under a
`shared/` directory so that it be imported by both the library code and the
test suite code. This is a questionable design, as it means that the code for
the library is not self-contained in a single `src/` directory. (There exists a
similar problem for the test suite.)

The comments in `Copilot.Compiler.Bluespec.External` mistakenly reference the
C99 backend instead of the Bluespec backend, which will make it confusing for
users when this module is moved to a more prominent, Bluespec-specific
location. This commit fixes the comments to reference the Bluespec backend
instead.
.

The non-public `Copilot.Compiler.Bluespec.External` module lives under a
`shared/` directory so that it be imported by both the library code and the
test suite code. This is a questionable design, as it means that the code for
the library is not self-contained in a single `src/` directory. (There exists a
similar problem for the test suite.)

This commit moves `Copilot.Compiler.Bluespec.External` from `shared/` to
`src/`. It also creates a duplicate version of the module under the name
`Test.Copilot.Compiler.Bluespec.External`. This code duplication is not ideal,
but it is better than the previous status quo. The task of de-duplicating it
will be deferred to a separate issue
(#3).
@RyanGlScott RyanGlScott merged commit 3d43fee into master Mar 20, 2025
3 checks passed
@RyanGlScott RyanGlScott deleted the T36-move-shared-to-src branch March 20, 2025 23:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Remove shared/ directory
2 participants