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.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
Document several undocumented builtin functions #8491
Conversation
This will allow documenting them (in later commits). Note that we keep the old constructor even if it is no longer used by Nix code, because it is used in tests/plugins/plugintest.cc, which suggests that it might be used by some external plugin.
I've applied the suggestions. I'll try to reformulate I tried to figure out what is a immutable flake ref, but a quick look into the manual and source code does not show anything. I guess that it might be either a reference to a git repo locked in |
I suggest splitting things out into separate PRs where you expect they'd need more work, simply to avoid blocking things on each other. I've seen 3 sentence PRs being open for months because they require figuring out non-trivial things, which in combination with intermittent availability of PR authors and maintainers leads to long waiting times. |
Good point. I've removed the fetchTree commit from this PR and will submit it later in #8509. |
Until now, these functions were completely missing in the Nix manual. Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
Thank you @fricklerhandwerk. This is definitely much better than how I would be able to formulate it. I've added you to the |
Thanks everyone, this is very nicely done! |
Motivation
I've found that
builtins.fromTOML
is not documented in the Nix manual. This PR adds the documentation of this function as well as of few others.Context
fetchTree
documentation took into account comments in #6740.Checklist for maintainers
Maintainers: tick if completed or explain if not relevant
tests/**.sh
src/*/tests
tests/nixos/*
Priorities
Add 馃憤 to pull requests you find important.