Skip to content
This repository has been archived by the owner on Jan 27, 2022. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
David Arnold authored and zimbatm committed Jan 1, 2021
1 parent 7027332 commit a965251
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions NixFlakes/README.md
Expand Up @@ -130,7 +130,9 @@ Here is what I found out while reading [`src/nix/flake.cc`](https://github.com/N

Where:
* `<system>` is something like "x86_64-linux".
* `<machine>` is something like "mymachine".
* `<attr>` is an attribute name like "hello".
* `<job>` is a hydra job name like "release".
* `<flake>` is a flake name like "nixpkgS".
* `<store-path>` is a /nix/store.. path

Expand All @@ -154,16 +156,16 @@ Where:
legacyPackages = TODO;
# TODO: Not sure how it's being used
overlay = final: prev: { };
# TODO: Same idea as overlay but a list of them.
overlays = [];
# TODO: Same idea as overlay but several.
overlays."<attr>" = final: prev: { };
# TODO: Not sure how it's being used
nixosModule = TODO;
# TODO: Same idea as nixosModule but a list of them.
nixosModules = [];
# TODO: Same idea as nixosModule but several
nixosModules."<attr>" = TODO;
# TODO: Not sure how it's being used
nixosConfigurations = TODO;
# TODO: Same idea as nixosModule but a list of them.
hydraJobs = TODO;
nixosConfigurations."<machine>" = TODO;
# TODO: Similar idea as for nixosModules but for hydra jobs.
hydraJobs."<job>" = TODO;
# Used by `nix flake init -t <flake>`
defaultTemplate = {
path = "<store-path>";
Expand All @@ -173,6 +175,8 @@ Where:
templates."<attr>" = { path = "<store-path>"; description = ""; );
}
```
See also:
* https://github.com/NixOS/nix/blob/master/src/nix/flake-check.md

## Building NixOS configurations with Flakes

Expand Down

0 comments on commit a965251

Please sign in to comment.