Safe Haskell	None
Language	Haskell98

Debian.Debianize

Contents

Collect information about desired debianization
State monads to carry the collected information, command line options
Functions for maping Cabal name and version number to Debian name
Specific details about the particular packages and versions in the Debian repo
Functions to configure some useful packaging idioms - web server packages,
IO functions for reading debian or cabal packaging info
Finish computing the debianization and output the result
Utility functions

Description

QUICK START:

You can either run the cabal-debian --debianize, or for more power and flexibility you can put a Debianize.hs script in the package's debian subdirectory. CabalInfo value and pass it to the debianize function. The callDebianize function retrieves extra arguments from the CABALDEBIAN environment variable and calls debianize with the build directory set as it would be when the packages is built by dpkg-buildpackage.

To see what your debianization would produce, or how it differs from the debianization already present:

% cabal-debian --debianize -n

This is equivalent to the library call

% ghc -e 'Debian.Debianize.callDebianize ["-n"]'

To actually create the debianization and then build the debs,

% ghc -e 'Debian.Debianize.callDebianize []'
% sudo dpkg-buildpackage

At this point you may need to modify Cabal.defaultFlags to achieve specific packaging goals. Create a module for this in debian/Debianize.hs:

import Data.Lens.Lazy
import Data.Map as Map (insertWith)
import Data.Set as Set (union, singleton)
import Debian.Relation (BinPkgName(BinPkgName), Relation(Rel))
import Debian.Debianize (defaultAtoms, depends, debianization, writeDebianization)
main = debianization "." defaultAtoms >>=
       return . modL depends (insertWith union (BinPkgName "cabal-debian") (singleton (Rel (BinPkgName "debian-policy") Nothing Nothing))) >>=
       writeDebianization "."

Then to test it,

% CABALDEBIAN='["-n"]' runhaskell debian/Debianize.hs

or equivalently

% ghc -e 'Debian.Debianize.runDebianize ["-n"]'

and to run it for real:

% runhaskell debian/Debianize.hs

DESIGN OVERVIEW

The three phases of the operation of the system are Input -> Finalization -> Output.

Input

Module Debian.Debianize.Input - gather inputs using IO operations and customization functions, from the .cabal file, an existing debianization, and so on. This information results in a value of type Atoms. Modules Types, Lenses, Inputs.

Customize: Make modifications to the input values
Finalization: Module Debian.Debianize.Finalize - Fill in any information missing from Atoms that is required to build the debianization based on the inputs and our policy decisions.
Debianize: Module Debian.Debianize.Files - Compute the paths and files of the debianization from the Atoms value.
Output: Module Debian.Debianize.Output - Perform a variety of output operations on the debianzation - writing or updating the files in a debian directory, comparing two debianizations, validate a debianization (ensure two debianizations match in source and binary package names), or describe a debianization.

There is also a high level function to run a script that runs this entire pipeline when it finds from a script found in a debian/Debianize.hs file.

Synopsis