Skip to content

add fetchTree docs#6740

Closed
elikoga wants to merge 2 commits intoNixOS:masterfrom
elikoga:document-fetchTree
Closed

add fetchTree docs#6740
elikoga wants to merge 2 commits intoNixOS:masterfrom
elikoga:document-fetchTree

Conversation

@elikoga
Copy link
Contributor

@elikoga elikoga commented Jun 29, 2022

Relates to #6728 and removes the fixme in

// FIXME: document

Maybe someone can add a few words about what fetchTree actually does so we can expand the text

Otherwise I'll rework the text over the next few days

@elikoga
Copy link
Contributor Author

elikoga commented Jun 29, 2022

Ouch, just saw #5556

Can rework this to that state if needed/requested

The fetcher infrastructure is exposed via the `fetchTree` built-in.

`builtins.fetchTree` allows fetching a source tree using any
backends supported by the fetcher infrastructure. It subsumes the
Copy link
Member

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.

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

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).

@stale stale bot added the stale label May 21, 2023
wentasah added a commit to wentasah/nix that referenced this pull request Jun 11, 2023
wentasah added a commit to wentasah/nix that referenced this pull request Jun 13, 2023
wentasah added a commit to wentasah/nix that referenced this pull request Jun 14, 2023
@Ericson2314
Copy link
Member

Ericson2314 commented Jun 23, 2023

#8509 uh oh, we now have two contributions for this in a half-finished state. CC @fricklerhandwerk

And #5556 before that!

@stale stale bot removed the stale label Jun 23, 2023
@fricklerhandwerk
Copy link
Contributor

Closing in favor of #8509. Sorry for the wasted time, everyone. I hope we'll continuously get get better at reviewing in a timely manner now that we have a maintainers team.

wentasah added a commit to wentasah/nix that referenced this pull request Jun 25, 2023
Co-authored-by: Valentin Gagarin <[email protected]>

Supersedes NixOS#6740
edolstra pushed a commit to edolstra/nix that referenced this pull request Sep 28, 2023
Co-authored-by: Valentin Gagarin <[email protected]>

Supersedes NixOS#6740
edolstra pushed a commit to edolstra/nix that referenced this pull request Sep 28, 2023
Co-authored-by: Valentin Gagarin <[email protected]>

Supersedes NixOS#6740
edolstra pushed a commit to edolstra/nix that referenced this pull request Oct 13, 2023
Co-authored-by: Valentin Gagarin <[email protected]>

Supersedes NixOS#6740
Ericson2314 pushed a commit to obsidiansystems/nix that referenced this pull request Oct 16, 2023
Co-authored-by: Valentin Gagarin <[email protected]>

Supersedes NixOS#6740
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants