[Nix#8888] Document the derivation build process and sandbox #121

New issue

Open

opened 2024-03-16 06:45:00 +00:00 by lix-bot · 1 comment

lix-bot commented

2024-03-16 06:45:00 +00:00

Member

Upstream-Issue: NixOS/nix#8888

Problem

Proposal

A new page or reorganized sections on the derivation page that describe

what building a derivation entails, outline (require inputs' outputs, run builder, check outputs, probably sandbox)
what is the process in more detail?
- it requires that dependencies' outputs are available (valid)
- how is the environment set up
- run the builder
- what is the builder expected to do?
- final checks (refer to the advanced derivation attrs)
- what effect does recursive nix have? dynamic derivations?
- anything different for ca? fod?
what the sandbox is like on each platform
- which files are available
- which permissions are available
- quirks

Not in scope for this issue, but perhaps worth linking:

Scheduling constraints
Stdenv concepts
- the build is virtually always specified by Nixpkgs stdenv, and almost never by you

Place relevant links in the docs touched by (or grep for the number of this issue, 8888)

https://github.com/NixOS/nix/pull/7592

Checklist

checked latest Nix manual (source)
checked open documentation issues and pull requests for possible duplicates

Priorities

Add 👍 to issues you find important.

Upstream-Issue: https://git.lix.systems/NixOS/nix/issues/8888 ## Problem  ## Proposal A new page or reorganized sections on the derivation page that describe - what building a derivation entails, outline (require inputs' outputs, run builder, check outputs, probably sandbox) - what is the process in more detail? - it requires that dependencies' outputs are available (valid) - how is the environment set up - run the builder - what is the builder expected to do? - final checks (refer to the advanced derivation attrs) - what effect does recursive nix have? dynamic derivations? - anything different for ca? fod? - what the sandbox is like on each platform - which files are available - which permissions are available - quirks Not in scope for this issue, but perhaps worth linking: - Scheduling constraints - Stdenv concepts - the build is virtually always specified by Nixpkgs stdenv, and almost never by you Place relevant links in the docs touched by (or grep for the number of this issue, `8888`) - https://github.com/NixOS/nix/pull/7592 ## Checklist  - [x] checked [latest Nix manual] \([source]) - [x] checked [open documentation issues and pull requests] for possible duplicates [latest Nix manual]: https://nixos.org/manual/nix/unstable/ [source]: https://github.com/NixOS/nix/tree/master/doc/manual/src [open documentation issues and pull requests]: https://github.com/NixOS/nix/labels/documentation ## Priorities Add :+1: to [issues you find important](https://github.com/NixOS/nix/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc).