Document several undocumented builtin functions#8491
Document several undocumented builtin functions#8491Ericson2314 merged 2 commits intoNixOS:masterfrom
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.
wentasah
changed the title
|
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 <[email protected]>
|
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! |
fricklerhandwerk
added
documentation
language
5 participants
Motivation
I've found that
builtins.fromTOMLis not documented in the Nix manual. This PR adds the documentation of this function as well as of few others.Context
fetchTreedocumentation took into account comments in #6740.Checklist for maintainers
Maintainers: tick if completed or explain if not relevant
tests/**.shsrc/*/teststests/nixos/*Priorities
Add 👍 to pull requests you find important.