haskell / haskell/cabal

Include Hackage revision (x-revision) in install output

Open
#1,929 1 comment 1 reaction 0 assignees View on GitHub
attention: pr-welcome cabal-install: other meta: easy re: pvp type: enhancement
Dominant language
Haskell
Stars
1.7k
Forks
750
Avg merge
4d 3h
Merged PRs (30d)
28

Description

It's now possible to modify .cabal files after the fact on Hackage to fix e.g. incorrect dependencies. It's important that we communicate to users that they're using an updated .cabal file, so we should include the revision number wherever we should the package versions. We could use either `foo-x.y.z.p-rn`, where `n` is the `x-revision`. An alternative that sets the revision a part a bit more is `foo-x.y.z.p (rn)`. I have a slight preference for the former, as it appears as one "unit". We could investigate what e.g. Debian does.

Contributor guide

Open the contributing guide

Research direction

Start by locating the install-output code that formats package versions and the code that reads Hackage metadata. Trace where the x-revision value is available, compare the proposed version formats, and verify that install output consistently identifies revised .cabal files wherever package versions are shown.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
cli, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.