Skip to content

add fetchTree docs #6740

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
elikoga wants to merge 2 commits into from
Closed

add fetchTree docs #6740

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1b6876f
add fetchTree docs
elikoga Jun 29, 2022
9a3e681
Update src/libexpr/primops/fetchTree.cc
elikoga Jul 11, 2022
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
18 changes: 16 additions & 2 deletions src/libexpr/primops/fetchTree.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,8 +182,22 @@ static void prim_fetchTree(EvalState & state, const PosIdx pos, Value * * args,
fetchTree(state, pos, args, v, std::nullopt, FetchTreeParams { .allowNameArgument = false });
}

// FIXME: document
static RegisterPrimOp primop_fetchTree("fetchTree", 1, prim_fetchTree);
static RegisterPrimOp primop_fetchTree({
.name = "fetchTree",
.args = {"args"},
.arity = 1,
.doc = R"(
`builtins.fetchTree` allows fetching a source tree using any
backends supported by the fetcher infrastructure. It subsumes the
Copy link
Member

@edolstra edolstra Jul 11, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't mention "fetcher infrastructure". Instead it can refer to the docs on flake references (https://nixos.org/manual/nix/stable/command-ref/new-cli/nix3-flake.html#flake-references), specifically the attrset form.

functionality of existing built-ins like `fetchGit`,
`fetchMercurial` and `fetchTarball`.

`builtins.fetchTree` can be used to fetch
plain files over the `http(s)` and `file` protocols in addition to
directory tarballs.
)",
Copy link
Member

@edolstra edolstra Jul 11, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There should be one or two examples here of how to use fetchTree.

It should also mention that fetchTree is experimental and that it requires a locked flakeref in pure eval mode (which is the default).

.fun = prim_fetchTree,
});

static void fetch(EvalState & state, const PosIdx pos, Value * * args, Value & v,
const std::string & who, bool unpack, std::string name)
Expand Down