mirrors/flake-utils
mirrors/flake-utils
1
0
Fork 0
mirror of https://github.com/numtide/flake-utils.git synced 2025-03-16 21:38:26 +00:00
Code Activity

REAMDE: document the systems pattern a bit more

Browse source
This commit is contained in:
zimbatm 2023-04-11 10:47:17 +02:00
parent 033b9f258c
commit cfacdce06f
No known key found for this signature in database
GPG key ID: 71BAF6D40C1D63D7
1 changed files with 27 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -30,11 +30,35 @@ Eg: instead of typing `"x86_64-linux"`, use `system.x86_64-linux`.
A list of all systems defined in nixpkgs. For a smaller list see `defaultSystems`. A list of all systems defined in nixpkgs. For a smaller list see `defaultSystems`.
### `defaultSystems :: [<system>]` (deprecated) ### `defaultSystems :: [<system>]`
The list of systems passed to the flake-utils `systems` input. The list of systems to use in `eachDefaultSystem` and `simpleFlake`.
Use this pattern to pass different systems to your flake: <https://github.com/nix-systems/nix-systems>. The default values are `["x86_64-linux" "aarch64-linux" "x86_64-darwin" "aarch64-darwin"]`.
It's possible to override and control that list by changing the `systems` input of this flake.
Eg (in your `flake.nix`):
```nix
{
# 1. Defined a "systems" inputs that maps to only ["x86_64-linux"]
inputs.systems.url = "github:nix-systems/x86_64-linux";
inputs.flake-utils.src = "github:numtide/flake-utils";
# 2. Override the flake-utils default to your version
inputs.flake-utils.inputs.systems.follows = "systems";
outputs = { self, flake-utils, ... }:
# Now eachDefaultSystem is only using ["x86_64-linux"], but this list can also
# further be changed by users of your flake.
flake-utils.lib.eachDefaultSystem (system: {
# ...
});
}
```
For more details in this pattern, see: <https://github.com/nix-systems/nix-systems>.
### `eachSystem :: [<system>] -> (<system> -> attrs)` ### `eachSystem :: [<system>] -> (<system> -> attrs)`