Skip to content
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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the derivation build process and sandbox #8888

Open
2 tasks done
roberth opened this issue Aug 31, 2023 · 0 comments
Open
2 tasks done

Document the derivation build process and sandbox #8888

roberth opened this issue Aug 31, 2023 · 0 comments

Comments

@roberth
Copy link
Member

roberth commented Aug 31, 2023

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)

Checklist

Priorities

Add 👍 to issues you find important.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant