Documentation Gaps: Difference between revisions

(2 intermediate revisions by 2 users not shown)

Line 1:

~~= Documentation Gaps =~~

{{Merge|FAQ|This is quite literally an FAQ outside of the FAQ page.}}

~~It's possible this is just me, but I find that there's several concepts implied by the Nix manuals that aren't explained well there. I'd like to contribute~~ documentation ~~for those myself, but there are cases where I don't understand it myself. (Or else I wouldn't want there to be documentation.)~~

This page details some known documentation gaps in the official NixOS/Nixpkgs documentation.

~~There's no small danger that as I learn the answers to my questions, I'll forget the question~~ in the ~~first place, so I'd like to keep a little list of them here, by way of note taking.~~

I've noticed that several members of the community seem to know answers to these questions off the top of their heads - I hope they don't take the existence of this page personally: I'd love to bug them less on IRC.

== What are setup hooks? ==

Line 22:

Line 18:

AFAICT, <code>nix-env</code> somehow assembles a <code>buildEnv</code> expression and the realization of that expression becomes a profile, somehow.

# [https://github.com/NixOS/nix/blob/~~215b70f51e5abd350c9b7db656aedac9d96d0046~~/src/nix-env/user-env.cc#~~L108~~ '''nix'''/user-env/]

# [https://github.com/NixOS/nix/blob/2c42a9dbaa805f4f29561d9a1c10b41dfe98dcfa/src/nix-env/user-env.cc#L123 '''nix'''/user-env/]

# [https://github.com/NixOS/nix/blob/master/~~corepkgs~~/buildenv.nix '''nix'''/~~corepkgs~~/buildenv.nix]

# [https://github.com/NixOS/nix/blob/master/src/nix-env/buildenv.nix '''nix'''/src/nix-env/buildenv.nix]

# [https://github.com/NixOS/nix/~~tree~~/master/src/buildenv '''nix'''/src/buildenv/]

# [https://github.com/NixOS/nix/blob/master/src/libstore/builtins/buildenv.cc '''nix'''/src/libstore/builtins/buildenv.cc]

'''#1''' loads the nix file in '''#2''' and uses it to merge everything together, and '''#2''' uses a copy of '''#3''' that was compiled when nix got built.

@@ Line 1: / Line 1: @@
-= Documentation Gaps =
+{{Merge|FAQ|This is quite literally an FAQ outside of the FAQ page.}}
-It's possible this is just me, but I find that there's several concepts implied by the Nix manuals that aren't explained well there. I'd like to contribute documentation for those myself, but there are cases where I don't understand it myself. (Or else I wouldn't want there to be documentation.)
+This page details some known documentation gaps in the official NixOS/Nixpkgs documentation.
-There's no small danger that as I learn the answers to my questions, I'll forget the question in the first place, so I'd like to keep a little list of them here, by way of note taking.
-I've noticed that several members of the community seem to know answers to these questions off the top of their heads - I hope they don't take the existence of this page personally: I'd love to bug them less on IRC.
 == What are setup hooks? ==
@@ Line 22: / Line 18: @@
 AFAICT, <code>nix-env</code> somehow assembles a <code>buildEnv</code> expression and the realization of that expression becomes a profile, somehow.
-# [https://github.com/NixOS/nix/blob/215b70f51e5abd350c9b7db656aedac9d96d0046/src/nix-env/user-env.cc#L108 '''nix'''/user-env/]
+# [https://github.com/NixOS/nix/blob/2c42a9dbaa805f4f29561d9a1c10b41dfe98dcfa/src/nix-env/user-env.cc#L123 '''nix'''/user-env/]
-# [https://github.com/NixOS/nix/blob/master/corepkgs/buildenv.nix '''nix'''/corepkgs/buildenv.nix]
+# [https://github.com/NixOS/nix/blob/master/src/nix-env/buildenv.nix '''nix'''/src/nix-env/buildenv.nix]
-# [https://github.com/NixOS/nix/tree/master/src/buildenv '''nix'''/src/buildenv/]
+# [https://github.com/NixOS/nix/blob/master/src/libstore/builtins/buildenv.cc '''nix'''/src/libstore/builtins/buildenv.cc]
 '''#1''' loads the nix file in '''#2''' and uses it to merge everything together, and '''#2''' uses a copy of '''#3''' that was compiled when nix got built.