diff options
author | Graham Christensen <graham@grahamc.com> | 2018-03-24 10:47:41 -0400 |
---|---|---|
committer | Graham Christensen <graham@grahamc.com> | 2018-03-25 19:52:00 -0400 |
commit | 92d53362d4da7e19b6a7a6b1b936a0a34a17c0c9 (patch) | |
tree | 0181e4b13913552df774069766369a5f75babbef /doc/languages-frameworks/idris.section.md | |
parent | a0c525bd0a93fba70471392b8651882b52197788 (diff) |
Move all nixpkgs doc files in to the doc directory
This makes a makefile-driven developer workflow nicer.
Diffstat (limited to 'doc/languages-frameworks/idris.section.md')
-rw-r--r-- | doc/languages-frameworks/idris.section.md | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/doc/languages-frameworks/idris.section.md b/doc/languages-frameworks/idris.section.md new file mode 100644 index 00000000000..005ed360285 --- /dev/null +++ b/doc/languages-frameworks/idris.section.md @@ -0,0 +1,39 @@ +Idris packages +============== + +This directory contains build rules for idris packages. In addition, +it contains several functions to build and compose those packages. +Everything is exposed to the user via the `idrisPackages` attribute. + +callPackage +------------ + +This is like the normal nixpkgs callPackage function, specialized to +idris packages. + +builtins +--------- + +This is a list of all of the libraries that come packaged with Idris +itself. + +build-idris-package +-------------------- + +A function to build an idris package. Its sole argument is a set like +you might pass to `stdenv.mkDerivation`, except `build-idris-package` +sets several attributes for you. See `build-idris-package.nix` for +details. + +build-builtin-package +---------------------- + +A version of `build-idris-package` specialized to builtin libraries. +Mostly for internal use. + +with-packages +------------- + +Bundle idris together with a list of packages. Because idris currently +only supports a single directory in its library path, you must include +all desired libraries here, including `prelude` and `base`.
\ No newline at end of file |