haskell-cabal.eclass – Gentoo Development Guide

Name

haskell-cabal.eclass -- for packages that make use of the Haskell Common Architecture for Building Applications and Libraries (cabal)

Description

Basic instructions:

Before inheriting the eclass, set CABAL_FEATURES to reflect the tools and features that the package makes use of.

Currently supported features:

haddock

for documentation generation

hscolour

generation of colourised sources

hoogle

generation of documentation search index

profile

if package supports to build profiling-enabled libraries

bootstrap

only used for the cabal package itself

lib

the package installs libraries

nocabaldep

don't add dependency on cabal. only used for packages that must not pull the dependency on cabal, but still use this eclass (e.g. haskell-updater).

ghcdeps

constraint dependency on package to ghc onces only used for packages that use libghc internally and must not pull upper versions

test-suite

add support for cabal test-suites (introduced in Cabal-1.8)

rebuild-after-doc-workaround

enable doctest test failue workaround.

Symptom: when ./setup haddock is run in a build-type: Custom package it might cause cause the test-suite to fail with errors like:

<command line>: cannot satisfy -package-id singletons-2.7-3Z7pnljD8tU1NrslJodXmr

Workaround re-reginsters the package to avoid the failure (and rebuilds changes).

FEATURE can be removed once https://github.com/haskell/cabal/issues/7213 is fixed.

Supported EAPIs

6 7 8

Exported Phases

pkg_setup
pkg_postrm
pkg_postinst
src_compile
src_test
src_install
src_prepare
src_configure

Functions

cabal_flag

ebuild.sh:use_enable() taken as base

Usage examples:

CABAL_CONFIGURE_FLAGS=$(cabal_flag gui)

leads to --flags=gui or --flags=-gui (useflag gui)

CABAL_CONFIGURE_FLAGS=$(cabal_flag gtk gui)

also leads to --flags=gui or --flags=-gui (useflag gtk)

cabal_chdeps

Allows easier patching of ${CABAL_FILE} (${S}/${PN}.cabal by default) depends

Accepts argument list as pairs of substitutions: <from-string> <to-string>...

Dies on error.

Usage examples:

src_prepare() {
   cabal_chdeps \
       'base >= 4.2 && < 4.6' 'base >= 4.2 && < 4.7' \
       'containers ==0.4.*' 'containers >= 0.4 && < 0.6'
}

or

src_prepare() {
   CABAL_FILE=${S}/${CABAL_PN}.cabal cabal_chdeps \
       'base >= 4.2 && < 4.6' 'base >= 4.2 && < 4.7'
   CABAL_FILE=${S}/${CABAL_PN}-tools.cabal cabal_chdeps \
       'base == 3.*' 'base >= 4.2 && < 4.7'
}

cabal-constraint

Allowes to set contraint to the libraries that are used by specified package

replace-hcflags <old> <new>

Replace the <old> flag with <new> in HCFLAGS. Accepts shell globs for <old>. The implementation is picked from flag-o-matic.eclass:replace-flags()

Variables

CABAL_EXTRA_CONFIGURE_FLAGS (USER VARIABLE)

User-specified additional parameters passed to setup configure.

Example /etc/portage/make.conf

CABAL_EXTRA_CONFIGURE_FLAGS="--enable-shared --enable-executable-dynamic"

CABAL_EXTRA_BUILD_FLAGS (USER VARIABLE)

User-specified additional parameters passed to setup build.