The cabal-sort package

[Tags: bsd3, program]

If you have a bunch of packages you may want to compile or recompile, then you need an order of compilation that meets the dependencies. Given a number of cabal package files, this program reads all those files and emits them topologically sorted according to their dependencies. This way you can compile many packages at once, say if a very low-level package has changed.

For compiling a couple of packages from their local darcs repositories in the right order, you may run something like

 for dir in `find . -name "*.cabal" | fgrep -v _darcs | xargs cabal-sort --info=dir`; do (cd $dir && cabal install); done

Note that cabal-install does this automatically since version 0.10 when you call it will multiple directory names as arguments. However, when the constraint solver in cabal-install fails you may still use cabal-sort for an automated build.

For uploading a set of packages to Hackage in the right order you may run

 for dir in `find . -name "*.cabal" | fgrep -v _darcs | xargs cabal-sort --info=dir`; do (cd $dir && rm dist/*.tar.gz && cabal sdist && cabal upload dist/*.tar.gz); done

Sometimes you have to inspect a number of packages manually, e.g. in order to adapt your packages to a new GHC version. In this case I found it useful to run

 for dir in `find . -name "*.cabal" | fgrep -v _darcs | xargs cabal-sort --info=dir`; do (cd $dir; bash); done@.

This way you start a local shell for every package. Then you can easily access commands in the shell history that you already run for previous packages, e.g. editor *.cabal. After you finished a package, you switch to the next package simply by leaving the shell by calling exit.

Problem 1: Given packages A, B, C, where C depends on B and B depends on A, and you call

 cabal-sort C.cabal A.cabal

then the emitted order of packages may be wrong, because cabal-sort does not get to know the dependency of C on B. Even if the order is correct, B.cabal is missing in the output and thus the list of cabal files cannot immediately be used for a sequence of cabal-install runs.

Problem 2: We ignore flags and merge all dependencies. This may lead to dependency cycles that cannot occur for any flag assignment.

You also have options --parallel and --makefile that support parallel compilation. The first option is for manual parallelization and the second one allows you to compile parallelly using make's -j/--jobs option.

There is a second program called ghc-pkg-dep that finds recursively all packages that a set of packages depends on. Duplicates are eliminated and the packages are given topologically sorted, such that you can use this for recompilation of the packages. The packages must already be registered with ghc-pkg.

 ghc-pkg-dep pkgA-0.1 pkgB-2.3 pkgC-0.1.2

On GHC versions before 7.0 ghc-pkg runs quite slowly. In order to not get bored you may run the program with --verbose=2 option.


Properties

Versions0.0.1, 0.0.2, 0.0.2.1, 0.0.3, 0.0.3.1, 0.0.4, 0.0.4.1, 0.0.4.2, 0.0.5, 0.0.5.1
Dependenciesbase (>=2 && <5), bytestring (>=0.9.1 && <0.11), Cabal (>=1.6 && <1.17), containers (>=0.2 && <0.6), directory (>=1 && <1.3), explicit-exception (>=0.1.6 && <0.2), fgl (>=5.4.2 && <5.5), filepath (>=1.1 && <1.4), process (>=1.0 && <1.2), transformers (>=0.2 && <0.4), utility-ht (>=0.0.5 && <0.1)
LicenseBSD3
AuthorHenning Thielemann <haskell@henning-thielemann.de>
MaintainerHenning Thielemann <haskell@henning-thielemann.de>
CategoryDistribution
Source repositoryhead: darcs get http://code.haskell.org/~thielema/cabal-sort/
this: darcs get http://code.haskell.org/~thielema/cabal-sort/ --tag 0.0.5.1
Executablesghc-pkg-dep, cabal-sort
Upload dateSun Oct 28 13:58:37 UTC 2012
Uploaded byHenningThielemann
Downloads525 total (50 in last 30 days)

Downloads

Maintainers' corner

For package maintainers and hackage trustees