Haskell.nix modules options for packages and components.

Generated

This documentation is generated from Nix sources in the modules subdirectory using scripts/update-docs.nix

Configuration Options

bootPkgs

This option has no description.

Type: list of strings

No Default

No Example

buildable

This option has no description.

Type: boolean

Default: true

No Example

cabal.compiler

This option has no description.

Type: unspecified

No Default

No Example

cabal.system

This option has no description.

Type: unspecified

No Default

No Example

compiler.nix-name

This option has no description.

Type: string

No Default

No Example

compiler.packages

This option has no description.

Type: attribute set of strings

No Default

No Example

compiler.version

This option has no description.

Type: string

No Default

No Example

configureAllComponents

If set all the components in the package are configured (useful for cabal-doctest).

Type: boolean

Default: false

No Example

configureFlags

This option has no description.

Type: list of strings

Default: []

No Example

doCheck

This option has no description.

Type: boolean

Default: true

No Example

doCoverage

Enable production of test coverage reports.

Type: boolean

Default: false

No Example

doCrossCheck

Run doCheck also in cross compilation settings. This can be tricky as the test logic must know how to run the tests on the target.

Type: boolean

Default: false

No Example

doExactConfig

This option has no description.

Type: boolean

Default: false

No Example

doHaddock

Enable building of the Haddock documentation from the annotated Haskell source code.

Type: boolean

Default: true

No Example

doHoogle

Also build a hoogle index.

Type: boolean

Default: true

No Example

doHyperlinkSource

Link documentation to the source code.

Type: boolean

Default: true

No Example

doQuickjump

Generate an index for interactive documentation navigation.

Type: boolean

Default: true

No Example

dontPatchELF

If set, the patchelf command is not used to remove unnecessary RPATH entries. Only applies to Linux.

Type: boolean

Default: true

No Example

dontStrip

If set, libraries and executables are not stripped.

Type: boolean

Default: true

No Example

enableDeadCodeElimination

If set, enables split sections for link-time dead-code stripping. Only applies to Linux

Type: boolean

Default: true

No Example

enableExecutableProfiling

This option has no description.

Type: boolean

Default: false

No Example

enableLibraryProfiling

This option has no description.

Type: boolean

Default: false

No Example

enableSeparateDataOutput

This option has no description.

Type: boolean

Default: false

No Example

enableShared

If set, enables building shared libraries.

Type: boolean

Default: true

No Example

enableStatic

If set, enables building static libraries and executables.

Type: boolean

Default: true

No Example

errorHandler

This option has no description.

Type: unspecified

No Default

No Example

ghc.package

This option has no description.

Type: package

Default: "pkgs.buildPackages.haskell-nix.compiler.${config.compiler.nix-name}"

No Example

ghcOptions

This option has no description.

Type: list of strings

Default: []

No Example

hackage.configs

This option has no description.

Type: unspecified

No Default

No Example

hackage.db

This option has no description.

Type: unspecified

No Default

No Example

hardeningDisable

This option has no description.

Type: list of strings

Default: []

No Example

hsPkgs

This option has no description.

Type: unspecified

No Default

No Example

keepSource

Keep component source in the store in a source output

Type: boolean

Default: false

No Example

nonReinstallablePkgs

This option has no description.

Type: list of strings

No Default

No Example

packages

This option has no description.

Type: attribute set of submodules

No Default

No Example

packages..allComponent

The merged dependencies of all other components

Type: submodule

No Default

No Example

packages..allComponent.asmSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..allComponent.build-tools

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..allComponent.buildable

This option has no description.

Type: boolean

Default: true

No Example

packages..allComponent.cSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..allComponent.cmmSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..allComponent.configureAllComponents

If set all the components in the package are configured (useful for cabal-doctest).

Type: boolean

Default: false

No Example

packages..allComponent.configureFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..allComponent.cxxSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..allComponent.depends

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..allComponent.doCheck

This option has no description.

Type: boolean

Default: true

No Example

packages..allComponent.doCoverage

Enable production of test coverage reports.

Type: boolean

Default: false

No Example

packages..allComponent.doCrossCheck

Run doCheck also in cross compilation settings. This can be tricky as the test logic must know how to run the tests on the target.

Type: boolean

Default: false

No Example

packages..allComponent.doExactConfig

This option has no description.

Type: boolean

Default: false

No Example

packages..allComponent.doHaddock

Enable building of the Haddock documentation from the annotated Haskell source code.

Type: boolean

Default: true

No Example

packages..allComponent.doHoogle

Also build a hoogle index.

Type: boolean

Default: true

No Example

packages..allComponent.doHyperlinkSource

Link documentation to the source code.

Type: boolean

Default: true

No Example

packages..allComponent.doQuickjump

Generate an index for interactive documentation navigation.

Type: boolean

Default: true

No Example

packages..allComponent.dontPatchELF

If set, the patchelf command is not used to remove unnecessary RPATH entries. Only applies to Linux.

Type: boolean

Default: true

No Example

packages..allComponent.dontStrip

If set, libraries and executables are not stripped.

Type: boolean

Default: true

No Example

packages..allComponent.enableDeadCodeElimination

If set, enables split sections for link-time dead-code stripping. Only applies to Linux

Type: boolean

Default: true

No Example

packages..allComponent.enableExecutableProfiling

This option has no description.

Type: boolean

Default: false

No Example

packages..allComponent.enableLibraryProfiling

This option has no description.

Type: boolean

Default: false

No Example

packages..allComponent.enableSeparateDataOutput

This option has no description.

Type: boolean

Default: false

No Example

packages..allComponent.enableShared

If set, enables building shared libraries.

Type: boolean

Default: true

No Example

packages..allComponent.enableStatic

If set, enables building static libraries and executables.

Type: boolean

Default: true

No Example

packages..allComponent.extraSrcFiles

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..allComponent.frameworks

This option has no description.

Type: list of packages

Default: []

No Example

packages..allComponent.ghcOptions

This option has no description.

Type: list of strings

Default: []

No Example

packages..allComponent.hardeningDisable

This option has no description.

Type: list of strings

Default: []

No Example

packages..allComponent.hsSourceDirs

This option has no description.

Type: list of unspecifieds

Default: ["."]

No Example

packages..allComponent.includeDirs

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..allComponent.includes

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..allComponent.jsSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..allComponent.keepSource

Keep component source in the store in a source output

Type: boolean

Default: false

No Example

packages..allComponent.libs

This option has no description.

Type: list of null or packages

Default: []

No Example

packages..allComponent.mainPath

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..allComponent.modules

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..allComponent.pkgconfig

This option has no description.

Type: list of list of packagess

Default: []

No Example

packages..allComponent.planned

Set to true by plan-to-nix for any component that was included in the plan.json file.

Type: boolean

Default: false

No Example

packages..allComponent.platforms

This option has no description.

Type: null or list of unspecifieds

Default: null

No Example

packages..allComponent.postBuild

This option has no description.

Type: null or string

Default: null

No Example

packages..allComponent.postCheck

This option has no description.

Type: null or string

Default: null

No Example

packages..allComponent.postConfigure

This option has no description.

Type: null or string

Default: null

No Example

packages..allComponent.postHaddock

This option has no description.

Type: null or string

Default: null

No Example

packages..allComponent.postInstall

This option has no description.

Type: null or string

Default: null

No Example

packages..allComponent.postUnpack

This option has no description.

Type: null or string

Default: null

No Example

packages..allComponent.preBuild

This option has no description.

Type: null or string

Default: null

No Example

packages..allComponent.preCheck

This option has no description.

Type: null or string

Default: null

No Example

packages..allComponent.preConfigure

This option has no description.

Type: null or string

Default: null

No Example

packages..allComponent.preHaddock

This option has no description.

Type: null or string

Default: null

No Example

packages..allComponent.preInstall

This option has no description.

Type: null or string

Default: null

No Example

packages..allComponent.preUnpack

This option has no description.

Type: null or strings concatenated with "\n"

Default: null

No Example

packages..allComponent.profilingDetail

This option has no description.

Type: null or string

Default: "default"

No Example

packages..allComponent.setupBuildFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..allComponent.setupHaddockFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..allComponent.setupInstallFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..allComponent.shellHook

Hook to run when entering a shell

Type: unspecified

Default: ""

No Example

packages..allComponent.testFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..allComponent.testWrapper

A command to run for executing tests in checkPhase, which takes the original test command as its arguments.

Type: list of strings

Default: []

Example:

"echo"

packages..allComponent.writeHieFiles

Write component .hie files in the store in a hie output

Type: boolean

Default: false

No Example

packages..buildable

This option has no description.

Type: boolean

Default: true

No Example

packages..cabal-generator

This option has no description.

Type: null or string

Default: null

No Example

packages..components.benchmarks

This option has no description.

Type: attribute set of submodules

Default: {}

No Example

packages..components.benchmarks..asmSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.benchmarks..build-tools

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.benchmarks..buildable

This option has no description.

Type: boolean

Default: true

No Example

packages..components.benchmarks..cSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.benchmarks..cmmSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.benchmarks..configureAllComponents

If set all the components in the package are configured (useful for cabal-doctest).

Type: boolean

Default: false

No Example

packages..components.benchmarks..configureFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.benchmarks..cxxSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.benchmarks..depends

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.benchmarks..doCheck

This option has no description.

Type: boolean

Default: true

No Example

packages..components.benchmarks..doCoverage

Enable production of test coverage reports.

Type: boolean

Default: false

No Example

packages..components.benchmarks..doCrossCheck

Run doCheck also in cross compilation settings. This can be tricky as the test logic must know how to run the tests on the target.

Type: boolean

Default: false

No Example

packages..components.benchmarks..doExactConfig

This option has no description.

Type: boolean

Default: false

No Example

packages..components.benchmarks..doHaddock

Enable building of the Haddock documentation from the annotated Haskell source code.

Type: boolean

Default: true

No Example

packages..components.benchmarks..doHoogle

Also build a hoogle index.

Type: boolean

Default: true

No Example

packages..components.benchmarks..doHyperlinkSource

Link documentation to the source code.

Type: boolean

Default: true

No Example

packages..components.benchmarks..doQuickjump

Generate an index for interactive documentation navigation.

Type: boolean

Default: true

No Example

packages..components.benchmarks..dontPatchELF

If set, the patchelf command is not used to remove unnecessary RPATH entries. Only applies to Linux.

Type: boolean

Default: true

No Example

packages..components.benchmarks..dontStrip

If set, libraries and executables are not stripped.

Type: boolean

Default: true

No Example

packages..components.benchmarks..enableDeadCodeElimination

If set, enables split sections for link-time dead-code stripping. Only applies to Linux

Type: boolean

Default: true

No Example

packages..components.benchmarks..enableExecutableProfiling

This option has no description.

Type: boolean

Default: false

No Example

packages..components.benchmarks..enableLibraryProfiling

This option has no description.

Type: boolean

Default: false

No Example

packages..components.benchmarks..enableSeparateDataOutput

This option has no description.

Type: boolean

Default: false

No Example

packages..components.benchmarks..enableShared

If set, enables building shared libraries.

Type: boolean

Default: true

No Example

packages..components.benchmarks..enableStatic

If set, enables building static libraries and executables.

Type: boolean

Default: true

No Example

packages..components.benchmarks..extraSrcFiles

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.benchmarks..frameworks

This option has no description.

Type: list of packages

Default: []

No Example

packages..components.benchmarks..ghcOptions

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.benchmarks..hardeningDisable

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.benchmarks..hsSourceDirs

This option has no description.

Type: list of unspecifieds

Default: ["."]

No Example

packages..components.benchmarks..includeDirs

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.benchmarks..includes

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.benchmarks..jsSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.benchmarks..keepSource

Keep component source in the store in a source output

Type: boolean

Default: false

No Example

packages..components.benchmarks..libs

This option has no description.

Type: list of null or packages

Default: []

No Example

packages..components.benchmarks..mainPath

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.benchmarks..modules

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.benchmarks..pkgconfig

This option has no description.

Type: list of list of packagess

Default: []

No Example

packages..components.benchmarks..planned

Set to true by plan-to-nix for any component that was included in the plan.json file.

Type: boolean

Default: false

No Example

packages..components.benchmarks..platforms

This option has no description.

Type: null or list of unspecifieds

Default: null

No Example

packages..components.benchmarks..postBuild

This option has no description.

Type: null or string

Default: null

No Example

packages..components.benchmarks..postCheck

This option has no description.

Type: null or string

Default: null

No Example

packages..components.benchmarks..postConfigure

This option has no description.

Type: null or string

Default: null

No Example

packages..components.benchmarks..postHaddock

This option has no description.

Type: null or string

Default: null

No Example

packages..components.benchmarks..postInstall

This option has no description.

Type: null or string

Default: null

No Example

packages..components.benchmarks..postUnpack

This option has no description.

Type: null or string

Default: null

No Example

packages..components.benchmarks..preBuild

This option has no description.

Type: null or string

Default: null

No Example

packages..components.benchmarks..preCheck

This option has no description.

Type: null or string

Default: null

No Example

packages..components.benchmarks..preConfigure

This option has no description.

Type: null or string

Default: null

No Example

packages..components.benchmarks..preHaddock

This option has no description.

Type: null or string

Default: null

No Example

packages..components.benchmarks..preInstall

This option has no description.

Type: null or string

Default: null

No Example

packages..components.benchmarks..preUnpack

This option has no description.

Type: null or strings concatenated with "\n"

Default: null

No Example

packages..components.benchmarks..profilingDetail

This option has no description.

Type: null or string

Default: "default"

No Example

packages..components.benchmarks..setupBuildFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.benchmarks..setupHaddockFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.benchmarks..setupInstallFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.benchmarks..shellHook

Hook to run when entering a shell

Type: unspecified

Default: ""

No Example

packages..components.benchmarks..testFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.benchmarks..testWrapper

A command to run for executing tests in checkPhase, which takes the original test command as its arguments.

Type: list of strings

Default: []

Example:

"echo"

packages..components.benchmarks..writeHieFiles

Write component .hie files in the store in a hie output

Type: boolean

Default: false

No Example

packages..components.exes

This option has no description.

Type: attribute set of submodules

Default: {}

No Example

packages..components.exes..asmSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.exes..build-tools

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.exes..buildable

This option has no description.

Type: boolean

Default: true

No Example

packages..components.exes..cSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.exes..cmmSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.exes..configureAllComponents

If set all the components in the package are configured (useful for cabal-doctest).

Type: boolean

Default: false

No Example

packages..components.exes..configureFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.exes..cxxSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.exes..depends

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.exes..doCheck

This option has no description.

Type: boolean

Default: true

No Example

packages..components.exes..doCoverage

Enable production of test coverage reports.

Type: boolean

Default: false

No Example

packages..components.exes..doCrossCheck

Run doCheck also in cross compilation settings. This can be tricky as the test logic must know how to run the tests on the target.

Type: boolean

Default: false

No Example

packages..components.exes..doExactConfig

This option has no description.

Type: boolean

Default: false

No Example

packages..components.exes..doHaddock

Enable building of the Haddock documentation from the annotated Haskell source code.

Type: boolean

Default: true

No Example

packages..components.exes..doHoogle

Also build a hoogle index.

Type: boolean

Default: true

No Example

packages..components.exes..doHyperlinkSource

Link documentation to the source code.

Type: boolean

Default: true

No Example

packages..components.exes..doQuickjump

Generate an index for interactive documentation navigation.

Type: boolean

Default: true

No Example

packages..components.exes..dontPatchELF

If set, the patchelf command is not used to remove unnecessary RPATH entries. Only applies to Linux.

Type: boolean

Default: true

No Example

packages..components.exes..dontStrip

If set, libraries and executables are not stripped.

Type: boolean

Default: true

No Example

packages..components.exes..enableDeadCodeElimination

If set, enables split sections for link-time dead-code stripping. Only applies to Linux

Type: boolean

Default: true

No Example

packages..components.exes..enableExecutableProfiling

This option has no description.

Type: boolean

Default: false

No Example

packages..components.exes..enableLibraryProfiling

This option has no description.

Type: boolean

Default: false

No Example

packages..components.exes..enableSeparateDataOutput

This option has no description.

Type: boolean

Default: false

No Example

packages..components.exes..enableShared

If set, enables building shared libraries.

Type: boolean

Default: true

No Example

packages..components.exes..enableStatic

If set, enables building static libraries and executables.

Type: boolean

Default: true

No Example

packages..components.exes..extraSrcFiles

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.exes..frameworks

This option has no description.

Type: list of packages

Default: []

No Example

packages..components.exes..ghcOptions

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.exes..hardeningDisable

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.exes..hsSourceDirs

This option has no description.

Type: list of unspecifieds

Default: ["."]

No Example

packages..components.exes..includeDirs

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.exes..includes

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.exes..jsSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.exes..keepSource

Keep component source in the store in a source output

Type: boolean

Default: false

No Example

packages..components.exes..libs

This option has no description.

Type: list of null or packages

Default: []

No Example

packages..components.exes..mainPath

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.exes..modules

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.exes..pkgconfig

This option has no description.

Type: list of list of packagess

Default: []

No Example

packages..components.exes..planned

Set to true by plan-to-nix for any component that was included in the plan.json file.

Type: boolean

Default: false

No Example

packages..components.exes..platforms

This option has no description.

Type: null or list of unspecifieds

Default: null

No Example

packages..components.exes..postBuild

This option has no description.

Type: null or string

Default: null

No Example

packages..components.exes..postCheck

This option has no description.

Type: null or string

Default: null

No Example

packages..components.exes..postConfigure

This option has no description.

Type: null or string

Default: null

No Example

packages..components.exes..postHaddock

This option has no description.

Type: null or string

Default: null

No Example

packages..components.exes..postInstall

This option has no description.

Type: null or string

Default: null

No Example

packages..components.exes..postUnpack

This option has no description.

Type: null or string

Default: null

No Example

packages..components.exes..preBuild

This option has no description.

Type: null or string

Default: null

No Example

packages..components.exes..preCheck

This option has no description.

Type: null or string

Default: null

No Example

packages..components.exes..preConfigure

This option has no description.

Type: null or string

Default: null

No Example

packages..components.exes..preHaddock

This option has no description.

Type: null or string

Default: null

No Example

packages..components.exes..preInstall

This option has no description.

Type: null or string

Default: null

No Example

packages..components.exes..preUnpack

This option has no description.

Type: null or strings concatenated with "\n"

Default: null

No Example

packages..components.exes..profilingDetail

This option has no description.

Type: null or string

Default: "default"

No Example

packages..components.exes..setupBuildFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.exes..setupHaddockFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.exes..setupInstallFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.exes..shellHook

Hook to run when entering a shell

Type: unspecified

Default: ""

No Example

packages..components.exes..testFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.exes..testWrapper

A command to run for executing tests in checkPhase, which takes the original test command as its arguments.

Type: list of strings

Default: []

Example:

"echo"

packages..components.exes..writeHieFiles

Write component .hie files in the store in a hie output

Type: boolean

Default: false

No Example

packages..components.foreignlibs

This option has no description.

Type: attribute set of submodules

Default: {}

No Example

packages..components.foreignlibs..asmSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.foreignlibs..build-tools

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.foreignlibs..buildable

This option has no description.

Type: boolean

Default: true

No Example

packages..components.foreignlibs..cSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.foreignlibs..cmmSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.foreignlibs..configureAllComponents

If set all the components in the package are configured (useful for cabal-doctest).

Type: boolean

Default: false

No Example

packages..components.foreignlibs..configureFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.foreignlibs..cxxSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.foreignlibs..depends

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.foreignlibs..doCheck

This option has no description.

Type: boolean

Default: true

No Example

packages..components.foreignlibs..doCoverage

Enable production of test coverage reports.

Type: boolean

Default: false

No Example

packages..components.foreignlibs..doCrossCheck

Run doCheck also in cross compilation settings. This can be tricky as the test logic must know how to run the tests on the target.

Type: boolean

Default: false

No Example

packages..components.foreignlibs..doExactConfig

This option has no description.

Type: boolean

Default: false

No Example

packages..components.foreignlibs..doHaddock

Enable building of the Haddock documentation from the annotated Haskell source code.

Type: boolean

Default: true

No Example

packages..components.foreignlibs..doHoogle

Also build a hoogle index.

Type: boolean

Default: true

No Example

packages..components.foreignlibs..doHyperlinkSource

Link documentation to the source code.

Type: boolean

Default: true

No Example

packages..components.foreignlibs..doQuickjump

Generate an index for interactive documentation navigation.

Type: boolean

Default: true

No Example

packages..components.foreignlibs..dontPatchELF

If set, the patchelf command is not used to remove unnecessary RPATH entries. Only applies to Linux.

Type: boolean

Default: true

No Example

packages..components.foreignlibs..dontStrip

If set, libraries and executables are not stripped.

Type: boolean

Default: true

No Example

packages..components.foreignlibs..enableDeadCodeElimination

If set, enables split sections for link-time dead-code stripping. Only applies to Linux

Type: boolean

Default: true

No Example

packages..components.foreignlibs..enableExecutableProfiling

This option has no description.

Type: boolean

Default: false

No Example

packages..components.foreignlibs..enableLibraryProfiling

This option has no description.

Type: boolean

Default: false

No Example

packages..components.foreignlibs..enableSeparateDataOutput

This option has no description.

Type: boolean

Default: false

No Example

packages..components.foreignlibs..enableShared

If set, enables building shared libraries.

Type: boolean

Default: true

No Example

packages..components.foreignlibs..enableStatic

If set, enables building static libraries and executables.

Type: boolean

Default: true

No Example

packages..components.foreignlibs..extraSrcFiles

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.foreignlibs..frameworks

This option has no description.

Type: list of packages

Default: []

No Example

packages..components.foreignlibs..ghcOptions

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.foreignlibs..hardeningDisable

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.foreignlibs..hsSourceDirs

This option has no description.

Type: list of unspecifieds

Default: ["."]

No Example

packages..components.foreignlibs..includeDirs

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.foreignlibs..includes

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.foreignlibs..jsSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.foreignlibs..keepSource

Keep component source in the store in a source output

Type: boolean

Default: false

No Example

packages..components.foreignlibs..libs

This option has no description.

Type: list of null or packages

Default: []

No Example

packages..components.foreignlibs..mainPath

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.foreignlibs..modules

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.foreignlibs..pkgconfig

This option has no description.

Type: list of list of packagess

Default: []

No Example

packages..components.foreignlibs..planned

Set to true by plan-to-nix for any component that was included in the plan.json file.

Type: boolean

Default: false

No Example

packages..components.foreignlibs..platforms

This option has no description.

Type: null or list of unspecifieds

Default: null

No Example

packages..components.foreignlibs..postBuild

This option has no description.

Type: null or string

Default: null

No Example

packages..components.foreignlibs..postCheck

This option has no description.

Type: null or string

Default: null

No Example

packages..components.foreignlibs..postConfigure

This option has no description.

Type: null or string

Default: null

No Example

packages..components.foreignlibs..postHaddock

This option has no description.

Type: null or string

Default: null

No Example

packages..components.foreignlibs..postInstall

This option has no description.

Type: null or string

Default: null

No Example

packages..components.foreignlibs..postUnpack

This option has no description.

Type: null or string

Default: null

No Example

packages..components.foreignlibs..preBuild

This option has no description.

Type: null or string

Default: null

No Example

packages..components.foreignlibs..preCheck

This option has no description.

Type: null or string

Default: null

No Example

packages..components.foreignlibs..preConfigure

This option has no description.

Type: null or string

Default: null

No Example

packages..components.foreignlibs..preHaddock

This option has no description.

Type: null or string

Default: null

No Example

packages..components.foreignlibs..preInstall

This option has no description.

Type: null or string

Default: null

No Example

packages..components.foreignlibs..preUnpack

This option has no description.

Type: null or strings concatenated with "\n"

Default: null

No Example

packages..components.foreignlibs..profilingDetail

This option has no description.

Type: null or string

Default: "default"

No Example

packages..components.foreignlibs..setupBuildFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.foreignlibs..setupHaddockFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.foreignlibs..setupInstallFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.foreignlibs..shellHook

Hook to run when entering a shell

Type: unspecified

Default: ""

No Example

packages..components.foreignlibs..testFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.foreignlibs..testWrapper

A command to run for executing tests in checkPhase, which takes the original test command as its arguments.

Type: list of strings

Default: []

Example:

"echo"

packages..components.foreignlibs..writeHieFiles

Write component .hie files in the store in a hie output

Type: boolean

Default: false

No Example

packages..components.library

This option has no description.

Type: null or submodule

Default: null

No Example

packages..components.library.asmSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.library.build-tools

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.library.buildable

This option has no description.

Type: boolean

Default: true

No Example

packages..components.library.cSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.library.cmmSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.library.configureAllComponents

If set all the components in the package are configured (useful for cabal-doctest).

Type: boolean

Default: false

No Example

packages..components.library.configureFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.library.cxxSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.library.depends

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.library.doCheck

This option has no description.

Type: boolean

Default: true

No Example

packages..components.library.doCoverage

Enable production of test coverage reports.

Type: boolean

Default: false

No Example

packages..components.library.doCrossCheck

Run doCheck also in cross compilation settings. This can be tricky as the test logic must know how to run the tests on the target.

Type: boolean

Default: false

No Example

packages..components.library.doExactConfig

This option has no description.

Type: boolean

Default: false

No Example

packages..components.library.doHaddock

Enable building of the Haddock documentation from the annotated Haskell source code.

Type: boolean

Default: true

No Example

packages..components.library.doHoogle

Also build a hoogle index.

Type: boolean

Default: true

No Example

packages..components.library.doHyperlinkSource

Link documentation to the source code.

Type: boolean

Default: true

No Example

packages..components.library.doQuickjump

Generate an index for interactive documentation navigation.

Type: boolean

Default: true

No Example

packages..components.library.dontPatchELF

If set, the patchelf command is not used to remove unnecessary RPATH entries. Only applies to Linux.

Type: boolean

Default: true

No Example

packages..components.library.dontStrip

If set, libraries and executables are not stripped.

Type: boolean

Default: true

No Example

packages..components.library.enableDeadCodeElimination

If set, enables split sections for link-time dead-code stripping. Only applies to Linux

Type: boolean

Default: true

No Example

packages..components.library.enableExecutableProfiling

This option has no description.

Type: boolean

Default: false

No Example

packages..components.library.enableLibraryProfiling

This option has no description.

Type: boolean

Default: false

No Example

packages..components.library.enableSeparateDataOutput

This option has no description.

Type: boolean

Default: false

No Example

packages..components.library.enableShared

If set, enables building shared libraries.

Type: boolean

Default: true

No Example

packages..components.library.enableStatic

If set, enables building static libraries and executables.

Type: boolean

Default: true

No Example

packages..components.library.extraSrcFiles

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.library.frameworks

This option has no description.

Type: list of packages

Default: []

No Example

packages..components.library.ghcOptions

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.library.hardeningDisable

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.library.hsSourceDirs

This option has no description.

Type: list of unspecifieds

Default: ["."]

No Example

packages..components.library.includeDirs

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.library.includes

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.library.jsSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.library.keepSource

Keep component source in the store in a source output

Type: boolean

Default: false

No Example

packages..components.library.libs

This option has no description.

Type: list of null or packages

Default: []

No Example

packages..components.library.mainPath

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.library.modules

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.library.pkgconfig

This option has no description.

Type: list of list of packagess

Default: []

No Example

packages..components.library.planned

Set to true by plan-to-nix for any component that was included in the plan.json file.

Type: boolean

Default: false

No Example

packages..components.library.platforms

This option has no description.

Type: null or list of unspecifieds

Default: null

No Example

packages..components.library.postBuild

This option has no description.

Type: null or string

Default: null

No Example

packages..components.library.postCheck

This option has no description.

Type: null or string

Default: null

No Example

packages..components.library.postConfigure

This option has no description.

Type: null or string

Default: null

No Example

packages..components.library.postHaddock

This option has no description.

Type: null or string

Default: null

No Example

packages..components.library.postInstall

This option has no description.

Type: null or string

Default: null

No Example

packages..components.library.postUnpack

This option has no description.

Type: null or string

Default: null

No Example

packages..components.library.preBuild

This option has no description.

Type: null or string

Default: null

No Example

packages..components.library.preCheck

This option has no description.

Type: null or string

Default: null

No Example

packages..components.library.preConfigure

This option has no description.

Type: null or string

Default: null

No Example

packages..components.library.preHaddock

This option has no description.

Type: null or string

Default: null

No Example

packages..components.library.preInstall

This option has no description.

Type: null or string

Default: null

No Example

packages..components.library.preUnpack

This option has no description.

Type: null or strings concatenated with "\n"

Default: null

No Example

packages..components.library.profilingDetail

This option has no description.

Type: null or string

Default: "default"

No Example

packages..components.library.setupBuildFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.library.setupHaddockFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.library.setupInstallFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.library.shellHook

Hook to run when entering a shell

Type: unspecified

Default: ""

No Example

packages..components.library.testFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.library.testWrapper

A command to run for executing tests in checkPhase, which takes the original test command as its arguments.

Type: list of strings

Default: []

Example:

"echo"

packages..components.library.writeHieFiles

Write component .hie files in the store in a hie output

Type: boolean

Default: false

No Example

packages..components.setup

This option has no description.

Type: null or submodule

Default: {"asmSources":[],"cSources":[],"cmmSources":[],"cxxSources":[],"depends":[],"doExactConfig":false,"extraSrcFiles":["Setup.hs","Setup.lhs"],"frameworks":[],"hsSourceDirs":["setup-src"],"includeDirs":[],"jsSources":[],"libs":[],"platforms":null}

No Example

packages..components.setup.asmSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.setup.build-tools

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.setup.buildable

This option has no description.

Type: boolean

Default: true

No Example

packages..components.setup.cSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.setup.cmmSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.setup.configureAllComponents

If set all the components in the package are configured (useful for cabal-doctest).

Type: boolean

Default: false

No Example

packages..components.setup.configureFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.setup.cxxSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.setup.depends

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.setup.doCheck

This option has no description.

Type: boolean

Default: true

No Example

packages..components.setup.doCoverage

Enable production of test coverage reports.

Type: boolean

Default: false

No Example

packages..components.setup.doCrossCheck

Run doCheck also in cross compilation settings. This can be tricky as the test logic must know how to run the tests on the target.

Type: boolean

Default: false

No Example

packages..components.setup.doExactConfig

This option has no description.

Type: boolean

Default: false

No Example

packages..components.setup.doHaddock

Enable building of the Haddock documentation from the annotated Haskell source code.

Type: boolean

Default: true

No Example

packages..components.setup.doHoogle

Also build a hoogle index.

Type: boolean

Default: true

No Example

packages..components.setup.doHyperlinkSource

Link documentation to the source code.

Type: boolean

Default: true

No Example

packages..components.setup.doQuickjump

Generate an index for interactive documentation navigation.

Type: boolean

Default: true

No Example

packages..components.setup.dontPatchELF

If set, the patchelf command is not used to remove unnecessary RPATH entries. Only applies to Linux.

Type: boolean

Default: true

No Example

packages..components.setup.dontStrip

If set, libraries and executables are not stripped.

Type: boolean

Default: true

No Example

packages..components.setup.enableDeadCodeElimination

If set, enables split sections for link-time dead-code stripping. Only applies to Linux

Type: boolean

Default: true

No Example

packages..components.setup.enableExecutableProfiling

This option has no description.

Type: boolean

Default: false

No Example

packages..components.setup.enableLibraryProfiling

This option has no description.

Type: boolean

Default: false

No Example

packages..components.setup.enableSeparateDataOutput

This option has no description.

Type: boolean

Default: false

No Example

packages..components.setup.enableShared

If set, enables building shared libraries.

Type: boolean

Default: true

No Example

packages..components.setup.enableStatic

If set, enables building static libraries and executables.

Type: boolean

Default: true

No Example

packages..components.setup.extraSrcFiles

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.setup.frameworks

This option has no description.

Type: list of packages

Default: []

No Example

packages..components.setup.ghcOptions

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.setup.hardeningDisable

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.setup.hsSourceDirs

This option has no description.

Type: list of unspecifieds

Default: ["."]

No Example

packages..components.setup.includeDirs

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.setup.includes

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.setup.jsSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.setup.keepSource

Keep component source in the store in a source output

Type: boolean

Default: false

No Example

packages..components.setup.libs

This option has no description.

Type: list of null or packages

Default: []

No Example

packages..components.setup.mainPath

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.setup.modules

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.setup.pkgconfig

This option has no description.

Type: list of list of packagess

Default: []

No Example

packages..components.setup.planned

Set to true by plan-to-nix for any component that was included in the plan.json file.

Type: boolean

Default: false

No Example

packages..components.setup.platforms

This option has no description.

Type: null or list of unspecifieds

Default: null

No Example

packages..components.setup.postBuild

This option has no description.

Type: null or string

Default: null

No Example

packages..components.setup.postCheck

This option has no description.

Type: null or string

Default: null

No Example

packages..components.setup.postConfigure

This option has no description.

Type: null or string

Default: null

No Example

packages..components.setup.postHaddock

This option has no description.

Type: null or string

Default: null

No Example

packages..components.setup.postInstall

This option has no description.

Type: null or string

Default: null

No Example

packages..components.setup.postUnpack

This option has no description.

Type: null or string

Default: null

No Example

packages..components.setup.preBuild

This option has no description.

Type: null or string

Default: null

No Example

packages..components.setup.preCheck

This option has no description.

Type: null or string

Default: null

No Example

packages..components.setup.preConfigure

This option has no description.

Type: null or string

Default: null

No Example

packages..components.setup.preHaddock

This option has no description.

Type: null or string

Default: null

No Example

packages..components.setup.preInstall

This option has no description.

Type: null or string

Default: null

No Example

packages..components.setup.preUnpack

This option has no description.

Type: null or strings concatenated with "\n"

Default: null

No Example

packages..components.setup.profilingDetail

This option has no description.

Type: null or string

Default: "default"

No Example

packages..components.setup.setupBuildFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.setup.setupHaddockFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.setup.setupInstallFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.setup.shellHook

Hook to run when entering a shell

Type: unspecified

Default: ""

No Example

packages..components.setup.testFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.setup.testWrapper

A command to run for executing tests in checkPhase, which takes the original test command as its arguments.

Type: list of strings

Default: []

Example:

"echo"

packages..components.setup.writeHieFiles

Write component .hie files in the store in a hie output

Type: boolean

Default: false

No Example

packages..components.sublibs

This option has no description.

Type: attribute set of submodules

Default: {}

No Example

packages..components.sublibs..asmSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.sublibs..build-tools

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.sublibs..buildable

This option has no description.

Type: boolean

Default: true

No Example

packages..components.sublibs..cSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.sublibs..cmmSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.sublibs..configureAllComponents

If set all the components in the package are configured (useful for cabal-doctest).

Type: boolean

Default: false

No Example

packages..components.sublibs..configureFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.sublibs..cxxSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.sublibs..depends

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.sublibs..doCheck

This option has no description.

Type: boolean

Default: true

No Example

packages..components.sublibs..doCoverage

Enable production of test coverage reports.

Type: boolean

Default: false

No Example

packages..components.sublibs..doCrossCheck

Run doCheck also in cross compilation settings. This can be tricky as the test logic must know how to run the tests on the target.

Type: boolean

Default: false

No Example

packages..components.sublibs..doExactConfig

This option has no description.

Type: boolean

Default: false

No Example

packages..components.sublibs..doHaddock

Enable building of the Haddock documentation from the annotated Haskell source code.

Type: boolean

Default: true

No Example

packages..components.sublibs..doHoogle

Also build a hoogle index.

Type: boolean

Default: true

No Example

packages..components.sublibs..doHyperlinkSource

Link documentation to the source code.

Type: boolean

Default: true

No Example

packages..components.sublibs..doQuickjump

Generate an index for interactive documentation navigation.

Type: boolean

Default: true

No Example

packages..components.sublibs..dontPatchELF

If set, the patchelf command is not used to remove unnecessary RPATH entries. Only applies to Linux.

Type: boolean

Default: true

No Example

packages..components.sublibs..dontStrip

If set, libraries and executables are not stripped.

Type: boolean

Default: true

No Example

packages..components.sublibs..enableDeadCodeElimination

If set, enables split sections for link-time dead-code stripping. Only applies to Linux

Type: boolean

Default: true

No Example

packages..components.sublibs..enableExecutableProfiling

This option has no description.

Type: boolean

Default: false

No Example

packages..components.sublibs..enableLibraryProfiling

This option has no description.

Type: boolean

Default: false

No Example

packages..components.sublibs..enableSeparateDataOutput

This option has no description.

Type: boolean

Default: false

No Example

packages..components.sublibs..enableShared

If set, enables building shared libraries.

Type: boolean

Default: true

No Example

packages..components.sublibs..enableStatic

If set, enables building static libraries and executables.

Type: boolean

Default: true

No Example

packages..components.sublibs..extraSrcFiles

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.sublibs..frameworks

This option has no description.

Type: list of packages

Default: []

No Example

packages..components.sublibs..ghcOptions

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.sublibs..hardeningDisable

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.sublibs..hsSourceDirs

This option has no description.

Type: list of unspecifieds

Default: ["."]

No Example

packages..components.sublibs..includeDirs

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.sublibs..includes

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.sublibs..jsSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.sublibs..keepSource

Keep component source in the store in a source output

Type: boolean

Default: false

No Example

packages..components.sublibs..libs

This option has no description.

Type: list of null or packages

Default: []

No Example

packages..components.sublibs..mainPath

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.sublibs..modules

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.sublibs..pkgconfig

This option has no description.

Type: list of list of packagess

Default: []

No Example

packages..components.sublibs..planned

Set to true by plan-to-nix for any component that was included in the plan.json file.

Type: boolean

Default: false

No Example

packages..components.sublibs..platforms

This option has no description.

Type: null or list of unspecifieds

Default: null

No Example

packages..components.sublibs..postBuild

This option has no description.

Type: null or string

Default: null

No Example

packages..components.sublibs..postCheck

This option has no description.

Type: null or string

Default: null

No Example

packages..components.sublibs..postConfigure

This option has no description.

Type: null or string

Default: null

No Example

packages..components.sublibs..postHaddock

This option has no description.

Type: null or string

Default: null

No Example

packages..components.sublibs..postInstall

This option has no description.

Type: null or string

Default: null

No Example

packages..components.sublibs..postUnpack

This option has no description.

Type: null or string

Default: null

No Example

packages..components.sublibs..preBuild

This option has no description.

Type: null or string

Default: null

No Example

packages..components.sublibs..preCheck

This option has no description.

Type: null or string

Default: null

No Example

packages..components.sublibs..preConfigure

This option has no description.

Type: null or string

Default: null

No Example

packages..components.sublibs..preHaddock

This option has no description.

Type: null or string

Default: null

No Example

packages..components.sublibs..preInstall

This option has no description.

Type: null or string

Default: null

No Example

packages..components.sublibs..preUnpack

This option has no description.

Type: null or strings concatenated with "\n"

Default: null

No Example

packages..components.sublibs..profilingDetail

This option has no description.

Type: null or string

Default: "default"

No Example

packages..components.sublibs..setupBuildFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.sublibs..setupHaddockFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.sublibs..setupInstallFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.sublibs..shellHook

Hook to run when entering a shell

Type: unspecified

Default: ""

No Example

packages..components.sublibs..testFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.sublibs..testWrapper

A command to run for executing tests in checkPhase, which takes the original test command as its arguments.

Type: list of strings

Default: []

Example:

"echo"

packages..components.sublibs..writeHieFiles

Write component .hie files in the store in a hie output

Type: boolean

Default: false

No Example

packages..components.tests

This option has no description.

Type: attribute set of submodules

Default: {}

No Example

packages..components.tests..asmSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.tests..build-tools

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.tests..buildable

This option has no description.

Type: boolean

Default: true

No Example

packages..components.tests..cSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.tests..cmmSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.tests..configureAllComponents

If set all the components in the package are configured (useful for cabal-doctest).

Type: boolean

Default: false

No Example

packages..components.tests..configureFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.tests..cxxSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.tests..depends

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.tests..doCheck

This option has no description.

Type: boolean

Default: true

No Example

packages..components.tests..doCoverage

Enable production of test coverage reports.

Type: boolean

Default: false

No Example

packages..components.tests..doCrossCheck

Run doCheck also in cross compilation settings. This can be tricky as the test logic must know how to run the tests on the target.

Type: boolean

Default: false

No Example

packages..components.tests..doExactConfig

This option has no description.

Type: boolean

Default: false

No Example

packages..components.tests..doHaddock

Enable building of the Haddock documentation from the annotated Haskell source code.

Type: boolean

Default: true

No Example

packages..components.tests..doHoogle

Also build a hoogle index.

Type: boolean

Default: true

No Example

packages..components.tests..doHyperlinkSource

Link documentation to the source code.

Type: boolean

Default: true

No Example

packages..components.tests..doQuickjump

Generate an index for interactive documentation navigation.

Type: boolean

Default: true

No Example

packages..components.tests..dontPatchELF

If set, the patchelf command is not used to remove unnecessary RPATH entries. Only applies to Linux.

Type: boolean

Default: true

No Example

packages..components.tests..dontStrip

If set, libraries and executables are not stripped.

Type: boolean

Default: true

No Example

packages..components.tests..enableDeadCodeElimination

If set, enables split sections for link-time dead-code stripping. Only applies to Linux

Type: boolean

Default: true

No Example

packages..components.tests..enableExecutableProfiling

This option has no description.

Type: boolean

Default: false

No Example

packages..components.tests..enableLibraryProfiling

This option has no description.

Type: boolean

Default: false

No Example

packages..components.tests..enableSeparateDataOutput

This option has no description.

Type: boolean

Default: false

No Example

packages..components.tests..enableShared

If set, enables building shared libraries.

Type: boolean

Default: true

No Example

packages..components.tests..enableStatic

If set, enables building static libraries and executables.

Type: boolean

Default: true

No Example

packages..components.tests..extraSrcFiles

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.tests..frameworks

This option has no description.

Type: list of packages

Default: []

No Example

packages..components.tests..ghcOptions

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.tests..hardeningDisable

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.tests..hsSourceDirs

This option has no description.

Type: list of unspecifieds

Default: ["."]

No Example

packages..components.tests..includeDirs

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.tests..includes

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.tests..jsSources

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.tests..keepSource

Keep component source in the store in a source output

Type: boolean

Default: false

No Example

packages..components.tests..libs

This option has no description.

Type: list of null or packages

Default: []

No Example

packages..components.tests..mainPath

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.tests..modules

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..components.tests..pkgconfig

This option has no description.

Type: list of list of packagess

Default: []

No Example

packages..components.tests..planned

Set to true by plan-to-nix for any component that was included in the plan.json file.

Type: boolean

Default: false

No Example

packages..components.tests..platforms

This option has no description.

Type: null or list of unspecifieds

Default: null

No Example

packages..components.tests..postBuild

This option has no description.

Type: null or string

Default: null

No Example

packages..components.tests..postCheck

This option has no description.

Type: null or string

Default: null

No Example

packages..components.tests..postConfigure

This option has no description.

Type: null or string

Default: null

No Example

packages..components.tests..postHaddock

This option has no description.

Type: null or string

Default: null

No Example

packages..components.tests..postInstall

This option has no description.

Type: null or string

Default: null

No Example

packages..components.tests..postUnpack

This option has no description.

Type: null or string

Default: null

No Example

packages..components.tests..preBuild

This option has no description.

Type: null or string

Default: null

No Example

packages..components.tests..preCheck

This option has no description.

Type: null or string

Default: null

No Example

packages..components.tests..preConfigure

This option has no description.

Type: null or string

Default: null

No Example

packages..components.tests..preHaddock

This option has no description.

Type: null or string

Default: null

No Example

packages..components.tests..preInstall

This option has no description.

Type: null or string

Default: null

No Example

packages..components.tests..preUnpack

This option has no description.

Type: null or strings concatenated with "\n"

Default: null

No Example

packages..components.tests..profilingDetail

This option has no description.

Type: null or string

Default: "default"

No Example

packages..components.tests..setupBuildFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.tests..setupHaddockFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.tests..setupInstallFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.tests..shellHook

Hook to run when entering a shell

Type: unspecified

Default: ""

No Example

packages..components.tests..testFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..components.tests..testWrapper

A command to run for executing tests in checkPhase, which takes the original test command as its arguments.

Type: list of strings

Default: []

Example:

"echo"

packages..components.tests..writeHieFiles

Write component .hie files in the store in a hie output

Type: boolean

Default: false

No Example

packages..configureAllComponents

If set all the components in the package are configured (useful for cabal-doctest).

Type: boolean

Default: false

No Example

packages..configureFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..doCheck

This option has no description.

Type: boolean

Default: true

No Example

packages..doCoverage

Enable production of test coverage reports.

Type: boolean

Default: false

No Example

packages..doCrossCheck

Run doCheck also in cross compilation settings. This can be tricky as the test logic must know how to run the tests on the target.

Type: boolean

Default: false

No Example

packages..doExactConfig

This option has no description.

Type: boolean

Default: false

No Example

packages..doHaddock

Enable building of the Haddock documentation from the annotated Haskell source code.

Type: boolean

Default: true

No Example

packages..doHoogle

Also build a hoogle index.

Type: boolean

Default: true

No Example

packages..doHyperlinkSource

Link documentation to the source code.

Type: boolean

Default: true

No Example

packages..doQuickjump

Generate an index for interactive documentation navigation.

Type: boolean

Default: true

No Example

packages..dontPatchELF

If set, the patchelf command is not used to remove unnecessary RPATH entries. Only applies to Linux.

Type: boolean

Default: true

No Example

packages..dontStrip

If set, libraries and executables are not stripped.

Type: boolean

Default: true

No Example

packages..enableDeadCodeElimination

If set, enables split sections for link-time dead-code stripping. Only applies to Linux

Type: boolean

Default: true

No Example

packages..enableExecutableProfiling

This option has no description.

Type: boolean

Default: false

No Example

packages..enableLibraryProfiling

This option has no description.

Type: boolean

Default: false

No Example

packages..enableSeparateDataOutput

This option has no description.

Type: boolean

Default: false

No Example

packages..enableShared

If set, enables building shared libraries.

Type: boolean

Default: true

No Example

packages..enableStatic

If set, enables building static libraries and executables.

Type: boolean

Default: true

No Example

packages..flags

This option has no description.

Type: attribute set of booleans

No Default

No Example

packages..ghcOptions

This option has no description.

Type: list of strings

Default: []

No Example

packages..hardeningDisable

This option has no description.

Type: list of strings

Default: []

No Example

packages..keepSource

Keep component source in the store in a source output

Type: boolean

Default: false

No Example

packages..name

This option has no description.

Type: string

Default: "${config.package.identifier.name}-${config.package.identifier.version}"

No Example

packages..package.author

This option has no description.

Type: string

No Default

No Example

packages..package.buildType

This option has no description.

Type: string

No Default

No Example

packages..package.buildable

This option has no description.

Type: boolean

Default: true

No Example

packages..package.cleanHpack

This option has no description.

Type: boolean

Default: false

No Example

packages..package.copyright

This option has no description.

Type: string

No Default

No Example

packages..package.dataDir

This option has no description.

Type: string

Default: ""

No Example

packages..package.dataFiles

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..package.description

This option has no description.

Type: string

No Default

No Example

packages..package.detailLevel

This option has no description.

Type: string

Default: "MinimalDetails"

No Example

packages..package.extraDocFiles

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..package.extraSrcFiles

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..package.extraTmpFiles

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..package.homepage

This option has no description.

Type: string

No Default

No Example

packages..package.identifier.name

This option has no description.

Type: string

No Default

No Example

packages..package.identifier.version

This option has no description.

Type: string

No Default

No Example

packages..package.isLocal

This option has no description.

Type: boolean

Default: false

No Example

packages..package.isProject

This option has no description.

Type: boolean

Default: false

No Example

packages..package.license

This option has no description.

Type: string

No Default

No Example

packages..package.licenseFiles

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..package.maintainer

This option has no description.

Type: string

No Default

No Example

packages..package.setup-depends

This option has no description.

Type: list of unspecifieds

Default: []

No Example

packages..package.specVersion

This option has no description.

Type: string

No Default

No Example

packages..package.synopsis

This option has no description.

Type: string

No Default

No Example

packages..package.url

This option has no description.

Type: string

No Default

No Example

packages..patches

This option has no description.

Type: list of unspecified or paths

Default: []

No Example

packages..planned

Set to true by plan-to-nix for any component that was included in the plan.json file.

Type: boolean

Default: false

No Example

packages..postBuild

This option has no description.

Type: null or string

Default: null

No Example

packages..postCheck

This option has no description.

Type: null or string

Default: null

No Example

packages..postConfigure

This option has no description.

Type: null or string

Default: null

No Example

packages..postHaddock

This option has no description.

Type: null or string

Default: null

No Example

packages..postInstall

This option has no description.

Type: null or string

Default: null

No Example

packages..postUnpack

This option has no description.

Type: null or string

Default: null

No Example

packages..preBuild

This option has no description.

Type: null or string

Default: null

No Example

packages..preCheck

This option has no description.

Type: null or string

Default: null

No Example

packages..preConfigure

This option has no description.

Type: null or string

Default: null

No Example

packages..preHaddock

This option has no description.

Type: null or string

Default: null

No Example

packages..preInstall

This option has no description.

Type: null or string

Default: null

No Example

packages..preUnpack

This option has no description.

Type: null or strings concatenated with "\n"

Default: null

No Example

packages..profilingDetail

This option has no description.

Type: null or string

Default: "default"

No Example

packages..revision

This option has no description.

Type: null or signed integer

Default: null

No Example

packages..revisionSha256

This option has no description.

Type: null or string

Default: null

No Example

packages..setupBuildFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..setupHaddockFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..setupInstallFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..sha256

This option has no description.

Type: null or string

Default: null

No Example

packages..shellHook

Hook to run when entering a shell

Type: unspecified

Default: ""

No Example

packages..src

This option has no description.

Type: path or package

Default: "pkgs.fetchurl { url = \"mirror://hackage/${config.name}.tar.gz\"; inherit (config) sha256; };"

No Example

packages..testFlags

This option has no description.

Type: list of strings

Default: []

No Example

packages..testWrapper

A command to run for executing tests in checkPhase, which takes the original test command as its arguments.

Type: list of strings

Default: []

Example:

"echo"

packages..writeHieFiles

Write component .hie files in the store in a hie output

Type: boolean

Default: false

No Example

planned

Set to true by plan-to-nix for any component that was included in the plan.json file.

Type: boolean

Default: false

No Example

postBuild

This option has no description.

Type: null or string

Default: null

No Example

postCheck

This option has no description.

Type: null or string

Default: null

No Example

postConfigure

This option has no description.

Type: null or string

Default: null

No Example

postHaddock

This option has no description.

Type: null or string

Default: null

No Example

postInstall

This option has no description.

Type: null or string

Default: null

No Example

postUnpack

This option has no description.

Type: null or string

Default: null

No Example

preBuild

This option has no description.

Type: null or string

Default: null

No Example

preCheck

This option has no description.

Type: null or string

Default: null

No Example

preConfigure

This option has no description.

Type: null or string

Default: null

No Example

preHaddock

This option has no description.

Type: null or string

Default: null

No Example

preInstall

This option has no description.

Type: null or string

Default: null

No Example

preUnpack

This option has no description.

Type: null or strings concatenated with "\n"

Default: null

No Example

profilingDetail

This option has no description.

Type: null or string

Default: "default"

No Example

reinstallableLibGhc

Is lib:ghc reinstallable?

Type: boolean

Default: false

No Example

setup-depends

pkgs to globally provide to Setup.hs builds

Type: list of unspecifieds

Default: []

No Example

setupBuildFlags

This option has no description.

Type: list of strings

Default: []

No Example

setupHaddockFlags

This option has no description.

Type: list of strings

Default: []

No Example

setupInstallFlags

This option has no description.

Type: list of strings

Default: []

No Example

shellHook

Hook to run when entering a shell

Type: unspecified

Default: ""

No Example

testFlags

This option has no description.

Type: list of strings

Default: []

No Example

testWrapper

A command to run for executing tests in checkPhase, which takes the original test command as its arguments.

Type: list of strings

Default: []

Example:

"echo"

writeHieFiles

Write component .hie files in the store in a hie output

Type: boolean

Default: false

No Example