Skip to content
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

Remove stack references; cabal is now fully capable for this project. #1098

Merged
merged 3 commits into from
Jul 10, 2023

Conversation

kquick
Copy link
Member

@kquick kquick commented Jul 10, 2023

No description provided.

@kquick
Copy link
Member Author

kquick commented Jul 10, 2023

Stack support was removed some time ago. Fixes #1097

@kquick kquick requested a review from RyanGlScott July 10, 2023 04:20
README.md Outdated
`stack`, as `cabal new-*` [does not yet support coverage](https://github.com/haskell/cabal/issues/5213).
Use `scripts/stack-test-coverage.sh` to generate a coverage
report for all test suites.
Testing with coverage tracking is done via `cabal test --enable-coverage ...`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make sure to mention to mention the workaround for #884 here.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

README.md Outdated
Comment on lines 90 to 91
Crucible can be built with the `cabal` tool (although it is not compatible with
the old/v1 cabal version).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To be honest, the cabal-v1 commands are old enough by this point that I don't think that they're even worth calling out here. You'd have to go out of your way to try them, since they aren't the default anymore.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks: that confirms my suspicions on the matter. I've removed the archaic reference.

README.md Outdated
stack build
```
Crucible can be built with the `cabal` tool (although it is not compatible with
the old/v1 cabal version).

```
./scripts/build-sandbox.sh
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As a side note (not necessarily something that you need to do in this PR), I wonder if this script is even worth having. All it does currently is:

https://github.com/GaloisInc/crucible/blob/2cf85d801d806a5f62cfc19403e041169be66cb7/scripts/build-sandbox.sh#L1C1-L3

We could just as well inline this into the README instructions. Moreover, I'm not sure how I feel about the --recursive part, since that will likely cause submodules to clone other submodules that aren't necessarily for the crucible build.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch: I've removed it and the references in an update.

The repository submodule management has been updated and simplified, making this
script irrelevant.
@kquick kquick merged commit 760168d into master Jul 10, 2023
30 checks passed
@kquick kquick deleted the issue1097 branch July 10, 2023 15:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants