Skip to content

fetchtree: initial documentation for builtin #8867

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Mic92 wants to merge 1 commit into from
Closed

fetchtree: initial documentation for builtin #8867

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion src/libexpr/primops/fetchTree.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,24 @@ static void prim_fetchTree(EvalState & state, const PosIdx pos, Value * * args,
static RegisterPrimOp primop_fetchTree({
.name = "fetchTree",
.arity = 1,
.fun = prim_fetchTree
.doc = R"(
Fetches a source tree using any backends supported by the fetcher infrastructure. It subsumes the functionality of existing built-ins like fetchGit, fetchMercurial and fetchTarball.

Examples:

```nix
builtins.fetchTree { type = "github"; owner = "NixOS"; repo = "nixpkgs"; }
```

```nix
builtins.fetchTree { type = "git"; url = "file:////tmp/nix/git"; }
```

```nix
builtins.fetchTree { type = "sourcehut"; owner = "~NixOS"; repo = "nixpkgs"; }
```
)",
.fun = prim_fetchTree,
});

static void fetch(EvalState & state, const PosIdx pos, Value * * args, Value & v,
Expand Down