September 2007 - cabal-devel

Survery of Setup.hs with Cabal-1.2
by Duncan Coutts 27 Sep '07

27 Sep '07

This is a survey of the problems in updating to Cabal-1.2. (This is independent of the problems in updating to GHC-6.8, though of course many people will encounter both at the same time.) I've compiled The Setup.(l)hs scripts of all 248 packages (394 package-version pairs) on hackage with the new Cabal-1.2 library. Of those, the Setup scripts from 20 packages fail to compile (there are 31 package-version pairs). 4 more compile but with warnings. I've categorised the failures by their cause & remedy: ------------------------------ There are several packages which currently use custom code in the Setup.hs script that can now be replaced entirely by using the new configurations feature. They are doing things like picking the dependencies based on the ghc version or the operating system. This is exactly what configurations are for. These packages can then use the "build-type: Simple" and the trivial Setup.hs script. cabalmdvrpm-0.0.1 cabalrpmdeps-0.0.3 HDBC-odbc-1.0.1.0 hslogger-1.0.2 MissingH-0.18.2 tar-0.1 unix-compat-0.1 hsql-odbc-1.7 (actually does compile but with a warning) ------------------------------ A similar case is using code to run an external program to discover the correct build flags for a package. In general this still needs to use custom code but in the common case of using the "pkg-config" program we can take advantage of the pkg-config support in Cabal-1.2 and again get away with using the build-type: Simple and the trivial Setup.hs script. hsql-sqlite3-1.7 ------------------------------ An API change in the "UserHook" hooks interface that affected many Setup scripts was that the result type was changed from IO ExitCode to just IO (). Then instead of returning codes all over the place (which were not being consistently checked) we now use IO exceptions instead. So Setup scripts which used to return ExitSuccess can now return () and ExitFailure n can be replaced by exitWith (ExitFailure n). debian-1.0 hburg-1.0 YamlReference-0.1 to 0.5 ------------------------------ There are a number of packages where the Setup script makes extensive use of the internal API of Cabal's default build system. I'll mention each one briefly: fenfire-0.1: needs updating to use new PreProcessor abstraction. Can drop the local def of c2hs pre-processor as this hack is no longer required in the minimum version of c2hs that Cabal supports (and it probably would no longer work anyway). lhs2tex-1.12: requires significant work. It makes use of the Program abstraction and system for managing installation dirs both of which have changed significantly. hsql-mysql-1.7, hsql-postgresql-1.7: requires significant work. can be simplified by using the cabal api effectively and using configurations. These both call external config programs to find the right build flags. I posted an update to hsql-mysql-1.7 the other day as an example. alex-2.1.0, happy-1.16: requires significant work (though already done in darcs versions). Again these used the internal Program abstraction which changed significantly. yi-0.2, hint-0.1: These both try to find ghc's libdir. The both could be significantly simplified by doing things in the 'proper' way which is to use the HookedBuildInfo stuff rather than writing little .ghc-libdir files. xmobar-0.3.1-0.7: The Setup.hs for this package completely re-implements the haddock command to customise the way docs are generated for executables. This is no longer necessary in Cabal-1.2 as it provides the features required. So the Setup.hs can be replaced with default and use build-type: Simple. ------------------------------ Packages for which Setup.hs compiles with a warning with Cabal-1.2: These three packages add a feature that was missing in Cabal-1.1.6 but is now present in Cabal-1.2. They add a --ghc-option= and --configure-option= flag to the configure command. Cabal-1.2 implements this generically for all programs that it knows about (and the programs it knows about can be extended by the Setup script). So again, these can use build-type: Simple and the trivial Setup script. cgi-3001.1.3 filepath-1.0 X11-1.2.2 One immediate cause of problems is Setup scripts importing Distribution.PreProcess, Distribution.Program which have moved under Distribution.Simple. I could add re-exports for both as I did for Distribution.Setup however both modules have changed significantly so any Script that actually uses these modules needs changing anyway, so theres no particular advantage to providing a module re-export crutch. I might make module Distribution.Simple.Utils export rawSystemVerbose again since some scripts use it. Though all those that do have other problems as well. So overall that's not too bad. Less than 10% of the hackage packages are affected by the significant internal changes in Cabal-1.2. Of those, only 9 packages need significant work to update their Setup scripts and 12 others can eliminate their custom Setup code completely using new features in Cabal-1.2. The remaining 3 need only minor changes. Duncan

1 0

patch applied (cabal-branches/cabal-1.2): Actually -stubdir only works well in ghc-6.8 due to -I search dir mess
by Ian Lynagh 26 Sep '07

26 Sep '07

Wed Sep 26 06:18:43 PDT 2007 Duncan Coutts <duncan(a)haskell.org> * Actually -stubdir only works well in ghc-6.8 due to -I search dir mess In ghc-6.6 the Foo/Bar.hc files only #include "Bar_stub.h" rather than #include "Foo/Bar_stub.h". This means when we set the stubdir so that the _stub.h files don't sit next to the .hs file then the include search path is not right to find the _stub.h file. In ghc-6.8 this is fixed so that it adds the -stubdir path to the include search path when calling gcc. M ./Distribution/Simple/GHC.hs -1 +1

1 0

patch applied (cabal-branches/cabal-1.2): The -stubdir flag is supported in ghc-6.6 not just 6.6.1
by Ian Lynagh 26 Sep '07

26 Sep '07

Wed Sep 26 04:42:23 PDT 2007 Duncan Coutts <duncan(a)haskell.org> * The -stubdir flag is supported in ghc-6.6 not just 6.6.1 M ./Distribution/Simple/GHC.hs -1 +1

1 0

patch applied (cabal): Actually -stubdir only works well in ghc-6.8 due to -I search dir mess
by Duncan Coutts 26 Sep '07

26 Sep '07

Wed Sep 26 06:18:43 PDT 2007 Duncan Coutts <duncan(a)haskell.org> * Actually -stubdir only works well in ghc-6.8 due to -I search dir mess In ghc-6.6 the Foo/Bar.hc files only #include "Bar_stub.h" rather than #include "Foo/Bar_stub.h". This means when we set the stubdir so that the _stub.h files don't sit next to the .hs file then the include search path is not right to find the _stub.h file. In ghc-6.8 this is fixed so that it adds the -stubdir path to the include search path when calling gcc. M ./Distribution/Simple/GHC.hs -1 +1

1 0

Re: [Hackage] #53: if cabal get update needs to run, say so
by Hackage 26 Sep '07

26 Sep '07

#53: if cabal get update needs to run, say so ----------------------------+----------------------------------------------- Reporter: ijones | Owner: ijones Type: defect | Status: new Priority: normal | Milestone: Cabal-1.4 Component: cabal-install | Version: Severity: major | Resolution: Keywords: | Difficulty: normal Ghcversion: 6.2.1 | Platform: Linux ----------------------------+----------------------------------------------- Changes (by duncan): * milestone: Cabal-1.2 => Cabal-1.4 Comment: Punt. -- Ticket URL: <http://hackage.haskell.org/trac/hackage/ticket/53#comment:5> Hackage <http://haskell.org/cabal/> Hackage: Cabal and related projects

1 0

Re: [Hackage] #27: Document configurations syntax
by Hackage 26 Sep '07

26 Sep '07

#27: Document configurations syntax ----------------------------------------------------+----------------------- Reporter: Simon Marlow <simonmar(a)microsoft.com> | Owner: nominolo Type: enhancement | Status: new Priority: high | Milestone: Cabal-1.2 Component: Cabal | Version: Severity: normal | Resolution: Keywords: | Difficulty: very easy (<1 hour) Ghcversion: 6.2.1 | Platform: Linux ----------------------------------------------------+----------------------- Comment (by duncan): I'm part way through doing this. -- Ticket URL: <http://hackage.haskell.org/trac/hackage/ticket/27#comment:8> Hackage <http://haskell.org/cabal/> Hackage: Cabal and related projects

1 0

Re: [Hackage] #62: implement "new age" cabal-get/put in order to make it possible to distribute cabal-get w/ cabal
by Hackage 26 Sep '07

26 Sep '07

#62: implement "new age" cabal-get/put in order to make it possible to distribute cabal-get w/ cabal ----------------------------+----------------------------------------------- Reporter: ijones | Owner: ijones Type: task | Status: closed Priority: normal | Milestone: Cabal-1.2 Component: cabal-install | Version: Severity: major | Resolution: fixed Keywords: | Difficulty: normal Ghcversion: 6.2.1 | Platform: Linux ----------------------------+----------------------------------------------- Changes (by duncan): * status: new => closed * resolution: => fixed Comment: Hackage is working well. cabal-install will be released some time after ghc-6.8.1. It will not be included in the Cabal package since it has more dependencies than the Cabal library. -- Ticket URL: <http://hackage.haskell.org/trac/hackage/ticket/62#comment:7> Hackage <http://haskell.org/cabal/> Hackage: Cabal and related projects

1 0

Re: [Hackage] #60: make cabal-get-bootstrap release
by Hackage 26 Sep '07

26 Sep '07

#60: make cabal-get-bootstrap release ----------------------------+----------------------------------------------- Reporter: ijones | Owner: ijones Type: task | Status: closed Priority: normal | Milestone: Cabal-1.2 Component: cabal-install | Version: Severity: major | Resolution: invalid Keywords: | Difficulty: normal Ghcversion: 6.2.1 | Platform: Linux ----------------------------+----------------------------------------------- Changes (by duncan): * status: new => closed * resolution: => invalid Comment: This is so out of date it's irrelevant. What we need is a cabal-install release. This will not be bundled with ghc-6.8.1 as it's not ready. We'll do an independent release after ghc-6.8.1 and Cabal-1.2.0.x are out. -- Ticket URL: <http://hackage.haskell.org/trac/hackage/ticket/60#comment:4> Hackage <http://haskell.org/cabal/> Hackage: Cabal and related projects

1 0

patch applied (cabal): The -stubdir flag is supported in ghc-6.6 not just 6.6.1
by Duncan Coutts 26 Sep '07

26 Sep '07

Wed Sep 26 04:42:23 PDT 2007 Duncan Coutts <duncan(a)haskell.org> * The -stubdir flag is supported in ghc-6.6 not just 6.6.1 M ./Distribution/Simple/GHC.hs -1 +1

1 0

patch applied (cabal-branches/cabal-1.2): Put _stub.{c|h} files under dist/ so they'll get cleaned. Fixes bug #154.
by Ian Lynagh 26 Sep '07

26 Sep '07

Mon Sep 17 05:30:42 PDT 2007 Duncan Coutts <duncan(a)haskell.org> * Put _stub.{c|h} files under dist/ so they'll get cleaned. Fixes bug #154. Only used with ghc-6.6 and later which supports the -stubdir flag. With earlier ghc versions the files still end up in the src dirs and so do not get cleaned. M ./Distribution/Simple/GHC.hs +2

2 2