1
1
mirror of https://github.com/divnix/digga.git synced 2024-11-22 18:58:21 +03:00
digga/doc/api-reference.md
David Arnold fee8829dd7 docs: add general docs (w/o library reference)
library reference expected to come as soon as flake-utils-plus has
the corresponding implementation.
2022-02-23 15:23:14 -08:00

940 B
Executable File

Top Level API

digga's top level api. API Containers are documented in their respective subchapter:

channelsConfig

nixpkgs config for all channels

Type: attribute set or path convertible to it

Default

{}

inputs

The flake's inputs

Type: attribute set of nix flakes

outputsBuilder

builder for flake system-spaced outputs The builder gets passed an attrset of all channels

Type: function that evaluates to a(n) attrs or path convertible to it

Default

"channels: { }"

self

The flake to create the devos outputs for

Type: nix flake

supportedSystems

The systems supported by this flake

Type: list of strings

Default

["aarch64-linux","i686-linux","x86_64-darwin","x86_64-linux"]