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

Update fetchTree docs

Browse source
This commit is contained in:
Eelco Dolstra 2023-09-28 17:08:26 +02:00
parent 856fe13533
commit 4ce7a53a9c
1 changed files with 8 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
src/libexpr/primops/fetchTree.cc
View file

@ -177,12 +177,12 @@ static RegisterPrimOp primop_fetchTree({
.args = {"input"}, .args = {"input"},
.doc = R"( .doc = R"(
Fetch a source tree or a plain file using one of the supported backends. Fetch a source tree or a plain file using one of the supported backends.
*input* can be an attribute set representation of [flake reference](@docroot@/command-ref/new-cli/nix3-flake.md#flake-references) or a URL. *input* must be a [flake reference](@docroot@/command-ref/new-cli/nix3-flake.md#flake-references), either in attribute set representation or in the URL-like syntax.
The input should be "locked", that is, it should contain a commit hash or content hash unless impure evaluation (`--impure`) is allowed. The input should be "locked", that is, it should contain a commit hash or content hash unless impure evaluation (`--impure`) is enabled.
Here are some examples of how to use `fetchTree`: Here are some examples of how to use `fetchTree`:
- Fetch a GitHub repository: - Fetch a GitHub repository using the attribute set representation:
```nix ```nix
builtins.fetchTree { builtins.fetchTree {
@ -193,7 +193,7 @@ static RegisterPrimOp primop_fetchTree({
} }
``` ```
This evaluates to attribute set: This evaluates to the following attribute set:
``` ```
{ {
@ -205,15 +205,12 @@ static RegisterPrimOp primop_fetchTree({
shortRev = "ae2e6b3"; shortRev = "ae2e6b3";
} }
``` ```
- Fetch a single file from a URL:
```nix - Fetch the same GitHub repository using the URL-like syntax:
builtins.fetchTree "https://example.com/"
```
builtins.fetchTree "github:NixOS/nixpkgs/ae2e6b3958682513d28f7d633734571fb18285dd"
``` ```
> **Note**
>
> This function requires the [`flakes` experimental feature](@docroot@/contributing/experimental-features.md#xp-feature-flakes) to be enabled.
)", )",
.fun = prim_fetchTree, .fun = prim_fetchTree,
.experimentalFeature = Xp::Flakes, .experimentalFeature = Xp::Flakes,