diff options
author | Marco Perone <pasafama@gmail.com> | 2019-07-31 17:15:06 +0200 |
---|---|---|
committer | Marco Perone <pasafama@gmail.com> | 2019-08-06 09:11:37 +0200 |
commit | 349a843ef413f9746ce97625328670451d5574c0 (patch) | |
tree | 2c0f2149ba9ad2540d4e3840c9d783fc6b06e071 /doc/languages-frameworks | |
parent | 8a02fa477f7ae58061f5d53060dc9f36f1e53d2a (diff) |
build-idris-package: add documentation on idris commands options
Diffstat (limited to 'doc/languages-frameworks')
-rw-r--r-- | doc/languages-frameworks/idris.section.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/languages-frameworks/idris.section.md b/doc/languages-frameworks/idris.section.md index 3025172b5c981..e88015f08e3f8 100644 --- a/doc/languages-frameworks/idris.section.md +++ b/doc/languages-frameworks/idris.section.md @@ -124,3 +124,21 @@ in another file (say `default.nix`) to be able to build it with ``` $ nix-build -A yaml ``` + +## Passing options to `idris` commands + +The `build-idris-package` function provides also optional input values to set additional options for the used `idris` commands. + +Specifically, you can set `idrisBuildOptions`, `idrisTestOptions`, `idrisInstallOptions` and `idrisDocOptions` to provide additional options to the `idris` command respectively when building, testing, installing and generating docs for your package. + +For example you could set + +``` +build-idris-package { + idrisBuildOptions = [ "--log" "1" "--verbose" ] + + ... +} +``` + +to require verbose output during `idris` build phase. |