Ticket #1565 (closed proposed-project: fixed)
Build a package API tool
|Reported by:||simonmar||Owned by:|
|Difficulty:||1 person Summer||Mentor:||not-accepted|
Description (last modified by simonmar) (diff)
We need a tool that does the following:
- shows the API diffs between versions of a package
- checks that the version number is being bumped properly (see http://www.haskell.org/haskellwiki/Package_versioning_policy)
- feeds back the information to Haddock, so that the docs can indicate eg. "added in version 1.2"
It could be built on top of the GHC API fairly easily. This would make a great SoC project, I think - it has few dependencies, and if the student finishes the basic functionality early, there's lots more that could be added to it, for example Cabal/Hackage integration.
This is a very useful project from the point of view of making Hackage more robust. More packages following the PVP and correctly specified dependencies will mean much more reliable package management for the whole Haskell community.
There is an existing tool that could serve as a basis for the project:
It appears to have seen no new development since it was posted in Nov 2009.
A relevant ticket in Haddock:
In general it would be good to consider what other projects need in this area, for example Hoogle, and see whether any universally useful infrastructure could be built.
- Simon Marlow
- Duncan Coutts (adviser / co-mentor)
- Patai Gergely (patai /at/ iit.bme.hu)
- Tim Horton (tmhorton@…)