emilytrau/lix
1
0
Fork 0
forked from lix-project/lix
Code Pull requests Activity

Document getFlake

Browse source 
Fixes #5523.
This commit is contained in:
Eelco Dolstra 2022-03-25 14:19:55 +01:00
parent 86b05ccd54
commit 8c363eb3eb
1 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
src/libexpr/flake/flake.cc
View file

@ -724,6 +724,24 @@ static void prim_getFlake(EvalState & state, const Pos & pos, Value * * args, Va
static RegisterPrimOp r2({ static RegisterPrimOp r2({
.name = "__getFlake", .name = "__getFlake",
.args = {"args"}, .args = {"args"},
.doc = R"(
Fetch a flake from a flake reference, and return its output attributes and some metadata. For example:
```nix
(builtins.getFlake "nix/55bc52401966fbffa525c574c14f67b00bc4fb3a").packages.x86_64-linux.nix
```
Unless impure evaluation is allowed (`--impure`), the flake reference
must be "locked", e.g. contain a Git revision or content hash. An
example of an unlocked usage is:
```nix
(builtins.getFlake "github:edolstra/dwarffs").rev
```
This function is only available if you enable the experimental feature
`flakes`.
)",
.fun = prim_getFlake, .fun = prim_getFlake,
.experimentalFeature = Xp::Flakes, .experimentalFeature = Xp::Flakes,
}); });