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 assmebler

• cmmOptions :: [String]

  options for C-- compiler

• ccOptions :: [String]

  options for C compiler

• cxxOptions :: [String]

  options for C++ compiler

• ldOptions :: [String]

  options for linker

• pkgconfigDepends :: [PkgconfigDependency]

  pkg-config packages that are used

• frameworks :: [String]

  support frameworks for Mac OS X

• extraFrameworkDirs :: [String]

  extra locations to find frameworks.

• asmSources :: [FilePath]

  Assembly files.

• cmmSources :: [FilePath]

  C-- files.

• cSources :: [FilePath]
   
• cxxSources :: [FilePath]
   
• jsSources :: [FilePath]
   
• hsSourceDirs :: [FilePath]

  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

• extraGHCiLibs :: [String]

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

• extraBundledLibs :: [String]

  if present, adds libs to hs-lirbaries, which become part of the package. Example: the Cffi library shipping with the rts, alognside the HSrts-1.0.a,.o,... Example 2: a library that is being built by a foreing 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. Oherwise cabal would need to lear how to call arbitary lirbary builders.

• extraLibFlavours :: [String]

  Hidden Flag. This set of strings, will be appended to all lirbaries 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.

• extraLibDirs :: [String]
   
• includeDirs :: [FilePath]

  directories to find .h files

• includes :: [FilePath]

  The .h files to be found in includeDirs

• installIncludes :: [FilePath]

  .h files to install with the package

• options :: [(CompilerFlavor, [String])]
   
• profOptions :: [(CompilerFlavor, [String])]
   
• sharedOptions :: [(CompilerFlavor, [String])]
   
• staticOptions :: [(CompilerFlavor, [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]