Documentation

Fields

• buildable :: Bool

  component is buildable here

• buildTools :: [LegacyExeDependency]

  Tools needed to build this bit.

  This is a legacy field that buildToolDepends largely supersedes.

  Unless use are very sure what you are doing, use the functions in Distribution.Simple.BuildToolDepends rather than accessing this field directly.

• buildToolDepends :: [ExeDependency]

  Haskell tools needed to build this bit

  This field is better than buildTools because it allows one to precisely specify an executable in a package.

  Unless use are very sure what you are doing, use the functions in Distribution.Simple.BuildToolDepends rather than accessing this field directly.

• cppOptions :: [String]

  options for pre-processing Haskell code

• asmOptions :: [String]

  options for assembler

• cmmOptions :: [String]

  options for C-- compiler

• ccOptions :: [String]

  options for C compiler

• cxxOptions :: [String]

  options for C++ compiler

• ldOptions :: [String]

  options for linker

• hsc2hsOptions :: [String]

  options for hsc2hs

• pkgconfigDepends :: [PkgconfigDependency]

  pkg-config packages that are used

• frameworks :: [RelativePath Framework 'File]

  support frameworks for Mac OS X

• extraFrameworkDirs :: [SymbolicPath Pkg ('Dir Framework)]

  extra locations to find frameworks.

• asmSources :: [SymbolicPath Pkg 'File]

  Assembly files.

• cmmSources :: [SymbolicPath Pkg 'File]

  C-- files.

• cSources :: [SymbolicPath Pkg 'File]
   
• cxxSources :: [SymbolicPath Pkg 'File]
   
• jsSources :: [SymbolicPath Pkg 'File]
   
• hsSourceDirs :: [SymbolicPath Pkg ('Dir Source)]

  where to look for the Haskell module hierarchy

• otherModules :: [ModuleName]

  non-exposed or non-main modules

• virtualModules :: [ModuleName]

  exposed modules that do not have a source file (e.g. GHC.Prim from ghc-prim package)

• autogenModules :: [ModuleName]

  not present on sdist, Paths_* or user-generated with a custom Setup.hs

• defaultLanguage :: Maybe Language

  language used when not explicitly specified

• otherLanguages :: [Language]

  other languages used within the package

• defaultExtensions :: [Extension]

  language extensions used by all modules

• otherExtensions :: [Extension]

  other language extensions used within the package

• oldExtensions :: [Extension]

  the old extensions field, treated same as defaultExtensions

• extraLibs :: [String]

  what libraries to link with when compiling a program that uses your package

• extraLibsStatic :: [String]

  what libraries to link with when compiling a program fully statically that uses your package

• extraGHCiLibs :: [String]

  if present, overrides extraLibs when package is loaded with GHCi.

• extraBundledLibs :: [String]

  if present, adds libs to hs-libraries, which become part of the package. Example 1: the Cffi library shipping with the rts, alongside the HSrts-1.0.a,.o,... Example 2: a library that is being built by a foreign tool (e.g. rust) and copied and registered together with this library. The logic on how this library is built will have to be encoded in a custom Setup for now. Otherwise cabal would need to learn how to call arbitrary library builders.

• extraLibFlavours :: [String]

  Hidden Flag. This set of strings, will be appended to all libraries when copying. E.g. [libHSname_flavour | flavour <- extraLibFlavours]. This should only be needed in very specific cases, e.g. the rts package, where there are multiple copies of slightly differently built libs.

• extraDynLibFlavours :: [String]

  Hidden Flag. This set of strings will be appended to all dynamic libraries when copying. This is particularly useful with the rts package, where we want different dynamic flavours of the RTS library to be installed.

• extraLibDirs :: [SymbolicPath Pkg ('Dir Lib)]
   
• extraLibDirsStatic :: [SymbolicPath Pkg ('Dir Lib)]
   
• includeDirs :: [SymbolicPath Pkg ('Dir Include)]

  directories to find .h files

• includes :: [SymbolicPath Include 'File]

  The .h files to be found in includeDirs

• autogenIncludes :: [RelativePath Include 'File]

  The .h files to be generated (e.g. by autoconf)

• installIncludes :: [RelativePath Include 'File]

  .h files to install with the package

• options :: PerCompilerFlavor [String]
   
• profOptions :: PerCompilerFlavor [String]
   
• sharedOptions :: PerCompilerFlavor [String]
   
• profSharedOptions :: PerCompilerFlavor [String]
   
• staticOptions :: PerCompilerFlavor [String]
   
• customFieldsBI :: [(String, String)]

  Custom fields starting with x-, stored in a simple assoc-list.

• targetBuildDepends :: [Dependency]

  Dependencies specific to a library or executable target

• mixins :: [Mixin]