haskell / haskell/cabal

Document `source-repository-package` better. E.g., what counts as `tag`?

Open
#8,063 0 comments 2 reactions 0 assignees View on GitHub
cabal-install: source-repository-package documentation type: enhancement
Dominant language
Haskell
Stars
1.7k
Forks
750
Avg merge
4d 3h
Merged PRs (30d)
28

Description

See https://cabal.readthedocs.io/en/latest/cabal-project.html#specifying-packages-from-remote-version-control-locations for the latest documentation.
https://github.com/haskell/cabal/blob/8e648ae06b8d456a698f105df0eaa3a46bd55e68/doc/cabal-project.rst#L155-L195
I am missing the information here what counts as a `tag`?
- [x] git hash. This is given in the example.
- [ ] git tag. I happen to know this.
- [ ] git branch name? (No, see #6888)
- [ ] github pr??

There are field types listed here, but one cannot click on them to be told their semantics.

Also, the example is a bit impoverished, it could be more diverse, in these dimensions:
- type of vcs (atm. `git` only)
- type of url (atm. `https` only)
- type of tag (atm. hash only)

If there were more examples, one could infer more of the semantics of `tag`, `location` etc.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.