| Cabal-1.6.0.3: A framework for packaging Haskell software | Source code | Contents | Index

Distribution.Simple.Register

Portability | portable
Maintainer | cabal-devel@haskell.org

Description

This module deals with registering and unregistering packages. There are a couple ways it can do this, one is to do it directly. Another is to generate a script that can be run later to do it. The idea here being that the user is shielded from the details of what command to use for package registration for a particular compiler. In practice this aspect was not especially popular so we also provide a way to simply generate the package registration file which then must be manually passed to `ghc-pkg`. It is possible to generate registration information for where the package is to be installed, or alternatively to register the package inplace in the build tree. The latter is occasionally handy, and will become more important when we try to build multi-package systems.

This module does not delegate anything to the per-compiler modules but just mixes it all in in this module, which is rather unsatisfactory. The script generation and the unregister feature are not well used or tested.

Synopsis

register :: PackageDescription -> LocalBuildInfo -> RegisterFlags -> IO ()
unregister :: PackageDescription -> LocalBuildInfo -> RegisterFlags -> IO ()
writeInstalledConfig :: FilePath -> PackageDescription -> LocalBuildInfo -> Bool -> Maybe FilePath -> IO ()
removeInstalledConfig :: FilePath -> IO ()
removeRegScripts :: IO ()

Documentation

register | Source

:: PackageDescription |
-> LocalBuildInfo |
-> RegisterFlags | Install in the user's database?; verbose
-> IO () |

unregister :: PackageDescription -> LocalBuildInfo -> RegisterFlags -> IO () | Source

writeInstalledConfig :: FilePath -> PackageDescription -> LocalBuildInfo -> Bool -> Maybe FilePath -> IO () | Source

Register doesn't drop the register info file, it must be done in a separate step.

removeInstalledConfig :: FilePath -> IO () | Source

removeRegScripts :: IO () | Source

Produced by Haddock version 2.4.2