From 349a843ef413f9746ce97625328670451d5574c0 Mon Sep 17 00:00:00 2001
From: Marco Perone <pasafama@gmail.com>
Date: Wed, 31 Jul 2019 17:15:06 +0200
Subject: [PATCH] build-idris-package: add documentation on idris commands
options
---
doc/languages-frameworks/idris.section.md | 18 ++++++++++++++++++
1 file changed, 18 insertions(+)
diff --git a/doc/languages-frameworks/idris.section.md b/doc/languages-frameworks/idris.section.md
index 3025172b5c98..e88015f08e3f 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.