Haskell.nix modules options for packages and components.
!!! note "Generated"
This documentation is generated from Nix sources in the
modules
subdirectory using scripts/update-docs.nix
Configuration Options
_module.args
Additional arguments passed to each module in addition to ones
like lib, config,
and pkgs, modulesPath.
This option is also available to all submodules. Submodules do not
inherit args from their parent module, nor do they provide args to
their parent module or sibling submodules. The sole exception to
this is the argument name which is provided by
parent modules to a submodule and contains the attribute name
the submodule is bound to, or a unique generated name if it is
not bound to an attribute.
Some arguments are already passed by default, of which the following cannot be changed with this option:
-
{var}
lib: The nixpkgs library. -
{var}
config: The results of all options after merging the values from all modules together. -
{var}
options: The options declared in all modules. -
{var}
specialArgs: ThespecialArgsargument passed toevalModules. -
All attributes of {var}
specialArgsWhereas option values can generally depend on other option values thanks to laziness, this does not apply to
imports, which must be computed statically before anything else.For this reason, callers of the module system can provide
specialArgswhich are available during import resolution.For NixOS,
specialArgsincludes {var}modulesPath, which allows you to import extra modules from the nixpkgs package tree without having to somehow make the module aware of the location of thenixpkgsor NixOS directories.{ modulesPath, ... }: { imports = [ (modulesPath + "/profiles/minimal.nix") ]; }
For NixOS, the default value for this option includes at least this argument:
- {var}
pkgs: The nixpkgs package set according to the {option}nixpkgs.pkgsoption.
Type: lazy attribute set of raw value
No Default
No Example
bootPkgs
Type: list of string
No Default
No Example
buildable
Type: boolean
Default: true
No Example
cabal.compiler
Type: unspecified value
No Default
No Example
cabal.system
Type: unspecified value
No Default
No Example
compiler.nix-name
Type: string
No Default
No Example
compiler.packages
Type: attribute set of string
No Default
No Example
compiler.version
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
Type: list of string
Default: []
No Example
contentAddressed
Build content addressed derivation, requires Nix to have experimental feature
ca-derivations enabled.
Type: boolean
Default: false
No Example
doCheck
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
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
enableLibraryProfiling
Type: boolean
Default: false
No Example
enableProfiling
Type: boolean
Default: false
No Example
enableSeparateDataOutput
Type: boolean
Default: true
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
Type: unspecified value
No Default
No Example
evalPackages
The evalPackages that will be used when building hoogle and shell tools.
Type: unspecified value
No Default
No Example
ghc.package
Type: package
Default: "pkgs.buildPackages.haskell-nix.compiler.${config.compiler.nix-name}"
No Example
ghcOptions
Type: list of string
Default: []
No Example
hackage.configs
Type: unspecified value
No Default
No Example
hackage.db
Type: unspecified value
No Default
No Example
hardeningDisable
Type: list of string
Default: []
No Example
hsPkgs
Type: unspecified value
No Default
No Example
inputMap
Type: attribute set of unspecified value
Default: {}
No Example
keepSource
Keep component source in the store in a source output
Type: boolean
Default: false
No Example
nonReinstallablePkgs
Type: list of string
No Default
No Example
packages
Type: attribute set of (submodule)
No Default
No Example
packages..allComponent
The merged dependencies of all other components
Type: submodule
No Default
No Example
packages..allComponent.asmSources
Type: list of unspecified value
Default: []
No Example
packages..allComponent.build-tools
Type: list of unspecified value
Default: []
No Example
packages..allComponent.buildable
Type: boolean
Default: true
No Example
packages..allComponent.cSources
Type: list of unspecified value
Default: []
No Example
packages..allComponent.cmmSources
Type: list of unspecified value
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
Type: list of string
Default: []
No Example
packages..allComponent.contentAddressed
Build content addressed derivation, requires Nix to have experimental feature
ca-derivations enabled.
Type: boolean
Default: false
No Example
packages..allComponent.cxxSources
Type: list of unspecified value
Default: []
No Example
packages..allComponent.depends
Type: list of unspecified value
Default: []
No Example
packages..allComponent.doCheck
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
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.enableLibraryProfiling
Type: boolean
Default: false
No Example
packages..allComponent.enableProfiling
Type: boolean
Default: false
No Example
packages..allComponent.enableSeparateDataOutput
Type: boolean
Default: true
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
Type: list of unspecified value
Default: []
No Example
packages..allComponent.frameworks
Type: list of package
Default: []
No Example
packages..allComponent.ghcOptions
Type: list of string
Default: []
No Example
packages..allComponent.hardeningDisable
Type: list of string
Default: []
No Example
packages..allComponent.hsSourceDirs
Type: list of unspecified value
Default: ["."]
No Example
packages..allComponent.includeDirs
Type: list of unspecified value
Default: []
No Example
packages..allComponent.includes
Type: list of unspecified value
Default: []
No Example
packages..allComponent.jsSources
Type: list of unspecified value
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
Type: list of (null or package or list of package)
Default: []
No Example
packages..allComponent.mainPath
Type: list of unspecified value
Default: []
No Example
packages..allComponent.modules
Type: list of unspecified value
Default: []
No Example
packages..allComponent.pkgconfig
Type: list of list of package
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
Type: null or (list of unspecified value)
Default: null
No Example
packages..allComponent.plugins
Type: list of (submodule)
Default: []
No Example
packages..allComponent.plugins.*.args
Type: list of string
Default: []
No Example
packages..allComponent.plugins.*.library
Type: unspecified value
No Default
No Example
packages..allComponent.plugins.*.moduleName
Type: string
No Default
No Example
packages..allComponent.postBuild
Type: null or string
Default: null
No Example
packages..allComponent.postCheck
Type: null or string
Default: null
No Example
packages..allComponent.postConfigure
Type: null or string
Default: null
No Example
packages..allComponent.postHaddock
Type: null or string
Default: null
No Example
packages..allComponent.postInstall
Type: null or string
Default: null
No Example
packages..allComponent.postUnpack
Type: null or string
Default: null
No Example
packages..allComponent.preBuild
Type: null or string
Default: null
No Example
packages..allComponent.preCheck
Type: null or string
Default: null
No Example
packages..allComponent.preConfigure
Type: null or string
Default: null
No Example
packages..allComponent.preHaddock
Type: null or string
Default: null
No Example
packages..allComponent.preInstall
Type: null or string
Default: null
No Example
packages..allComponent.preUnpack
Type: null or strings concatenated with "\n"
Default: null
No Example
packages..allComponent.profilingDetail
Type: null or string
Default: "default"
No Example
packages..allComponent.setupBuildFlags
Type: list of string
Default: []
No Example
packages..allComponent.setupHaddockFlags
Type: list of string
Default: []
No Example
packages..allComponent.setupInstallFlags
Type: list of string
Default: []
No Example
packages..allComponent.shellHook
Hook to run when entering a shell
Type: unspecified value
Default: ""
No Example
packages..allComponent.testFlags
Type: list of string
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 string
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
Type: boolean
Default: true
No Example
packages..cabal-generator
Type: null or string
Default: null
No Example
packages..components.benchmarks
Type: attribute set of (submodule)
Default: {}
No Example
packages..components.benchmarks..asmSources
Type: list of unspecified value
Default: []
No Example
packages..components.benchmarks..build-tools
Type: list of unspecified value
Default: []
No Example
packages..components.benchmarks..buildable
Type: boolean
Default: true
No Example
packages..components.benchmarks..cSources
Type: list of unspecified value
Default: []
No Example
packages..components.benchmarks..cmmSources
Type: list of unspecified value
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
Type: list of string
Default: []
No Example
packages..components.benchmarks..contentAddressed
Build content addressed derivation, requires Nix to have experimental feature
ca-derivations enabled.
Type: boolean
Default: false
No Example
packages..components.benchmarks..cxxSources
Type: list of unspecified value
Default: []
No Example
packages..components.benchmarks..depends
Type: list of unspecified value
Default: []
No Example
packages..components.benchmarks..doCheck
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
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..enableLibraryProfiling
Type: boolean
Default: false
No Example
packages..components.benchmarks..enableProfiling
Type: boolean
Default: false
No Example
packages..components.benchmarks..enableSeparateDataOutput
Type: boolean
Default: true
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
Type: list of unspecified value
Default: []
No Example
packages..components.benchmarks..frameworks
Type: list of package
Default: []
No Example
packages..components.benchmarks..ghcOptions
Type: list of string
Default: []
No Example
packages..components.benchmarks..hardeningDisable
Type: list of string
Default: []
No Example
packages..components.benchmarks..hsSourceDirs
Type: list of unspecified value
Default: ["."]
No Example
packages..components.benchmarks..includeDirs
Type: list of unspecified value
Default: []
No Example
packages..components.benchmarks..includes
Type: list of unspecified value
Default: []
No Example
packages..components.benchmarks..jsSources
Type: list of unspecified value
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
Type: list of (null or package or list of package)
Default: []
No Example
packages..components.benchmarks..mainPath
Type: list of unspecified value
Default: []
No Example
packages..components.benchmarks..modules
Type: list of unspecified value
Default: []
No Example
packages..components.benchmarks..pkgconfig
Type: list of list of package
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
Type: null or (list of unspecified value)
Default: null
No Example
packages..components.benchmarks..plugins
Type: list of (submodule)
Default: []
No Example
packages..components.benchmarks..plugins.*.args
Type: list of string
Default: []
No Example
packages..components.benchmarks..plugins.*.library
Type: unspecified value
No Default
No Example
packages..components.benchmarks..plugins.*.moduleName
Type: string
No Default
No Example
packages..components.benchmarks..postBuild
Type: null or string
Default: null
No Example
packages..components.benchmarks..postCheck
Type: null or string
Default: null
No Example
packages..components.benchmarks..postConfigure
Type: null or string
Default: null
No Example
packages..components.benchmarks..postHaddock
Type: null or string
Default: null
No Example
packages..components.benchmarks..postInstall
Type: null or string
Default: null
No Example
packages..components.benchmarks..postUnpack
Type: null or string
Default: null
No Example
packages..components.benchmarks..preBuild
Type: null or string
Default: null
No Example
packages..components.benchmarks..preCheck
Type: null or string
Default: null
No Example
packages..components.benchmarks..preConfigure
Type: null or string
Default: null
No Example
packages..components.benchmarks..preHaddock
Type: null or string
Default: null
No Example
packages..components.benchmarks..preInstall
Type: null or string
Default: null
No Example
packages..components.benchmarks..preUnpack
Type: null or strings concatenated with "\n"
Default: null
No Example
packages..components.benchmarks..profilingDetail
Type: null or string
Default: "default"
No Example
packages..components.benchmarks..setupBuildFlags
Type: list of string
Default: []
No Example
packages..components.benchmarks..setupHaddockFlags
Type: list of string
Default: []
No Example
packages..components.benchmarks..setupInstallFlags
Type: list of string
Default: []
No Example
packages..components.benchmarks..shellHook
Hook to run when entering a shell
Type: unspecified value
Default: ""
No Example
packages..components.benchmarks..testFlags
Type: list of string
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 string
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
Type: attribute set of (submodule)
Default: {}
No Example
packages..components.exes..asmSources
Type: list of unspecified value
Default: []
No Example
packages..components.exes..build-tools
Type: list of unspecified value
Default: []
No Example
packages..components.exes..buildable
Type: boolean
Default: true
No Example
packages..components.exes..cSources
Type: list of unspecified value
Default: []
No Example
packages..components.exes..cmmSources
Type: list of unspecified value
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
Type: list of string
Default: []
No Example
packages..components.exes..contentAddressed
Build content addressed derivation, requires Nix to have experimental feature
ca-derivations enabled.
Type: boolean
Default: false
No Example
packages..components.exes..cxxSources
Type: list of unspecified value
Default: []
No Example
packages..components.exes..depends
Type: list of unspecified value
Default: []
No Example
packages..components.exes..doCheck
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
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..enableLibraryProfiling
Type: boolean
Default: false
No Example
packages..components.exes..enableProfiling
Type: boolean
Default: false
No Example
packages..components.exes..enableSeparateDataOutput
Type: boolean
Default: true
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
Type: list of unspecified value
Default: []
No Example
packages..components.exes..frameworks
Type: list of package
Default: []
No Example
packages..components.exes..ghcOptions
Type: list of string
Default: []
No Example
packages..components.exes..hardeningDisable
Type: list of string
Default: []
No Example
packages..components.exes..hsSourceDirs
Type: list of unspecified value
Default: ["."]
No Example
packages..components.exes..includeDirs
Type: list of unspecified value
Default: []
No Example
packages..components.exes..includes
Type: list of unspecified value
Default: []
No Example
packages..components.exes..jsSources
Type: list of unspecified value
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
Type: list of (null or package or list of package)
Default: []
No Example
packages..components.exes..mainPath
Type: list of unspecified value
Default: []
No Example
packages..components.exes..modules
Type: list of unspecified value
Default: []
No Example
packages..components.exes..pkgconfig
Type: list of list of package
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
Type: null or (list of unspecified value)
Default: null
No Example
packages..components.exes..plugins
Type: list of (submodule)
Default: []
No Example
packages..components.exes..plugins.*.args
Type: list of string
Default: []
No Example
packages..components.exes..plugins.*.library
Type: unspecified value
No Default
No Example
packages..components.exes..plugins.*.moduleName
Type: string
No Default
No Example
packages..components.exes..postBuild
Type: null or string
Default: null
No Example
packages..components.exes..postCheck
Type: null or string
Default: null
No Example
packages..components.exes..postConfigure
Type: null or string
Default: null
No Example
packages..components.exes..postHaddock
Type: null or string
Default: null
No Example
packages..components.exes..postInstall
Type: null or string
Default: null
No Example
packages..components.exes..postUnpack
Type: null or string
Default: null
No Example
packages..components.exes..preBuild
Type: null or string
Default: null
No Example
packages..components.exes..preCheck
Type: null or string
Default: null
No Example
packages..components.exes..preConfigure
Type: null or string
Default: null
No Example
packages..components.exes..preHaddock
Type: null or string
Default: null
No Example
packages..components.exes..preInstall
Type: null or string
Default: null
No Example
packages..components.exes..preUnpack
Type: null or strings concatenated with "\n"
Default: null
No Example
packages..components.exes..profilingDetail
Type: null or string
Default: "default"
No Example
packages..components.exes..setupBuildFlags
Type: list of string
Default: []
No Example
packages..components.exes..setupHaddockFlags
Type: list of string
Default: []
No Example
packages..components.exes..setupInstallFlags
Type: list of string
Default: []
No Example
packages..components.exes..shellHook
Hook to run when entering a shell
Type: unspecified value
Default: ""
No Example
packages..components.exes..testFlags
Type: list of string
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 string
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
Type: attribute set of (submodule)
Default: {}
No Example
packages..components.foreignlibs..asmSources
Type: list of unspecified value
Default: []
No Example
packages..components.foreignlibs..build-tools
Type: list of unspecified value
Default: []
No Example
packages..components.foreignlibs..buildable
Type: boolean
Default: true
No Example
packages..components.foreignlibs..cSources
Type: list of unspecified value
Default: []
No Example
packages..components.foreignlibs..cmmSources
Type: list of unspecified value
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
Type: list of string
Default: []
No Example
packages..components.foreignlibs..contentAddressed
Build content addressed derivation, requires Nix to have experimental feature
ca-derivations enabled.
Type: boolean
Default: false
No Example
packages..components.foreignlibs..cxxSources
Type: list of unspecified value
Default: []
No Example
packages..components.foreignlibs..depends
Type: list of unspecified value
Default: []
No Example
packages..components.foreignlibs..doCheck
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
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..enableLibraryProfiling
Type: boolean
Default: false
No Example
packages..components.foreignlibs..enableProfiling
Type: boolean
Default: false
No Example
packages..components.foreignlibs..enableSeparateDataOutput
Type: boolean
Default: true
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
Type: list of unspecified value
Default: []
No Example
packages..components.foreignlibs..frameworks
Type: list of package
Default: []
No Example
packages..components.foreignlibs..ghcOptions
Type: list of string
Default: []
No Example
packages..components.foreignlibs..hardeningDisable
Type: list of string
Default: []
No Example
packages..components.foreignlibs..hsSourceDirs
Type: list of unspecified value
Default: ["."]
No Example
packages..components.foreignlibs..includeDirs
Type: list of unspecified value
Default: []
No Example
packages..components.foreignlibs..includes
Type: list of unspecified value
Default: []
No Example
packages..components.foreignlibs..jsSources
Type: list of unspecified value
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
Type: list of (null or package or list of package)
Default: []
No Example
packages..components.foreignlibs..mainPath
Type: list of unspecified value
Default: []
No Example
packages..components.foreignlibs..modules
Type: list of unspecified value
Default: []
No Example
packages..components.foreignlibs..pkgconfig
Type: list of list of package
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
Type: null or (list of unspecified value)
Default: null
No Example
packages..components.foreignlibs..plugins
Type: list of (submodule)
Default: []
No Example
packages..components.foreignlibs..plugins.*.args
Type: list of string
Default: []
No Example
packages..components.foreignlibs..plugins.*.library
Type: unspecified value
No Default
No Example
packages..components.foreignlibs..plugins.*.moduleName
Type: string
No Default
No Example
packages..components.foreignlibs..postBuild
Type: null or string
Default: null
No Example
packages..components.foreignlibs..postCheck
Type: null or string
Default: null
No Example
packages..components.foreignlibs..postConfigure
Type: null or string
Default: null
No Example
packages..components.foreignlibs..postHaddock
Type: null or string
Default: null
No Example
packages..components.foreignlibs..postInstall
Type: null or string
Default: null
No Example
packages..components.foreignlibs..postUnpack
Type: null or string
Default: null
No Example
packages..components.foreignlibs..preBuild
Type: null or string
Default: null
No Example
packages..components.foreignlibs..preCheck
Type: null or string
Default: null
No Example
packages..components.foreignlibs..preConfigure
Type: null or string
Default: null
No Example
packages..components.foreignlibs..preHaddock
Type: null or string
Default: null
No Example
packages..components.foreignlibs..preInstall
Type: null or string
Default: null
No Example
packages..components.foreignlibs..preUnpack
Type: null or strings concatenated with "\n"
Default: null
No Example
packages..components.foreignlibs..profilingDetail
Type: null or string
Default: "default"
No Example
packages..components.foreignlibs..setupBuildFlags
Type: list of string
Default: []
No Example
packages..components.foreignlibs..setupHaddockFlags
Type: list of string
Default: []
No Example
packages..components.foreignlibs..setupInstallFlags
Type: list of string
Default: []
No Example
packages..components.foreignlibs..shellHook
Hook to run when entering a shell
Type: unspecified value
Default: ""
No Example
packages..components.foreignlibs..testFlags
Type: list of string
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 string
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
Type: null or (submodule)
Default: null
No Example
packages..components.library.asmSources
Type: list of unspecified value
Default: []
No Example
packages..components.library.build-tools
Type: list of unspecified value
Default: []
No Example
packages..components.library.buildable
Type: boolean
Default: true
No Example
packages..components.library.cSources
Type: list of unspecified value
Default: []
No Example
packages..components.library.cmmSources
Type: list of unspecified value
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
Type: list of string
Default: []
No Example
packages..components.library.contentAddressed
Build content addressed derivation, requires Nix to have experimental feature
ca-derivations enabled.
Type: boolean
Default: false
No Example
packages..components.library.cxxSources
Type: list of unspecified value
Default: []
No Example
packages..components.library.depends
Type: list of unspecified value
Default: []
No Example
packages..components.library.doCheck
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
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.enableLibraryProfiling
Type: boolean
Default: false
No Example
packages..components.library.enableProfiling
Type: boolean
Default: false
No Example
packages..components.library.enableSeparateDataOutput
Type: boolean
Default: true
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
Type: list of unspecified value
Default: []
No Example
packages..components.library.frameworks
Type: list of package
Default: []
No Example
packages..components.library.ghcOptions
Type: list of string
Default: []
No Example
packages..components.library.hardeningDisable
Type: list of string
Default: []
No Example
packages..components.library.hsSourceDirs
Type: list of unspecified value
Default: ["."]
No Example
packages..components.library.includeDirs
Type: list of unspecified value
Default: []
No Example
packages..components.library.includes
Type: list of unspecified value
Default: []
No Example
packages..components.library.jsSources
Type: list of unspecified value
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
Type: list of (null or package or list of package)
Default: []
No Example
packages..components.library.mainPath
Type: list of unspecified value
Default: []
No Example
packages..components.library.modules
Type: list of unspecified value
Default: []
No Example
packages..components.library.pkgconfig
Type: list of list of package
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
Type: null or (list of unspecified value)
Default: null
No Example
packages..components.library.plugins
Type: list of (submodule)
Default: []
No Example
packages..components.library.plugins.*.args
Type: list of string
Default: []
No Example
packages..components.library.plugins.*.library
Type: unspecified value
No Default
No Example
packages..components.library.plugins.*.moduleName
Type: string
No Default
No Example
packages..components.library.postBuild
Type: null or string
Default: null
No Example
packages..components.library.postCheck
Type: null or string
Default: null
No Example
packages..components.library.postConfigure
Type: null or string
Default: null
No Example
packages..components.library.postHaddock
Type: null or string
Default: null
No Example
packages..components.library.postInstall
Type: null or string
Default: null
No Example
packages..components.library.postUnpack
Type: null or string
Default: null
No Example
packages..components.library.preBuild
Type: null or string
Default: null
No Example
packages..components.library.preCheck
Type: null or string
Default: null
No Example
packages..components.library.preConfigure
Type: null or string
Default: null
No Example
packages..components.library.preHaddock
Type: null or string
Default: null
No Example
packages..components.library.preInstall
Type: null or string
Default: null
No Example
packages..components.library.preUnpack
Type: null or strings concatenated with "\n"
Default: null
No Example
packages..components.library.profilingDetail
Type: null or string
Default: "default"
No Example
packages..components.library.setupBuildFlags
Type: list of string
Default: []
No Example
packages..components.library.setupHaddockFlags
Type: list of string
Default: []
No Example
packages..components.library.setupInstallFlags
Type: list of string
Default: []
No Example
packages..components.library.shellHook
Hook to run when entering a shell
Type: unspecified value
Default: ""
No Example
packages..components.library.testFlags
Type: list of string
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 string
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
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
Type: list of unspecified value
Default: []
No Example
packages..components.setup.build-tools
Type: list of unspecified value
Default: []
No Example
packages..components.setup.buildable
Type: boolean
Default: true
No Example
packages..components.setup.cSources
Type: list of unspecified value
Default: []
No Example
packages..components.setup.cmmSources
Type: list of unspecified value
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
Type: list of string
Default: []
No Example
packages..components.setup.contentAddressed
Build content addressed derivation, requires Nix to have experimental feature
ca-derivations enabled.
Type: boolean
Default: false
No Example
packages..components.setup.cxxSources
Type: list of unspecified value
Default: []
No Example
packages..components.setup.depends
Type: list of unspecified value
Default: []
No Example
packages..components.setup.doCheck
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
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.enableLibraryProfiling
Type: boolean
Default: false
No Example
packages..components.setup.enableProfiling
Type: boolean
Default: false
No Example
packages..components.setup.enableSeparateDataOutput
Type: boolean
Default: true
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
Type: list of unspecified value
Default: []
No Example
packages..components.setup.frameworks
Type: list of package
Default: []
No Example
packages..components.setup.ghcOptions
Type: list of string
Default: []
No Example
packages..components.setup.hardeningDisable
Type: list of string
Default: []
No Example
packages..components.setup.hsSourceDirs
Type: list of unspecified value
Default: ["."]
No Example
packages..components.setup.includeDirs
Type: list of unspecified value
Default: []
No Example
packages..components.setup.includes
Type: list of unspecified value
Default: []
No Example
packages..components.setup.jsSources
Type: list of unspecified value
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
Type: list of (null or package or list of package)
Default: []
No Example
packages..components.setup.mainPath
Type: list of unspecified value
Default: []
No Example
packages..components.setup.modules
Type: list of unspecified value
Default: []
No Example
packages..components.setup.pkgconfig
Type: list of list of package
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
Type: null or (list of unspecified value)
Default: null
No Example
packages..components.setup.plugins
Type: list of (submodule)
Default: []
No Example
packages..components.setup.plugins.*.args
Type: list of string
Default: []
No Example
packages..components.setup.plugins.*.library
Type: unspecified value
No Default
No Example
packages..components.setup.plugins.*.moduleName
Type: string
No Default
No Example
packages..components.setup.postBuild
Type: null or string
Default: null
No Example
packages..components.setup.postCheck
Type: null or string
Default: null
No Example
packages..components.setup.postConfigure
Type: null or string
Default: null
No Example
packages..components.setup.postHaddock
Type: null or string
Default: null
No Example
packages..components.setup.postInstall
Type: null or string
Default: null
No Example
packages..components.setup.postUnpack
Type: null or string
Default: null
No Example
packages..components.setup.preBuild
Type: null or string
Default: null
No Example
packages..components.setup.preCheck
Type: null or string
Default: null
No Example
packages..components.setup.preConfigure
Type: null or string
Default: null
No Example
packages..components.setup.preHaddock
Type: null or string
Default: null
No Example
packages..components.setup.preInstall
Type: null or string
Default: null
No Example
packages..components.setup.preUnpack
Type: null or strings concatenated with "\n"
Default: null
No Example
packages..components.setup.profilingDetail
Type: null or string
Default: "default"
No Example
packages..components.setup.setupBuildFlags
Type: list of string
Default: []
No Example
packages..components.setup.setupHaddockFlags
Type: list of string
Default: []
No Example
packages..components.setup.setupInstallFlags
Type: list of string
Default: []
No Example
packages..components.setup.shellHook
Hook to run when entering a shell
Type: unspecified value
Default: ""
No Example
packages..components.setup.testFlags
Type: list of string
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 string
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
Type: attribute set of (submodule)
Default: {}
No Example
packages..components.sublibs..asmSources
Type: list of unspecified value
Default: []
No Example
packages..components.sublibs..build-tools
Type: list of unspecified value
Default: []
No Example
packages..components.sublibs..buildable
Type: boolean
Default: true
No Example
packages..components.sublibs..cSources
Type: list of unspecified value
Default: []
No Example
packages..components.sublibs..cmmSources
Type: list of unspecified value
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
Type: list of string
Default: []
No Example
packages..components.sublibs..contentAddressed
Build content addressed derivation, requires Nix to have experimental feature
ca-derivations enabled.
Type: boolean
Default: false
No Example
packages..components.sublibs..cxxSources
Type: list of unspecified value
Default: []
No Example
packages..components.sublibs..depends
Type: list of unspecified value
Default: []
No Example
packages..components.sublibs..doCheck
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
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..enableLibraryProfiling
Type: boolean
Default: false
No Example
packages..components.sublibs..enableProfiling
Type: boolean
Default: false
No Example
packages..components.sublibs..enableSeparateDataOutput
Type: boolean
Default: true
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
Type: list of unspecified value
Default: []
No Example
packages..components.sublibs..frameworks
Type: list of package
Default: []
No Example
packages..components.sublibs..ghcOptions
Type: list of string
Default: []
No Example
packages..components.sublibs..hardeningDisable
Type: list of string
Default: []
No Example
packages..components.sublibs..hsSourceDirs
Type: list of unspecified value
Default: ["."]
No Example
packages..components.sublibs..includeDirs
Type: list of unspecified value
Default: []
No Example
packages..components.sublibs..includes
Type: list of unspecified value
Default: []
No Example
packages..components.sublibs..jsSources
Type: list of unspecified value
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
Type: list of (null or package or list of package)
Default: []
No Example
packages..components.sublibs..mainPath
Type: list of unspecified value
Default: []
No Example
packages..components.sublibs..modules
Type: list of unspecified value
Default: []
No Example
packages..components.sublibs..pkgconfig
Type: list of list of package
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
Type: null or (list of unspecified value)
Default: null
No Example
packages..components.sublibs..plugins
Type: list of (submodule)
Default: []
No Example
packages..components.sublibs..plugins.*.args
Type: list of string
Default: []
No Example
packages..components.sublibs..plugins.*.library
Type: unspecified value
No Default
No Example
packages..components.sublibs..plugins.*.moduleName
Type: string
No Default
No Example
packages..components.sublibs..postBuild
Type: null or string
Default: null
No Example
packages..components.sublibs..postCheck
Type: null or string
Default: null
No Example
packages..components.sublibs..postConfigure
Type: null or string
Default: null
No Example
packages..components.sublibs..postHaddock
Type: null or string
Default: null
No Example
packages..components.sublibs..postInstall
Type: null or string
Default: null
No Example
packages..components.sublibs..postUnpack
Type: null or string
Default: null
No Example
packages..components.sublibs..preBuild
Type: null or string
Default: null
No Example
packages..components.sublibs..preCheck
Type: null or string
Default: null
No Example
packages..components.sublibs..preConfigure
Type: null or string
Default: null
No Example
packages..components.sublibs..preHaddock
Type: null or string
Default: null
No Example
packages..components.sublibs..preInstall
Type: null or string
Default: null
No Example
packages..components.sublibs..preUnpack
Type: null or strings concatenated with "\n"
Default: null
No Example
packages..components.sublibs..profilingDetail
Type: null or string
Default: "default"
No Example
packages..components.sublibs..setupBuildFlags
Type: list of string
Default: []
No Example
packages..components.sublibs..setupHaddockFlags
Type: list of string
Default: []
No Example
packages..components.sublibs..setupInstallFlags
Type: list of string
Default: []
No Example
packages..components.sublibs..shellHook
Hook to run when entering a shell
Type: unspecified value
Default: ""
No Example
packages..components.sublibs..testFlags
Type: list of string
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 string
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
Type: attribute set of (submodule)
Default: {}
No Example
packages..components.tests..asmSources
Type: list of unspecified value
Default: []
No Example
packages..components.tests..build-tools
Type: list of unspecified value
Default: []
No Example
packages..components.tests..buildable
Type: boolean
Default: true
No Example
packages..components.tests..cSources
Type: list of unspecified value
Default: []
No Example
packages..components.tests..cmmSources
Type: list of unspecified value
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
Type: list of string
Default: []
No Example
packages..components.tests..contentAddressed
Build content addressed derivation, requires Nix to have experimental feature
ca-derivations enabled.
Type: boolean
Default: false
No Example
packages..components.tests..cxxSources
Type: list of unspecified value
Default: []
No Example
packages..components.tests..depends
Type: list of unspecified value
Default: []
No Example
packages..components.tests..doCheck
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
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..enableLibraryProfiling
Type: boolean
Default: false
No Example
packages..components.tests..enableProfiling
Type: boolean
Default: false
No Example
packages..components.tests..enableSeparateDataOutput
Type: boolean
Default: true
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
Type: list of unspecified value
Default: []
No Example
packages..components.tests..frameworks
Type: list of package
Default: []
No Example
packages..components.tests..ghcOptions
Type: list of string
Default: []
No Example
packages..components.tests..hardeningDisable
Type: list of string
Default: []
No Example
packages..components.tests..hsSourceDirs
Type: list of unspecified value
Default: ["."]
No Example
packages..components.tests..includeDirs
Type: list of unspecified value
Default: []
No Example
packages..components.tests..includes
Type: list of unspecified value
Default: []
No Example
packages..components.tests..jsSources
Type: list of unspecified value
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
Type: list of (null or package or list of package)
Default: []
No Example
packages..components.tests..mainPath
Type: list of unspecified value
Default: []
No Example
packages..components.tests..modules
Type: list of unspecified value
Default: []
No Example
packages..components.tests..pkgconfig
Type: list of list of package
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
Type: null or (list of unspecified value)
Default: null
No Example
packages..components.tests..plugins
Type: list of (submodule)
Default: []
No Example
packages..components.tests..plugins.*.args
Type: list of string
Default: []
No Example
packages..components.tests..plugins.*.library
Type: unspecified value
No Default
No Example
packages..components.tests..plugins.*.moduleName
Type: string
No Default
No Example
packages..components.tests..postBuild
Type: null or string
Default: null
No Example
packages..components.tests..postCheck
Type: null or string
Default: null
No Example
packages..components.tests..postConfigure
Type: null or string
Default: null
No Example
packages..components.tests..postHaddock
Type: null or string
Default: null
No Example
packages..components.tests..postInstall
Type: null or string
Default: null
No Example
packages..components.tests..postUnpack
Type: null or string
Default: null
No Example
packages..components.tests..preBuild
Type: null or string
Default: null
No Example
packages..components.tests..preCheck
Type: null or string
Default: null
No Example
packages..components.tests..preConfigure
Type: null or string
Default: null
No Example
packages..components.tests..preHaddock
Type: null or string
Default: null
No Example
packages..components.tests..preInstall
Type: null or string
Default: null
No Example
packages..components.tests..preUnpack
Type: null or strings concatenated with "\n"
Default: null
No Example
packages..components.tests..profilingDetail
Type: null or string
Default: "default"
No Example
packages..components.tests..setupBuildFlags
Type: list of string
Default: []
No Example
packages..components.tests..setupHaddockFlags
Type: list of string
Default: []
No Example
packages..components.tests..setupInstallFlags
Type: list of string
Default: []
No Example
packages..components.tests..shellHook
Hook to run when entering a shell
Type: unspecified value
Default: ""
No Example
packages..components.tests..testFlags
Type: list of string
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 string
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
Type: list of string
Default: []
No Example
packages..contentAddressed
Build content addressed derivation, requires Nix to have experimental feature
ca-derivations enabled.
Type: boolean
Default: false
No Example
packages..doCheck
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
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..enableLibraryProfiling
Type: boolean
Default: false
No Example
packages..enableProfiling
Type: boolean
Default: false
No Example
packages..enableSeparateDataOutput
Type: boolean
Default: true
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
Type: attribute set of boolean
No Default
No Example
packages..ghcOptions
Type: list of string
Default: []
No Example
packages..hardeningDisable
Type: list of string
Default: []
No Example
packages..keepSource
Keep component source in the store in a source output
Type: boolean
Default: false
No Example
packages..name
Type: string
Default: "${config.package.identifier.name}-${config.package.identifier.version}"
No Example
packages..package.author
Type: string
No Default
No Example
packages..package.buildType
Type: string
No Default
No Example
packages..package.buildable
Type: boolean
Default: true
No Example
packages..package.cleanHpack
Type: boolean
Default: false
No Example
packages..package.copyright
Type: string
No Default
No Example
packages..package.dataDir
Type: string
Default: ""
No Example
packages..package.dataFiles
Type: list of unspecified value
Default: []
No Example
packages..package.description
Type: string
No Default
No Example
packages..package.detailLevel
Type: string
Default: "MinimalDetails"
No Example
packages..package.extraDocFiles
Type: list of unspecified value
Default: []
No Example
packages..package.extraSrcFiles
Type: list of unspecified value
Default: []
No Example
packages..package.extraTmpFiles
Type: list of unspecified value
Default: []
No Example
packages..package.homepage
Type: string
No Default
No Example
packages..package.identifier.name
Type: string
No Default
No Example
packages..package.identifier.version
Type: string
No Default
No Example
packages..package.isLocal
Type: boolean
Default: false
No Example
packages..package.isProject
Type: boolean
Default: false
No Example
packages..package.license
Type: string
No Default
No Example
packages..package.licenseFiles
Type: list of unspecified value
Default: []
No Example
packages..package.maintainer
Type: string
No Default
No Example
packages..package.setup-depends
Type: list of unspecified value
Default: []
No Example
packages..package.specVersion
Type: string
No Default
No Example
packages..package.synopsis
Type: string
No Default
No Example
packages..package.url
Type: string
No Default
No Example
packages..patches
Type: list of (unspecified value or (path))
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
Type: null or string
Default: null
No Example
packages..postCheck
Type: null or string
Default: null
No Example
packages..postConfigure
Type: null or string
Default: null
No Example
packages..postHaddock
Type: null or string
Default: null
No Example
packages..postInstall
Type: null or string
Default: null
No Example
packages..postUnpack
Type: null or string
Default: null
No Example
packages..preBuild
Type: null or string
Default: null
No Example
packages..preCheck
Type: null or string
Default: null
No Example
packages..preConfigure
Type: null or string
Default: null
No Example
packages..preHaddock
Type: null or string
Default: null
No Example
packages..preInstall
Type: null or string
Default: null
No Example
packages..preUnpack
Type: null or strings concatenated with "\n"
Default: null
No Example
packages..profilingDetail
Type: null or string
Default: "default"
No Example
packages..revision
Type: null or signed integer
Default: null
No Example
packages..revisionSha256
Type: null or string
Default: null
No Example
packages..setupBuildFlags
Type: list of string
Default: []
No Example
packages..setupHaddockFlags
Type: list of string
Default: []
No Example
packages..setupInstallFlags
Type: list of string
Default: []
No Example
packages..sha256
Type: null or string
Default: null
No Example
packages..shellHook
Hook to run when entering a shell
Type: unspecified value
Default: ""
No Example
packages..src
Type: (path) or package
Default: "pkgs.fetchurl { url = "mirror://hackage/${config.name}.tar.gz"; inherit (config) sha256; };"
No Example
packages..testFlags
Type: list of string
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 string
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
Type: null or string
Default: null
No Example
postCheck
Type: null or string
Default: null
No Example
postConfigure
Type: null or string
Default: null
No Example
postHaddock
Type: null or string
Default: null
No Example
postInstall
Type: null or string
Default: null
No Example
postUnpack
Type: null or string
Default: null
No Example
preBuild
Type: null or string
Default: null
No Example
preCheck
Type: null or string
Default: null
No Example
preConfigure
Type: null or string
Default: null
No Example
preHaddock
Type: null or string
Default: null
No Example
preInstall
Type: null or string
Default: null
No Example
preUnpack
Type: null or strings concatenated with "\n"
Default: null
No Example
profilingDetail
Type: null or string
Default: "default"
No Example
reinstallableLibGhc
Is lib:ghc reinstallable?
Type: boolean
Default: true
No Example
setup-depends
pkgs to globally provide to Setup.hs builds
Type: list of unspecified value
Default: []
No Example
setupBuildFlags
Type: list of string
Default: []
No Example
setupHaddockFlags
Type: list of string
Default: []
No Example
setupInstallFlags
Type: list of string
Default: []
No Example
shellHook
Hook to run when entering a shell
Type: unspecified value
Default: ""
No Example
testFlags
Type: list of string
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 string
Default: []
Example:
"echo"
writeHieFiles
Write component .hie files in the store in a hie output
Type: boolean
Default: false
No Example