Document that `cabal.project` is used only for `packages`
Nobody has claimed this yet.
- Dominant language
- Nix
- Stars
- 240
- Forks
- 27
- PR merge metrics
- No merged PRs in 30d
Description
I appreciate haskell-flake's support for cabal.project. I think it might be ignoring source-repository-package: https://cabal.readthedocs.io/en/stable/cabal-project.html#specifying-packages-from-remote-version-control-locations
haskell-multi-nix with example:
https://github.com/peterbecich/haskell-multi-nix/tree/source-repository-package-example
This should attempt to pull haskell/text bogus commit 123
cabal.project
packages:
./foo
./bar
source-repository-package
type: git
location: https://github.com/haskell/text.git
tag: 123
-- tag: 73620de89d43ee50de2d15b7bc0843bf6d6e9b9a
cabal build all fails as it should. However, nix build succeeds; I think it is getting text from NixPkgs as usual.
Cabal pulls the real commit 73620de correctly. nix build doesn't indicate if it is pulling this commit or not.
I know the text dependency could be specified in flake.nix: https://community.flake.parts/haskell-flake/dependency/#path
Thank you
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked cabal.project example and the Cabal documentation for source-repository-package, then reproduce the differing cabal build and nix build results. Confirm whether haskell-flake uses cabal.project only for packages, and document the observed limitation and expected behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- haskell
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100