31206 files changed+3050341−36277
28206 more files changed are not listed.
.editorconfignew file+87
@@ -0,0 +1,87 @@
1+# EditorConfig configuration for nixpkgs
2+# https://EditorConfig.org
3+
4+# Top-most EditorConfig file
5+root = true
6+
7+# Unix-style newlines with a newline ending every file, utf-8 charset
8+[*]
9+end_of_line = lf
10+insert_final_newline = true
11+trim_trailing_whitespace = true
12+charset = utf-8
13+
14+# Ignore diffs/patches
15+[*.{diff,patch}]
16+end_of_line = unset
17+insert_final_newline = unset
18+trim_trailing_whitespace = unset
19+
20+# see https://nixos.org/nixpkgs/manual/#chap-conventions
21+
22+# Match json/lockfiles/markdown/nix/perl/python/ruby/shell/docbook files, set indent to spaces
23+[*.{json,lock,md,nix,pl,pm,py,rb,sh,xml}]
24+indent_style = space
25+
26+# Match docbook files, set indent width of one
27+[*.xml]
28+indent_size = 1
29+
30+# Match json/lockfiles/markdown/nix/ruby files, set indent width of two
31+[*.{json,lock,md,nix,rb}]
32+indent_size = 2
33+
34+# Match perl/python/shell scripts, set indent width of four
35+[*.{pl,pm,py,sh}]
36+indent_size = 4
37+
38+# Match gemfiles, set indent to spaces with width of two
39+[Gemfile]
40+indent_size = 2
41+indent_style = space
42+
43+# Disable file types or individual files
44+# some of these files may be auto-generated and/or require significant changes
45+
46+[*.{c,h}]
47+insert_final_newline = unset
48+trim_trailing_whitespace = unset
49+
50+[*.{asc,key,ovpn}]
51+insert_final_newline = unset
52+end_of_line = unset
53+trim_trailing_whitespace = unset
54+
55+[*.lock]
56+indent_size = unset
57+
58+# trailing whitespace is an actual syntax element of classic Markdown/
59+# CommonMark to enforce a line break
60+[*.md]
61+trim_trailing_whitespace = unset
62+
63+[eggs.nix]
64+trim_trailing_whitespace = unset
65+
66+[nixos/modules/services/networking/ircd-hybrid/*.{conf,in}]
67+trim_trailing_whitespace = unset
68+
69+[pkgs/build-support/dotnetenv/Wrapper/**]
70+end_of_line = unset
71+indent_style = unset
72+insert_final_newline = unset
73+trim_trailing_whitespace = unset
74+
75+[pkgs/development/compilers/elm/registry.dat]
76+end_of_line = unset
77+insert_final_newline = unset
78+
79+[pkgs/development/haskell-modules/hackage-packages.nix]
80+indent_style = unset
81+trim_trailing_whitespace = unset
82+
83+[pkgs/servers/dict/wordnet_structures.py]
84+trim_trailing_whitespace = unset
85+
86+[pkgs/tools/misc/timidity/timidity.cfg]
87+trim_trailing_whitespace = unset
.git-blame-ignore-revsnew file+32
@@ -0,0 +1,32 @@
1+# This file contains a list of commits that are not likely what you
2+# are looking for in a blame, such as mass reformatting or renaming.
3+# You can set this file as a default ignore file for blame by running
4+# the following command.
5+#
6+# $ git config blame.ignoreRevsFile .git-blame-ignore-revs
7+#
8+# To temporarily not use this file add
9+# --ignore-revs-file=""
10+# to your blame command.
11+#
12+# The ignoreRevsFile can't be set globally due to blame failing if the file isn't present.
13+# To not have to set the option in every repository it is needed in,
14+# save the following script in your path with the name "git-bblame"
15+# now you can run
16+# $ git bblame $FILE
17+# to use the .git-blame-ignore-revs file if it is present.
18+#
19+# #!/usr/bin/env bash
20+# repo_root=$(git rev-parse --show-toplevel)
21+# if [[ -e $repo_root/.git-blame-ignore-revs ]]; then
22+# git blame --ignore-revs-file="$repo_root/.git-blame-ignore-revs" $@
23+# else
24+# git blame $@
25+# fi
26+
27+
28+# nixos/modules/rename: Sort alphabetically
29+1f71224fe86605ef4cd23ed327b3da7882dad382
30+
31+# nixos: fix module paths in rename.nix
32+d08ede042b74b8199dc748323768227b88efcf7c
.gitattributesnew file+16
@@ -0,0 +1,16 @@
1+**/deps.nix linguist-generated
2+**/node-packages.nix linguist-generated
3+
4+pkgs/applications/editors/emacs-modes/*-generated.nix linguist-generated
5+pkgs/development/r-modules/*-packages.nix linguist-generated
6+pkgs/development/haskell-modules/hackage-packages.nix linguist-generated
7+pkgs/development/beam-modules/hex-packages.nix linguist-generated
8+
9+doc/** linguist-documentation
10+doc/default.nix linguist-documentation=false
11+
12+nixos/doc/** linguist-documentation
13+nixos/doc/default.nix linguist-documentation=false
14+
15+nixos/modules/module-list.nix merge=union
16+# pkgs/top-level/all-packages.nix merge=union
.github/CODEOWNERSnew file+291
@@ -0,0 +1,291 @@
1+# CODEOWNERS file
2+#
3+# This file is used to describe who owns what in this repository. This file does not
4+# replace `meta.maintainers` but is instead used for other things than derivations
5+# and modules, like documentation, package sets, and other assets.
6+#
7+# For documentation on this file, see https://help.github.com/articles/about-codeowners/
8+# Mentioned users will get code review requests.
9+#
10+# IMPORTANT NOTE: in order to actually get pinged, commit access is required.
11+# This also holds true for GitHub teams. Since almost none of our teams have write
12+# permissions, you need to list all members of the team with commit access individually.
13+
14+# This file
15+/.github/CODEOWNERS @edolstra
16+
17+# GitHub actions
18+/.github/workflows @NixOS/Security @Mic92 @zowoq
19+/.github/workflows/merge-staging @FRidh
20+
21+# EditorConfig
22+/.editorconfig @Mic92 @zowoq
23+
24+# Libraries
25+/lib @edolstra @nbp @infinisil
26+/lib/systems @alyssais @nbp @ericson2314 @matthewbauer
27+/lib/generators.nix @edolstra @nbp @Profpatsch
28+/lib/cli.nix @edolstra @nbp @Profpatsch
29+/lib/debug.nix @edolstra @nbp @Profpatsch
30+/lib/asserts.nix @edolstra @nbp @Profpatsch
31+
32+# Nixpkgs Internals
33+/default.nix @nbp
34+/pkgs/top-level/default.nix @nbp @Ericson2314
35+/pkgs/top-level/impure.nix @nbp @Ericson2314
36+/pkgs/top-level/stage.nix @nbp @Ericson2314 @matthewbauer
37+/pkgs/top-level/splice.nix @Ericson2314 @matthewbauer
38+/pkgs/top-level/release-cross.nix @Ericson2314 @matthewbauer
39+/pkgs/stdenv/generic @Ericson2314 @matthewbauer
40+/pkgs/stdenv/cross @Ericson2314 @matthewbauer
41+/pkgs/build-support/cc-wrapper @Ericson2314
42+/pkgs/build-support/bintools-wrapper @Ericson2314
43+/pkgs/build-support/setup-hooks @Ericson2314
44+/pkgs/build-support/setup-hooks/auto-patchelf.sh @layus
45+/pkgs/build-support/setup-hooks/auto-patchelf.py @layus
46+
47+# Nixpkgs build-support
48+/pkgs/build-support/writers @lassulus @Profpatsch
49+
50+# Nixpkgs documentation
51+/maintainers/scripts/db-to-md.sh @jtojnar @ryantm
52+/maintainers/scripts/doc @jtojnar @ryantm
53+/doc/build-aux/pandoc-filters @jtojnar
54+/doc/contributing/contributing-to-documentation.chapter.md @jtojnar
55+
56+# NixOS Internals
57+/nixos/default.nix @nbp @infinisil
58+/nixos/lib/from-env.nix @nbp @infinisil
59+/nixos/lib/eval-config.nix @nbp @infinisil
60+/nixos/doc/manual/configuration/abstractions.xml @nbp
61+/nixos/doc/manual/configuration/config-file.xml @nbp
62+/nixos/doc/manual/configuration/config-syntax.xml @nbp
63+/nixos/doc/manual/configuration/modularity.xml @nbp
64+/nixos/doc/manual/development/assertions.xml @nbp
65+/nixos/doc/manual/development/meta-attributes.xml @nbp
66+/nixos/doc/manual/development/option-declarations.xml @nbp
67+/nixos/doc/manual/development/option-def.xml @nbp
68+/nixos/doc/manual/development/option-types.xml @nbp
69+/nixos/doc/manual/development/replace-modules.xml @nbp
70+/nixos/doc/manual/development/writing-modules.xml @nbp
71+/nixos/doc/manual/man-nixos-option.xml @nbp
72+/nixos/modules/installer/tools/nixos-option.sh @nbp
73+/nixos/modules/system @dasJ
74+
75+# NixOS integration test driver
76+/nixos/lib/test-driver @tfc
77+
78+# Systemd
79+/nixos/modules/system/boot/systemd.nix @NixOS/systemd
80+/nixos/modules/system/boot/systemd @NixOS/systemd
81+/nixos/lib/systemd-*.nix @NixOS/systemd
82+/pkgs/os-specific/linux/systemd @NixOS/systemd
83+
84+# Updaters
85+## update.nix
86+/maintainers/scripts/update.nix @jtojnar
87+/maintainers/scripts/update.py @jtojnar
88+## common-updater-scripts
89+/pkgs/common-updater/scripts/update-source-version @jtojnar
90+
91+# Python-related code and docs
92+/maintainers/scripts/update-python-libraries @FRidh
93+/pkgs/top-level/python-packages.nix @FRidh @jonringer
94+/pkgs/development/interpreters/python @FRidh
95+/pkgs/development/python-modules @FRidh @jonringer
96+/doc/languages-frameworks/python.section.md @FRidh
97+/pkgs/development/tools/poetry2nix @adisbladis
98+/pkgs/development/interpreters/python/hooks @FRidh @jonringer
99+
100+# Haskell
101+/doc/languages-frameworks/haskell.section.md @cdepillabout @sternenseemann @maralorn @expipiplus1
102+/maintainers/scripts/haskell @cdepillabout @sternenseemann @maralorn @expipiplus1
103+/pkgs/development/compilers/ghc @cdepillabout @sternenseemann @maralorn @expipiplus1
104+/pkgs/development/haskell-modules @cdepillabout @sternenseemann @maralorn @expipiplus1
105+/pkgs/test/haskell @cdepillabout @sternenseemann @maralorn @expipiplus1
106+/pkgs/top-level/release-haskell.nix @cdepillabout @sternenseemann @maralorn @expipiplus1
107+/pkgs/top-level/haskell-packages.nix @cdepillabout @sternenseemann @maralorn @expipiplus1
108+
109+# Perl
110+/pkgs/development/interpreters/perl @stigtsp @zakame
111+/pkgs/top-level/perl-packages.nix @stigtsp @zakame
112+/pkgs/development/perl-modules @stigtsp @zakame
113+
114+# R
115+/pkgs/applications/science/math/R @jbedo
116+/pkgs/development/r-modules @jbedo
117+
118+# Ruby
119+/pkgs/development/interpreters/ruby @marsam
120+/pkgs/development/ruby-modules @marsam
121+
122+# Rust
123+/pkgs/development/compilers/rust @Mic92 @LnL7 @zowoq
124+/pkgs/build-support/rust @zowoq
125+/doc/languages-frameworks/rust.section.md @zowoq
126+
127+# C compilers
128+/pkgs/development/compilers/gcc @matthewbauer
129+/pkgs/development/compilers/llvm @matthewbauer
130+
131+# Compatibility stuff
132+/pkgs/top-level/unix-tools.nix @matthewbauer
133+/pkgs/development/tools/xcbuild @matthewbauer
134+
135+# Audio
136+/nixos/modules/services/audio/botamusique.nix @mweinelt
137+/nixos/modules/services/audio/snapserver.nix @mweinelt
138+/nixos/tests/modules/services/audio/botamusique.nix @mweinelt
139+/nixos/tests/snapcast.nix @mweinelt
140+
141+# Browsers
142+/pkgs/applications/networking/browsers/firefox @mweinelt
143+
144+# Jetbrains
145+/pkgs/applications/editors/jetbrains @edwtjo
146+
147+# Licenses
148+/lib/licenses.nix @alyssais
149+
150+# Qt / KDE
151+/pkgs/applications/kde @ttuegel
152+/pkgs/desktops/plasma-5 @ttuegel
153+/pkgs/development/libraries/kde-frameworks @ttuegel
154+/pkgs/development/libraries/qt-5 @ttuegel
155+
156+# PostgreSQL and related stuff
157+/pkgs/servers/sql/postgresql @thoughtpolice @marsam
158+/nixos/modules/services/databases/postgresql.xml @thoughtpolice
159+/nixos/modules/services/databases/postgresql.nix @thoughtpolice
160+/nixos/tests/postgresql.nix @thoughtpolice
161+
162+# Hardened profile & related modules
163+/nixos/modules/profiles/hardened.nix @joachifm
164+/nixos/modules/security/hidepid.nix @joachifm
165+/nixos/modules/security/lock-kernel-modules.nix @joachifm
166+/nixos/modules/security/misc.nix @joachifm
167+/nixos/tests/hardened.nix @joachifm
168+/pkgs/os-specific/linux/kernel/hardened-config.nix @joachifm
169+
170+# Home Automation
171+/nixos/modules/services/misc/home-assistant.nix @mweinelt
172+/nixos/modules/services/misc/zigbee2mqtt.nix @mweinelt
173+/nixos/tests/home-assistant.nix @mweinelt
174+/nixos/tests/zigbee2mqtt.nix @mweinelt
175+/pkgs/servers/home-assistant @mweinelt
176+/pkgs/tools/misc/esphome @mweinelt
177+
178+# Network Time Daemons
179+/pkgs/tools/networking/chrony @thoughtpolice
180+/pkgs/tools/networking/ntp @thoughtpolice
181+/pkgs/tools/networking/openntpd @thoughtpolice
182+/nixos/modules/services/networking/ntp @thoughtpolice
183+
184+# Network
185+/pkgs/tools/networking/kea/default.nix @mweinelt
186+/pkgs/tools/networking/babeld/default.nix @mweinelt
187+/nixos/modules/services/networking/babeld.nix @mweinelt
188+/nixos/modules/services/networking/kea.nix @mweinelt
189+/nixos/modules/services/networking/knot.nix @mweinelt
190+/nixos/tests/babeld.nix @mweinelt
191+/nixos/tests/kea.nix @mweinelt
192+/nixos/tests/knot.nix @mweinelt
193+
194+# Dhall
195+/pkgs/development/dhall-modules @Gabriel439 @Profpatsch @ehmry
196+/pkgs/development/interpreters/dhall @Gabriel439 @Profpatsch @ehmry
197+
198+# Idris
199+/pkgs/development/idris-modules @Infinisil
200+
201+# Bazel
202+/pkgs/development/tools/build-managers/bazel @Profpatsch
203+
204+# NixOS modules for e-mail and dns services
205+/nixos/modules/services/mail/mailman.nix @peti
206+/nixos/modules/services/mail/postfix.nix @peti
207+/nixos/modules/services/networking/bind.nix @peti
208+/nixos/modules/services/mail/rspamd.nix @peti
209+
210+# Emacs
211+/pkgs/applications/editors/emacs/elisp-packages @adisbladis
212+/pkgs/applications/editors/emacs @adisbladis
213+/pkgs/top-level/emacs-packages.nix @adisbladis
214+
215+# Neovim
216+/pkgs/applications/editors/neovim @jonringer @teto
217+
218+# VimPlugins
219+/pkgs/applications/editors/vim/plugins @jonringer
220+
221+# VsCode Extensions
222+/pkgs/applications/editors/vscode/extensions @jonringer
223+
224+# Prometheus exporter modules and tests
225+/nixos/modules/services/monitoring/prometheus/exporters.nix @WilliButz
226+/nixos/modules/services/monitoring/prometheus/exporters.xml @WilliButz
227+/nixos/tests/prometheus-exporters.nix @WilliButz
228+
229+# PHP interpreter, packages, extensions, tests and documentation
230+/doc/languages-frameworks/php.section.md @aanderse @etu @globin @ma27 @talyz
231+/nixos/tests/php @aanderse @etu @globin @ma27 @talyz
232+/pkgs/build-support/build-pecl.nix @aanderse @etu @globin @ma27 @talyz
233+/pkgs/development/interpreters/php @jtojnar @aanderse @etu @globin @ma27 @talyz
234+/pkgs/development/php-packages @aanderse @etu @globin @ma27 @talyz
235+/pkgs/top-level/php-packages.nix @jtojnar @aanderse @etu @globin @ma27 @talyz
236+
237+# Podman, CRI-O modules and related
238+/nixos/modules/virtualisation/containers.nix @zowoq @adisbladis
239+/nixos/modules/virtualisation/cri-o.nix @zowoq @adisbladis
240+/nixos/modules/virtualisation/podman @zowoq @adisbladis
241+/nixos/tests/cri-o.nix @zowoq @adisbladis
242+/nixos/tests/podman @zowoq @adisbladis
243+
244+# Docker tools
245+/pkgs/build-support/docker @roberth
246+/nixos/tests/docker-tools* @roberth
247+/doc/builders/images/dockertools.section.md @roberth
248+
249+# Blockchains
250+/pkgs/applications/blockchains @mmahut @RaghavSood
251+
252+# Go
253+/doc/languages-frameworks/go.section.md @kalbasit @Mic92 @zowoq
254+/pkgs/development/compilers/go @kalbasit @Mic92 @zowoq
255+/pkgs/development/go-modules @kalbasit @Mic92 @zowoq
256+/pkgs/development/go-packages @kalbasit @Mic92 @zowoq
257+
258+# GNOME
259+/pkgs/desktops/gnome @jtojnar @hedning
260+/pkgs/desktops/gnome/extensions @piegamesde @jtojnar @hedning
261+
262+# Cinnamon
263+/pkgs/desktops/cinnamon @mkg20001
264+
265+# nim
266+/pkgs/development/compilers/nim @ehmry
267+/pkgs/development/nim-packages @ehmry
268+/pkgs/top-level/nim-packages.nix @ehmry
269+
270+# terraform providers
271+/pkgs/applications/networking/cluster/terraform-providers @zowoq
272+
273+# kubernetes
274+/nixos/doc/manual/configuration/kubernetes.chapter.md @zowoq
275+/nixos/modules/services/cluster/kubernetes @zowoq
276+/nixos/tests/kubernetes @zowoq
277+/pkgs/applications/networking/cluster/kubernetes @zowoq
278+
279+# Matrix
280+/pkgs/servers/heisenbridge @piegamesde
281+/pkgs/servers/matrix-conduit @piegamesde
282+/pkgs/servers/matrix-synapse/matrix-appservice-irc @piegamesde
283+/nixos/modules/services/misc/heisenbridge.nix @piegamesde
284+/nixos/modules/services/misc/matrix-appservice-irc.nix @piegamesde
285+/nixos/modules/services/misc/matrix-conduit.nix @piegamesde
286+/nixos/tests/matrix-appservice-irc.nix @piegamesde
287+/nixos/tests/matrix-conduit.nix @piegamesde
288+
289+# Dotnet
290+/pkgs/build-support/dotnet @IvarWithoutBones
291+/pkgs/development/compilers/dotnet @IvarWithoutBones
.github/ISSUE_TEMPLATE.mdnew file+11
@@ -0,0 +1,11 @@
1+## Issue description
2+
3+
4+
5+### Steps to reproduce
6+
7+
8+
9+## Technical details
10+
11+Please run `nix-shell -p nix-info --run "nix-info -m"` and paste the result.
.github/ISSUE_TEMPLATE/bug_report.mdnew file+40
@@ -0,0 +1,40 @@
1+---
2+name: Bug report
3+about: Create a report to help us improve
4+title: ''
5+labels: '0.kind: bug'
6+assignees: ''
7+
8+---
9+
10+### Describe the bug
11+A clear and concise description of what the bug is.
12+
13+### Steps To Reproduce
14+Steps to reproduce the behavior:
15+1. ...
16+2. ...
17+3. ...
18+
19+### Expected behavior
20+A clear and concise description of what you expected to happen.
21+
22+### Screenshots
23+If applicable, add screenshots to help explain your problem.
24+
25+### Additional context
26+Add any other context about the problem here.
27+
28+### Notify maintainers
29+<!--
30+Please @ people who are in the `meta.maintainers` list of the offending package or module.
31+If in doubt, check `git blame` for whoever last touched something.
32+-->
33+
34+### Metadata
35+Please run `nix-shell -p nix-info --run "nix-info -m"` and paste the result.
36+
37+```console
38+[user@system:~]$ nix-shell -p nix-info --run "nix-info -m"
39+output here
40+```
.github/ISSUE_TEMPLATE/out_of_date_package_report.mdnew file+48
@@ -0,0 +1,48 @@
1+---
2+name: Out-of-date package reports
3+about: For packages that are out-of-date
4+title: ''
5+labels: '9.needs: package (update)'
6+assignees: ''
7+
8+---
9+
10+
11+###### Checklist
12+
13+<!-- Note that these are hard requirements -->
14+
15+<!--
16+You can use the "Go to file" functionality on GitHub to find the package
17+Then you can go to the history for this package
18+Find the latest "package_name: old_version -> new_version" commit
19+The "new_version" is the current version of the package
20+-->
21+- [ ] Checked the [nixpkgs master branch](https://github.com/NixOS/nixpkgs)
22+<!--
23+Type the name of your package and try to find an open pull request for the package
24+If you find an open pull request, you can review it!
25+There's a high chance that you'll have the new version right away while helping the community!
26+-->
27+- [ ] Checked the [nixpkgs pull requests](https://github.com/NixOS/nixpkgs/pulls)
28+
29+###### Project name
30+`nix search` name:
31+<!--
32+The current version can be found easily with the same process as above for checking the master branch
33+If an open PR is present for the package, take this version as the current one and link to the PR
34+-->
35+current version:
36+desired version:
37+
38+###### Notify maintainers
39+<!--
40+Search your package here: https://search.nixos.org/packages?channel=unstable
41+If no maintainer is listed for your package, tag the person that last updated the package
42+-->
43+
44+maintainers:
45+
46+###### Note for maintainers
47+
48+Please tag this issue in your PR.
.github/ISSUE_TEMPLATE/packaging_request.mdnew file+18
@@ -0,0 +1,18 @@
1+---
2+name: Packaging requests
3+about: For packages that are missing
4+title: ''
5+labels: '0.kind: packaging request'
6+assignees: ''
7+
8+---
9+
10+**Project description**
11+_describe the project a little_
12+
13+**Metadata**
14+
15+* homepage URL:
16+* source URL:
17+* license: mit, bsd, gpl2+ , ...
18+* platforms: unix, linux, darwin, ...
.github/PULL_REQUEST_TEMPLATE.mdnew file+41
@@ -0,0 +1,41 @@
1+###### Description of changes
2+
3+<!--
4+For package updates please link to a changelog or describe changes, this helps your fellow maintainers discover breaking updates.
5+For new packages please briefly describe the package or provide a link to its homepage.
6+-->
7+
8+###### Things done
9+
10+<!-- Please check what applies. Note that these are not hard requirements but merely serve as information for reviewers. -->
11+
12+- Built on platform(s)
13+ - [ ] x86_64-linux
14+ - [ ] aarch64-linux
15+ - [ ] x86_64-darwin
16+ - [ ] aarch64-darwin
17+- [ ] For non-Linux: Is `sandbox = true` set in `nix.conf`? (See [Nix manual](https://nixos.org/manual/nix/stable/command-ref/conf-file.html))
18+- [ ] Tested, as applicable:
19+ - [NixOS test(s)](https://nixos.org/manual/nixos/unstable/index.html#sec-nixos-tests) (look inside [nixos/tests](https://github.com/NixOS/nixpkgs/blob/master/nixos/tests))
20+ - and/or [package tests](https://nixos.org/manual/nixpkgs/unstable/#sec-package-tests)
21+ - or, for functions and "core" functionality, tests in [lib/tests](https://github.com/NixOS/nixpkgs/blob/master/lib/tests) or [pkgs/test](https://github.com/NixOS/nixpkgs/blob/master/pkgs/test)
22+ - made sure NixOS tests are [linked](https://nixos.org/manual/nixpkgs/unstable/#ssec-nixos-tests-linking) to the relevant packages
23+- [ ] Tested compilation of all packages that depend on this change using `nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD"`. Note: all changes have to be committed, also see [nixpkgs-review usage](https://github.com/Mic92/nixpkgs-review#usage)
24+- [ ] Tested basic functionality of all binary files (usually in `./result/bin/`)
25+- [22.05 Release Notes (or backporting 21.11 Release notes)](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md#generating-2205-release-notes)
26+ - [ ] (Package updates) Added a release notes entry if the change is major or breaking
27+ - [ ] (Module updates) Added a release notes entry if the change is significant
28+ - [ ] (Module addition) Added a release notes entry if adding a new NixOS module
29+ - [ ] (Release notes changes) Ran `nixos/doc/manual/md-to-db.sh` to update generated release notes
30+- [ ] Fits [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
31+
32+<!--
33+To help with the large amounts of pull requests, we would appreciate your
34+reviews of other pull requests, especially simple package updates. Just leave a
35+comment describing what you have tested in the relevant package/service.
36+Reviewing helps to reduce the average time-to-merge for everyone.
37+Thanks a lot if you do!
38+
39+List of open PRs: https://github.com/NixOS/nixpkgs/pulls
40+Reviewing guidelines: https://nixos.org/manual/nixpkgs/unstable/#chap-reviewing-contributions
41+-->
.github/STALE-BOT.mdnew file+35
@@ -0,0 +1,35 @@
1+# Stale bot information
2+
3+- Thanks for your contribution!
4+- To remove the stale label, just leave a new comment.
5+- _How to find the right people to ping?_ → [`git blame`](https://git-scm.com/docs/git-blame) to the rescue! (or GitHub's history and blame buttons.)
6+- You can always ask for help on [our Discourse Forum](https://discourse.nixos.org/), [our Matrix room](https://matrix.to/#/#nix:nixos.org), or on the [#nixos IRC channel](https://web.libera.chat/#nixos).
7+
8+## Suggestions for PRs
9+
10+1. GitHub sometimes doesn't notify people who commented / reviewed a PR previously, when you (force) push commits. If you have addressed the reviews you can [officially ask for a review](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/requesting-a-pull-request-review) from those who commented to you or anyone else.
11+2. If it is unfinished but you plan to finish it, please mark it as a draft.
12+3. If you don't expect to work on it any time soon, closing it with a short comment may encourage someone else to pick up your work.
13+4. To get things rolling again, rebase the PR against the target branch and address valid comments.
14+5. If you need a review to move forward, ask in [the Discourse thread for PRs that need help](https://discourse.nixos.org/t/prs-in-distress/3604).
15+6. If all you need is a merge, check the git history to find and [request reviews](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/requesting-a-pull-request-review) from people who usually merge related contributions.
16+
17+## Suggestions for issues
18+
19+1. If it is resolved (either for you personally, or in general), please consider closing it.
20+2. If this might still be an issue, but you are not interested in promoting its resolution, please consider closing it while encouraging others to take over and reopen an issue if they care enough.
21+3. If you still have interest in resolving it, try to ping somebody who you believe might have an interest in the topic. Consider discussing the problem in [our Discourse Forum](https://discourse.nixos.org/).
22+4. As with all open source projects, your best option is to submit a Pull Request that addresses this issue. We :heart: this attitude!
23+
24+**Memorandum on closing issues**
25+
26+Don't be afraid to close an issue that holds valuable information. Closed issues stay in the system for people to search, read, cross-reference, or even reopen--nothing is lost! Closing obsolete issues is an important way to help maintainers focus their time and effort.
27+
28+## Useful GitHub search queries
29+
30+- [Open PRs with any stale-bot interaction](https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+commenter%3Aapp%2Fstale+)
31+- [Open PRs with any stale-bot interaction and `2.status: stale`](https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+commenter%3Aapp%2Fstale+label%3A%222.status%3A+stale%22)
32+- [Open PRs with any stale-bot interaction and NOT `2.status: stale`](https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+commenter%3Aapp%2Fstale+-label%3A%222.status%3A+stale%22+)
33+- [Open Issues with any stale-bot interaction](https://github.com/NixOS/nixpkgs/issues?q=is%3Aissue+is%3Aopen+commenter%3Aapp%2Fstale+)
34+- [Open Issues with any stale-bot interaction and `2.status: stale`](https://github.com/NixOS/nixpkgs/issues?q=is%3Aissue+is%3Aopen+commenter%3Aapp%2Fstale+label%3A%222.status%3A+stale%22+)
35+- [Open Issues with any stale-bot interaction and NOT `2.status: stale`](https://github.com/NixOS/nixpkgs/issues?q=is%3Aissue+is%3Aopen+commenter%3Aapp%2Fstale+-label%3A%222.status%3A+stale%22+)
.github/labeler.ymlnew file+159
@@ -0,0 +1,159 @@
1+"6.topic: agda":
2+ - doc/languages-frameworks/agda.section.md
3+ - nixos/tests/agda.nix
4+ - pkgs/build-support/agda/**/*
5+ - pkgs/development/libraries/agda/**/*
6+ - pkgs/top-level/agda-packages.nix
7+
8+"6.topic: cinnamon":
9+ - pkgs/desktops/cinnamon/**/*
10+
11+"6.topic: emacs":
12+ - nixos/modules/services/editors/emacs.nix
13+ - nixos/modules/services/editors/emacs.xml
14+ - nixos/tests/emacs-daemon.nix
15+ - pkgs/applications/editors/emacs/elisp-packages/**/*
16+ - pkgs/applications/editors/emacs/**/*
17+ - pkgs/build-support/emacs/**/*
18+ - pkgs/top-level/emacs-packages.nix
19+
20+"6.topic: erlang":
21+ - doc/languages-frameworks/beam.section.md
22+ - pkgs/development/beam-modules/**/*
23+ - pkgs/development/interpreters/elixir/**/*
24+ - pkgs/development/interpreters/erlang/**/*
25+ - pkgs/development/tools/build-managers/rebar/**/*
26+ - pkgs/development/tools/build-managers/rebar3/**/*
27+ - pkgs/development/tools/erlang/**/*
28+ - pkgs/top-level/beam-packages.nix
29+
30+"6.topic: fetch":
31+ - pkgs/build-support/fetch*/**/*
32+
33+"6.topic: GNOME":
34+ - doc/languages-frameworks/gnome.section.md
35+ - nixos/modules/services/desktops/gnome/**/*
36+ - nixos/modules/services/x11/desktop-managers/gnome.nix
37+ - nixos/tests/gnome-xorg.nix
38+ - nixos/tests/gnome.nix
39+ - pkgs/desktops/gnome/**/*
40+
41+"6.topic: golang":
42+ - doc/languages-frameworks/go.section.md
43+ - pkgs/development/compilers/go/**/*
44+ - pkgs/development/go-modules/**/*
45+ - pkgs/development/go-packages/**/*
46+
47+"6.topic: haskell":
48+ - doc/languages-frameworks/haskell.section.md
49+ - maintainers/scripts/haskell/**/*
50+ - pkgs/development/compilers/ghc/**/*
51+ - pkgs/development/haskell-modules/**/*
52+ - pkgs/development/tools/haskell/**/*
53+ - pkgs/test/haskell/**/*
54+ - pkgs/top-level/haskell-packages.nix
55+ - pkgs/top-level/release-haskell.nix
56+
57+"6.topic: kernel":
58+ - pkgs/build-support/kernel/**/*
59+ - pkgs/os-specific/linux/kernel/**/*
60+
61+"6.topic: lua":
62+ - pkgs/development/interpreters/lua-5/**/*
63+ - pkgs/development/interpreters/luajit/**/*
64+ - pkgs/development/lua-modules/**/*
65+ - pkgs/top-level/lua-packages.nix
66+
67+"6.topic: nixos":
68+ - nixos/**/*
69+ - pkgs/os-specific/linux/nixos-rebuild/**/*
70+
71+"6.topic: nim":
72+ - doc/languages-frameworks/nim.section.md
73+ - pkgs/development/compilers/nim/*
74+ - pkgs/development/nim-packages/**/*
75+ - pkgs/top-level/nim-packages.nix
76+
77+"6.topic: ocaml":
78+ - doc/languages-frameworks/ocaml.section.md
79+ - pkgs/development/compilers/ocaml/**/*
80+ - pkgs/development/compilers/reason/**/*
81+ - pkgs/development/ocaml-modules/**/*
82+ - pkgs/development/tools/ocaml/**/*
83+ - pkgs/top-level/ocaml-packages.nix
84+
85+"6.topic: pantheon":
86+ - nixos/modules/services/desktops/pantheon/**/*
87+ - nixos/modules/services/x11/desktop-managers/pantheon.nix
88+ - nixos/modules/services/x11/display-managers/lightdm-greeters/pantheon.nix
89+ - nixos/tests/pantheon.nix
90+ - pkgs/desktops/pantheon/**/*
91+
92+"6.topic: policy discussion":
93+ - .github/**/*
94+
95+"6.topic: printing":
96+ - nixos/modules/services/printing/cupsd.nix
97+ - pkgs/misc/cups/**/*
98+
99+"6.topic: python":
100+ - doc/languages-frameworks/python.section.md
101+ - pkgs/development/interpreters/python/**/*
102+ - pkgs/development/python-modules/**/*
103+ - pkgs/top-level/python-packages.nix
104+
105+"6.topic: qt/kde":
106+ - doc/languages-frameworks/qt.section.md
107+ - nixos/modules/services/x11/desktop-managers/plasma5.nix
108+ - nixos/tests/plasma5.nix
109+ - pkgs/applications/kde/**/*
110+ - pkgs/desktops/plasma-5/**/*
111+ - pkgs/development/libraries/kde-frameworks/**/*
112+ - pkgs/development/libraries/qt-5/**/*
113+
114+"6.topic: ruby":
115+ - doc/languages-frameworks/ruby.section.md
116+ - pkgs/development/interpreters/ruby/**/*
117+ - pkgs/development/ruby-modules/**/*
118+
119+"6.topic: rust":
120+ - doc/languages-frameworks/rust.section.md
121+ - pkgs/build-support/rust/**/*
122+ - pkgs/development/compilers/rust/**/*
123+
124+"6.topic: stdenv":
125+ - pkgs/stdenv/**/*
126+
127+"6.topic: steam":
128+ - pkgs/games/steam/**/*
129+
130+"6.topic: systemd":
131+ - pkgs/os-specific/linux/systemd/**/*
132+ - nixos/modules/system/boot/systemd*/**/*
133+
134+"6.topic: TeX":
135+ - doc/languages-frameworks/texlive.section.md
136+ - pkgs/tools/typesetting/tex/**/*
137+
138+"6.topic: vim":
139+ - doc/languages-frameworks/vim.section.md
140+ - pkgs/applications/editors/vim/**/*
141+ - pkgs/applications/editors/vim/plugins/**/*
142+ - nixos/modules/programs/neovim.nix
143+ - pkgs/applications/editors/neovim/**/*
144+
145+"6.topic: xfce":
146+ - nixos/doc/manual/configuration/xfce.xml
147+ - nixos/modules/services/x11/desktop-managers/xfce.nix
148+ - nixos/tests/xfce.nix
149+ - pkgs/desktops/xfce/**/*
150+
151+"8.has: changelog":
152+ - nixos/doc/manual/release-notes/**/*
153+
154+"8.has: documentation":
155+ - doc/**/*
156+ - nixos/doc/**/*
157+
158+"8.has: module (update)":
159+ - nixos/modules/**/*
.github/stale.ymlnew file+10
@@ -0,0 +1,10 @@
1+# Configuration for probot-stale - https://github.com/probot/stale
2+daysUntilStale: 180
3+daysUntilClose: false
4+exemptLabels:
5+ - "1.severity: security"
6+ - "2.status: never-stale"
7+staleLabel: "2.status: stale"
8+markComment: |
9+ I marked this as stale due to inactivity. → [More info](https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md)
10+closeComment: false
.github/workflows/backport.ymlnew file+35
@@ -0,0 +1,35 @@
1+name: Backport
2+on:
3+ pull_request_target:
4+ types: [closed, labeled]
5+
6+# WARNING:
7+# When extending this action, be aware that $GITHUB_TOKEN allows write access to
8+# the GitHub repository. This means that it should not evaluate user input in a
9+# way that allows code injection.
10+
11+jobs:
12+ backport:
13+ name: Backport Pull Request
14+ if: github.repository_owner == 'NixOS' && github.event.pull_request.merged == true && (github.event_name != 'labeled' || startsWith('backport', github.event.label.name))
15+ runs-on: ubuntu-latest
16+ steps:
17+ - uses: actions/checkout@v3
18+ with:
19+ # required to find all branches
20+ fetch-depth: 0
21+ ref: ${{ github.event.pull_request.head.sha }}
22+ - name: Create backport PRs
23+ # should be kept in sync with `version`
24+ uses: zeebe-io/backport-action@v0.0.5
25+ with:
26+ # Config README: https://github.com/zeebe-io/backport-action#backport-action
27+ github_token: ${{ secrets.GITHUB_TOKEN }}
28+ github_workspace: ${{ github.workspace }}
29+ # should be kept in sync with `uses`
30+ version: v0.0.5
31+ pull_description: |-
32+ Bot-based backport to `${target_branch}`, triggered by a label in #${pull_number}.
33+
34+ * [ ] Before merging, ensure that this backport complies with the [Criteria for Backporting](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md#criteria-for-backporting-changes).
35+ * Even as a non-commiter, if you find that it does not comply, leave a comment.
.github/workflows/basic-eval.ymlnew file+26
@@ -0,0 +1,26 @@
1+name: Basic evaluation checks
2+
3+on:
4+ workflow_dispatch
5+ # pull_request:
6+ # branches:
7+ # - master
8+ # - release-**
9+ # push:
10+ # branches:
11+ # - master
12+ # - release-**
13+jobs:
14+ tests:
15+ runs-on: ubuntu-latest
16+ # we don't limit this action to only NixOS repo since the checks are cheap and useful developer feedback
17+ steps:
18+ - uses: actions/checkout@v3
19+ - uses: cachix/install-nix-action@v17
20+ - uses: cachix/cachix-action@v10
21+ with:
22+ # This cache is for the nixpkgs repo checks and should not be trusted or used elsewhere.
23+ name: nixpkgs-ci
24+ signingKey: '${{ secrets.CACHIX_SIGNING_KEY }}'
25+ # explicit list of supportedSystems is needed until aarch64-darwin becomes part of the trunk jobset
26+ - run: nix-build pkgs/top-level/release.nix -A tarball.nixpkgs-basic-release-checks --arg supportedSystems '[ "aarch64-darwin" "aarch64-linux" "x86_64-linux" "x86_64-darwin" ]'
.github/workflows/direct-push.ymlnew file+32
@@ -0,0 +1,32 @@
1+name: "Direct Push Warning"
2+on:
3+ push:
4+ branches:
5+ - master
6+ - release-**
7+jobs:
8+ build:
9+ runs-on: ubuntu-latest
10+ if: github.repository_owner == 'NixOS'
11+ env:
12+ GITHUB_SHA: ${{ github.sha }}
13+ GITHUB_REPOSITORY: ${{ github.repository }}
14+ steps:
15+ - name: Check if commit is a merge commit
16+ id: ismerge
17+ run: |
18+ ISMERGE=$(curl -H 'Accept: application/vnd.github.groot-preview+json' -H "authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" https://api.github.com/repos/${{ env.GITHUB_REPOSITORY }}/commits/${{ env.GITHUB_SHA }}/pulls | jq -r '.[] | select(.merge_commit_sha == "${{ env.GITHUB_SHA }}") | any')
19+ echo "::set-output name=ismerge::$ISMERGE"
20+ # github events are eventually consistent, so wait until changes propagate to thier DB
21+ - run: sleep 60
22+ if: steps.ismerge.outputs.ismerge != 'true'
23+ - name: Warn if the commit was a direct push
24+ if: steps.ismerge.outputs.ismerge != 'true'
25+ uses: peter-evans/commit-comment@v2
26+ with:
27+ body: |
28+ @${{ github.actor }}, you pushed a commit directly to master/release branch
29+ instead of going through a Pull Request.
30+
31+ That's highly discouraged beyond the few exceptions listed
32+ on https://github.com/NixOS/nixpkgs/issues/118661
.github/workflows/editorconfig.ymlnew file+43
@@ -0,0 +1,43 @@
1+name: "Checking EditorConfig"
2+
3+permissions: read-all
4+
5+on:
6+ # avoids approving first time contributors
7+ pull_request_target:
8+ branches-ignore:
9+ - 'release-**'
10+
11+jobs:
12+ tests:
13+ runs-on: ubuntu-latest
14+ if: "github.repository_owner == 'NixOS' && !contains(github.event.pull_request.title, '[skip editorconfig]')"
15+ steps:
16+ - name: Get list of changed files from PR
17+ env:
18+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
19+ run: |
20+ gh api \
21+ repos/NixOS/nixpkgs/pulls/${{github.event.number}}/files --paginate \
22+ | jq '.[] | select(.status != "removed") | .filename' \
23+ > "$HOME/changed_files"
24+ - name: print list of changed files
25+ run: |
26+ cat "$HOME/changed_files"
27+ - uses: actions/checkout@v3
28+ with:
29+ # pull_request_target checks out the base branch by default
30+ ref: refs/pull/${{ github.event.pull_request.number }}/merge
31+ - uses: cachix/install-nix-action@v17
32+ with:
33+ # nixpkgs commit is pinned so that it doesn't break
34+ # editorconfig-checker 2.4.0
35+ nix_path: nixpkgs=https://github.com/NixOS/nixpkgs/archive/c473cc8714710179df205b153f4e9fa007107ff9.tar.gz
36+ - name: install editorconfig-checker
37+ run: nix-env -iA editorconfig-checker -f '<nixpkgs>'
38+ - name: Checking EditorConfig
39+ run: |
40+ cat "$HOME/changed_files" | xargs -r editorconfig-checker -disable-indent-size
41+ - if: ${{ failure() }}
42+ run: |
43+ echo "::error :: Hey! It looks like your changes don't follow our editorconfig settings. Read https://editorconfig.org/#download to configure your editor so you never see this error again."
.github/workflows/labels.ymlnew file+24
@@ -0,0 +1,24 @@
1+name: "Label PR"
2+
3+on:
4+ pull_request_target:
5+ types: [edited, opened, synchronize, reopened]
6+
7+# WARNING:
8+# When extending this action, be aware that $GITHUB_TOKEN allows some write
9+# access to the GitHub API. This means that it should not evaluate user input in
10+# a way that allows code injection.
11+
12+permissions:
13+ contents: read
14+ pull-requests: write
15+
16+jobs:
17+ labels:
18+ runs-on: ubuntu-latest
19+ if: github.repository_owner == 'NixOS'
20+ steps:
21+ - uses: actions/labeler@v4
22+ with:
23+ repo-token: ${{ secrets.GITHUB_TOKEN }}
24+ sync-labels: true
.github/workflows/manual-nixos.ymlnew file+31
@@ -0,0 +1,31 @@
1+name: "Build NixOS manual"
2+
3+permissions: read-all
4+
5+on:
6+ pull_request_target:
7+ branches:
8+ - master
9+ paths:
10+ - 'nixos/**'
11+
12+jobs:
13+ nixos:
14+ runs-on: ubuntu-latest
15+ if: github.repository_owner == 'NixOS'
16+ steps:
17+ - uses: actions/checkout@v3
18+ with:
19+ # pull_request_target checks out the base branch by default
20+ ref: refs/pull/${{ github.event.pull_request.number }}/merge
21+ - uses: cachix/install-nix-action@v17
22+ with:
23+ # explicitly enable sandbox
24+ extra_nix_config: sandbox = true
25+ - uses: cachix/cachix-action@v10
26+ with:
27+ # This cache is for the nixpkgs repo checks and should not be trusted or used elsewhere.
28+ name: nixpkgs-ci
29+ signingKey: '${{ secrets.CACHIX_SIGNING_KEY }}'
30+ - name: Building NixOS manual
31+ run: NIX_PATH=nixpkgs=$(pwd) nix-build --option restrict-eval true nixos/release.nix -A manual.x86_64-linux
.github/workflows/manual-nixpkgs.ymlnew file+31
@@ -0,0 +1,31 @@
1+name: "Build Nixpkgs manual"
2+
3+permissions: read-all
4+
5+on:
6+ pull_request_target:
7+ branches:
8+ - master
9+ paths:
10+ - 'doc/**'
11+
12+jobs:
13+ nixpkgs:
14+ runs-on: ubuntu-latest
15+ if: github.repository_owner == 'NixOS'
16+ steps:
17+ - uses: actions/checkout@v3
18+ with:
19+ # pull_request_target checks out the base branch by default
20+ ref: refs/pull/${{ github.event.pull_request.number }}/merge
21+ - uses: cachix/install-nix-action@v17
22+ with:
23+ # explicitly enable sandbox
24+ extra_nix_config: sandbox = true
25+ - uses: cachix/cachix-action@v10
26+ with:
27+ # This cache is for the nixpkgs repo checks and should not be trusted or used elsewhere.
28+ name: nixpkgs-ci
29+ signingKey: '${{ secrets.CACHIX_SIGNING_KEY }}'
30+ - name: Building Nixpkgs manual
31+ run: NIX_PATH=nixpkgs=$(pwd) nix-build --option restrict-eval true pkgs/top-level/release.nix -A manual
.github/workflows/nixos-manual.ymlnew file+26
@@ -0,0 +1,26 @@
1+name: NixOS manual checks
2+
3+permissions: read-all
4+
5+on:
6+ pull_request_target:
7+ branches-ignore:
8+ - 'release-**'
9+ paths:
10+ - 'nixos/**/*.xml'
11+ - 'nixos/**/*.md'
12+
13+jobs:
14+ tests:
15+ runs-on: ubuntu-latest
16+ if: github.repository_owner == 'NixOS'
17+ steps:
18+ - uses: actions/checkout@v3
19+ with:
20+ # pull_request_target checks out the base branch by default
21+ ref: refs/pull/${{ github.event.pull_request.number }}/merge
22+ - uses: cachix/install-nix-action@v17
23+ - name: Check DocBook files generated from Markdown are consistent
24+ run: |
25+ nixos/doc/manual/md-to-db.sh
26+ git diff --exit-code
.github/workflows/no-channel.ymlnew file+21
@@ -0,0 +1,21 @@
1+name: "No channel PR"
2+
3+on:
4+ pull_request:
5+ branches:
6+ - 'nixos-**'
7+ - 'nixpkgs-**'
8+
9+jobs:
10+ fail:
11+ name: "This PR is is targeting a channel branch"
12+ runs-on: ubuntu-latest
13+ steps:
14+ - run: |
15+ cat <<EOF
16+ The nixos-* and nixpkgs-* branches are pushed to by the channel
17+ release script and should not be merged into directly.
18+
19+ Please target the equivalent release-* branch or master instead.
20+ EOF
21+ exit 1
.github/workflows/pending-clear.ymlnew file+21
@@ -0,0 +1,21 @@
1+name: "clear pending status"
2+
3+on:
4+ check_suite:
5+ types: [ completed ]
6+
7+jobs:
8+ action:
9+ runs-on: ubuntu-latest
10+ steps:
11+ - name: clear pending status
12+ if: github.repository_owner == 'NixOS' && github.event.check_suite.app.name == 'OfBorg'
13+ env:
14+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
15+ run: |
16+ curl \
17+ -X POST \
18+ -H "Accept: application/vnd.github.v3+json" \
19+ -H "Authorization: token $GITHUB_TOKEN" \
20+ -d '{"state": "success", "target_url": " ", "description": " ", "context": "Wait for ofborg"}' \
21+ "https://api.github.com/repos/NixOS/nixpkgs/statuses/${{ github.event.check_suite.head_sha }}"
.github/workflows/pending-set.ymlnew file+25
@@ -0,0 +1,25 @@
1+name: "set pending status"
2+
3+on:
4+ pull_request_target:
5+
6+# WARNING:
7+# When extending this action, be aware that $GITHUB_TOKEN allows write access to
8+# the GitHub repository. This means that it should not evaluate user input in a
9+# way that allows code injection.
10+
11+jobs:
12+ action:
13+ runs-on: ubuntu-latest
14+ steps:
15+ - name: set pending status
16+ if: github.repository_owner == 'NixOS'
17+ env:
18+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
19+ run: |
20+ curl \
21+ -X POST \
22+ -H "Accept: application/vnd.github.v3+json" \
23+ -H "Authorization: token $GITHUB_TOKEN" \
24+ -d '{"state": "pending", "target_url": " ", "description": "This pending status will be cleared when ofborg starts eval.", "context": "Wait for ofborg"}' \
25+ "https://api.github.com/repos/NixOS/nixpkgs/statuses/${{ github.event.pull_request.head.sha }}"
.github/workflows/periodic-merge-24h.ymlnew file+57
@@ -0,0 +1,57 @@
1+# This action periodically merges base branches into staging branches.
2+# This is done to
3+# * prevent conflicts or rather resolve them early
4+# * make all potential breakage happen on the staging branch
5+# * and make sure that all major rebuilds happen before the staging
6+# branch get’s merged back into its base branch.
7+
8+name: "Periodic Merges (24h)"
9+
10+
11+on:
12+ schedule:
13+ # * is a special character in YAML so you have to quote this string
14+ # Merge every 24 hours
15+ - cron: '0 0 * * *'
16+
17+jobs:
18+ periodic-merge:
19+ if: github.repository_owner == 'NixOS'
20+ runs-on: ubuntu-latest
21+ strategy:
22+ # don't fail fast, so that all pairs are tried
23+ fail-fast: false
24+ # certain branches need to be merged in order, like master->staging-next->staging
25+ # and disabling parallelism ensures the order of the pairs below.
26+ max-parallel: 1
27+ matrix:
28+ pairs:
29+ - from: master
30+ into: haskell-updates
31+ - from: release-21.05
32+ into: staging-next-21.05
33+ - from: staging-next-21.05
34+ into: staging-21.05
35+ - from: release-21.11
36+ into: staging-next-21.11
37+ - from: staging-next-21.11
38+ into: staging-21.11
39+ name: ${{ matrix.pairs.from }} → ${{ matrix.pairs.into }}
40+ steps:
41+ - uses: actions/checkout@v3
42+
43+ - name: ${{ matrix.pairs.from }} → ${{ matrix.pairs.into }}
44+ uses: devmasx/merge-branch@1.4.0
45+ with:
46+ type: now
47+ from_branch: ${{ matrix.pairs.from }}
48+ target_branch: ${{ matrix.pairs.into }}
49+ github_token: ${{ secrets.GITHUB_TOKEN }}
50+
51+ - name: Comment on failure
52+ uses: peter-evans/create-or-update-comment@v2
53+ if: ${{ failure() }}
54+ with:
55+ issue-number: 105153
56+ body: |
57+ Periodic merge from `${{ matrix.pairs.from }}` into `${{ matrix.pairs.into }}` has [failed](https://github.com/NixOS/nixpkgs/actions/runs/${{ github.run_id }}).
.github/workflows/periodic-merge-6h.ymlnew file+51
@@ -0,0 +1,51 @@
1+# This action periodically merges base branches into staging branches.
2+# This is done to
3+# * prevent conflicts or rather resolve them early
4+# * make all potential breakage happen on the staging branch
5+# * and make sure that all major rebuilds happen before the staging
6+# branch get’s merged back into its base branch.
7+
8+name: "Periodic Merges (6h)"
9+
10+
11+on:
12+ schedule:
13+ # * is a special character in YAML so you have to quote this string
14+ # Merge every 6 hours
15+ - cron: '0 */6 * * *'
16+
17+jobs:
18+ periodic-merge:
19+ if: github.repository_owner == 'NixOS'
20+ runs-on: ubuntu-latest
21+ strategy:
22+ # don't fail fast, so that all pairs are tried
23+ fail-fast: false
24+ # certain branches need to be merged in order, like master->staging-next->staging
25+ # and disabling parallelism ensures the order of the pairs below.
26+ max-parallel: 1
27+ matrix:
28+ pairs:
29+ - from: master
30+ into: staging-next
31+ - from: staging-next
32+ into: staging
33+ name: ${{ matrix.pairs.from }} → ${{ matrix.pairs.into }}
34+ steps:
35+ - uses: actions/checkout@v3
36+
37+ - name: ${{ matrix.pairs.from }} → ${{ matrix.pairs.into }}
38+ uses: devmasx/merge-branch@1.4.0
39+ with:
40+ type: now
41+ from_branch: ${{ matrix.pairs.from }}
42+ target_branch: ${{ matrix.pairs.into }}
43+ github_token: ${{ secrets.GITHUB_TOKEN }}
44+
45+ - name: Comment on failure
46+ uses: peter-evans/create-or-update-comment@v2
47+ if: ${{ failure() }}
48+ with:
49+ issue-number: 105153
50+ body: |
51+ Periodic merge from `${{ matrix.pairs.from }}` into `${{ matrix.pairs.into }}` has [failed](https://github.com/NixOS/nixpkgs/actions/runs/${{ github.run_id }}).
.github/workflows/update-terraform-providers.ymlnew file+48
@@ -0,0 +1,48 @@
1+name: "Update terraform-providers"
2+
3+on:
4+ schedule:
5+ - cron: "14 3 * * 1"
6+ workflow_dispatch:
7+
8+jobs:
9+ tf-providers:
10+ if: github.repository_owner == 'NixOS' && github.ref == 'refs/heads/master' # ensure workflow_dispatch only runs on master
11+ runs-on: ubuntu-latest
12+ steps:
13+ - uses: actions/checkout@v3
14+ - uses: cachix/install-nix-action@v17
15+ - name: setup
16+ id: setup
17+ run: |
18+ echo ::set-output name=title::"terraform-providers: update $(date -u +"%Y-%m-%d")"
19+ - name: update terraform-providers
20+ run: |
21+ git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
22+ git config user.name "github-actions[bot]"
23+ pushd pkgs/applications/networking/cluster/terraform-providers
24+ ./update-all-providers --no-build
25+ git commit -m "${{ steps.setup.outputs.title }}" providers.json
26+ popd
27+ - name: create PR
28+ uses: peter-evans/create-pull-request@v4
29+ with:
30+ body: |
31+ Automatic update by [update-terraform-providers](https://github.com/NixOS/nixpkgs/blob/master/.github/workflows/update-terraform-providers.yml) action.
32+
33+ Check that all providers build with:
34+ ```
35+ @ofborg build terraform-full
36+ ```
37+ branch: terraform-providers-update
38+ delete-branch: false
39+ labels: "2.status: work-in-progress"
40+ title: ${{ steps.setup.outputs.title }}
41+ token: ${{ secrets.GITHUB_TOKEN }}
42+ - name: comment on failure
43+ uses: peter-evans/create-or-update-comment@v2
44+ if: ${{ failure() }}
45+ with:
46+ issue-number: 153416
47+ body: |
48+ Automatic update of terraform providers [failed](https://github.com/NixOS/nixpkgs/actions/runs/${{ github.run_id }}).
.gitignorenew file+29
@@ -0,0 +1,29 @@
1+*~
2+,*
3+.*.swp
4+.*.swo
5+.idea/
6+.vscode/
7+outputs/
8+result
9+result-*
10+source/
11+/doc/NEWS.html
12+/doc/NEWS.txt
13+/doc/manual.html
14+/doc/manual.pdf
15+.version-suffix
16+
17+.DS_Store
18+.mypy_cache
19+__pycache__
20+
21+/pkgs/development/libraries/qt-5/*/tmp/
22+/pkgs/desktops/kde-5/*/tmp/
23+/pkgs/development/mobile/androidenv/xml/*
24+
25+# generated by pkgs/common-updater/update-script.nix
26+update-git-commits.txt
27+
28+# JetBrains IDEA module declaration file
29+/nixpkgs.iml
CONTRIBUTING.mdnew file+130
@@ -0,0 +1,130 @@
1+# How to contribute
2+
3+Note: contributing implies licensing those contributions
4+under the terms of [COPYING](COPYING), which is an MIT-like license.
5+
6+## Opening issues
7+
8+* Make sure you have a [GitHub account](https://github.com/signup/free)
9+* Make sure there is no open issue on the topic
10+* [Submit a new issue](https://github.com/NixOS/nixpkgs/issues/new/choose) by choosing the kind of topic and fill out the template
11+
12+## Submitting changes
13+
14+Read the ["Submitting changes"](https://nixos.org/nixpkgs/manual/#chap-submitting-changes) section of the nixpkgs manual. It explains how to write, test, and iterate on your change, and which branch to base your pull request against.
15+
16+Below is a short excerpt of some points in there:
17+
18+* Format the commit messages in the following way:
19+
20+ ```
21+ (pkg-name | nixos/<module>): (from -> to | init at version | refactor | etc)
22+
23+ (Motivation for change. Link to release notes. Additional information.)
24+ ```
25+
26+ For consistency, there should not be a period at the end of the commit message's summary line (the first line of the commit message).
27+
28+ Examples:
29+
30+ * nginx: init at 2.0.1
31+ * firefox: 54.0.1 -> 55.0
32+ https://www.mozilla.org/en-US/firefox/55.0/releasenotes/
33+ * nixos/hydra: add bazBaz option
34+
35+ Dual baz behavior is needed to do foo.
36+ * nixos/nginx: refactor config generation
37+
38+ The old config generation system used impure shell scripts and could break in specific circumstances (see #1234).
39+
40+* `meta.description` should:
41+ * Be capitalized.
42+ * Not start with the package name.
43+ * Not have a period at the end.
44+* `meta.license` must be set and fit the upstream license.
45+ * If there is no upstream license, `meta.license` should default to `lib.licenses.unfree`.
46+* `meta.maintainers` must be set.
47+
48+See the nixpkgs manual for more details on [standard meta-attributes](https://nixos.org/nixpkgs/manual/#sec-standard-meta-attributes).
49+
50+## Writing good commit messages
51+
52+In addition to writing properly formatted commit messages, it's important to include relevant information so other developers can later understand *why* a change was made. While this information usually can be found by digging code, mailing list/Discourse archives, pull request discussions or upstream changes, it may require a lot of work.
53+
54+For package version upgrades and such a one-line commit message is usually sufficient.
55+
56+## Rebasing between branches (i.e. from master to staging)
57+
58+From time to time, changes between branches must be rebased, for example, if the
59+number of new rebuilds they would cause is too large for the target branch. When
60+rebasing, care must be taken to include only the intended changes, otherwise
61+many CODEOWNERS will be inadvertently requested for review. To achieve this,
62+rebasing should not be performed directly on the target branch, but on the merge
63+base between the current and target branch.
64+
65+In the following example, we see a rebase from `master` onto the merge base
66+between `master` and `staging`, so that a change can eventually be retargeted to
67+`staging`. The example uses `upstream` as the remote for `NixOS/nixpkgs.git`
68+while the `origin` remote is used for the remote you are pushing to.
69+
70+
71+```console
72+# Find the common base between two branches
73+common=$(git merge-base upstream/master upstream/staging)
74+# Find the common base between your feature branch and master
75+commits=$(git merge-base $(git branch --show-current) upstream/master)
76+# Rebase all commits onto the common base
77+git rebase --onto=$common $commits
78+# Force push your changes
79+git push origin $(git branch --show-current) --force-with-lease
80+```
81+
82+Then change the base branch in the GitHub PR using the *Edit* button in the upper
83+right corner, and switch from `master` to `staging`. After the PR has been
84+retargeted it might be necessary to do a final rebase onto the target branch, to
85+resolve any outstanding merge conflicts.
86+
87+```console
88+# Rebase onto target branch
89+git rebase upstream/staging
90+# Review and fixup possible conflicts
91+git status
92+# Force push your changes
93+git push origin $(git branch --show-current) --force-with-lease
94+```
95+
96+## Backporting changes
97+
98+Follow these steps to backport a change into a release branch in compliance with the [commit policy](https://nixos.org/nixpkgs/manual/#submitting-changes-stable-release-branches).
99+
100+1. Take note of the commits in which the change was introduced into `master` branch.
101+2. Check out the target _release branch_, e.g. `release-21.11`. Do not use a _channel branch_ like `nixos-21.11` or `nixpkgs-21.11-darwin`.
102+3. Create a branch for your change, e.g. `git checkout -b backport`.
103+4. When the reason to backport is not obvious from the original commit message, use `git cherry-pick -xe <original commit>` and add a reason. Otherwise use `git cherry-pick -x <original commit>`. That's fine for minor version updates that only include security and bug fixes, commits that fixes an otherwise broken package or similar. Please also ensure the commits exists on the master branch; in the case of squashed or rebased merges, the commit hash will change and the new commits can be found in the merge message at the bottom of the master pull request.
104+5. Push to GitHub and open a backport pull request. Make sure to select the release branch (e.g. `release-21.11`) as the target branch of the pull request, and link to the pull request in which the original change was comitted to `master`. The pull request title should be the commit title with the release version as prefix, e.g. `[21.11]`.
105+6. When the backport pull request is merged and you have the necessary privileges you can also replace the label `9.needs: port to stable` with `8.has: port to stable` on the original pull request. This way maintainers can keep track of missing backports easier.
106+
107+## Criteria for Backporting changes
108+
109+Anything that does not cause user or downstream dependency regressions can be backported. This includes:
110+- New Packages / Modules
111+- Security / Patch updates
112+- Version updates which include new functionality (but no breaking changes)
113+- Services which require a client to be up-to-date regardless. (E.g. `spotify`, `steam`, or `discord`)
114+- Security critical applications (E.g. `firefox`)
115+
116+## Generating 22.05 Release Notes
117+
118+(This section also applies to backporting 21.11 release notes: substitute "rl-2205" for "rl-2111".)
119+
120+Documentation in nixpkgs is transitioning to a markdown-centric workflow. Release notes now require a translation step to convert from markdown to a compatible docbook document.
121+
122+Steps for updating 22.05 Release notes:
123+
124+1. Edit `nixos/doc/manual/release-notes/rl-2205.section.md` with the desired changes
125+2. Run `./nixos/doc/manual/md-to-db.sh` to render `nixos/doc/manual/from_md/release-notes/rl-2205.section.xml`
126+3. Include changes to `rl-2205.section.md` and `rl-2205.section.xml` in the same commit.
127+
128+## Reviewing contributions
129+
130+See the nixpkgs manual for more details on how to [Review contributions](https://nixos.org/nixpkgs/manual/#chap-reviewing-contributions).
COPYINGnew file+20
@@ -0,0 +1,20 @@
1+Copyright (c) 2003-2022 Eelco Dolstra and the Nixpkgs/NixOS contributors
2+
3+Permission is hereby granted, free of charge, to any person obtaining
4+a copy of this software and associated documentation files (the
5+"Software"), to deal in the Software without restriction, including
6+without limitation the rights to use, copy, modify, merge, publish,
7+distribute, sublicense, and/or sell copies of the Software, and to
8+permit persons to whom the Software is furnished to do so, subject to
9+the following conditions:
10+
11+The above copyright notice and this permission notice shall be
12+included in all copies or substantial portions of the Software.
13+
14+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
README.mdnew file+119
@@ -0,0 +1,119 @@
1+<p align="center">
2+ <a href="https://nixos.org#gh-light-mode-only">
3+ <img src="https://raw.githubusercontent.com/NixOS/nixos-homepage/master/logo/nixos-hires.png" width="500px" alt="NixOS logo"/>
4+ </a>
5+ <a href="https://nixos.org#gh-dark-mode-only">
6+ <img src="https://raw.githubusercontent.com/NixOS/nixos-artwork/master/logo/nixos-white.png" width="500px" alt="NixOS logo"/>
7+ </a>
8+</p>
9+
10+<p align="center">
11+ <a href="https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md"><img src="https://img.shields.io/github/contributors-anon/NixOS/nixpkgs" alt="Contributors badge" /></a>
12+ <a href="https://opencollective.com/nixos"><img src="https://opencollective.com/nixos/tiers/supporter/badge.svg?label=supporters&color=brightgreen" alt="Open Collective supporters" /></a>
13+</p>
14+
15+[Nixpkgs](https://github.com/nixos/nixpkgs) is a collection of over
16+80,000 software packages that can be installed with the
17+[Nix](https://nixos.org/nix/) package manager. It also implements
18+[NixOS](https://nixos.org/nixos/), a purely-functional Linux distribution.
19+
20+# Manuals
21+
22+* [NixOS Manual](https://nixos.org/nixos/manual) - how to install, configure, and maintain a purely-functional Linux distribution
23+* [Nixpkgs Manual](https://nixos.org/nixpkgs/manual/) - contributing to Nixpkgs and using programming-language-specific Nix expressions
24+* [Nix Package Manager Manual](https://nixos.org/nix/manual) - how to write Nix expressions (programs), and how to use Nix command line tools
25+
26+# Community
27+
28+* [Discourse Forum](https://discourse.nixos.org/)
29+* [Matrix Chat](https://matrix.to/#/#community:nixos.org)
30+* [NixOS Weekly](https://weekly.nixos.org/)
31+* [Community-maintained wiki](https://nixos.wiki/)
32+* [Community-maintained list of ways to get in touch](https://nixos.wiki/wiki/Get_In_Touch#Chat) (Discord, Telegram, IRC, etc.)
33+
34+# Other Project Repositories
35+
36+The sources of all official Nix-related projects are in the [NixOS
37+organization on GitHub](https://github.com/NixOS/). Here are some of
38+the main ones:
39+
40+* [Nix](https://github.com/NixOS/nix) - the purely functional package manager
41+* [NixOps](https://github.com/NixOS/nixops) - the tool to remotely deploy NixOS machines
42+* [nixos-hardware](https://github.com/NixOS/nixos-hardware) - NixOS profiles to optimize settings for different hardware
43+* [Nix RFCs](https://github.com/NixOS/rfcs) - the formal process for making substantial changes to the community
44+* [NixOS homepage](https://github.com/NixOS/nixos-homepage) - the [NixOS.org](https://nixos.org) website
45+* [hydra](https://github.com/NixOS/hydra) - our continuous integration system
46+* [NixOS Artwork](https://github.com/NixOS/nixos-artwork) - NixOS artwork
47+
48+# Continuous Integration and Distribution
49+
50+Nixpkgs and NixOS are built and tested by our continuous integration
51+system, [Hydra](https://hydra.nixos.org/).
52+
53+* [Continuous package builds for unstable/master](https://hydra.nixos.org/jobset/nixos/trunk-combined)
54+* [Continuous package builds for the NixOS 21.11 release](https://hydra.nixos.org/jobset/nixos/release-21.11)
55+* [Tests for unstable/master](https://hydra.nixos.org/job/nixos/trunk-combined/tested#tabs-constituents)
56+* [Tests for the NixOS 21.11 release](https://hydra.nixos.org/job/nixos/release-21.11/tested#tabs-constituents)
57+
58+Artifacts successfully built with Hydra are published to cache at
59+https://cache.nixos.org/. When successful build and test criteria are
60+met, the Nixpkgs expressions are distributed via [Nix
61+channels](https://nixos.org/manual/nix/stable/package-management/channels.html).
62+
63+# Contributing
64+
65+Nixpkgs is among the most active projects on GitHub. While thousands
66+of open issues and pull requests might seem a lot at first, it helps
67+consider it in the context of the scope of the project. Nixpkgs
68+describes how to build tens of thousands of pieces of software and implements a
69+Linux distribution. The [GitHub Insights](https://github.com/NixOS/nixpkgs/pulse)
70+page gives a sense of the project activity.
71+
72+Community contributions are always welcome through GitHub Issues and
73+Pull Requests. When pull requests are made, our tooling automation bot,
74+[OfBorg](https://github.com/NixOS/ofborg) will perform various checks
75+to help ensure expression quality.
76+
77+The *Nixpkgs maintainers* are people who have assigned themselves to
78+maintain specific individual packages. We encourage people who care
79+about a package to assign themselves as a maintainer. When a pull
80+request is made against a package, OfBorg will notify the appropriate
81+maintainer(s). The *Nixpkgs committers* are people who have been given
82+permission to merge.
83+
84+Most contributions are based on and merged into these branches:
85+
86+* `master` is the main branch where all small contributions go
87+* `staging` is branched from master, changes that have a big impact on
88+ Hydra builds go to this branch
89+* `staging-next` is branched from staging and only fixes to stabilize
90+ and security fixes with a big impact on Hydra builds should be
91+ contributed to this branch. This branch is merged into master when
92+ deemed of sufficiently high quality
93+
94+For more information about contributing to the project, please visit
95+the [contributing page](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
96+
97+# Donations
98+
99+The infrastructure for NixOS and related projects is maintained by a
100+nonprofit organization, the [NixOS
101+Foundation](https://nixos.org/nixos/foundation.html). To ensure the
102+continuity and expansion of the NixOS infrastructure, we are looking
103+for donations to our organization.
104+
105+You can donate to the NixOS foundation through [SEPA bank
106+transfers](https://nixos.org/donate.html) or by using Open Collective:
107+
108+<a href="https://opencollective.com/nixos#support"><img src="https://opencollective.com/nixos/tiers/supporter.svg?width=890" /></a>
109+
110+# License
111+
112+Nixpkgs is licensed under the [MIT License](COPYING).
113+
114+Note: MIT license does not apply to the packages built by Nixpkgs,
115+merely to the files in this repository (the Nix expressions, build
116+scripts, NixOS modules, etc.). It also might not apply to patches
117+included in Nixpkgs, which may be derivative works of the packages to
118+which they apply. The aforementioned artifacts are all covered by the
119+licenses of the respective packages.
default.nixnew file+28
@@ -0,0 +1,28 @@
1+let requiredVersion = import ./lib/minver.nix; in
2+
3+if ! builtins ? nixVersion || builtins.compareVersions requiredVersion builtins.nixVersion == 1 then
4+
5+ abort ''
6+
7+ This version of Nixpkgs requires Nix >= ${requiredVersion}, please upgrade:
8+
9+ - If you are running NixOS, `nixos-rebuild' can be used to upgrade your system.
10+
11+ - Alternatively, with Nix > 2.0 `nix upgrade-nix' can be used to imperatively
12+ upgrade Nix. You may use `nix-env --version' to check which version you have.
13+
14+ - If you installed Nix using the install script (https://nixos.org/nix/install),
15+ it is safe to upgrade by running it again:
16+
17+ curl -L https://nixos.org/nix/install | sh
18+
19+ For more information, please see the NixOS release notes at
20+ https://nixos.org/nixos/manual or locally at
21+ ${toString ./nixos/doc/manual/release-notes}.
22+
23+ If you need further help, see https://nixos.org/nixos/support.html
24+ ''
25+
26+else
27+
28+ import ./pkgs/top-level/impure.nix
doc/.gitignorenew file+8
@@ -0,0 +1,8 @@
1+*.chapter.xml
2+*.section.xml
3+.version
4+functions/library/generated
5+functions/library/locations.xml
6+highlightjs
7+manual-full.xml
8+out
doc/Makefile+116−27
@@ -1,27 +1,116 @@
1−ENV = SGML_CATALOG_FILES=$(docbookcatalog)
2−
3−XMLLINT = $(ENV) xmllint --catalogs
4−XSLTPROC = $(ENV) xsltproc --catalogs \
5− --param section.autolabel 1 \
6− --param section.label.includes.component.label 1 \
7− --param html.stylesheet \'style.css\' \
8− --param xref.with.number.and.title 1 \
9− --param toc.section.depth 3
10−
11−NEWS_OPTS = \
12− --stringparam generate.toc "article nop" \
13− --stringparam section.autolabel.max.depth 0 \
14− --stringparam header.rule 0
15−
16−all: NEWS.html NEWS.txt
17−
18−NEWS.html: release-notes.xml
19− $(XSLTPROC) --nonet --xinclude --output $@ $(NEWS_OPTS) \
20− $(docbookxsl)/html/docbook.xsl release-notes.xml
21−
22−NEWS.txt: release-notes.xml
23− $(XSLTPROC) --nonet --xinclude quote-literals.xsl release-notes.xml | \
24− $(XSLTPROC) --nonet --output $@.tmp.html $(NEWS_OPTS) \
25− $(docbookxsl)/html/docbook.xsl -
26− LANG=en_US w3m -dump $@.tmp.html > $@
27− rm $@.tmp.html
1+MD_TARGETS=$(addsuffix .xml, $(basename $(shell find . -type f -regex '.*\.md$$' -not -name README.md)))
2+
3+PANDOC ?= pandoc
4+
5+pandoc_media_dir = media
6+# NOTE: Keep in sync with NixOS manual (/nixos/doc/manual/md-to-db.sh) and conversion script (/maintainers/scripts/db-to-md.sh).
7+# TODO: Remove raw-attribute when we can get rid of DocBook altogether.
8+pandoc_commonmark_enabled_extensions = +attributes+fenced_divs+footnotes+bracketed_spans+definition_lists+pipe_tables+raw_attribute
9+# Not needed:
10+# - docbook-reader/citerefentry-to-rst-role.lua (only relevant for DocBook → MarkDown/rST/MyST)
11+pandoc_flags = --extract-media=$(pandoc_media_dir) \
12+ --lua-filter=$(PANDOC_LUA_FILTERS_DIR)/diagram-generator.lua \
13+ --lua-filter=build-aux/pandoc-filters/myst-reader/roles.lua \
14+ --lua-filter=build-aux/pandoc-filters/link-unix-man-references.lua \
15+ --lua-filter=build-aux/pandoc-filters/docbook-writer/rst-roles.lua \
16+ --lua-filter=build-aux/pandoc-filters/docbook-writer/labelless-link-is-xref.lua \
17+ -f commonmark$(pandoc_commonmark_enabled_extensions)+smart
18+
19+.PHONY: all
20+all: validate format out/html/index.html out/epub/manual.epub
21+
22+.PHONY: debug
23+debug:
24+ nix-shell --run "xmloscopy --docbook5 ./manual.xml ./manual-full.xml"
25+
26+.PHONY: format
27+format: doc-support/result
28+ find . -iname '*.xml' -type f | while read f; do \
29+ echo $$f ;\
30+ xmlformat --config-file "doc-support/result/xmlformat.conf" -i $$f ;\
31+ done
32+
33+.PHONY: fix-misc-xml
34+fix-misc-xml:
35+ find . -iname '*.xml' -type f \
36+ -exec ../nixos/doc/varlistentry-fixer.rb {} ';'
37+
38+.PHONY: clean
39+clean:
40+ rm -f ${MD_TARGETS} doc-support/result .version manual-full.xml functions/library/locations.xml functions/library/generated
41+ rm -rf ./out/ ./highlightjs ./media
42+
43+.PHONY: validate
44+validate: manual-full.xml doc-support/result
45+ jing doc-support/result/docbook.rng manual-full.xml
46+
47+out/html/index.html: doc-support/result manual-full.xml style.css highlightjs
48+ mkdir -p out/html
49+ xsltproc \
50+ --nonet --xinclude \
51+ --output $@ \
52+ doc-support/result/xhtml.xsl \
53+ ./manual-full.xml
54+
55+ mkdir -p out/html/highlightjs/
56+ cp -r highlightjs out/html/
57+
58+ cp -r $(pandoc_media_dir) out/html/
59+ cp ./overrides.css out/html/
60+ cp ./style.css out/html/style.css
61+
62+ mkdir -p out/html/images/callouts
63+ cp doc-support/result/xsl/docbook/images/callouts/*.svg out/html/images/callouts/
64+ chmod u+w -R out/html/
65+
66+out/epub/manual.epub: manual-full.xml
67+ mkdir -p out/epub/scratch
68+ xsltproc --nonet \
69+ --output out/epub/scratch/ \
70+ doc-support/result/epub.xsl \
71+ ./manual-full.xml
72+
73+ cp -r $(pandoc_media_dir) out/epub/scratch/OEBPS
74+ cp ./overrides.css out/epub/scratch/OEBPS
75+ cp ./style.css out/epub/scratch/OEBPS
76+ mkdir -p out/epub/scratch/OEBPS/images/callouts/
77+ cp doc-support/result/xsl/docbook/images/callouts/*.svg out/epub/scratch/OEBPS/images/callouts/
78+ echo "application/epub+zip" > mimetype
79+ zip -0Xq "out/epub/manual.epub" mimetype
80+ rm mimetype
81+ cd "out/epub/scratch/" && zip -Xr9D "../manual.epub" *
82+ rm -rf "out/epub/scratch/"
83+
84+highlightjs: doc-support/result
85+ mkdir -p highlightjs
86+ cp -r doc-support/result/highlightjs/highlight.pack.js highlightjs/
87+ cp -r doc-support/result/highlightjs/LICENSE highlightjs/
88+ cp -r doc-support/result/highlightjs/mono-blue.css highlightjs/
89+ cp -r doc-support/result/highlightjs/loader.js highlightjs/
90+
91+
92+manual-full.xml: ${MD_TARGETS} .version functions/library/locations.xml functions/library/generated *.xml **/*.xml **/**/*.xml
93+ xmllint --nonet --xinclude --noxincludenode manual.xml --output manual-full.xml
94+
95+.version: doc-support/result
96+ ln -rfs ./doc-support/result/version .version
97+
98+doc-support/result: doc-support/default.nix
99+ (cd doc-support; nix-build)
100+
101+functions/library/locations.xml: doc-support/result
102+ ln -rfs ./doc-support/result/function-locations.xml functions/library/locations.xml
103+
104+functions/library/generated: doc-support/result
105+ ln -rfs ./doc-support/result/function-docs functions/library/generated
106+
107+%.section.xml: %.section.md
108+ $(PANDOC) $^ -t docbook \
109+ $(pandoc_flags) \
110+ -o $@
111+
112+%.chapter.xml: %.chapter.md
113+ $(PANDOC) $^ -t docbook \
114+ --top-level-division=chapter \
115+ $(pandoc_flags) \
116+ -o $@
doc/README.mdnew file+12
@@ -0,0 +1,12 @@
1+
2+# Nixpkgs/doc
3+
4+This directory houses the sources files for the Nixpkgs manual.
5+
6+You can find the [rendered documentation for Nixpkgs `unstable` on nixos.org](https://nixos.org/manual/nixpkgs/unstable/).
7+
8+[Docs for Nixpkgs stable](https://nixos.org/manual/nixpkgs/stable/) are also available.
9+
10+If you want to contribute to the documentation, [here's how to do it](https://nixos.org/manual/nixpkgs/unstable/#chap-contributing).
11+
12+If you're only getting started with Nix, go to [nixos.org/learn](https://nixos.org/learn).
doc/build-aux/pandoc-filters/docbook-reader/citerefentry-to-rst-role.luanew file+23
@@ -0,0 +1,23 @@
1+--[[
2+Converts Code AST nodes produced by pandoc’s DocBook reader
3+from citerefentry elements into AST for corresponding role
4+for reStructuredText.
5+
6+We use subset of MyST syntax (CommonMark with features from rST)
7+so let’s use the rST AST for rST features.
8+
9+Reference: https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-manpage
10+]]
11+
12+function Code(elem)
13+ elem.classes = elem.classes:map(function (x)
14+ if x == 'citerefentry' then
15+ elem.attributes['role'] = 'manpage'
16+ return 'interpreted-text'
17+ else
18+ return x
19+ end
20+ end)
21+
22+ return elem
23+end
doc/build-aux/pandoc-filters/docbook-writer/labelless-link-is-xref.luanew file+34
@@ -0,0 +1,34 @@
1+--[[
2+Converts Link AST nodes with empty label to DocBook xref elements.
3+
4+This is a temporary script to be able use cross-references conveniently
5+using syntax taken from MyST, while we still use docbook-xsl
6+for generating the documentation.
7+
8+Reference: https://myst-parser.readthedocs.io/en/latest/using/syntax.html#targets-and-cross-referencing
9+]]
10+
11+local function starts_with(start, str)
12+ return str:sub(1, #start) == start
13+end
14+
15+local function escape_xml_arg(arg)
16+ amps = arg:gsub('&', '&')
17+ amps_quotes = amps:gsub('"', '"')
18+ amps_quotes_lt = amps_quotes:gsub('<', '<')
19+
20+ return amps_quotes_lt
21+end
22+
23+function Link(elem)
24+ has_no_content = #elem.content == 0
25+ targets_anchor = starts_with('#', elem.target)
26+ has_no_attributes = elem.title == '' and elem.identifier == '' and #elem.classes == 0 and #elem.attributes == 0
27+
28+ if has_no_content and targets_anchor and has_no_attributes then
29+ -- xref expects idref without the pound-sign
30+ target_without_hash = elem.target:sub(2, #elem.target)
31+
32+ return pandoc.RawInline('docbook', '<xref linkend="' .. escape_xml_arg(target_without_hash) .. '" />')
33+ end
34+end
doc/build-aux/pandoc-filters/docbook-writer/rst-roles.luanew file+36
@@ -0,0 +1,36 @@
1+--[[
2+Converts AST for reStructuredText roles into corresponding
3+DocBook elements.
4+
5+Currently, only a subset of roles is supported.
6+
7+Reference:
8+ List of roles:
9+ https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html
10+ manpage:
11+ https://tdg.docbook.org/tdg/5.1/citerefentry.html
12+ file:
13+ https://tdg.docbook.org/tdg/5.1/filename.html
14+]]
15+
16+function Code(elem)
17+ if elem.classes:includes('interpreted-text') then
18+ local tag = nil
19+ local content = elem.text
20+ if elem.attributes['role'] == 'manpage' then
21+ tag = 'citerefentry'
22+ local title, volnum = content:match('^(.+)%((%w+)%)$')
23+ if title == nil then
24+ -- No volnum in parentheses.
25+ title = content
26+ end
27+ content = '<refentrytitle>' .. title .. '</refentrytitle>' .. (volnum ~= nil and ('<manvolnum>' .. volnum .. '</manvolnum>') or '')
28+ elseif elem.attributes['role'] == 'file' then
29+ tag = 'filename'
30+ end
31+
32+ if tag ~= nil then
33+ return pandoc.RawInline('docbook', '<' .. tag .. '>' .. content .. '</' .. tag .. '>')
34+ end
35+ end
36+end
doc/build-aux/pandoc-filters/link-unix-man-references.luanew file+17
@@ -0,0 +1,17 @@
1+--[[
2+Turns a manpage reference into a link, when a mapping is defined below.
3+]]
4+
5+local man_urls = {
6+ ["tmpfiles.d(5)"] = "https://www.freedesktop.org/software/systemd/man/tmpfiles.d.html",
7+ ["nix.conf(5)"] = "https://nixos.org/manual/nix/stable/#sec-conf-file",
8+ ["systemd.time(7)"] = "https://www.freedesktop.org/software/systemd/man/systemd.time.html",
9+ ["systemd.timer(5)"] = "https://www.freedesktop.org/software/systemd/man/systemd.timer.html",
10+}
11+
12+function Code(elem)
13+ local is_man_role = elem.classes:includes('interpreted-text') and elem.attributes['role'] == 'manpage'
14+ if is_man_role and man_urls[elem.text] ~= nil then
15+ return pandoc.Link(elem, man_urls[elem.text])
16+ end
17+end
doc/build-aux/pandoc-filters/myst-reader/roles.luanew file+29
@@ -0,0 +1,29 @@
1+--[[
2+Replaces Str AST nodes containing {role}, followed by a Code node
3+by a Code node with attrs that would be produced by rST reader
4+from the role syntax.
5+
6+This is to emulate MyST syntax in Pandoc.
7+(MyST is a CommonMark flavour with rST features mixed in.)
8+
9+Reference: https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#roles-an-in-line-extension-point
10+]]
11+
12+function Inlines(inlines)
13+ for i = #inlines-1,1,-1 do
14+ local first = inlines[i]
15+ local second = inlines[i+1]
16+ local correct_tags = first.tag == 'Str' and second.tag == 'Code'
17+ if correct_tags then
18+ -- docutils supports alphanumeric strings separated by [-._:]
19+ -- We are slightly more liberal for simplicity.
20+ local role = first.text:match('^{([-._+:%w]+)}$')
21+ if role ~= nil then
22+ inlines:remove(i)
23+ second.attributes['role'] = role
24+ second.classes:insert('interpreted-text')
25+ end
26+ end
27+ end
28+ return inlines
29+end
doc/build-aux/pandoc-filters/myst-writer/roles.luanew file+25
@@ -0,0 +1,25 @@
1+--[[
2+Replaces Code nodes with attrs that would be produced by rST reader
3+from the role syntax by a Str AST node containing {role}, followed by a Code node.
4+
5+This is to emulate MyST syntax in Pandoc.
6+(MyST is a CommonMark flavour with rST features mixed in.)
7+
8+Reference: https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#roles-an-in-line-extension-point
9+]]
10+
11+function Code(elem)
12+ local role = elem.attributes['role']
13+
14+ if elem.classes:includes('interpreted-text') and role ~= nil then
15+ elem.classes = elem.classes:filter(function (c)
16+ return c ~= 'interpreted-text'
17+ end)
18+ elem.attributes['role'] = nil
19+
20+ return {
21+ pandoc.Str('{' .. role .. '}'),
22+ elem,
23+ }
24+ end
25+end
doc/builders/fetchers.chapter.mdnew file+114
@@ -0,0 +1,114 @@
1+# Fetchers {#chap-pkgs-fetchers}
2+
3+When using Nix, you will frequently need to download source code and other files from the internet. For this purpose, Nix provides the [_fixed output derivation_](https://nixos.org/manual/nix/stable/#fixed-output-drvs) feature and Nixpkgs provides various functions that implement the actual fetching from various protocols and services.
4+
5+## Caveats
6+
7+Because fixed output derivations are _identified_ by their hash, a common mistake is to update a fetcher's URL or a version parameter, without updating the hash. **This will cause the old contents to be used.** So remember to always invalidate the hash argument.
8+
9+For those who develop and maintain fetchers, a similar problem arises with changes to the implementation of a fetcher. These may cause a fixed output derivation to fail, but won't normally be caught by tests because the supposed output is already in the store or cache. For the purpose of testing, you can use a trick that is embodied by the [`invalidateFetcherByDrvHash`](#tester-invalidateFetcherByDrvHash) function. It uses the derivation `name` to create a unique output path per fetcher implementation, defeating the caching precisely where it would be harmful.
10+
11+## `fetchurl` and `fetchzip` {#fetchurl}
12+
13+Two basic fetchers are `fetchurl` and `fetchzip`. Both of these have two required arguments, a URL and a hash. The hash is typically `sha256`, although many more hash algorithms are supported. Nixpkgs contributors are currently recommended to use `sha256`. This hash will be used by Nix to identify your source. A typical usage of `fetchurl` is provided below.
14+
15+```nix
16+{ stdenv, fetchurl }:
17+
18+stdenv.mkDerivation {
19+ name = "hello";
20+ src = fetchurl {
21+ url = "http://www.example.org/hello.tar.gz";
22+ sha256 = "1111111111111111111111111111111111111111111111111111";
23+ };
24+}
25+```
26+
27+The main difference between `fetchurl` and `fetchzip` is in how they store the contents. `fetchurl` will store the unaltered contents of the URL within the Nix store. `fetchzip` on the other hand, will decompress the archive for you, making files and directories directly accessible in the future. `fetchzip` can only be used with archives. Despite the name, `fetchzip` is not limited to .zip files and can also be used with any tarball.
28+
29+`fetchpatch` works very similarly to `fetchurl` with the same arguments expected. It expects patch files as a source and performs normalization on them before computing the checksum. For example, it will remove comments or other unstable parts that are sometimes added by version control systems and can change over time.
30+
31+Most other fetchers return a directory rather than a single file.
32+
33+## `fetchsvn` {#fetchsvn}
34+
35+Used with Subversion. Expects `url` to a Subversion directory, `rev`, and `sha256`.
36+
37+## `fetchgit` {#fetchgit}
38+
39+Used with Git. Expects `url` to a Git repo, `rev`, and `sha256`. `rev` in this case can be full the git commit id (SHA1 hash) or a tag name like `refs/tags/v1.0`.
40+
41+Additionally, the following optional arguments can be given: `fetchSubmodules = true` makes `fetchgit` also fetch the submodules of a repository. If `deepClone` is set to true, the entire repository is cloned as opposing to just creating a shallow clone. `deepClone = true` also implies `leaveDotGit = true` which means that the `.git` directory of the clone won't be removed after checkout.
42+
43+If only parts of the repository are needed, `sparseCheckout` can be used. This will prevent git from fetching unnecessary blobs from server, see [git sparse-checkout](https://git-scm.com/docs/git-sparse-checkout) and [git clone --filter](https://git-scm.com/docs/git-clone#Documentation/git-clone.txt---filterltfilter-specgt) for more information:
44+
45+```nix
46+{ stdenv, fetchgit }:
47+
48+stdenv.mkDerivation {
49+ name = "hello";
50+ src = fetchgit {
51+ url = "https://...";
52+ sparseCheckout = ''
53+ path/to/be/included
54+ another/path
55+ '';
56+ sha256 = "0000000000000000000000000000000000000000000000000000";
57+ };
58+}
59+```
60+
61+## `fetchfossil` {#fetchfossil}
62+
63+Used with Fossil. Expects `url` to a Fossil archive, `rev`, and `sha256`.
64+
65+## `fetchcvs` {#fetchcvs}
66+
67+Used with CVS. Expects `cvsRoot`, `tag`, and `sha256`.
68+
69+## `fetchhg` {#fetchhg}
70+
71+Used with Mercurial. Expects `url`, `rev`, and `sha256`.
72+
73+A number of fetcher functions wrap part of `fetchurl` and `fetchzip`. They are mainly convenience functions intended for commonly used destinations of source code in Nixpkgs. These wrapper fetchers are listed below.
74+
75+## `fetchFromGitea` {#fetchfromgitea}
76+
77+`fetchFromGitea` expects five arguments. `domain` is the gitea server name. `owner` is a string corresponding to the Gitea user or organization that controls this repository. `repo` corresponds to the name of the software repository. These are located at the top of every Gitea HTML page as `owner`/`repo`. `rev` corresponds to the Git commit hash or tag (e.g `v1.0`) that will be downloaded from Git. Finally, `sha256` corresponds to the hash of the extracted directory. Again, other hash algorithms are also available but `sha256` is currently preferred.
78+
79+## `fetchFromGitHub` {#fetchfromgithub}
80+
81+`fetchFromGitHub` expects four arguments. `owner` is a string corresponding to the GitHub user or organization that controls this repository. `repo` corresponds to the name of the software repository. These are located at the top of every GitHub HTML page as `owner`/`repo`. `rev` corresponds to the Git commit hash or tag (e.g `v1.0`) that will be downloaded from Git. Finally, `sha256` corresponds to the hash of the extracted directory. Again, other hash algorithms are also available, but `sha256` is currently preferred.
82+
83+`fetchFromGitHub` uses `fetchzip` to download the source archive generated by GitHub for the specified revision. If `leaveDotGit`, `deepClone` or `fetchSubmodules` are set to `true`, `fetchFromGitHub` will use `fetchgit` instead. Refer to its section for documentation of these options.
84+
85+## `fetchFromGitLab` {#fetchfromgitlab}
86+
87+This is used with GitLab repositories. The arguments expected are very similar to `fetchFromGitHub` above.
88+
89+## `fetchFromGitiles` {#fetchfromgitiles}
90+
91+This is used with Gitiles repositories. The arguments expected are similar to `fetchgit`.
92+
93+## `fetchFromBitbucket` {#fetchfrombitbucket}
94+
95+This is used with BitBucket repositories. The arguments expected are very similar to fetchFromGitHub above.
96+
97+## `fetchFromSavannah` {#fetchfromsavannah}
98+
99+This is used with Savannah repositories. The arguments expected are very similar to `fetchFromGitHub` above.
100+
101+## `fetchFromRepoOrCz` {#fetchfromrepoorcz}
102+
103+This is used with repo.or.cz repositories. The arguments expected are very similar to `fetchFromGitHub` above.
104+
105+## `fetchFromSourcehut` {#fetchfromsourcehut}
106+
107+This is used with sourcehut repositories. Similar to `fetchFromGitHub` above,
108+it expects `owner`, `repo`, `rev` and `sha256`, but don't forget the tilde (~)
109+in front of the username! Expected arguments also include `vc` ("git" (default)
110+or "hg"), `domain` and `fetchSubmodules`.
111+
112+If `fetchSubmodules` is `true`, `fetchFromSourcehut` uses `fetchgit`
113+or `fetchhg` with `fetchSubmodules` or `fetchSubrepos` set to `true`,
114+respectively. Otherwise, the fetcher uses `fetchzip`.
doc/builders/images.xmlnew file+12
@@ -0,0 +1,12 @@
1+<chapter xmlns="http://docbook.org/ns/docbook"
2+ xmlns:xi="http://www.w3.org/2001/XInclude"
3+ xml:id="chap-images">
4+ <title>Images</title>
5+ <para>
6+ This chapter describes tools for creating various types of images.
7+ </para>
8+ <xi:include href="images/appimagetools.section.xml" />
9+ <xi:include href="images/dockertools.section.xml" />
10+ <xi:include href="images/ocitools.section.xml" />
11+ <xi:include href="images/snaptools.section.xml" />
12+</chapter>
doc/builders/images/appimagetools.section.mdnew file+48
@@ -0,0 +1,48 @@
1+# pkgs.appimageTools {#sec-pkgs-appimageTools}
2+
3+`pkgs.appimageTools` is a set of functions for extracting and wrapping [AppImage](https://appimage.org/) files. They are meant to be used if traditional packaging from source is infeasible, or it would take too long. To quickly run an AppImage file, `pkgs.appimage-run` can be used as well.
4+
5+::: {.warning}
6+The `appimageTools` API is unstable and may be subject to backwards-incompatible changes in the future.
7+:::
8+
9+## AppImage formats {#ssec-pkgs-appimageTools-formats}
10+
11+There are different formats for AppImages, see [the specification](https://github.com/AppImage/AppImageSpec/blob/74ad9ca2f94bf864a4a0dac1f369dd4f00bd1c28/draft.md#image-format) for details.
12+
13+- Type 1 images are ISO 9660 files that are also ELF executables.
14+- Type 2 images are ELF executables with an appended filesystem.
15+
16+They can be told apart with `file -k`:
17+
18+```ShellSession
19+$ file -k type1.AppImage
20+type1.AppImage: ELF 64-bit LSB executable, x86-64, version 1 (SYSV) ISO 9660 CD-ROM filesystem data 'AppImage' (Lepton 3.x), scale 0-0,
21+spot sensor temperature 0.000000, unit celsius, color scheme 0, calibration: offset 0.000000, slope 0.000000, dynamically linked, interpreter /lib64/ld-linux-x86-64.so.2, for GNU/Linux 2.6.18, BuildID[sha1]=d629f6099d2344ad82818172add1d38c5e11bc6d, stripped\012- data
22+
23+$ file -k type2.AppImage
24+type2.AppImage: ELF 64-bit LSB executable, x86-64, version 1 (SYSV) (Lepton 3.x), scale 232-60668, spot sensor temperature -4.187500, color scheme 15, show scale bar, calibration: offset -0.000000, slope 0.000000 (Lepton 2.x), scale 4111-45000, spot sensor temperature 412442.250000, color scheme 3, minimum point enabled, calibration: offset -75402534979642766821519867692934234112.000000, slope 5815371847733706829839455140374904832.000000, dynamically linked, interpreter /lib64/ld-linux-x86-64.so.2, for GNU/Linux 2.6.18, BuildID[sha1]=79dcc4e55a61c293c5e19edbd8d65b202842579f, stripped\012- data
25+```
26+
27+Note how the type 1 AppImage is described as an `ISO 9660 CD-ROM filesystem`, and the type 2 AppImage is not.
28+
29+## Wrapping {#ssec-pkgs-appimageTools-wrapping}
30+
31+Depending on the type of AppImage you're wrapping, you'll have to use `wrapType1` or `wrapType2`.
32+
33+```nix
34+appimageTools.wrapType2 { # or wrapType1
35+ name = "patchwork";
36+ src = fetchurl {
37+ url = "https://github.com/ssbc/patchwork/releases/download/v3.11.4/Patchwork-3.11.4-linux-x86_64.AppImage";
38+ sha256 = "1blsprpkvm0ws9b96gb36f0rbf8f5jgmw4x6dsb1kswr4ysf591s";
39+ };
40+ extraPkgs = pkgs: with pkgs; [ ];
41+}
42+```
43+
44+- `name` specifies the name of the resulting image.
45+- `src` specifies the AppImage file to extract.
46+- `extraPkgs` allows you to pass a function to include additional packages inside the FHS environment your AppImage is going to run in. There are a few ways to learn which dependencies an application needs:
47+ - Looking through the extracted AppImage files, reading its scripts and running `patchelf` and `ldd` on its executables. This can also be done in `appimage-run`, by setting `APPIMAGE_DEBUG_EXEC=bash`.
48+ - Running `strace -vfefile` on the wrapped executable, looking for libraries that can't be found.
doc/builders/images/dockertools.section.mdnew file+314
@@ -0,0 +1,314 @@
1+# pkgs.dockerTools {#sec-pkgs-dockerTools}
2+
3+`pkgs.dockerTools` is a set of functions for creating and manipulating Docker images according to the [Docker Image Specification v1.2.0](https://github.com/moby/moby/blob/master/image/spec/v1.2.md#docker-image-specification-v120). Docker itself is not used to perform any of the operations done by these functions.
4+
5+## buildImage {#ssec-pkgs-dockerTools-buildImage}
6+
7+This function is analogous to the `docker build` command, in that it can be used to build a Docker-compatible repository tarball containing a single image with one or multiple layers. As such, the result is suitable for being loaded in Docker with `docker load`.
8+
9+The parameters of `buildImage` with relative example values are described below:
10+
11+[]{#ex-dockerTools-buildImage}
12+[]{#ex-dockerTools-buildImage-runAsRoot}
13+
14+```nix
15+buildImage {
16+ name = "redis";
17+ tag = "latest";
18+
19+ fromImage = someBaseImage;
20+ fromImageName = null;
21+ fromImageTag = "latest";
22+
23+ contents = pkgs.redis;
24+ runAsRoot = ''
25+ #!${pkgs.runtimeShell}
26+ mkdir -p /data
27+ '';
28+
29+ config = {
30+ Cmd = [ "/bin/redis-server" ];
31+ WorkingDir = "/data";
32+ Volumes = { "/data" = { }; };
33+ };
34+}
35+```
36+
37+The above example will build a Docker image `redis/latest` from the given base image. Loading and running this image in Docker results in `redis-server` being started automatically.
38+
39+- `name` specifies the name of the resulting image. This is the only required argument for `buildImage`.
40+
41+- `tag` specifies the tag of the resulting image. By default it's `null`, which indicates that the nix output hash will be used as tag.
42+
43+- `fromImage` is the repository tarball containing the base image. It must be a valid Docker image, such as exported by `docker save`. By default it's `null`, which can be seen as equivalent to `FROM scratch` of a `Dockerfile`.
44+
45+- `fromImageName` can be used to further specify the base image within the repository, in case it contains multiple images. By default it's `null`, in which case `buildImage` will peek the first image available in the repository.
46+
47+- `fromImageTag` can be used to further specify the tag of the base image within the repository, in case an image contains multiple tags. By default it's `null`, in which case `buildImage` will peek the first tag available for the base image.
48+
49+- `contents` is a derivation that will be copied in the new layer of the resulting image. This can be similarly seen as `ADD contents/ /` in a `Dockerfile`. By default it's `null`.
50+
51+- `runAsRoot` is a bash script that will run as root in an environment that overlays the existing layers of the base image with the new resulting layer, including the previously copied `contents` derivation. This can be similarly seen as `RUN ...` in a `Dockerfile`.
52+
53+> **_NOTE:_** Using this parameter requires the `kvm` device to be available.
54+
55+- `config` is used to specify the configuration of the containers that will be started off the built image in Docker. The available options are listed in the [Docker Image Specification v1.2.0](https://github.com/moby/moby/blob/master/image/spec/v1.2.md#image-json-field-descriptions).
56+
57+After the new layer has been created, its closure (to which `contents`, `config` and `runAsRoot` contribute) will be copied in the layer itself. Only new dependencies that are not already in the existing layers will be copied.
58+
59+At the end of the process, only one new single layer will be produced and added to the resulting image.
60+
61+The resulting repository will only list the single image `image/tag`. In the case of [the `buildImage` example](#ex-dockerTools-buildImage), it would be `redis/latest`.
62+
63+It is possible to inspect the arguments with which an image was built using its `buildArgs` attribute.
64+
65+> **_NOTE:_** If you see errors similar to `getProtocolByName: does not exist (no such protocol name: tcp)` you may need to add `pkgs.iana-etc` to `contents`.
66+
67+> **_NOTE:_** If you see errors similar to `Error_Protocol ("certificate has unknown CA",True,UnknownCa)` you may need to add `pkgs.cacert` to `contents`.
68+
69+By default `buildImage` will use a static date of one second past the UNIX Epoch. This allows `buildImage` to produce binary reproducible images. When listing images with `docker images`, the newly created images will be listed like this:
70+
71+```ShellSession
72+$ docker images
73+REPOSITORY TAG IMAGE ID CREATED SIZE
74+hello latest 08c791c7846e 48 years ago 25.2MB
75+```
76+
77+You can break binary reproducibility but have a sorted, meaningful `CREATED` column by setting `created` to `now`.
78+
79+```nix
80+pkgs.dockerTools.buildImage {
81+ name = "hello";
82+ tag = "latest";
83+ created = "now";
84+ contents = pkgs.hello;
85+
86+ config.Cmd = [ "/bin/hello" ];
87+}
88+```
89+
90+Now the Docker CLI will display a reasonable date and sort the images as expected:
91+
92+```ShellSession
93+$ docker images
94+REPOSITORY TAG IMAGE ID CREATED SIZE
95+hello latest de2bf4786de6 About a minute ago 25.2MB
96+```
97+
98+However, the produced images will not be binary reproducible.
99+
100+## buildLayeredImage {#ssec-pkgs-dockerTools-buildLayeredImage}
101+
102+Create a Docker image with many of the store paths being on their own layer to improve sharing between images. The image is realized into the Nix store as a gzipped tarball. Depending on the intended usage, many users might prefer to use `streamLayeredImage` instead, which this function uses internally.
103+
104+`name`
105+
106+: The name of the resulting image.
107+
108+`tag` _optional_
109+
110+: Tag of the generated image.
111+
112+ *Default:* the output path's hash
113+
114+`fromImage` _optional_
115+
116+: The repository tarball containing the base image. It must be a valid Docker image, such as one exported by `docker save`.
117+
118+ *Default:* `null`, which can be seen as equivalent to `FROM scratch` of a `Dockerfile`.
119+
120+`contents` _optional_
121+
122+: Top-level paths in the container. Either a single derivation, or a list of derivations.
123+
124+ *Default:* `[]`
125+
126+`config` _optional_
127+
128+: Run-time configuration of the container. A full list of the options are available at in the [Docker Image Specification v1.2.0](https://github.com/moby/moby/blob/master/image/spec/v1.2.md#image-json-field-descriptions).
129+
130+ *Default:* `{}`
131+
132+`created` _optional_
133+
134+: Date and time the layers were created. Follows the same `now` exception supported by `buildImage`.
135+
136+ *Default:* `1970-01-01T00:00:01Z`
137+
138+`maxLayers` _optional_
139+
140+: Maximum number of layers to create.
141+
142+ *Default:* `100`
143+
144+ *Maximum:* `125`
145+
146+`extraCommands` _optional_
147+
148+: Shell commands to run while building the final layer, without access to most of the layer contents. Changes to this layer are "on top" of all the other layers, so can create additional directories and files.
149+
150+`fakeRootCommands` _optional_
151+
152+: Shell commands to run while creating the archive for the final layer in a fakeroot environment. Unlike `extraCommands`, you can run `chown` to change the owners of the files in the archive, changing fakeroot's state instead of the real filesystem. The latter would require privileges that the build user does not have. Static binaries do not interact with the fakeroot environment. By default all files in the archive will be owned by root.
153+
154+`enableFakechroot` _optional_
155+
156+: Whether to run in `fakeRootCommands` in `fakechroot`, making programs behave as though `/` is the root of the image being created, while files in the Nix store are available as usual. This allows scripts that perform installation in `/` to work as expected. Considering that `fakechroot` is implemented via the same mechanism as `fakeroot`, the same caveats apply.
157+
158+ *Default:* `false`
159+
160+### Behavior of `contents` in the final image {#dockerTools-buildLayeredImage-arg-contents}
161+
162+Each path directly listed in `contents` will have a symlink in the root of the image.
163+
164+For example:
165+
166+```nix
167+pkgs.dockerTools.buildLayeredImage {
168+ name = "hello";
169+ contents = [ pkgs.hello ];
170+}
171+```
172+
173+will create symlinks for all the paths in the `hello` package:
174+
175+```ShellSession
176+/bin/hello -> /nix/store/h1zb1padqbbb7jicsvkmrym3r6snphxg-hello-2.10/bin/hello
177+/share/info/hello.info -> /nix/store/h1zb1padqbbb7jicsvkmrym3r6snphxg-hello-2.10/share/info/hello.info
178+/share/locale/bg/LC_MESSAGES/hello.mo -> /nix/store/h1zb1padqbbb7jicsvkmrym3r6snphxg-hello-2.10/share/locale/bg/LC_MESSAGES/hello.mo
179+```
180+
181+### Automatic inclusion of `config` references {#dockerTools-buildLayeredImage-arg-config}
182+
183+The closure of `config` is automatically included in the closure of the final image.
184+
185+This allows you to make very simple Docker images with very little code. This container will start up and run `hello`:
186+
187+```nix
188+pkgs.dockerTools.buildLayeredImage {
189+ name = "hello";
190+ config.Cmd = [ "${pkgs.hello}/bin/hello" ];
191+}
192+```
193+
194+### Adjusting `maxLayers` {#dockerTools-buildLayeredImage-arg-maxLayers}
195+
196+Increasing the `maxLayers` increases the number of layers which have a chance to be shared between different images.
197+
198+Modern Docker installations support up to 128 layers, but older versions support as few as 42.
199+
200+If the produced image will not be extended by other Docker builds, it is safe to set `maxLayers` to `128`. However, it will be impossible to extend the image further.
201+
202+The first (`maxLayers-2`) most "popular" paths will have their own individual layers, then layer \#`maxLayers-1` will contain all the remaining "unpopular" paths, and finally layer \#`maxLayers` will contain the Image configuration.
203+
204+Docker's Layers are not inherently ordered, they are content-addressable and are not explicitly layered until they are composed in to an Image.
205+
206+## streamLayeredImage {#ssec-pkgs-dockerTools-streamLayeredImage}
207+
208+Builds a script which, when run, will stream an uncompressed tarball of a Docker image to stdout. The arguments to this function are as for `buildLayeredImage`. This method of constructing an image does not realize the image into the Nix store, so it saves on IO and disk/cache space, particularly with large images.
209+
210+The image produced by running the output script can be piped directly into `docker load`, to load it into the local docker daemon:
211+
212+```ShellSession
213+$(nix-build) | docker load
214+```
215+
216+Alternatively, the image be piped via `gzip` into `skopeo`, e.g., to copy it into a registry:
217+
218+```ShellSession
219+$(nix-build) | gzip --fast | skopeo copy docker-archive:/dev/stdin docker://some_docker_registry/myimage:tag
220+```
221+
222+## pullImage {#ssec-pkgs-dockerTools-fetchFromRegistry}
223+
224+This function is analogous to the `docker pull` command, in that it can be used to pull a Docker image from a Docker registry. By default [Docker Hub](https://hub.docker.com/) is used to pull images.
225+
226+Its parameters are described in the example below:
227+
228+```nix
229+pullImage {
230+ imageName = "nixos/nix";
231+ imageDigest =
232+ "sha256:20d9485b25ecfd89204e843a962c1bd70e9cc6858d65d7f5fadc340246e2116b";
233+ finalImageName = "nix";
234+ finalImageTag = "1.11";
235+ sha256 = "0mqjy3zq2v6rrhizgb9nvhczl87lcfphq9601wcprdika2jz7qh8";
236+ os = "linux";
237+ arch = "x86_64";
238+}
239+```
240+
241+- `imageName` specifies the name of the image to be downloaded, which can also include the registry namespace (e.g. `nixos`). This argument is required.
242+
243+- `imageDigest` specifies the digest of the image to be downloaded. This argument is required.
244+
245+- `finalImageName`, if specified, this is the name of the image to be created. Note it is never used to fetch the image since we prefer to rely on the immutable digest ID. By default it's equal to `imageName`.
246+
247+- `finalImageTag`, if specified, this is the tag of the image to be created. Note it is never used to fetch the image since we prefer to rely on the immutable digest ID. By default it's `latest`.
248+
249+- `sha256` is the checksum of the whole fetched image. This argument is required.
250+
251+- `os`, if specified, is the operating system of the fetched image. By default it's `linux`.
252+
253+- `arch`, if specified, is the cpu architecture of the fetched image. By default it's `x86_64`.
254+
255+`nix-prefetch-docker` command can be used to get required image parameters:
256+
257+```ShellSession
258+$ nix run nixpkgs.nix-prefetch-docker -c nix-prefetch-docker --image-name mysql --image-tag 5
259+```
260+
261+Since a given `imageName` may transparently refer to a manifest list of images which support multiple architectures and/or operating systems, you can supply the `--os` and `--arch` arguments to specify exactly which image you want. By default it will match the OS and architecture of the host the command is run on.
262+
263+```ShellSession
264+$ nix-prefetch-docker --image-name mysql --image-tag 5 --arch x86_64 --os linux
265+```
266+
267+Desired image name and tag can be set using `--final-image-name` and `--final-image-tag` arguments:
268+
269+```ShellSession
270+$ nix-prefetch-docker --image-name mysql --image-tag 5 --final-image-name eu.gcr.io/my-project/mysql --final-image-tag prod
271+```
272+
273+## exportImage {#ssec-pkgs-dockerTools-exportImage}
274+
275+This function is analogous to the `docker export` command, in that it can be used to flatten a Docker image that contains multiple layers. It is in fact the result of the merge of all the layers of the image. As such, the result is suitable for being imported in Docker with `docker import`.
276+
277+> **_NOTE:_** Using this function requires the `kvm` device to be available.
278+
279+The parameters of `exportImage` are the following:
280+
281+```nix
282+exportImage {
283+ fromImage = someLayeredImage;
284+ fromImageName = null;
285+ fromImageTag = null;
286+
287+ name = someLayeredImage.name;
288+}
289+```
290+
291+The parameters relative to the base image have the same synopsis as described in [buildImage](#ssec-pkgs-dockerTools-buildImage), except that `fromImage` is the only required argument in this case.
292+
293+The `name` argument is the name of the derivation output, which defaults to `fromImage.name`.
294+
295+## shadowSetup {#ssec-pkgs-dockerTools-shadowSetup}
296+
297+This constant string is a helper for setting up the base files for managing users and groups, only if such files don't exist already. It is suitable for being used in a [`buildImage` `runAsRoot`](#ex-dockerTools-buildImage-runAsRoot) script for cases like in the example below:
298+
299+```nix
300+buildImage {
301+ name = "shadow-basic";
302+
303+ runAsRoot = ''
304+ #!${pkgs.runtimeShell}
305+ ${shadowSetup}
306+ groupadd -r redis
307+ useradd -r -g redis redis
308+ mkdir /data
309+ chown redis:redis /data
310+ '';
311+}
312+```
313+
314+Creating base files like `/etc/passwd` or `/etc/login.defs` is necessary for shadow-utils to manipulate users and groups.
doc/builders/images/ocitools.section.mdnew file+37
@@ -0,0 +1,37 @@
1+# pkgs.ociTools {#sec-pkgs-ociTools}
2+
3+`pkgs.ociTools` is a set of functions for creating containers according to the [OCI container specification v1.0.0](https://github.com/opencontainers/runtime-spec). Beyond that, it makes no assumptions about the container runner you choose to use to run the created container.
4+
5+## buildContainer {#ssec-pkgs-ociTools-buildContainer}
6+
7+This function creates a simple OCI container that runs a single command inside of it. An OCI container consists of a `config.json` and a rootfs directory. The nix store of the container will contain all referenced dependencies of the given command.
8+
9+The parameters of `buildContainer` with an example value are described below:
10+
11+```nix
12+buildContainer {
13+ args = [
14+ (with pkgs;
15+ writeScript "run.sh" ''
16+ #!${bash}/bin/bash
17+ exec ${bash}/bin/bash
18+ '').outPath
19+ ];
20+
21+ mounts = {
22+ "/data" = {
23+ type = "none";
24+ source = "/var/lib/mydata";
25+ options = [ "bind" ];
26+ };
27+ };
28+
29+ readonly = false;
30+}
31+```
32+
33+- `args` specifies a set of arguments to run inside the container. This is the only required argument for `buildContainer`. All referenced packages inside the derivation will be made available inside the container.
34+
35+- `mounts` specifies additional mount points chosen by the user. By default only a minimal set of necessary filesystems are mounted into the container (e.g procfs, cgroupfs)
36+
37+- `readonly` makes the container\'s rootfs read-only if it is set to true. The default value is false `false`.
doc/builders/images/snaptools.section.mdnew file+71
@@ -0,0 +1,71 @@
1+# pkgs.snapTools {#sec-pkgs-snapTools}
2+
3+`pkgs.snapTools` is a set of functions for creating Snapcraft images. Snap and Snapcraft is not used to perform these operations.
4+
5+## The makeSnap Function {#ssec-pkgs-snapTools-makeSnap-signature}
6+
7+`makeSnap` takes a single named argument, `meta`. This argument mirrors [the upstream `snap.yaml` format](https://docs.snapcraft.io/snap-format) exactly.
8+
9+The `base` should not be specified, as `makeSnap` will force set it.
10+
11+Currently, `makeSnap` does not support creating GUI stubs.
12+
13+## Build a Hello World Snap {#ssec-pkgs-snapTools-build-a-snap-hello}
14+
15+The following expression packages GNU Hello as a Snapcraft snap.
16+
17+``` {#ex-snapTools-buildSnap-hello .nix}
18+let
19+ inherit (import <nixpkgs> { }) snapTools hello;
20+in snapTools.makeSnap {
21+ meta = {
22+ name = "hello";
23+ summary = hello.meta.description;
24+ description = hello.meta.longDescription;
25+ architectures = [ "amd64" ];
26+ confinement = "strict";
27+ apps.hello.command = "${hello}/bin/hello";
28+ };
29+}
30+```
31+
32+`nix-build` this expression and install it with `snap install ./result --dangerous`. `hello` will now be the Snapcraft version of the package.
33+
34+## Build a Graphical Snap {#ssec-pkgs-snapTools-build-a-snap-firefox}
35+
36+Graphical programs require many more integrations with the host. This example uses Firefox as an example because it is one of the most complicated programs we could package.
37+
38+``` {#ex-snapTools-buildSnap-firefox .nix}
39+let
40+ inherit (import <nixpkgs> { }) snapTools firefox;
41+in snapTools.makeSnap {
42+ meta = {
43+ name = "nix-example-firefox";
44+ summary = firefox.meta.description;
45+ architectures = [ "amd64" ];
46+ apps.nix-example-firefox = {
47+ command = "${firefox}/bin/firefox";
48+ plugs = [
49+ "pulseaudio"
50+ "camera"
51+ "browser-support"
52+ "avahi-observe"
53+ "cups-control"
54+ "desktop"
55+ "desktop-legacy"
56+ "gsettings"
57+ "home"
58+ "network"
59+ "mount-observe"
60+ "removable-media"
61+ "x11"
62+ ];
63+ };
64+ confinement = "strict";
65+ };
66+}
67+```
68+
69+`nix-build` this expression and install it with `snap install ./result --dangerous`. `nix-example-firefox` will now be the Snapcraft version of the Firefox package.
70+
71+The specific meaning behind plugs can be looked up in the [Snapcraft interface documentation](https://docs.snapcraft.io/supported-interfaces).
doc/builders/packages/cataclysm-dda.section.mdnew file+129
@@ -0,0 +1,129 @@
1+# Cataclysm: Dark Days Ahead {#cataclysm-dark-days-ahead}
2+
3+## How to install Cataclysm DDA {#how-to-install-cataclysm-dda}
4+
5+To install the latest stable release of Cataclysm DDA to your profile, execute
6+`nix-env -f "<nixpkgs>" -iA cataclysm-dda`. For the curses build (build
7+without tiles), install `cataclysmDDA.stable.curses`. Note: `cataclysm-dda` is
8+an alias to `cataclysmDDA.stable.tiles`.
9+
10+If you like access to a development build of your favorite git revision,
11+override `cataclysm-dda-git` (or `cataclysmDDA.git.curses` if you like curses
12+build):
13+
14+```nix
15+cataclysm-dda-git.override {
16+ version = "YYYY-MM-DD";
17+ rev = "YOUR_FAVORITE_REVISION";
18+ sha256 = "CHECKSUM_OF_THE_REVISION";
19+}
20+```
21+
22+The sha256 checksum can be obtained by
23+
24+```sh
25+nix-prefetch-url --unpack "https://github.com/CleverRaven/Cataclysm-DDA/archive/${YOUR_FAVORITE_REVISION}.tar.gz"
26+```
27+
28+The default configuration directory is `~/.cataclysm-dda`. If you prefer
29+`$XDG_CONFIG_HOME/cataclysm-dda`, override the derivation:
30+
31+```nix
32+cataclysm-dda.override {
33+ useXdgDir = true;
34+}
35+```
36+
37+## Important note for overriding packages {#important-note-for-overriding-packages}
38+
39+After applying `overrideAttrs`, you need to fix `passthru.pkgs` and
40+`passthru.withMods` attributes either manually or by using `attachPkgs`:
41+
42+```nix
43+let
44+ # You enabled parallel building.
45+ myCDDA = cataclysm-dda-git.overrideAttrs (_: {
46+ enableParallelBuilding = true;
47+ });
48+
49+ # Unfortunately, this refers to the package before overriding and
50+ # parallel building is still disabled.
51+ badExample = myCDDA.withMods (_: []);
52+
53+ inherit (cataclysmDDA) attachPkgs pkgs wrapCDDA;
54+
55+ # You can fix it by hand
56+ goodExample1 = myCDDA.overrideAttrs (old: {
57+ passthru = old.passthru // {
58+ pkgs = pkgs.override { build = goodExample1; };
59+ withMods = wrapCDDA goodExample1;
60+ };
61+ });
62+
63+ # or by using a helper function `attachPkgs`.
64+ goodExample2 = attachPkgs pkgs myCDDA;
65+in
66+
67+# badExample # parallel building disabled
68+# goodExample1.withMods (_: []) # parallel building enabled
69+goodExample2.withMods (_: []) # parallel building enabled
70+```
71+
72+## Customizing with mods {#customizing-with-mods}
73+
74+To install Cataclysm DDA with mods of your choice, you can use `withMods`
75+attribute:
76+
77+```nix
78+cataclysm-dda.withMods (mods: with mods; [
79+ tileset.UndeadPeople
80+])
81+```
82+
83+All mods, soundpacks, and tilesets available in nixpkgs are found in
84+`cataclysmDDA.pkgs`.
85+
86+Here is an example to modify existing mods and/or add more mods not available
87+in nixpkgs:
88+
89+```nix
90+let
91+ customMods = self: super: lib.recursiveUpdate super {
92+ # Modify existing mod
93+ tileset.UndeadPeople = super.tileset.UndeadPeople.overrideAttrs (old: {
94+ # If you like to apply a patch to the tileset for example
95+ patches = [ ./path/to/your.patch ];
96+ });
97+
98+ # Add another mod
99+ mod.Awesome = cataclysmDDA.buildMod {
100+ modName = "Awesome";
101+ version = "0.x";
102+ src = fetchFromGitHub {
103+ owner = "Someone";
104+ repo = "AwesomeMod";
105+ rev = "...";
106+ sha256 = "...";
107+ };
108+ # Path to be installed in the unpacked source (default: ".")
109+ modRoot = "contents/under/this/path/will/be/installed";
110+ };
111+
112+ # Add another soundpack
113+ soundpack.Fantastic = cataclysmDDA.buildSoundPack {
114+ # ditto
115+ };
116+
117+ # Add another tileset
118+ tileset.SuperDuper = cataclysmDDA.buildTileSet {
119+ # ditto
120+ };
121+ };
122+in
123+cataclysm-dda.withMods (mods: with mods.extend customMods; [
124+ tileset.UndeadPeople
125+ mod.Awesome
126+ soundpack.Fantastic
127+ tileset.SuperDuper
128+])
129+```
doc/builders/packages/citrix.section.mdnew file+32
@@ -0,0 +1,32 @@
1+# Citrix Workspace {#sec-citrix}
2+
3+The [Citrix Workspace App](https://www.citrix.com/products/workspace-app/) is a remote desktop viewer which provides access to [XenDesktop](https://www.citrix.com/products/xenapp-xendesktop/) installations.
4+
5+## Basic usage {#sec-citrix-base}
6+
7+The tarball archive needs to be downloaded manually, as the license agreements of the vendor for [Citrix Workspace](https://www.citrix.de/downloads/workspace-app/linux/workspace-app-for-linux-latest.html) needs to be accepted first. Then run `nix-prefetch-url file://$PWD/linuxx64-$version.tar.gz`. With the archive available in the store, the package can be built and installed with Nix.
8+
9+## Citrix Self-service {#sec-citrix-selfservice}
10+
11+The [self-service](https://support.citrix.com/article/CTX200337) is an application managing Citrix desktops and applications. Please note that this feature only works with at least citrix_workspace_20_06_0 and later versions.
12+
13+In order to set this up, you first have to [download the `.cr` file from the Netscaler Gateway](https://its.uiowa.edu/support/article/102186). After that, you can configure the `selfservice` like this:
14+
15+```ShellSession
16+$ storebrowse -C ~/Downloads/receiverconfig.cr
17+$ selfservice
18+```
19+
20+## Custom certificates {#sec-citrix-custom-certs}
21+
22+The `Citrix Workspace App` in `nixpkgs` trusts several certificates [from the Mozilla database](https://curl.haxx.se/docs/caextract.html) by default. However, several companies using Citrix might require their own corporate certificate. On distros with imperative packaging, these certs can be stored easily in [`$ICAROOT`](https://developer-docs.citrix.com/projects/receiver-for-linux-command-reference/en/13.7/), however this directory is a store path in `nixpkgs`. In order to work around this issue, the package provides a simple mechanism to add custom certificates without rebuilding the entire package using `symlinkJoin`:
23+
24+```nix
25+with import <nixpkgs> { config.allowUnfree = true; };
26+let
27+ extraCerts = [
28+ ./custom-cert-1.pem
29+ ./custom-cert-2.pem # ...
30+ ];
31+in citrix_workspace.override { inherit extraCerts; }
32+```
doc/builders/packages/dlib.section.mdnew file+13
@@ -0,0 +1,13 @@
1+# DLib {#dlib}
2+
3+[DLib](http://dlib.net/) is a modern, C++-based toolkit which provides several machine learning algorithms.
4+
5+## Compiling without AVX support {#compiling-without-avx-support}
6+
7+Especially older CPUs don\'t support [AVX](https://en.wikipedia.org/wiki/Advanced_Vector_Extensions) (Advanced Vector Extensions) instructions that are used by DLib to optimize their algorithms.
8+
9+On the affected hardware errors like `Illegal instruction` will occur. In those cases AVX support needs to be disabled:
10+
11+```nix
12+self: super: { dlib = super.dlib.override { avxSupport = false; }; }
13+```
doc/builders/packages/eclipse.section.mdnew file+64
@@ -0,0 +1,64 @@
1+# Eclipse {#sec-eclipse}
2+
3+The Nix expressions related to the Eclipse platform and IDE are in [`pkgs/applications/editors/eclipse`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/editors/eclipse).
4+
5+Nixpkgs provides a number of packages that will install Eclipse in its various forms. These range from the bare-bones Eclipse Platform to the more fully featured Eclipse SDK or Scala-IDE packages and multiple version are often available. It is possible to list available Eclipse packages by issuing the command:
6+
7+```ShellSession
8+$ nix-env -f '<nixpkgs>' -qaP -A eclipses --description
9+```
10+
11+Once an Eclipse variant is installed, it can be run using the `eclipse` command, as expected. From within Eclipse, it is then possible to install plugins in the usual manner by either manually specifying an Eclipse update site or by installing the Marketplace Client plugin and using it to discover and install other plugins. This installation method provides an Eclipse installation that closely resemble a manually installed Eclipse.
12+
13+If you prefer to install plugins in a more declarative manner, then Nixpkgs also offer a number of Eclipse plugins that can be installed in an _Eclipse environment_. This type of environment is created using the function `eclipseWithPlugins` found inside the `nixpkgs.eclipses` attribute set. This function takes as argument `{ eclipse, plugins ? [], jvmArgs ? [] }` where `eclipse` is a one of the Eclipse packages described above, `plugins` is a list of plugin derivations, and `jvmArgs` is a list of arguments given to the JVM running the Eclipse. For example, say you wish to install the latest Eclipse Platform with the popular Eclipse Color Theme plugin and also allow Eclipse to use more RAM. You could then add:
14+
15+```nix
16+packageOverrides = pkgs: {
17+ myEclipse = with pkgs.eclipses; eclipseWithPlugins {
18+ eclipse = eclipse-platform;
19+ jvmArgs = [ "-Xmx2048m" ];
20+ plugins = [ plugins.color-theme ];
21+ };
22+}
23+```
24+
25+to your Nixpkgs configuration (`~/.config/nixpkgs/config.nix`) and install it by running `nix-env -f '<nixpkgs>' -iA myEclipse` and afterward run Eclipse as usual. It is possible to find out which plugins are available for installation using `eclipseWithPlugins` by running:
26+
27+```ShellSession
28+$ nix-env -f '<nixpkgs>' -qaP -A eclipses.plugins --description
29+```
30+
31+If there is a need to install plugins that are not available in Nixpkgs then it may be possible to define these plugins outside Nixpkgs using the `buildEclipseUpdateSite` and `buildEclipsePlugin` functions found in the `nixpkgs.eclipses.plugins` attribute set. Use the `buildEclipseUpdateSite` function to install a plugin distributed as an Eclipse update site. This function takes `{ name, src }` as argument, where `src` indicates the Eclipse update site archive. All Eclipse features and plugins within the downloaded update site will be installed. When an update site archive is not available, then the `buildEclipsePlugin` function can be used to install a plugin that consists of a pair of feature and plugin JARs. This function takes an argument `{ name, srcFeature, srcPlugin }` where `srcFeature` and `srcPlugin` are the feature and plugin JARs, respectively.
32+
33+Expanding the previous example with two plugins using the above functions, we have:
34+
35+```nix
36+packageOverrides = pkgs: {
37+ myEclipse = with pkgs.eclipses; eclipseWithPlugins {
38+ eclipse = eclipse-platform;
39+ jvmArgs = [ "-Xmx2048m" ];
40+ plugins = [
41+ plugins.color-theme
42+ (plugins.buildEclipsePlugin {
43+ name = "myplugin1-1.0";
44+ srcFeature = fetchurl {
45+ url = "http://…/features/myplugin1.jar";
46+ sha256 = "123…";
47+ };
48+ srcPlugin = fetchurl {
49+ url = "http://…/plugins/myplugin1.jar";
50+ sha256 = "123…";
51+ };
52+ });
53+ (plugins.buildEclipseUpdateSite {
54+ name = "myplugin2-1.0";
55+ src = fetchurl {
56+ stripRoot = false;
57+ url = "http://…/myplugin2.zip";
58+ sha256 = "123…";
59+ };
60+ });
61+ ];
62+ };
63+}
64+```
doc/builders/packages/elm.section.mdnew file+11
@@ -0,0 +1,11 @@
1+# Elm {#sec-elm}
2+
3+To start a development environment, run:
4+
5+```ShellSession
6+nix-shell -p elmPackages.elm elmPackages.elm-format
7+```
8+
9+To update the Elm compiler, see `nixpkgs/pkgs/development/compilers/elm/README.md`.
10+
11+To package Elm applications, [read about elm2nix](https://github.com/hercules-ci/elm2nix#elm2nix).
doc/builders/packages/emacs.section.mdnew file+119
@@ -0,0 +1,119 @@
1+# Emacs {#sec-emacs}
2+
3+## Configuring Emacs {#sec-emacs-config}
4+
5+The Emacs package comes with some extra helpers to make it easier to configure. `emacs.pkgs.withPackages` allows you to manage packages from ELPA. This means that you will not have to install that packages from within Emacs. For instance, if you wanted to use `company` `counsel`, `flycheck`, `ivy`, `magit`, `projectile`, and `use-package` you could use this as a `~/.config/nixpkgs/config.nix` override:
6+
7+```nix
8+{
9+ packageOverrides = pkgs: with pkgs; {
10+ myEmacs = emacs.pkgs.withPackages (epkgs: (with epkgs.melpaStablePackages; [
11+ company
12+ counsel
13+ flycheck
14+ ivy
15+ magit
16+ projectile
17+ use-package
18+ ]));
19+ }
20+}
21+```
22+
23+You can install it like any other packages via `nix-env -iA myEmacs`. However, this will only install those packages. It will not `configure` them for us. To do this, we need to provide a configuration file. Luckily, it is possible to do this from within Nix! By modifying the above example, we can make Emacs load a custom config file. The key is to create a package that provides a `default.el` file in `/share/emacs/site-start/`. Emacs knows to load this file automatically when it starts.
24+
25+```nix
26+{
27+ packageOverrides = pkgs: with pkgs; rec {
28+ myEmacsConfig = writeText "default.el" ''
29+ ;; initialize package
30+
31+ (require 'package)
32+ (package-initialize 'noactivate)
33+ (eval-when-compile
34+ (require 'use-package))
35+
36+ ;; load some packages
37+
38+ (use-package company
39+ :bind ("<C-tab>" . company-complete)
40+ :diminish company-mode
41+ :commands (company-mode global-company-mode)
42+ :defer 1
43+ :config
44+ (global-company-mode))
45+
46+ (use-package counsel
47+ :commands (counsel-descbinds)
48+ :bind (([remap execute-extended-command] . counsel-M-x)
49+ ("C-x C-f" . counsel-find-file)
50+ ("C-c g" . counsel-git)
51+ ("C-c j" . counsel-git-grep)
52+ ("C-c k" . counsel-ag)
53+ ("C-x l" . counsel-locate)
54+ ("M-y" . counsel-yank-pop)))
55+
56+ (use-package flycheck
57+ :defer 2
58+ :config (global-flycheck-mode))
59+
60+ (use-package ivy
61+ :defer 1
62+ :bind (("C-c C-r" . ivy-resume)
63+ ("C-x C-b" . ivy-switch-buffer)
64+ :map ivy-minibuffer-map
65+ ("C-j" . ivy-call))
66+ :diminish ivy-mode
67+ :commands ivy-mode
68+ :config
69+ (ivy-mode 1))
70+
71+ (use-package magit
72+ :defer
73+ :if (executable-find "git")
74+ :bind (("C-x g" . magit-status)
75+ ("C-x G" . magit-dispatch-popup))
76+ :init
77+ (setq magit-completing-read-function 'ivy-completing-read))
78+
79+ (use-package projectile
80+ :commands projectile-mode
81+ :bind-keymap ("C-c p" . projectile-command-map)
82+ :defer 5
83+ :config
84+ (projectile-global-mode))
85+ '';
86+
87+ myEmacs = emacs.pkgs.withPackages (epkgs: (with epkgs.melpaStablePackages; [
88+ (runCommand "default.el" {} ''
89+ mkdir -p $out/share/emacs/site-lisp
90+ cp ${myEmacsConfig} $out/share/emacs/site-lisp/default.el
91+ '')
92+ company
93+ counsel
94+ flycheck
95+ ivy
96+ magit
97+ projectile
98+ use-package
99+ ]));
100+ };
101+}
102+```
103+
104+This provides a fairly full Emacs start file. It will load in addition to the user's personal config. You can always disable it by passing `-q` to the Emacs command.
105+
106+Sometimes `emacs.pkgs.withPackages` is not enough, as this package set has some priorities imposed on packages (with the lowest priority assigned to Melpa Unstable, and the highest for packages manually defined in `pkgs/top-level/emacs-packages.nix`). But you can't control these priorities when some package is installed as a dependency. You can override it on a per-package-basis, providing all the required dependencies manually, but it's tedious and there is always a possibility that an unwanted dependency will sneak in through some other package. To completely override such a package, you can use `overrideScope'`.
107+
108+```nix
109+overrides = self: super: rec {
110+ haskell-mode = self.melpaPackages.haskell-mode;
111+ ...
112+};
113+((emacsPackagesFor emacs).overrideScope' overrides).withPackages
114+ (p: with p; [
115+ # here both these package will use haskell-mode of our own choice
116+ ghc-mod
117+ dante
118+ ])
119+```
doc/builders/packages/etc-files.section.mdnew file+18
@@ -0,0 +1,18 @@
1+# /etc files {#etc}
2+
3+Certain calls in glibc require access to runtime files found in `/etc` such as `/etc/protocols` or `/etc/services` -- [getprotobyname](https://linux.die.net/man/3/getprotobyname) is one such function.
4+
5+On non-NixOS distributions these files are typically provided by packages (i.e., [netbase](https://packages.debian.org/sid/netbase)) if not already pre-installed in your distribution. This can cause non-reproducibility for code if they rely on these files being present.
6+
7+If [iana-etc](https://hydra.nixos.org/job/nixos/trunk-combined/nixpkgs.iana-etc.x86_64-linux) is part of your `buildInputs`, then it will set the environment variables `NIX_ETC_PROTOCOLS` and `NIX_ETC_SERVICES` to the corresponding files in the package through a setup hook.
8+
9+
10+```bash
11+> nix-shell -p iana-etc
12+
13+[nix-shell:~]$ env | grep NIX_ETC
14+NIX_ETC_SERVICES=/nix/store/aj866hr8fad8flnggwdhrldm0g799ccz-iana-etc-20210225/etc/services
15+NIX_ETC_PROTOCOLS=/nix/store/aj866hr8fad8flnggwdhrldm0g799ccz-iana-etc-20210225/etc/protocols
16+```
17+
18+Nixpkg's version of [glibc](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/libraries/glibc/default.nix) has been patched to check for the existence of these environment variables. If the environment variables are *not* set, then it will attempt to find the files at the default location within `/etc`.
doc/builders/packages/firefox.section.mdnew file+51
@@ -0,0 +1,51 @@
1+# Firefox {#sec-firefox}
2+
3+## Build wrapped Firefox with extensions and policies {#build-wrapped-firefox-with-extensions-and-policies}
4+
5+The `wrapFirefox` function allows to pass policies, preferences and extensions that are available to Firefox. With the help of `fetchFirefoxAddon` this allows to build a Firefox version that already comes with add-ons pre-installed:
6+
7+```nix
8+{
9+ # Nix firefox addons only work with the firefox-esr package.
10+ myFirefox = wrapFirefox firefox-esr-unwrapped {
11+ nixExtensions = [
12+ (fetchFirefoxAddon {
13+ name = "ublock"; # Has to be unique!
14+ url = "https://addons.mozilla.org/firefox/downloads/file/3679754/ublock_origin-1.31.0-an+fx.xpi";
15+ sha256 = "1h768ljlh3pi23l27qp961v1hd0nbj2vasgy11bmcrlqp40zgvnr";
16+ })
17+ ];
18+
19+ extraPolicies = {
20+ CaptivePortal = false;
21+ DisableFirefoxStudies = true;
22+ DisablePocket = true;
23+ DisableTelemetry = true;
24+ DisableFirefoxAccounts = true;
25+ FirefoxHome = {
26+ Pocket = false;
27+ Snippets = false;
28+ };
29+ UserMessaging = {
30+ ExtensionRecommendations = false;
31+ SkipOnboarding = true;
32+ };
33+ };
34+
35+ extraPrefs = ''
36+ // Show more ssl cert infos
37+ lockPref("security.identityblock.show_extended_validation", true);
38+ '';
39+ };
40+}
41+```
42+
43+If `nixExtensions != null`, then all manually installed add-ons will be uninstalled from your browser profile.
44+To view available enterprise policies, visit [enterprise policies](https://github.com/mozilla/policy-templates#enterprisepoliciesenabled)
45+or type into the Firefox URL bar: `about:policies#documentation`.
46+Nix installed add-ons do not have a valid signature, which is why signature verification is disabled. This does not compromise security because downloaded add-ons are checksummed and manual add-ons can't be installed. Also, make sure that the `name` field of `fetchFirefoxAddon` is unique. If you remove an add-on from the `nixExtensions` array, rebuild and start Firefox: the removed add-on will be completely removed with all of its settings.
47+
48+## Troubleshooting {#sec-firefox-troubleshooting}
49+If add-ons are marked as broken or the signature is invalid, make sure you have Firefox ESR installed. Normal Firefox does not provide the ability anymore to disable signature verification for add-ons thus nix add-ons get disabled by the normal Firefox binary.
50+
51+If add-ons do not appear installed despite being defined in your nix configuration file, reset the local add-on state of your Firefox profile by clicking `Help -> More Troubleshooting Information -> Refresh Firefox`. This can happen if you switch from manual add-on mode to nix add-on mode and then back to manual mode and then again to nix add-on mode.
doc/builders/packages/fish.section.mdnew file+50
@@ -0,0 +1,50 @@
1+# Fish {#sec-fish}
2+
3+Fish is a "smart and user-friendly command line shell" with support for plugins.
4+
5+
6+## Vendor Fish scripts {#sec-fish-vendor}
7+
8+Any package may ship its own Fish completions, configuration snippets, and
9+functions. Those should be installed to
10+`$out/share/fish/vendor_{completions,conf,functions}.d` respectively.
11+
12+When the `programs.fish.enable` and
13+`programs.fish.vendor.{completions,config,functions}.enable` options from the
14+NixOS Fish module are set to true, those paths are symlinked in the current
15+system environment and automatically loaded by Fish.
16+
17+
18+## Packaging Fish plugins {#sec-fish-plugins-pkg}
19+
20+While packages providing standalone executables belong to the top level,
21+packages which have the sole purpose of extending Fish belong to the
22+`fishPlugins` scope and should be registered in
23+`pkgs/shells/fish/plugins/default.nix`.
24+
25+The `buildFishPlugin` utility function can be used to automatically copy Fish
26+scripts from `$src/{completions,conf,conf.d,functions}` to the standard vendor
27+installation paths. It also sets up the test environment so that the optional
28+`checkPhase` is executed in a Fish shell with other already packaged plugins
29+and package-local Fish functions specified in `checkPlugins` and
30+`checkFunctionDirs` respectively.
31+
32+See `pkgs/shells/fish/plugins/pure.nix` for an example of Fish plugin package
33+using `buildFishPlugin` and running unit tests with the `fishtape` test runner.
34+
35+
36+## Fish wrapper {#sec-fish-wrapper}
37+
38+The `wrapFish` package is a wrapper around Fish which can be used to create
39+Fish shells initialized with some plugins as well as completions, configuration
40+snippets and functions sourced from the given paths. This provides a convenient
41+way to test Fish plugins and scripts without having to alter the environment.
42+
43+```nix
44+wrapFish {
45+ pluginPkgs = with fishPlugins; [ pure foreign-env ];
46+ completionDirs = [];
47+ functionDirs = [];
48+ confDirs = [ "/path/to/some/fish/init/dir/" ];
49+}
50+```
doc/builders/packages/fuse.section.mdnew file+45
@@ -0,0 +1,45 @@
1+# FUSE {#sec-fuse}
2+
3+Some packages rely on
4+[FUSE](https://www.kernel.org/doc/html/latest/filesystems/fuse.html) to provide
5+support for additional filesystems not supported by the kernel.
6+
7+In general, FUSE software are primarily developed for Linux but many of them can
8+also run on macOS. Nixpkgs supports FUSE packages on macOS, but it requires
9+[macFUSE](https://osxfuse.github.io) to be installed outside of Nix. macFUSE
10+currently isn't packaged in Nixpkgs mainly because it includes a kernel
11+extension, which isn't supported by Nix outside of NixOS.
12+
13+If a package fails to run on macOS with an error message similar to the
14+following, it's a likely sign that you need to have macFUSE installed.
15+
16+ dyld: Library not loaded: /usr/local/lib/libfuse.2.dylib
17+ Referenced from: /nix/store/w8bi72bssv0bnxhwfw3xr1mvn7myf37x-sshfs-fuse-2.10/bin/sshfs
18+ Reason: image not found
19+ [1] 92299 abort /nix/store/w8bi72bssv0bnxhwfw3xr1mvn7myf37x-sshfs-fuse-2.10/bin/sshfs
20+
21+Package maintainers may often encounter the following error when building FUSE
22+packages on macOS:
23+
24+ checking for fuse.h... no
25+ configure: error: No fuse.h found.
26+
27+This happens on autoconf based projects that use `AC_CHECK_HEADERS` or
28+`AC_CHECK_LIBS` to detect libfuse, and will occur even when the `fuse` package
29+is included in `buildInputs`. It happens because libfuse headers throw an error
30+on macOS if the `FUSE_USE_VERSION` macro is undefined. Many projects do define
31+`FUSE_USE_VERSION`, but only inside C source files. This results in the above
32+error at configure time because the configure script would attempt to compile
33+sample FUSE programs without defining `FUSE_USE_VERSION`.
34+
35+There are two possible solutions for this problem in Nixpkgs:
36+
37+1. Pass `FUSE_USE_VERSION` to the configure script by adding
38+ `CFLAGS=-DFUSE_USE_VERSION=25` in `configureFlags`. The actual value would
39+ have to match the definition used in the upstream source code.
40+2. Remove `AC_CHECK_HEADERS` / `AC_CHECK_LIBS` for libfuse.
41+
42+However, a better solution might be to fix the build script upstream to use
43+`PKG_CHECK_MODULES` instead. This approach wouldn't suffer from the problem that
44+`AC_CHECK_HEADERS`/`AC_CHECK_LIBS` has at the price of introducing a dependency
45+on pkg-config.
doc/builders/packages/ibus.section.mdnew file+38
@@ -0,0 +1,38 @@
1+# ibus-engines.typing-booster {#sec-ibus-typing-booster}
2+
3+This package is an ibus-based completion method to speed up typing.
4+
5+## Activating the engine {#sec-ibus-typing-booster-activate}
6+
7+IBus needs to be configured accordingly to activate `typing-booster`. The configuration depends on the desktop manager in use. For detailed instructions, please refer to the [upstream docs](https://mike-fabian.github.io/ibus-typing-booster/documentation.html).
8+
9+On NixOS, you need to explicitly enable `ibus` with given engines before customizing your desktop to use `typing-booster`. This can be achieved using the `ibus` module:
10+
11+```nix
12+{ pkgs, ... }: {
13+ i18n.inputMethod = {
14+ enabled = "ibus";
15+ ibus.engines = with pkgs.ibus-engines; [ typing-booster ];
16+ };
17+}
18+```
19+
20+## Using custom hunspell dictionaries {#sec-ibus-typing-booster-customize-hunspell}
21+
22+The IBus engine is based on `hunspell` to support completion in many languages. By default, the dictionaries `de-de`, `en-us`, `fr-moderne` `es-es`, `it-it`, `sv-se` and `sv-fi` are in use. To add another dictionary, the package can be overridden like this:
23+
24+```nix
25+ibus-engines.typing-booster.override { langs = [ "de-at" "en-gb" ]; }
26+```
27+
28+_Note: each language passed to `langs` must be an attribute name in `pkgs.hunspellDicts`._
29+
30+## Built-in emoji picker {#sec-ibus-typing-booster-emoji-picker}
31+
32+The `ibus-engines.typing-booster` package contains a program named `emoji-picker`. To display all emojis correctly, a special font such as `noto-fonts-emoji` is needed:
33+
34+On NixOS, it can be installed using the following expression:
35+
36+```nix
37+{ pkgs, ... }: { fonts.fonts = with pkgs; [ noto-fonts-emoji ]; }
38+```
doc/builders/packages/index.xmlnew file+29
@@ -0,0 +1,29 @@
1+<chapter xmlns="http://docbook.org/ns/docbook"
2+ xmlns:xi="http://www.w3.org/2001/XInclude"
3+ xml:id="chap-packages">
4+ <title>Packages</title>
5+ <para>
6+ This chapter contains information about how to use and maintain the Nix expressions for a number of specific packages, such as the Linux kernel or X.org.
7+ </para>
8+ <xi:include href="citrix.section.xml" />
9+ <xi:include href="dlib.section.xml" />
10+ <xi:include href="eclipse.section.xml" />
11+ <xi:include href="elm.section.xml" />
12+ <xi:include href="emacs.section.xml" />
13+ <xi:include href="firefox.section.xml" />
14+ <xi:include href="fish.section.xml" />
15+ <xi:include href="fuse.section.xml" />
16+ <xi:include href="ibus.section.xml" />
17+ <xi:include href="kakoune.section.xml" />
18+ <xi:include href="linux.section.xml" />
19+ <xi:include href="locales.section.xml" />
20+ <xi:include href="etc-files.section.xml" />
21+ <xi:include href="nginx.section.xml" />
22+ <xi:include href="opengl.section.xml" />
23+ <xi:include href="shell-helpers.section.xml" />
24+ <xi:include href="steam.section.xml" />
25+ <xi:include href="cataclysm-dda.section.xml" />
26+ <xi:include href="urxvt.section.xml" />
27+ <xi:include href="weechat.section.xml" />
28+ <xi:include href="xorg.section.xml" />
29+</chapter>
doc/builders/packages/kakoune.section.mdnew file+9
@@ -0,0 +1,9 @@
1+# Kakoune {#sec-kakoune}
2+
3+Kakoune can be built to autoload plugins:
4+
5+```nix
6+(kakoune.override {
7+ plugins = with pkgs.kakounePlugins; [ parinfer-rust ];
8+})
9+```
doc/builders/packages/linux.section.mdnew file+41
@@ -0,0 +1,41 @@
1+# Linux kernel {#sec-linux-kernel}
2+
3+The Nix expressions to build the Linux kernel are in [`pkgs/os-specific/linux/kernel`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/os-specific/linux/kernel).
4+
5+The function that builds the kernel has an argument `kernelPatches` which should be a list of `{name, patch, extraConfig}` attribute sets, where `name` is the name of the patch (which is included in the kernel’s `meta.description` attribute), `patch` is the patch itself (possibly compressed), and `extraConfig` (optional) is a string specifying extra options to be concatenated to the kernel configuration file (`.config`).
6+
7+The kernel derivation exports an attribute `features` specifying whether optional functionality is or isn’t enabled. This is used in NixOS to implement kernel-specific behaviour. For instance, if the kernel has the `iwlwifi` feature (i.e., has built-in support for Intel wireless chipsets), then NixOS doesn’t have to build the external `iwlwifi` package:
8+
9+```nix
10+modulesTree = [kernel]
11+ ++ pkgs.lib.optional (!kernel.features ? iwlwifi) kernelPackages.iwlwifi
12+ ++ ...;
13+```
14+
15+How to add a new (major) version of the Linux kernel to Nixpkgs:
16+
17+1. Copy the old Nix expression (e.g., `linux-2.6.21.nix`) to the new one (e.g., `linux-2.6.22.nix`) and update it.
18+
19+2. Add the new kernel to the `kernels` attribute set in `linux-kernels.nix` (e.g., create an attribute `kernel_2_6_22`).
20+
21+3. Now we’re going to update the kernel configuration. First unpack the kernel. Then for each supported platform (`i686`, `x86_64`, `uml`) do the following:
22+
23+ 1. Make a copy from the old config (e.g., `config-2.6.21-i686-smp`) to the new one (e.g., `config-2.6.22-i686-smp`).
24+
25+ 2. Copy the config file for this platform (e.g., `config-2.6.22-i686-smp`) to `.config` in the kernel source tree.
26+
27+ 3. Run `make oldconfig ARCH={i386,x86_64,um}` and answer all questions. (For the uml configuration, also add `SHELL=bash`.) Make sure to keep the configuration consistent between platforms (i.e., don’t enable some feature on `i686` and disable it on `x86_64`).
28+
29+ 4. If needed, you can also run `make menuconfig`:
30+
31+ ```ShellSession
32+ $ nix-env -f "<nixpkgs>" -iA ncurses
33+ $ export NIX_CFLAGS_LINK=-lncurses
34+ $ make menuconfig ARCH=arch
35+ ```
36+
37+ 5. Copy `.config` over the new config file (e.g., `config-2.6.22-i686-smp`).
38+
39+4. Test building the kernel: `nix-build -A linuxKernel.kernels.kernel_2_6_22`. If it compiles, ship it! For extra credit, try booting NixOS with it.
40+
41+5. It may be that the new kernel requires updating the external kernel modules and kernel-dependent packages listed in the `linuxPackagesFor` function in `linux-kernels.nix` (such as the NVIDIA drivers, AUFS, etc.). If the updated packages aren’t backwards compatible with older kernels, you may need to keep the older versions around.
doc/builders/packages/locales.section.mdnew file+5
@@ -0,0 +1,5 @@
1+# Locales {#locales}
2+
3+To allow simultaneous use of packages linked against different versions of `glibc` with different locale archive formats, Nixpkgs patches `glibc` to rely on `LOCALE_ARCHIVE` environment variable.
4+
5+On non-NixOS distributions, this variable is obviously not set. This can cause regressions in language support or even crashes in some Nixpkgs-provided programs. The simplest way to mitigate this problem is exporting the `LOCALE_ARCHIVE` variable pointing to `${glibcLocales}/lib/locale/locale-archive`. The drawback (and the reason this is not the default) is the relatively large (a hundred MiB) size of the full set of locales. It is possible to build a custom set of locales by overriding parameters `allLocales` and `locales` of the package.
doc/builders/packages/nginx.section.mdnew file+11
@@ -0,0 +1,11 @@
1+# Nginx {#sec-nginx}
2+
3+[Nginx](https://nginx.org) is a reverse proxy and lightweight webserver.
4+
5+## ETags on static files served from the Nix store {#sec-nginx-etag}
6+
7+HTTP has a couple of different mechanisms for caching to prevent clients from having to download the same content repeatedly if a resource has not changed since the last time it was requested. When nginx is used as a server for static files, it implements the caching mechanism based on the [`Last-Modified`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Last-Modified) response header automatically; unfortunately, it works by using filesystem timestamps to determine the value of the `Last-Modified` header. This doesn't give the desired behavior when the file is in the Nix store because all file timestamps are set to 0 (for reasons related to build reproducibility).
8+
9+Fortunately, HTTP supports an alternative (and more effective) caching mechanism: the [`ETag`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) response header. The value of the `ETag` header specifies some identifier for the particular content that the server is sending (e.g., a hash). When a client makes a second request for the same resource, it sends that value back in an `If-None-Match` header. If the ETag value is unchanged, then the server does not need to resend the content.
10+
11+As of NixOS 19.09, the nginx package in Nixpkgs is patched such that when nginx serves a file out of `/nix/store`, the hash in the store path is used as the `ETag` header in the HTTP response, thus providing proper caching functionality. This happens automatically; you do not need to do modify any configuration to get this behavior.
doc/builders/packages/opengl.section.mdnew file+15
@@ -0,0 +1,15 @@
1+# OpenGL {#sec-opengl}
2+
3+OpenGL support varies depending on which hardware is used and which drivers are available and loaded.
4+
5+Broadly, we support both GL vendors: Mesa and NVIDIA.
6+
7+## NixOS Desktop {#nixos-desktop}
8+
9+The NixOS desktop or other non-headless configurations are the primary target for OpenGL libraries and applications. The current solution for discovering which drivers are available is based on [libglvnd](https://gitlab.freedesktop.org/glvnd/libglvnd). `libglvnd` performs "vendor-neutral dispatch", trying a variety of techniques to find the system's GL implementation. In practice, this will be either via standard GLX for X11 users or EGL for Wayland users, and supporting either NVIDIA or Mesa extensions.
10+
11+## Nix on GNU/Linux {#nix-on-gnulinux}
12+
13+If you are using a non-NixOS GNU/Linux/X11 desktop with free software video drivers, consider launching OpenGL-dependent programs from Nixpkgs with Nixpkgs versions of `libglvnd` and `mesa.drivers` in `LD_LIBRARY_PATH`. For Mesa drivers, the Linux kernel version doesn't have to match nixpkgs.
14+
15+For proprietary video drivers, you might have luck with also adding the corresponding video driver package.
doc/builders/packages/shell-helpers.section.mdnew file+12
@@ -0,0 +1,12 @@
1+# Interactive shell helpers {#sec-shell-helpers}
2+
3+Some packages provide the shell integration to be more useful. But unlike other systems, nix doesn't have a standard `share` directory location. This is why a bunch `PACKAGE-share` scripts are shipped that print the location of the corresponding shared folder. Current list of such packages is as following:
4+
5+- `fzf` : `fzf-share`
6+
7+E.g. `fzf` can then be used in the `.bashrc` like this:
8+
9+```bash
10+source "$(fzf-share)/completion.bash"
11+source "$(fzf-share)/key-bindings.bash"
12+```
doc/builders/packages/steam.section.mdnew file+63
@@ -0,0 +1,63 @@
1+# Steam {#sec-steam}
2+
3+## Steam in Nix {#sec-steam-nix}
4+
5+Steam is distributed as a `.deb` file, for now only as an i686 package (the amd64 package only has documentation). When unpacked, it has a script called `steam` that in Ubuntu (their target distro) would go to `/usr/bin`. When run for the first time, this script copies some files to the user's home, which include another script that is the ultimate responsible for launching the steam binary, which is also in `$HOME`.
6+
7+Nix problems and constraints:
8+
9+- We don't have `/bin/bash` and many scripts point there. Same thing for `/usr/bin/python`.
10+- We don't have the dynamic loader in `/lib`.
11+- The `steam.sh` script in `$HOME` cannot be patched, as it is checked and rewritten by steam.
12+- The steam binary cannot be patched, it's also checked.
13+
14+The current approach to deploy Steam in NixOS is composing a FHS-compatible chroot environment, as documented [here](http://sandervanderburg.blogspot.nl/2013/09/composing-fhs-compatible-chroot.html). This allows us to have binaries in the expected paths without disrupting the system, and to avoid patching them to work in a non FHS environment.
15+
16+## How to play {#sec-steam-play}
17+
18+Use `programs.steam.enable = true;` if you want to add steam to `systemPackages` and also enable a few workarounds as well as Steam controller support or other Steam supported controllers such as the DualShock 4 or Nintendo Switch Pro Controller.
19+
20+## Troubleshooting {#sec-steam-troub}
21+
22+- **Steam fails to start. What do I do?**
23+
24+ Try to run
25+
26+ ```ShellSession
27+ strace steam
28+ ```
29+
30+ to see what is causing steam to fail.
31+
32+- **Using the FOSS Radeon or nouveau (nvidia) drivers**
33+
34+ - The `newStdcpp` parameter was removed since NixOS 17.09 and should not be needed anymore.
35+ - Steam ships statically linked with a version of `libcrypto` that conflicts with the one dynamically loaded by radeonsi_dri.so. If you get the error:
36+
37+ ```
38+ steam.sh: line 713: 7842 Segmentation fault (core dumped)
39+ ```
40+
41+ have a look at [this pull request](https://github.com/NixOS/nixpkgs/pull/20269).
42+
43+- **Java**
44+
45+ 1. There is no java in steam chrootenv by default. If you get a message like:
46+
47+ ```
48+ /home/foo/.local/share/Steam/SteamApps/common/towns/towns.sh: line 1: java: command not found
49+ ```
50+
51+ you need to add:
52+
53+ ```nix
54+ steam.override { withJava = true; };
55+ ```
56+
57+## steam-run {#sec-steam-run}
58+
59+The FHS-compatible chroot used for Steam can also be used to run other Linux games that expect a FHS environment. To use it, install the `steam-run` package and run the game with:
60+
61+```
62+steam-run ./foo
63+```
doc/builders/packages/unfree.xmlnew file+13
@@ -0,0 +1,13 @@
1+<section xmlns="http://docbook.org/ns/docbook"
2+ xmlns:xlink="http://www.w3.org/1999/xlink"
3+ xml:id="unfree-software">
4+ <title>Unfree software</title>
5+
6+ <para>
7+ All users of Nixpkgs are free software users, and many users (and developers) of Nixpkgs want to limit and tightly control their exposure to unfree software. At the same time, many users need (or want) to run some specific pieces of proprietary software. Nixpkgs includes some expressions for unfree software packages. By default unfree software cannot be installed and doesn’t show up in searches. To allow installing unfree software in a single Nix invocation one can export <literal>NIXPKGS_ALLOW_UNFREE=1</literal>. For a persistent solution, users can set <literal>allowUnfree</literal> in the Nixpkgs configuration.
8+ </para>
9+
10+ <para>
11+ Fine-grained control is possible by defining <literal>allowUnfreePredicate</literal> function in config; it takes the <literal>mkDerivation</literal> parameter attrset and returns <literal>true</literal> for unfree packages that should be allowed.
12+ </para>
13+</section>
doc/builders/packages/urxvt.section.mdnew file+71
@@ -0,0 +1,71 @@
1+# Urxvt {#sec-urxvt}
2+
3+Urxvt, also known as rxvt-unicode, is a highly customizable terminal emulator.
4+
5+## Configuring urxvt {#sec-urxvt-conf}
6+
7+In `nixpkgs`, urxvt is provided by the package `rxvt-unicode`. It can be configured to include your choice of plugins, reducing its closure size from the default configuration which includes all available plugins. To make use of this functionality, use an overlay or directly install an expression that overrides its configuration, such as:
8+
9+```nix
10+rxvt-unicode.override {
11+ configure = { availablePlugins, ... }: {
12+ plugins = with availablePlugins; [ perls resize-font vtwheel ];
13+ };
14+}
15+```
16+
17+If the `configure` function returns an attrset without the `plugins` attribute, `availablePlugins` will be used automatically.
18+
19+In order to add plugins but also keep all default plugins installed, it is possible to use the following method:
20+
21+```nix
22+rxvt-unicode.override {
23+ configure = { availablePlugins, ... }: {
24+ plugins = (builtins.attrValues availablePlugins) ++ [ custom-plugin ];
25+ };
26+}
27+```
28+
29+To get a list of all the plugins available, open the Nix REPL and run
30+
31+```ShellSession
32+$ nix repl
33+:l <nixpkgs>
34+map (p: p.name) pkgs.rxvt-unicode.plugins
35+```
36+
37+Alternatively, if your shell is bash or zsh and have completion enabled, simply type `nixpkgs.rxvt-unicode.plugins.<tab>`.
38+
39+In addition to `plugins` the options `extraDeps` and `perlDeps` can be used to install extra packages. `extraDeps` can be used, for example, to provide `xsel` (a clipboard manager) to the clipboard plugin, without installing it globally:
40+
41+```nix
42+rxvt-unicode.override {
43+ configure = { availablePlugins, ... }: {
44+ pluginsDeps = [ xsel ];
45+ };
46+}
47+```
48+
49+`perlDeps` is a handy way to provide Perl packages to your custom plugins (in `$HOME/.urxvt/ext`). For example, if you need `AnyEvent` you can do:
50+
51+```nix
52+rxvt-unicode.override {
53+ configure = { availablePlugins, ... }: {
54+ perlDeps = with perlPackages; [ AnyEvent ];
55+ };
56+}
57+```
58+
59+## Packaging urxvt plugins {#sec-urxvt-pkg}
60+
61+Urxvt plugins resides in `pkgs/applications/misc/rxvt-unicode-plugins`. To add a new plugin, create an expression in a subdirectory and add the package to the set in `pkgs/applications/misc/rxvt-unicode-plugins/default.nix`.
62+
63+A plugin can be any kind of derivation, the only requirement is that it should always install perl scripts in `$out/lib/urxvt/perl`. Look for existing plugins for examples.
64+
65+If the plugin is itself a Perl package that needs to be imported from other plugins or scripts, add the following passthrough:
66+
67+```nix
68+passthru.perlPackages = [ "self" ];
69+```
70+
71+This will make the urxvt wrapper pick up the dependency and set up the Perl path accordingly.
doc/builders/packages/weechat.section.mdnew file+85
@@ -0,0 +1,85 @@
1+# WeeChat {#sec-weechat}
2+
3+WeeChat can be configured to include your choice of plugins, reducing its closure size from the default configuration which includes all available plugins. To make use of this functionality, install an expression that overrides its configuration, such as:
4+
5+```nix
6+weechat.override {configure = {availablePlugins, ...}: {
7+ plugins = with availablePlugins; [ python perl ];
8+ }
9+}
10+```
11+
12+If the `configure` function returns an attrset without the `plugins` attribute, `availablePlugins` will be used automatically.
13+
14+The plugins currently available are `python`, `perl`, `ruby`, `guile`, `tcl` and `lua`.
15+
16+The Python and Perl plugins allows the addition of extra libraries. For instance, the `inotify.py` script in `weechat-scripts` requires D-Bus or libnotify, and the `fish.py` script requires `pycrypto`. To use these scripts, use the plugin's `withPackages` attribute:
17+
18+```nix
19+weechat.override { configure = {availablePlugins, ...}: {
20+ plugins = with availablePlugins; [
21+ (python.withPackages (ps: with ps; [ pycrypto python-dbus ]))
22+ ];
23+ };
24+}
25+```
26+
27+In order to also keep all default plugins installed, it is possible to use the following method:
28+
29+```nix
30+weechat.override { configure = { availablePlugins, ... }: {
31+ plugins = builtins.attrValues (availablePlugins // {
32+ python = availablePlugins.python.withPackages (ps: with ps; [ pycrypto python-dbus ]);
33+ });
34+}; }
35+```
36+
37+WeeChat allows to set defaults on startup using the `--run-command`. The `configure` method can be used to pass commands to the program:
38+
39+```nix
40+weechat.override {
41+ configure = { availablePlugins, ... }: {
42+ init = ''
43+ /set foo bar
44+ /server add libera irc.libera.chat
45+ '';
46+ };
47+}
48+```
49+
50+Further values can be added to the list of commands when running `weechat --run-command "your-commands"`.
51+
52+Additionally, it's possible to specify scripts to be loaded when starting `weechat`. These will be loaded before the commands from `init`:
53+
54+```nix
55+weechat.override {
56+ configure = { availablePlugins, ... }: {
57+ scripts = with pkgs.weechatScripts; [
58+ weechat-xmpp weechat-matrix-bridge wee-slack
59+ ];
60+ init = ''
61+ /set plugins.var.python.jabber.key "val"
62+ '':
63+ };
64+}
65+```
66+
67+In `nixpkgs` there's a subpackage which contains derivations for WeeChat scripts. Such derivations expect a `passthru.scripts` attribute, which contains a list of all scripts inside the store path. Furthermore, all scripts have to live in `$out/share`. An exemplary derivation looks like this:
68+
69+```nix
70+{ stdenv, fetchurl }:
71+
72+stdenv.mkDerivation {
73+ name = "exemplary-weechat-script";
74+ src = fetchurl {
75+ url = "https://scripts.tld/your-scripts.tar.gz";
76+ sha256 = "...";
77+ };
78+ passthru.scripts = [ "foo.py" "bar.lua" ];
79+ installPhase = ''
80+ mkdir $out/share
81+ cp foo.py $out/share
82+ cp bar.lua $out/share
83+ '';
84+}
85+```
doc/builders/packages/xorg.section.mdnew file+34
@@ -0,0 +1,34 @@
1+# X.org {#sec-xorg}
2+
3+The Nix expressions for the X.org packages reside in `pkgs/servers/x11/xorg/default.nix`. This file is automatically generated from lists of tarballs in an X.org release. As such it should not be modified directly; rather, you should modify the lists, the generator script or the file `pkgs/servers/x11/xorg/overrides.nix`, in which you can override or add to the derivations produced by the generator.
4+
5+## Katamari Tarballs {#katamari-tarballs}
6+
7+X.org upstream releases used to include [katamari](https://en.wiktionary.org/wiki/%E3%81%8B%E3%81%9F%E3%81%BE%E3%82%8A) releases, which included a holistic recommended version for each tarball, up until 7.7. To create a list of tarballs in a katamari release:
8+
9+```ShellSession
10+export release="X11R7.7"
11+export url="mirror://xorg/$release/src/everything/"
12+cat $(PRINT_PATH=1 nix-prefetch-url $url | tail -n 1) \
13+ | perl -e 'while (<>) { if (/(href|HREF)="([^"]*.bz2)"/) { print "$ENV{'url'}$2\n"; }; }' \
14+ | sort > "tarballs-$release.list"
15+```
16+
17+## Individual Tarballs {#individual-tarballs}
18+
19+The upstream release process for [X11R7.8](https://x.org/wiki/Releases/7.8/) does not include a planned katamari. Instead, each component of X.org is released as its own tarball. We maintain `pkgs/servers/x11/xorg/tarballs.list` as a list of tarballs for each individual package. This list includes X.org core libraries and protocol descriptions, extra newer X11 interface libraries, like `xorg.libxcb`, and classic utilities which are largely unused but still available if needed, like `xorg.imake`.
20+
21+## Generating Nix Expressions {#generating-nix-expressions}
22+
23+The generator is invoked as follows:
24+
25+```ShellSession
26+cd pkgs/servers/x11/xorg
27+<tarballs.list perl ./generate-expr-from-tarballs.pl
28+```
29+
30+For each of the tarballs in the `.list` files, the script downloads it, unpacks it, and searches its `configure.ac` and `*.pc.in` files for dependencies. This information is used to generate `default.nix`. The generator caches downloaded tarballs between runs. Pay close attention to the `NOT FOUND: $NAME` messages at the end of the run, since they may indicate missing dependencies. (Some might be optional dependencies, however.)
31+
32+## Overriding the Generator {#overriding-the-generator}
33+
34+If the expression for a package requires derivation attributes that the generator cannot figure out automatically (say, `patches` or a `postInstall` hook), you should modify `pkgs/servers/x11/xorg/overrides.nix`.
doc/builders/special.xmlnew file+10
@@ -0,0 +1,10 @@
1+<chapter xmlns="http://docbook.org/ns/docbook"
2+ xmlns:xi="http://www.w3.org/2001/XInclude"
3+ xml:id="chap-special">
4+ <title>Special builders</title>
5+ <para>
6+ This chapter describes several special builders.
7+ </para>
8+ <xi:include href="special/fhs-environments.section.xml" />
9+ <xi:include href="special/mkshell.section.xml" />
10+</chapter>
doc/builders/special/fhs-environments.section.mdnew file+49
@@ -0,0 +1,49 @@
1+# buildFHSUserEnv {#sec-fhs-environments}
2+
3+`buildFHSUserEnv` provides a way to build and run FHS-compatible lightweight sandboxes. It creates an isolated root with bound `/nix/store`, so its footprint in terms of disk space needed is quite small. This allows one to run software which is hard or unfeasible to patch for NixOS -- 3rd-party source trees with FHS assumptions, games distributed as tarballs, software with integrity checking and/or external self-updated binaries. It uses Linux namespaces feature to create temporary lightweight environments which are destroyed after all child processes exit, without root user rights requirement. Accepted arguments are:
4+
5+- `name`
6+ Environment name.
7+- `targetPkgs`
8+ Packages to be installed for the main host's architecture (i.e. x86_64 on x86_64 installations). Along with libraries binaries are also installed.
9+- `multiPkgs`
10+ Packages to be installed for all architectures supported by a host (i.e. i686 and x86_64 on x86_64 installations). Only libraries are installed by default.
11+- `extraBuildCommands`
12+ Additional commands to be executed for finalizing the directory structure.
13+- `extraBuildCommandsMulti`
14+ Like `extraBuildCommands`, but executed only on multilib architectures.
15+- `extraOutputsToInstall`
16+ Additional derivation outputs to be linked for both target and multi-architecture packages.
17+- `extraInstallCommands`
18+ Additional commands to be executed for finalizing the derivation with runner script.
19+- `runScript`
20+ A command that would be executed inside the sandbox and passed all the command line arguments. It defaults to `bash`.
21+- `profile`
22+ Optional script for `/etc/profile` within the sandbox.
23+
24+One can create a simple environment using a `shell.nix` like that:
25+
26+```nix
27+{ pkgs ? import <nixpkgs> {} }:
28+
29+(pkgs.buildFHSUserEnv {
30+ name = "simple-x11-env";
31+ targetPkgs = pkgs: (with pkgs;
32+ [ udev
33+ alsa-lib
34+ ]) ++ (with pkgs.xorg;
35+ [ libX11
36+ libXcursor
37+ libXrandr
38+ ]);
39+ multiPkgs = pkgs: (with pkgs;
40+ [ udev
41+ alsa-lib
42+ ]);
43+ runScript = "bash";
44+}).env
45+```
46+
47+Running `nix-shell` would then drop you into a shell with these libraries and binaries available. You can use this to run closed-source applications which expect FHS structure without hassles: simply change `runScript` to the application path, e.g. `./bin/start.sh` -- relative paths are supported.
48+
49+Additionally, the FHS builder links all relocated gsettings-schemas (the glib setup-hook moves them to `share/gsettings-schemas/${name}/glib-2.0/schemas`) to their standard FHS location. This means you don't need to wrap binaries with `wrapGAppsHook`.
doc/builders/special/mkshell.section.mdnew file+37
@@ -0,0 +1,37 @@
1+# pkgs.mkShell {#sec-pkgs-mkShell}
2+
3+`pkgs.mkShell` is a specialized `stdenv.mkDerivation` that removes some
4+repetition when using it with `nix-shell` (or `nix develop`).
5+
6+## Usage {#sec-pkgs-mkShell-usage}
7+
8+Here is a common usage example:
9+
10+```nix
11+{ pkgs ? import <nixpkgs> {} }:
12+pkgs.mkShell {
13+ packages = [ pkgs.gnumake ];
14+
15+ inputsFrom = [ pkgs.hello pkgs.gnutar ];
16+
17+ shellHook = ''
18+ export DEBUG=1
19+ '';
20+}
21+```
22+
23+## Attributes
24+
25+* `name` (default: `nix-shell`). Set the name of the derivation.
26+* `packages` (default: `[]`). Add executable packages to the `nix-shell` environment.
27+* `inputsFrom` (default: `[]`). Add build dependencies of the listed derivations to the `nix-shell` environment.
28+* `shellHook` (default: `""`). Bash statements that are executed by `nix-shell`.
29+
30+... all the attributes of `stdenv.mkDerivation`.
31+
32+## Building the shell
33+
34+This derivation output will contain a text file that contains a reference to
35+all the build inputs. This is useful in CI where we want to make sure that
36+every derivation, and its dependencies, build properly. Or when creating a GC
37+root so that the build dependencies don't get garbage-collected.
doc/builders/testers.chapter.mdnew file+82
@@ -0,0 +1,82 @@
1+# Testers {#chap-testers}
2+This chapter describes several testing builders which are available in the <literal>testers</literal> namespace.
3+
4+## `testVersion` {#tester-testVersion}
5+
6+Checks the command output contains the specified version
7+
8+Although simplistic, this test assures that the main program
9+can run. While there's no substitute for a real test case,
10+it does catch dynamic linking errors and such. It also provides
11+some protection against accidentally building the wrong version,
12+for example when using an 'old' hash in a fixed-output derivation.
13+
14+Examples:
15+
16+```nix
17+passthru.tests.version = testVersion { package = hello; };
18+
19+passthru.tests.version = testVersion {
20+ package = seaweedfs;
21+ command = "weed version";
22+};
23+
24+passthru.tests.version = testVersion {
25+ package = key;
26+ command = "KeY --help";
27+ # Wrong '2.5' version in the code. Drop on next version.
28+ version = "2.5";
29+};
30+```
31+
32+## `testEqualDerivation` {#tester-testEqualDerivation}
33+
34+Checks that two packages produce the exact same build instructions.
35+
36+This can be used to make sure that a certain difference of configuration,
37+such as the presence of an overlay does not cause a cache miss.
38+
39+When the derivations are equal, the return value is an empty file.
40+Otherwise, the build log explains the difference via `nix-diff`.
41+
42+Example:
43+
44+```nix
45+testEqualDerivation
46+ "The hello package must stay the same when enabling checks."
47+ hello
48+ (hello.overrideAttrs(o: { doCheck = true; }))
49+```
50+
51+## `invalidateFetcherByDrvHash` {#tester-invalidateFetcherByDrvHash}
52+
53+Use the derivation hash to invalidate the output via name, for testing.
54+
55+Type: `(a@{ name, ... } -> Derivation) -> a -> Derivation`
56+
57+Normally, fixed output derivations can and should be cached by their output
58+hash only, but for testing we want to re-fetch everytime the fetcher changes.
59+
60+Changes to the fetcher become apparent in the drvPath, which is a hash of
61+how to fetch, rather than a fixed store path.
62+By inserting this hash into the name, we can make sure to re-run the fetcher
63+every time the fetcher changes.
64+
65+This relies on the assumption that Nix isn't clever enough to reuse its
66+database of local store contents to optimize fetching.
67+
68+You might notice that the "salted" name derives from the normal invocation,
69+not the final derivation. `invalidateFetcherByDrvHash` has to invoke the fetcher
70+function twice: once to get a derivation hash, and again to produce the final
71+fixed output derivation.
72+
73+Example:
74+
75+```nix
76+tests.fetchgit = invalidateFetcherByDrvHash fetchgit {
77+ name = "nix-source";
78+ url = "https://github.com/NixOS/nix";
79+ rev = "9d9dbe6ed05854e03811c361a3380e09183f4f4a";
80+ sha256 = "sha256-7DszvbCNTjpzGRmpIVAWXk20P0/XTrWZ79KSOGLrUWY=";
81+};
82+```
doc/builders/trivial-builders.chapter.mdnew file+223
@@ -0,0 +1,223 @@
1+# Trivial builders {#chap-trivial-builders}
2+
3+Nixpkgs provides a couple of functions that help with building derivations. The most important one, `stdenv.mkDerivation`, has already been documented above. The following functions wrap `stdenv.mkDerivation`, making it easier to use in certain cases.
4+
5+## `runCommand` {#trivial-builder-runCommand}
6+
7+This takes three arguments, `name`, `env`, and `buildCommand`. `name` is just the name that Nix will append to the store path in the same way that `stdenv.mkDerivation` uses its `name` attribute. `env` is an attribute set specifying environment variables that will be set for this derivation. These attributes are then passed to the wrapped `stdenv.mkDerivation`. `buildCommand` specifies the commands that will be run to create this derivation. Note that you will need to create `$out` for Nix to register the command as successful.
8+
9+An example of using `runCommand` is provided below.
10+
11+```nix
12+(import <nixpkgs> {}).runCommand "my-example" {} ''
13+ echo My example command is running
14+
15+ mkdir $out
16+
17+ echo I can write data to the Nix store > $out/message
18+
19+ echo I can also run basic commands like:
20+
21+ echo ls
22+ ls
23+
24+ echo whoami
25+ whoami
26+
27+ echo date
28+ date
29+''
30+```
31+
32+## `runCommandCC` {#trivial-builder-runCommandCC}
33+
34+This works just like `runCommand`. The only difference is that it also provides a C compiler in `buildCommand`'s environment. To minimize your dependencies, you should only use this if you are sure you will need a C compiler as part of running your command.
35+
36+## `runCommandLocal` {#trivial-builder-runCommandLocal}
37+
38+Variant of `runCommand` that forces the derivation to be built locally, it is not substituted. This is intended for very cheap commands (<1s execution time). It saves on the network round-trip and can speed up a build.
39+
40+::: {.note}
41+This sets [`allowSubstitutes` to `false`](https://nixos.org/nix/manual/#adv-attr-allowSubstitutes), so only use `runCommandLocal` if you are certain the user will always have a builder for the `system` of the derivation. This should be true for most trivial use cases (e.g., just copying some files to a different location or adding symlinks) because there the `system` is usually the same as `builtins.currentSystem`.
42+:::
43+
44+## `writeTextFile`, `writeText`, `writeTextDir`, `writeScript`, `writeScriptBin` {#trivial-builder-writeText}
45+
46+These functions write `text` to the Nix store. This is useful for creating scripts from Nix expressions. `writeTextFile` takes an attribute set and expects two arguments, `name` and `text`. `name` corresponds to the name used in the Nix store path. `text` will be the contents of the file. You can also set `executable` to true to make this file have the executable bit set.
47+
48+Many more commands wrap `writeTextFile` including `writeText`, `writeTextDir`, `writeScript`, and `writeScriptBin`. These are convenience functions over `writeTextFile`.
49+
50+Here are a few examples:
51+```nix
52+# Writes my-file to /nix/store/<store path>
53+writeTextFile {
54+ name = "my-file";
55+ text = ''
56+ Contents of File
57+ '';
58+}
59+# See also the `writeText` helper function below.
60+
61+# Writes executable my-file to /nix/store/<store path>/bin/my-file
62+writeTextFile {
63+ name = "my-file";
64+ text = ''
65+ Contents of File
66+ '';
67+ executable = true;
68+ destination = "/bin/my-file";
69+}
70+# Writes contents of file to /nix/store/<store path>
71+writeText "my-file"
72+ ''
73+ Contents of File
74+ '';
75+# Writes contents of file to /nix/store/<store path>/share/my-file
76+writeTextDir "share/my-file"
77+ ''
78+ Contents of File
79+ '';
80+# Writes my-file to /nix/store/<store path> and makes executable
81+writeScript "my-file"
82+ ''
83+ Contents of File
84+ '';
85+# Writes my-file to /nix/store/<store path>/bin/my-file and makes executable.
86+writeScriptBin "my-file"
87+ ''
88+ Contents of File
89+ '';
90+# Writes my-file to /nix/store/<store path> and makes executable.
91+writeShellScript "my-file"
92+ ''
93+ Contents of File
94+ '';
95+# Writes my-file to /nix/store/<store path>/bin/my-file and makes executable.
96+writeShellScriptBin "my-file"
97+ ''
98+ Contents of File
99+ '';
100+
101+```
102+
103+## `concatTextFile`, `concatText`, `concatScript` {#trivial-builder-concatText}
104+
105+These functions concatenate `files` to the Nix store in a single file. This is useful for configuration files structured in lines of text. `concatTextFile` takes an attribute set and expects two arguments, `name` and `files`. `name` corresponds to the name used in the Nix store path. `files` will be the files to be concatenated. You can also set `executable` to true to make this file have the executable bit set.
106+`concatText` and`concatScript` are simple wrappers over `concatTextFile`.
107+
108+Here are a few examples:
109+```nix
110+
111+# Writes my-file to /nix/store/<store path>
112+concatTextFile {
113+ name = "my-file";
114+ files = [ drv1 "${drv2}/path/to/file" ];
115+}
116+# See also the `concatText` helper function below.
117+
118+# Writes executable my-file to /nix/store/<store path>/bin/my-file
119+concatTextFile {
120+ name = "my-file";
121+ files = [ drv1 "${drv2}/path/to/file" ];
122+ executable = true;
123+ destination = "/bin/my-file";
124+}
125+# Writes contents of files to /nix/store/<store path>
126+concatText "my-file" [ file1 file2 ]
127+
128+# Writes contents of files to /nix/store/<store path>
129+concatScript "my-file" [ file1 file2 ]
130+```
131+
132+## `writeShellApplication` {#trivial-builder-writeShellApplication}
133+
134+This can be used to easily produce a shell script that has some dependencies (`runtimeInputs`). It automatically sets the `PATH` of the script to contain all of the listed inputs, sets some sanity shellopts (`errexit`, `nounset`, `pipefail`), and checks the resulting script with [`shellcheck`](https://github.com/koalaman/shellcheck).
135+
136+For example, look at the following code:
137+
138+```nix
139+writeShellApplication {
140+ name = "show-nixos-org";
141+
142+ runtimeInputs = [ curl w3m ];
143+
144+ text = ''
145+ curl -s 'https://nixos.org' | w3m -dump -T text/html
146+ '';
147+}
148+```
149+
150+Unlike with normal `writeShellScriptBin`, there is no need to manually write out `${curl}/bin/curl`, setting the PATH
151+was handled by `writeShellApplication`. Moreover, the script is being checked with `shellcheck` for more strict
152+validation.
153+
154+## `symlinkJoin` {#trivial-builder-symlinkJoin}
155+
156+This can be used to put many derivations into the same directory structure. It works by creating a new derivation and adding symlinks to each of the paths listed. It expects two arguments, `name`, and `paths`. `name` is the name used in the Nix store path for the created derivation. `paths` is a list of paths that will be symlinked. These paths can be to Nix store derivations or any other subdirectory contained within.
157+Here is an example:
158+```nix
159+# adds symlinks of hello and stack to current build and prints "links added"
160+symlinkJoin { name = "myexample"; paths = [ pkgs.hello pkgs.stack ]; postBuild = "echo links added"; }
161+```
162+This creates a derivation with a directory structure like the following:
163+```
164+/nix/store/sglsr5g079a5235hy29da3mq3hv8sjmm-myexample
165+|-- bin
166+| |-- hello -> /nix/store/qy93dp4a3rqyn2mz63fbxjg228hffwyw-hello-2.10/bin/hello
167+| `-- stack -> /nix/store/6lzdpxshx78281vy056lbk553ijsdr44-stack-2.1.3.1/bin/stack
168+`-- share
169+ |-- bash-completion
170+ | `-- completions
171+ | `-- stack -> /nix/store/6lzdpxshx78281vy056lbk553ijsdr44-stack-2.1.3.1/share/bash-completion/completions/stack
172+ |-- fish
173+ | `-- vendor_completions.d
174+ | `-- stack.fish -> /nix/store/6lzdpxshx78281vy056lbk553ijsdr44-stack-2.1.3.1/share/fish/vendor_completions.d/stack.fish
175+...
176+```
177+
178+## `writeReferencesToFile` {#trivial-builder-writeReferencesToFile}
179+
180+Writes the closure of transitive dependencies to a file.
181+
182+This produces the equivalent of `nix-store -q --requisites`.
183+
184+For example,
185+
186+```nix
187+writeReferencesToFile (writeScriptBin "hi" ''${hello}/bin/hello'')
188+```
189+
190+produces an output path `/nix/store/<hash>-runtime-deps` containing
191+
192+```nix
193+/nix/store/<hash>-hello-2.10
194+/nix/store/<hash>-hi
195+/nix/store/<hash>-libidn2-2.3.0
196+/nix/store/<hash>-libunistring-0.9.10
197+/nix/store/<hash>-glibc-2.32-40
198+```
199+
200+You can see that this includes `hi`, the original input path,
201+`hello`, which is a direct reference, but also
202+the other paths that are indirectly required to run `hello`.
203+
204+## `writeDirectReferencesToFile` {#trivial-builder-writeDirectReferencesToFile}
205+
206+Writes the set of references to the output file, that is, their immediate dependencies.
207+
208+This produces the equivalent of `nix-store -q --references`.
209+
210+For example,
211+
212+```nix
213+writeDirectReferencesToFile (writeScriptBin "hi" ''${hello}/bin/hello'')
214+```
215+
216+produces an output path `/nix/store/<hash>-runtime-references` containing
217+
218+```nix
219+/nix/store/<hash>-hello-2.10
220+```
221+
222+but none of `hello`'s dependencies because those are not referenced directly
223+by `hi`'s output.
doc/contributing/coding-conventions.chapter.mdnew file+665
@@ -0,0 +1,665 @@
1+# Coding conventions {#chap-conventions}
2+
3+## Syntax {#sec-syntax}
4+
5+- Use 2 spaces of indentation per indentation level in Nix expressions, 4 spaces in shell scripts.
6+
7+- Do not use tab characters, i.e. configure your editor to use soft tabs. For instance, use `(setq-default indent-tabs-mode nil)` in Emacs. Everybody has different tab settings so it’s asking for trouble.
8+
9+- Use `lowerCamelCase` for variable names, not `UpperCamelCase`. Note, this rule does not apply to package attribute names, which instead follow the rules in [](#sec-package-naming).
10+
11+- Function calls with attribute set arguments are written as
12+
13+ ```nix
14+ foo {
15+ arg = ...;
16+ }
17+ ```
18+
19+ not
20+
21+ ```nix
22+ foo
23+ {
24+ arg = ...;
25+ }
26+ ```
27+
28+ Also fine is
29+
30+ ```nix
31+ foo { arg = ...; }
32+ ```
33+
34+ if it's a short call.
35+
36+- In attribute sets or lists that span multiple lines, the attribute names or list elements should be aligned:
37+
38+ ```nix
39+ # A long list.
40+ list = [
41+ elem1
42+ elem2
43+ elem3
44+ ];
45+
46+ # A long attribute set.
47+ attrs = {
48+ attr1 = short_expr;
49+ attr2 =
50+ if true then big_expr else big_expr;
51+ };
52+
53+ # Combined
54+ listOfAttrs = [
55+ {
56+ attr1 = 3;
57+ attr2 = "fff";
58+ }
59+ {
60+ attr1 = 5;
61+ attr2 = "ggg";
62+ }
63+ ];
64+ ```
65+
66+- Short lists or attribute sets can be written on one line:
67+
68+ ```nix
69+ # A short list.
70+ list = [ elem1 elem2 elem3 ];
71+
72+ # A short set.
73+ attrs = { x = 1280; y = 1024; };
74+ ```
75+
76+- Breaking in the middle of a function argument can give hard-to-read code, like
77+
78+ ```nix
79+ someFunction { x = 1280;
80+ y = 1024; } otherArg
81+ yetAnotherArg
82+ ```
83+
84+ (especially if the argument is very large, spanning multiple lines).
85+
86+ Better:
87+
88+ ```nix
89+ someFunction
90+ { x = 1280; y = 1024; }
91+ otherArg
92+ yetAnotherArg
93+ ```
94+
95+ or
96+
97+ ```nix
98+ let res = { x = 1280; y = 1024; };
99+ in someFunction res otherArg yetAnotherArg
100+ ```
101+
102+- The bodies of functions, asserts, and withs are not indented to prevent a lot of superfluous indentation levels, i.e.
103+
104+ ```nix
105+ { arg1, arg2 }:
106+ assert system == "i686-linux";
107+ stdenv.mkDerivation { ...
108+ ```
109+
110+ not
111+
112+ ```nix
113+ { arg1, arg2 }:
114+ assert system == "i686-linux";
115+ stdenv.mkDerivation { ...
116+ ```
117+
118+- Function formal arguments are written as:
119+
120+ ```nix
121+ { arg1, arg2, arg3 }:
122+ ```
123+
124+ but if they don't fit on one line they're written as:
125+
126+ ```nix
127+ { arg1, arg2, arg3
128+ , arg4, ...
129+ , # Some comment...
130+ argN
131+ }:
132+ ```
133+
134+- Functions should list their expected arguments as precisely as possible. That is, write
135+
136+ ```nix
137+ { stdenv, fetchurl, perl }: ...
138+ ```
139+
140+ instead of
141+
142+ ```nix
143+ args: with args; ...
144+ ```
145+
146+ or
147+
148+ ```nix
149+ { stdenv, fetchurl, perl, ... }: ...
150+ ```
151+
152+ For functions that are truly generic in the number of arguments (such as wrappers around `mkDerivation`) that have some required arguments, you should write them using an `@`-pattern:
153+
154+ ```nix
155+ { stdenv, doCoverageAnalysis ? false, ... } @ args:
156+
157+ stdenv.mkDerivation (args // {
158+ ... if doCoverageAnalysis then "bla" else "" ...
159+ })
160+ ```
161+
162+ instead of
163+
164+ ```nix
165+ args:
166+
167+ args.stdenv.mkDerivation (args // {
168+ ... if args ? doCoverageAnalysis && args.doCoverageAnalysis then "bla" else "" ...
169+ })
170+ ```
171+
172+- Unnecessary string conversions should be avoided. Do
173+
174+ ```nix
175+ rev = version;
176+ ```
177+
178+ instead of
179+
180+ ```nix
181+ rev = "${version}";
182+ ```
183+
184+- Building lists conditionally _should_ be done with `lib.optional(s)` instead of using `if cond then [ ... ] else null` or `if cond then [ ... ] else [ ]`.
185+
186+ ```nix
187+ buildInputs = lib.optional stdenv.isDarwin iconv;
188+ ```
189+
190+ instead of
191+
192+ ```nix
193+ buildInputs = if stdenv.isDarwin then [ iconv ] else null;
194+ ```
195+
196+ As an exception, an explicit conditional expression with null can be used when fixing a important bug without triggering a mass rebuild.
197+ If this is done a follow up pull request _should_ be created to change the code to `lib.optional(s)`.
198+
199+- Arguments should be listed in the order they are used, with the exception of `lib`, which always goes first.
200+
201+## Package naming {#sec-package-naming}
202+
203+The key words _must_, _must not_, _required_, _shall_, _shall not_, _should_, _should not_, _recommended_, _may_, and _optional_ in this section are to be interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119). Only _emphasized_ words are to be interpreted in this way.
204+
205+In Nixpkgs, there are generally three different names associated with a package:
206+
207+- The `name` attribute of the derivation (excluding the version part). This is what most users see, in particular when using `nix-env`.
208+
209+- The variable name used for the instantiated package in `all-packages.nix`, and when passing it as a dependency to other functions. Typically this is called the _package attribute name_. This is what Nix expression authors see. It can also be used when installing using `nix-env -iA`.
210+
211+- The filename for (the directory containing) the Nix expression.
212+
213+Most of the time, these are the same. For instance, the package `e2fsprogs` has a `name` attribute `"e2fsprogs-version"`, is bound to the variable name `e2fsprogs` in `all-packages.nix`, and the Nix expression is in `pkgs/os-specific/linux/e2fsprogs/default.nix`.
214+
215+There are a few naming guidelines:
216+
217+- The `pname` attribute _should_ be identical to the upstream package name.
218+
219+- The `pname` and the `version` attribute _must not_ contain uppercase letters — e.g., `"mplayer" instead of `"MPlayer"`.
220+
221+- The `version` attribute _must_ start with a digit e.g`"0.3.1rc2".
222+
223+- If a package is not a release but a commit from a repository, then the `version` attribute _must_ be the date of that (fetched) commit. The date _must_ be in `"unstable-YYYY-MM-DD"` format.
224+
225+- Dashes in the package `pname` _should_ be preserved in new variable names, rather than converted to underscores or camel cased — e.g., `http-parser` instead of `http_parser` or `httpParser`. The hyphenated style is preferred in all three package names.
226+
227+- If there are multiple versions of a package, this _should_ be reflected in the variable names in `all-packages.nix`, e.g. `json-c_0_9` and `json-c_0_11`. If there is an obvious “default” version, make an attribute like `json-c = json-c_0_9;`. See also [](#sec-versioning)
228+
229+## File naming and organisation {#sec-organisation}
230+
231+Names of files and directories should be in lowercase, with dashes between words — not in camel case. For instance, it should be `all-packages.nix`, not `allPackages.nix` or `AllPackages.nix`.
232+
233+### Hierarchy {#sec-hierarchy}
234+
235+Each package should be stored in its own directory somewhere in the `pkgs/` tree, i.e. in `pkgs/category/subcategory/.../pkgname`. Below are some rules for picking the right category for a package. Many packages fall under several categories; what matters is the _primary_ purpose of a package. For example, the `libxml2` package builds both a library and some tools; but it’s a library foremost, so it goes under `pkgs/development/libraries`.
236+
237+When in doubt, consider refactoring the `pkgs/` tree, e.g. creating new categories or splitting up an existing category.
238+
239+**If it’s used to support _software development_:**
240+
241+- **If it’s a _library_ used by other packages:**
242+
243+ - `development/libraries` (e.g. `libxml2`)
244+
245+- **If it’s a _compiler_:**
246+
247+ - `development/compilers` (e.g. `gcc`)
248+
249+- **If it’s an _interpreter_:**
250+
251+ - `development/interpreters` (e.g. `guile`)
252+
253+- **If it’s a (set of) development _tool(s)_:**
254+
255+ - **If it’s a _parser generator_ (including lexers):**
256+
257+ - `development/tools/parsing` (e.g. `bison`, `flex`)
258+
259+ - **If it’s a _build manager_:**
260+
261+ - `development/tools/build-managers` (e.g. `gnumake`)
262+
263+ - **Else:**
264+
265+ - `development/tools/misc` (e.g. `binutils`)
266+
267+- **Else:**
268+
269+ - `development/misc`
270+
271+**If it’s a (set of) _tool(s)_:**
272+
273+(A tool is a relatively small program, especially one intended to be used non-interactively.)
274+
275+- **If it’s for _networking_:**
276+
277+ - `tools/networking` (e.g. `wget`)
278+
279+- **If it’s for _text processing_:**
280+
281+ - `tools/text` (e.g. `diffutils`)
282+
283+- **If it’s a _system utility_, i.e., something related or essential to the operation of a system:**
284+
285+ - `tools/system` (e.g. `cron`)
286+
287+- **If it’s an _archiver_ (which may include a compression function):**
288+
289+ - `tools/archivers` (e.g. `zip`, `tar`)
290+
291+- **If it’s a _compression_ program:**
292+
293+ - `tools/compression` (e.g. `gzip`, `bzip2`)
294+
295+- **If it’s a _security_-related program:**
296+
297+ - `tools/security` (e.g. `nmap`, `gnupg`)
298+
299+- **Else:**
300+
301+ - `tools/misc`
302+
303+**If it’s a _shell_:**
304+
305+- `shells` (e.g. `bash`)
306+
307+**If it’s a _server_:**
308+
309+- **If it’s a web server:**
310+
311+ - `servers/http` (e.g. `apache-httpd`)
312+
313+- **If it’s an implementation of the X Windowing System:**
314+
315+ - `servers/x11` (e.g. `xorg` — this includes the client libraries and programs)
316+
317+- **Else:**
318+
319+ - `servers/misc`
320+
321+**If it’s a _desktop environment_:**
322+
323+- `desktops` (e.g. `kde`, `gnome`, `enlightenment`)
324+
325+**If it’s a _window manager_:**
326+
327+- `applications/window-managers` (e.g. `awesome`, `stumpwm`)
328+
329+**If it’s an _application_:**
330+
331+A (typically large) program with a distinct user interface, primarily used interactively.
332+
333+- **If it’s a _version management system_:**
334+
335+ - `applications/version-management` (e.g. `subversion`)
336+
337+- **If it’s a _terminal emulator_:**
338+
339+ - `applications/terminal-emulators` (e.g. `alacritty` or `rxvt` or `termite`)
340+
341+- **If it’s for _video playback / editing_:**
342+
343+ - `applications/video` (e.g. `vlc`)
344+
345+- **If it’s for _graphics viewing / editing_:**
346+
347+ - `applications/graphics` (e.g. `gimp`)
348+
349+- **If it’s for _networking_:**
350+
351+ - **If it’s a _mailreader_:**
352+
353+ - `applications/networking/mailreaders` (e.g. `thunderbird`)
354+
355+ - **If it’s a _newsreader_:**
356+
357+ - `applications/networking/newsreaders` (e.g. `pan`)
358+
359+ - **If it’s a _web browser_:**
360+
361+ - `applications/networking/browsers` (e.g. `firefox`)
362+
363+ - **Else:**
364+
365+ - `applications/networking/misc`
366+
367+- **Else:**
368+
369+ - `applications/misc`
370+
371+**If it’s _data_ (i.e., does not have a straight-forward executable semantics):**
372+
373+- **If it’s a _font_:**
374+
375+ - `data/fonts`
376+
377+- **If it’s an _icon theme_:**
378+
379+ - `data/icons`
380+
381+- **If it’s related to _SGML/XML processing_:**
382+
383+ - **If it’s an _XML DTD_:**
384+
385+ - `data/sgml+xml/schemas/xml-dtd` (e.g. `docbook`)
386+
387+ - **If it’s an _XSLT stylesheet_:**
388+
389+ (Okay, these are executable...)
390+
391+ - `data/sgml+xml/stylesheets/xslt` (e.g. `docbook-xsl`)
392+
393+- **If it’s a _theme_ for a _desktop environment_, a _window manager_ or a _display manager_:**
394+
395+ - `data/themes`
396+
397+**If it’s a _game_:**
398+
399+- `games`
400+
401+**Else:**
402+
403+- `misc`
404+
405+### Versioning {#sec-versioning}
406+
407+Because every version of a package in Nixpkgs creates a potential maintenance burden, old versions of a package should not be kept unless there is a good reason to do so. For instance, Nixpkgs contains several versions of GCC because other packages don’t build with the latest version of GCC. Other examples are having both the latest stable and latest pre-release version of a package, or to keep several major releases of an application that differ significantly in functionality.
408+
409+If there is only one version of a package, its Nix expression should be named `e2fsprogs/default.nix`. If there are multiple versions, this should be reflected in the filename, e.g. `e2fsprogs/1.41.8.nix` and `e2fsprogs/1.41.9.nix`. The version in the filename should leave out unnecessary detail. For instance, if we keep the latest Firefox 2.0.x and 3.5.x versions in Nixpkgs, they should be named `firefox/2.0.nix` and `firefox/3.5.nix`, respectively (which, at a given point, might contain versions `2.0.0.20` and `3.5.4`). If a version requires many auxiliary files, you can use a subdirectory for each version, e.g. `firefox/2.0/default.nix` and `firefox/3.5/default.nix`.
410+
411+All versions of a package _must_ be included in `all-packages.nix` to make sure that they evaluate correctly.
412+
413+## Fetching Sources {#sec-sources}
414+
415+There are multiple ways to fetch a package source in nixpkgs. The general guideline is that you should package reproducible sources with a high degree of availability. Right now there is only one fetcher which has mirroring support and that is `fetchurl`. Note that you should also prefer protocols which have a corresponding proxy environment variable.
416+
417+You can find many source fetch helpers in `pkgs/build-support/fetch*`.
418+
419+In the file `pkgs/top-level/all-packages.nix` you can find fetch helpers, these have names on the form `fetchFrom*`. The intention of these are to provide snapshot fetches but using the same api as some of the version controlled fetchers from `pkgs/build-support/`. As an example going from bad to good:
420+
421+- Bad: Uses `git://` which won't be proxied.
422+
423+ ```nix
424+ src = fetchgit {
425+ url = "git://github.com/NixOS/nix.git";
426+ rev = "1f795f9f44607cc5bec70d1300150bfefcef2aae";
427+ sha256 = "1cw5fszffl5pkpa6s6wjnkiv6lm5k618s32sp60kvmvpy7a2v9kg";
428+ }
429+ ```
430+
431+- Better: This is ok, but an archive fetch will still be faster.
432+
433+ ```nix
434+ src = fetchgit {
435+ url = "https://github.com/NixOS/nix.git";
436+ rev = "1f795f9f44607cc5bec70d1300150bfefcef2aae";
437+ sha256 = "1cw5fszffl5pkpa6s6wjnkiv6lm5k618s32sp60kvmvpy7a2v9kg";
438+ }
439+ ```
440+
441+- Best: Fetches a snapshot archive and you get the rev you want.
442+
443+ ```nix
444+ src = fetchFromGitHub {
445+ owner = "NixOS";
446+ repo = "nix";
447+ rev = "1f795f9f44607cc5bec70d1300150bfefcef2aae";
448+ sha256 = "1i2yxndxb6yc9l6c99pypbd92lfq5aac4klq7y2v93c9qvx2cgpc";
449+ }
450+ ```
451+
452+ Find the value to put as `sha256` by running `nix run -f '<nixpkgs>' nix-prefetch-github -c nix-prefetch-github --rev 1f795f9f44607cc5bec70d1300150bfefcef2aae NixOS nix` or `nix-prefetch-url --unpack https://github.com/NixOS/nix/archive/1f795f9f44607cc5bec70d1300150bfefcef2aae.tar.gz`.
453+
454+## Obtaining source hash {#sec-source-hashes}
455+
456+Preferred source hash type is sha256. There are several ways to get it.
457+
458+1. Prefetch URL (with `nix-prefetch-XXX URL`, where `XXX` is one of `url`, `git`, `hg`, `cvs`, `bzr`, `svn`). Hash is printed to stdout.
459+
460+2. Prefetch by package source (with `nix-prefetch-url '<nixpkgs>' -A PACKAGE.src`, where `PACKAGE` is package attribute name). Hash is printed to stdout.
461+
462+ This works well when you've upgraded existing package version and want to find out new hash, but is useless if package can't be accessed by attribute or package has multiple sources (`.srcs`, architecture-dependent sources, etc).
463+
464+3. Upstream provided hash: use it when upstream provides `sha256` or `sha512` (when upstream provides `md5`, don't use it, compute `sha256` instead).
465+
466+ A little nuance is that `nix-prefetch-*` tools produce hash encoded with `base32`, but upstream usually provides hexadecimal (`base16`) encoding. Fetchers understand both formats. Nixpkgs does not standardize on any one format.
467+
468+ You can convert between formats with nix-hash, for example:
469+
470+ ```ShellSession
471+ $ nix-hash --type sha256 --to-base32 HASH
472+ ```
473+
474+4. Extracting hash from local source tarball can be done with `sha256sum`. Use `nix-prefetch-url file:///path/to/tarball` if you want base32 hash.
475+
476+5. Fake hash: set fake hash in package expression, perform build and extract correct hash from error Nix prints.
477+
478+ For package updates it is enough to change one symbol to make hash fake. For new packages, you can use `lib.fakeSha256`, `lib.fakeSha512` or any other fake hash.
479+
480+ This is last resort method when reconstructing source URL is non-trivial and `nix-prefetch-url -A` isn’t applicable (for example, [one of `kodi` dependencies](https://github.com/NixOS/nixpkgs/blob/d2ab091dd308b99e4912b805a5eb088dd536adb9/pkgs/applications/video/kodi/default.nix#L73)). The easiest way then would be replace hash with a fake one and rebuild. Nix build will fail and error message will contain desired hash.
481+
482+::: {.warning}
483+This method has security problems. Check below for details.
484+:::
485+
486+### Obtaining hashes securely {#sec-source-hashes-security}
487+
488+Let's say Man-in-the-Middle (MITM) sits close to your network. Then instead of fetching source you can fetch malware, and instead of source hash you get hash of malware. Here are security considerations for this scenario:
489+
490+- `http://` URLs are not secure to prefetch hash from;
491+
492+- hashes from upstream (in method 3) should be obtained via secure protocol;
493+
494+- `https://` URLs are secure in methods 1, 2, 3;
495+
496+- `https://` URLs are not secure in method 5. When obtaining hashes with fake hash method, TLS checks are disabled. So refetch source hash from several different networks to exclude MITM scenario. Alternatively, use fake hash method to make Nix error, but instead of extracting hash from error, extract `https://` URL and prefetch it with method 1.
497+
498+## Patches {#sec-patches}
499+
500+Patches available online should be retrieved using `fetchpatch`.
501+
502+```nix
503+patches = [
504+ (fetchpatch {
505+ name = "fix-check-for-using-shared-freetype-lib.patch";
506+ url = "http://git.ghostscript.com/?p=ghostpdl.git;a=patch;h=8f5d285";
507+ sha256 = "1f0k043rng7f0rfl9hhb89qzvvksqmkrikmm38p61yfx51l325xr";
508+ })
509+];
510+```
511+
512+Otherwise, you can add a `.patch` file to the `nixpkgs` repository. In the interest of keeping our maintenance burden to a minimum, only patches that are unique to `nixpkgs` should be added in this way.
513+
514+```nix
515+patches = [ ./0001-changes.patch ];
516+```
517+
518+If you do need to do create this sort of patch file, one way to do so is with git:
519+
520+1. Move to the root directory of the source code you're patching.
521+
522+ ```ShellSession
523+ $ cd the/program/source
524+ ```
525+
526+2. If a git repository is not already present, create one and stage all of the source files.
527+
528+ ```ShellSession
529+ $ git init
530+ $ git add .
531+ ```
532+
533+3. Edit some files to make whatever changes need to be included in the patch.
534+
535+4. Use git to create a diff, and pipe the output to a patch file:
536+
537+ ```ShellSession
538+ $ git diff -a > nixpkgs/pkgs/the/package/0001-changes.patch
539+ ```
540+
541+If a patch is available online but does not cleanly apply, it can be modified in some fixed ways by using additional optional arguments for `fetchpatch`:
542+
543+- `relative`: Similar to using `git-diff`'s `--relative` flag, only keep changes inside the specified directory, making paths relative to it.
544+- `stripLen`: Remove the first `stripLen` components of pathnames in the patch.
545+- `extraPrefix`: Prefix pathnames by this string.
546+- `excludes`: Exclude files matching these patterns (applies after the above arguments).
547+- `includes`: Include only files matching these patterns (applies after the above arguments).
548+- `revert`: Revert the patch.
549+
550+Note that because the checksum is computed after applying these effects, using or modifying these arguments will have no effect unless the `sha256` argument is changed as well.
551+
552+## Package tests {#sec-package-tests}
553+
554+Tests are important to ensure quality and make reviews and automatic updates easy.
555+
556+The following types of tests exists:
557+
558+* [NixOS **module tests**](https://nixos.org/manual/nixos/stable/#sec-nixos-tests), which spawn one or more NixOS VMs. They exercise both NixOS modules and the packaged programs used within them. For example, a NixOS module test can start a web server VM running the `nginx` module, and a client VM running `curl` or a graphical `firefox`, and test that they can talk to each other and display the correct content.
559+* Nix **package tests** are a lightweight alternative to NixOS module tests. They should be used to create simple integration tests for packages, but cannot test NixOS services, and some programs with graphical user interfaces may also be difficult to test with them.
560+* The **`checkPhase` of a package**, which should execute the unit tests that are included in the source code of a package.
561+
562+Here in the nixpkgs manual we describe mostly _package tests_; for _module tests_ head over to the corresponding [section in the NixOS manual](https://nixos.org/manual/nixos/stable/#sec-nixos-tests).
563+
564+### Writing inline package tests {#ssec-inline-package-tests-writing}
565+
566+For very simple tests, they can be written inline:
567+
568+```nix
569+{ …, yq-go }:
570+
571+buildGoModule rec {
572+ …
573+
574+ passthru.tests = {
575+ simple = runCommand "${pname}-test" {} ''
576+ echo "test: 1" | ${yq-go}/bin/yq eval -j > $out
577+ [ "$(cat $out | tr -d $'\n ')" = '{"test":1}' ]
578+ '';
579+ };
580+}
581+```
582+
583+### Writing larger package tests {#ssec-package-tests-writing}
584+
585+This is an example using the `phoronix-test-suite` package with the current best practices.
586+
587+Add the tests in `passthru.tests` to the package definition like this:
588+
589+```nix
590+{ stdenv, lib, fetchurl, callPackage }:
591+
592+stdenv.mkDerivation {
593+ …
594+
595+ passthru.tests = {
596+ simple-execution = callPackage ./tests.nix { };
597+ };
598+
599+ meta = { … };
600+}
601+```
602+
603+Create `tests.nix` in the package directory:
604+
605+```nix
606+{ runCommand, phoronix-test-suite }:
607+
608+let
609+ inherit (phoronix-test-suite) pname version;
610+in
611+
612+runCommand "${pname}-tests" { meta.timeout = 60; }
613+ ''
614+ # automatic initial setup to prevent interactive questions
615+ ${phoronix-test-suite}/bin/phoronix-test-suite enterprise-setup >/dev/null
616+ # get version of installed program and compare with package version
617+ if [[ `${phoronix-test-suite}/bin/phoronix-test-suite version` != *"${version}"* ]]; then
618+ echo "Error: program version does not match package version"
619+ exit 1
620+ fi
621+ # run dummy command
622+ ${phoronix-test-suite}/bin/phoronix-test-suite dummy_module.dummy-command >/dev/null
623+ # needed for Nix to register the command as successful
624+ touch $out
625+ ''
626+```
627+
628+### Running package tests {#ssec-package-tests-running}
629+
630+You can run these tests with:
631+
632+```ShellSession
633+$ cd path/to/nixpkgs
634+$ nix-build -A phoronix-test-suite.tests
635+```
636+
637+### Examples of package tests {#ssec-package-tests-examples}
638+
639+Here are examples of package tests:
640+
641+- [Jasmin compile test](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/compilers/jasmin/test-assemble-hello-world/default.nix)
642+- [Lobster compile test](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/compilers/lobster/test-can-run-hello-world.nix)
643+- [Spacy annotation test](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/python-modules/spacy/annotation-test/default.nix)
644+- [Libtorch test](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/libraries/science/math/libtorch/test/default.nix)
645+- [Multiple tests for nanopb](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/libraries/nanopb/default.nix)
646+
647+### Linking NixOS module tests to a package {#ssec-nixos-tests-linking}
648+
649+Like [package tests](#ssec-package-tests-writing) as shown above, [NixOS module tests](https://nixos.org/manual/nixos/stable/#sec-nixos-tests) can also be linked to a package, so that the tests can be easily run when changing the related package.
650+
651+For example, assuming we're packaging `nginx`, we can link its module test via `passthru.tests`:
652+
653+```nix
654+{ stdenv, lib, nixosTests }:
655+
656+stdenv.mkDerivation {
657+ ...
658+
659+ passthru.tests = {
660+ nginx = nixosTests.nginx;
661+ };
662+
663+ ...
664+}
665+```
doc/contributing/contributing-to-documentation.chapter.mdnew file+106
@@ -0,0 +1,106 @@
1+# Contributing to this documentation {#chap-contributing}
2+
3+The sources of the Nixpkgs manual are in the [doc](https://github.com/NixOS/nixpkgs/tree/master/doc) subdirectory of the Nixpkgs repository. The manual is still partially written in DocBook but it is progressively being converted to [Markdown](#sec-contributing-markup).
4+
5+You can quickly check your edits with `make`:
6+
7+```ShellSession
8+$ cd /path/to/nixpkgs/doc
9+$ nix-shell
10+[nix-shell]$ make
11+```
12+
13+If you experience problems, run `make debug` to help understand the docbook errors.
14+
15+After making modifications to the manual, it's important to build it before committing. You can do that as follows:
16+
17+```ShellSession
18+$ cd /path/to/nixpkgs/doc
19+$ nix-shell
20+[nix-shell]$ make clean
21+[nix-shell]$ nix-build .
22+```
23+
24+If the build succeeds, the manual will be in `./result/share/doc/nixpkgs/manual.html`.
25+
26+## Syntax {#sec-contributing-markup}
27+
28+As per [RFC 0072](https://github.com/NixOS/rfcs/pull/72), all new documentation content should be written in [CommonMark](https://commonmark.org/) Markdown dialect.
29+
30+Additionally, the following syntax extensions are currently used:
31+
32+- []{#ssec-contributing-markup-anchors}
33+ Explicitly defined **anchors** on headings, to allow linking to sections. These should be always used, to ensure the anchors can be linked even when the heading text changes, and to prevent conflicts between [automatically assigned identifiers](https://github.com/jgm/commonmark-hs/blob/master/commonmark-extensions/test/auto_identifiers.md).
34+
35+ It uses the widely compatible [header attributes](https://github.com/jgm/commonmark-hs/blob/master/commonmark-extensions/test/attributes.md) syntax:
36+
37+ ```markdown
38+ ## Syntax {#sec-contributing-markup}
39+ ```
40+
41+- []{#ssec-contributing-markup-anchors-inline}
42+ **Inline anchors**, which allow linking arbitrary place in the text (e.g. individual list items, sentences…).
43+
44+ They are defined using a hybrid of the link syntax with the attributes syntax known from headings, called [bracketed spans](https://github.com/jgm/commonmark-hs/blob/master/commonmark-extensions/test/bracketed_spans.md):
45+
46+ ```markdown
47+ - []{#ssec-gnome-hooks-glib} `glib` setup hook will populate `GSETTINGS_SCHEMAS_PATH` and then `wrapGAppsHook` will prepend it to `XDG_DATA_DIRS`.
48+ ```
49+
50+- []{#ssec-contributing-markup-automatic-links}
51+ If you **omit a link text** for a link pointing to a section, the text will be substituted automatically. For example, `[](#chap-contributing)` will result in [](#chap-contributing).
52+
53+ This syntax is taken from [MyST](https://myst-parser.readthedocs.io/en/latest/using/syntax.html#targets-and-cross-referencing).
54+
55+- []{#ssec-contributing-markup-inline-roles}
56+ If you want to link to a man page, you can use `` {manpage}`nix.conf(5)` ``, which will turn into {manpage}`nix.conf(5)`.
57+
58+ The references will turn into links when a mapping exists in {file}`doc/build-aux/pandoc-filters/link-unix-man-references.lua`.
59+
60+ This syntax is taken from [MyST](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#roles-an-in-line-extension-point). Though, the feature originates from [reStructuredText](https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-manpage) with slightly different syntax.
61+
62+- []{#ssec-contributing-markup-admonitions}
63+ **Admonitions**, set off from the text to bring attention to something.
64+
65+ It uses pandoc’s [fenced `div`s syntax](https://github.com/jgm/commonmark-hs/blob/master/commonmark-extensions/test/fenced_divs.md):
66+
67+ ```markdown
68+ ::: {.warning}
69+ This is a warning
70+ :::
71+ ```
72+
73+ which renders as
74+
75+ > ::: {.warning}
76+ > This is a warning.
77+ > :::
78+
79+ The following are supported:
80+
81+ - [`caution`](https://tdg.docbook.org/tdg/5.0/caution.html)
82+ - [`important`](https://tdg.docbook.org/tdg/5.0/important.html)
83+ - [`note`](https://tdg.docbook.org/tdg/5.0/note.html)
84+ - [`tip`](https://tdg.docbook.org/tdg/5.0/tip.html)
85+ - [`warning`](https://tdg.docbook.org/tdg/5.0/warning.html)
86+
87+- []{#ssec-contributing-markup-definition-lists}
88+ [**Definition lists**](https://github.com/jgm/commonmark-hs/blob/master/commonmark-extensions/test/definition_lists.md), for defining a group of terms:
89+
90+ ```markdown
91+ pear
92+ : green or yellow bulbous fruit
93+
94+ watermelon
95+ : green fruit with red flesh
96+ ```
97+
98+ which renders as
99+
100+ > pear
101+ > : green or yellow bulbous fruit
102+ >
103+ > watermelon
104+ > : green fruit with red flesh
105+
106+For contributing to the legacy parts, please see [DocBook: The Definitive Guide](https://tdg.docbook.org/) or the [DocBook rocks! primer](https://web.archive.org/web/20200816233747/https://docbook.rocks/).
doc/contributing/quick-start.chapter.mdnew file+77
@@ -0,0 +1,77 @@
1+# Quick Start to Adding a Package {#chap-quick-start}
2+
3+To add a package to Nixpkgs:
4+
5+1. Checkout the Nixpkgs source tree:
6+
7+ ```ShellSession
8+ $ git clone https://github.com/NixOS/nixpkgs
9+ $ cd nixpkgs
10+ ```
11+
12+2. Find a good place in the Nixpkgs tree to add the Nix expression for your package. For instance, a library package typically goes into `pkgs/development/libraries/pkgname`, while a web browser goes into `pkgs/applications/networking/browsers/pkgname`. See [](#sec-organisation) for some hints on the tree organisation. Create a directory for your package, e.g.
13+
14+ ```ShellSession
15+ $ mkdir pkgs/development/libraries/libfoo
16+ ```
17+
18+3. In the package directory, create a Nix expression — a piece of code that describes how to build the package. In this case, it should be a _function_ that is called with the package dependencies as arguments, and returns a build of the package in the Nix store. The expression should usually be called `default.nix`.
19+
20+ ```ShellSession
21+ $ emacs pkgs/development/libraries/libfoo/default.nix
22+ $ git add pkgs/development/libraries/libfoo/default.nix
23+ ```
24+
25+ You can have a look at the existing Nix expressions under `pkgs/` to see how it’s done. Here are some good ones:
26+
27+ - GNU Hello: [`pkgs/applications/misc/hello/default.nix`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/misc/hello/default.nix). Trivial package, which specifies some `meta` attributes which is good practice.
28+
29+ - GNU cpio: [`pkgs/tools/archivers/cpio/default.nix`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/archivers/cpio/default.nix). Also a simple package. The generic builder in `stdenv` does everything for you. It has no dependencies beyond `stdenv`.
30+
31+ - GNU Multiple Precision arithmetic library (GMP): [`pkgs/development/libraries/gmp/5.1.x.nix`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/libraries/gmp/5.1.x.nix). Also done by the generic builder, but has a dependency on `m4`.
32+
33+ - Pan, a GTK-based newsreader: [`pkgs/applications/networking/newsreaders/pan/default.nix`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/networking/newsreaders/pan/default.nix). Has an optional dependency on `gtkspell`, which is only built if `spellCheck` is `true`.
34+
35+ - Apache HTTPD: [`pkgs/servers/http/apache-httpd/2.4.nix`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/servers/http/apache-httpd/2.4.nix). A bunch of optional features, variable substitutions in the configure flags, a post-install hook, and miscellaneous hackery.
36+
37+ - Thunderbird: [`pkgs/applications/networking/mailreaders/thunderbird/default.nix`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/networking/mailreaders/thunderbird/default.nix). Lots of dependencies.
38+
39+ - JDiskReport, a Java utility: [`pkgs/tools/misc/jdiskreport/default.nix`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/jdiskreport/default.nix). Nixpkgs doesn’t have a decent `stdenv` for Java yet so this is pretty ad-hoc.
40+
41+ - XML::Simple, a Perl module: [`pkgs/top-level/perl-packages.nix`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/top-level/perl-packages.nix) (search for the `XMLSimple` attribute). Most Perl modules are so simple to build that they are defined directly in `perl-packages.nix`; no need to make a separate file for them.
42+
43+ - Adobe Reader: [`pkgs/applications/misc/adobe-reader/default.nix`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/misc/adobe-reader/default.nix). Shows how binary-only packages can be supported. In particular the [builder](https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/misc/adobe-reader/builder.sh) uses `patchelf` to set the RUNPATH and ELF interpreter of the executables so that the right libraries are found at runtime.
44+
45+ Some notes:
46+
47+ - All [`meta`](#chap-meta) attributes are optional, but it’s still a good idea to provide at least the `description`, `homepage` and [`license`](#sec-meta-license).
48+
49+ - You can use `nix-prefetch-url url` to get the SHA-256 hash of source distributions. There are similar commands as `nix-prefetch-git` and `nix-prefetch-hg` available in `nix-prefetch-scripts` package.
50+
51+ - A list of schemes for `mirror://` URLs can be found in [`pkgs/build-support/fetchurl/mirrors.nix`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/build-support/fetchurl/mirrors.nix).
52+
53+ The exact syntax and semantics of the Nix expression language, including the built-in function, are described in the Nix manual in the [chapter on writing Nix expressions](https://hydra.nixos.org/job/nix/trunk/tarball/latest/download-by-type/doc/manual/#chap-writing-nix-expressions).
54+
55+4. Add a call to the function defined in the previous step to [`pkgs/top-level/all-packages.nix`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/top-level/all-packages.nix) with some descriptive name for the variable, e.g. `libfoo`.
56+
57+ ```ShellSession
58+ $ emacs pkgs/top-level/all-packages.nix
59+ ```
60+
61+ The attributes in that file are sorted by category (like “Development / Libraries”) that more-or-less correspond to the directory structure of Nixpkgs, and then by attribute name.
62+
63+5. To test whether the package builds, run the following command from the root of the nixpkgs source tree:
64+
65+ ```ShellSession
66+ $ nix-build -A libfoo
67+ ```
68+
69+ where `libfoo` should be the variable name defined in the previous step. You may want to add the flag `-K` to keep the temporary build directory in case something fails. If the build succeeds, a symlink `./result` to the package in the Nix store is created.
70+
71+6. If you want to install the package into your profile (optional), do
72+
73+ ```ShellSession
74+ $ nix-env -f . -iA libfoo
75+ ```
76+
77+7. Optionally commit the new package and open a pull request [to nixpkgs](https://github.com/NixOS/nixpkgs/pulls), or use [the Patches category](https://discourse.nixos.org/t/about-the-patches-category/477) on Discourse for sending a patch without a GitHub account.
doc/contributing/reviewing-contributions.chapter.mdnew file+208
@@ -0,0 +1,208 @@
1+# Reviewing contributions {#chap-reviewing-contributions}
2+
3+::: {.warning}
4+The following section is a draft, and the policy for reviewing is still being discussed in issues such as [#11166](https://github.com/NixOS/nixpkgs/issues/11166) and [#20836](https://github.com/NixOS/nixpkgs/issues/20836).
5+:::
6+
7+The Nixpkgs project receives a fairly high number of contributions via GitHub pull requests. Reviewing and approving these is an important task and a way to contribute to the project.
8+
9+The high change rate of Nixpkgs makes any pull request that remains open for too long subject to conflicts that will require extra work from the submitter or the merger. Reviewing pull requests in a timely manner and being responsive to the comments is the key to avoid this issue. GitHub provides sort filters that can be used to see the [most recently](https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc) and the [least recently](https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-asc) updated pull requests. We highly encourage looking at [this list of ready to merge, unreviewed pull requests](https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+review%3Anone+status%3Asuccess+-label%3A%222.status%3A+work-in-progress%22+no%3Aproject+no%3Aassignee+no%3Amilestone).
10+
11+When reviewing a pull request, please always be nice and polite. Controversial changes can lead to controversial opinions, but it is important to respect every community member and their work.
12+
13+GitHub provides reactions as a simple and quick way to provide feedback to pull requests or any comments. The thumb-down reaction should be used with care and if possible accompanied with some explanation so the submitter has directions to improve their contribution.
14+
15+pull request reviews should include a list of what has been reviewed in a comment, so other reviewers and mergers can know the state of the review.
16+
17+All the review template samples provided in this section are generic and meant as examples. Their usage is optional and the reviewer is free to adapt them to their liking.
18+
19+## Package updates {#reviewing-contributions-package-updates}
20+
21+A package update is the most trivial and common type of pull request. These pull requests mainly consist of updating the version part of the package name and the source hash.
22+
23+It can happen that non-trivial updates include patches or more complex changes.
24+
25+Reviewing process:
26+
27+- Ensure that the package versioning fits the guidelines.
28+- Ensure that the commit text fits the guidelines.
29+- Ensure that the package maintainers are notified.
30+ - [CODEOWNERS](https://help.github.com/articles/about-codeowners) will make GitHub notify users based on the submitted changes, but it can happen that it misses some of the package maintainers.
31+- Ensure that the meta field information is correct.
32+ - License can change with version updates, so it should be checked to match the upstream license.
33+ - If the package has no maintainer, a maintainer must be set. This can be the update submitter or a community member that accepts to take maintainership of the package.
34+- Ensure that the code contains no typos.
35+- Building the package locally.
36+ - pull requests are often targeted to the master or staging branch, and building the pull request locally when it is submitted can trigger many source builds.
37+ - It is possible to rebase the changes on nixos-unstable or nixpkgs-unstable for easier review by running the following commands from a nixpkgs clone.
38+
39+ ```ShellSession
40+ $ git fetch origin nixos-unstable
41+ $ git fetch origin pull/PRNUMBER/head
42+ $ git rebase --onto nixos-unstable BASEBRANCH FETCH_HEAD
43+ ```
44+
45+ - The first command fetches the nixos-unstable branch.
46+ - The second command fetches the pull request changes, `PRNUMBER` is the number at the end of the pull request title and `BASEBRANCH` the base branch of the pull request.
47+ - The third command rebases the pull request changes to the nixos-unstable branch.
48+ - The [nixpkgs-review](https://github.com/Mic92/nixpkgs-review) tool can be used to review a pull request content in a single command. `PRNUMBER` should be replaced by the number at the end of the pull request title. You can also provide the full github pull request url.
49+
50+ ```ShellSession
51+ $ nix-shell -p nixpkgs-review --run "nixpkgs-review pr PRNUMBER"
52+ ```
53+- Running every binary.
54+
55+Sample template for a package update review is provided below.
56+
57+```markdown
58+##### Reviewed points
59+
60+- [ ] package name fits guidelines
61+- [ ] package version fits guidelines
62+- [ ] package build on ARCHITECTURE
63+- [ ] executables tested on ARCHITECTURE
64+- [ ] all depending packages build
65+
66+##### Possible improvements
67+
68+##### Comments
69+```
70+
71+## New packages {#reviewing-contributions-new-packages}
72+
73+New packages are a common type of pull requests. These pull requests consists in adding a new nix-expression for a package.
74+
75+Review process:
76+
77+- Ensure that the package versioning fits the guidelines.
78+- Ensure that the commit name fits the guidelines.
79+- Ensure that the meta fields contain correct information.
80+ - License must match the upstream license.
81+ - Platforms should be set (or the package will not get binary substitutes).
82+ - Maintainers must be set. This can be the package submitter or a community member that accepts taking up maintainership of the package.
83+- Report detected typos.
84+- Ensure the package source:
85+ - Uses mirror URLs when available.
86+ - Uses the most appropriate functions (e.g. packages from GitHub should use `fetchFromGitHub`).
87+- Building the package locally.
88+- Running every binary.
89+
90+Sample template for a new package review is provided below.
91+
92+```markdown
93+##### Reviewed points
94+
95+- [ ] package path fits guidelines
96+- [ ] package name fits guidelines
97+- [ ] package version fits guidelines
98+- [ ] package build on ARCHITECTURE
99+- [ ] executables tested on ARCHITECTURE
100+- [ ] `meta.description` is set and fits guidelines
101+- [ ] `meta.license` fits upstream license
102+- [ ] `meta.platforms` is set
103+- [ ] `meta.maintainers` is set
104+- [ ] build time only dependencies are declared in `nativeBuildInputs`
105+- [ ] source is fetched using the appropriate function
106+- [ ] the list of `phases` is not overridden
107+- [ ] when a phase (like `installPhase`) is overridden it starts with `runHook preInstall` and ends with `runHook postInstall`.
108+- [ ] patches that are remotely available are fetched with `fetchpatch`
109+
110+##### Possible improvements
111+
112+##### Comments
113+```
114+
115+## Module updates {#reviewing-contributions-module-updates}
116+
117+Module updates are submissions changing modules in some ways. These often contains changes to the options or introduce new options.
118+
119+Reviewing process:
120+
121+- Ensure that the module maintainers are notified.
122+ - [CODEOWNERS](https://help.github.com/articles/about-codeowners/) will make GitHub notify users based on the submitted changes, but it can happen that it misses some of the package maintainers.
123+- Ensure that the module tests, if any, are succeeding.
124+- Ensure that the introduced options are correct.
125+ - Type should be appropriate (string related types differs in their merging capabilities, `loaOf` and `string` types are deprecated).
126+ - Description, default and example should be provided.
127+- Ensure that option changes are backward compatible.
128+ - `mkRenamedOptionModuleWith` provides a way to make option changes backward compatible.
129+- Ensure that removed options are declared with `mkRemovedOptionModule`
130+- Ensure that changes that are not backward compatible are mentioned in release notes.
131+- Ensure that documentations affected by the change is updated.
132+
133+Sample template for a module update review is provided below.
134+
135+```markdown
136+##### Reviewed points
137+
138+- [ ] changes are backward compatible
139+- [ ] removed options are declared with `mkRemovedOptionModule`
140+- [ ] changes that are not backward compatible are documented in release notes
141+- [ ] module tests succeed on ARCHITECTURE
142+- [ ] options types are appropriate
143+- [ ] options description is set
144+- [ ] options example is provided
145+- [ ] documentation affected by the changes is updated
146+
147+##### Possible improvements
148+
149+##### Comments
150+```
151+
152+## New modules {#reviewing-contributions-new-modules}
153+
154+New modules submissions introduce a new module to NixOS.
155+
156+Reviewing process:
157+
158+- Ensure that the module tests, if any, are succeeding.
159+- Ensure that the introduced options are correct.
160+ - Type should be appropriate (string related types differs in their merging capabilities, `loaOf` and `string` types are deprecated).
161+ - Description, default and example should be provided.
162+- Ensure that module `meta` field is present
163+ - Maintainers should be declared in `meta.maintainers`.
164+ - Module documentation should be declared with `meta.doc`.
165+- Ensure that the module respect other modules functionality.
166+ - For example, enabling a module should not open firewall ports by default.
167+
168+Sample template for a new module review is provided below.
169+
170+```markdown
171+##### Reviewed points
172+
173+- [ ] module path fits the guidelines
174+- [ ] module tests succeed on ARCHITECTURE
175+- [ ] options have appropriate types
176+- [ ] options have default
177+- [ ] options have example
178+- [ ] options have descriptions
179+- [ ] No unneeded package is added to environment.systemPackages
180+- [ ] meta.maintainers is set
181+- [ ] module documentation is declared in meta.doc
182+
183+##### Possible improvements
184+
185+##### Comments
186+```
187+
188+## Other submissions {#reviewing-contributions-other-submissions}
189+
190+Other type of submissions requires different reviewing steps.
191+
192+If you consider having enough knowledge and experience in a topic and would like to be a long-term reviewer for related submissions, please contact the current reviewers for that topic. They will give you information about the reviewing process. The main reviewers for a topic can be hard to find as there is no list, but checking past pull requests to see who reviewed or git-blaming the code to see who committed to that topic can give some hints.
193+
194+Container system, boot system and library changes are some examples of the pull requests fitting this category.
195+
196+## Merging pull requests {#reviewing-contributions--merging-pull-requests}
197+
198+It is possible for community members that have enough knowledge and experience on a special topic to contribute by merging pull requests.
199+
200+<!--
201+The following paragraphs about how to deal with unactive contributors is just a proposition and should be modified to what the community agrees to be the right policy.
202+
203+Please note that contributors with commit rights unactive for more than three months will have their commit rights revoked.
204+-->
205+
206+Please see the discussion in [GitHub nixpkgs issue #50105](https://github.com/NixOS/nixpkgs/issues/50105) for information on how to proceed to be granted this level of access.
207+
208+In a case a contributor definitively leaves the Nix community, they should create an issue or post on [Discourse](https://discourse.nixos.org) with references of packages and modules they maintain so the maintainership can be taken over by other contributors.
doc/contributing/submitting-changes.chapter.mdnew file+292
@@ -0,0 +1,292 @@
1+# Submitting changes {#chap-submitting-changes}
2+
3+## Making patches {#submitting-changes-making-patches}
4+
5+- Read [Manual (How to write packages for Nix)](https://nixos.org/nixpkgs/manual/).
6+
7+- Fork [the Nixpkgs repository](https://github.com/nixos/nixpkgs/) on GitHub.
8+
9+- Create a branch for your future fix.
10+
11+ - You can make branch from a commit of your local `nixos-version`. That will help you to avoid additional local compilations. Because you will receive packages from binary cache. For example
12+
13+ ```ShellSession
14+ $ nixos-version --hash
15+ 0998212
16+ $ git checkout 0998212
17+ $ git checkout -b 'fix/pkg-name-update'
18+ ```
19+
20+ - Please avoid working directly on the `master` branch.
21+
22+- Make commits of logical units.
23+
24+- If you removed pkgs or made some major NixOS changes, write about it in the release notes for the next stable release. For example `nixos/doc/manual/release-notes/rl-2003.xml`.
25+
26+- Check for unnecessary whitespace with `git diff --check` before committing.
27+
28+- Format the commit in a following way:
29+
30+ ```
31+ (pkg-name | nixos/<module>): (from -> to | init at version | refactor | etc)
32+ Additional information.
33+ ```
34+
35+ - Examples:
36+ - `nginx: init at 2.0.1`
37+ - `firefox: 54.0.1 -> 55.0`
38+ - `nixos/hydra: add bazBaz option`
39+ - `nixos/nginx: refactor config generation`
40+
41+- Test your changes. If you work with
42+
43+ - nixpkgs:
44+
45+ - update pkg
46+ - `nix-env -iA pkg-attribute-name -f <path to your local nixpkgs folder>`
47+ - add pkg
48+ - Make sure it’s in `pkgs/top-level/all-packages.nix`
49+ - `nix-env -iA pkg-attribute-name -f <path to your local nixpkgs folder>`
50+ - _If you don’t want to install pkg in you profile_.
51+ - `nix-build -A pkg-attribute-name <path to your local nixpkgs folder>` and check results in the folder `result`. It will appear in the same directory where you did `nix-build`.
52+ - If you installed your package with `nix-env`, you can run `nix-env -e pkg-name` where `pkg-name` is as reported by `nix-env -q` to uninstall it from your system.
53+
54+ - NixOS and its modules:
55+ - You can add new module to your NixOS configuration file (usually it’s `/etc/nixos/configuration.nix`). And do `sudo nixos-rebuild test -I nixpkgs=<path to your local nixpkgs folder> --fast`.
56+
57+- If you have commits `pkg-name: oh, forgot to insert whitespace`: squash commits in this case. Use `git rebase -i`.
58+
59+- [Rebase](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) your branch against current `master`.
60+
61+## Submitting changes {#submitting-changes-submitting-changes}
62+
63+- Push your changes to your fork of nixpkgs.
64+- Create the pull request
65+- Follow [the contribution guidelines](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md#submitting-changes).
66+
67+## Submitting security fixes {#submitting-changes-submitting-security-fixes}
68+
69+Security fixes are submitted in the same way as other changes and thus the same guidelines apply.
70+
71+- If a new version fixing the vulnerability has been released, update the package;
72+- If the security fix comes in the form of a patch and a CVE is available, then add the patch to the Nixpkgs tree, and apply it to the package.
73+ The name of the patch should be the CVE identifier, so e.g. `CVE-2019-13636.patch`; If a patch is fetched the name needs to be set as well, e.g.:
74+
75+ ```nix
76+ (fetchpatch {
77+ name = "CVE-2019-11068.patch";
78+ url = "https://gitlab.gnome.org/GNOME/libxslt/commit/e03553605b45c88f0b4b2980adfbbb8f6fca2fd6.patch";
79+ sha256 = "0pkpb4837km15zgg6h57bncp66d5lwrlvkr73h0lanywq7zrwhj8";
80+ })
81+ ```
82+
83+If a security fix applies to both master and a stable release then, similar to regular changes, they are preferably delivered via master first and cherry-picked to the release branch.
84+
85+Critical security fixes may by-pass the staging branches and be delivered directly to release branches such as `master` and `release-*`.
86+
87+## Deprecating/removing packages {#submitting-changes-deprecating-packages}
88+
89+There is currently no policy when to remove a package.
90+
91+Before removing a package, one should try to find a new maintainer or fix smaller issues first.
92+
93+### Steps to remove a package from Nixpkgs {#steps-to-remove-a-package-from-nixpkgs}
94+
95+We use jbidwatcher as an example for a discontinued project here.
96+
97+1. Have Nixpkgs checked out locally and up to date.
98+1. Create a new branch for your change, e.g. `git checkout -b jbidwatcher`
99+1. Remove the actual package including its directory, e.g. `git rm -rf pkgs/applications/misc/jbidwatcher`
100+1. Remove the package from the list of all packages (`pkgs/top-level/all-packages.nix`).
101+1. Add an alias for the package name in `pkgs/top-level/aliases.nix` (There is also `pkgs/applications/editors/vim/plugins/aliases.nix`. Package sets typically do not have aliases, so we can't add them there.)
102+
103+ For example in this case:
104+
105+ ```
106+ jbidwatcher = throw "jbidwatcher was discontinued in march 2021"; # added 2021-03-15
107+ ```
108+
109+ The throw message should explain in short why the package was removed for users that still have it installed.
110+
111+1. Test if the changes introduced any issues by running `nix-env -qaP -f . --show-trace`. It should show the list of packages without errors.
112+1. Commit the changes. Explain again why the package was removed. If it was declared discontinued upstream, add a link to the source.
113+
114+ ```ShellSession
115+ $ git add pkgs/applications/misc/jbidwatcher/default.nix pkgs/top-level/all-packages.nix pkgs/top-level/aliases.nix
116+ $ git commit
117+ ```
118+
119+ Example commit message:
120+
121+ ```
122+ jbidwatcher: remove
123+
124+ project was discontinued in march 2021. the program does not work anymore because ebay changed the login.
125+
126+ https://web.archive.org/web/20210315205723/http://www.jbidwatcher.com/
127+ ```
128+
129+1. Push changes to your GitHub fork with `git push`
130+1. Create a pull request against Nixpkgs. Mention the package maintainer.
131+
132+This is how the pull request looks like in this case: [https://github.com/NixOS/nixpkgs/pull/116470](https://github.com/NixOS/nixpkgs/pull/116470)
133+
134+## Pull Request Template {#submitting-changes-pull-request-template}
135+
136+The pull request template helps determine what steps have been made for a contribution so far, and will help guide maintainers on the status of a change. The motivation section of the PR should include any extra details the title does not address and link any existing issues related to the pull request.
137+
138+When a PR is created, it will be pre-populated with some checkboxes detailed below:
139+
140+### Tested using sandboxing {#submitting-changes-tested-with-sandbox}
141+
142+When sandbox builds are enabled, Nix will setup an isolated environment for each build process. It is used to remove further hidden dependencies set by the build environment to improve reproducibility. This includes access to the network during the build outside of `fetch*` functions and files outside the Nix store. Depending on the operating system access to other resources are blocked as well (ex. inter process communication is isolated on Linux); see [sandbox](https://nixos.org/nix/manual/#conf-sandbox) in Nix manual for details.
143+
144+Sandboxing is not enabled by default in Nix due to a small performance hit on each build. In pull requests for [nixpkgs](https://github.com/NixOS/nixpkgs/) people are asked to test builds with sandboxing enabled (see `Tested using sandboxing` in the pull request template) because in<https://nixos.org/hydra/> sandboxing is also used.
145+
146+Depending if you use NixOS or other platforms you can use one of the following methods to enable sandboxing **before** building the package:
147+
148+- **Globally enable sandboxing on NixOS**: add the following to `configuration.nix`
149+
150+ ```nix
151+ nix.useSandbox = true;
152+ ```
153+
154+- **Globally enable sandboxing on non-NixOS platforms**: add the following to: `/etc/nix/nix.conf`
155+
156+ ```ini
157+ sandbox = true
158+ ```
159+
160+### Built on platform(s) {#submitting-changes-platform-diversity}
161+
162+Many Nix packages are designed to run on multiple platforms. As such, it’s important to let the maintainer know which platforms your changes have been tested on. It’s not always practical to test a change on all platforms, and is not required for a pull request to be merged. Only check the systems you tested the build on in this section.
163+
164+### Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests) {#submitting-changes-nixos-tests}
165+
166+Packages with automated tests are much more likely to be merged in a timely fashion because it doesn’t require as much manual testing by the maintainer to verify the functionality of the package. If there are existing tests for the package, they should be run to verify your changes do not break the tests. Tests can only be run on Linux. For more details on writing and running tests, see the [section in the NixOS manual](https://nixos.org/nixos/manual/index.html#sec-nixos-tests).
167+
168+### Tested compilation of all pkgs that depend on this change using `nixpkgs-review` {#submitting-changes-tested-compilation}
169+
170+If you are updating a package’s version, you can use nixpkgs-review to make sure all packages that depend on the updated package still compile correctly. The `nixpkgs-review` utility can look for and build all dependencies either based on uncommited changes with the `wip` option or specifying a github pull request number.
171+
172+review changes from pull request number 12345:
173+
174+```ShellSession
175+nix run nixpkgs.nixpkgs-review -c nixpkgs-review pr 12345
176+```
177+
178+review uncommitted changes:
179+
180+```ShellSession
181+nix run nixpkgs.nixpkgs-review -c nixpkgs-review wip
182+```
183+
184+review changes from last commit:
185+
186+```ShellSession
187+nix run nixpkgs.nixpkgs-review -c nixpkgs-review rev HEAD
188+```
189+
190+### Tested execution of all binary files (usually in `./result/bin/`) {#submitting-changes-tested-execution}
191+
192+It’s important to test any executables generated by a build when you change or create a package in nixpkgs. This can be done by looking in `./result/bin` and running any files in there, or at a minimum, the main executable for the package. For example, if you make a change to texlive, you probably would only check the binaries associated with the change you made rather than testing all of them.
193+
194+### Meets Nixpkgs contribution standards {#submitting-changes-contribution-standards}
195+
196+The last checkbox is fits [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md). The contributing document has detailed information on standards the Nix community has for commit messages, reviews, licensing of contributions you make to the project, etc\... Everyone should read and understand the standards the community has for contributing before submitting a pull request.
197+
198+## Hotfixing pull requests {#submitting-changes-hotfixing-pull-requests}
199+
200+- Make the appropriate changes in you branch.
201+- Don’t create additional commits, do
202+ - `git rebase -i`
203+ - `git push --force` to your branch.
204+
205+## Commit policy {#submitting-changes-commit-policy}
206+
207+- Commits must be sufficiently tested before being merged, both for the master and staging branches.
208+- Hydra builds for master and staging should not be used as testing platform, it’s a build farm for changes that have been already tested.
209+- When changing the bootloader installation process, extra care must be taken. Grub installations cannot be rolled back, hence changes may break people’s installations forever. For any non-trivial change to the bootloader please file a PR asking for review, especially from \@edolstra.
210+
211+```{.graphviz caption="Staging workflow"}
212+digraph {
213+ "small changes" [shape=none]
214+ "mass-rebuilds and other large changes" [shape=none]
215+ "critical security fixes" [shape=none]
216+ "broken staging-next fixes" [shape=none]
217+
218+ "small changes" -> master
219+ "mass-rebuilds and other large changes" -> staging
220+ "critical security fixes" -> master
221+ "broken staging-next fixes" -> "staging-next"
222+
223+ "staging-next" -> master [color="#E85EB0"] [label="stabilization ends"] [fontcolor="#E85EB0"]
224+ "staging" -> "staging-next" [color="#E85EB0"] [label="stabilization starts"] [fontcolor="#E85EB0"]
225+
226+ master -> "staging-next" -> staging [color="#5F5EE8"] [label="every six hours (GitHub Action)"] [fontcolor="#5F5EE8"]
227+}
228+```
229+
230+[This GitHub Action](https://github.com/NixOS/nixpkgs/blob/master/.github/workflows/periodic-merge-6h.yml) brings changes from `master` to `staging-next` and from `staging-next` to `staging` every 6 hours.
231+
232+
233+### Master branch {#submitting-changes-master-branch}
234+
235+The `master` branch is the main development branch. It should only see non-breaking commits that do not cause mass rebuilds.
236+
237+### Staging branch {#submitting-changes-staging-branch}
238+
239+The `staging` branch is a development branch where mass-rebuilds go. It should only see non-breaking mass-rebuild commits. That means it is not to be used for testing, and changes must have been well tested already. If the branch is already in a broken state, please refrain from adding extra new breakages.
240+
241+### Staging-next branch {#submitting-changes-staging-next-branch}
242+
243+The `staging-next` branch is for stabilizing mass-rebuilds submitted to the `staging` branch prior to merging them into `master`. Mass-rebuilds must go via the `staging` branch. It must only see non-breaking commits that are fixing issues blocking it from being merged into the `master ` branch.
244+
245+If the branch is already in a broken state, please refrain from adding extra new breakages. Stabilize it for a few days and then merge into master.
246+
247+### Stable release branches {#submitting-changes-stable-release-branches}
248+
249+The same staging workflow applies to stable release branches, but the main branch is called `release-*` instead of `master`.
250+
251+Example branch names: `release-21.11`, `staging-21.11`, `staging-next-21.11`.
252+
253+Most changes added to the stable release branches are cherry-picked (“backported”) from the `master` and staging branches.
254+
255+#### Automatically backporting a Pull Request {#submitting-changes-stable-release-branches-automatic-backports}
256+
257+Assign label `backport <branch>` (e.g. `backport release-21.11`) to the PR and a backport PR is automatically created after the PR is merged.
258+
259+#### Manually backporting changes {#submitting-changes-stable-release-branches-manual-backports}
260+
261+Cherry-pick changes via `git cherry-pick -x <original commit>` so that the original commit id is included in the commit message.
262+
263+Add a reason for the backport when it is not obvious from the original commit message. You can do this by cherry picking with `git cherry-pick -xe <original commit>`, which allows editing the commit message. This is not needed for minor version updates that include security and bug fixes but don't add new features or when the commit fixes an otherwise broken package.
264+
265+Here is an example of a cherry-picked commit message with good reason description:
266+
267+```
268+zfs: Keep trying root import until it works
269+
270+Works around #11003.
271+
272+(cherry picked from commit 98b213a11041af39b39473906b595290e2a4e2f9)
273+
274+Reason: several people cannot boot with ZFS on NVMe
275+```
276+
277+Other examples of reasons are:
278+
279+- Previously the build would fail due to, e.g., `getaddrinfo` not being defined
280+- The previous download links were all broken
281+- Crash when starting on some X11 systems
282+
283+#### Acceptable backport criteria
284+
285+The stable branch does have some changes which cannot be backported. Most notable are breaking changes. The desire is to have stable users be uninterrupted when updating packages.
286+
287+However, many changes are able to be backported, including:
288+- New Packages / Modules
289+- Security / Patch updates
290+- Version updates which include new functionality (but no breaking changes)
291+- Services which require a client to be up-to-date regardless. (E.g. `spotify`, `steam`, or `discord`)
292+- Security critical applications (E.g. `firefox`)
doc/contributing/vulnerability-roundup.chapter.mdnew file+45
@@ -0,0 +1,45 @@
1+# Vulnerability Roundup {#chap-vulnerability-roundup}
2+
3+## Issues {#vulnerability-roundup-issues}
4+
5+Vulnerable packages in Nixpkgs are managed using issues.
6+Currently opened ones can be found using the following:
7+
8+[github.com/NixOS/nixpkgs/issues?q=is:issue+is:open+"Vulnerability+roundup"](https://github.com/NixOS/nixpkgs/issues?q=is%3Aissue+is%3Aopen+%22Vulnerability+roundup%22)
9+
10+Each issue correspond to a vulnerable version of a package; As a consequence:
11+
12+- One issue can contain several CVEs;
13+- One CVE can be shared across several issues;
14+- A single package can be concerned by several issues.
15+
16+
17+A "Vulnerability roundup" issue usually respects the following format:
18+
19+```txt
20+<link to relevant package search on search.nix.gsc.io>, <link to relevant files in Nixpkgs on GitHub>
21+
22+<list of related CVEs, their CVSS score, and the impacted NixOS version>
23+
24+<list of the scanned Nixpkgs versions>
25+
26+<list of relevant contributors>
27+```
28+
29+Note that there can be an extra comment containing links to previously reported (and still open) issues for the same package.
30+
31+
32+## Triaging and Fixing {#vulnerability-roundup-triaging-and-fixing}
33+
34+**Note**: An issue can be a "false positive" (i.e. automatically opened, but without the package it refers to being actually vulnerable).
35+If you find such a "false positive", comment on the issue an explanation of why it falls into this category, linking as much information as the necessary to help maintainers double check.
36+
37+If you are investigating a "true positive":
38+
39+- Find the earliest patched version or a code patch in the CVE details;
40+- Is the issue already patched (version up-to-date or patch applied manually) in Nixpkgs's `master` branch?
41+ - **No**:
42+ - [Submit a security fix](#submitting-changes-submitting-security-fixes);
43+ - Once the fix is merged into `master`, [submit the change to the vulnerable release branch(es)](https://nixos.org/manual/nixpkgs/stable/#submitting-changes-stable-release-branches);
44+ - **Yes**: [Backport the change to the vulnerable release branch(es)](https://nixos.org/manual/nixpkgs/stable/#submitting-changes-stable-release-branches).
45+- When the patch has made it into all the relevant branches (`master`, and the vulnerable releases), close the relevant issue(s).
doc/default.nixnew file+39
@@ -0,0 +1,39 @@
1+{ pkgs ? (import ./.. { }), nixpkgs ? { }}:
2+let
3+ lib = pkgs.lib;
4+ doc-support = import ./doc-support { inherit pkgs nixpkgs; };
5+in pkgs.stdenv.mkDerivation {
6+ name = "nixpkgs-manual";
7+
8+ nativeBuildInputs = with pkgs; [
9+ pandoc
10+ graphviz
11+ libxml2
12+ libxslt
13+ zip
14+ jing
15+ xmlformat
16+ ];
17+
18+ src = lib.cleanSource ./.;
19+
20+ postPatch = ''
21+ ln -s ${doc-support} ./doc-support/result
22+ '';
23+
24+ installPhase = ''
25+ dest="$out/share/doc/nixpkgs"
26+ mkdir -p "$(dirname "$dest")"
27+ mv out/html "$dest"
28+ mv "$dest/index.html" "$dest/manual.html"
29+
30+ mv out/epub/manual.epub "$dest/nixpkgs-manual.epub"
31+
32+ mkdir -p $out/nix-support/
33+ echo "doc manual $dest manual.html" >> $out/nix-support/hydra-build-products
34+ echo "doc manual $dest nixpkgs-manual.epub" >> $out/nix-support/hydra-build-products
35+ '';
36+
37+ # Environment variables
38+ PANDOC_LUA_FILTERS_DIR = "${pkgs.pandoc-lua-filters}/share/pandoc/filters";
39+}
doc/doc-support/default.nixnew file+45
@@ -0,0 +1,45 @@
1+{ pkgs ? (import ../.. {}), nixpkgs ? { }}:
2+let
3+ locationsXml = import ./lib-function-locations.nix { inherit pkgs nixpkgs; };
4+ functionDocs = import ./lib-function-docs.nix { inherit locationsXml pkgs; };
5+ version = pkgs.lib.version;
6+
7+ epub-xsl = pkgs.writeText "epub.xsl" ''
8+ <?xml version='1.0'?>
9+ <xsl:stylesheet
10+ xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
11+ version="1.0">
12+ <xsl:import href="${pkgs.docbook_xsl_ns}/xml/xsl/docbook/epub/docbook.xsl" />
13+ <xsl:import href="${./parameters.xml}"/>
14+ </xsl:stylesheet>
15+ '';
16+
17+ xhtml-xsl = pkgs.writeText "xhtml.xsl" ''
18+ <?xml version='1.0'?>
19+ <xsl:stylesheet
20+ xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
21+ version="1.0">
22+ <xsl:import href="${pkgs.docbook_xsl_ns}/xml/xsl/docbook/xhtml/docbook.xsl" />
23+ <xsl:import href="${./parameters.xml}"/>
24+ </xsl:stylesheet>
25+ '';
26+in pkgs.runCommand "doc-support" {}
27+''
28+ mkdir result
29+ (
30+ cd result
31+ ln -s ${locationsXml} ./function-locations.xml
32+ ln -s ${functionDocs} ./function-docs
33+
34+ ln -s ${pkgs.docbook5}/xml/rng/docbook/docbook.rng ./docbook.rng
35+ ln -s ${pkgs.docbook_xsl_ns}/xml/xsl ./xsl
36+ ln -s ${epub-xsl} ./epub.xsl
37+ ln -s ${xhtml-xsl} ./xhtml.xsl
38+
39+ ln -s ${../../nixos/doc/xmlformat.conf} ./xmlformat.conf
40+ ln -s ${pkgs.documentation-highlighter} ./highlightjs
41+
42+ echo -n "${version}" > ./version
43+ )
44+ mv result $out
45+''
doc/doc-support/lib-function-docs.nixnew file+27
@@ -0,0 +1,27 @@
1+# Generates the documentation for library functons via nixdoc. To add
2+# another library function file to this list, the include list in the
3+# file `doc/functions/library.xml` must also be updated.
4+
5+{ pkgs ? import ./.. {}, locationsXml }:
6+
7+with pkgs; stdenv.mkDerivation {
8+ name = "nixpkgs-lib-docs";
9+ src = ./../../lib;
10+
11+ buildInputs = [ nixdoc ];
12+ installPhase = ''
13+ function docgen {
14+ nixdoc -c "$1" -d "$2" -f "../lib/$1.nix" > "$out/$1.xml"
15+ }
16+
17+ mkdir -p $out
18+ ln -s ${locationsXml} $out/locations.xml
19+
20+ docgen strings 'String manipulation functions'
21+ docgen trivial 'Miscellaneous functions'
22+ docgen lists 'List manipulation functions'
23+ docgen debug 'Debugging functions'
24+ docgen options 'NixOS / nixpkgs option handling'
25+ docgen sources 'Source filtering functions'
26+ '';
27+}
doc/doc-support/lib-function-locations.nixnew file+85
@@ -0,0 +1,85 @@
1+{ pkgs ? (import ./.. { }), nixpkgs ? { }}:
2+let
3+ revision = pkgs.lib.trivial.revisionWithDefault (nixpkgs.revision or "master");
4+
5+ libDefPos = set:
6+ builtins.map
7+ (name: {
8+ name = name;
9+ location = builtins.unsafeGetAttrPos name set;
10+ })
11+ (builtins.attrNames set);
12+
13+ libset = toplib:
14+ builtins.map
15+ (subsetname: {
16+ subsetname = subsetname;
17+ functions = libDefPos toplib.${subsetname};
18+ })
19+ (builtins.filter
20+ (name: builtins.isAttrs toplib.${name})
21+ (builtins.attrNames toplib));
22+
23+ nixpkgsLib = pkgs.lib;
24+
25+ flattenedLibSubset = { subsetname, functions }:
26+ builtins.map
27+ (fn: {
28+ name = "lib.${subsetname}.${fn.name}";
29+ value = fn.location;
30+ })
31+ functions;
32+
33+ locatedlibsets = libs: builtins.map flattenedLibSubset (libset libs);
34+ removeFilenamePrefix = prefix: filename:
35+ let
36+ prefixLen = (builtins.stringLength prefix) + 1; # +1 to remove the leading /
37+ filenameLen = builtins.stringLength filename;
38+ substr = builtins.substring prefixLen filenameLen filename;
39+ in substr;
40+
41+ removeNixpkgs = removeFilenamePrefix (builtins.toString pkgs.path);
42+
43+ liblocations =
44+ builtins.filter
45+ (elem: elem.value != null)
46+ (nixpkgsLib.lists.flatten
47+ (locatedlibsets nixpkgsLib));
48+
49+ fnLocationRelative = { name, value }:
50+ {
51+ inherit name;
52+ value = value // { file = removeNixpkgs value.file; };
53+ };
54+
55+ relativeLocs = (builtins.map fnLocationRelative liblocations);
56+ sanitizeId = builtins.replaceStrings
57+ [ "'" ]
58+ [ "-prime" ];
59+
60+ urlPrefix = "https://github.com/NixOS/nixpkgs/blob/${revision}";
61+ xmlstrings = (nixpkgsLib.strings.concatMapStrings
62+ ({ name, value }:
63+ ''
64+ <section><title>${name}</title>
65+ <para xml:id="${sanitizeId name}">
66+ Located at
67+ <link
68+ xlink:href="${urlPrefix}/${value.file}#L${builtins.toString value.line}">${value.file}:${builtins.toString value.line}</link>
69+ in <literal><nixpkgs></literal>.
70+ </para>
71+ </section>
72+ '')
73+ relativeLocs);
74+
75+in pkgs.writeText
76+ "locations.xml"
77+ ''
78+ <section xmlns="http://docbook.org/ns/docbook"
79+ xmlns:xlink="http://www.w3.org/1999/xlink"
80+ version="5">
81+ <title>All the locations for every lib function</title>
82+ <para>This file is only for inclusion by other files.</para>
83+ ${xmlstrings}
84+ </section>
85+ ''
doc/doc-support/parameters.xmlnew file+14
@@ -0,0 +1,14 @@
1+<?xml version='1.0'?>
2+<xsl:stylesheet
3+ xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
4+ version="1.0">
5+ <xsl:param name="section.autolabel" select="1" />
6+ <xsl:param name="section.label.includes.component.label" select="1" />
7+ <xsl:param name="html.stylesheet" select="'style.css overrides.css highlightjs/mono-blue.css'" />
8+ <xsl:param name="html.script" select="'./highlightjs/highlight.pack.js ./highlightjs/loader.js'" />
9+ <xsl:param name="xref.with.number.and.title" select="1" />
10+ <xsl:param name="use.id.as.filename" select="1" />
11+ <xsl:param name="toc.section.depth" select="0" />
12+ <xsl:param name="admon.style" select="''" />
13+ <xsl:param name="callout.graphics.extension" select="'.svg'" />
14+</xsl:stylesheet>
doc/functions.xmlnew file+14
@@ -0,0 +1,14 @@
1+<chapter xmlns="http://docbook.org/ns/docbook"
2+ xmlns:xlink="http://www.w3.org/1999/xlink"
3+ xmlns:xi="http://www.w3.org/2001/XInclude"
4+ xml:id="chap-functions">
5+ <title>Functions reference</title>
6+ <para>
7+ The nixpkgs repository has several utility functions to manipulate Nix expressions.
8+ </para>
9+ <xi:include href="functions/library.xml" />
10+ <xi:include href="functions/generators.section.xml" />
11+ <xi:include href="functions/debug.section.xml" />
12+ <xi:include href="functions/prefer-remote-fetch.section.xml" />
13+ <xi:include href="functions/nix-gitignore.section.xml" />
14+</chapter>
doc/functions/debug.section.mdnew file+5
@@ -0,0 +1,5 @@
1+# Debugging Nix Expressions {#sec-debug}
2+
3+Nix is a unityped, dynamic language, this means every value can potentially appear anywhere. Since it is also non-strict, evaluation order and what ultimately is evaluated might surprise you. Therefore it is important to be able to debug nix expressions.
4+
5+In the `lib/debug.nix` file you will find a number of functions that help (pretty-)printing values while evaluation is running. You can even specify how deep these values should be printed recursively, and transform them on the fly. Please consult the docstrings in `lib/debug.nix` for usage information.
doc/functions/generators.section.mdnew file+56
@@ -0,0 +1,56 @@
1+# Generators {#sec-generators}
2+Generators are functions that create file formats from nix data structures, e. g. for configuration files. There are generators available for: `INI`, `JSON` and `YAML`
3+
4+All generators follow a similar call interface: `generatorName configFunctions data`, where `configFunctions` is an attrset of user-defined functions that format nested parts of the content. They each have common defaults, so often they do not need to be set manually. An example is `mkSectionName ? (name: libStr.escape [ "[" "]" ] name)` from the `INI` generator. It receives the name of a section and sanitizes it. The default `mkSectionName` escapes `[` and `]` with a backslash.
5+
6+Generators can be fine-tuned to produce exactly the file format required by your application/service. One example is an INI-file format which uses `: ` as separator, the strings `"yes"`/`"no"` as boolean values and requires all string values to be quoted:
7+
8+```nix
9+with lib;
10+let
11+ customToINI = generators.toINI {
12+ # specifies how to format a key/value pair
13+ mkKeyValue = generators.mkKeyValueDefault {
14+ # specifies the generated string for a subset of nix values
15+ mkValueString = v:
16+ if v == true then ''"yes"''
17+ else if v == false then ''"no"''
18+ else if isString v then ''"${v}"''
19+ # and delegats all other values to the default generator
20+ else generators.mkValueStringDefault {} v;
21+ } ":";
22+ };
23+
24+# the INI file can now be given as plain old nix values
25+in customToINI {
26+ main = {
27+ pushinfo = true;
28+ autopush = false;
29+ host = "localhost";
30+ port = 42;
31+ };
32+ mergetool = {
33+ merge = "diff3";
34+ };
35+}
36+```
37+
38+This will produce the following INI file as nix string:
39+
40+```INI
41+[main]
42+autopush:"no"
43+host:"localhost"
44+port:42
45+pushinfo:"yes"
46+str\:ange:"very::strange"
47+
48+[mergetool]
49+merge:"diff3"
50+```
51+
52+::: {.note}
53+Nix store paths can be converted to strings by enclosing a derivation attribute like so: `"${drv}"`.
54+:::
55+
56+Detailed documentation for each generator can be found in `lib/generators.nix`.
doc/functions/library.xmlnew file+30
@@ -0,0 +1,30 @@
1+<section xmlns="http://docbook.org/ns/docbook"
2+ xmlns:xlink="http://www.w3.org/1999/xlink"
3+ xmlns:xi="http://www.w3.org/2001/XInclude"
4+ xml:id="sec-functions-library">
5+ <title>Nixpkgs Library Functions</title>
6+
7+ <para>
8+ Nixpkgs provides a standard library at <varname>pkgs.lib</varname>, or through <code>import <nixpkgs/lib></code>.
9+ </para>
10+
11+ <xi:include href="./library/asserts.xml" />
12+
13+ <xi:include href="./library/attrsets.xml" />
14+
15+<!-- These docs are generated via nixdoc. To add another generated
16+ library function file to this list, the file
17+ `lib-function-docs.nix` must also be updated. -->
18+
19+ <xi:include href="./library/generated/strings.xml" />
20+
21+ <xi:include href="./library/generated/trivial.xml" />
22+
23+ <xi:include href="./library/generated/lists.xml" />
24+
25+ <xi:include href="./library/generated/debug.xml" />
26+
27+ <xi:include href="./library/generated/options.xml" />
28+
29+ <xi:include href="./library/generated/sources.xml" />
30+</section>
doc/functions/library/asserts.xmlnew file+112
@@ -0,0 +1,112 @@
1+<section xmlns="http://docbook.org/ns/docbook"
2+ xmlns:xlink="http://www.w3.org/1999/xlink"
3+ xmlns:xi="http://www.w3.org/2001/XInclude"
4+ xml:id="sec-functions-library-asserts">
5+ <title>Assert functions</title>
6+
7+ <section xml:id="function-library-lib.asserts.assertMsg">
8+ <title><function>lib.asserts.assertMsg</function></title>
9+
10+ <subtitle><literal>assertMsg :: Bool -> String -> Bool</literal>
11+ </subtitle>
12+
13+ <xi:include href="./locations.xml" xpointer="lib.asserts.assertMsg" />
14+
15+ <para>
16+ Print a trace message if <literal>pred</literal> is false.
17+ </para>
18+
19+ <para>
20+ Intended to be used to augment asserts with helpful error messages.
21+ </para>
22+
23+ <variablelist>
24+ <varlistentry>
25+ <term>
26+ <varname>pred</varname>
27+ </term>
28+ <listitem>
29+ <para>
30+ Condition under which the <varname>msg</varname> should <emphasis>not</emphasis> be printed.
31+ </para>
32+ </listitem>
33+ </varlistentry>
34+ <varlistentry>
35+ <term>
36+ <varname>msg</varname>
37+ </term>
38+ <listitem>
39+ <para>
40+ Message to print.
41+ </para>
42+ </listitem>
43+ </varlistentry>
44+ </variablelist>
45+
46+ <example xml:id="function-library-lib.asserts.assertMsg-example-false">
47+ <title>Printing when the predicate is false</title>
48+<programlisting><![CDATA[
49+assert lib.asserts.assertMsg ("foo" == "bar") "foo is not bar, silly"
50+stderr> trace: foo is not bar, silly
51+stderr> assert failed
52+]]></programlisting>
53+ </example>
54+ </section>
55+
56+ <section xml:id="function-library-lib.asserts.assertOneOf">
57+ <title><function>lib.asserts.assertOneOf</function></title>
58+
59+ <subtitle><literal>assertOneOf :: String -> String ->
60+ StringList -> Bool</literal>
61+ </subtitle>
62+
63+ <xi:include href="./locations.xml" xpointer="lib.asserts.assertOneOf" />
64+
65+ <para>
66+ Specialized <function>asserts.assertMsg</function> for checking if <varname>val</varname> is one of the elements of <varname>xs</varname>. Useful for checking enums.
67+ </para>
68+
69+ <variablelist>
70+ <varlistentry>
71+ <term>
72+ <varname>name</varname>
73+ </term>
74+ <listitem>
75+ <para>
76+ The name of the variable the user entered <varname>val</varname> into, for inclusion in the error message.
77+ </para>
78+ </listitem>
79+ </varlistentry>
80+ <varlistentry>
81+ <term>
82+ <varname>val</varname>
83+ </term>
84+ <listitem>
85+ <para>
86+ The value of what the user provided, to be compared against the values in <varname>xs</varname>.
87+ </para>
88+ </listitem>
89+ </varlistentry>
90+ <varlistentry>
91+ <term>
92+ <varname>xs</varname>
93+ </term>
94+ <listitem>
95+ <para>
96+ The list of valid values.
97+ </para>
98+ </listitem>
99+ </varlistentry>
100+ </variablelist>
101+
102+ <example xml:id="function-library-lib.asserts.assertOneOf-example">
103+ <title>Ensuring a user provided a possible value</title>
104+<programlisting><![CDATA[
105+let sslLibrary = "bearssl";
106+in lib.asserts.assertOneOf "sslLibrary" sslLibrary [ "openssl" "libressl" ];
107+=> false
108+stderr> trace: sslLibrary must be one of "openssl", "libressl", but is: "bearssl"
109+ ]]></programlisting>
110+ </example>
111+ </section>
112+</section>
doc/functions/library/attrsets.xmlnew file+1751
@@ -0,0 +1,1751 @@
1+<section xmlns="http://docbook.org/ns/docbook"
2+ xmlns:xlink="http://www.w3.org/1999/xlink"
3+ xmlns:xi="http://www.w3.org/2001/XInclude"
4+ xml:id="sec-functions-library-attrset">
5+ <title>Attribute-Set Functions</title>
6+
7+ <section xml:id="function-library-lib.attrsets.attrByPath">
8+ <title><function>lib.attrset.attrByPath</function></title>
9+
10+ <subtitle><literal>attrByPath :: [String] -> Any -> AttrSet -> Any</literal>
11+ </subtitle>
12+
13+ <xi:include href="./locations.xml" xpointer="lib.attrsets.attrByPath" />
14+
15+ <para>
16+ Return an attribute from within nested attribute sets.
17+ </para>
18+
19+ <variablelist>
20+ <varlistentry>
21+ <term>
22+ <varname>attrPath</varname>
23+ </term>
24+ <listitem>
25+ <para>
26+ A list of strings representing the path through the nested attribute set <varname>set</varname>.
27+ </para>
28+ </listitem>
29+ </varlistentry>
30+ <varlistentry>
31+ <term>
32+ <varname>default</varname>
33+ </term>
34+ <listitem>
35+ <para>
36+ Default value if <varname>attrPath</varname> does not resolve to an existing value.
37+ </para>
38+ </listitem>
39+ </varlistentry>
40+ <varlistentry>
41+ <term>
42+ <varname>set</varname>
43+ </term>
44+ <listitem>
45+ <para>
46+ The nested attributeset to select values from.
47+ </para>
48+ </listitem>
49+ </varlistentry>
50+ </variablelist>
51+
52+ <example xml:id="function-library-lib.attrset.attrByPath-example-value-exists">
53+ <title>Extracting a value from a nested attribute set</title>
54+<programlisting><![CDATA[
55+let set = { a = { b = 3; }; };
56+in lib.attrsets.attrByPath [ "a" "b" ] 0 set
57+=> 3
58+]]></programlisting>
59+ </example>
60+
61+ <example xml:id="function-library-lib.attrset.attrByPath-example-default-value">
62+ <title>No value at the path, instead using the default</title>
63+<programlisting><![CDATA[
64+lib.attrsets.attrByPath [ "a" "b" ] 0 {}
65+=> 0
66+]]></programlisting>
67+ </example>
68+ </section>
69+
70+ <section xml:id="function-library-lib.attrsets.hasAttrByPath">
71+ <title><function>lib.attrsets.hasAttrByPath</function></title>
72+
73+ <subtitle><literal>hasAttrByPath :: [String] -> AttrSet -> Bool</literal>
74+ </subtitle>
75+
76+ <xi:include href="./locations.xml" xpointer="lib.attrsets.hasAttrByPath" />
77+
78+ <para>
79+ Determine if an attribute exists within a nested attribute set.
80+ </para>
81+
82+ <variablelist>
83+ <varlistentry>
84+ <term>
85+ <varname>attrPath</varname>
86+ </term>
87+ <listitem>
88+ <para>
89+ A list of strings representing the path through the nested attribute set <varname>set</varname>.
90+ </para>
91+ </listitem>
92+ </varlistentry>
93+ <varlistentry>
94+ <term>
95+ <varname>set</varname>
96+ </term>
97+ <listitem>
98+ <para>
99+ The nested attributeset to check.
100+ </para>
101+ </listitem>
102+ </varlistentry>
103+ </variablelist>
104+
105+ <example xml:id="function-library-lib.attrsets.hasAttrByPath-example">
106+ <title>A nested value does exist inside a set</title>
107+<programlisting><![CDATA[
108+lib.attrsets.hasAttrByPath
109+ [ "a" "b" "c" "d" ]
110+ { a = { b = { c = { d = 123; }; }; }; }
111+=> true
112+]]></programlisting>
113+ </example>
114+ </section>
115+
116+ <section xml:id="function-library-lib.attrsets.setAttrByPath">
117+ <title><function>lib.attrsets.setAttrByPath</function></title>
118+
119+ <subtitle><literal>setAttrByPath :: [String] -> Any -> AttrSet</literal>
120+ </subtitle>
121+
122+ <xi:include href="./locations.xml" xpointer="lib.attrsets.setAttrByPath" />
123+
124+ <para>
125+ Create a new attribute set with <varname>value</varname> set at the nested attribute location specified in <varname>attrPath</varname>.
126+ </para>
127+
128+ <variablelist>
129+ <varlistentry>
130+ <term>
131+ <varname>attrPath</varname>
132+ </term>
133+ <listitem>
134+ <para>
135+ A list of strings representing the path through the nested attribute set.
136+ </para>
137+ </listitem>
138+ </varlistentry>
139+ <varlistentry>
140+ <term>
141+ <varname>value</varname>
142+ </term>
143+ <listitem>
144+ <para>
145+ The value to set at the location described by <varname>attrPath</varname>.
146+ </para>
147+ </listitem>
148+ </varlistentry>
149+ </variablelist>
150+
151+ <example xml:id="function-library-lib.attrsets.setAttrByPath-example">
152+ <title>Creating a new nested attribute set</title>
153+<programlisting><![CDATA[
154+lib.attrsets.setAttrByPath [ "a" "b" ] 3
155+=> { a = { b = 3; }; }
156+]]></programlisting>
157+ </example>
158+ </section>
159+
160+ <section xml:id="function-library-lib.attrsets.getAttrFromPath">
161+ <title><function>lib.attrsets.getAttrFromPath</function></title>
162+
163+ <subtitle><literal>getAttrFromPath :: [String] -> AttrSet -> Value</literal>
164+ </subtitle>
165+
166+ <xi:include href="./locations.xml" xpointer="lib.attrsets.getAttrFromPath" />
167+
168+ <para>
169+ Like <xref linkend="function-library-lib.attrsets.attrByPath" /> except without a default, and it will throw if the value doesn't exist.
170+ </para>
171+
172+ <variablelist>
173+ <varlistentry>
174+ <term>
175+ <varname>attrPath</varname>
176+ </term>
177+ <listitem>
178+ <para>
179+ A list of strings representing the path through the nested attribute set <varname>set</varname>.
180+ </para>
181+ </listitem>
182+ </varlistentry>
183+ <varlistentry>
184+ <term>
185+ <varname>set</varname>
186+ </term>
187+ <listitem>
188+ <para>
189+ The nested attribute set to find the value in.
190+ </para>
191+ </listitem>
192+ </varlistentry>
193+ </variablelist>
194+
195+ <example xml:id="function-library-lib.attrsets.getAttrPath-example-success">
196+ <title>Succesfully getting a value from an attribute set</title>
197+<programlisting><![CDATA[
198+lib.attrsets.getAttrFromPath [ "a" "b" ] { a = { b = 3; }; }
199+=> 3
200+]]></programlisting>
201+ </example>
202+
203+ <example xml:id="function-library-lib.attrsets.getAttrPath-example-throw">
204+ <title>Throwing after failing to get a value from an attribute set</title>
205+<programlisting><![CDATA[
206+lib.attrsets.getAttrFromPath [ "x" "y" ] { }
207+=> error: cannot find attribute `x.y'
208+]]></programlisting>
209+ </example>
210+ </section>
211+
212+ <section xml:id="function-library-lib.attrsets.attrVals">
213+ <title><function>lib.attrsets.attrVals</function></title>
214+
215+ <subtitle><literal>attrVals :: [String] -> AttrSet -> [Any]</literal>
216+ </subtitle>
217+
218+ <xi:include href="./locations.xml" xpointer="lib.attrsets.attrVals" />
219+
220+ <para>
221+ Return the specified attributes from a set. All values must exist.
222+ </para>
223+
224+ <variablelist>
225+ <varlistentry>
226+ <term>
227+ <varname>nameList</varname>
228+ </term>
229+ <listitem>
230+ <para>
231+ The list of attributes to fetch from <varname>set</varname>. Each attribute name must exist on the attrbitue set.
232+ </para>
233+ </listitem>
234+ </varlistentry>
235+ <varlistentry>
236+ <term>
237+ <varname>set</varname>
238+ </term>
239+ <listitem>
240+ <para>
241+ The set to get attribute values from.
242+ </para>
243+ </listitem>
244+ </varlistentry>
245+ </variablelist>
246+
247+ <example xml:id="function-library-lib.attrsets.attrVals-example-success">
248+ <title>Getting several values from an attribute set</title>
249+<programlisting><![CDATA[
250+lib.attrsets.attrVals [ "a" "b" "c" ] { a = 1; b = 2; c = 3; }
251+=> [ 1 2 3 ]
252+]]></programlisting>
253+ </example>
254+
255+ <example xml:id="function-library-lib.attrsets.attrVals-failure">
256+ <title>Getting missing values from an attribute set</title>
257+<programlisting><![CDATA[
258+lib.attrsets.attrVals [ "d" ] { }
259+error: attribute 'd' missing
260+]]></programlisting>
261+ </example>
262+ </section>
263+
264+ <section xml:id="function-library-lib.attrsets.attrValues">
265+ <title><function>lib.attrsets.attrValues</function></title>
266+
267+ <subtitle><literal>attrValues :: AttrSet -> [Any]</literal>
268+ </subtitle>
269+
270+ <xi:include href="./locations.xml" xpointer="lib.attrsets.attrValues" />
271+
272+ <para>
273+ Get all the attribute values from an attribute set.
274+ </para>
275+
276+ <para>
277+ Provides a backwards-compatible interface of <function>builtins.attrValues</function> for Nix version older than 1.8.
278+ </para>
279+
280+ <variablelist>
281+ <varlistentry>
282+ <term>
283+ <varname>attrs</varname>
284+ </term>
285+ <listitem>
286+ <para>
287+ The attribute set.
288+ </para>
289+ </listitem>
290+ </varlistentry>
291+ </variablelist>
292+
293+ <example xml:id="function-library-lib.attrsets.attrValues-example">
294+ <title></title>
295+<programlisting><![CDATA[
296+lib.attrsets.attrValues { a = 1; b = 2; c = 3; }
297+=> [ 1 2 3 ]
298+]]></programlisting>
299+ </example>
300+ </section>
301+
302+ <section xml:id="function-library-lib.attrsets.catAttrs">
303+ <title><function>lib.attrsets.catAttrs</function></title>
304+
305+ <subtitle><literal>catAttrs :: String -> [AttrSet] -> [Any]</literal>
306+ </subtitle>
307+
308+ <xi:include href="./locations.xml" xpointer="lib.attrsets.catAttrs" />
309+
310+ <para>
311+ Collect each attribute named `attr' from the list of attribute sets, <varname>sets</varname>. Sets that don't contain the named attribute are ignored.
312+ </para>
313+
314+ <para>
315+ Provides a backwards-compatible interface of <function>builtins.catAttrs</function> for Nix version older than 1.9.
316+ </para>
317+
318+ <variablelist>
319+ <varlistentry>
320+ <term>
321+ <varname>attr</varname>
322+ </term>
323+ <listitem>
324+ <para>
325+ Attribute name to select from each attribute set in <varname>sets</varname>.
326+ </para>
327+ </listitem>
328+ </varlistentry>
329+ <varlistentry>
330+ <term>
331+ <varname>sets</varname>
332+ </term>
333+ <listitem>
334+ <para>
335+ The list of attribute sets to select <varname>attr</varname> from.
336+ </para>
337+ </listitem>
338+ </varlistentry>
339+ </variablelist>
340+
341+ <example xml:id="function-library-lib.attrsets.catAttrs-example">
342+ <title>Collect an attribute from a list of attribute sets.</title>
343+ <para>
344+ Attribute sets which don't have the attribute are ignored.
345+ </para>
346+<programlisting><![CDATA[
347+catAttrs "a" [{a = 1;} {b = 0;} {a = 2;}]
348+=> [ 1 2 ]
349+ ]]></programlisting>
350+ </example>
351+ </section>
352+
353+ <section xml:id="function-library-lib.attrsets.filterAttrs">
354+ <title><function>lib.attrsets.filterAttrs</function></title>
355+
356+ <subtitle><literal>filterAttrs :: (String -> Any -> Bool) -> AttrSet -> AttrSet</literal>
357+ </subtitle>
358+
359+ <xi:include href="./locations.xml" xpointer="lib.attrsets.filterAttrs" />
360+
361+ <para>
362+ Filter an attribute set by removing all attributes for which the given predicate return false.
363+ </para>
364+
365+ <variablelist>
366+ <varlistentry>
367+ <term>
368+ <varname>pred</varname>
369+ </term>
370+ <listitem>
371+ <para>
372+ <literal>String -> Any -> Bool</literal>
373+ </para>
374+ <para>
375+ Predicate which returns true to include an attribute, or returns false to exclude it.
376+ </para>
377+ <variablelist>
378+ <varlistentry>
379+ <term>
380+ <varname>name</varname>
381+ </term>
382+ <listitem>
383+ <para>
384+ The attribute's name
385+ </para>
386+ </listitem>
387+ </varlistentry>
388+ <varlistentry>
389+ <term>
390+ <varname>value</varname>
391+ </term>
392+ <listitem>
393+ <para>
394+ The attribute's value
395+ </para>
396+ </listitem>
397+ </varlistentry>
398+ </variablelist>
399+ <para>
400+ Returns <literal>true</literal> to include the attribute, <literal>false</literal> to exclude the attribute.
401+ </para>
402+ </listitem>
403+ </varlistentry>
404+ <varlistentry>
405+ <term>
406+ <varname>set</varname>
407+ </term>
408+ <listitem>
409+ <para>
410+ The attribute set to filter
411+ </para>
412+ </listitem>
413+ </varlistentry>
414+ </variablelist>
415+
416+ <example xml:id="function-library-lib.attrsets.filterAttrs-example">
417+ <title>Filtering an attributeset</title>
418+<programlisting><![CDATA[
419+filterAttrs (n: v: n == "foo") { foo = 1; bar = 2; }
420+=> { foo = 1; }
421+]]></programlisting>
422+ </example>
423+ </section>
424+
425+ <section xml:id="function-library-lib.attrsets.filterAttrsRecursive">
426+ <title><function>lib.attrsets.filterAttrsRecursive</function></title>
427+
428+ <subtitle><literal>filterAttrsRecursive :: (String -> Any -> Bool) -> AttrSet -> AttrSet</literal>
429+ </subtitle>
430+
431+ <xi:include href="./locations.xml" xpointer="lib.attrsets.filterAttrsRecursive" />
432+
433+ <para>
434+ Filter an attribute set recursively by removing all attributes for which the given predicate return false.
435+ </para>
436+
437+ <variablelist>
438+ <varlistentry>
439+ <term>
440+ <varname>pred</varname>
441+ </term>
442+ <listitem>
443+ <para>
444+ <literal>String -> Any -> Bool</literal>
445+ </para>
446+ <para>
447+ Predicate which returns true to include an attribute, or returns false to exclude it.
448+ </para>
449+ <variablelist>
450+ <varlistentry>
451+ <term>
452+ <varname>name</varname>
453+ </term>
454+ <listitem>
455+ <para>
456+ The attribute's name
457+ </para>
458+ </listitem>
459+ </varlistentry>
460+ <varlistentry>
461+ <term>
462+ <varname>value</varname>
463+ </term>
464+ <listitem>
465+ <para>
466+ The attribute's value
467+ </para>
468+ </listitem>
469+ </varlistentry>
470+ </variablelist>
471+ <para>
472+ Returns <literal>true</literal> to include the attribute, <literal>false</literal> to exclude the attribute.
473+ </para>
474+ </listitem>
475+ </varlistentry>
476+ <varlistentry>
477+ <term>
478+ <varname>set</varname>
479+ </term>
480+ <listitem>
481+ <para>
482+ The attribute set to filter
483+ </para>
484+ </listitem>
485+ </varlistentry>
486+ </variablelist>
487+
488+ <example xml:id="function-library-lib.attrsets.filterAttrsRecursive-example">
489+ <title>Recursively filtering an attribute set</title>
490+<programlisting><![CDATA[
491+lib.attrsets.filterAttrsRecursive
492+ (n: v: v != null)
493+ {
494+ levelA = {
495+ example = "hi";
496+ levelB = {
497+ hello = "there";
498+ this-one-is-present = {
499+ this-is-excluded = null;
500+ };
501+ };
502+ this-one-is-also-excluded = null;
503+ };
504+ also-excluded = null;
505+ }
506+=> {
507+ levelA = {
508+ example = "hi";
509+ levelB = {
510+ hello = "there";
511+ this-one-is-present = { };
512+ };
513+ };
514+ }
515+ ]]></programlisting>
516+ </example>
517+ </section>
518+
519+ <section xml:id="function-library-lib.attrsets.foldAttrs">
520+ <title><function>lib.attrsets.foldAttrs</function></title>
521+
522+ <subtitle><literal>foldAttrs :: (Any -> Any -> Any) -> Any -> [AttrSets] -> Any</literal>
523+ </subtitle>
524+
525+ <xi:include href="./locations.xml" xpointer="lib.attrsets.foldAttrs" />
526+
527+ <para>
528+ Apply fold function to values grouped by key.
529+ </para>
530+
531+ <variablelist>
532+ <varlistentry>
533+ <term>
534+ <varname>op</varname>
535+ </term>
536+ <listitem>
537+ <para>
538+ <literal>Any -> Any -> Any</literal>
539+ </para>
540+ <para>
541+ Given a value <varname>val</varname> and a collector <varname>col</varname>, combine the two.
542+ </para>
543+ <variablelist>
544+ <varlistentry>
545+ <term>
546+ <varname>val</varname>
547+ </term>
548+ <listitem>
549+ <para>
550+ An attribute's value
551+ </para>
552+ </listitem>
553+ </varlistentry>
554+ <varlistentry>
555+ <term>
556+ <varname>col</varname>
557+ </term>
558+ <listitem>
559+<!-- TODO: make this not bad, use more fold-ey terms -->
560+ <para>
561+ The result of previous <function>op</function> calls with other values and <function>nul</function>.
562+ </para>
563+ </listitem>
564+ </varlistentry>
565+ </variablelist>
566+ </listitem>
567+ </varlistentry>
568+ <varlistentry>
569+ <term>
570+ <varname>nul</varname>
571+ </term>
572+ <listitem>
573+ <para>
574+ The null-value, the starting value.
575+ </para>
576+ </listitem>
577+ </varlistentry>
578+ <varlistentry>
579+ <term>
580+ <varname>list_of_attrs</varname>
581+ </term>
582+ <listitem>
583+ <para>
584+ A list of attribute sets to fold together by key.
585+ </para>
586+ </listitem>
587+ </varlistentry>
588+ </variablelist>
589+
590+ <example xml:id="function-library-lib.attrsets.foldAttrs-example">
591+ <title>Combining an attribute of lists in to one attribute set</title>
592+<programlisting><![CDATA[
593+lib.attrsets.foldAttrs
594+ (n: a: [n] ++ a) []
595+ [
596+ { a = 2; b = 7; }
597+ { a = 3; }
598+ { b = 6; }
599+ ]
600+=> { a = [ 2 3 ]; b = [ 7 6 ]; }
601+]]></programlisting>
602+ </example>
603+ </section>
604+
605+ <section xml:id="function-library-lib.attrsets.collect">
606+ <title><function>lib.attrsets.collect</function></title>
607+
608+ <subtitle><literal>collect :: (Any -> Bool) -> AttrSet -> [Any]</literal>
609+ </subtitle>
610+
611+ <xi:include href="./locations.xml" xpointer="lib.attrsets.collect" />
612+
613+ <para>
614+ Recursively collect sets that verify a given predicate named <varname>pred</varname> from the set <varname>attrs</varname>. The recursion stops when <varname>pred</varname> returns <literal>true</literal>.
615+ </para>
616+
617+ <variablelist>
618+ <varlistentry>
619+ <term>
620+ <varname>pred</varname>
621+ </term>
622+ <listitem>
623+ <para>
624+ <literal>Any -> Bool</literal>
625+ </para>
626+ <para>
627+ Given an attribute's value, determine if recursion should stop.
628+ </para>
629+ <variablelist>
630+ <varlistentry>
631+ <term>
632+ <varname>value</varname>
633+ </term>
634+ <listitem>
635+ <para>
636+ The attribute set value.
637+ </para>
638+ </listitem>
639+ </varlistentry>
640+ </variablelist>
641+ </listitem>
642+ </varlistentry>
643+ <varlistentry>
644+ <term>
645+ <varname>attrs</varname>
646+ </term>
647+ <listitem>
648+ <para>
649+ The attribute set to recursively collect.
650+ </para>
651+ </listitem>
652+ </varlistentry>
653+ </variablelist>
654+
655+ <example xml:id="function-library-lib.attrsets.collect-example-lists">
656+ <title>Collecting all lists from an attribute set</title>
657+<programlisting><![CDATA[
658+lib.attrsets.collect isList { a = { b = ["b"]; }; c = [1]; }
659+=> [["b"] [1]]
660+]]></programlisting>
661+ </example>
662+
663+ <example xml:id="function-library-lib.attrsets.collect-example-outpath">
664+ <title>Collecting all attribute-sets which contain the <literal>outPath</literal> attribute name.</title>
665+<programlisting><![CDATA[
666+collect (x: x ? outPath)
667+ { a = { outPath = "a/"; }; b = { outPath = "b/"; }; }
668+=> [{ outPath = "a/"; } { outPath = "b/"; }]
669+]]></programlisting>
670+ </example>
671+ </section>
672+
673+ <section xml:id="function-library-lib.attrsets.nameValuePair">
674+ <title><function>lib.attrsets.nameValuePair</function></title>
675+
676+ <subtitle><literal>nameValuePair :: String -> Any -> AttrSet</literal>
677+ </subtitle>
678+
679+ <xi:include href="./locations.xml" xpointer="lib.attrsets.nameValuePair" />
680+
681+ <para>
682+ Utility function that creates a <literal>{name, value}</literal> pair as expected by <function>builtins.listToAttrs</function>.
683+ </para>
684+
685+ <variablelist>
686+ <varlistentry>
687+ <term>
688+ <varname>name</varname>
689+ </term>
690+ <listitem>
691+ <para>
692+ The attribute name.
693+ </para>
694+ </listitem>
695+ </varlistentry>
696+ <varlistentry>
697+ <term>
698+ <varname>value</varname>
699+ </term>
700+ <listitem>
701+ <para>
702+ The attribute value.
703+ </para>
704+ </listitem>
705+ </varlistentry>
706+ </variablelist>
707+
708+ <example xml:id="function-library-lib.attrsets.nameValuePair-example">
709+ <title>Creating a name value pair</title>
710+<programlisting><![CDATA[
711+nameValuePair "some" 6
712+=> { name = "some"; value = 6; }
713+]]></programlisting>
714+ </example>
715+ </section>
716+
717+ <section xml:id="function-library-lib.attrsets.mapAttrs">
718+ <title><function>lib.attrsets.mapAttrs</function></title>
719+
720+ <subtitle><literal></literal>
721+ </subtitle>
722+
723+ <xi:include href="./locations.xml" xpointer="lib.attrsets.mapAttrs" />
724+
725+ <para>
726+ Apply a function to each element in an attribute set, creating a new attribute set.
727+ </para>
728+
729+ <para>
730+ Provides a backwards-compatible interface of <function>builtins.mapAttrs</function> for Nix version older than 2.1.
731+ </para>
732+
733+ <variablelist>
734+ <varlistentry>
735+ <term>
736+ <varname>fn</varname>
737+ </term>
738+ <listitem>
739+ <para>
740+ <literal>String -> Any -> Any</literal>
741+ </para>
742+ <para>
743+ Given an attribute's name and value, return a new value.
744+ </para>
745+ <variablelist>
746+ <varlistentry>
747+ <term>
748+ <varname>name</varname>
749+ </term>
750+ <listitem>
751+ <para>
752+ The name of the attribute.
753+ </para>
754+ </listitem>
755+ </varlistentry>
756+ <varlistentry>
757+ <term>
758+ <varname>value</varname>
759+ </term>
760+ <listitem>
761+ <para>
762+ The attribute's value.
763+ </para>
764+ </listitem>
765+ </varlistentry>
766+ </variablelist>
767+ </listitem>
768+ </varlistentry>
769+ </variablelist>
770+
771+ <example xml:id="function-library-lib.attrsets.mapAttrs-example">
772+ <title>Modifying each value of an attribute set</title>
773+<programlisting><![CDATA[
774+lib.attrsets.mapAttrs
775+ (name: value: name + "-" + value)
776+ { x = "foo"; y = "bar"; }
777+=> { x = "x-foo"; y = "y-bar"; }
778+]]></programlisting>
779+ </example>
780+ </section>
781+
782+ <section xml:id="function-library-lib.attrsets.mapAttrs-prime">
783+ <title><function>lib.attrsets.mapAttrs'</function></title>
784+
785+ <subtitle><literal>mapAttrs' :: (String -> Any -> { name = String; value = Any }) -> AttrSet -> AttrSet</literal>
786+ </subtitle>
787+
788+ <xi:include href="./locations.xml" xpointer="lib.attrsets.mapAttrs-prime" />
789+
790+ <para>
791+ Like <function>mapAttrs</function>, but allows the name of each attribute to be changed in addition to the value. The applied function should return both the new name and value as a <function>nameValuePair</function>.
792+ </para>
793+
794+ <variablelist>
795+ <varlistentry>
796+ <term>
797+ <varname>fn</varname>
798+ </term>
799+ <listitem>
800+ <para>
801+ <literal>String -> Any -> { name = String; value = Any }</literal>
802+ </para>
803+ <para>
804+ Given an attribute's name and value, return a new <link
805+ linkend="function-library-lib.attrsets.nameValuePair">name value pair</link>.
806+ </para>
807+ <variablelist>
808+ <varlistentry>
809+ <term>
810+ <varname>name</varname>
811+ </term>
812+ <listitem>
813+ <para>
814+ The name of the attribute.
815+ </para>
816+ </listitem>
817+ </varlistentry>
818+ <varlistentry>
819+ <term>
820+ <varname>value</varname>
821+ </term>
822+ <listitem>
823+ <para>
824+ The attribute's value.
825+ </para>
826+ </listitem>
827+ </varlistentry>
828+ </variablelist>
829+ </listitem>
830+ </varlistentry>
831+ <varlistentry>
832+ <term>
833+ <varname>set</varname>
834+ </term>
835+ <listitem>
836+ <para>
837+ The attribute set to map over.
838+ </para>
839+ </listitem>
840+ </varlistentry>
841+ </variablelist>
842+
843+ <example xml:id="function-library-lib.attrsets.mapAttrs-prime-example">
844+ <title>Change the name and value of each attribute of an attribute set</title>
845+<programlisting><![CDATA[
846+lib.attrsets.mapAttrs' (name: value: lib.attrsets.nameValuePair ("foo_" + name) ("bar-" + value))
847+ { x = "a"; y = "b"; }
848+=> { foo_x = "bar-a"; foo_y = "bar-b"; }
849+
850+ ]]></programlisting>
851+ </example>
852+ </section>
853+
854+ <section xml:id="function-library-lib.attrsets.mapAttrsToList">
855+ <title><function>lib.attrsets.mapAttrsToList</function></title>
856+
857+ <subtitle><literal>mapAttrsToList :: (String -> Any -> Any) ->
858+ AttrSet -> [Any]</literal>
859+ </subtitle>
860+
861+ <xi:include href="./locations.xml" xpointer="lib.attrsets.mapAttrsToList" />
862+
863+ <para>
864+ Call <varname>fn</varname> for each attribute in the given <varname>set</varname> and return the result in a list.
865+ </para>
866+
867+ <variablelist>
868+ <varlistentry>
869+ <term>
870+ <varname>fn</varname>
871+ </term>
872+ <listitem>
873+ <para>
874+ <literal>String -> Any -> Any</literal>
875+ </para>
876+ <para>
877+ Given an attribute's name and value, return a new value.
878+ </para>
879+ <variablelist>
880+ <varlistentry>
881+ <term>
882+ <varname>name</varname>
883+ </term>
884+ <listitem>
885+ <para>
886+ The name of the attribute.
887+ </para>
888+ </listitem>
889+ </varlistentry>
890+ <varlistentry>
891+ <term>
892+ <varname>value</varname>
893+ </term>
894+ <listitem>
895+ <para>
896+ The attribute's value.
897+ </para>
898+ </listitem>
899+ </varlistentry>
900+ </variablelist>
901+ </listitem>
902+ </varlistentry>
903+ <varlistentry>
904+ <term>
905+ <varname>set</varname>
906+ </term>
907+ <listitem>
908+ <para>
909+ The attribute set to map over.
910+ </para>
911+ </listitem>
912+ </varlistentry>
913+ </variablelist>
914+
915+ <example xml:id="function-library-lib.attrsets.mapAttrsToList-example">
916+ <title>Combine attribute values and names in to a list</title>
917+<programlisting><![CDATA[
918+lib.attrsets.mapAttrsToList (name: value: "${name}=${value}")
919+ { x = "a"; y = "b"; }
920+=> [ "x=a" "y=b" ]
921+]]></programlisting>
922+ </example>
923+ </section>
924+
925+ <section xml:id="function-library-lib.attrsets.mapAttrsRecursive">
926+ <title><function>lib.attrsets.mapAttrsRecursive</function></title>
927+
928+ <subtitle><literal>mapAttrsRecursive :: ([String] > Any -> Any) -> AttrSet -> AttrSet</literal>
929+ </subtitle>
930+
931+ <xi:include href="./locations.xml" xpointer="lib.attrsets.mapAttrsRecursive" />
932+
933+ <para>
934+ Like <function>mapAttrs</function>, except that it recursively applies itself to attribute sets. Also, the first argument of the argument function is a <emphasis>list</emphasis> of the names of the containing attributes.
935+ </para>
936+
937+ <variablelist>
938+ <varlistentry>
939+ <term>
940+ <varname>f</varname>
941+ </term>
942+ <listitem>
943+ <para>
944+ <literal>[ String ] -> Any -> Any</literal>
945+ </para>
946+ <para>
947+ Given a list of attribute names and value, return a new value.
948+ </para>
949+ <variablelist>
950+ <varlistentry>
951+ <term>
952+ <varname>name_path</varname>
953+ </term>
954+ <listitem>
955+ <para>
956+ The list of attribute names to this value.
957+ </para>
958+ <para>
959+ For example, the <varname>name_path</varname> for the <literal>example</literal> string in the attribute set <literal>{ foo = { bar = "example"; }; }</literal> is <literal>[ "foo" "bar" ]</literal>.
960+ </para>
961+ </listitem>
962+ </varlistentry>
963+ <varlistentry>
964+ <term>
965+ <varname>value</varname>
966+ </term>
967+ <listitem>
968+ <para>
969+ The attribute's value.
970+ </para>
971+ </listitem>
972+ </varlistentry>
973+ </variablelist>
974+ </listitem>
975+ </varlistentry>
976+ <varlistentry>
977+ <term>
978+ <varname>set</varname>
979+ </term>
980+ <listitem>
981+ <para>
982+ The attribute set to recursively map over.
983+ </para>
984+ </listitem>
985+ </varlistentry>
986+ </variablelist>
987+
988+ <example xml:id="function-library-lib.attrsets.mapAttrsRecursive-example">
989+ <title>A contrived example of using <function>lib.attrsets.mapAttrsRecursive</function></title>
990+<programlisting><![CDATA[
991+mapAttrsRecursive
992+ (path: value: concatStringsSep "-" (path ++ [value]))
993+ {
994+ n = {
995+ a = "A";
996+ m = {
997+ b = "B";
998+ c = "C";
999+ };
1000+ };
1001+ d = "D";
1002+ }
1003+=> {
1004+ n = {
1005+ a = "n-a-A";
1006+ m = {
1007+ b = "n-m-b-B";
1008+ c = "n-m-c-C";
1009+ };
1010+ };
1011+ d = "d-D";
1012+ }
1013+ ]]></programlisting>
1014+ </example>
1015+ </section>
1016+
1017+ <section xml:id="function-library-lib.attrsets.mapAttrsRecursiveCond">
1018+ <title><function>lib.attrsets.mapAttrsRecursiveCond</function></title>
1019+
1020+ <subtitle><literal>mapAttrsRecursiveCond :: (AttrSet -> Bool) -> ([ String ] -> Any -> Any) -> AttrSet -> AttrSet</literal>
1021+ </subtitle>
1022+
1023+ <xi:include href="./locations.xml" xpointer="lib.attrsets.mapAttrsRecursiveCond" />
1024+
1025+ <para>
1026+ Like <function>mapAttrsRecursive</function>, but it takes an additional predicate function that tells it whether to recursive into an attribute set. If it returns false, <function>mapAttrsRecursiveCond</function> does not recurse, but does apply the map function. It is returns true, it does recurse, and does not apply the map function.
1027+ </para>
1028+
1029+ <variablelist>
1030+ <varlistentry>
1031+ <term>
1032+ <varname>cond</varname>
1033+ </term>
1034+ <listitem>
1035+ <para>
1036+ <literal>(AttrSet -> Bool)</literal>
1037+ </para>
1038+ <para>
1039+ Determine if <function>mapAttrsRecursive</function> should recurse deeper in to the attribute set.
1040+ </para>
1041+ <variablelist>
1042+ <varlistentry>
1043+ <term>
1044+ <varname>attributeset</varname>
1045+ </term>
1046+ <listitem>
1047+ <para>
1048+ An attribute set.
1049+ </para>
1050+ </listitem>
1051+ </varlistentry>
1052+ </variablelist>
1053+ </listitem>
1054+ </varlistentry>
1055+ <varlistentry>
1056+ <term>
1057+ <varname>f</varname>
1058+ </term>
1059+ <listitem>
1060+ <para>
1061+ <literal>[ String ] -> Any -> Any</literal>
1062+ </para>
1063+ <para>
1064+ Given a list of attribute names and value, return a new value.
1065+ </para>
1066+ <variablelist>
1067+ <varlistentry>
1068+ <term>
1069+ <varname>name_path</varname>
1070+ </term>
1071+ <listitem>
1072+ <para>
1073+ The list of attribute names to this value.
1074+ </para>
1075+ <para>
1076+ For example, the <varname>name_path</varname> for the <literal>example</literal> string in the attribute set <literal>{ foo = { bar = "example"; }; }</literal> is <literal>[ "foo" "bar" ]</literal>.
1077+ </para>
1078+ </listitem>
1079+ </varlistentry>
1080+ <varlistentry>
1081+ <term>
1082+ <varname>value</varname>
1083+ </term>
1084+ <listitem>
1085+ <para>
1086+ The attribute's value.
1087+ </para>
1088+ </listitem>
1089+ </varlistentry>
1090+ </variablelist>
1091+ </listitem>
1092+ </varlistentry>
1093+ <varlistentry>
1094+ <term>
1095+ <varname>set</varname>
1096+ </term>
1097+ <listitem>
1098+ <para>
1099+ The attribute set to recursively map over.
1100+ </para>
1101+ </listitem>
1102+ </varlistentry>
1103+ </variablelist>
1104+
1105+ <example xml:id="function-library-lib.attrsets.mapAttrsRecursiveCond-example">
1106+ <title>Only convert attribute values to JSON if the containing attribute set is marked for recursion</title>
1107+<programlisting><![CDATA[
1108+lib.attrsets.mapAttrsRecursiveCond
1109+ ({ recurse ? false, ... }: recurse)
1110+ (name: value: builtins.toJSON value)
1111+ {
1112+ dorecur = {
1113+ recurse = true;
1114+ hello = "there";
1115+ };
1116+ dontrecur = {
1117+ converted-to- = "json";
1118+ };
1119+ }
1120+=> {
1121+ dorecur = {
1122+ hello = "\"there\"";
1123+ recurse = "true";
1124+ };
1125+ dontrecur = "{\"converted-to\":\"json\"}";
1126+ }
1127+ ]]></programlisting>
1128+ </example>
1129+ </section>
1130+
1131+ <section xml:id="function-library-lib.attrsets.genAttrs">
1132+ <title><function>lib.attrsets.genAttrs</function></title>
1133+
1134+ <subtitle><literal>genAttrs :: [ String ] -> (String -> Any) -> AttrSet</literal>
1135+ </subtitle>
1136+
1137+ <xi:include href="./locations.xml" xpointer="lib.attrsets.genAttrs" />
1138+
1139+ <para>
1140+ Generate an attribute set by mapping a function over a list of attribute names.
1141+ </para>
1142+
1143+ <variablelist>
1144+ <varlistentry>
1145+ <term>
1146+ <varname>names</varname>
1147+ </term>
1148+ <listitem>
1149+ <para>
1150+ Names of values in the resulting attribute set.
1151+ </para>
1152+ </listitem>
1153+ </varlistentry>
1154+ <varlistentry>
1155+ <term>
1156+ <varname>f</varname>
1157+ </term>
1158+ <listitem>
1159+ <para>
1160+ <literal>String -> Any</literal>
1161+ </para>
1162+ <para>
1163+ Takes the name of the attribute and return the attribute's value.
1164+ </para>
1165+ <variablelist>
1166+ <varlistentry>
1167+ <term>
1168+ <varname>name</varname>
1169+ </term>
1170+ <listitem>
1171+ <para>
1172+ The name of the attribute to generate a value for.
1173+ </para>
1174+ </listitem>
1175+ </varlistentry>
1176+ </variablelist>
1177+ </listitem>
1178+ </varlistentry>
1179+ </variablelist>
1180+
1181+ <example xml:id="function-library-lib.attrsets.genAttrs-example">
1182+ <title>Generate an attrset based on names only</title>
1183+<programlisting><![CDATA[
1184+lib.attrsets.genAttrs [ "foo" "bar" ] (name: "x_${name}")
1185+=> { foo = "x_foo"; bar = "x_bar"; }
1186+ ]]></programlisting>
1187+ </example>
1188+ </section>
1189+
1190+ <section xml:id="function-library-lib.attrsets.isDerivation">
1191+ <title><function>lib.attrsets.isDerivation</function></title>
1192+
1193+ <subtitle><literal>isDerivation :: Any -> Bool</literal>
1194+ </subtitle>
1195+
1196+ <xi:include href="./locations.xml" xpointer="lib.attrsets.isDerivation" />
1197+
1198+ <para>
1199+ Check whether the argument is a derivation. Any set with <code>{ type = "derivation"; }</code> counts as a derivation.
1200+ </para>
1201+
1202+ <variablelist>
1203+ <varlistentry>
1204+ <term>
1205+ <varname>value</varname>
1206+ </term>
1207+ <listitem>
1208+ <para>
1209+ The value which is possibly a derivation.
1210+ </para>
1211+ </listitem>
1212+ </varlistentry>
1213+ </variablelist>
1214+
1215+ <example xml:id="function-library-lib.attrsets.isDerivation-example-true">
1216+ <title>A package is a derivation</title>
1217+<programlisting><![CDATA[
1218+lib.attrsets.isDerivation (import <nixpkgs> {}).ruby
1219+=> true
1220+ ]]></programlisting>
1221+ </example>
1222+
1223+ <example xml:id="function-library-lib.attrsets.isDerivation-example-false">
1224+ <title>Anything else is not a derivation</title>
1225+<programlisting><![CDATA[
1226+lib.attrsets.isDerivation "foobar"
1227+=> false
1228+ ]]></programlisting>
1229+ </example>
1230+ </section>
1231+
1232+ <section xml:id="function-library-lib.attrsets.toDerivation">
1233+ <title><function>lib.attrsets.toDerivation</function></title>
1234+
1235+ <subtitle><literal>toDerivation :: Path -> Derivation</literal>
1236+ </subtitle>
1237+
1238+ <xi:include href="./locations.xml" xpointer="lib.attrsets.toDerivation" />
1239+
1240+ <para>
1241+ Converts a store path to a fake derivation.
1242+ </para>
1243+
1244+ <variablelist>
1245+ <varlistentry>
1246+ <term>
1247+ <varname>path</varname>
1248+ </term>
1249+ <listitem>
1250+ <para>
1251+ A store path to convert to a derivation.
1252+ </para>
1253+ </listitem>
1254+ </varlistentry>
1255+ </variablelist>
1256+ </section>
1257+
1258+ <section xml:id="function-library-lib.attrsets.optionalAttrs">
1259+ <title><function>lib.attrsets.optionalAttrs</function></title>
1260+
1261+ <subtitle><literal>optionalAttrs :: Bool -> AttrSet</literal>
1262+ </subtitle>
1263+
1264+ <xi:include href="./locations.xml" xpointer="lib.attrsets.optionalAttrs" />
1265+
1266+ <para>
1267+ Conditionally return an attribute set or an empty attribute set.
1268+ </para>
1269+
1270+ <variablelist>
1271+ <varlistentry>
1272+ <term>
1273+ <varname>cond</varname>
1274+ </term>
1275+ <listitem>
1276+ <para>
1277+ Condition under which the <varname>as</varname> attribute set is returned.
1278+ </para>
1279+ </listitem>
1280+ </varlistentry>
1281+ <varlistentry>
1282+ <term>
1283+ <varname>as</varname>
1284+ </term>
1285+ <listitem>
1286+ <para>
1287+ The attribute set to return if <varname>cond</varname> is true.
1288+ </para>
1289+ </listitem>
1290+ </varlistentry>
1291+ </variablelist>
1292+
1293+ <example xml:id="function-library-lib.attrsets.optionalAttrs-example-true">
1294+ <title>Return the provided attribute set when <varname>cond</varname> is true</title>
1295+<programlisting><![CDATA[
1296+lib.attrsets.optionalAttrs true { my = "set"; }
1297+=> { my = "set"; }
1298+ ]]></programlisting>
1299+ </example>
1300+
1301+ <example xml:id="function-library-lib.attrsets.optionalAttrs-example-false">
1302+ <title>Return an empty attribute set when <varname>cond</varname> is false</title>
1303+<programlisting><![CDATA[
1304+lib.attrsets.optionalAttrs false { my = "set"; }
1305+=> { }
1306+ ]]></programlisting>
1307+ </example>
1308+ </section>
1309+
1310+ <section xml:id="function-library-lib.attrsets.zipAttrsWithNames">
1311+ <title><function>lib.attrsets.zipAttrsWithNames</function></title>
1312+
1313+ <subtitle><literal>zipAttrsWithNames :: [ String ] -> (String -> [ Any ] -> Any) -> [ AttrSet ] -> AttrSet</literal>
1314+ </subtitle>
1315+
1316+ <xi:include href="./locations.xml" xpointer="lib.attrsets.zipAttrsWithNames" />
1317+
1318+ <para>
1319+ Merge sets of attributes and use the function <varname>f</varname> to merge attribute values where the attribute name is in <varname>names</varname>.
1320+ </para>
1321+
1322+ <variablelist>
1323+ <varlistentry>
1324+ <term>
1325+ <varname>names</varname>
1326+ </term>
1327+ <listitem>
1328+ <para>
1329+ A list of attribute names to zip.
1330+ </para>
1331+ </listitem>
1332+ </varlistentry>
1333+ <varlistentry>
1334+ <term>
1335+ <varname>f</varname>
1336+ </term>
1337+ <listitem>
1338+ <para>
1339+ <literal>(String -> [ Any ] -> Any</literal>
1340+ </para>
1341+ <para>
1342+ Accepts an attribute name, all the values, and returns a combined value.
1343+ </para>
1344+ <variablelist>
1345+ <varlistentry>
1346+ <term>
1347+ <varname>name</varname>
1348+ </term>
1349+ <listitem>
1350+ <para>
1351+ The name of the attribute each value came from.
1352+ </para>
1353+ </listitem>
1354+ </varlistentry>
1355+ <varlistentry>
1356+ <term>
1357+ <varname>vs</varname>
1358+ </term>
1359+ <listitem>
1360+ <para>
1361+ A list of values collected from the list of attribute sets.
1362+ </para>
1363+ </listitem>
1364+ </varlistentry>
1365+ </variablelist>
1366+ </listitem>
1367+ </varlistentry>
1368+ <varlistentry>
1369+ <term>
1370+ <varname>sets</varname>
1371+ </term>
1372+ <listitem>
1373+ <para>
1374+ A list of attribute sets to zip together.
1375+ </para>
1376+ </listitem>
1377+ </varlistentry>
1378+ </variablelist>
1379+
1380+ <example xml:id="function-library-lib.attrsets.zipAttrsWithNames-example">
1381+ <title>Summing a list of attribute sets of numbers</title>
1382+<programlisting><![CDATA[
1383+lib.attrsets.zipAttrsWithNames
1384+ [ "a" "b" ]
1385+ (name: vals: "${name} ${toString (builtins.foldl' (a: b: a + b) 0 vals)}")
1386+ [
1387+ { a = 1; b = 1; c = 1; }
1388+ { a = 10; }
1389+ { b = 100; }
1390+ { c = 1000; }
1391+ ]
1392+=> { a = "a 11"; b = "b 101"; }
1393+ ]]></programlisting>
1394+ </example>
1395+ </section>
1396+
1397+ <section xml:id="function-library-lib.attrsets.zipAttrsWith">
1398+ <title><function>lib.attrsets.zipAttrsWith</function></title>
1399+
1400+ <subtitle><literal>zipAttrsWith :: (String -> [ Any ] -> Any) -> [ AttrSet ] -> AttrSet</literal>
1401+ </subtitle>
1402+
1403+ <xi:include href="./locations.xml" xpointer="lib.attrsets.zipAttrsWith" />
1404+
1405+ <para>
1406+ Merge sets of attributes and use the function <varname>f</varname> to merge attribute values. Similar to <xref
1407+ linkend="function-library-lib.attrsets.zipAttrsWithNames" /> where all key names are passed for <varname>names</varname>.
1408+ </para>
1409+
1410+ <variablelist>
1411+ <varlistentry>
1412+ <term>
1413+ <varname>f</varname>
1414+ </term>
1415+ <listitem>
1416+ <para>
1417+ <literal>(String -> [ Any ] -> Any</literal>
1418+ </para>
1419+ <para>
1420+ Accepts an attribute name, all the values, and returns a combined value.
1421+ </para>
1422+ <variablelist>
1423+ <varlistentry>
1424+ <term>
1425+ <varname>name</varname>
1426+ </term>
1427+ <listitem>
1428+ <para>
1429+ The name of the attribute each value came from.
1430+ </para>
1431+ </listitem>
1432+ </varlistentry>
1433+ <varlistentry>
1434+ <term>
1435+ <varname>vs</varname>
1436+ </term>
1437+ <listitem>
1438+ <para>
1439+ A list of values collected from the list of attribute sets.
1440+ </para>
1441+ </listitem>
1442+ </varlistentry>
1443+ </variablelist>
1444+ </listitem>
1445+ </varlistentry>
1446+ <varlistentry>
1447+ <term>
1448+ <varname>sets</varname>
1449+ </term>
1450+ <listitem>
1451+ <para>
1452+ A list of attribute sets to zip together.
1453+ </para>
1454+ </listitem>
1455+ </varlistentry>
1456+ </variablelist>
1457+
1458+ <example xml:id="function-library-lib.attrsets.zipAttrsWith-example">
1459+ <title>Summing a list of attribute sets of numbers</title>
1460+<programlisting><![CDATA[
1461+lib.attrsets.zipAttrsWith
1462+ (name: vals: "${name} ${toString (builtins.foldl' (a: b: a + b) 0 vals)}")
1463+ [
1464+ { a = 1; b = 1; c = 1; }
1465+ { a = 10; }
1466+ { b = 100; }
1467+ { c = 1000; }
1468+ ]
1469+=> { a = "a 11"; b = "b 101"; c = "c 1001"; }
1470+ ]]></programlisting>
1471+ </example>
1472+ </section>
1473+
1474+ <section xml:id="function-library-lib.attrsets.zipAttrs">
1475+ <title><function>lib.attrsets.zipAttrs</function></title>
1476+
1477+ <subtitle><literal>zipAttrs :: [ AttrSet ] -> AttrSet</literal>
1478+ </subtitle>
1479+
1480+ <xi:include href="./locations.xml" xpointer="lib.attrsets.zipAttrs" />
1481+
1482+ <para>
1483+ Merge sets of attributes and combine each attribute value in to a list. Similar to <xref linkend="function-library-lib.attrsets.zipAttrsWith" /> where the merge function returns a list of all values.
1484+ </para>
1485+
1486+ <variablelist>
1487+ <varlistentry>
1488+ <term>
1489+ <varname>sets</varname>
1490+ </term>
1491+ <listitem>
1492+ <para>
1493+ A list of attribute sets to zip together.
1494+ </para>
1495+ </listitem>
1496+ </varlistentry>
1497+ </variablelist>
1498+
1499+ <example xml:id="function-library-lib.attrsets.zipAttrs-example">
1500+ <title>Combining a list of attribute sets</title>
1501+<programlisting><![CDATA[
1502+lib.attrsets.zipAttrs
1503+ [
1504+ { a = 1; b = 1; c = 1; }
1505+ { a = 10; }
1506+ { b = 100; }
1507+ { c = 1000; }
1508+ ]
1509+=> { a = [ 1 10 ]; b = [ 1 100 ]; c = [ 1 1000 ]; }
1510+ ]]></programlisting>
1511+ </example>
1512+ </section>
1513+
1514+ <section xml:id="function-library-lib.attrsets.recursiveUpdateUntil">
1515+ <title><function>lib.attrsets.recursiveUpdateUntil</function></title>
1516+
1517+ <subtitle><literal>recursiveUpdateUntil :: ( [ String ] -> AttrSet -> AttrSet -> Bool ) -> AttrSet -> AttrSet -> AttrSet</literal>
1518+ </subtitle>
1519+
1520+ <xi:include href="./locations.xml" xpointer="lib.attrsets.recursiveUpdateUntil" />
1521+
1522+ <para>
1523+ Does the same as the update operator <literal>//</literal> except that attributes are merged until the given predicate is verified. The predicate should accept 3 arguments which are the path to reach the attribute, a part of the first attribute set and a part of the second attribute set. When the predicate is verified, the value of the first attribute set is replaced by the value of the second attribute set.
1524+ </para>
1525+
1526+ <variablelist>
1527+ <varlistentry>
1528+ <term>
1529+ <varname>pred</varname>
1530+ </term>
1531+ <listitem>
1532+ <para>
1533+ <literal>[ String ] -> AttrSet -> AttrSet -> Bool</literal>
1534+ </para>
1535+ <variablelist>
1536+ <varlistentry>
1537+ <term>
1538+ <varname>path</varname>
1539+ </term>
1540+ <listitem>
1541+ <para>
1542+ The path to the values in the left and right hand sides.
1543+ </para>
1544+ </listitem>
1545+ </varlistentry>
1546+ <varlistentry>
1547+ <term>
1548+ <varname>l</varname>
1549+ </term>
1550+ <listitem>
1551+ <para>
1552+ The left hand side value.
1553+ </para>
1554+ </listitem>
1555+ </varlistentry>
1556+ <varlistentry>
1557+ <term>
1558+ <varname>r</varname>
1559+ </term>
1560+ <listitem>
1561+ <para>
1562+ The right hand side value.
1563+ </para>
1564+ </listitem>
1565+ </varlistentry>
1566+ </variablelist>
1567+ </listitem>
1568+ </varlistentry>
1569+ <varlistentry>
1570+ <term>
1571+ <varname>lhs</varname>
1572+ </term>
1573+ <listitem>
1574+ <para>
1575+ The left hand attribute set of the merge.
1576+ </para>
1577+ </listitem>
1578+ </varlistentry>
1579+ <varlistentry>
1580+ <term>
1581+ <varname>rhs</varname>
1582+ </term>
1583+ <listitem>
1584+ <para>
1585+ The right hand attribute set of the merge.
1586+ </para>
1587+ </listitem>
1588+ </varlistentry>
1589+ </variablelist>
1590+
1591+ <example xml:id="function-library-lib.attrsets.recursiveUpdateUntil-example">
1592+ <title>Recursively merging two attribute sets</title>
1593+<programlisting><![CDATA[
1594+lib.attrsets.recursiveUpdateUntil (path: l: r: path == ["foo"])
1595+ {
1596+ # first attribute set
1597+ foo.bar = 1;
1598+ foo.baz = 2;
1599+ bar = 3;
1600+ }
1601+ {
1602+ #second attribute set
1603+ foo.bar = 1;
1604+ foo.quz = 2;
1605+ baz = 4;
1606+ }
1607+=> {
1608+ foo.bar = 1; # 'foo.*' from the second set
1609+ foo.quz = 2; #
1610+ bar = 3; # 'bar' from the first set
1611+ baz = 4; # 'baz' from the second set
1612+}
1613+ ]]></programlisting>
1614+ </example>
1615+ </section>
1616+
1617+ <section xml:id="function-library-lib.attrsets.recursiveUpdate">
1618+ <title><function>lib.attrsets.recursiveUpdate</function></title>
1619+
1620+ <subtitle><literal>recursiveUpdate :: AttrSet -> AttrSet -> AttrSet</literal>
1621+ </subtitle>
1622+
1623+ <xi:include href="./locations.xml" xpointer="lib.attrsets.recursiveUpdate" />
1624+
1625+ <para>
1626+ A recursive variant of the update operator <literal>//</literal>. The recursion stops when one of the attribute values is not an attribute set, in which case the right hand side value takes precedence over the left hand side value.
1627+ </para>
1628+
1629+ <variablelist>
1630+ <varlistentry>
1631+ <term>
1632+ <varname>lhs</varname>
1633+ </term>
1634+ <listitem>
1635+ <para>
1636+ The left hand attribute set of the merge.
1637+ </para>
1638+ </listitem>
1639+ </varlistentry>
1640+ <varlistentry>
1641+ <term>
1642+ <varname>rhs</varname>
1643+ </term>
1644+ <listitem>
1645+ <para>
1646+ The right hand attribute set of the merge.
1647+ </para>
1648+ </listitem>
1649+ </varlistentry>
1650+ </variablelist>
1651+
1652+ <example xml:id="function-library-lib.attrsets.recursiveUpdate-example">
1653+ <title>Recursively merging two attribute sets</title>
1654+<programlisting><![CDATA[
1655+recursiveUpdate
1656+ {
1657+ boot.loader.grub.enable = true;
1658+ boot.loader.grub.device = "/dev/hda";
1659+ }
1660+ {
1661+ boot.loader.grub.device = "";
1662+ }
1663+=> {
1664+ boot.loader.grub.enable = true;
1665+ boot.loader.grub.device = "";
1666+}
1667+]]></programlisting>
1668+ </example>
1669+ </section>
1670+
1671+ <section xml:id="function-library-lib.attrsets.recurseIntoAttrs">
1672+ <title><function>lib.attrsets.recurseIntoAttrs</function></title>
1673+
1674+ <subtitle><literal>recurseIntoAttrs :: AttrSet -> AttrSet</literal>
1675+ </subtitle>
1676+
1677+ <xi:include href="./locations.xml" xpointer="lib.attrsets.recurseIntoAttrs" />
1678+
1679+ <para>
1680+ Make various Nix tools consider the contents of the resulting attribute set when looking for what to build, find, etc.
1681+ </para>
1682+
1683+ <para>
1684+ This function only affects a single attribute set; it does not apply itself recursively for nested attribute sets.
1685+ </para>
1686+
1687+ <variablelist>
1688+ <varlistentry>
1689+ <term>
1690+ <varname>attrs</varname>
1691+ </term>
1692+ <listitem>
1693+ <para>
1694+ An attribute set to scan for derivations.
1695+ </para>
1696+ </listitem>
1697+ </varlistentry>
1698+ </variablelist>
1699+
1700+ <example xml:id="function-library-lib.attrsets.recurseIntoAttrs-example">
1701+ <title>Making Nix look inside an attribute set</title>
1702+<programlisting><![CDATA[
1703+{ pkgs ? import <nixpkgs> {} }:
1704+{
1705+ myTools = pkgs.lib.recurseIntoAttrs {
1706+ inherit (pkgs) hello figlet;
1707+ };
1708+}
1709+]]></programlisting>
1710+ </example>
1711+ </section>
1712+
1713+ <section xml:id="function-library-lib.attrsets.cartesianProductOfSets">
1714+ <title><function>lib.attrsets.cartesianProductOfSets</function></title>
1715+
1716+ <subtitle><literal>cartesianProductOfSets :: AttrSet -> [ AttrSet ]</literal>
1717+ </subtitle>
1718+
1719+ <xi:include href="./locations.xml" xpointer="lib.attrsets.cartesianProductOfSets" />
1720+
1721+ <para>
1722+ Return the cartesian product of attribute set value combinations.
1723+ </para>
1724+
1725+ <variablelist>
1726+ <varlistentry>
1727+ <term>
1728+ <varname>set</varname>
1729+ </term>
1730+ <listitem>
1731+ <para>
1732+ An attribute set with attributes that carry lists of values.
1733+ </para>
1734+ </listitem>
1735+ </varlistentry>
1736+ </variablelist>
1737+
1738+ <example xml:id="function-library-lib.attrsets.cartesianProductOfSets-example">
1739+ <title>Creating the cartesian product of a list of attribute values</title>
1740+<programlisting><![CDATA[
1741+cartesianProductOfSets { a = [ 1 2 ]; b = [ 10 20 ]; }
1742+=> [
1743+ { a = 1; b = 10; }
1744+ { a = 1; b = 20; }
1745+ { a = 2; b = 10; }
1746+ { a = 2; b = 20; }
1747+ ]
1748+]]></programlisting>
1749+ </example>
1750+ </section>
1751+</section>
doc/functions/nix-gitignore.section.mdnew file+49
@@ -0,0 +1,49 @@
1+# pkgs.nix-gitignore {#sec-pkgs-nix-gitignore}
2+
3+`pkgs.nix-gitignore` is a function that acts similarly to `builtins.filterSource` but also allows filtering with the help of the gitignore format.
4+
5+## Usage {#sec-pkgs-nix-gitignore-usage}
6+
7+`pkgs.nix-gitignore` exports a number of functions, but you\'ll most likely need either `gitignoreSource` or `gitignoreSourcePure`. As their first argument, they both accept either 1. a file with gitignore lines or 2. a string with gitignore lines, or 3. a list of either of the two. They will be concatenated into a single big string.
8+
9+```nix
10+{ pkgs ? import <nixpkgs> {} }:
11+
12+ nix-gitignore.gitignoreSource [] ./source
13+ # Simplest version
14+
15+ nix-gitignore.gitignoreSource "supplemental-ignores\n" ./source
16+ # This one reads the ./source/.gitignore and concats the auxiliary ignores
17+
18+ nix-gitignore.gitignoreSourcePure "ignore-this\nignore-that\n" ./source
19+ # Use this string as gitignore, don't read ./source/.gitignore.
20+
21+ nix-gitignore.gitignoreSourcePure ["ignore-this\nignore-that\n", ~/.gitignore] ./source
22+ # It also accepts a list (of strings and paths) that will be concatenated
23+ # once the paths are turned to strings via readFile.
24+```
25+
26+These functions are derived from the `Filter` functions by setting the first filter argument to `(_: _: true)`:
27+
28+```nix
29+gitignoreSourcePure = gitignoreFilterSourcePure (_: _: true);
30+gitignoreSource = gitignoreFilterSource (_: _: true);
31+```
32+
33+Those filter functions accept the same arguments the `builtins.filterSource` function would pass to its filters, thus `fn: gitignoreFilterSourcePure fn ""` should be extensionally equivalent to `filterSource`. The file is blacklisted if it\'s blacklisted by either your filter or the gitignoreFilter.
34+
35+If you want to make your own filter from scratch, you may use
36+
37+```nix
38+gitignoreFilter = ign: root: filterPattern (gitignoreToPatterns ign) root;
39+```
40+
41+## gitignore files in subdirectories {#sec-pkgs-nix-gitignore-usage-recursive}
42+
43+If you wish to use a filter that would search for .gitignore files in subdirectories, just like git does by default, use this function:
44+
45+```nix
46+gitignoreFilterRecursiveSource = filter: patterns: root:
47+# OR
48+gitignoreRecursiveSource = gitignoreFilterSourcePure (_: _: true);
49+```
doc/functions/prefer-remote-fetch.section.mdnew file+17
@@ -0,0 +1,17 @@
1+# prefer-remote-fetch overlay {#sec-prefer-remote-fetch}
2+
3+`prefer-remote-fetch` is an overlay that download sources on remote builder. This is useful when the evaluating machine has a slow upload while the builder can fetch faster directly from the source. To use it, put the following snippet as a new overlay:
4+
5+```nix
6+self: super:
7+ (super.prefer-remote-fetch self super)
8+```
9+
10+A full configuration example for that sets the overlay up for your own account, could look like this
11+
12+```ShellSession
13+$ mkdir ~/.config/nixpkgs/overlays/
14+$ cat > ~/.config/nixpkgs/overlays/prefer-remote-fetch.nix <<EOF
15+ self: super: super.prefer-remote-fetch self super
16+EOF
17+```
doc/hooks/index.xmlnew file+10
@@ -0,0 +1,10 @@
1+<chapter xmlns="http://docbook.org/ns/docbook"
2+ xmlns:xlink="http://www.w3.org/1999/xlink"
3+ xmlns:xi="http://www.w3.org/2001/XInclude"
4+ xml:id="chap-hooks">
5+ <title>Hooks reference</title>
6+ <para>
7+ Nixpkgs has several hook packages that augment the stdenv phases.
8+ </para>
9+ <xi:include href="./postgresql-test-hook.section.xml" />
10+</chapter>
doc/hooks/postgresql-test-hook.section.mdnew file+59
@@ -0,0 +1,59 @@
1+
2+# `postgresqlTestHook` {#sec-postgresqlTestHook}
3+
4+This hook starts a PostgreSQL server during the `checkPhase`. Example:
5+
6+```nix
7+{ stdenv, postgresql, postgresqlTestHook }:
8+stdenv.mkDerivation {
9+
10+ # ...
11+
12+ checkInputs = [
13+ postgresql
14+ postgresqlTestHook
15+ ];
16+}
17+```
18+
19+If you use a custom `checkPhase`, remember to add the `runHook` calls:
20+```nix
21+ checkPhase ''
22+ runHook preCheck
23+
24+ # ... your tests
25+
26+ runHook postCheck
27+ ''
28+```
29+
30+## Variables {#sec-postgresqlTestHook-variables}
31+
32+The hook logic will read a number of variables and set them to a default value if unset or empty.
33+
34+Exported variables:
35+
36+ - `PGDATA`: location of server files.
37+ - `PGHOST`: location of UNIX domain socket directory; the default `host` in a connection string.
38+ - `PGUSER`: user to create / log in with, default: `test_user`.
39+ - `PGDATABASE`: database name, default: `test_db`.
40+
41+Bash-only variables:
42+
43+ - `postgresqlTestUserOptions`: SQL options to use when creating the `$PGUSER` role, default: `LOGIN`.
44+ - `postgresqlTestSetupSQL`: SQL commands to run as database administrator after startup, default: statements that create `$PGUSER` and `$PGDATABASE`.
45+ - `postgresqlTestSetupCommands`: bash commands to run after database start, defaults to running `$postgresqlTestSetupSQL` as database administrator.
46+ - `postgresqlEnableTCP`: set to `1` to enable TCP listening. Flaky; not recommended.
47+ - `postgresqlStartCommands`: defaults to `pg_ctl start`.
48+
49+## TCP and the Nix sandbox {#sec-postgresqlTestHook-tcp}
50+
51+`postgresqlEnableTCP` relies on network sandboxing, which is not available on macOS and some custom Nix installations, resulting in flaky tests.
52+For this reason, it is disabled by default.
53+
54+The preferred solution is to make the test suite use a UNIX domain socket connection. This is the default behavior when no `host` connection parameter is provided.
55+Some test suites hardcode a value for `host` though, so a patch may be required. If you can upstream the patch, you can make `host` default to the `PGHOST` environment variable when set. Otherwise, you can patch it locally to omit the `host` connection string parameter altogether.
56+
57+::: {.note}
58+The error `libpq: failed (could not receive data from server: Connection refused` is generally an indication that the test suite is trying to connect through TCP.
59+:::
doc/languages-frameworks/agda.section.mdnew file+256
@@ -0,0 +1,256 @@
1+# Agda {#agda}
2+
3+## How to use Agda {#how-to-use-agda}
4+
5+Agda is available as the [agda](https://search.nixos.org/packages?channel=unstable&show=agda&from=0&size=30&sort=relevance&query=agda)
6+package.
7+
8+The `agda` package installs an Agda-wrapper, which calls `agda` with `--library-file`
9+set to a generated library-file within the nix store, this means your library-file in
10+`$HOME/.agda/libraries` will be ignored. By default the agda package installs Agda
11+with no libraries, i.e. the generated library-file is empty. To use Agda with libraries,
12+the `agda.withPackages` function can be used. This function either takes:
13+
14+* A list of packages,
15+* or a function which returns a list of packages when given the `agdaPackages` attribute set,
16+* or an attribute set containing a list of packages and a GHC derivation for compilation (see below).
17+* or an attribute set containing a function which returns a list of packages when given the `agdaPackages` attribute set and a GHC derivation for compilation (see below).
18+
19+For example, suppose we wanted a version of Agda which has access to the standard library. This can be obtained with the expressions:
20+
21+```nix
22+agda.withPackages [ agdaPackages.standard-library ]
23+```
24+
25+or
26+
27+```nix
28+agda.withPackages (p: [ p.standard-library ])
29+```
30+
31+or can be called as in the [Compiling Agda](#compiling-agda) section.
32+
33+If you want to use a different version of a library (for instance a development version)
34+override the `src` attribute of the package to point to your local repository
35+
36+```nix
37+agda.withPackages (p: [
38+ (p.standard-library.overrideAttrs (oldAttrs: {
39+ version = "local version";
40+ src = /path/to/local/repo/agda-stdlib;
41+ }))
42+])
43+```
44+
45+You can also reference a GitHub repository
46+
47+```nix
48+agda.withPackages (p: [
49+ (p.standard-library.overrideAttrs (oldAttrs: {
50+ version = "1.5";
51+ src = fetchFromGitHub {
52+ repo = "agda-stdlib";
53+ owner = "agda";
54+ rev = "v1.5";
55+ sha256 = "16fcb7ssj6kj687a042afaa2gq48rc8abihpm14k684ncihb2k4w";
56+ };
57+ }))
58+])
59+```
60+
61+If you want to use a library not added to Nixpkgs, you can add a
62+dependency to a local library by calling `agdaPackages.mkDerivation`.
63+
64+```nix
65+agda.withPackages (p: [
66+ (p.mkDerivation {
67+ pname = "your-agda-lib";
68+ version = "1.0.0";
69+ src = /path/to/your-agda-lib;
70+ })
71+])
72+```
73+
74+Again you can reference GitHub
75+
76+```nix
77+agda.withPackages (p: [
78+ (p.mkDerivation {
79+ pname = "your-agda-lib";
80+ version = "1.0.0";
81+ src = fetchFromGitHub {
82+ repo = "repo";
83+ owner = "owner";
84+ version = "...";
85+ rev = "...";
86+ sha256 = "...";
87+ };
88+ })
89+])
90+```
91+
92+See [Building Agda Packages](#building-agda-packages) for more information on `mkDerivation`.
93+
94+Agda will not by default use these libraries. To tell Agda to use a library we have some options:
95+
96+* Call `agda` with the library flag:
97+ ```ShellSession
98+ $ agda -l standard-library -i . MyFile.agda
99+ ```
100+* Write a `my-library.agda-lib` file for the project you are working on which may look like:
101+ ```
102+ name: my-library
103+ include: .
104+ depend: standard-library
105+ ```
106+* Create the file `~/.agda/defaults` and add any libraries you want to use by default.
107+
108+More information can be found in the [official Agda documentation on library management](https://agda.readthedocs.io/en/v2.6.1/tools/package-system.html).
109+
110+## Compiling Agda {#compiling-agda}
111+
112+Agda modules can be compiled using the GHC backend with the `--compile` flag. A version of `ghc` with `ieee754` is made available to the Agda program via the `--with-compiler` flag.
113+This can be overridden by a different version of `ghc` as follows:
114+
115+```nix
116+agda.withPackages {
117+ pkgs = [ ... ];
118+ ghc = haskell.compiler.ghcHEAD;
119+}
120+```
121+
122+## Writing Agda packages {#writing-agda-packages}
123+
124+To write a nix derivation for an Agda library, first check that the library has a `*.agda-lib` file.
125+
126+A derivation can then be written using `agdaPackages.mkDerivation`. This has similar arguments to `stdenv.mkDerivation` with the following additions:
127+
128+* `everythingFile` can be used to specify the location of the `Everything.agda` file, defaulting to `./Everything.agda`. If this file does not exist then either it should be patched in or the `buildPhase` should be overridden (see below).
129+* `libraryName` should be the name that appears in the `*.agda-lib` file, defaulting to `pname`.
130+* `libraryFile` should be the file name of the `*.agda-lib` file, defaulting to `${libraryName}.agda-lib`.
131+
132+Here is an example `default.nix`
133+
134+```nix
135+{ nixpkgs ? <nixpkgs> }:
136+with (import nixpkgs {});
137+agdaPackages.mkDerivation {
138+ version = "1.0";
139+ pname = "my-agda-lib";
140+ src = ./.;
141+ buildInputs = [
142+ agdaPackages.standard-library
143+ ];
144+}
145+```
146+
147+### Building Agda packages {#building-agda-packages}
148+
149+The default build phase for `agdaPackages.mkDerivation` simply runs `agda` on the `Everything.agda` file.
150+If something else is needed to build the package (e.g. `make`) then the `buildPhase` should be overridden.
151+Additionally, a `preBuild` or `configurePhase` can be used if there are steps that need to be done prior to checking the `Everything.agda` file.
152+`agda` and the Agda libraries contained in `buildInputs` are made available during the build phase.
153+
154+### Installing Agda packages {#installing-agda-packages}
155+
156+The default install phase copies Agda source files, Agda interface files (`*.agdai`) and `*.agda-lib` files to the output directory.
157+This can be overridden.
158+
159+By default, Agda sources are files ending on `.agda`, or literate Agda files ending on `.lagda`, `.lagda.tex`, `.lagda.org`, `.lagda.md`, `.lagda.rst`. The list of recognised Agda source extensions can be extended by setting the `extraExtensions` config variable.
160+
161+## Maintaining the Agda package set on Nixpkgs {#maintaining-the-agda-package-set-on-nixpkgs}
162+
163+We are aiming at providing all common Agda libraries as packages on `nixpkgs`,
164+and keeping them up to date.
165+Contributions and maintenance help is always appreciated,
166+but the maintenance effort is typically low since the Agda ecosystem is quite small.
167+
168+The `nixpkgs` Agda package set tries to take up a role similar to that of [Stackage](https://www.stackage.org/) in the Haskell world.
169+It is a curated set of libraries that:
170+
171+1. Always work together.
172+2. Are as up-to-date as possible.
173+
174+While the Haskell ecosystem is huge, and Stackage is highly automatised,
175+the Agda package set is small and can (still) be maintained by hand.
176+
177+### Adding Agda packages to Nixpkgs {#adding-agda-packages-to-nixpkgs}
178+
179+To add an Agda package to `nixpkgs`, the derivation should be written to `pkgs/development/libraries/agda/${library-name}/` and an entry should be added to `pkgs/top-level/agda-packages.nix`. Here it is called in a scope with access to all other Agda libraries, so the top line of the `default.nix` can look like:
180+
181+```nix
182+{ mkDerivation, standard-library, fetchFromGitHub }:
183+```
184+
185+Note that the derivation function is called with `mkDerivation` set to `agdaPackages.mkDerivation`, therefore you
186+could use a similar set as in your `default.nix` from [Writing Agda Packages](#writing-agda-packages) with
187+`agdaPackages.mkDerivation` replaced with `mkDerivation`.
188+
189+Here is an example skeleton derivation for iowa-stdlib:
190+
191+```nix
192+mkDerivation {
193+ version = "1.5.0";
194+ pname = "iowa-stdlib";
195+
196+ src = ...
197+
198+ libraryFile = "";
199+ libraryName = "IAL-1.3";
200+
201+ buildPhase = ''
202+ patchShebangs find-deps.sh
203+ make
204+ '';
205+}
206+```
207+
208+This library has a file called `.agda-lib`, and so we give an empty string to `libraryFile` as nothing precedes `.agda-lib` in the filename. This file contains `name: IAL-1.3`, and so we let `libraryName = "IAL-1.3"`. This library does not use an `Everything.agda` file and instead has a Makefile, so there is no need to set `everythingFile` and we set a custom `buildPhase`.
209+
210+When writing an Agda package it is essential to make sure that no `.agda-lib` file gets added to the store as a single file (for example by using `writeText`). This causes Agda to think that the nix store is a Agda library and it will attempt to write to it whenever it typechecks something. See [https://github.com/agda/agda/issues/4613](https://github.com/agda/agda/issues/4613).
211+
212+In the pull request adding this library,
213+you can test whether it builds correctly by writing in a comment:
214+
215+```
216+@ofborg build agdaPackages.iowa-stdlib
217+```
218+
219+### Maintaining Agda packages
220+
221+As mentioned before, the aim is to have a compatible, and up-to-date package set.
222+These two conditions sometimes exclude each other:
223+For example, if we update `agdaPackages.standard-library` because there was an upstream release,
224+this will typically break many reverse dependencies,
225+i.e. downstream Agda libraries that depend on the standard library.
226+In `nixpkgs` we are typically among the first to notice this,
227+since we have build tests in place to check this.
228+
229+In a pull request updating e.g. the standard library, you should write the following comment:
230+
231+```
232+@ofborg build agdaPackages.standard-library.passthru.tests
233+```
234+
235+This will build all reverse dependencies of the standard library,
236+for example `agdaPackages.agda-categories`, or `agdaPackages.generic`.
237+
238+In some cases it is useful to build _all_ Agda packages.
239+This can be done with the following Github comment:
240+
241+```
242+@ofborg build agda.passthru.tests.allPackages
243+```
244+
245+Sometimes, the builds of the reverse dependencies fail because they have not yet been updated and released.
246+You should drop the maintainers a quick issue notifying them of the breakage,
247+citing the build error (which you can get from the ofborg logs).
248+If you are motivated, you might even send a pull request that fixes it.
249+Usually, the maintainers will answer within a week or two with a new release.
250+Bumping the version of that reverse dependency should be a further commit on your PR.
251+
252+In the rare case that a new release is not to be expected within an acceptable time,
253+simply mark the broken package as broken by setting `meta.broken = true;`.
254+This will exclude it from the build test.
255+It can be added later when it is fixed,
256+and does not hinder the advancement of the whole package set in the meantime.
doc/languages-frameworks/android.section.mdnew file+346
@@ -0,0 +1,346 @@
1+# Android {#android}
2+
3+The Android build environment provides three major features and a number of
4+supporting features.
5+
6+## Deploying an Android SDK installation with plugins {#deploying-an-android-sdk-installation-with-plugins}
7+
8+The first use case is deploying the SDK with a desired set of plugins or subsets
9+of an SDK.
10+
11+```nix
12+with import <nixpkgs> {};
13+
14+let
15+ androidComposition = androidenv.composeAndroidPackages {
16+ toolsVersion = "26.1.1";
17+ platformToolsVersion = "30.0.5";
18+ buildToolsVersions = [ "30.0.3" ];
19+ includeEmulator = false;
20+ emulatorVersion = "30.3.4";
21+ platformVersions = [ "28" "29" "30" ];
22+ includeSources = false;
23+ includeSystemImages = false;
24+ systemImageTypes = [ "google_apis_playstore" ];
25+ abiVersions = [ "armeabi-v7a" "arm64-v8a" ];
26+ cmakeVersions = [ "3.10.2" ];
27+ includeNDK = true;
28+ ndkVersions = ["22.0.7026061"];
29+ useGoogleAPIs = false;
30+ useGoogleTVAddOns = false;
31+ includeExtras = [
32+ "extras;google;gcm"
33+ ];
34+ };
35+in
36+androidComposition.androidsdk
37+```
38+
39+The above function invocation states that we want an Android SDK with the above
40+specified plugin versions. By default, most plugins are disabled. Notable
41+exceptions are the tools, platform-tools and build-tools sub packages.
42+
43+The following parameters are supported:
44+
45+* `toolsVersion`, specifies the version of the tools package to use
46+* `platformsToolsVersion` specifies the version of the `platform-tools` plugin
47+* `buildToolsVersions` specifies the versions of the `build-tools` plugins to
48+ use.
49+* `includeEmulator` specifies whether to deploy the emulator package (`false`
50+ by default). When enabled, the version of the emulator to deploy can be
51+ specified by setting the `emulatorVersion` parameter.
52+* `cmakeVersions` specifies which CMake versions should be deployed.
53+* `includeNDK` specifies that the Android NDK bundle should be included.
54+ Defaults to: `false`.
55+* `ndkVersions` specifies the NDK versions that we want to use. These are linked
56+ under the `ndk` directory of the SDK root, and the first is linked under the
57+ `ndk-bundle` directory.
58+* `ndkVersion` is equivalent to specifying one entry in `ndkVersions`, and
59+ `ndkVersions` overrides this parameter if provided.
60+* `includeExtras` is an array of identifier strings referring to arbitrary
61+ add-on packages that should be installed.
62+* `platformVersions` specifies which platform SDK versions should be included.
63+
64+For each platform version that has been specified, we can apply the following
65+options:
66+
67+* `includeSystemImages` specifies whether a system image for each platform SDK
68+ should be included.
69+* `includeSources` specifies whether the sources for each SDK version should be
70+ included.
71+* `useGoogleAPIs` specifies that for each selected platform version the
72+ Google API should be included.
73+* `useGoogleTVAddOns` specifies that for each selected platform version the
74+ Google TV add-on should be included.
75+
76+For each requested system image we can specify the following options:
77+
78+* `systemImageTypes` specifies what kind of system images should be included.
79+ Defaults to: `default`.
80+* `abiVersions` specifies what kind of ABI version of each system image should
81+ be included. Defaults to: `armeabi-v7a`.
82+
83+Most of the function arguments have reasonable default settings.
84+
85+You can specify license names:
86+
87+* `extraLicenses` is a list of license names.
88+ You can get these names from repo.json or `querypackages.sh licenses`. The SDK
89+ license (`android-sdk-license`) is accepted for you if you set accept_license
90+ to true. If you are doing something like working with preview SDKs, you will
91+ want to add `android-sdk-preview-license` or whichever license applies here.
92+
93+Additionally, you can override the repositories that composeAndroidPackages will
94+pull from:
95+
96+* `repoJson` specifies a path to a generated repo.json file. You can generate this
97+ by running `generate.sh`, which in turn will call into `mkrepo.rb`.
98+* `repoXmls` is an attribute set containing paths to repo XML files. If specified,
99+ it takes priority over `repoJson`, and will trigger a local build writing out a
100+ repo.json to the Nix store based on the given repository XMLs.
101+
102+```nix
103+repoXmls = {
104+ packages = [ ./xml/repository2-1.xml ];
105+ images = [
106+ ./xml/android-sys-img2-1.xml
107+ ./xml/android-tv-sys-img2-1.xml
108+ ./xml/android-wear-sys-img2-1.xml
109+ ./xml/android-wear-cn-sys-img2-1.xml
110+ ./xml/google_apis-sys-img2-1.xml
111+ ./xml/google_apis_playstore-sys-img2-1.xml
112+ ];
113+ addons = [ ./xml/addon2-1.xml ];
114+};
115+```
116+
117+When building the above expression with:
118+
119+```bash
120+$ nix-build
121+```
122+
123+The Android SDK gets deployed with all desired plugin versions.
124+
125+We can also deploy subsets of the Android SDK. For example, to only the
126+`platform-tools` package, you can evaluate the following expression:
127+
128+```nix
129+with import <nixpkgs> {};
130+
131+let
132+ androidComposition = androidenv.composeAndroidPackages {
133+ # ...
134+ };
135+in
136+androidComposition.platform-tools
137+```
138+
139+## Using predefined Android package compositions {#using-predefined-android-package-compositions}
140+
141+In addition to composing an Android package set manually, it is also possible
142+to use a predefined composition that contains all basic packages for a specific
143+Android version, such as version 9.0 (API-level 28).
144+
145+The following Nix expression can be used to deploy the entire SDK with all basic
146+plugins:
147+
148+```nix
149+with import <nixpkgs> {};
150+
151+androidenv.androidPkgs_9_0.androidsdk
152+```
153+
154+It is also possible to use one plugin only:
155+
156+```nix
157+with import <nixpkgs> {};
158+
159+androidenv.androidPkgs_9_0.platform-tools
160+```
161+
162+## Building an Android application {#building-an-android-application}
163+
164+In addition to the SDK, it is also possible to build an Ant-based Android
165+project and automatically deploy all the Android plugins that a project
166+requires.
167+
168+
169+```nix
170+with import <nixpkgs> {};
171+
172+androidenv.buildApp {
173+ name = "MyAndroidApp";
174+ src = ./myappsources;
175+ release = true;
176+
177+ # If release is set to true, you need to specify the following parameters
178+ keyStore = ./keystore;
179+ keyAlias = "myfirstapp";
180+ keyStorePassword = "mykeystore";
181+ keyAliasPassword = "myfirstapp";
182+
183+ # Any Android SDK parameters that install all the relevant plugins that a
184+ # build requires
185+ platformVersions = [ "24" ];
186+
187+ # When we include the NDK, then ndk-build is invoked before Ant gets invoked
188+ includeNDK = true;
189+}
190+```
191+
192+Aside from the app-specific build parameters (`name`, `src`, `release` and
193+keystore parameters), the `buildApp {}` function supports all the function
194+parameters that the SDK composition function (the function shown in the
195+previous section) supports.
196+
197+This build function is particularly useful when it is desired to use
198+[Hydra](https://nixos.org/hydra): the Nix-based continuous integration solution
199+to build Android apps. An Android APK gets exposed as a build product and can be
200+installed on any Android device with a web browser by navigating to the build
201+result page.
202+
203+## Spawning emulator instances {#spawning-emulator-instances}
204+
205+For testing purposes, it can also be quite convenient to automatically generate
206+scripts that spawn emulator instances with all desired configuration settings.
207+
208+An emulator spawn script can be configured by invoking the `emulateApp {}`
209+function:
210+
211+```nix
212+with import <nixpkgs> {};
213+
214+androidenv.emulateApp {
215+ name = "emulate-MyAndroidApp";
216+ platformVersion = "28";
217+ abiVersion = "x86"; # armeabi-v7a, mips, x86_64
218+ systemImageType = "google_apis_playstore";
219+}
220+```
221+
222+Additional flags may be applied to the Android SDK's emulator through the runtime environment variable `$NIX_ANDROID_EMULATOR_FLAGS`.
223+
224+It is also possible to specify an APK to deploy inside the emulator
225+and the package and activity names to launch it:
226+
227+```nix
228+with import <nixpkgs> {};
229+
230+androidenv.emulateApp {
231+ name = "emulate-MyAndroidApp";
232+ platformVersion = "24";
233+ abiVersion = "armeabi-v7a"; # mips, x86, x86_64
234+ systemImageType = "default";
235+ useGoogleAPIs = false;
236+ app = ./MyApp.apk;
237+ package = "MyApp";
238+ activity = "MainActivity";
239+}
240+```
241+
242+In addition to prebuilt APKs, you can also bind the APK parameter to a
243+`buildApp {}` function invocation shown in the previous example.
244+
245+## Notes on environment variables in Android projects {#notes-on-environment-variables-in-android-projects}
246+
247+* `ANDROID_SDK_ROOT` should point to the Android SDK. In your Nix expressions, this should be
248+ `${androidComposition.androidsdk}/libexec/android-sdk`. Note that `ANDROID_HOME` is deprecated,
249+ but if you rely on tools that need it, you can export it too.
250+* `ANDROID_NDK_ROOT` should point to the Android NDK, if you're doing NDK development.
251+ In your Nix expressions, this should be `${ANDROID_SDK_ROOT}/ndk-bundle`.
252+
253+If you are running the Android Gradle plugin, you need to export GRADLE_OPTS to override aapt2
254+to point to the aapt2 binary in the Nix store as well, or use a FHS environment so the packaged
255+aapt2 can run. If you don't want to use a FHS environment, something like this should work:
256+
257+```nix
258+let
259+ buildToolsVersion = "30.0.3";
260+
261+ # Use buildToolsVersion when you define androidComposition
262+ androidComposition = <...>;
263+in
264+pkgs.mkShell rec {
265+ ANDROID_SDK_ROOT = "${androidComposition.androidsdk}/libexec/android-sdk";
266+ ANDROID_NDK_ROOT = "${ANDROID_SDK_ROOT}/ndk-bundle";
267+
268+ # Use the same buildToolsVersion here
269+ GRADLE_OPTS = "-Dorg.gradle.project.android.aapt2FromMavenOverride=${ANDROID_SDK_ROOT}/build-tools/${buildToolsVersion}/aapt2";
270+}
271+```
272+
273+If you are using cmake, you need to add it to PATH in a shell hook or FHS env profile.
274+The path is suffixed with a build number, but properly prefixed with the version.
275+So, something like this should suffice:
276+
277+```nix
278+let
279+ cmakeVersion = "3.10.2";
280+
281+ # Use cmakeVersion when you define androidComposition
282+ androidComposition = <...>;
283+in
284+pkgs.mkShell rec {
285+ ANDROID_SDK_ROOT = "${androidComposition.androidsdk}/libexec/android-sdk";
286+ ANDROID_NDK_ROOT = "${ANDROID_SDK_ROOT}/ndk-bundle";
287+
288+ # Use the same cmakeVersion here
289+ shellHook = ''
290+ export PATH="$(echo "$ANDROID_SDK_ROOT/cmake/${cmakeVersion}".*/bin):$PATH"
291+ '';
292+}
293+```
294+
295+Note that running Android Studio with ANDROID_SDK_ROOT set will automatically write a
296+`local.properties` file with `sdk.dir` set to $ANDROID_SDK_ROOT if one does not already
297+exist. If you are using the NDK as well, you may have to add `ndk.dir` to this file.
298+
299+An example shell.nix that does all this for you is provided in examples/shell.nix.
300+This shell.nix includes a shell hook that overwrites local.properties with the correct
301+sdk.dir and ndk.dir values. This will ensure that the SDK and NDK directories will
302+both be correct when you run Android Studio inside nix-shell.
303+
304+## Notes on improving build.gradle compatibility {#notes-on-improving-build.gradle-compatibility}
305+
306+Ensure that your buildToolsVersion and ndkVersion match what is declared in androidenv.
307+If you are using cmake, make sure its declared version is correct too.
308+
309+Otherwise, you may get cryptic errors from aapt2 and the Android Gradle plugin warning
310+that it cannot install the build tools because the SDK directory is not writeable.
311+
312+```gradle
313+android {
314+ buildToolsVersion "30.0.3"
315+ ndkVersion = "22.0.7026061"
316+ externalNativeBuild {
317+ cmake {
318+ version "3.10.2"
319+ }
320+ }
321+}
322+
323+```
324+
325+## Querying the available versions of each plugin {#querying-the-available-versions-of-each-plugin}
326+
327+repo.json provides all the options in one file now.
328+
329+A shell script in the `pkgs/development/mobile/androidenv/` subdirectory can be used to retrieve all
330+possible options:
331+
332+```bash
333+./querypackages.sh packages
334+```
335+
336+The above command-line instruction queries all package versions in repo.json.
337+
338+## Updating the generated expressions {#updating-the-generated-expressions}
339+
340+repo.json is generated from XML files that the Android Studio package manager uses.
341+To update the expressions run the `generate.sh` script that is stored in the
342+`pkgs/development/mobile/androidenv/` subdirectory:
343+
344+```bash
345+./generate.sh
346+```
doc/languages-frameworks/beam.section.mdnew file+373
@@ -0,0 +1,373 @@
1+# BEAM Languages (Erlang, Elixir & LFE) {#sec-beam}
2+
3+## Introduction {#beam-introduction}
4+
5+In this document and related Nix expressions, we use the term, _BEAM_, to describe the environment. BEAM is the name of the Erlang Virtual Machine and, as far as we're concerned, from a packaging perspective, all languages that run on the BEAM are interchangeable. That which varies, like the build system, is transparent to users of any given BEAM package, so we make no distinction.
6+
7+## Available versions and deprecations schedule {#available-versions-and-deprecations-schedule}
8+
9+### Elixir {#elixir}
10+
11+nixpkgs follows the [official elixir deprecation schedule](https://hexdocs.pm/elixir/compatibility-and-deprecations.html) and keeps the last 5 released versions of Elixir available.
12+
13+## Structure {#beam-structure}
14+
15+All BEAM-related expressions are available via the top-level `beam` attribute, which includes:
16+
17+- `interpreters`: a set of compilers running on the BEAM, including multiple Erlang/OTP versions (`beam.interpreters.erlangR22`, etc), Elixir (`beam.interpreters.elixir`) and LFE (Lisp Flavoured Erlang) (`beam.interpreters.lfe`).
18+
19+- `packages`: a set of package builders (Mix and rebar3), each compiled with a specific Erlang/OTP version, e.g. `beam.packages.erlang22`.
20+
21+The default Erlang compiler, defined by `beam.interpreters.erlang`, is aliased as `erlang`. The default BEAM package set is defined by `beam.packages.erlang` and aliased at the top level as `beamPackages`.
22+
23+To create a package builder built with a custom Erlang version, use the lambda, `beam.packagesWith`, which accepts an Erlang/OTP derivation and produces a package builder similar to `beam.packages.erlang`.
24+
25+Many Erlang/OTP distributions available in `beam.interpreters` have versions with ODBC and/or Java enabled or without wx (no observer support). For example, there's `beam.interpreters.erlangR22_odbc_javac`, which corresponds to `beam.interpreters.erlangR22` and `beam.interpreters.erlangR22_nox`, which corresponds to `beam.interpreters.erlangR22`.
26+
27+## Build Tools {#build-tools}
28+
29+### Rebar3 {#build-tools-rebar3}
30+
31+We provide a version of Rebar3, under `rebar3`. We also provide a helper to fetch Rebar3 dependencies from a lockfile under `fetchRebar3Deps`.
32+
33+We also provide a version on Rebar3 with plugins included, under `rebar3WithPlugins`. This package is a function which takes two arguments: `plugins`, a list of nix derivations to include as plugins (loaded only when specified in `rebar.config`), and `globalPlugins`, which should always be loaded by rebar3. Example: `rebar3WithPlugins { globalPlugins = [beamPackages.pc]; }`.
34+
35+When adding a new plugin it is important that the `packageName` attribute is the same as the atom used by rebar3 to refer to the plugin.
36+
37+### Mix & Erlang.mk {#build-tools-other}
38+
39+Erlang.mk works exactly as expected. There is a bootstrap process that needs to be run, which is supported by the `buildErlangMk` derivation.
40+
41+For Elixir applications use `mixRelease` to make a release. See examples for more details.
42+
43+There is also a `buildMix` helper, whose behavior is closer to that of `buildErlangMk` and `buildRebar3`. The primary difference is that mixRelease makes a release, while buildMix only builds the package, making it useful for libraries and other dependencies.
44+
45+## How to Install BEAM Packages {#how-to-install-beam-packages}
46+
47+BEAM builders are not registered at the top level, simply because they are not relevant to the vast majority of Nix users. To install any of those builders into your profile, refer to them by their attribute path `beamPackages.rebar3`:
48+
49+```ShellSession
50+$ nix-env -f "<nixpkgs>" -iA beamPackages.rebar3
51+```
52+
53+## Packaging BEAM Applications {#packaging-beam-applications}
54+
55+### Erlang Applications {#packaging-erlang-applications}
56+
57+#### Rebar3 Packages {#rebar3-packages}
58+
59+The Nix function, `buildRebar3`, defined in `beam.packages.erlang.buildRebar3` and aliased at the top level, can be used to build a derivation that understands how to build a Rebar3 project.
60+
61+If a package needs to compile native code via Rebar3's port compilation mechanism, add `compilePort = true;` to the derivation.
62+
63+#### Erlang.mk Packages {#erlang-mk-packages}
64+
65+Erlang.mk functions similarly to Rebar3, except we use `buildErlangMk` instead of `buildRebar3`.
66+
67+#### Mix Packages {#mix-packages}
68+
69+`mixRelease` is used to make a release in the mix sense. Dependencies will need to be fetched with `fetchMixDeps` and passed to it.
70+
71+#### mixRelease - Elixir Phoenix example {#mix-release-elixir-phoenix-example}
72+
73+there are 3 steps, frontend dependencies (javascript), backend dependencies (elixir) and the final derivation that puts both of those together
74+
75+##### mixRelease - Frontend dependencies (javascript) {#mix-release-javascript-deps}
76+
77+For phoenix projects, inside of nixpkgs you can either use yarn2nix (mkYarnModule) or node2nix. An example with yarn2nix can be found [here](https://github.com/NixOS/nixpkgs/blob/master/pkgs/servers/web-apps/plausible/default.nix#L39). An example with node2nix will follow. To package something outside of nixpkgs, you have alternatives like [npmlock2nix](https://github.com/nix-community/npmlock2nix) or [nix-npm-buildpackage](https://github.com/serokell/nix-npm-buildpackage)
78+
79+##### mixRelease - backend dependencies (mix) {#mix-release-mix-deps}
80+
81+There are 2 ways to package backend dependencies. With mix2nix and with a fixed-output-derivation (FOD).
82+
83+###### mix2nix {#mix2nix}
84+
85+`mix2nix` is a cli tool available in nixpkgs. it will generate a nix expression from a mix.lock file. It is quite standard in the 2nix tool series.
86+
87+Note that currently mix2nix can't handle git dependencies inside the mix.lock file. If you have git dependencies, you can either add them manually (see [example](https://github.com/NixOS/nixpkgs/blob/master/pkgs/servers/pleroma/default.nix#L20)) or use the FOD method.
88+
89+The advantage of using mix2nix is that nix will know your whole dependency graph. On a dependency update, this won't trigger a full rebuild and download of all the dependencies, where FOD will do so.
90+
91+Practical steps:
92+
93+- run `mix2nix > mix_deps.nix` in the upstream repo.
94+- pass `mixNixDeps = with pkgs; import ./mix_deps.nix { inherit lib beamPackages; };` as an argument to mixRelease.
95+
96+If there are git depencencies.
97+
98+- You'll need to fix the version artificially in mix.exs and regenerate the mix.lock with fixed version (on upstream). This will enable you to run `mix2nix > mix_deps.nix`.
99+- From the mix_deps.nix file, remove the dependencies that had git versions and pass them as an override to the import function.
100+
101+```nix
102+ mixNixDeps = import ./mix.nix {
103+ inherit beamPackages lib;
104+ overrides = (final: prev: {
105+ # mix2nix does not support git dependencies yet,
106+ # so we need to add them manually
107+ prometheus_ex = beamPackages.buildMix rec {
108+ name = "prometheus_ex";
109+ version = "3.0.5";
110+
111+ # Change the argument src with the git src that you actually need
112+ src = fetchFromGitLab {
113+ domain = "git.pleroma.social";
114+ group = "pleroma";
115+ owner = "elixir-libraries";
116+ repo = "prometheus.ex";
117+ rev = "a4e9beb3c1c479d14b352fd9d6dd7b1f6d7deee5";
118+ sha256 = "1v0q4bi7sb253i8q016l7gwlv5562wk5zy3l2sa446csvsacnpjk";
119+ };
120+ # you can re-use the same beamDeps argument as generated
121+ beamDeps = with final; [ prometheus ];
122+ };
123+ });
124+};
125+```
126+
127+You will need to run the build process once to fix the sha256 to correspond to your new git src.
128+
129+###### FOD {#fixed-output-derivation}
130+
131+A fixed output derivation will download mix dependencies from the internet. To ensure reproducibility, a hash will be supplied. Note that mix is relatively reproducible. An FOD generating a different hash on each run hasn't been observed (as opposed to npm where the chances are relatively high). See [elixir_ls](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/beam-modules/elixir_ls.nix) for a usage example of FOD.
132+
133+Practical steps
134+
135+- start with the following argument to mixRelease
136+
137+```nix
138+ mixFodDeps = fetchMixDeps {
139+ pname = "mix-deps-${pname}";
140+ inherit src version;
141+ sha256 = lib.fakeSha256;
142+ };
143+```
144+
145+The first build will complain about the sha256 value, you can replace with the suggested value after that.
146+
147+Note that if after you've replaced the value, nix suggests another sha256, then mix is not fetching the dependencies reproducibly. An FOD will not work in that case and you will have to use mix2nix.
148+
149+##### mixRelease - example {#mix-release-example}
150+
151+Here is how your `default.nix` file would look for a phoenix project.
152+
153+```nix
154+with import <nixpkgs> { };
155+
156+let
157+ # beam.interpreters.erlangR23 is available if you need a particular version
158+ packages = beam.packagesWith beam.interpreters.erlang;
159+
160+ pname = "your_project";
161+ version = "0.0.1";
162+
163+ src = builtins.fetchgit {
164+ url = "ssh://git@github.com/your_id/your_repo";
165+ rev = "replace_with_your_commit";
166+ };
167+
168+ # if using mix2nix you can use the mixNixDeps attribute
169+ mixFodDeps = packages.fetchMixDeps {
170+ pname = "mix-deps-${pname}";
171+ inherit src version;
172+ # nix will complain and tell you the right value to replace this with
173+ sha256 = lib.fakeSha256;
174+ # if you have build time environment variables add them here
175+ MY_ENV_VAR="my_value";
176+ };
177+
178+ nodeDependencies = (pkgs.callPackage ./assets/default.nix { }).shell.nodeDependencies;
179+
180+in packages.mixRelease {
181+ inherit src pname version mixFodDeps;
182+ # if you have build time environment variables add them here
183+ MY_ENV_VAR="my_value";
184+
185+ postBuild = ''
186+ ln -sf ${nodeDependencies}/lib/node_modules assets/node_modules
187+ npm run deploy --prefix ./assets
188+
189+ # for external task you need a workaround for the no deps check flag
190+ # https://github.com/phoenixframework/phoenix/issues/2690
191+ mix do deps.loadpaths --no-deps-check, phx.digest
192+ mix phx.digest --no-deps-check
193+ '';
194+}
195+```
196+
197+Setup will require the following steps:
198+
199+- Move your secrets to runtime environment variables. For more information refer to the [runtime.exs docs](https://hexdocs.pm/mix/Mix.Tasks.Release.html#module-runtime-configuration). On a fresh Phoenix build that would mean that both `DATABASE_URL` and `SECRET_KEY` need to be moved to `runtime.exs`.
200+- `cd assets` and `nix-shell -p node2nix --run node2nix --development` will generate a Nix expression containing your frontend dependencies
201+- commit and push those changes
202+- you can now `nix-build .`
203+- To run the release, set the `RELEASE_TMP` environment variable to a directory that your program has write access to. It will be used to store the BEAM settings.
204+
205+#### Example of creating a service for an Elixir - Phoenix project {#example-of-creating-a-service-for-an-elixir---phoenix-project}
206+
207+In order to create a service with your release, you could add a `service.nix`
208+in your project with the following
209+
210+```nix
211+{config, pkgs, lib, ...}:
212+
213+let
214+ release = pkgs.callPackage ./default.nix;
215+ release_name = "app";
216+ working_directory = "/home/app";
217+in
218+{
219+ systemd.services.${release_name} = {
220+ wantedBy = [ "multi-user.target" ];
221+ after = [ "network.target" "postgresql.service" ];
222+ # note that if you are connecting to a postgres instance on a different host
223+ # postgresql.service should not be included in the requires.
224+ requires = [ "network-online.target" "postgresql.service" ];
225+ description = "my app";
226+ environment = {
227+ # RELEASE_TMP is used to write the state of the
228+ # VM configuration when the system is running
229+ # it needs to be a writable directory
230+ RELEASE_TMP = working_directory;
231+ # can be generated in an elixir console with
232+ # Base.encode32(:crypto.strong_rand_bytes(32))
233+ RELEASE_COOKIE = "my_cookie";
234+ MY_VAR = "my_var";
235+ };
236+ serviceConfig = {
237+ Type = "exec";
238+ DynamicUser = true;
239+ WorkingDirectory = working_directory;
240+ # Implied by DynamicUser, but just to emphasize due to RELEASE_TMP
241+ PrivateTmp = true;
242+ ExecStart = ''
243+ ${release}/bin/${release_name} start
244+ '';
245+ ExecStop = ''
246+ ${release}/bin/${release_name} stop
247+ '';
248+ ExecReload = ''
249+ ${release}/bin/${release_name} restart
250+ '';
251+ Restart = "on-failure";
252+ RestartSec = 5;
253+ StartLimitBurst = 3;
254+ StartLimitInterval = 10;
255+ };
256+ # disksup requires bash
257+ path = [ pkgs.bash ];
258+ };
259+
260+ # in case you have migration scripts or you want to use a remote shell
261+ environment.systemPackages = [ release ];
262+}
263+```
264+
265+## How to Develop {#how-to-develop}
266+
267+### Creating a Shell {#creating-a-shell}
268+
269+Usually, we need to create a `shell.nix` file and do our development inside of the environment specified therein. Just install your version of Erlang and any other interpreters, and then use your normal build tools. As an example with Elixir:
270+
271+```nix
272+{ pkgs ? import <nixpkgs> {} }:
273+
274+with pkgs;
275+let
276+ elixir = beam.packages.erlangR24.elixir_1_12;
277+in
278+mkShell {
279+ buildInputs = [ elixir ];
280+}
281+```
282+
283+### Using an overlay
284+
285+If you need to use an overlay to change some attributes of a derivation, e.g. if you need a bugfix from a version that is not yet available in nixpkgs, you can override attributes such as `version` (and the corresponding `sha256`) and then use this overlay in your development environment:
286+
287+#### `shell.nix`
288+
289+```nix
290+let
291+ elixir_1_13_1_overlay = (self: super: {
292+ elixir_1_13 = super.elixir_1_13.override {
293+ version = "1.13.1";
294+ sha256 = "0z0b1w2vvw4vsnb99779c2jgn9bgslg7b1pmd9vlbv02nza9qj5p";
295+ };
296+ });
297+ pkgs = import <nixpkgs> { overlays = [ elixir_1_13_1_overlay ]; };
298+in
299+with pkgs;
300+mkShell {
301+ buildInputs = [
302+ elixir_1_13
303+ ];
304+}
305+```
306+
307+#### Elixir - Phoenix project {#elixir---phoenix-project}
308+
309+Here is an example `shell.nix`.
310+
311+```nix
312+with import <nixpkgs> { };
313+
314+let
315+ # define packages to install
316+ basePackages = [
317+ git
318+ # replace with beam.packages.erlang.elixir_1_13 if you need
319+ beam.packages.erlang.elixir
320+ nodejs
321+ postgresql_14
322+ # only used for frontend dependencies
323+ # you are free to use yarn2nix as well
324+ nodePackages.node2nix
325+ # formatting js file
326+ nodePackages.prettier
327+ ];
328+
329+ inputs = basePackages ++ lib.optionals stdenv.isLinux [ inotify-tools ]
330+ ++ lib.optionals stdenv.isDarwin
331+ (with darwin.apple_sdk.frameworks; [ CoreFoundation CoreServices ]);
332+
333+ # define shell startup command
334+ hooks = ''
335+ # this allows mix to work on the local directory
336+ mkdir -p .nix-mix .nix-hex
337+ export MIX_HOME=$PWD/.nix-mix
338+ export HEX_HOME=$PWD/.nix-mix
339+ # make hex from Nixpkgs available
340+ # `mix local.hex` will install hex into MIX_HOME and should take precedence
341+ export MIX_PATH="${beam.packages.erlang.hex}/lib/erlang/lib/hex/ebin"
342+ export PATH=$MIX_HOME/bin:$HEX_HOME/bin:$PATH
343+ export LANG=C.UTF-8
344+ # keep your shell history in iex
345+ export ERL_AFLAGS="-kernel shell_history enabled"
346+
347+ # postges related
348+ # keep all your db data in a folder inside the project
349+ export PGDATA="$PWD/db"
350+
351+ # phoenix related env vars
352+ export POOL_SIZE=15
353+ export DB_URL="postgresql://postgres:postgres@localhost:5432/db"
354+ export PORT=4000
355+ export MIX_ENV=dev
356+ # add your project env vars here, word readable in the nix store.
357+ export ENV_VAR="your_env_var"
358+ '';
359+
360+in mkShell {
361+ buildInputs = inputs;
362+ shellHook = hooks;
363+}
364+```
365+
366+Initializing the project will require the following steps:
367+
368+- create the db directory `initdb ./db` (inside your mix project folder)
369+- create the postgres user `createuser postgres -ds`
370+- create the db `createdb db`
371+- start the postgres instance `pg_ctl -l "$PGDATA/server.log" start`
372+- add the `/db` folder to your `.gitignore`
373+- you can start your phoenix server and get a shell with `iex -S mix phx.server`
doc/languages-frameworks/bower.section.mdnew file+158
@@ -0,0 +1,158 @@
1+# Bower {#sec-bower}
2+
3+[Bower](https://bower.io) is a package manager for web site front-end components. Bower packages (comprising of build artefacts and sometimes sources) are stored in `git` repositories, typically on Github. The package registry is run by the Bower team with package metadata coming from the `bower.json` file within each package.
4+
5+The end result of running Bower is a `bower_components` directory which can be included in the web app's build process.
6+
7+Bower can be run interactively, by installing `nodePackages.bower`. More interestingly, the Bower components can be declared in a Nix derivation, with the help of `nodePackages.bower2nix`.
8+
9+## bower2nix usage {#ssec-bower2nix-usage}
10+
11+Suppose you have a `bower.json` with the following contents:
12+
13+### Example bower.json {#ex-bowerJson}
14+
15+```json
16+ "name": "my-web-app",
17+ "dependencies": {
18+ "angular": "~1.5.0",
19+ "bootstrap": "~3.3.6"
20+ }
21+```
22+
23+Running `bower2nix` will produce something like the following output:
24+
25+```nix
26+{ fetchbower, buildEnv }:
27+buildEnv { name = "bower-env"; ignoreCollisions = true; paths = [
28+ (fetchbower "angular" "1.5.3" "~1.5.0" "1749xb0firxdra4rzadm4q9x90v6pzkbd7xmcyjk6qfza09ykk9y")
29+ (fetchbower "bootstrap" "3.3.6" "~3.3.6" "1vvqlpbfcy0k5pncfjaiskj3y6scwifxygfqnw393sjfxiviwmbv")
30+ (fetchbower "jquery" "2.2.2" "1.9.1 - 2" "10sp5h98sqwk90y4k6hbdviwqzvzwqf47r3r51pakch5ii2y7js1")
31+];
32+```
33+
34+Using the `bower2nix` command line arguments, the output can be redirected to a file. A name like `bower-packages.nix` would be fine.
35+
36+The resulting derivation is a union of all the downloaded Bower packages (and their dependencies). To use it, they still need to be linked together by Bower, which is where `buildBowerComponents` is useful.
37+
38+## buildBowerComponents function {#ssec-build-bower-components}
39+
40+The function is implemented in [pkgs/development/bower-modules/generic/default.nix](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/bower-modules/generic/default.nix).
41+
42+### Example buildBowerComponents {#ex-buildBowerComponents}
43+
44+```{=docbook}
45+<programlisting language="nix">
46+bowerComponents = buildBowerComponents {
47+ name = "my-web-app";
48+ generated = ./bower-packages.nix; <co xml:id="ex-buildBowerComponents-1" />
49+ src = myWebApp; <co xml:id="ex-buildBowerComponents-2" />
50+};
51+</programlisting>
52+```
53+
54+In ["buildBowerComponents" example](#ex-buildBowerComponents) the following arguments are of special significance to the function:
55+
56+```{=docbook}
57+<calloutlist>
58+ <callout arearefs="ex-buildBowerComponents-1">
59+ <para>
60+ <varname>generated</varname> specifies the file which was created by <command>bower2nix</command>.
61+ </para>
62+ </callout>
63+ <callout arearefs="ex-buildBowerComponents-2">
64+ <para>
65+ <varname>src</varname> is your project's sources. It needs to contain a <filename>bower.json</filename> file.
66+ </para>
67+ </callout>
68+</calloutlist>
69+```
70+
71+`buildBowerComponents` will run Bower to link together the output of `bower2nix`, resulting in a `bower_components` directory which can be used.
72+
73+Here is an example of a web frontend build process using `gulp`. You might use `grunt`, or anything else.
74+
75+### Example build script (gulpfile.js) {#ex-bowerGulpFile}
76+
77+```javascript
78+var gulp = require('gulp');
79+
80+gulp.task('default', [], function () {
81+ gulp.start('build');
82+});
83+
84+gulp.task('build', [], function () {
85+ console.log("Just a dummy gulp build");
86+ gulp
87+ .src(["./bower_components/**/*"])
88+ .pipe(gulp.dest("./gulpdist/"));
89+});
90+```
91+
92+### Example Full example — default.nix {#ex-buildBowerComponentsDefaultNix}
93+
94+```{=docbook}
95+<programlisting language="nix">
96+{ myWebApp ? { outPath = ./.; name = "myWebApp"; }
97+, pkgs ? import <nixpkgs> {}
98+}:
99+
100+pkgs.stdenv.mkDerivation {
101+ name = "my-web-app-frontend";
102+ src = myWebApp;
103+
104+ buildInputs = [ pkgs.nodePackages.gulp ];
105+
106+ bowerComponents = pkgs.buildBowerComponents { <co xml:id="ex-buildBowerComponentsDefault-1" />
107+ name = "my-web-app";
108+ generated = ./bower-packages.nix;
109+ src = myWebApp;
110+ };
111+
112+ buildPhase = ''
113+ cp --reflink=auto --no-preserve=mode -R $bowerComponents/bower_components . <co xml:id="ex-buildBowerComponentsDefault-2" />
114+ export HOME=$PWD <co xml:id="ex-buildBowerComponentsDefault-3" />
115+ ${pkgs.nodePackages.gulp}/bin/gulp build <co xml:id="ex-buildBowerComponentsDefault-4" />
116+ '';
117+
118+ installPhase = "mv gulpdist $out";
119+}
120+</programlisting>
121+```
122+
123+A few notes about [Full example — `default.nix`](#ex-buildBowerComponentsDefaultNix):
124+
125+```{=docbook}
126+<calloutlist>
127+ <callout arearefs="ex-buildBowerComponentsDefault-1">
128+ <para>
129+ The result of <varname>buildBowerComponents</varname> is an input to the frontend build.
130+ </para>
131+ </callout>
132+ <callout arearefs="ex-buildBowerComponentsDefault-2">
133+ <para>
134+ Whether to symlink or copy the <filename>bower_components</filename> directory depends on the build tool in use. In this case a copy is used to avoid <command>gulp</command> silliness with permissions.
135+ </para>
136+ </callout>
137+ <callout arearefs="ex-buildBowerComponentsDefault-3">
138+ <para>
139+ <command>gulp</command> requires <varname>HOME</varname> to refer to a writeable directory.
140+ </para>
141+ </callout>
142+ <callout arearefs="ex-buildBowerComponentsDefault-4">
143+ <para>
144+ The actual build command. Other tools could be used.
145+ </para>
146+ </callout>
147+</calloutlist>
148+```
149+
150+## Troubleshooting {#ssec-bower2nix-troubleshooting}
151+
152+### ENOCACHE errors from buildBowerComponents {#enocache-errors-from-buildbowercomponents}
153+
154+This means that Bower was looking for a package version which doesn't exist in the generated `bower-packages.nix`.
155+
156+If `bower.json` has been updated, then run `bower2nix` again.
157+
158+It could also be a bug in `bower2nix` or `fetchbower`. If possible, try reformulating the version specification in `bower.json`.
doc/languages-frameworks/chicken.section.mdnew file+49
@@ -0,0 +1,49 @@
1+# CHICKEN {#sec-chicken}
2+
3+[CHICKEN](https://call-cc.org/) is a
4+[R⁵RS](https://schemers.org/Documents/Standards/R5RS/HTML/)-compliant Scheme
5+compiler. It includes an interactive mode and a custom package format, "eggs".
6+
7+## Using Eggs
8+
9+Eggs described in nixpkgs are available inside the
10+`chickenPackages.chickenEggs` attrset. Including an egg as a build input is
11+done in the typical Nix fashion. For example, to include support for [SRFI
12+189](https://srfi.schemers.org/srfi-189/srfi-189.html) in a derivation, one
13+might write:
14+
15+```nix
16+ buildInputs = [
17+ chicken
18+ chickenPackages.chickenEggs.srfi-189
19+ ];
20+```
21+
22+Both `chicken` and its eggs have a setup hook which configures the environment
23+variables `CHICKEN_INCLUDE_PATH` and `CHICKEN_REPOSITORY_PATH`.
24+
25+## Updating Eggs
26+
27+nixpkgs only knows about a subset of all published eggs. It uses
28+[egg2nix](https://github.com/the-kenny/egg2nix) to generate a
29+package set from a list of eggs to include.
30+
31+The package set is regenerated by running the following shell commands:
32+
33+```
34+$ nix-shell -p chickenPackages.egg2nix
35+$ cd pkgs/development/compilers/chicken/5/
36+$ egg2nix eggs.scm > eggs.nix
37+```
38+
39+## Adding Eggs
40+
41+When we run `egg2nix`, we obtain one collection of eggs with
42+mutually-compatible versions. This means that when we add new eggs, we may
43+need to update existing eggs. To keep those separate, follow the procedure for
44+updating eggs before including more eggs.
45+
46+To include more eggs, edit `pkgs/development/compilers/chicken/5/eggs.scm`.
47+The first section of this file lists eggs which are required by `egg2nix`
48+itself; all other eggs go into the second section. After editing, follow the
49+procedure for updating eggs.
doc/languages-frameworks/coq.section.mdnew file+83
@@ -0,0 +1,83 @@
1+# Coq and coq packages {#sec-language-coq}
2+
3+## Coq derivation: `coq` {#coq-derivation-coq}
4+
5+The Coq derivation is overridable through the `coq.override overrides`, where overrides is an attribute set which contains the arguments to override. We recommend overriding either of the following
6+
7+* `version` (optional, defaults to the latest version of Coq selected for nixpkgs, see `pkgs/top-level/coq-packages` to witness this choice), which follows the conventions explained in the `coqPackages` section below,
8+* `customOCamlPackage` (optional, defaults to `null`, which lets Coq choose a version automatically), which can be set to any of the ocaml packages attribute of `ocaml-ng` (such as `ocaml-ng.ocamlPackages_4_10` which is the default for Coq 8.11 for example).
9+* `coq-version` (optional, defaults to the short version e.g. "8.10"), is a version number of the form "x.y" that indicates which Coq's version build behavior to mimic when using a source which is not a release. E.g. `coq.override { version = "d370a9d1328a4e1cdb9d02ee032f605a9d94ec7a"; coq-version = "8.10"; }`.
10+
11+## Coq packages attribute sets: `coqPackages` {#coq-packages-attribute-sets-coqpackages}
12+
13+The recommended way of defining a derivation for a Coq library, is to use the `coqPackages.mkCoqDerivation` function, which is essentially a specialization of `mkDerivation` taking into account most of the specifics of Coq libraries. The following attributes are supported:
14+
15+* `pname` (required) is the name of the package,
16+* `version` (optional, defaults to `null`), is the version to fetch and build,
17+ this attribute is interpreted in several ways depending on its type and pattern:
18+ * if it is a known released version string, i.e. from the `release` attribute below, the according release is picked, and the `version` attribute of the resulting derivation is set to this release string,
19+ * if it is a majorMinor `"x.y"` prefix of a known released version (as defined above), then the latest `"x.y.z"` known released version is selected (for the ordering given by `versionAtLeast`),
20+ * if it is a path or a string representing an absolute path (i.e. starting with `"/"`), the provided path is selected as a source, and the `version` attribute of the resulting derivation is set to `"dev"`,
21+ * if it is a string of the form `owner:branch` then it tries to download the `branch` of owner `owner` for a project of the same name using the same vcs, and the `version` attribute of the resulting derivation is set to `"dev"`, additionally if the owner is not provided (i.e. if the `owner:` prefix is missing), it defaults to the original owner of the package (see below),
22+ * if it is a string of the form `"#N"`, and the domain is github, then it tries to download the current head of the pull request `#N` from github,
23+* `defaultVersion` (optional). Coq libraries may be compatible with some specific versions of Coq only. The `defaultVersion` attribute is used when no `version` is provided (or if `version = null`) to select the version of the library to use by default, depending on the context. This selection will mainly depend on a `coq` version number but also possibly on other packages versions (e.g. `mathcomp`). If its value ends up to be `null`, the package is marked for removal in end-user `coqPackages` attribute set.
24+* `release` (optional, defaults to `{}`), lists all the known releases of the library and for each of them provides an attribute set with at least a `sha256` attribute (you may put the empty string `""` in order to automatically insert a fake sha256, this will trigger an error which will allow you to find the correct sha256), each attribute set of the list of releases also takes optional overloading arguments for the fetcher as below (i.e.`domain`, `owner`, `repo`, `rev` assuming the default fetcher is used) and optional overrides for the result of the fetcher (i.e. `version` and `src`).
25+* `fetcher` (optional, defaults to a generic fetching mechanism supporting github or gitlab based infrastructures), is a function that takes at least an `owner`, a `repo`, a `rev`, and a `sha256` and returns an attribute set with a `version` and `src`.
26+* `repo` (optional, defaults to the value of `pname`),
27+* `owner` (optional, defaults to `"coq-community"`).
28+* `domain` (optional, defaults to `"github.com"`), domains including the strings `"github"` or `"gitlab"` in their names are automatically supported, otherwise, one must change the `fetcher` argument to support them (cf `pkgs/development/coq-modules/heq/default.nix` for an example),
29+* `releaseRev` (optional, defaults to `(v: v)`), provides a default mapping from release names to revision hashes/branch names/tags,
30+* `displayVersion` (optional), provides a way to alter the computation of `name` from `pname`, by explaining how to display version numbers,
31+* `namePrefix` (optional, defaults to `[ "coq" ]`), provides a way to alter the computation of `name` from `pname`, by explaining which dependencies must occur in `name`,
32+* `extraNativeBuildInputs` (optional), by default `nativeBuildInputs` just contains `coq`, this allows to add more native build inputs, `nativeBuildInputs` are executables and `buildInputs` are libraries and dependencies,
33+* `extraBuildInputs` (optional), this allows to add more build inputs,
34+* `mlPlugin` (optional, defaults to `false`). Some extensions (plugins) might require OCaml and sometimes other OCaml packages. Standard dependencies can be added by setting the current option to `true`. For a finer grain control, the `coq.ocamlPackages` attribute can be used in `extraBuildInputs` to depend on the same package set Coq was built against.
35+* `useDune2ifVersion` (optional, default to `(x: false)` uses Dune2 to build the package if the provided predicate evaluates to true on the version, e.g. `useDune2if = versions.isGe "1.1"` will use dune if the version of the package is greater or equal to `"1.1"`,
36+* `useDune2` (optional, defaults to `false`) uses Dune2 to build the package if set to true, the presence of this attribute overrides the behavior of the previous one.
37+* `opam-name` (optional, defaults to concatenating with a dash separator the components of `namePrefix` and `pname`), name of the Dune package to build.
38+* `enableParallelBuilding` (optional, defaults to `true`), since it is activated by default, we provide a way to disable it.
39+* `extraInstallFlags` (optional), allows to extend `installFlags` which initializes the variable `COQMF_COQLIB` so as to install in the proper subdirectory. Indeed Coq libraries should be installed in `$(out)/lib/coq/${coq.coq-version}/user-contrib/`. Such directories are automatically added to the `$COQPATH` environment variable by the hook defined in the Coq derivation.
40+* `setCOQBIN` (optional, defaults to `true`), by default, the environment variable `$COQBIN` is set to the current Coq's binary, but one can disable this behavior by setting it to `false`,
41+* `useMelquiondRemake` (optional, default to `null`) is an attribute set, which, if given, overloads the `preConfigurePhases`, `configureFlags`, `buildPhase`, and `installPhase` attributes of the derivation for a specific use in libraries using `remake` as set up by Guillaume Melquiond for `flocq`, `gappalib`, `interval`, and `coquelicot` (see the corresponding derivation for concrete examples of use of this option). For backward compatibility, the attribute `useMelquiondRemake.logpath` must be set to the logical root of the library (otherwise, one can pass `useMelquiondRemake = {}` to activate this without backward compatibility).
42+* `dropAttrs`, `keepAttrs`, `dropDerivationAttrs` are all optional and allow to tune which attribute is added or removed from the final call to `mkDerivation`.
43+
44+It also takes other standard `mkDerivation` attributes, they are added as such, except for `meta` which extends an automatically computed `meta` (where the `platform` is the same as `coq` and the homepage is automatically computed).
45+
46+Here is a simple package example. It is a pure Coq library, thus it depends on Coq. It builds on the Mathematical Components library, thus it also takes some `mathcomp` derivations as `extraBuildInputs`.
47+
48+```nix
49+{ lib, mkCoqDerivation, version ? null
50+, coq, mathcomp, mathcomp-finmap, mathcomp-bigenough }:
51+with lib; mkCoqDerivation {
52+ /* namePrefix leads to e.g. `name = coq8.11-mathcomp1.11-multinomials-1.5.2` */
53+ namePrefix = [ "coq" "mathcomp" ];
54+ pname = "multinomials";
55+ owner = "math-comp";
56+ inherit version;
57+ defaultVersion = with versions; switch [ coq.version mathcomp.version ] [
58+ { cases = [ (range "8.7" "8.12") "1.11.0" ]; out = "1.5.2"; }
59+ { cases = [ (range "8.7" "8.11") (range "1.8" "1.10") ]; out = "1.5.0"; }
60+ { cases = [ (range "8.7" "8.10") (range "1.8" "1.10") ]; out = "1.4"; }
61+ { cases = [ "8.6" (range "1.6" "1.7") ]; out = "1.1"; }
62+ ] null;
63+ release = {
64+ "1.5.2".sha256 = "15aspf3jfykp1xgsxf8knqkxv8aav2p39c2fyirw7pwsfbsv2c4s";
65+ "1.5.1".sha256 = "13nlfm2wqripaq671gakz5mn4r0xwm0646araxv0nh455p9ndjs3";
66+ "1.5.0".sha256 = "064rvc0x5g7y1a0nip6ic91vzmq52alf6in2bc2dmss6dmzv90hw";
67+ "1.5.0".rev = "1.5";
68+ "1.4".sha256 = "0vnkirs8iqsv8s59yx1fvg1nkwnzydl42z3scya1xp1b48qkgn0p";
69+ "1.3".sha256 = "0l3vi5n094nx3qmy66hsv867fnqm196r8v605kpk24gl0aa57wh4";
70+ "1.2".sha256 = "1mh1w339dslgv4f810xr1b8v2w7rpx6fgk9pz96q0fyq49fw2xcq";
71+ "1.1".sha256 = "1q8alsm89wkc0lhcvxlyn0pd8rbl2nnxg81zyrabpz610qqjqc3s";
72+ "1.0".sha256 = "1qmbxp1h81cy3imh627pznmng0kvv37k4hrwi2faa101s6bcx55m";
73+ };
74+
75+ propagatedBuildInputs =
76+ [ mathcomp.ssreflect mathcomp.algebra mathcomp-finmap mathcomp-bigenough ];
77+
78+ meta = {
79+ description = "A Coq/SSReflect Library for Monoidal Rings and Multinomials";
80+ license = licenses.cecill-c;
81+ };
82+}
83+```
doc/languages-frameworks/crystal.section.mdnew file+73
@@ -0,0 +1,73 @@
1+# Crystal {#crystal}
2+
3+## Building a Crystal package {#building-a-crystal-package}
4+
5+This section uses [Mint](https://github.com/mint-lang/mint) as an example for how to build a Crystal package.
6+
7+If the Crystal project has any dependencies, the first step is to get a `shards.nix` file encoding those. Get a copy of the project and go to its root directory such that its `shard.lock` file is in the current directory. Executable projects should usually commit the `shard.lock` file, but sometimes that's not the case, which means you need to generate it yourself. With an existing `shard.lock` file, `crystal2nix` can be run.
8+```bash
9+$ git clone https://github.com/mint-lang/mint
10+$ cd mint
11+$ git checkout 0.5.0
12+$ if [ ! -f shard.lock ]; then nix-shell -p shards --run "shards lock"; fi
13+$ nix-shell -p crystal2nix --run crystal2nix
14+```
15+
16+This should have generated a `shards.nix` file.
17+
18+Next create a Nix file for your derivation and use `pkgs.crystal.buildCrystalPackage` as follows:
19+
20+```nix
21+with import <nixpkgs> {};
22+crystal.buildCrystalPackage rec {
23+ pname = "mint";
24+ version = "0.5.0";
25+
26+ src = fetchFromGitHub {
27+ owner = "mint-lang";
28+ repo = "mint";
29+ rev = version;
30+ sha256 = "0vxbx38c390rd2ysvbwgh89v2232sh5rbsp3nk9wzb70jybpslvl";
31+ };
32+
33+ # Insert the path to your shards.nix file here
34+ shardsFile = ./shards.nix;
35+
36+ ...
37+}
38+```
39+
40+This won't build anything yet, because we haven't told it what files build. We can specify a mapping from binary names to source files with the `crystalBinaries` attribute. The project's compilation instructions should show this. For Mint, the binary is called "mint", which is compiled from the source file `src/mint.cr`, so we'll specify this as follows:
41+
42+```nix
43+ crystalBinaries.mint.src = "src/mint.cr";
44+
45+ # ...
46+```
47+
48+Additionally you can override the default `crystal build` options (which are currently `--release --progress --no-debug --verbose`) with
49+
50+```nix
51+ crystalBinaries.mint.options = [ "--release" "--verbose" ];
52+```
53+
54+Depending on the project, you might need additional steps to get it to compile successfully. In Mint's case, we need to link against openssl, so in the end the Nix file looks as follows:
55+
56+```nix
57+with import <nixpkgs> {};
58+crystal.buildCrystalPackage rec {
59+ version = "0.5.0";
60+ pname = "mint";
61+ src = fetchFromGitHub {
62+ owner = "mint-lang";
63+ repo = "mint";
64+ rev = version;
65+ sha256 = "0vxbx38c390rd2ysvbwgh89v2232sh5rbsp3nk9wzb70jybpslvl";
66+ };
67+
68+ shardsFile = ./shards.nix;
69+ crystalBinaries.mint.src = "src/mint.cr";
70+
71+ buildInputs = [ openssl ];
72+}
73+```
doc/languages-frameworks/cuda.section.mdnew file+34
@@ -0,0 +1,34 @@
1+# CUDA {#cuda}
2+
3+CUDA-only packages are stored in the `cudaPackages` packages set. This set
4+includes the `cudatoolkit`, portions of the toolkit in separate derivations,
5+`cudnn`, `cutensor` and `nccl`.
6+
7+A package set is available for each CUDA version, so for example
8+`cudaPackages_11_6`. Within each set is a matching version of the above listed
9+packages. Additionally, other versions of the packages that are packaged and
10+compatible are available as well. For example, there can be a
11+`cudaPackages.cudnn_8_3_2` package.
12+
13+To use one or more CUDA packages in an expression, give the expression a `cudaPackages` parameter, and in case CUDA is optional
14+```nix
15+cudaSupport ? false
16+cudaPackages ? {}
17+```
18+
19+When using `callPackage`, you can choose to pass in a different variant, e.g.
20+when a different version of the toolkit suffices
21+```nix
22+mypkg = callPackage { cudaPackages = cudaPackages_11_5; }
23+```
24+
25+If another version of say `cudnn` or `cutensor` is needed, you can override the
26+package set to make it the default. This guarantees you get a consistent package
27+set.
28+```nix
29+mypkg = let
30+ cudaPackages = cudaPackages_11_5.overrideScope' (final: prev {
31+ cudnn = prev.cudnn_8_3_2;
32+ }});
33+in callPackage { inherit cudaPackages; };
34+```
doc/languages-frameworks/dhall.section.mdnew file+463
@@ -0,0 +1,463 @@
1+# Dhall {#sec-language-dhall}
2+
3+The Nixpkgs support for Dhall assumes some familiarity with Dhall's language
4+support for importing Dhall expressions, which is documented here:
5+
6+* [`dhall-lang.org` - Installing packages](https://docs.dhall-lang.org/tutorials/Language-Tour.html#installing-packages)
7+
8+## Remote imports {#ssec-dhall-remote-imports}
9+
10+Nixpkgs bypasses Dhall's support for remote imports using Dhall's
11+semantic integrity checks. Specifically, any Dhall import can be protected by
12+an integrity check like:
13+
14+```dhall
15+https://prelude.dhall-lang.org/v20.1.0/package.dhall
16+ sha256:26b0ef498663d269e4dc6a82b0ee289ec565d683ef4c00d0ebdd25333a5a3c98
17+```
18+
19+… and if the import is cached then the interpreter will load the import from
20+cache instead of fetching the URL.
21+
22+Nixpkgs uses this trick to add all of a Dhall expression's dependencies into the
23+cache so that the Dhall interpreter never needs to resolve any remote URLs. In
24+fact, Nixpkgs uses a Dhall interpreter with remote imports disabled when
25+packaging Dhall expressions to enforce that the interpreter never resolves a
26+remote import. This means that Nixpkgs only supports building Dhall expressions
27+if all of their remote imports are protected by semantic integrity checks.
28+
29+Instead of remote imports, Nixpkgs uses Nix to fetch remote Dhall code. For
30+example, the Prelude Dhall package uses `pkgs.fetchFromGitHub` to fetch the
31+`dhall-lang` repository containing the Prelude. Relying exclusively on Nix
32+to fetch Dhall code ensures that Dhall packages built using Nix remain pure and
33+also behave well when built within a sandbox.
34+
35+## Packaging a Dhall expression from scratch {#ssec-dhall-packaging-expression}
36+
37+We can illustrate how Nixpkgs integrates Dhall by beginning from the following
38+trivial Dhall expression with one dependency (the Prelude):
39+
40+```dhall
41+-- ./true.dhall
42+
43+let Prelude = https://prelude.dhall-lang.org/v20.1.0/package.dhall
44+
45+in Prelude.Bool.not False
46+```
47+
48+As written, this expression cannot be built using Nixpkgs because the
49+expression does not protect the Prelude import with a semantic integrity
50+check, so the first step is to freeze the expression using `dhall freeze`,
51+like this:
52+
53+```ShellSession
54+$ dhall freeze --inplace ./true.dhall
55+```
56+
57+… which gives us:
58+
59+```dhall
60+-- ./true.dhall
61+
62+let Prelude =
63+ https://prelude.dhall-lang.org/v20.1.0/package.dhall
64+ sha256:26b0ef498663d269e4dc6a82b0ee289ec565d683ef4c00d0ebdd25333a5a3c98
65+
66+in Prelude.Bool.not False
67+```
68+
69+To package that expression, we create a `./true.nix` file containing the
70+following specification for the Dhall package:
71+
72+```nix
73+# ./true.nix
74+
75+{ buildDhallPackage, Prelude }:
76+
77+buildDhallPackage {
78+ name = "true";
79+ code = ./true.dhall;
80+ dependencies = [ Prelude ];
81+ source = true;
82+}
83+```
84+
85+… and we complete the build by incorporating that Dhall package into the
86+`pkgs.dhallPackages` hierarchy using an overlay, like this:
87+
88+```nix
89+# ./example.nix
90+
91+let
92+ nixpkgs = builtins.fetchTarball {
93+ url = "https://github.com/NixOS/nixpkgs/archive/94b2848559b12a8ed1fe433084686b2a81123c99.tar.gz";
94+ sha256 = "1pbl4c2dsaz2lximgd31m96jwbps6apn3anx8cvvhk1gl9rkg107";
95+ };
96+
97+ dhallOverlay = self: super: {
98+ true = self.callPackage ./true.nix { };
99+ };
100+
101+ overlay = self: super: {
102+ dhallPackages = super.dhallPackages.override (old: {
103+ overrides =
104+ self.lib.composeExtensions (old.overrides or (_: _: {})) dhallOverlay;
105+ });
106+ };
107+
108+ pkgs = import nixpkgs { config = {}; overlays = [ overlay ]; };
109+
110+in
111+ pkgs
112+```
113+
114+… which we can then build using this command:
115+
116+```ShellSession
117+$ nix build --file ./example.nix dhallPackages.true
118+```
119+
120+## Contents of a Dhall package {#ssec-dhall-package-contents}
121+
122+The above package produces the following directory tree:
123+
124+```ShellSession
125+$ tree -a ./result
126+result
127+├── .cache
128+│ └── dhall
129+│ └── 122027abdeddfe8503496adeb623466caa47da5f63abd2bc6fa19f6cfcb73ecfed70
130+├── binary.dhall
131+└── source.dhall
132+```
133+
134+… where:
135+
136+* `source.dhall` contains the result of interpreting our Dhall package:
137+
138+ ```ShellSession
139+ $ cat ./result/source.dhall
140+ True
141+ ```
142+
143+* The `.cache` subdirectory contains one binary cache product encoding the
144+ same result as `source.dhall`:
145+
146+ ```ShellSession
147+ $ dhall decode < ./result/.cache/dhall/122027abdeddfe8503496adeb623466caa47da5f63abd2bc6fa19f6cfcb73ecfed70
148+ True
149+ ```
150+
151+* `binary.dhall` contains a Dhall expression which handles fetching and decoding
152+ the same cache product:
153+
154+ ```ShellSession
155+ $ cat ./result/binary.dhall
156+ missing sha256:27abdeddfe8503496adeb623466caa47da5f63abd2bc6fa19f6cfcb73ecfed70
157+ $ cp -r ./result/.cache .cache
158+
159+ $ chmod -R u+w .cache
160+
161+ $ XDG_CACHE_HOME=.cache dhall --file ./result/binary.dhall
162+ True
163+ ```
164+
165+The `source.dhall` file is only present for packages that specify
166+`source = true;`. By default, Dhall packages omit the `source.dhall` in order
167+to conserve disk space when they are used exclusively as dependencies. For
168+example, if we build the Prelude package it will only contain the binary
169+encoding of the expression:
170+
171+```ShellSession
172+$ nix build --file ./example.nix dhallPackages.Prelude
173+
174+$ tree -a result
175+result
176+├── .cache
177+│ └── dhall
178+│ └── 122026b0ef498663d269e4dc6a82b0ee289ec565d683ef4c00d0ebdd25333a5a3c98
179+└── binary.dhall
180+
181+2 directories, 2 files
182+```
183+
184+Typically, you only specify `source = true;` for the top-level Dhall expression
185+of interest (such as our example `true.nix` Dhall package). However, if you
186+wish to specify `source = true` for all Dhall packages, then you can amend the
187+Dhall overlay like this:
188+
189+```nix
190+ dhallOverrides = self: super: {
191+ # Enable source for all Dhall packages
192+ buildDhallPackage =
193+ args: super.buildDhallPackage (args // { source = true; });
194+
195+ true = self.callPackage ./true.nix { };
196+ };
197+```
198+
199+… and now the Prelude will contain the fully decoded result of interpreting
200+the Prelude:
201+
202+```ShellSession
203+$ nix build --file ./example.nix dhallPackages.Prelude
204+
205+$ tree -a result
206+result
207+├── .cache
208+│ └── dhall
209+│ └── 122026b0ef498663d269e4dc6a82b0ee289ec565d683ef4c00d0ebdd25333a5a3c98
210+├── binary.dhall
211+└── source.dhall
212+
213+$ cat ./result/source.dhall
214+{ Bool =
215+ { and =
216+ \(_ : List Bool) ->
217+ List/fold Bool _ Bool (\(_ : Bool) -> \(_ : Bool) -> _@1 && _) True
218+ , build = \(_ : Type -> _ -> _@1 -> _@2) -> _ Bool True False
219+ , even =
220+ \(_ : List Bool) ->
221+ List/fold Bool _ Bool (\(_ : Bool) -> \(_ : Bool) -> _@1 == _) True
222+ , fold =
223+ \(_ : Bool) ->
224+…
225+```
226+
227+## Packaging functions {#ssec-dhall-packaging-functions}
228+
229+We already saw an example of using `buildDhallPackage` to create a Dhall
230+package from a single file, but most Dhall packages consist of more than one
231+file and there are two derived utilities that you may find more useful when
232+packaging multiple files:
233+
234+* `buildDhallDirectoryPackage` - build a Dhall package from a local directory
235+
236+* `buildDhallGitHubPackage` - build a Dhall package from a GitHub repository
237+
238+The `buildDhallPackage` is the lowest-level function and accepts the following
239+arguments:
240+
241+* `name`: The name of the derivation
242+
243+* `dependencies`: Dhall dependencies to build and cache ahead of time
244+
245+* `code`: The top-level expression to build for this package
246+
247+ Note that the `code` field accepts an arbitrary Dhall expression. You're
248+ not limited to just a file.
249+
250+* `source`: Set to `true` to include the decoded result as `source.dhall` in the
251+ build product, at the expense of requiring more disk space
252+
253+* `documentationRoot`: Set to the root directory of the package if you want
254+ `dhall-docs` to generate documentation underneath the `docs` subdirectory of
255+ the build product
256+
257+The `buildDhallDirectoryPackage` is a higher-level function implemented in terms
258+of `buildDhallPackage` that accepts the following arguments:
259+
260+* `name`: Same as `buildDhallPackage`
261+
262+* `dependencies`: Same as `buildDhallPackage`
263+
264+* `source`: Same as `buildDhallPackage`
265+
266+* `src`: The directory containing Dhall code that you want to turn into a Dhall
267+ package
268+
269+* `file`: The top-level file (`package.dhall` by default) that is the entrypoint
270+ to the rest of the package
271+
272+* `document`: Set to `true` to generate documentation for the package
273+
274+The `buildDhallGitHubPackage` is another higher-level function implemented in
275+terms of `buildDhallPackage` that accepts the following arguments:
276+
277+* `name`: Same as `buildDhallPackage`
278+
279+* `dependencies`: Same as `buildDhallPackage`
280+
281+* `source`: Same as `buildDhallPackage`
282+
283+* `owner`: The owner of the repository
284+
285+* `repo`: The repository name
286+
287+* `rev`: The desired revision (or branch, or tag)
288+
289+* `directory`: The subdirectory of the Git repository to package (if a
290+ directory other than the root of the repository)
291+
292+* `file`: The top-level file (`${directory}/package.dhall` by default) that is
293+ the entrypoint to the rest of the package
294+
295+* `document`: Set to `true` to generate documentation for the package
296+
297+Additionally, `buildDhallGitHubPackage` accepts the same arguments as
298+`fetchFromGitHub`, such as `sha256` or `fetchSubmodules`.
299+
300+## `dhall-to-nixpkgs` {#ssec-dhall-dhall-to-nixpkgs}
301+
302+You can use the `dhall-to-nixpkgs` command-line utility to automate
303+packaging Dhall code. For example:
304+
305+```ShellSession
306+$ nix-env --install --attr haskellPackages.dhall-nixpkgs
307+
308+$ nix-env --install --attr nix-prefetch-git # Used by dhall-to-nixpkgs
309+
310+$ dhall-to-nixpkgs github https://github.com/Gabriel439/dhall-semver.git
311+{ buildDhallGitHubPackage, Prelude }:
312+ buildDhallGitHubPackage {
313+ name = "dhall-semver";
314+ githubBase = "github.com";
315+ owner = "Gabriel439";
316+ repo = "dhall-semver";
317+ rev = "2d44ae605302ce5dc6c657a1216887fbb96392a4";
318+ fetchSubmodules = false;
319+ sha256 = "0y8shvp8srzbjjpmnsvz9c12ciihnx1szs0yzyi9ashmrjvd0jcz";
320+ directory = "";
321+ file = "package.dhall";
322+ source = false;
323+ document = false;
324+ dependencies = [ (Prelude.overridePackage { file = "package.dhall"; }) ];
325+ }
326+```
327+
328+The utility takes care of automatically detecting remote imports and converting
329+them to package dependencies. You can also use the utility on local
330+Dhall directories, too:
331+
332+```ShellSession
333+$ dhall-to-nixpkgs directory ~/proj/dhall-semver
334+{ buildDhallDirectoryPackage, Prelude }:
335+ buildDhallDirectoryPackage {
336+ name = "proj";
337+ src = ~/proj/dhall-semver;
338+ file = "package.dhall";
339+ source = false;
340+ document = false;
341+ dependencies = [ (Prelude.overridePackage { file = "package.dhall"; }) ];
342+ }
343+```
344+
345+### Remote imports as fixed-output derivations {#ssec-dhall-remote-imports-as-fod}
346+
347+`dhall-to-nixpkgs` has the ability to fetch and build remote imports as
348+fixed-output derivations by using their Dhall integrity check. This is
349+sometimes easier than manually packaging all remote imports.
350+
351+This can be used like the following:
352+
353+```ShellSession
354+$ dhall-to-nixpkgs directory --fixed-output-derivations ~/proj/dhall-semver
355+{ buildDhallDirectoryPackage, buildDhallUrl }:
356+ buildDhallDirectoryPackage {
357+ name = "proj";
358+ src = ~/proj/dhall-semver;
359+ file = "package.dhall";
360+ source = false;
361+ document = false;
362+ dependencies = [
363+ (buildDhallUrl {
364+ url = "https://prelude.dhall-lang.org/v17.0.0/package.dhall";
365+ hash = "sha256-ENs8kZwl6QRoM9+Jeo/+JwHcOQ+giT2VjDQwUkvlpD4=";
366+ dhallHash = "sha256:10db3c919c25e9046833df897a8ffe2701dc390fa0893d958c3430524be5a43e";
367+ })
368+ ];
369+ }
370+```
371+
372+Here, `dhall-semver`'s `Prelude` dependency is fetched and built with the
373+`buildDhallUrl` helper function, instead of being passed in as a function
374+argument.
375+
376+## Overriding dependency versions {#ssec-dhall-overriding-dependency-versions}
377+
378+Suppose that we change our `true.dhall` example expression to depend on an older
379+version of the Prelude (19.0.0):
380+
381+```dhall
382+-- ./true.dhall
383+
384+let Prelude =
385+ https://prelude.dhall-lang.org/v19.0.0/package.dhall
386+ sha256:eb693342eb769f782174157eba9b5924cf8ac6793897fc36a31ccbd6f56dafe2
387+
388+in Prelude.Bool.not False
389+```
390+
391+If we try to rebuild that expression the build will fail:
392+
393+```ShellSession
394+$ nix build --file ./example.nix dhallPackages.true
395+builder for '/nix/store/0f1hla7ff1wiaqyk1r2ky4wnhnw114fi-true.drv' failed with exit code 1; last 10 log lines:
396+
397+ Dhall was compiled without the 'with-http' flag.
398+
399+ The requested URL was: https://prelude.dhall-lang.org/v19.0.0/package.dhall
400+
401+
402+ 4│ https://prelude.dhall-lang.org/v19.0.0/package.dhall
403+ 5│ sha256:eb693342eb769f782174157eba9b5924cf8ac6793897fc36a31ccbd6f56dafe2
404+
405+ /nix/store/rsab4y99h14912h4zplqx2iizr5n4rc2-true.dhall:4:7
406+[1 built (1 failed), 0.0 MiB DL]
407+error: build of '/nix/store/0f1hla7ff1wiaqyk1r2ky4wnhnw114fi-true.drv' failed
408+```
409+
410+… because the default Prelude selected by Nixpkgs revision
411+`94b2848559b12a8ed1fe433084686b2a81123c99is` is version 20.1.0, which doesn't
412+have the same integrity check as version 19.0.0. This means that version
413+19.0.0 is not cached and the interpreter is not allowed to fall back to
414+importing the URL.
415+
416+However, we can override the default Prelude version by using `dhall-to-nixpkgs`
417+to create a Dhall package for our desired Prelude:
418+
419+```ShellSession
420+$ dhall-to-nixpkgs github https://github.com/dhall-lang/dhall-lang.git \
421+ --name Prelude \
422+ --directory Prelude \
423+ --rev v19.0.0 \
424+ > Prelude.nix
425+```
426+
427+… and then referencing that package in our Dhall overlay, by either overriding
428+the Prelude globally for all packages, like this:
429+
430+```nix
431+ dhallOverrides = self: super: {
432+ true = self.callPackage ./true.nix { };
433+
434+ Prelude = self.callPackage ./Prelude.nix { };
435+ };
436+```
437+
438+… or selectively overriding the Prelude dependency for just the `true` package,
439+like this:
440+
441+```nix
442+ dhallOverrides = self: super: {
443+ true = self.callPackage ./true.nix {
444+ Prelude = self.callPackage ./Prelude.nix { };
445+ };
446+ };
447+```
448+
449+## Overrides {#ssec-dhall-overrides}
450+
451+You can override any of the arguments to `buildDhallGitHubPackage` or
452+`buildDhallDirectoryPackage` using the `overridePackage` attribute of a package.
453+For example, suppose we wanted to selectively enable `source = true` just for the Prelude. We can do that like this:
454+
455+```nix
456+ dhallOverrides = self: super: {
457+ Prelude = super.Prelude.overridePackage { source = true; };
458+
459+ …
460+ };
461+```
462+
463+[semantic-integrity-checks]: https://docs.dhall-lang.org/tutorials/Language-Tour.html#installing-packages
doc/languages-frameworks/dotnet.section.mdnew file+132
@@ -0,0 +1,132 @@
1+# Dotnet {#dotnet}
2+
3+## Local Development Workflow {#local-development-workflow}
4+
5+For local development, it's recommended to use nix-shell to create a dotnet environment:
6+
7+```nix
8+# shell.nix
9+with import <nixpkgs> {};
10+
11+mkShell {
12+ name = "dotnet-env";
13+ packages = [
14+ dotnet-sdk_3
15+ ];
16+}
17+```
18+
19+### Using many sdks in a workflow {#using-many-sdks-in-a-workflow}
20+
21+It's very likely that more than one sdk will be needed on a given project. Dotnet provides several different frameworks (E.g dotnetcore, aspnetcore, etc.) as well as many versions for a given framework. Normally, dotnet is able to fetch a framework and install it relative to the executable. However, this would mean writing to the nix store in nixpkgs, which is read-only. To support the many-sdk use case, one can compose an environment using `dotnetCorePackages.combinePackages`:
22+
23+```nix
24+with import <nixpkgs> {};
25+
26+mkShell {
27+ name = "dotnet-env";
28+ packages = [
29+ (with dotnetCorePackages; combinePackages [
30+ sdk_3_1
31+ sdk_5_0
32+ ])
33+ ];
34+}
35+```
36+
37+This will produce a dotnet installation that has the dotnet 3.1, 3.0, and 2.1 sdk. The first sdk listed will have it's cli utility present in the resulting environment. Example info output:
38+
39+```ShellSession
40+$ dotnet --info
41+.NET Core SDK (reflecting any global.json):
42+ Version: 3.1.101
43+ Commit: b377529961
44+
45+...
46+
47+.NET Core SDKs installed:
48+ 2.1.803 [/nix/store/iiv98i2jdi226dgh4jzkkj2ww7f8jgpd-dotnet-core-combined/sdk]
49+ 3.0.102 [/nix/store/iiv98i2jdi226dgh4jzkkj2ww7f8jgpd-dotnet-core-combined/sdk]
50+ 3.1.101 [/nix/store/iiv98i2jdi226dgh4jzkkj2ww7f8jgpd-dotnet-core-combined/sdk]
51+
52+.NET Core runtimes installed:
53+ Microsoft.AspNetCore.All 2.1.15 [/nix/store/iiv98i2jdi226dgh4jzkkj2ww7f8jgpd-dotnet-core-combined/shared/Microsoft.AspNetCore.All]
54+ Microsoft.AspNetCore.App 2.1.15 [/nix/store/iiv98i2jdi226dgh4jzkkj2ww7f8jgpd-dotnet-core-combined/shared/Microsoft.AspNetCore.App]
55+ Microsoft.AspNetCore.App 3.0.2 [/nix/store/iiv98i2jdi226dgh4jzkkj2ww7f8jgpd-dotnet-core-combined/shared/Microsoft.AspNetCore.App]
56+ Microsoft.AspNetCore.App 3.1.1 [/nix/store/iiv98i2jdi226dgh4jzkkj2ww7f8jgpd-dotnet-core-combined/shared/Microsoft.AspNetCore.App]
57+ Microsoft.NETCore.App 2.1.15 [/nix/store/iiv98i2jdi226dgh4jzkkj2ww7f8jgpd-dotnet-core-combined/shared/Microsoft.NETCore.App]
58+ Microsoft.NETCore.App 3.0.2 [/nix/store/iiv98i2jdi226dgh4jzkkj2ww7f8jgpd-dotnet-core-combined/shared/Microsoft.NETCore.App]
59+ Microsoft.NETCore.App 3.1.1 [/nix/store/iiv98i2jdi226dgh4jzkkj2ww7f8jgpd-dotnet-core-combined/shared/Microsoft.NETCore.App]
60+```
61+
62+## dotnet-sdk vs dotnetCorePackages.sdk {#dotnet-sdk-vs-dotnetcorepackages.sdk}
63+
64+The `dotnetCorePackages.sdk_X_Y` is preferred over the old dotnet-sdk as both major and minor version are very important for a dotnet environment. If a given minor version isn't present (or was changed), then this will likely break your ability to build a project.
65+
66+## dotnetCorePackages.sdk vs dotnetCorePackages.runtime vs dotnetCorePackages.aspnetcore {#dotnetcorepackages.sdk-vs-dotnetcorepackages.runtime-vs-dotnetcorepackages.aspnetcore}
67+
68+The `dotnetCorePackages.sdk` contains both a runtime and the full sdk of a given version. The `runtime` and `aspnetcore` packages are meant to serve as minimal runtimes to deploy alongside already built applications.
69+
70+## Packaging a Dotnet Application {#packaging-a-dotnet-application}
71+
72+To package Dotnet applications, you can use `buildDotnetModule`. This has similar arguments to `stdenv.mkDerivation`, with the following additions:
73+
74+* `projectFile` has to be used for specifying the dotnet project file relative to the source root. These usually have `.sln` or `.csproj` file extensions. This can be an array of multiple projects as well.
75+* `nugetDeps` has to be used to specify the NuGet dependency file. Unfortunately, these cannot be deterministically fetched without a lockfile. A script to fetch these is available as `passthru.fetch-deps`. This file can also be generated manually using `nuget-to-nix` tool, which is available in nixpkgs.
76+* `packNupkg` is used to pack project as a `nupkg`, and installs it to `$out/share`. If set to `true`, the derivation can be used as a dependency for another dotnet project by adding it to `projectReferences`.
77+* `projectReferences` can be used to resolve `ProjectReference` project items. Referenced projects can be packed with `buildDotnetModule` by setting the `packNupkg = true` attribute and passing a list of derivations to `projectReferences`. Since we are sharing referenced projects as NuGets they must be added to csproj/fsproj files as `PackageReference` as well.
78+ For example, your project has a local dependency:
79+ ```xml
80+ <ProjectReference Include="../foo/bar.fsproj" />
81+ ```
82+ To enable discovery through `projectReferences` you would need to add:
83+ ```xml
84+ <ProjectReference Include="../foo/bar.fsproj" />
85+ <PackageReference Include="bar" Version="*" Condition=" '$(ContinuousIntegrationBuild)'=='true' "/>
86+ ```
87+* `executables` is used to specify which executables get wrapped to `$out/bin`, relative to `$out/lib/$pname`. If this is unset, all executables generated will get installed. If you do not want to install any, set this to `[]`. This gets done in the `preFixup` phase.
88+* `runtimeDeps` is used to wrap libraries into `LD_LIBRARY_PATH`. This is how dotnet usually handles runtime dependencies.
89+* `buildType` is used to change the type of build. Possible values are `Release`, `Debug`, etc. By default, this is set to `Release`.
90+* `dotnet-sdk` is useful in cases where you need to change what dotnet SDK is being used.
91+* `dotnet-runtime` is useful in cases where you need to change what dotnet runtime is being used. This can be either a regular dotnet runtime, or an aspnetcore.
92+* `dotnet-test-sdk` is useful in cases where unit tests expect a different dotnet SDK. By default, this is set to the `dotnet-sdk` attribute.
93+* `testProjectFile` is useful in cases where the regular project file does not contain the unit tests. It gets restored and build, but not installed. You may need to regenerate your nuget lockfile after setting this.
94+* `disabledTests` is used to disable running specific unit tests. This gets passed as: `dotnet test --filter "FullyQualifiedName!={}"`, to ensure compatibility with all unit test frameworks.
95+* `dotnetRestoreFlags` can be used to pass flags to `dotnet restore`.
96+* `dotnetBuildFlags` can be used to pass flags to `dotnet build`.
97+* `dotnetTestFlags` can be used to pass flags to `dotnet test`. Used only if `doCheck` is set to `true`.
98+* `dotnetInstallFlags` can be used to pass flags to `dotnet install`.
99+* `dotnetPackFlags` can be used to pass flags to `dotnet pack`. Used only if `packNupkg` is set to `true`.
100+* `dotnetFlags` can be used to pass flags to all of the above phases.
101+
102+When packaging a new application, you need to fetch it's dependencies. You can set `nugetDeps` to an empty string to make the derivation temporarily evaluate, and then run `nix-build -A package.passthru.fetch-deps` to generate it's dependency fetching script. After running the script, you should have the location of the generated lockfile printed to the console. This can be copied to a stable directory. Note that if either `projectFile` or `nugetDeps` are unset, this script cannot be generated!
103+
104+Here is an example `default.nix`, using some of the previously discussed arguments:
105+```nix
106+{ lib, buildDotnetModule, dotnetCorePackages, ffmpeg }:
107+
108+let
109+ referencedProject = import ../../bar { ... };
110+in buildDotnetModule rec {
111+ pname = "someDotnetApplication";
112+ version = "0.1";
113+
114+ src = ./.;
115+
116+ projectFile = "src/project.sln";
117+ nugetDeps = ./deps.nix; # File generated with `nix-build -A package.passthru.fetch-deps`.
118+
119+ projectReferences = [ referencedProject ]; # `referencedProject` must contain `nupkg` in the folder structure.
120+
121+ dotnet-sdk = dotnetCorePackages.sdk_3_1;
122+ dotnet-runtime = dotnetCorePackages.net_5_0;
123+ dotnetFlags = [ "--runtime linux-x64" ];
124+
125+ executables = [ "foo" ]; # This wraps "$out/lib/$pname/foo" to `$out/bin/foo`.
126+ executables = []; # Don't install any executables.
127+
128+ packNupkg = true; # This packs the project as "foo-0.1.nupkg" at `$out/share`.
129+
130+ runtimeDeps = [ ffmpeg ]; # This will wrap ffmpeg's library path into `LD_LIBRARY_PATH`.
131+}
132+```
doc/languages-frameworks/emscripten.section.mdnew file+182
@@ -0,0 +1,182 @@
1+# Emscripten {#emscripten}
2+
3+[Emscripten](https://github.com/kripken/emscripten): An LLVM-to-JavaScript Compiler
4+
5+This section of the manual covers how to use `emscripten` in nixpkgs.
6+
7+Minimal requirements:
8+
9+* nix
10+* nixpkgs
11+
12+Modes of use of `emscripten`:
13+
14+* **Imperative usage** (on the command line):
15+
16+ If you want to work with `emcc`, `emconfigure` and `emmake` as you are used to from Ubuntu and similar distributions you can use these commands:
17+
18+ * `nix-env -f "<nixpkgs>" -iA emscripten`
19+ * `nix-shell -p emscripten`
20+
21+* **Declarative usage**:
22+
23+ This mode is far more power full since this makes use of `nix` for dependency management of emscripten libraries and targets by using the `mkDerivation` which is implemented by `pkgs.emscriptenStdenv` and `pkgs.buildEmscriptenPackage`. The source for the packages is in `pkgs/top-level/emscripten-packages.nix` and the abstraction behind it in `pkgs/development/em-modules/generic/default.nix`. From the root of the nixpkgs repository:
24+ * build and install all packages:
25+ * `nix-env -iA emscriptenPackages`
26+
27+ * dev-shell for zlib implementation hacking:
28+ * `nix-shell -A emscriptenPackages.zlib`
29+
30+## Imperative usage {#imperative-usage}
31+
32+A few things to note:
33+
34+* `export EMCC_DEBUG=2` is nice for debugging
35+* `~/.emscripten`, the build artifact cache sometimes creates issues and needs to be removed from time to time
36+
37+## Declarative usage {#declarative-usage}
38+
39+Let's see two different examples from `pkgs/top-level/emscripten-packages.nix`:
40+
41+* `pkgs.zlib.override`
42+* `pkgs.buildEmscriptenPackage`
43+
44+Both are interesting concepts.
45+
46+A special requirement of the `pkgs.buildEmscriptenPackage` is the `doCheck = true` is a default meaning that each emscriptenPackage requires a `checkPhase` implemented.
47+
48+* Use `export EMCC_DEBUG=2` from within a emscriptenPackage's `phase` to get more detailed debug output what is going wrong.
49+* ~/.emscripten cache is requiring us to set `HOME=$TMPDIR` in individual phases. This makes compilation slower but also makes it more deterministic.
50+
51+### Usage 1: pkgs.zlib.override {#usage-1-pkgs.zlib.override}
52+
53+This example uses `zlib` from nixpkgs but instead of compiling **C** to **ELF** it compiles **C** to **JS** since we were using `pkgs.zlib.override` and changed stdenv to `pkgs.emscriptenStdenv`. A few adaptions and hacks were set in place to make it working. One advantage is that when `pkgs.zlib` is updated, it will automatically update this package as well. However, this can also be the downside...
54+
55+See the `zlib` example:
56+
57+ zlib = (pkgs.zlib.override {
58+ stdenv = pkgs.emscriptenStdenv;
59+ }).overrideDerivation
60+ (old: rec {
61+ buildInputs = old.buildInputs ++ [ pkg-config ];
62+ # we need to reset this setting!
63+ NIX_CFLAGS_COMPILE="";
64+ configurePhase = ''
65+ # FIXME: Some tests require writing at $HOME
66+ HOME=$TMPDIR
67+ runHook preConfigure
68+
69+ #export EMCC_DEBUG=2
70+ emconfigure ./configure --prefix=$out --shared
71+
72+ runHook postConfigure
73+ '';
74+ dontStrip = true;
75+ outputs = [ "out" ];
76+ buildPhase = ''
77+ emmake make
78+ '';
79+ installPhase = ''
80+ emmake make install
81+ '';
82+ checkPhase = ''
83+ echo "================= testing zlib using node ================="
84+
85+ echo "Compiling a custom test"
86+ set -x
87+ emcc -O2 -s EMULATE_FUNCTION_POINTER_CASTS=1 test/example.c -DZ_SOLO \
88+ libz.so.${old.version} -I . -o example.js
89+
90+ echo "Using node to execute the test"
91+ ${pkgs.nodejs}/bin/node ./example.js
92+
93+ set +x
94+ if [ $? -ne 0 ]; then
95+ echo "test failed for some reason"
96+ exit 1;
97+ else
98+ echo "it seems to work! very good."
99+ fi
100+ echo "================= /testing zlib using node ================="
101+ '';
102+
103+ postPatch = pkgs.lib.optionalString pkgs.stdenv.isDarwin ''
104+ substituteInPlace configure \
105+ --replace '/usr/bin/libtool' 'ar' \
106+ --replace 'AR="libtool"' 'AR="ar"' \
107+ --replace 'ARFLAGS="-o"' 'ARFLAGS="-r"'
108+ '';
109+ });
110+
111+### Usage 2: pkgs.buildEmscriptenPackage {#usage-2-pkgs.buildemscriptenpackage}
112+
113+This `xmlmirror` example features a emscriptenPackage which is defined completely from this context and no `pkgs.zlib.override` is used.
114+
115+ xmlmirror = pkgs.buildEmscriptenPackage rec {
116+ name = "xmlmirror";
117+
118+ buildInputs = [ pkg-config autoconf automake libtool gnumake libxml2 nodejs openjdk json_c ];
119+ nativeBuildInputs = [ pkg-config zlib ];
120+
121+ src = pkgs.fetchgit {
122+ url = "https://gitlab.com/odfplugfest/xmlmirror.git";
123+ rev = "4fd7e86f7c9526b8f4c1733e5c8b45175860a8fd";
124+ sha256 = "1jasdqnbdnb83wbcnyrp32f36w3xwhwp0wq8lwwmhqagxrij1r4b";
125+ };
126+
127+ configurePhase = ''
128+ rm -f fastXmlLint.js*
129+ # a fix for ERROR:root:For asm.js, TOTAL_MEMORY must be a multiple of 16MB, was 234217728
130+ # https://gitlab.com/odfplugfest/xmlmirror/issues/8
131+ sed -e "s/TOTAL_MEMORY=234217728/TOTAL_MEMORY=268435456/g" -i Makefile.emEnv
132+ # https://github.com/kripken/emscripten/issues/6344
133+ # https://gitlab.com/odfplugfest/xmlmirror/issues/9
134+ sed -e "s/\$(JSONC_LDFLAGS) \$(ZLIB_LDFLAGS) \$(LIBXML20_LDFLAGS)/\$(JSONC_LDFLAGS) \$(LIBXML20_LDFLAGS) \$(ZLIB_LDFLAGS) /g" -i Makefile.emEnv
135+ # https://gitlab.com/odfplugfest/xmlmirror/issues/11
136+ sed -e "s/-o fastXmlLint.js/-s EXTRA_EXPORTED_RUNTIME_METHODS='[\"ccall\", \"cwrap\"]' -o fastXmlLint.js/g" -i Makefile.emEnv
137+ '';
138+
139+ buildPhase = ''
140+ HOME=$TMPDIR
141+ make -f Makefile.emEnv
142+ '';
143+
144+ outputs = [ "out" "doc" ];
145+
146+ installPhase = ''
147+ mkdir -p $out/share
148+ mkdir -p $doc/share/${name}
149+
150+ cp Demo* $out/share
151+ cp -R codemirror-5.12 $out/share
152+ cp fastXmlLint.js* $out/share
153+ cp *.xsd $out/share
154+ cp *.js $out/share
155+ cp *.xhtml $out/share
156+ cp *.html $out/share
157+ cp *.json $out/share
158+ cp *.rng $out/share
159+ cp README.md $doc/share/${name}
160+ '';
161+ checkPhase = ''
162+
163+ '';
164+ };
165+
166+### Declarative debugging {#declarative-debugging}
167+
168+Use `nix-shell -I nixpkgs=/some/dir/nixpkgs -A emscriptenPackages.libz` and from there you can go trough the individual steps. This makes it easy to build a good `unit test` or list the files of the project.
169+
170+1. `nix-shell -I nixpkgs=/some/dir/nixpkgs -A emscriptenPackages.libz`
171+2. `cd /tmp/`
172+3. `unpackPhase`
173+4. cd libz-1.2.3
174+5. `configurePhase`
175+6. `buildPhase`
176+7. ... happy hacking...
177+
178+## Summary {#summary}
179+
180+Using this toolchain makes it easy to leverage `nix` from NixOS, MacOSX or even Windows (WSL+ubuntu+nix). This toolchain is reproducible, behaves like the rest of the packages from nixpkgs and contains a set of well working examples to learn and adapt from.
181+
182+If in trouble, ask the maintainers.
doc/languages-frameworks/gnome.section.mdnew file+218
@@ -0,0 +1,218 @@
1+# GNOME {#sec-language-gnome}
2+
3+## Packaging GNOME applications {#ssec-gnome-packaging}
4+
5+Programs in the GNOME universe are written in various languages but they all use GObject-based libraries like GLib, GTK or GStreamer. These libraries are often modular, relying on looking into certain directories to find their modules. However, due to Nix’s specific file system organization, this will fail without our intervention. Fortunately, the libraries usually allow overriding the directories through environment variables, either natively or thanks to a patch in nixpkgs. [Wrapping](#fun-wrapProgram) the executables to ensure correct paths are available to the application constitutes a significant part of packaging a modern desktop application. In this section, we will describe various modules needed by such applications, environment variables needed to make the modules load, and finally a script that will do the work for us.
6+
7+### Settings {#ssec-gnome-settings}
8+
9+[GSettings](https://developer.gnome.org/gio/stable/GSettings.html) API is often used for storing settings. GSettings schemas are required, to know the type and other metadata of the stored values. GLib looks for `glib-2.0/schemas/gschemas.compiled` files inside the directories of `XDG_DATA_DIRS`.
10+
11+On Linux, GSettings API is implemented using [dconf](https://wiki.gnome.org/Projects/dconf) backend. You will need to add `dconf` [GIO module](#ssec-gnome-gio-modules) to `GIO_EXTRA_MODULES` variable, otherwise the `memory` backend will be used and the saved settings will not be persistent.
12+
13+Last you will need the dconf database D-Bus service itself. You can enable it using `programs.dconf.enable`.
14+
15+Some applications will also require `gsettings-desktop-schemas` for things like reading proxy configuration or user interface customization. This dependency is often not mentioned by upstream, you should grep for `org.gnome.desktop` and `org.gnome.system` to see if the schemas are needed.
16+
17+### GIO modules {#ssec-gnome-gio-modules}
18+
19+GLib’s [GIO](https://developer.gnome.org/gio/stable/ch01.html) library supports several [extension points](https://developer.gnome.org/gio/stable/extending-gio.html). Notably, they allow:
20+
21+* implementing settings backends (already [mentioned](#ssec-gnome-settings))
22+* adding TLS support
23+* proxy settings
24+* virtual file systems
25+
26+The modules are typically installed to `lib/gio/modules/` directory of a package and you need to add them to `GIO_EXTRA_MODULES` if you need any of those features.
27+
28+In particular, we recommend:
29+
30+* adding `dconf.lib` for any software on Linux that reads [GSettings](#ssec-gnome-settings) (even transitivily through e.g. GTK’s file manager)
31+* adding `glib-networking` for any software that accesses network using GIO or libsoup – glib-networking contains a module that implements TLS support and loads system-wide proxy settings
32+
33+To allow software to use various virtual file systems, `gvfs` package can be also added. But that is usually an optional feature so we typically use `gvfs` from the system (e.g. installed globally using NixOS module).
34+
35+### GdkPixbuf loaders {#ssec-gnome-gdk-pixbuf-loaders}
36+
37+GTK applications typically use [GdkPixbuf](https://developer.gnome.org/gdk-pixbuf/stable/) to load images. But `gdk-pixbuf` package only supports basic bitmap formats like JPEG, PNG or TIFF, requiring to use third-party loader modules for other formats. This is especially painful since GTK itself includes SVG icons, which cannot be rendered without a loader provided by `librsvg`.
38+
39+Unlike other libraries mentioned in this section, GdkPixbuf only supports a single value in its controlling environment variable `GDK_PIXBUF_MODULE_FILE`. It is supposed to point to a cache file containing information about the available loaders. Each loader package will contain a `lib/gdk-pixbuf-2.0/2.10.0/loaders.cache` file describing the default loaders in `gdk-pixbuf` package plus the loader contained in the package itself. If you want to use multiple third-party loaders, you will need to create your own cache file manually. Fortunately, this is pretty rare as [not many loaders exist](https://gitlab.gnome.org/federico/gdk-pixbuf-survey/blob/master/src/modules.md).
40+
41+`gdk-pixbuf` contains [a setup hook](#ssec-gnome-hooks-gdk-pixbuf) that sets `GDK_PIXBUF_MODULE_FILE` from dependencies but as mentioned in further section, it is pretty limited. Loaders should propagate this setup hook.
42+
43+### Icons {#ssec-gnome-icons}
44+
45+When an application uses icons, an icon theme should be available in `XDG_DATA_DIRS` during runtime. The package for the default, icon-less [hicolor-icon-theme](https://www.freedesktop.org/wiki/Software/icon-theme/) (should be propagated by every icon theme) contains [a setup hook](#ssec-gnome-hooks-hicolor-icon-theme) that will pick up icon themes from `buildInputs` and add their datadirs to `XDG_ICON_DIRS` environment variable (this is Nixpkgs specific, not actually a XDG standard variable). Unfortunately, relying on that would mean every user has to download the theme included in the package expression no matter their preference. For that reason, we leave the installation of icon theme on the user. If you use one of the desktop environments, you probably already have an icon theme installed.
46+
47+In the rare case you need to use icons from dependencies (e.g. when an app forces an icon theme), you can use the following to pick them up:
48+
49+```nix
50+ buildInputs = [
51+ pantheon.elementary-icon-theme
52+ ];
53+ preFixup = ''
54+ gappsWrapperArgs+=(
55+ # The icon theme is hardcoded.
56+ --prefix XDG_DATA_DIRS : "$XDG_ICON_DIRS"
57+ )
58+ '';
59+```
60+
61+To avoid costly file system access when locating icons, GTK, [as well as Qt](https://woboq.com/blog/qicon-reads-gtk-icon-cache-in-qt57.html), can rely on `icon-theme.cache` files from the themes' top-level directories. These files are generated using `gtk-update-icon-cache`, which is expected to be run whenever an icon is added or removed to an icon theme (typically an application icon into `hicolor` theme) and some programs do indeed run this after icon installation. However, since packages are installed into their own prefix by Nix, this would lead to conflicts. For that reason, `gtk3` provides a [setup hook](#ssec-gnome-hooks-gtk-drop-icon-theme-cache) that will clean the file from installation. Since most applications only ship their own icon that will be loaded on start-up, it should not affect them too much. On the other hand, icon themes are much larger and more widely used so we need to cache them. Because we recommend installing icon themes globally, we will generate the cache files from all packages in a profile using a NixOS module. You can enable the cache generation using `gtk.iconCache.enable` option if your desktop environment does not already do that.
62+
63+### Packaging icon themes {#ssec-icon-theme-packaging}
64+
65+Icon themes may inherit from other icon themes. The inheritance is specified using the `Inherits` key in the `index.theme` file distributed with the icon theme. According to the [icon theme specification](https://specifications.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html), icons not provided by the theme are looked for in its parent icon themes. Therefore the parent themes should be installed as dependencies for a more complete experience regarding the icon sets used.
66+
67+The package `hicolor-icon-theme` provides a setup hook which makes symbolic links for the parent themes into the directory `share/icons` of the current theme directory in the nix store, making sure they can be found at runtime. For that to work the packages providing parent icon themes should be listed as propagated build dependencies, together with `hicolor-icon-theme`.
68+
69+Also make sure that `icon-theme.cache` is installed for each theme provided by the package, and set `dontDropIconThemeCache` to `true` so that the cache file is not removed by the `gtk3` setup hook.
70+
71+### GTK Themes {#ssec-gnome-themes}
72+
73+Previously, a GTK theme needed to be in `XDG_DATA_DIRS`. This is no longer necessary for most programs since GTK incorporated Adwaita theme. Some programs (for example, those designed for [elementary HIG](https://elementary.io/docs/human-interface-guidelines#human-interface-guidelines)) might require a special theme like `pantheon.elementary-gtk-theme`.
74+
75+### GObject introspection typelibs {#ssec-gnome-typelibs}
76+
77+[GObject introspection](https://wiki.gnome.org/Projects/GObjectIntrospection) allows applications to use C libraries in other languages easily. It does this through `typelib` files searched in `GI_TYPELIB_PATH`.
78+
79+### Various plug-ins {#ssec-gnome-plugins}
80+
81+If your application uses [GStreamer](https://gstreamer.freedesktop.org/) or [Grilo](https://wiki.gnome.org/Projects/Grilo), you should set `GST_PLUGIN_SYSTEM_PATH_1_0` and `GRL_PLUGIN_PATH`, respectively.
82+
83+## Onto `wrapGAppsHook` {#ssec-gnome-hooks}
84+
85+Given the requirements above, the package expression would become messy quickly:
86+
87+```nix
88+preFixup = ''
89+ for f in $(find $out/bin/ $out/libexec/ -type f -executable); do
90+ wrapProgram "$f" \
91+ --prefix GIO_EXTRA_MODULES : "${getLib dconf}/lib/gio/modules" \
92+ --prefix XDG_DATA_DIRS : "$out/share" \
93+ --prefix XDG_DATA_DIRS : "$out/share/gsettings-schemas/${name}" \
94+ --prefix XDG_DATA_DIRS : "${gsettings-desktop-schemas}/share/gsettings-schemas/${gsettings-desktop-schemas.name}" \
95+ --prefix XDG_DATA_DIRS : "${hicolor-icon-theme}/share" \
96+ --prefix GI_TYPELIB_PATH : "${lib.makeSearchPath "lib/girepository-1.0" [ pango json-glib ]}"
97+ done
98+'';
99+```
100+
101+Fortunately, there is [`wrapGAppsHook`]{#ssec-gnome-hooks-wrapgappshook}. It works in conjunction with other setup hooks that populate environment variables, and it will then wrap all executables in `bin` and `libexec` directories using said variables.
102+
103+For convenience, it also adds `dconf.lib` for a GIO module implementing a GSettings backend using `dconf`, `gtk3` for GSettings schemas, and `librsvg` for GdkPixbuf loader to the closure. There is also [`wrapGAppsHook4`]{#ssec-gnome-hooks-wrapgappshook4}, which replaces GTK 3 with GTK 4. And in case you are packaging a program without a graphical interface, you might want to use [`wrapGAppsNoGuiHook`]{#ssec-gnome-hooks-wrapgappsnoguihook}, which runs the same script as `wrapGAppsHook` but does not bring `gtk3` and `librsvg` into the closure.
104+
105+- `wrapGAppsHook` itself will add the package’s `share` directory to `XDG_DATA_DIRS`.
106+
107+- []{#ssec-gnome-hooks-glib} `glib` setup hook will populate `GSETTINGS_SCHEMAS_PATH` and then `wrapGAppsHook` will prepend it to `XDG_DATA_DIRS`.
108+
109+- []{#ssec-gnome-hooks-gdk-pixbuf} `gdk-pixbuf` setup hook will populate `GDK_PIXBUF_MODULE_FILE` with the path to biggest `loaders.cache` file from the dependencies containing [GdkPixbuf loaders](#ssec-gnome-gdk-pixbuf-loaders). This works fine when there are only two packages containing loaders (`gdk-pixbuf` and e.g. `librsvg`) – it will choose the second one, reasonably expecting that it will be bigger since it describes extra loader in addition to the default ones. But when there are more than two loader packages, this logic will break. One possible solution would be constructing a custom cache file for each package containing a program like `services/x11/gdk-pixbuf.nix` NixOS module does. `wrapGAppsHook` copies the `GDK_PIXBUF_MODULE_FILE` environment variable into the produced wrapper.
110+
111+- []{#ssec-gnome-hooks-gtk-drop-icon-theme-cache} One of `gtk3`’s setup hooks will remove `icon-theme.cache` files from package’s icon theme directories to avoid conflicts. Icon theme packages should prevent this with `dontDropIconThemeCache = true;`.
112+
113+- []{#ssec-gnome-hooks-dconf} `dconf.lib` is a dependency of `wrapGAppsHook`, which then also adds it to the `GIO_EXTRA_MODULES` variable.
114+
115+- []{#ssec-gnome-hooks-hicolor-icon-theme} `hicolor-icon-theme`’s setup hook will add icon themes to `XDG_ICON_DIRS`.
116+
117+- []{#ssec-gnome-hooks-gobject-introspection} `gobject-introspection` setup hook populates `GI_TYPELIB_PATH` variable with `lib/girepository-1.0` directories of dependencies, which is then added to wrapper by `wrapGAppsHook`. It also adds `share` directories of dependencies to `XDG_DATA_DIRS`, which is intended to promote GIR files but it also [pollutes the closures](https://github.com/NixOS/nixpkgs/issues/32790) of packages using `wrapGAppsHook`.
118+
119+ ::: {.warning}
120+ The setup hook [currently](https://github.com/NixOS/nixpkgs/issues/56943) does not work in expressions with `strictDeps` enabled, like Python packages. In those cases, you will need to disable it with `strictDeps = false;`.
121+ :::
122+
123+- []{#ssec-gnome-hooks-gst-grl-plugins} Setup hooks of `gst_all_1.gstreamer` and `grilo` will populate the `GST_PLUGIN_SYSTEM_PATH_1_0` and `GRL_PLUGIN_PATH` variables, respectively, which will then be added to the wrapper by `wrapGAppsHook`.
124+
125+You can also pass additional arguments to `makeWrapper` using `gappsWrapperArgs` in `preFixup` hook:
126+
127+```nix
128+preFixup = ''
129+ gappsWrapperArgs+=(
130+ # Thumbnailers
131+ --prefix XDG_DATA_DIRS : "${gdk-pixbuf}/share"
132+ --prefix XDG_DATA_DIRS : "${librsvg}/share"
133+ --prefix XDG_DATA_DIRS : "${shared-mime-info}/share"
134+ )
135+'';
136+```
137+
138+## Updating GNOME packages {#ssec-gnome-updating}
139+
140+Most GNOME package offer [`updateScript`](#var-passthru-updateScript), it is therefore possible to update to latest source tarball by running `nix-shell maintainers/scripts/update.nix --argstr package gnome.nautilus` or even en masse with `nix-shell maintainers/scripts/update.nix --argstr path gnome`. Read the package’s `NEWS` file to see what changed.
141+
142+## Frequently encountered issues {#ssec-gnome-common-issues}
143+
144+#### `GLib-GIO-ERROR **: 06:04:50.903: No GSettings schemas are installed on the system` {#ssec-gnome-common-issues-no-schemas}
145+
146+There are no schemas available in `XDG_DATA_DIRS`. Temporarily add a random package containing schemas like `gsettings-desktop-schemas` to `buildInputs`. [`glib`](#ssec-gnome-hooks-glib) and [`wrapGAppsHook`](#ssec-gnome-hooks-wrapgappshook) setup hooks will take care of making the schemas available to application and you will see the actual missing schemas with the [next error](#ssec-gnome-common-issues-missing-schema). Or you can try looking through the source code for the actual schemas used.
147+
148+#### `GLib-GIO-ERROR **: 06:04:50.903: Settings schema ‘org.gnome.foo’ is not installed` {#ssec-gnome-common-issues-missing-schema}
149+
150+Package is missing some GSettings schemas. You can find out the package containing the schema with `nix-locate org.gnome.foo.gschema.xml` and let the hooks handle the wrapping as [above](#ssec-gnome-common-issues-no-schemas).
151+
152+#### When using `wrapGAppsHook` with special derivers you can end up with double wrapped binaries. {#ssec-gnome-common-issues-double-wrapped}
153+
154+This is because derivers like `python.pkgs.buildPythonApplication` or `qt5.mkDerivation` have setup-hooks automatically added that produce wrappers with makeWrapper. The simplest way to workaround that is to disable the `wrapGAppsHook` automatic wrapping with `dontWrapGApps = true;` and pass the arguments it intended to pass to makeWrapper to another.
155+
156+In the case of a Python application it could look like:
157+
158+```nix
159+python3.pkgs.buildPythonApplication {
160+ pname = "gnome-music";
161+ version = "3.32.2";
162+
163+ nativeBuildInputs = [
164+ wrapGAppsHook
165+ gobject-introspection
166+ ...
167+ ];
168+
169+ dontWrapGApps = true;
170+
171+ # Arguments to be passed to `makeWrapper`, only used by buildPython*
172+ preFixup = ''
173+ makeWrapperArgs+=("''${gappsWrapperArgs[@]}")
174+ '';
175+}
176+```
177+
178+And for a QT app like:
179+
180+```nix
181+mkDerivation {
182+ pname = "calibre";
183+ version = "3.47.0";
184+
185+ nativeBuildInputs = [
186+ wrapGAppsHook
187+ qmake
188+ ...
189+ ];
190+
191+ dontWrapGApps = true;
192+
193+ # Arguments to be passed to `makeWrapper`, only used by qt5’s mkDerivation
194+ preFixup = ''
195+ qtWrapperArgs+=("''${gappsWrapperArgs[@]}")
196+ '';
197+}
198+```
199+
200+#### I am packaging a project that cannot be wrapped, like a library or GNOME Shell extension. {#ssec-gnome-common-issues-unwrappable-package}
201+
202+You can rely on applications depending on the library setting the necessary environment variables but that is often easy to miss. Instead we recommend to patch the paths in the source code whenever possible. Here are some examples:
203+
204+- []{#ssec-gnome-common-issues-unwrappable-package-gnome-shell-ext} [Replacing a `GI_TYPELIB_PATH` in GNOME Shell extension](https://github.com/NixOS/nixpkgs/blob/7bb8f05f12ca3cff9da72b56caa2f7472d5732bc/pkgs/desktops/gnome-3/core/gnome-shell-extensions/default.nix#L21-L24) – we are using `substituteAll` to include the path to a typelib into a patch.
205+
206+- []{#ssec-gnome-common-issues-unwrappable-package-gsettings} The following examples are hardcoding GSettings schema paths. To get the schema paths we use the functions
207+
208+ * `glib.getSchemaPath` Takes a nix package attribute as an argument.
209+
210+ * `glib.makeSchemaPath` Takes a package output like `$out` and a derivation name. You should use this if the schemas you need to hardcode are in the same derivation.
211+
212+ []{#ssec-gnome-common-issues-unwrappable-package-gsettings-vala} [Hard-coding GSettings schema path in Vala plug-in (dynamically loaded library)](https://github.com/NixOS/nixpkgs/blob/7bb8f05f12ca3cff9da72b56caa2f7472d5732bc/pkgs/desktops/pantheon/apps/elementary-files/default.nix#L78-L86) – here, `substituteAll` cannot be used since the schema comes from the same package preventing us from pass its path to the function, probably due to a [Nix bug](https://github.com/NixOS/nix/issues/1846).
213+
214+ []{#ssec-gnome-common-issues-unwrappable-package-gsettings-c} [Hard-coding GSettings schema path in C library](https://github.com/NixOS/nixpkgs/blob/29c120c065d03b000224872251bed93932d42412/pkgs/development/libraries/glib-networking/default.nix#L31-L34) – nothing special other than using [Coccinelle patch](https://github.com/NixOS/nixpkgs/pull/67957#issuecomment-527717467) to generate the patch itself.
215+
216+#### I need to wrap a binary outside `bin` and `libexec` directories. {#ssec-gnome-common-issues-weird-location}
217+
218+You can manually trigger the wrapping with `wrapGApp` in `preFixup` phase. It takes a path to a program as a first argument; the remaining arguments are passed directly to [`wrapProgram`](#fun-wrapProgram) function.
doc/languages-frameworks/go.section.mdnew file+149
@@ -0,0 +1,149 @@
1+# Go {#sec-language-go}
2+
3+## Go modules {#ssec-language-go}
4+
5+The function `buildGoModule` builds Go programs managed with Go modules. It builds a [Go Modules](https://github.com/golang/go/wiki/Modules) through a two phase build:
6+
7+- An intermediate fetcher derivation. This derivation will be used to fetch all of the dependencies of the Go module.
8+- A final derivation will use the output of the intermediate derivation to build the binaries and produce the final output.
9+
10+### Example for `buildGoModule` {#ex-buildGoModule}
11+
12+In the following is an example expression using `buildGoModule`, the following arguments are of special significance to the function:
13+
14+- `vendorSha256`: is the hash of the output of the intermediate fetcher derivation. `vendorSha256` can also take `null` as an input. When `null` is used as a value, rather than fetching the dependencies and vendoring them, we use the vendoring included within the source repo. If you'd like to not have to update this field on dependency changes, run `go mod vendor` in your source repo and set `vendorSha256 = null;`
15+- `proxyVendor`: Fetches (go mod download) and proxies the vendor directory. This is useful if your code depends on c code and go mod tidy does not include the needed sources to build or if any dependency has case-insensitive conflicts which will produce platform dependant `vendorSha256` checksums.
16+
17+```nix
18+pet = buildGoModule rec {
19+ pname = "pet";
20+ version = "0.3.4";
21+
22+ src = fetchFromGitHub {
23+ owner = "knqyf263";
24+ repo = "pet";
25+ rev = "v${version}";
26+ sha256 = "0m2fzpqxk7hrbxsgqplkg7h2p7gv6s1miymv3gvw0cz039skag0s";
27+ };
28+
29+ vendorSha256 = "1879j77k96684wi554rkjxydrj8g3hpp0kvxz03sd8dmwr3lh83j";
30+
31+ meta = with lib; {
32+ description = "Simple command-line snippet manager, written in Go";
33+ homepage = "https://github.com/knqyf263/pet";
34+ license = licenses.mit;
35+ maintainers = with maintainers; [ kalbasit ];
36+ };
37+}
38+```
39+
40+## `buildGoPackage` (legacy) {#ssec-go-legacy}
41+
42+The function `buildGoPackage` builds legacy Go programs, not supporting Go modules.
43+
44+### Example for `buildGoPackage` {#example-for-buildgopackage}
45+
46+In the following is an example expression using buildGoPackage, the following arguments are of special significance to the function:
47+
48+- `goPackagePath` specifies the package's canonical Go import path.
49+- `goDeps` is where the Go dependencies of a Go program are listed as a list of package source identified by Go import path. It could be imported as a separate `deps.nix` file for readability. The dependency data structure is described below.
50+
51+```nix
52+deis = buildGoPackage rec {
53+ pname = "deis";
54+ version = "1.13.0";
55+
56+ goPackagePath = "github.com/deis/deis";
57+
58+ src = fetchFromGitHub {
59+ owner = "deis";
60+ repo = "deis";
61+ rev = "v${version}";
62+ sha256 = "1qv9lxqx7m18029lj8cw3k7jngvxs4iciwrypdy0gd2nnghc68sw";
63+ };
64+
65+ goDeps = ./deps.nix;
66+}
67+```
68+
69+The `goDeps` attribute can be imported from a separate `nix` file that defines which Go libraries are needed and should be included in `GOPATH` for `buildPhase`:
70+
71+```nix
72+# deps.nix
73+[ # goDeps is a list of Go dependencies.
74+ {
75+ # goPackagePath specifies Go package import path.
76+ goPackagePath = "gopkg.in/yaml.v2";
77+ fetch = {
78+ # `fetch type` that needs to be used to get package source.
79+ # If `git` is used there should be `url`, `rev` and `sha256` defined next to it.
80+ type = "git";
81+ url = "https://gopkg.in/yaml.v2";
82+ rev = "a83829b6f1293c91addabc89d0571c246397bbf4";
83+ sha256 = "1m4dsmk90sbi17571h6pld44zxz7jc4lrnl4f27dpd1l8g5xvjhh";
84+ };
85+ }
86+ {
87+ goPackagePath = "github.com/docopt/docopt-go";
88+ fetch = {
89+ type = "git";
90+ url = "https://github.com/docopt/docopt-go";
91+ rev = "784ddc588536785e7299f7272f39101f7faccc3f";
92+ sha256 = "0wwz48jl9fvl1iknvn9dqr4gfy1qs03gxaikrxxp9gry6773v3sj";
93+ };
94+ }
95+]
96+```
97+
98+To extract dependency information from a Go package in automated way use [go2nix](https://github.com/kamilchm/go2nix). It can produce complete derivation and `goDeps` file for Go programs.
99+
100+You may use Go packages installed into the active Nix profiles by adding the following to your ~/.bashrc:
101+
102+```bash
103+for p in $NIX_PROFILES; do
104+ GOPATH="$p/share/go:$GOPATH"
105+done
106+```
107+
108+## Attributes used by the builders {#ssec-go-common-attributes}
109+
110+Both `buildGoModule` and `buildGoPackage` can be tweaked to behave slightly differently, if the following attributes are used:
111+
112+### `ldflags` {#var-go-ldflags}
113+
114+Arguments to pass to the Go linker tool via the `-ldflags` argument of `go build`. The most common use case for this argument is to make the resulting executable aware of its own version. For example:
115+
116+```nix
117+ ldflags = [
118+ "-s" "-w"
119+ "-X main.Version=${version}"
120+ "-X main.Commit=${version}"
121+ ];
122+```
123+
124+### `tags` {#var-go-tags}
125+
126+Arguments to pass to the Go via the `-tags` argument of `go build`. For example:
127+
128+```nix
129+ tags = [
130+ "production"
131+ "sqlite"
132+ ];
133+```
134+
135+```nix
136+ tags = [ "production" ] ++ lib.optionals withSqlite [ "sqlite" ];
137+```
138+
139+### `deleteVendor` {#var-go-deleteVendor}
140+
141+Removes the pre-existing vendor directory. This should only be used if the dependencies included in the vendor folder are broken or incomplete.
142+
143+### `subPackages` {#var-go-subPackages}
144+
145+Specified as a string or list of strings. Limits the builder from building child packages that have not been listed. If `subPackages` is not specified, all child packages will be built.
146+
147+### `excludedPackages` {#var-go-excludedPackages}
148+
149+Specified as a string or list of strings. Causes the builder to skip building child packages that match any of the provided values. If `excludedPackages` is not specified, all child packages will be built.
doc/languages-frameworks/haskell.section.mdnew file+7
@@ -0,0 +1,7 @@
1+# Haskell {#haskell}
2+
3+The documentation for the Haskell infrastructure is published at
4+<https://haskell4nix.readthedocs.io/>. The source code for that
5+site lives in the `doc/` sub-directory of the
6+[`cabal2nix` Git repository](https://github.com/NixOS/cabal2nix)
7+and changes can be submitted there.
doc/languages-frameworks/hy.section.mdnew file+31
@@ -0,0 +1,31 @@
1+# Hy {#sec-language-hy}
2+
3+## Installation {#ssec-hy-installation}
4+
5+### Installation without packages {#installation-without-packages}
6+
7+You can install `hy` via nix-env or by adding it to `configuration.nix` by reffering to it as a `hy` attribute. This kind of installation adds `hy` to your environment and it succesfully works with `python3`.
8+
9+::: {.caution}
10+Packages that are installed with your python derivation, are not accesible by `hy` this way.
11+:::
12+
13+### Installation with packages {#installation-with-packages}
14+
15+Creating `hy` derivation with custom `python` packages is really simple and similar to the way that python does it. Attribute `hy` provides function `withPackages` that creates custom `hy` derivation with specified packages.
16+
17+For example if you want to create shell with `matplotlib` and `numpy`, you can do it like so:
18+
19+```ShellSession
20+$ nix-shell -p "hy.withPackages (ps: with ps; [ numpy matplotlib ])"
21+```
22+
23+Or if you want to extend your `configuration.nix`:
24+```nix
25+{ # ...
26+
27+ environment.systemPackages = with pkgs; [
28+ (hy.withPackages (py-packages: with py-packages; [ numpy matplotlib ]))
29+ ];
30+}
31+```
doc/languages-frameworks/idris.section.mdnew file+143
@@ -0,0 +1,143 @@
1+# Idris {#idris}
2+
3+## Installing Idris {#installing-idris}
4+
5+The easiest way to get a working idris version is to install the `idris` attribute:
6+
7+```ShellSession
8+$ nix-env -f "<nixpkgs>" -iA idris
9+```
10+
11+This however only provides the `prelude` and `base` libraries. To install idris with additional libraries, you can use the `idrisPackages.with-packages` function, e.g. in an overlay in `~/.config/nixpkgs/overlays/my-idris.nix`:
12+
13+```nix
14+self: super: {
15+ myIdris = with self.idrisPackages; with-packages [ contrib pruviloj ];
16+}
17+```
18+
19+And then:
20+
21+```ShellSession
22+$ # On NixOS
23+$ nix-env -iA nixos.myIdris
24+$ # On non-NixOS
25+$ nix-env -iA nixpkgs.myIdris
26+```
27+
28+To see all available Idris packages:
29+
30+```ShellSession
31+$ # On NixOS
32+$ nix-env -qaPA nixos.idrisPackages
33+$ # On non-NixOS
34+$ nix-env -qaPA nixpkgs.idrisPackages
35+```
36+
37+Similarly, entering a `nix-shell`:
38+
39+```ShellSession
40+$ nix-shell -p 'idrisPackages.with-packages (with idrisPackages; [ contrib pruviloj ])'
41+```
42+
43+## Starting Idris with library support {#starting-idris-with-library-support}
44+
45+To have access to these libraries in idris, call it with an argument `-p <library name>` for each library:
46+
47+```ShellSession
48+$ nix-shell -p 'idrisPackages.with-packages (with idrisPackages; [ contrib pruviloj ])'
49+[nix-shell:~]$ idris -p contrib -p pruviloj
50+```
51+
52+A listing of all available packages the Idris binary has access to is available via `--listlibs`:
53+
54+```ShellSession
55+$ idris --listlibs
56+00prelude-idx.ibc
57+pruviloj
58+base
59+contrib
60+prelude
61+00pruviloj-idx.ibc
62+00base-idx.ibc
63+00contrib-idx.ibc
64+```
65+
66+## Building an Idris project with Nix {#building-an-idris-project-with-nix}
67+
68+As an example of how a Nix expression for an Idris package can be created, here is the one for `idrisPackages.yaml`:
69+
70+```nix
71+{ lib
72+, build-idris-package
73+, fetchFromGitHub
74+, contrib
75+, lightyear
76+}:
77+build-idris-package {
78+ name = "yaml";
79+ version = "2018-01-25";
80+
81+ # This is the .ipkg file that should be built, defaults to the package name
82+ # In this case it should build `Yaml.ipkg` instead of `yaml.ipkg`
83+ # This is only necessary because the yaml packages ipkg file is
84+ # different from its package name here.
85+ ipkgName = "Yaml";
86+ # Idris dependencies to provide for the build
87+ idrisDeps = [ contrib lightyear ];
88+
89+ src = fetchFromGitHub {
90+ owner = "Heather";
91+ repo = "Idris.Yaml";
92+ rev = "5afa51ffc839844862b8316faba3bafa15656db4";
93+ sha256 = "1g4pi0swmg214kndj85hj50ccmckni7piprsxfdzdfhg87s0avw7";
94+ };
95+
96+ meta = with lib; {
97+ description = "Idris YAML lib";
98+ homepage = "https://github.com/Heather/Idris.Yaml";
99+ license = licenses.mit;
100+ maintainers = [ maintainers.brainrape ];
101+ };
102+}
103+```
104+
105+Assuming this file is saved as `yaml.nix`, it's buildable using
106+
107+```ShellSession
108+$ nix-build -E '(import <nixpkgs> {}).idrisPackages.callPackage ./yaml.nix {}'
109+```
110+
111+Or it's possible to use
112+
113+```nix
114+with import <nixpkgs> {};
115+
116+{
117+ yaml = idrisPackages.callPackage ./yaml.nix {};
118+}
119+```
120+
121+in another file (say `default.nix`) to be able to build it with
122+
123+```ShellSession
124+$ nix-build -A yaml
125+```
126+
127+## Passing options to `idris` commands {#passing-options-to-idris-commands}
128+
129+The `build-idris-package` function provides also optional input values to set additional options for the used `idris` commands.
130+
131+Specifically, you can set `idrisBuildOptions`, `idrisTestOptions`, `idrisInstallOptions` and `idrisDocOptions` to provide additional options to the `idris` command respectively when building, testing, installing and generating docs for your package.
132+
133+For example you could set
134+
135+```nix
136+build-idris-package {
137+ idrisBuildOptions = [ "--log" "1" "--verbose" ]
138+
139+ ...
140+}
141+```
142+
143+to require verbose output during `idris` build phase.
doc/languages-frameworks/index.xmlnew file+42
@@ -0,0 +1,42 @@
1+<chapter xmlns="http://docbook.org/ns/docbook"
2+ xmlns:xi="http://www.w3.org/2001/XInclude"
3+ xml:id="chap-language-support">
4+ <title>Languages and frameworks</title>
5+ <para>
6+ The <link linkend="chap-stdenv">standard build environment</link> makes it easy to build typical Autotools-based packages with very little code. Any other kind of package can be accomodated by overriding the appropriate phases of <literal>stdenv</literal>. However, there are specialised functions in Nixpkgs to easily build packages for other programming languages, such as Perl or Haskell. These are described in this chapter.
7+ </para>
8+ <xi:include href="agda.section.xml" />
9+ <xi:include href="android.section.xml" />
10+ <xi:include href="beam.section.xml" />
11+ <xi:include href="bower.section.xml" />
12+ <xi:include href="chicken.section.xml" />
13+ <xi:include href="coq.section.xml" />
14+ <xi:include href="crystal.section.xml" />
15+ <xi:include href="cuda.section.xml" />
16+ <xi:include href="dhall.section.xml" />
17+ <xi:include href="dotnet.section.xml" />
18+ <xi:include href="emscripten.section.xml" />
19+ <xi:include href="gnome.section.xml" />
20+ <xi:include href="go.section.xml" />
21+ <xi:include href="haskell.section.xml" />
22+ <xi:include href="hy.section.xml" />
23+ <xi:include href="idris.section.xml" />
24+ <xi:include href="ios.section.xml" />
25+ <xi:include href="java.section.xml" />
26+ <xi:include href="javascript.section.xml" />
27+ <xi:include href="lua.section.xml" />
28+ <xi:include href="maven.section.xml" />
29+ <xi:include href="nim.section.xml" />
30+ <xi:include href="ocaml.section.xml" />
31+ <xi:include href="octave.section.xml" />
32+ <xi:include href="perl.section.xml" />
33+ <xi:include href="php.section.xml" />
34+ <xi:include href="python.section.xml" />
35+ <xi:include href="qt.section.xml" />
36+ <xi:include href="r.section.xml" />
37+ <xi:include href="ruby.section.xml" />
38+ <xi:include href="rust.section.xml" />
39+ <xi:include href="texlive.section.xml" />
40+ <xi:include href="titanium.section.xml" />
41+ <xi:include href="vim.section.xml" />
42+</chapter>
doc/languages-frameworks/ios.section.mdnew file+225
@@ -0,0 +1,225 @@
1+# iOS {#ios}
2+
3+This component is basically a wrapper/workaround that makes it possible to
4+expose an Xcode installation as a Nix package by means of symlinking to the
5+relevant executables on the host system.
6+
7+Since Xcode can't be packaged with Nix, nor we can publish it as a Nix package
8+(because of its license) this is basically the only integration strategy
9+making it possible to do iOS application builds that integrate with other
10+components of the Nix ecosystem
11+
12+The primary objective of this project is to use the Nix expression language to
13+specify how iOS apps can be built from source code, and to automatically spawn
14+iOS simulator instances for testing.
15+
16+This component also makes it possible to use [Hydra](https://nixos.org/hydra),
17+the Nix-based continuous integration server to regularly build iOS apps and to
18+do wireless ad-hoc installations of enterprise IPAs on iOS devices through
19+Hydra.
20+
21+The Xcode build environment implements a number of features.
22+
23+## Deploying a proxy component wrapper exposing Xcode {#deploying-a-proxy-component-wrapper-exposing-xcode}
24+
25+The first use case is deploying a Nix package that provides symlinks to the Xcode
26+installation on the host system. This package can be used as a build input to
27+any build function implemented in the Nix expression language that requires
28+Xcode.
29+
30+```nix
31+let
32+ pkgs = import <nixpkgs> {};
33+
34+ xcodeenv = import ./xcodeenv {
35+ inherit (pkgs) stdenv;
36+ };
37+in
38+xcodeenv.composeXcodeWrapper {
39+ version = "9.2";
40+ xcodeBaseDir = "/Applications/Xcode.app";
41+}
42+```
43+
44+By deploying the above expression with `nix-build` and inspecting its content
45+you will notice that several Xcode-related executables are exposed as a Nix
46+package:
47+
48+```bash
49+$ ls result/bin
50+lrwxr-xr-x 1 sander staff 94 1 jan 1970 Simulator -> /Applications/Xcode.app/Contents/Developer/Applications/Simulator.app/Contents/MacOS/Simulator
51+lrwxr-xr-x 1 sander staff 17 1 jan 1970 codesign -> /usr/bin/codesign
52+lrwxr-xr-x 1 sander staff 17 1 jan 1970 security -> /usr/bin/security
53+lrwxr-xr-x 1 sander staff 21 1 jan 1970 xcode-select -> /usr/bin/xcode-select
54+lrwxr-xr-x 1 sander staff 61 1 jan 1970 xcodebuild -> /Applications/Xcode.app/Contents/Developer/usr/bin/xcodebuild
55+lrwxr-xr-x 1 sander staff 14 1 jan 1970 xcrun -> /usr/bin/xcrun
56+```
57+
58+## Building an iOS application {#building-an-ios-application}
59+
60+We can build an iOS app executable for the simulator, or an IPA/xcarchive file
61+for release purposes, e.g. ad-hoc, enterprise or store installations, by
62+executing the `xcodeenv.buildApp {}` function:
63+
64+```nix
65+let
66+ pkgs = import <nixpkgs> {};
67+
68+ xcodeenv = import ./xcodeenv {
69+ inherit (pkgs) stdenv;
70+ };
71+in
72+xcodeenv.buildApp {
73+ name = "MyApp";
74+ src = ./myappsources;
75+ sdkVersion = "11.2";
76+
77+ target = null; # Corresponds to the name of the app by default
78+ configuration = null; # Release for release builds, Debug for debug builds
79+ scheme = null; # -scheme will correspond to the app name by default
80+ sdk = null; # null will set it to 'iphonesimulator` for simulator builds or `iphoneos` to real builds
81+ xcodeFlags = "";
82+
83+ release = true;
84+ certificateFile = ./mycertificate.p12;
85+ certificatePassword = "secret";
86+ provisioningProfile = ./myprovisioning.profile;
87+ signMethod = "ad-hoc"; # 'enterprise' or 'store'
88+ generateIPA = true;
89+ generateXCArchive = false;
90+
91+ enableWirelessDistribution = true;
92+ installURL = "/installipa.php";
93+ bundleId = "mycompany.myapp";
94+ appVersion = "1.0";
95+
96+ # Supports all xcodewrapper parameters as well
97+ xcodeBaseDir = "/Applications/Xcode.app";
98+}
99+```
100+
101+The above function takes a variety of parameters:
102+
103+* The `name` and `src` parameters are mandatory and specify the name of the app
104+ and the location where the source code resides
105+* `sdkVersion` specifies which version of the iOS SDK to use.
106+
107+It also possile to adjust the `xcodebuild` parameters. This is only needed in
108+rare circumstances. In most cases the default values should suffice:
109+
110+* Specifies which `xcodebuild` target to build. By default it takes the target
111+ that has the same name as the app.
112+* The `configuration` parameter can be overridden if desired. By default, it
113+ will do a debug build for the simulator and a release build for real devices.
114+* The `scheme` parameter specifies which `-scheme` parameter to propagate to
115+ `xcodebuild`. By default, it corresponds to the app name.
116+* The `sdk` parameter specifies which SDK to use. By default, it picks
117+ `iphonesimulator` for simulator builds and `iphoneos` for release builds.
118+* The `xcodeFlags` parameter specifies arbitrary command line parameters that
119+ should be propagated to `xcodebuild`.
120+
121+By default, builds are carried out for the iOS simulator. To do release builds
122+(builds for real iOS devices), you must set the `release` parameter to `true`.
123+In addition, you need to set the following parameters:
124+
125+* `certificateFile` refers to a P12 certificate file.
126+* `certificatePassword` specifies the password of the P12 certificate.
127+* `provisioningProfile` refers to the provision profile needed to sign the app
128+* `signMethod` should refer to `ad-hoc` for signing the app with an ad-hoc
129+ certificate, `enterprise` for enterprise certificates and `app-store` for App
130+ store certificates.
131+* `generateIPA` specifies that we want to produce an IPA file (this is probably
132+ what you want)
133+* `generateXCArchive` specifies thet we want to produce an xcarchive file.
134+
135+When building IPA files on Hydra and when it is desired to allow iOS devices to
136+install IPAs by browsing to the Hydra build products page, you can enable the
137+`enableWirelessDistribution` parameter.
138+
139+When enabled, you need to configure the following options:
140+
141+* The `installURL` parameter refers to the URL of a PHP script that composes the
142+ `itms-services://` URL allowing iOS devices to install the IPA file.
143+* `bundleId` refers to the bundle ID value of the app
144+* `appVersion` refers to the app's version number
145+
146+To use wireless adhoc distributions, you must also install the corresponding
147+PHP script on a web server (see section: 'Installing the PHP script for wireless
148+ad hoc installations from Hydra' for more information).
149+
150+In addition to the build parameters, you can also specify any parameters that
151+the `xcodeenv.composeXcodeWrapper {}` function takes. For example, the
152+`xcodeBaseDir` parameter can be overridden to refer to a different Xcode
153+version.
154+
155+## Spawning simulator instances {#spawning-simulator-instances}
156+
157+In addition to building iOS apps, we can also automatically spawn simulator
158+instances:
159+
160+```nix
161+let
162+ pkgs = import <nixpkgs> {};
163+
164+ xcodeenv = import ./xcodeenv {
165+ inherit (pkgs) stdenv;
166+ };
167+in
168+xcode.simulateApp {
169+ name = "simulate";
170+
171+ # Supports all xcodewrapper parameters as well
172+ xcodeBaseDir = "/Applications/Xcode.app";
173+}
174+```
175+
176+The above expression produces a script that starts the simulator from the
177+provided Xcode installation. The script can be started as follows:
178+
179+```bash
180+./result/bin/run-test-simulator
181+```
182+
183+By default, the script will show an overview of UDID for all available simulator
184+instances and asks you to pick one. You can also provide a UDID as a
185+command-line parameter to launch an instance automatically:
186+
187+```bash
188+./result/bin/run-test-simulator 5C93129D-CF39-4B1A-955F-15180C3BD4B8
189+```
190+
191+You can also extend the simulator script to automatically deploy and launch an
192+app in the requested simulator instance:
193+
194+```nix
195+let
196+ pkgs = import <nixpkgs> {};
197+
198+ xcodeenv = import ./xcodeenv {
199+ inherit (pkgs) stdenv;
200+ };
201+in
202+xcode.simulateApp {
203+ name = "simulate";
204+ bundleId = "mycompany.myapp";
205+ app = xcode.buildApp {
206+ # ...
207+ };
208+
209+ # Supports all xcodewrapper parameters as well
210+ xcodeBaseDir = "/Applications/Xcode.app";
211+}
212+```
213+
214+By providing the result of an `xcode.buildApp {}` function and configuring the
215+app bundle id, the app gets deployed automatically and started.
216+
217+## Troubleshooting {#troubleshooting}
218+
219+In some rare cases, it may happen that after a failure, changes are not picked
220+up. Most likely, this is caused by a derived data cache that Xcode maintains.
221+To wipe it you can run:
222+
223+```bash
224+$ rm -rf ~/Library/Developer/Xcode/DerivedData
225+```
doc/languages-frameworks/java.section.mdnew file+100
@@ -0,0 +1,100 @@
1+# Java {#sec-language-java}
2+
3+Ant-based Java packages are typically built from source as follows:
4+
5+```nix
6+stdenv.mkDerivation {
7+ name = "...";
8+ src = fetchurl { ... };
9+
10+ nativeBuildInputs = [ jdk ant ];
11+
12+ buildPhase = "ant";
13+}
14+```
15+
16+Note that `jdk` is an alias for the OpenJDK (self-built where available,
17+or pre-built via Zulu). Platforms with OpenJDK not (yet) in Nixpkgs
18+(`Aarch32`, `Aarch64`) point to the (unfree) `oraclejdk`.
19+
20+JAR files that are intended to be used by other packages should be
21+installed in `$out/share/java`. JDKs have a stdenv setup hook that add
22+any JARs in the `share/java` directories of the build inputs to the
23+`CLASSPATH` environment variable. For instance, if the package `libfoo`
24+installs a JAR named `foo.jar` in its `share/java` directory, and
25+another package declares the attribute
26+
27+```nix
28+buildInputs = [ libfoo ];
29+nativeBuildInputs = [ jdk ];
30+```
31+
32+then `CLASSPATH` will be set to
33+`/nix/store/...-libfoo/share/java/foo.jar`.
34+
35+Private JARs should be installed in a location like
36+`$out/share/package-name`.
37+
38+If your Java package provides a program, you need to generate a wrapper
39+script to run it using a JRE. You can use `makeWrapper` for this:
40+
41+```nix
42+nativeBuildInputs = [ makeWrapper ];
43+
44+installPhase = ''
45+ mkdir -p $out/bin
46+ makeWrapper ${jre}/bin/java $out/bin/foo \
47+ --add-flags "-cp $out/share/java/foo.jar org.foo.Main"
48+'';
49+```
50+
51+Since the introduction of the Java Platform Module System in Java 9,
52+Java distributions typically no longer ship with a general-purpose JRE:
53+instead, they allow generating a JRE with only the modules required for
54+your application(s). Because we can't predict what modules will be
55+needed on a general-purpose system, the default jre package is the full
56+JDK. When building a minimal system/image, you can override the
57+`modules` parameter on `jre_minimal` to build a JRE with only the
58+modules relevant for you:
59+
60+```nix
61+let
62+ my_jre = pkgs.jre_minimal.override {
63+ modules = [
64+ # The modules used by 'something' and 'other' combined:
65+ "java.base"
66+ "java.logging"
67+ ];
68+ };
69+ something = (pkgs.something.override { jre = my_jre; });
70+ other = (pkgs.other.override { jre = my_jre; });
71+in
72+ ...
73+```
74+
75+You can also specify what JDK your JRE should be based on, for example
76+selecting a 'headless' build to avoid including a link to GTK+:
77+
78+```nix
79+my_jre = pkgs.jre_minimal.override {
80+ jdk = jdk11_headless;
81+};
82+```
83+
84+Note all JDKs passthru `home`, so if your application requires
85+environment variables like `JAVA_HOME` being set, that can be done in a
86+generic fashion with the `--set` argument of `makeWrapper`:
87+
88+```bash
89+--set JAVA_HOME ${jdk.home}
90+```
91+
92+It is possible to use a different Java compiler than `javac` from the
93+OpenJDK. For instance, to use the GNU Java Compiler:
94+
95+```nix
96+nativeBuildInputs = [ gcj ant ];
97+```
98+
99+Here, Ant will automatically use `gij` (the GNU Java Runtime) instead of
100+the OpenJRE.
doc/languages-frameworks/javascript.section.mdnew file+278
@@ -0,0 +1,278 @@
1+# Javascript {#language-javascript}
2+
3+## Introduction {#javascript-introduction}
4+
5+This contains instructions on how to package javascript applications.
6+
7+The various tools available will be listed in the [tools-overview](#javascript-tools-overview). Some general principles for packaging will follow. Finally some tool specific instructions will be given.
8+
9+## Getting unstuck / finding code examples
10+
11+If you find you are lacking inspiration for packing javascript applications, the links below might prove useful.
12+Searching online for prior art can be helpful if you are running into solved problems.
13+
14+### Github
15+
16+- Searching Nix files for `mkYarnPackage`: <https://github.com/search?q=mkYarnPackage+language%3ANix&type=code>
17+
18+- Searching just `flake.nix` files for `mkYarnPackage`: <https://github.com/search?q=mkYarnPackage+filename%3Aflake.nix&type=code>
19+
20+### Gitlab
21+
22+- Searching Nix files for `mkYarnPackage`: <https://gitlab.com/search?scope=blobs&search=mkYarnPackage+extension%3Anix>
23+
24+- Searching just `flake.nix` files for `mkYarnPackage`: <https://gitlab.com/search?scope=blobs&search=mkYarnPackage+filename%3Aflake.nix>
25+
26+## Tools overview {#javascript-tools-overview}
27+
28+## General principles {#javascript-general-principles}
29+
30+The following principles are given in order of importance with potential exceptions.
31+
32+### Try to use the same node version used upstream {#javascript-upstream-node-version}
33+
34+It is often not documented which node version is used upstream, but if it is, try to use the same version when packaging.
35+
36+This can be a problem if upstream is using the latest and greatest and you are trying to use an earlier version of node. Some cryptic errors regarding V8 may appear.
37+
38+An exception to this:
39+
40+### Try to respect the package manager originally used by upstream (and use the upstream lock file) {#javascript-upstream-package-manager}
41+
42+A lock file (package-lock.json, yarn.lock...) is supposed to make reproducible installations of node_modules for each tool.
43+
44+Guidelines of package managers, recommend to commit those lock files to the repos. If a particular lock file is present, it is a strong indication of which package manager is used upstream.
45+
46+It's better to try to use a nix tool that understand the lock file. Using a different tool might give you hard to understand error because different packages have been installed. An example of problems that could arise can be found [here](https://github.com/NixOS/nixpkgs/pull/126629). Upstream uses npm, but this is an attempt to package it with yarn2nix (that uses yarn.lock)
47+
48+Using a different tool forces to commit a lock file to the repository. Those files are fairly large, so when packaging for nixpkgs, this approach does not scale well.
49+
50+Exceptions to this rule are:
51+
52+- when you encounter one of the bugs from a nix tool. In each of the tool specific instructions, known problems will be detailed. If you have a problem with a particular tool, then it's best to try another tool, even if this means you will have to recreate a lock file and commit it to nixpkgs. In general yarn2nix has less known problems and so a simple search in nixpkgs will reveal many yarn.lock files committed
53+- Some lock files contain particular version of a package that has been pulled off npm for some reason. In that case, you can recreate upstream lock (by removing the original and `npm install`, `yarn`, ...) and commit this to nixpkgs.
54+- The only tool that supports workspaces (a feature of npm that helps manage sub-directories with different package.json from a single top level package.json) is yarn2nix. If upstream has workspaces you should try yarn2nix.
55+
56+### Try to use upstream package.json {#javascript-upstream-package-json}
57+
58+Exceptions to this rule are
59+
60+- Sometimes the upstream repo assumes some dependencies be installed globally. In that case you can add them manually to the upstream package.json (`yarn add xxx` or `npm install xxx`, ...). Dependencies that are installed locally can be executed with `npx` for cli tools. (e.g. `npx postcss ...`, this is how you can call those dependencies in the phases).
61+- Sometimes there is a version conflict between some dependency requirements. In that case you can fix a version (by removing the `^`).
62+- Sometimes the script defined in the package.json does not work as is. Some scripts for example use cli tools that might not be available, or cd in directory with a different package.json (for workspaces notably). In that case, it's perfectly fine to look at what the particular script is doing and break this down in the phases. In the build script you can see `build:*` calling in turns several other build scripts like `build:ui` or `build:server`. If one of those fails, you can try to separate those into:
63+
64+```Shell
65+yarn build:ui
66+yarn build:server
67+# OR
68+npm run build:ui
69+npm run build:server
70+```
71+
72+when you need to override a package.json. It's nice to use the one from the upstream src and do some explicit override. Here is an example.
73+
74+```nix
75+patchedPackageJSON = final.runCommand "package.json" { } ''
76+ ${jq}/bin/jq '.version = "0.4.0" |
77+ .devDependencies."@jsdoc/cli" = "^0.2.5"
78+ ${sonar-src}/package.json > $out
79+'';
80+```
81+
82+you will still need to commit the modified version of the lock files, but at least the overrides are explicit for everyone to see.
83+
84+### Using node_modules directly {#javascript-using-node_modules}
85+
86+each tool has an abstraction to just build the node_modules (dependencies) directory. you can always use the stdenv.mkDerivation with the node_modules to build the package (symlink the node_modules directory and then use the package build command). the node_modules abstraction can be also used to build some web framework frontends. For an example of this see how [plausible](https://github.com/NixOS/nixpkgs/blob/master/pkgs/servers/web-apps/plausible/default.nix) is built. mkYarnModules to make the derivation containing node_modules. Then when building the frontend you can just symlink the node_modules directory
87+
88+## Javascript packages inside nixpkgs {#javascript-packages-nixpkgs}
89+
90+The `pkgs/development/node-packages` folder contains a generated collection of
91+[NPM packages](https://npmjs.com/) that can be installed with the Nix package
92+manager.
93+
94+As a rule of thumb, the package set should only provide _end user_ software
95+packages, such as command-line utilities. Libraries should only be added to the
96+package set if there is a non-NPM package that requires it.
97+
98+When it is desired to use NPM libraries in a development project, use the
99+`node2nix` generator directly on the `package.json` configuration file of the
100+project.
101+
102+The package set provides support for the official stable Node.js versions.
103+The latest stable LTS release in `nodePackages`, as well as the latest stable
104+Current release in `nodePackages_latest`.
105+
106+If your package uses native addons, you need to examine what kind of native
107+build system it uses. Here are some examples:
108+
109+- `node-gyp`
110+- `node-gyp-builder`
111+- `node-pre-gyp`
112+
113+After you have identified the correct system, you need to override your package
114+expression while adding in build system as a build input. For example, `dat`
115+requires `node-gyp-build`, so [we override](https://github.com/NixOS/nixpkgs/blob/32f5e5da4a1b3f0595527f5195ac3a91451e9b56/pkgs/development/node-packages/default.nix#L37-L40) its expression in [`default.nix`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/node-packages/default.nix):
116+
117+```nix
118+ dat = super.dat.override {
119+ buildInputs = [ self.node-gyp-build pkgs.libtool pkgs.autoconf pkgs.automake ];
120+ meta.broken = since "12";
121+ };
122+```
123+
124+### Adding and Updating Javascript packages in nixpkgs
125+
126+To add a package from NPM to nixpkgs:
127+
128+1. Modify `pkgs/development/node-packages/node-packages.json` to add, update
129+ or remove package entries to have it included in `nodePackages` and
130+ `nodePackages_latest`.
131+2. Run the script: `./pkgs/development/node-packages/generate.sh`.
132+3. Build your new package to test your changes:
133+ `cd /path/to/nixpkgs && nix-build -A nodePackages.<new-or-updated-package>`.
134+ To build against the latest stable Current Node.js version (e.g. 14.x):
135+ `nix-build -A nodePackages_latest.<new-or-updated-package>`
136+4. Add and commit all modified and generated files.
137+
138+For more information about the generation process, consult the
139+[README.md](https://github.com/svanderburg/node2nix) file of the `node2nix`
140+tool.
141+
142+To update NPM packages in nixpkgs, run the same `generate.sh` script:
143+
144+```sh
145+./pkgs/development/node-packages/generate.sh
146+```
147+
148+#### Git protocol error
149+
150+Some packages may have Git dependencies from GitHub specified with `git://`.
151+GitHub has
152+[disabled unecrypted Git connections](https://github.blog/2021-09-01-improving-git-protocol-security-github/#no-more-unauthenticated-git),
153+so you may see the following error when running the generate script:
154+`The unauthenticated git protocol on port 9418 is no longer supported`.
155+
156+Use the following Git configuration to resolve the issue:
157+
158+```sh
159+git config --global url."https://github.com/".insteadOf git://github.com/
160+```
161+
162+## Tool specific instructions {#javascript-tool-specific}
163+
164+### node2nix {#javascript-node2nix}
165+
166+#### Preparation {#javascript-node2nix-preparation}
167+
168+you will need to generate a nix expression for the dependencies
169+
170+- don't forget the `-l package-lock.json` if there is a lock file
171+- Most probably you will need the `--development` to include the `devDependencies`
172+
173+so the command will most likely be
174+`node2nix --development -l package-lock.json`
175+
176+[link to the doc in the repo](https://github.com/svanderburg/node2nix)
177+
178+#### Pitfalls {#javascript-node2nix-pitfalls}
179+
180+- if upstream package.json does not have a "version" attribute, node2nix will crash. You will need to add it like shown in [the package.json section](#javascript-upstream-package-json)
181+- node2nix has some [bugs](https://github.com/svanderburg/node2nix/issues/238). related to working with lock files from npm distributed with nodejs-16_x
182+- node2nix does not like missing packages from npm. If you see something like `Cannot resolve version: vue-loader-v16@undefined` then you might want to try another tool. The package might have been pulled off of npm.
183+
184+### yarn2nix {#javascript-yarn2nix}
185+
186+#### Preparation {#javascript-yarn2nix-preparation}
187+
188+you will need at least a yarn.lock and yarn.nix file
189+
190+- generate a yarn.lock in upstream if it is not already there
191+- `yarn2nix > yarn.nix` will generate the dependencies in a nix format
192+
193+#### mkYarnPackage {#javascript-yarn2nix-mkYarnPackage}
194+
195+this will by default try to generate a binary. For package only generating static assets (Svelte, Vue, React...), you will need to explicitly override the build step with your instructions. It's important to use the `--offline` flag. For example if you script is `"build": "something"` in package.json use
196+
197+```nix
198+buildPhase = ''
199+ yarn build --offline
200+'';
201+```
202+
203+The dist phase is also trying to build a binary, the only way to override it is with
204+
205+```nix
206+distPhase = "true";
207+```
208+
209+the configure phase can sometimes fail because it tries to be too clever.
210+One common override is
211+
212+```nix
213+configurePhase = "ln -s $node_modules node_modules";
214+```
215+
216+#### mkYarnModules {#javascript-yarn2nix-mkYarnModules}
217+
218+this will generate a derivation including the node_modules. If you have to build a derivation for an integrated web framework (rails, phoenix..), this is probably the easiest way. [Plausible](https://github.com/NixOS/nixpkgs/blob/master/pkgs/servers/web-apps/plausible/default.nix#L39) offers a good example of how to do this.
219+
220+#### Overriding dependency behavior
221+
222+In the `mkYarnPackage` record the property `pkgConfig` can be used to override packages when you encounter problems building.
223+
224+For instance, say your package is throwing errors when trying to invoke node-sass: `ENOENT: no such file or directory, scandir '/build/source/node_modules/node-sass/vendor'`
225+
226+To fix this we will specify different versions of build inputs to use, as well as some post install steps to get the software built the way we want:
227+
228+```nix
229+mkYarnPackage rec {
230+ pkgConfig = {
231+ node-sass = {
232+ buildInputs = with final;[ python libsass pkg-config ];
233+ postInstall = ''
234+ LIBSASS_EXT=auto yarn --offline run build
235+ rm build/config.gypi
236+ '';
237+ };
238+ };
239+}
240+```
241+
242+#### Pitfalls {#javascript-yarn2nix-pitfalls}
243+
244+- if version is missing from upstream package.json, yarn will silently install nothing. In that case, you will need to override package.json as shown in the [package.json section](#javascript-upstream-package-json)
245+
246+- having trouble with node-gyp? Try adding these lines to the `yarnPreBuild` steps:
247+
248+ ```nix
249+ yarnPreBuild = ''
250+ mkdir -p $HOME/.node-gyp/${nodejs.version}
251+ echo 9 > $HOME/.node-gyp/${nodejs.version}/installVersion
252+ ln -sfv ${nodejs}/include $HOME/.node-gyp/${nodejs.version}
253+ export npm_config_nodedir=${nodejs}
254+ '';
255+ ```
256+
257+ - The `echo 9` steps comes from this answer: <https://stackoverflow.com/a/49139496>
258+ - Exporting the headers in `npm_config_nodedir` comes from this issue: <https://github.com/nodejs/node-gyp/issues/1191#issuecomment-301243919>
259+
260+## Outside of nixpkgs {#javascript-outside-nixpkgs}
261+
262+There are some other options available that can't be used inside nixpkgs. Those other options are written in nix. Importing them in nixpkgs will require moving the source code into nixpkgs. Using [Import From Derivation](https://nixos.wiki/wiki/Import_From_Derivation) is not allowed in hydra at present. If you are packaging something outside nixpkgs, those can be considered
263+
264+### npmlock2nix {#javascript-npmlock2nix}
265+
266+[npmlock2nix](https://github.com/nix-community/npmlock2nix) aims at building node_modules without code generation. It hasn't reached v1 yet, the api might be subject to change.
267+
268+#### Pitfalls {#javascript-npmlock2nix-pitfalls}
269+
270+- there are some [problems with npm v7](https://github.com/tweag/npmlock2nix/issues/45).
271+
272+### nix-npm-buildpackage {#javascript-nix-npm-buildpackage}
273+
274+[nix-npm-buildpackage](https://github.com/serokell/nix-npm-buildpackage) aims at building node_modules without code generation. It hasn't reached v1 yet, the api might change. It supports both package-lock.json and yarn.lock.
275+
276+#### Pitfalls {#javascript-nix-npm-buildpackage-pitfalls}
277+
278+- there are some [problems with npm v7](https://github.com/serokell/nix-npm-buildpackage/issues/33).
doc/languages-frameworks/lua.section.mdnew file+253
@@ -0,0 +1,253 @@
1+# User’s Guide to Lua Infrastructure {#users-guide-to-lua-infrastructure}
2+
3+## Using Lua {#using-lua}
4+
5+### Overview of Lua {#overview-of-lua}
6+
7+Several versions of the Lua interpreter are available: luajit, lua 5.1, 5.2, 5.3.
8+The attribute `lua` refers to the default interpreter, it is also possible to refer to specific versions, e.g. `lua5_2` refers to Lua 5.2.
9+
10+Lua libraries are in separate sets, with one set per interpreter version.
11+
12+The interpreters have several common attributes. One of these attributes is
13+`pkgs`, which is a package set of Lua libraries for this specific
14+interpreter. E.g., the `busted` package corresponding to the default interpreter
15+is `lua.pkgs.busted`, and the lua 5.2 version is `lua5_2.pkgs.busted`.
16+The main package set contains aliases to these package sets, e.g.
17+`luaPackages` refers to `lua5_1.pkgs` and `lua52Packages` to
18+`lua5_2.pkgs`.
19+
20+### Installing Lua and packages {#installing-lua-and-packages}
21+
22+#### Lua environment defined in separate `.nix` file {#lua-environment-defined-in-separate-.nix-file}
23+
24+Create a file, e.g. `build.nix`, with the following expression
25+
26+```nix
27+with import <nixpkgs> {};
28+
29+lua5_2.withPackages (ps: with ps; [ busted luafilesystem ])
30+```
31+
32+and install it in your profile with
33+
34+```shell
35+nix-env -if build.nix
36+```
37+Now you can use the Lua interpreter, as well as the extra packages (`busted`,
38+`luafilesystem`) that you added to the environment.
39+
40+#### Lua environment defined in `~/.config/nixpkgs/config.nix` {#lua-environment-defined-in-.confignixpkgsconfig.nix}
41+
42+If you prefer to, you could also add the environment as a package override to the Nixpkgs set, e.g.
43+using `config.nix`,
44+
45+```nix
46+{ # ...
47+
48+ packageOverrides = pkgs: with pkgs; {
49+ myLuaEnv = lua5_2.withPackages (ps: with ps; [ busted luafilesystem ]);
50+ };
51+}
52+```
53+
54+and install it in your profile with
55+
56+```shell
57+nix-env -iA nixpkgs.myLuaEnv
58+```
59+The environment is installed by referring to the attribute, and considering
60+the `nixpkgs` channel was used.
61+
62+#### Lua environment defined in `/etc/nixos/configuration.nix` {#lua-environment-defined-in-etcnixosconfiguration.nix}
63+
64+For the sake of completeness, here's another example how to install the environment system-wide.
65+
66+```nix
67+{ # ...
68+
69+ environment.systemPackages = with pkgs; [
70+ (lua.withPackages(ps: with ps; [ busted luafilesystem ]))
71+ ];
72+}
73+```
74+
75+### How to override a Lua package using overlays? {#how-to-override-a-lua-package-using-overlays}
76+
77+Use the following overlay template:
78+
79+```nix
80+final: prev:
81+{
82+
83+ lua = prev.lua.override {
84+ packageOverrides = luaself: luaprev: {
85+
86+ luarocks-nix = luaprev.luarocks-nix.overrideAttrs(oa: {
87+ pname = "luarocks-nix";
88+ src = /home/my_luarocks/repository;
89+ });
90+ };
91+
92+ luaPackages = lua.pkgs;
93+}
94+```
95+
96+### Temporary Lua environment with `nix-shell` {#temporary-lua-environment-with-nix-shell}
97+
98+
99+There are two methods for loading a shell with Lua packages. The first and recommended method
100+is to create an environment with `lua.buildEnv` or `lua.withPackages` and load that. E.g.
101+
102+```sh
103+$ nix-shell -p 'lua.withPackages(ps: with ps; [ busted luafilesystem ])'
104+```
105+
106+opens a shell from which you can launch the interpreter
107+
108+```sh
109+[nix-shell:~] lua
110+```
111+
112+The other method, which is not recommended, does not create an environment and requires you to list the packages directly,
113+
114+```sh
115+$ nix-shell -p lua.pkgs.busted lua.pkgs.luafilesystem
116+```
117+Again, it is possible to launch the interpreter from the shell.
118+The Lua interpreter has the attribute `pkgs` which contains all Lua libraries for that specific interpreter.
119+
120+
121+## Developing with Lua {#developing-with-lua}
122+
123+Now that you know how to get a working Lua environment with Nix, it is time
124+to go forward and start actually developing with Lua. There are two ways to
125+package lua software, either it is on luarocks and most of it can be taken care
126+of by the luarocks2nix converter or the packaging has to be done manually.
127+Let's present the luarocks way first and the manual one in a second time.
128+
129+### Packaging a library on luarocks {#packaging-a-library-on-luarocks}
130+
131+[Luarocks.org](https://luarocks.org/) is the main repository of lua packages.
132+The site proposes two types of packages, the rockspec and the src.rock
133+(equivalent of a [rockspec](https://github.com/luarocks/luarocks/wiki/Rockspec-format) but with the source).
134+These packages can have different build types such as `cmake`, `builtin` etc .
135+
136+Luarocks-based packages are generated in pkgs/development/lua-modules/generated-packages.nix from
137+the whitelist maintainers/scripts/luarocks-packages.csv and updated by running maintainers/scripts/update-luarocks-packages.
138+
139+[luarocks2nix](https://github.com/nix-community/luarocks) is a tool capable of generating nix derivations from both rockspec and src.rock (and favors the src.rock).
140+The automation only goes so far though and some packages need to be customized.
141+These customizations go in `pkgs/development/lua-modules/overrides.nix`.
142+For instance if the rockspec defines `external_dependencies`, these need to be manually added to the overrides.nix.
143+
144+You can try converting luarocks packages to nix packages with the command `nix-shell -p luarocks-nix` and then `luarocks nix PKG_NAME`.
145+
146+#### Packaging a library manually {#packaging-a-library-manually}
147+
148+You can develop your package as you usually would, just don't forget to wrap it
149+within a `toLuaModule` call, for instance
150+
151+```nix
152+mynewlib = toLuaModule ( stdenv.mkDerivation { ... });
153+```
154+
155+There is also the `buildLuaPackage` function that can be used when lua modules
156+are not packaged for luarocks. You can see a few examples at `pkgs/top-level/lua-packages.nix`.
157+
158+## Lua Reference {#lua-reference}
159+
160+### Lua interpreters {#lua-interpreters}
161+
162+Versions 5.1, 5.2, 5.3 and 5.4 of the lua interpreter are available as
163+respectively `lua5_1`, `lua5_2`, `lua5_3` and `lua5_4`. Luajit is available too.
164+The Nix expressions for the interpreters can be found in `pkgs/development/interpreters/lua-5`.
165+
166+#### Attributes on lua interpreters packages {#attributes-on-lua-interpreters-packages}
167+
168+Each interpreter has the following attributes:
169+
170+- `interpreter`. Alias for `${pkgs.lua}/bin/lua`.
171+- `buildEnv`. Function to build lua interpreter environments with extra packages bundled together. See section *lua.buildEnv function* for usage and documentation.
172+- `withPackages`. Simpler interface to `buildEnv`.
173+- `pkgs`. Set of Lua packages for that specific interpreter. The package set can be modified by overriding the interpreter and passing `packageOverrides`.
174+
175+#### `buildLuarocksPackage` function {#buildluarockspackage-function}
176+
177+The `buildLuarocksPackage` function is implemented in `pkgs/development/interpreters/lua-5/build-lua-package.nix`
178+The following is an example:
179+```nix
180+luaposix = buildLuarocksPackage {
181+ pname = "luaposix";
182+ version = "34.0.4-1";
183+
184+ src = fetchurl {
185+ url = "https://raw.githubusercontent.com/rocks-moonscript-org/moonrocks-mirror/master/luaposix-34.0.4-1.src.rock";
186+ sha256 = "0yrm5cn2iyd0zjd4liyj27srphvy0gjrjx572swar6zqr4dwjqp2";
187+ };
188+ disabled = (luaOlder "5.1") || (luaAtLeast "5.4");
189+ propagatedBuildInputs = [ bit32 lua std_normalize ];
190+
191+ meta = with lib; {
192+ homepage = "https://github.com/luaposix/luaposix/";
193+ description = "Lua bindings for POSIX";
194+ maintainers = with maintainers; [ vyp lblasc ];
195+ license.fullName = "MIT/X11";
196+ };
197+};
198+```
199+
200+The `buildLuarocksPackage` delegates most tasks to luarocks:
201+
202+* it adds `luarocks` as an unpacker for `src.rock` files (zip files really).
203+* configurePhase` writes a temporary luarocks configuration file which location
204+is exported via the environment variable `LUAROCKS_CONFIG`.
205+* the `buildPhase` does nothing.
206+* `installPhase` calls `luarocks make --deps-mode=none --tree $out` to build and
207+install the package
208+* In the `postFixup` phase, the `wrapLuaPrograms` bash function is called to
209+ wrap all programs in the `$out/bin/*` directory to include `$PATH`
210+ environment variable and add dependent libraries to script's `LUA_PATH` and
211+ `LUA_CPATH`.
212+
213+By default `meta.platforms` is set to the same value as the interpreter unless overridden otherwise.
214+
215+#### `buildLuaApplication` function {#buildluaapplication-function}
216+
217+The `buildLuaApplication` function is practically the same as `buildLuaPackage`.
218+The difference is that `buildLuaPackage` by default prefixes the names of the packages with the version of the interpreter.
219+Because with an application we're not interested in multiple version the prefix is dropped.
220+
221+#### lua.withPackages function {#lua.withpackages-function}
222+
223+The `lua.withPackages` takes a function as an argument that is passed the set of lua packages and returns the list of packages to be included in the environment.
224+Using the `withPackages` function, the previous example for the luafilesystem environment can be written like this:
225+
226+```nix
227+with import <nixpkgs> {};
228+
229+lua.withPackages (ps: [ps.luafilesystem])
230+```
231+
232+`withPackages` passes the correct package set for the specific interpreter version as an argument to the function. In the above example, `ps` equals `luaPackages`.
233+But you can also easily switch to using `lua5_2`:
234+
235+```nix
236+with import <nixpkgs> {};
237+
238+lua5_2.withPackages (ps: [ps.lua])
239+```
240+
241+Now, `ps` is set to `lua52Packages`, matching the version of the interpreter.
242+
243+### Possible Todos {#possible-todos}
244+
245+* export/use version specific variables such as `LUA_PATH_5_2`/`LUAROCKS_CONFIG_5_2`
246+* let luarocks check for dependencies via exporting the different rocktrees in temporary config
247+
248+### Lua Contributing guidelines {#lua-contributing-guidelines}
249+
250+Following rules should be respected:
251+
252+* Make sure libraries build for all Lua interpreters.
253+* Commit names of Lua libraries should reflect that they are Lua libraries, so write for example `luaPackages.luafilesystem: 1.11 -> 1.12`.
doc/languages-frameworks/maven.section.mdnew file+351
@@ -0,0 +1,351 @@
1+# Maven {#maven}
2+
3+Maven is a well-known build tool for the Java ecosystem however it has some challenges when integrating into the Nix build system.
4+
5+The following provides a list of common patterns with how to package a Maven project (or any JVM language that can export to Maven) as a Nix package.
6+
7+For the purposes of this example let's consider a very basic Maven project with the following `pom.xml` with a single dependency on [emoji-java](https://github.com/vdurmont/emoji-java).
8+
9+```xml
10+<?xml version="1.0" encoding="UTF-8"?>
11+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
12+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
13+ <modelVersion>4.0.0</modelVersion>
14+ <groupId>io.github.fzakaria</groupId>
15+ <artifactId>maven-demo</artifactId>
16+ <version>1.0</version>
17+ <packaging>jar</packaging>
18+ <name>NixOS Maven Demo</name>
19+
20+ <dependencies>
21+ <dependency>
22+ <groupId>com.vdurmont</groupId>
23+ <artifactId>emoji-java</artifactId>
24+ <version>5.1.1</version>
25+ </dependency>
26+ </dependencies>
27+</project>
28+```
29+
30+Our main class file will be very simple:
31+
32+```java
33+import com.vdurmont.emoji.EmojiParser;
34+
35+public class Main {
36+ public static void main(String[] args) {
37+ String str = "NixOS :grinning: is super cool :smiley:!";
38+ String result = EmojiParser.parseToUnicode(str);
39+ System.out.println(result);
40+ }
41+}
42+```
43+
44+You find this demo project at https://github.com/fzakaria/nixos-maven-example
45+
46+## Solving for dependencies {#solving-for-dependencies}
47+
48+### buildMaven with NixOS/mvn2nix-maven-plugin {#buildmaven-with-nixosmvn2nix-maven-plugin}
49+
50+> ⚠️ Although `buildMaven` is the "blessed" way within nixpkgs, as of 2020, it hasn't seen much activity in quite a while.
51+
52+`buildMaven` is an alternative method that tries to follow similar patterns of other programming languages by generating a lock file. It relies on the maven plugin [mvn2nix-maven-plugin](https://github.com/NixOS/mvn2nix-maven-plugin).
53+
54+First you generate a `project-info.json` file using the maven plugin.
55+
56+> This should be executed in the project's source repository or be told which `pom.xml` to execute with.
57+
58+```bash
59+# run this step within the project's source repository
60+❯ mvn org.nixos.mvn2nix:mvn2nix-maven-plugin:mvn2nix
61+
62+❯ cat project-info.json | jq | head
63+{
64+ "project": {
65+ "artifactId": "maven-demo",
66+ "groupId": "org.nixos",
67+ "version": "1.0",
68+ "classifier": "",
69+ "extension": "jar",
70+ "dependencies": [
71+ {
72+ "artifactId": "maven-resources-plugin",
73+```
74+
75+This file is then given to the `buildMaven` function, and it returns 2 attributes.
76+
77+**`repo`**:
78+ A Maven repository that is a symlink farm of all the dependencies found in the `project-info.json`
79+
80+
81+**`build`**:
82+ A simple derivation that runs through `mvn compile` & `mvn package` to build the JAR. You may use this as inspiration for more complicated derivations.
83+
84+Here is an [example](https://github.com/fzakaria/nixos-maven-example/blob/main/build-maven-repository.nix) of building the Maven repository
85+
86+```nix
87+{ pkgs ? import <nixpkgs> { } }:
88+with pkgs;
89+(buildMaven ./project-info.json).repo
90+```
91+
92+The benefit over the _double invocation_ as we will see below, is that the _/nix/store_ entry is a _linkFarm_ of every package, so that changes to your dependency set doesn't involve downloading everything from scratch.
93+
94+```bash
95+❯ tree $(nix-build --no-out-link build-maven-repository.nix) | head
96+/nix/store/g87va52nkc8jzbmi1aqdcf2f109r4dvn-maven-repository
97+├── antlr
98+│ └── antlr
99+│ └── 2.7.2
100+│ ├── antlr-2.7.2.jar -> /nix/store/d027c8f2cnmj5yrynpbq2s6wmc9cb559-antlr-2.7.2.jar
101+│ └── antlr-2.7.2.pom -> /nix/store/mv42fc5gizl8h5g5vpywz1nfiynmzgp2-antlr-2.7.2.pom
102+├── avalon-framework
103+│ └── avalon-framework
104+│ └── 4.1.3
105+│ ├── avalon-framework-4.1.3.jar -> /nix/store/iv5fp3955w3nq28ff9xfz86wvxbiw6n9-avalon-framework-4.1.3.jar
106+```
107+
108+### Double Invocation {#double-invocation}
109+
110+> ⚠️ This pattern is the simplest but may cause unnecessary rebuilds due to the output hash changing.
111+
112+The double invocation is a _simple_ way to get around the problem that `nix-build` may be sandboxed and have no Internet connectivity.
113+
114+It treats the entire Maven repository as a single source to be downloaded, relying on Maven's dependency resolution to satisfy the output hash. This is similar to fetchers like `fetchgit`, except it has to run a Maven build to determine what to download.
115+
116+The first step will be to build the Maven project as a fixed-output derivation in order to collect the Maven repository -- below is an [example](https://github.com/fzakaria/nixos-maven-example/blob/main/double-invocation-repository.nix).
117+
118+> Traditionally the Maven repository is at `~/.m2/repository`. We will override this to be the `$out` directory.
119+
120+```nix
121+{ lib, stdenv, maven }:
122+stdenv.mkDerivation {
123+ name = "maven-repository";
124+ buildInputs = [ maven ];
125+ src = ./.; # or fetchFromGitHub, cleanSourceWith, etc
126+ buildPhase = ''
127+ mvn package -Dmaven.repo.local=$out
128+ '';
129+
130+ # keep only *.{pom,jar,sha1,nbm} and delete all ephemeral files with lastModified timestamps inside
131+ installPhase = ''
132+ find $out -type f \
133+ -name \*.lastUpdated -or \
134+ -name resolver-status.properties -or \
135+ -name _remote.repositories \
136+ -delete
137+ '';
138+
139+ # don't do any fixup
140+ dontFixup = true;
141+ outputHashAlgo = "sha256";
142+ outputHashMode = "recursive";
143+ # replace this with the correct SHA256
144+ outputHash = lib.fakeSha256;
145+}
146+```
147+
148+The build will fail, and tell you the expected `outputHash` to place. When you've set the hash, the build will return with a `/nix/store` entry whose contents are the full Maven repository.
149+
150+> Some additional files are deleted that would cause the output hash to change potentially on subsequent runs.
151+
152+```bash
153+❯ tree $(nix-build --no-out-link double-invocation-repository.nix) | head
154+/nix/store/8kicxzp98j68xyi9gl6jda67hp3c54fq-maven-repository
155+├── backport-util-concurrent
156+│ └── backport-util-concurrent
157+│ └── 3.1
158+│ ├── backport-util-concurrent-3.1.pom
159+│ └── backport-util-concurrent-3.1.pom.sha1
160+├── classworlds
161+│ └── classworlds
162+│ ├── 1.1
163+│ │ ├── classworlds-1.1.jar
164+```
165+
166+If your package uses _SNAPSHOT_ dependencies or _version ranges_; there is a strong likelihood that over-time your output hash will change since the resolved dependencies may change. Hence this method is less recommended then using `buildMaven`.
167+
168+## Building a JAR {#building-a-jar}
169+
170+Regardless of which strategy is chosen above, the step to build the derivation is the same.
171+
172+```nix
173+{ stdenv, maven, callPackage }:
174+# pick a repository derivation, here we will use buildMaven
175+let repository = callPackage ./build-maven-repository.nix { };
176+in stdenv.mkDerivation rec {
177+ pname = "maven-demo";
178+ version = "1.0";
179+
180+ src = builtins.fetchTarball "https://github.com/fzakaria/nixos-maven-example/archive/main.tar.gz";
181+ buildInputs = [ maven ];
182+
183+ buildPhase = ''
184+ echo "Using repository ${repository}"
185+ mvn --offline -Dmaven.repo.local=${repository} package;
186+ '';
187+
188+ installPhase = ''
189+ install -Dm644 target/${pname}-${version}.jar $out/share/java
190+ '';
191+}
192+```
193+
194+> We place the library in `$out/share/java` since JDK package has a _stdenv setup hook_ that adds any JARs in the `share/java` directories of the build inputs to the CLASSPATH environment.
195+
196+```bash
197+❯ tree $(nix-build --no-out-link build-jar.nix)
198+/nix/store/7jw3xdfagkc2vw8wrsdv68qpsnrxgvky-maven-demo-1.0
199+└── share
200+ └── java
201+ └── maven-demo-1.0.jar
202+
203+2 directories, 1 file
204+```
205+
206+## Runnable JAR {#runnable-jar}
207+
208+The previous example builds a `jar` file but that's not a file one can run.
209+
210+You need to use it with `java -jar $out/share/java/output.jar` and make sure to provide the required dependencies on the classpath.
211+
212+The following explains how to use `makeWrapper` in order to make the derivation produce an executable that will run the JAR file you created.
213+
214+We will use the same repository we built above (either _double invocation_ or _buildMaven_) to setup a CLASSPATH for our JAR.
215+
216+The following two methods are more suited to Nix then building an [UberJar](https://imagej.net/Uber-JAR) which may be the more traditional approach.
217+
218+### CLASSPATH {#classpath}
219+
220+> This is ideal if you are providing a derivation for _nixpkgs_ and don't want to patch the project's `pom.xml`.
221+
222+We will read the Maven repository and flatten it to a single list. This list will then be concatenated with the _CLASSPATH_ separator to create the full classpath.
223+
224+We make sure to provide this classpath to the `makeWrapper`.
225+
226+```nix
227+{ stdenv, maven, callPackage, makeWrapper, jre }:
228+let
229+ repository = callPackage ./build-maven-repository.nix { };
230+in stdenv.mkDerivation rec {
231+ pname = "maven-demo";
232+ version = "1.0";
233+
234+ src = builtins.fetchTarball
235+ "https://github.com/fzakaria/nixos-maven-example/archive/main.tar.gz";
236+ buildInputs = [ maven makeWrapper ];
237+
238+ buildPhase = ''
239+ echo "Using repository ${repository}"
240+ mvn --offline -Dmaven.repo.local=${repository} package;
241+ '';
242+
243+ installPhase = ''
244+ mkdir -p $out/bin
245+
246+ classpath=$(find ${repository} -name "*.jar" -printf ':%h/%f');
247+ install -Dm644 target/${pname}-${version}.jar $out/share/java
248+ # create a wrapper that will automatically set the classpath
249+ # this should be the paths from the dependency derivation
250+ makeWrapper ${jre}/bin/java $out/bin/${pname} \
251+ --add-flags "-classpath $out/share/java/${pname}-${version}.jar:''${classpath#:}" \
252+ --add-flags "Main"
253+ '';
254+}
255+```
256+
257+### MANIFEST file via Maven Plugin {#manifest-file-via-maven-plugin}
258+
259+> This is ideal if you are the project owner and want to change your `pom.xml` to set the CLASSPATH within it.
260+
261+Augment the `pom.xml` to create a JAR with the following manifest:
262+
263+```xml
264+<build>
265+ <plugins>
266+ <plugin>
267+ <artifactId>maven-jar-plugin</artifactId>
268+ <configuration>
269+ <archive>
270+ <manifest>
271+ <addClasspath>true</addClasspath>
272+ <classpathPrefix>../../repository/</classpathPrefix>
273+ <classpathLayoutType>repository</classpathLayoutType>
274+ <mainClass>Main</mainClass>
275+ </manifest>
276+ <manifestEntries>
277+ <Class-Path>.</Class-Path>
278+ </manifestEntries>
279+ </archive>
280+ </configuration>
281+ </plugin>
282+ </plugins>
283+</build>
284+```
285+
286+The above plugin instructs the JAR to look for the necessary dependencies in the `lib/` relative folder. The layout of the folder is also in the _maven repository_ style.
287+
288+```bash
289+❯ unzip -q -c $(nix-build --no-out-link runnable-jar.nix)/share/java/maven-demo-1.0.jar META-INF/MANIFEST.MF
290+
291+Manifest-Version: 1.0
292+Archiver-Version: Plexus Archiver
293+Built-By: nixbld
294+Class-Path: . ../../repository/com/vdurmont/emoji-java/5.1.1/emoji-jav
295+ a-5.1.1.jar ../../repository/org/json/json/20170516/json-20170516.jar
296+Created-By: Apache Maven 3.6.3
297+Build-Jdk: 1.8.0_265
298+Main-Class: Main
299+```
300+
301+We will modify the derivation above to add a symlink to our repository so that it's accessible to our JAR during the `installPhase`.
302+
303+```nix
304+{ stdenv, maven, callPackage, makeWrapper, jre }:
305+# pick a repository derivation, here we will use buildMaven
306+let repository = callPackage ./build-maven-repository.nix { };
307+in stdenv.mkDerivation rec {
308+ pname = "maven-demo";
309+ version = "1.0";
310+
311+ src = builtins.fetchTarball
312+ "https://github.com/fzakaria/nixos-maven-example/archive/main.tar.gz";
313+ buildInputs = [ maven makeWrapper ];
314+
315+ buildPhase = ''
316+ echo "Using repository ${repository}"
317+ mvn --offline -Dmaven.repo.local=${repository} package;
318+ '';
319+
320+ installPhase = ''
321+ mkdir -p $out/bin
322+
323+ # create a symbolic link for the repository directory
324+ ln -s ${repository} $out/repository
325+
326+ install -Dm644 target/${pname}-${version}.jar $out/share/java
327+ # create a wrapper that will automatically set the classpath
328+ # this should be the paths from the dependency derivation
329+ makeWrapper ${jre}/bin/java $out/bin/${pname} \
330+ --add-flags "-jar $out/share/java/${pname}-${version}.jar"
331+ '';
332+}
333+```
334+
335+> Our script produces a dependency on `jre` rather than `jdk` to restrict the runtime closure necessary to run the application.
336+
337+This will give you an executable shell-script that launches your JAR with all the dependencies available.
338+
339+```bash
340+❯ tree $(nix-build --no-out-link runnable-jar.nix)
341+/nix/store/8d4c3ibw8ynsn01ibhyqmc1zhzz75s26-maven-demo-1.0
342+├── bin
343+│ └── maven-demo
344+├── repository -> /nix/store/g87va52nkc8jzbmi1aqdcf2f109r4dvn-maven-repository
345+└── share
346+ └── java
347+ └── maven-demo-1.0.jar
348+
349+❯ $(nix-build --no-out-link --option tarball-ttl 1 runnable-jar.nix)/bin/maven-demo
350+NixOS 😀 is super cool 😃!
351+```
doc/languages-frameworks/nim.section.mdnew file+91
@@ -0,0 +1,91 @@
1+# Nim {#nim}
2+
3+## Overview {#nim-overview}
4+
5+The Nim compiler, a builder function, and some packaged libraries are available
6+in Nixpkgs. Until now each compiler release has been effectively backwards
7+compatible so only the latest version is available.
8+
9+## Nim program packages in Nixpkgs {#nim-program-packages-in-nixpkgs}
10+
11+Nim programs can be built using `nimPackages.buildNimPackage`. In the
12+case of packages not containing exported library code the attribute
13+`nimBinOnly` should be set to `true`.
14+
15+The following example shows a Nim program that depends only on Nim libraries:
16+
17+```nix
18+{ lib, nimPackages, fetchurl }:
19+
20+nimPackages.buildNimPackage rec {
21+ pname = "hottext";
22+ version = "1.4";
23+
24+ nimBinOnly = true;
25+
26+ src = fetchurl {
27+ url = "https://git.sr.ht/~ehmry/hottext/archive/v${version}.tar.gz";
28+ sha256 = "sha256-hIUofi81zowSMbt1lUsxCnVzfJGN3FEiTtN8CEFpwzY=";
29+ };
30+
31+ buildInputs = with nimPackages; [
32+ bumpy
33+ chroma
34+ flatty
35+ nimsimd
36+ pixie
37+ sdl2
38+ typography
39+ vmath
40+ zippy
41+ ];
42+}
43+
44+```
45+
46+## Nim library packages in Nixpkgs {#nim-library-packages-in-nixpkgs}
47+
48+
49+Nim libraries can also be built using `nimPackages.buildNimPackage`, but
50+often the product of a fetcher is sufficient to satisfy a dependency.
51+The `fetchgit`, `fetchFromGitHub`, and `fetchNimble` functions yield an
52+output that can be discovered during the `configurePhase` of `buildNimPackage`.
53+
54+Nim library packages are listed in
55+[pkgs/top-level/nim-packages.nix](https://github.com/NixOS/nixpkgs/blob/master/pkgs/top-level/nim-packages.nix) and implemented at
56+[pkgs/development/nim-packages](https://github.com/NixOS/nixpkgs/tree/master/pkgs/development/nim-packages).
57+
58+The following example shows a Nim library that propagates a dependency on a
59+non-Nim package:
60+```nix
61+{ lib, buildNimPackage, fetchNimble, SDL2 }:
62+
63+buildNimPackage rec {
64+ pname = "sdl2";
65+ version = "2.0.4";
66+ src = fetchNimble {
67+ inherit pname version;
68+ hash = "sha256-Vtcj8goI4zZPQs2TbFoBFlcR5UqDtOldaXSH/+/xULk=";
69+ };
70+ propagatedBuildInputs = [ SDL2 ];
71+}
72+```
73+
74+## `buildNimPackage` parameters {#buildnimpackage-parameters}
75+
76+All parameters from `stdenv.mkDerivation` function are still supported. The
77+following are specific to `buildNimPackage`:
78+
79+* `nimBinOnly ? false`: If `true` then build only the programs listed in
80+ the Nimble file in the packages sources.
81+* `nimbleFile`: Specify the Nimble file location of the package being built
82+ rather than discover the file at build-time.
83+* `nimRelease ? true`: Build the package in *release* mode.
84+* `nimDefines ? []`: A list of Nim defines. Key-value tuples are not supported.
85+* `nimFlags ? []`: A list of command line arguments to pass to the Nim compiler.
86+ Use this to specify defines with arguments in the form of `-d:${name}=${value}`.
87+* `nimDoc` ? false`: Build and install HTML documentation.
88+
89+* `buildInputs` ? []: The packages listed here will be searched for `*.nimble`
90+ files which are used to populate the Nim library path. Otherwise the standard
91+ behavior is in effect.
doc/languages-frameworks/ocaml.section.mdnew file+131
@@ -0,0 +1,131 @@
1+# OCaml {#sec-language-ocaml}
2+
3+## User guide {#sec-language-ocaml-user-guide}
4+
5+OCaml libraries are available in attribute sets of the form `ocaml-ng.ocamlPackages_X_XX` where X is to be replaced with the desired compiler version. For example, ocamlgraph compiled with OCaml 4.12 can be found in `ocaml-ng.ocamlPackages_4_12.ocamlgraph`. The compiler itself is also located in this set, under the name `ocaml`.
6+
7+If you don't care about the exact compiler version, `ocamlPackages` is a top-level alias pointing to a recent version of OCaml.
8+
9+OCaml applications are usually available top-level, and not inside `ocamlPackages`. Notable exceptions are build tools that must be built with the same compiler version as the compiler you intend to use like `dune` or `ocaml-lsp`.
10+
11+To open a shell able to build a typical OCaml project, put the dependencies in `buildInputs` and add `ocamlPackages.ocaml` and `ocamlPackages.findlib` to `nativeBuildInputs` at least.
12+For example:
13+```nix
14+let
15+ pkgs = import <nixpkgs> {};
16+ # choose the ocaml version you want to use
17+ ocamlPackages = pkgs.ocaml-ng.ocamlPackages_4_12;
18+in
19+pkgs.mkShell {
20+ # build tools
21+ nativeBuildInputs = with ocamlPackages; [ ocaml findlib dune_2 ocaml-lsp ];
22+ # dependencies
23+ buildInputs = with ocamlPackages; [ ocamlgraph ];
24+}
25+```
26+
27+## Packaging guide {#sec-language-ocaml-packaging}
28+
29+OCaml libraries should be installed in `$(out)/lib/ocaml/${ocaml.version}/site-lib/`. Such directories are automatically added to the `$OCAMLPATH` environment variable when building another package that depends on them or when opening a `nix-shell`.
30+
31+Given that most of the OCaml ecosystem is now built with dune, nixpkgs includes a convenience build support function called `buildDunePackage` that will build an OCaml package using dune, OCaml and findlib and any additional dependencies provided as `buildInputs` or `propagatedBuildInputs`.
32+
33+Here is a simple package example.
34+
35+- It defines an (optional) attribute `minimalOCamlVersion` (see note below)
36+ that will be used to throw a descriptive evaluation error if building with
37+ an older OCaml is attempted.
38+
39+- It uses the `fetchFromGitHub` fetcher to get its source.
40+
41+- `duneVersion = "2"` ensures that Dune version 2 is used for the
42+ build (this is the default; valid values are `"1"`, `"2"`, and `"3"`);
43+ note that there is also a legacy `useDune2` boolean attribute:
44+ set to `false` it corresponds to `duneVersion = "1"`; set to `true` it
45+ corresponds to `duneVersion = "2"`. If both arguments (`duneVersion` and
46+ `useDune2`) are given, the second one (`useDune2`) is silently ignored.
47+
48+- It sets the optional `doCheck` attribute such that tests will be run with
49+ `dune runtest -p angstrom` after the build (`dune build -p angstrom`) is
50+ complete, but only if the Ocaml version is at at least `"4.05"`.
51+
52+- It uses the package `ocaml-syntax-shims` as a build input, `alcotest` and
53+ `ppx_let` as check inputs (because they are needed to run the tests), and
54+ `bigstringaf` and `result` as propagated build inputs (thus they will also be
55+ available to libraries depending on this library).
56+
57+- The library will be installed using the `angstrom.install` file that dune
58+ generates.
59+
60+```nix
61+{ lib,
62+ fetchFromGitHub,
63+ buildDunePackage,
64+ ocaml,
65+ ocaml-syntax-shims,
66+ alcotest,
67+ result,
68+ bigstringaf,
69+ ppx_let }:
70+
71+buildDunePackage rec {
72+ pname = "angstrom";
73+ version = "0.15.0";
74+ duneVersion = "2";
75+
76+ minimalOCamlVersion = "4.04";
77+
78+ src = fetchFromGitHub {
79+ owner = "inhabitedtype";
80+ repo = pname;
81+ rev = version;
82+ sha256 = "1hmrkdcdlkwy7rxhngf3cv3sa61cznnd9p5lmqhx20664gx2ibrh";
83+ };
84+
85+ checkInputs = [ alcotest ppx_let ];
86+ buildInputs = [ ocaml-syntax-shims ];
87+ propagatedBuildInputs = [ bigstringaf result ];
88+ doCheck = lib.versionAtLeast ocaml.version "4.05";
89+
90+ meta = {
91+ homepage = "https://github.com/inhabitedtype/angstrom";
92+ description = "OCaml parser combinators built for speed and memory efficiency";
93+ license = lib.licenses.bsd3;
94+ maintainers = with lib.maintainers; [ sternenseemann ];
95+ };
96+```
97+
98+Here is a second example, this time using a source archive generated with `dune-release`. It is a good idea to use this archive when it is available as it will usually contain substituted variables such as a `%%VERSION%%` field. This library does not depend on any other OCaml library and no tests are run after building it.
99+
100+```nix
101+{ lib, fetchurl, buildDunePackage }:
102+
103+buildDunePackage rec {
104+ pname = "wtf8";
105+ version = "1.0.2";
106+
107+ useDune2 = true;
108+
109+ minimalOCamlVersion = "4.02";
110+
111+ src = fetchurl {
112+ url = "https://github.com/flowtype/ocaml-${pname}/releases/download/v${version}/${pname}-v${version}.tbz";
113+ sha256 = "09ygcxxd5warkdzz17rgpidrd0pg14cy2svvnvy1hna080lzg7vp";
114+ };
115+
116+ meta = with lib; {
117+ homepage = "https://github.com/flowtype/ocaml-wtf8";
118+ description = "WTF-8 is a superset of UTF-8 that allows unpaired surrogates.";
119+ license = licenses.mit;
120+ maintainers = [ maintainers.eqyiel ];
121+ };
122+}
123+```
124+
125+Note about `minimalOCamlVersion`. A deprecated version of this argument was
126+spelled `minimumOCamlVersion`; setting the old attribute wrongly modifies the
127+derivation hash and is therefore inappropriate. As a technical dept, currently
128+packaged libraries may still use the old spelling: maintainers are invited to
129+fix this when updating packages. Massive renaming is strongly discouraged as it
130+would be challenging to review, difficult to test, and will cause unnecessary
131+rebuild.
doc/languages-frameworks/octave.section.mdnew file+92
@@ -0,0 +1,92 @@
1+# Octave {#sec-octave}
2+
3+## Introduction {#ssec-octave-introduction}
4+
5+Octave is a modular scientific programming language and environment.
6+A majority of the packages supported by Octave from their [website](https://octave.sourceforge.io/packages.php) are packaged in nixpkgs.
7+
8+## Structure {#ssec-octave-structure}
9+
10+All Octave add-on packages are available in two ways:
11+1. Under the top-level `Octave` attribute, `octave.pkgs`.
12+2. As a top-level attribute, `octavePackages`.
13+
14+## Packaging Octave Packages {#ssec-octave-packaging}
15+
16+Nixpkgs provides a function `buildOctavePackage`, a generic package builder function for any Octave package that complies with the Octave's current packaging format.
17+
18+All Octave packages are defined in [pkgs/top-level/octave-packages.nix](https://github.com/NixOS/nixpkgs/blob/master/pkgs/top-level/octave-packages.nix) rather than `pkgs/all-packages.nix`.
19+Each package is defined in their own file in the [pkgs/development/octave-modules](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/octave-modules) directory.
20+Octave packages are made available through `all-packages.nix` through both the attribute `octavePackages` and `octave.pkgs`.
21+You can test building an Octave package as follows:
22+
23+```ShellSession
24+$ nix-build -A octavePackages.symbolic
25+```
26+
27+To install it into your user profile, run this command from the root of the repository:
28+
29+```ShellSession
30+$ nix-env -f. -iA octavePackages.symbolic
31+```
32+
33+You can build Octave with packages by using the `withPackages` passed-through function.
34+
35+```ShellSession
36+$ nix-shell -p 'octave.withPackages (ps: with ps; [ symbolic ])'
37+```
38+
39+This will also work in a `shell.nix` file.
40+
41+```nix
42+{ pkgs ? import <nixpkgs> { }}:
43+
44+pkgs.mkShell {
45+ nativeBuildInputs = with pkgs; [
46+ (octave.withPackages (opkgs: with opkgs; [ symbolic ]))
47+ ];
48+}
49+```
50+
51+### `buildOctavePackage` Steps {#sssec-buildOctavePackage-steps}
52+
53+The `buildOctavePackage` does several things to make sure things work properly.
54+
55+1. Sets the environment variable `OCTAVE_HISTFILE` to `/dev/null` during package compilation so that the commands run through the Octave interpreter directly are not logged.
56+2. Skips the configuration step, because the packages are stored as gzipped tarballs, which Octave itself handles directly.
57+3. Change the hierarchy of the tarball so that only a single directory is at the top-most level of the tarball.
58+4. Use Octave itself to run the `pkg build` command, which unzips the tarball, extracts the necessary files written in Octave, and compiles any code written in C++ or Fortran, and places the fully compiled artifact in `$out`.
59+
60+`buildOctavePackage` is built on top of `stdenv` in a standard way, allowing most things to be customized.
61+
62+### Handling Dependencies {#sssec-octave-handling-dependencies}
63+
64+In Octave packages, there are four sets of dependencies that can be specified:
65+
66+`nativeBuildInputs`
67+: Just like other packages, `nativeBuildInputs` is intended for architecture-dependent build-time-only dependencies.
68+
69+`buildInputs`
70+: Like other packages, `buildInputs` is intended for architecture-independent build-time-only dependencies.
71+
72+`propagatedBuildInputs`
73+: Similar to other packages, `propagatedBuildInputs` is intended for packages that are required for both building and running of the package.
74+See [Symbolic](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/octave-modules/symbolic/default.nix) for how this works and why it is needed.
75+
76+`requiredOctavePackages`
77+: This is a special dependency that ensures the specified Octave packages are dependent on others, and are made available simultaneously when loading them in Octave.
78+
79+### Installing Octave Packages {#sssec-installing-octave-packages}
80+
81+By default, the `buildOctavePackage` function does _not_ install the requested package into Octave for use.
82+The function will only build the requested package.
83+This is due to Octave maintaining an text-based database about which packages are installed where.
84+To this end, when all the requested packages have been built, the Octave package and all its add-on packages are put together into an environment, similar to Python.
85+
86+1. First, all the Octave binaries are wrapped with the environment variable `OCTAVE_SITE_INITFILE` set to a file in `$out`, which is required for Octave to be able to find the non-standard package database location.
87+2. Because of the way `buildEnv` works, all tarballs that are present (which should be all Octave packages to install) should be removed.
88+3. The path down to the default install location of Octave packages is recreated so that Nix-operated Octave can install the packages.
89+4. Install the packages into the `$out` environment while writing package entries to the database file.
90+This database file is unique for each different (according to Nix) environment invocation.
91+5. Rewrite the Octave-wide startup file to read from the list of packages installed in that particular environment.
92+6. Wrap any programs that are required by the Octave packages so that they work with all the paths defined within the environment.
doc/languages-frameworks/perl.section.mdnew file+159
@@ -0,0 +1,159 @@
1+# Perl {#sec-language-perl}
2+
3+## Running perl programs on the shell {#ssec-perl-running}
4+
5+When executing a Perl script, it is possible you get an error such as `./myscript.pl: bad interpreter: /usr/bin/perl: no such file or directory`. This happens when the script expects Perl to be installed at `/usr/bin/perl`, which is not the case when using Perl from nixpkgs. You can fix the script by changing the first line to:
6+
7+```perl
8+#!/usr/bin/env perl
9+```
10+
11+to take the Perl installation from the `PATH` environment variable, or invoke Perl directly with:
12+
13+```ShellSession
14+$ perl ./myscript.pl
15+```
16+
17+When the script is using a Perl library that is not installed globally, you might get an error such as `Can't locate DB_File.pm in @INC (you may need to install the DB_File module)`. In that case, you can use `nix-shell` to start an ad-hoc shell with that library installed, for instance:
18+
19+```ShellSession
20+$ nix-shell -p perl perlPackages.DBFile --run ./myscript.pl
21+```
22+
23+If you are always using the script in places where `nix-shell` is available, you can embed the `nix-shell` invocation in the shebang like this:
24+
25+```perl
26+#!/usr/bin/env nix-shell
27+#! nix-shell -i perl -p perl perlPackages.DBFile
28+```
29+
30+## Packaging Perl programs {#ssec-perl-packaging}
31+
32+Nixpkgs provides a function `buildPerlPackage`, a generic package builder function for any Perl package that has a standard `Makefile.PL`. It’s implemented in [pkgs/development/perl-modules/generic](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/perl-modules/generic).
33+
34+Perl packages from CPAN are defined in [pkgs/top-level/perl-packages.nix](https://github.com/NixOS/nixpkgs/blob/master/pkgs/top-level/perl-packages.nix) rather than `pkgs/all-packages.nix`. Most Perl packages are so straight-forward to build that they are defined here directly, rather than having a separate function for each package called from `perl-packages.nix`. However, more complicated packages should be put in a separate file, typically in `pkgs/development/perl-modules`. Here is an example of the former:
35+
36+```nix
37+ClassC3 = buildPerlPackage rec {
38+ name = "Class-C3-0.21";
39+ src = fetchurl {
40+ url = "mirror://cpan/authors/id/F/FL/FLORA/${name}.tar.gz";
41+ sha256 = "1bl8z095y4js66pwxnm7s853pi9czala4sqc743fdlnk27kq94gz";
42+ };
43+};
44+```
45+
46+Note the use of `mirror://cpan/`, and the `${name}` in the URL definition to ensure that the name attribute is consistent with the source that we’re actually downloading. Perl packages are made available in `all-packages.nix` through the variable `perlPackages`. For instance, if you have a package that needs `ClassC3`, you would typically write
47+
48+```nix
49+foo = import ../path/to/foo.nix {
50+ inherit stdenv fetchurl ...;
51+ inherit (perlPackages) ClassC3;
52+};
53+```
54+
55+in `all-packages.nix`. You can test building a Perl package as follows:
56+
57+```ShellSession
58+$ nix-build -A perlPackages.ClassC3
59+```
60+
61+To install it with `nix-env` instead: `nix-env -f. -iA perlPackages.ClassC3`.
62+
63+So what does `buildPerlPackage` do? It does the following:
64+
65+1. In the configure phase, it calls `perl Makefile.PL` to generate a Makefile. You can set the variable `makeMakerFlags` to pass flags to `Makefile.PL`
66+2. It adds the contents of the `PERL5LIB` environment variable to `#! .../bin/perl` line of Perl scripts as `-Idir` flags. This ensures that a script can find its dependencies. (This can cause this shebang line to become too long for Darwin to handle; see the note below.)
67+3. In the fixup phase, it writes the propagated build inputs (`propagatedBuildInputs`) to the file `$out/nix-support/propagated-user-env-packages`. `nix-env` recursively installs all packages listed in this file when you install a package that has it. This ensures that a Perl package can find its dependencies.
68+
69+`buildPerlPackage` is built on top of `stdenv`, so everything can be customised in the usual way. For instance, the `BerkeleyDB` module has a `preConfigure` hook to generate a configuration file used by `Makefile.PL`:
70+
71+```nix
72+{ buildPerlPackage, fetchurl, db }:
73+
74+buildPerlPackage rec {
75+ name = "BerkeleyDB-0.36";
76+
77+ src = fetchurl {
78+ url = "mirror://cpan/authors/id/P/PM/PMQS/${name}.tar.gz";
79+ sha256 = "07xf50riarb60l1h6m2dqmql8q5dij619712fsgw7ach04d8g3z1";
80+ };
81+
82+ preConfigure = ''
83+ echo "LIB = ${db.out}/lib" > config.in
84+ echo "INCLUDE = ${db.dev}/include" >> config.in
85+ '';
86+}
87+```
88+
89+Dependencies on other Perl packages can be specified in the `buildInputs` and `propagatedBuildInputs` attributes. If something is exclusively a build-time dependency, use `buildInputs`; if it’s (also) a runtime dependency, use `propagatedBuildInputs`. For instance, this builds a Perl module that has runtime dependencies on a bunch of other modules:
90+
91+```nix
92+ClassC3Componentised = buildPerlPackage rec {
93+ name = "Class-C3-Componentised-1.0004";
94+ src = fetchurl {
95+ url = "mirror://cpan/authors/id/A/AS/ASH/${name}.tar.gz";
96+ sha256 = "0xql73jkcdbq4q9m0b0rnca6nrlvf5hyzy8is0crdk65bynvs8q1";
97+ };
98+ propagatedBuildInputs = [
99+ ClassC3 ClassInspector TestException MROCompat
100+ ];
101+};
102+```
103+
104+On Darwin, if a script has too many `-Idir` flags in its first line (its “shebang line”), it will not run. This can be worked around by calling the `shortenPerlShebang` function from the `postInstall` phase:
105+
106+```nix
107+{ lib, stdenv, buildPerlPackage, fetchurl, shortenPerlShebang }:
108+
109+ImageExifTool = buildPerlPackage {
110+ pname = "Image-ExifTool";
111+ version = "11.50";
112+
113+ src = fetchurl {
114+ url = "https://www.sno.phy.queensu.ca/~phil/exiftool/Image-ExifTool-11.50.tar.gz";
115+ sha256 = "0d8v48y94z8maxkmw1rv7v9m0jg2dc8xbp581njb6yhr7abwqdv3";
116+ };
117+
118+ buildInputs = lib.optional stdenv.isDarwin shortenPerlShebang;
119+ postInstall = lib.optionalString stdenv.isDarwin ''
120+ shortenPerlShebang $out/bin/exiftool
121+ '';
122+};
123+```
124+
125+This will remove the `-I` flags from the shebang line, rewrite them in the `use lib` form, and put them on the next line instead. This function can be given any number of Perl scripts as arguments; it will modify them in-place.
126+
127+### Generation from CPAN {#ssec-generation-from-CPAN}
128+
129+Nix expressions for Perl packages can be generated (almost) automatically from CPAN. This is done by the program `nix-generate-from-cpan`, which can be installed as follows:
130+
131+```ShellSession
132+$ nix-env -f "<nixpkgs>" -iA nix-generate-from-cpan
133+```
134+
135+Substitute `<nixpkgs>` by the path of a nixpkgs clone to use the latest version.
136+
137+This program takes a Perl module name, looks it up on CPAN, fetches and unpacks the corresponding package, and prints a Nix expression on standard output. For example:
138+
139+```ShellSession
140+$ nix-generate-from-cpan XML::Simple
141+ XMLSimple = buildPerlPackage rec {
142+ name = "XML-Simple-2.22";
143+ src = fetchurl {
144+ url = "mirror://cpan/authors/id/G/GR/GRANTM/${name}.tar.gz";
145+ sha256 = "b9450ef22ea9644ae5d6ada086dc4300fa105be050a2030ebd4efd28c198eb49";
146+ };
147+ propagatedBuildInputs = [ XMLNamespaceSupport XMLSAX XMLSAXExpat ];
148+ meta = {
149+ description = "An API for simple XML files";
150+ license = with lib.licenses; [ artistic1 gpl1Plus ];
151+ };
152+ };
153+```
154+
155+The output can be pasted into `pkgs/top-level/perl-packages.nix` or wherever else you need it.
156+
157+### Cross-compiling modules {#ssec-perl-cross-compilation}
158+
159+Nixpkgs has experimental support for cross-compiling Perl modules. In many cases, it will just work out of the box, even for modules with native extensions. Sometimes, however, the Makefile.PL for a module may (indirectly) import a native module. In that case, you will need to make a stub for that module that will satisfy the Makefile.PL and install it into `lib/perl5/site_perl/cross_perl/${perl.version}`. See the `postInstall` for `DBI` for an example.
doc/languages-frameworks/php.section.mdnew file+155
@@ -0,0 +1,155 @@
1+# PHP {#sec-php}
2+
3+## User Guide {#ssec-php-user-guide}
4+
5+### Overview {#ssec-php-user-guide-overview}
6+
7+Several versions of PHP are available on Nix, each of which having a
8+wide variety of extensions and libraries available.
9+
10+The different versions of PHP that nixpkgs provides are located under
11+attributes named based on major and minor version number; e.g.,
12+`php74` is PHP 7.4.
13+
14+Only versions of PHP that are supported by upstream for the entirety
15+of a given NixOS release will be included in that release of
16+NixOS. See [PHP Supported
17+Versions](https://www.php.net/supported-versions.php).
18+
19+The attribute `php` refers to the version of PHP considered most
20+stable and thoroughly tested in nixpkgs for any given release of
21+NixOS - not necessarily the latest major release from upstream.
22+
23+All available PHP attributes are wrappers around their respective
24+binary PHP package and provide commonly used extensions this way. The
25+real PHP 7.4 package, i.e. the unwrapped one, is available as
26+`php74.unwrapped`; see the next section for more details.
27+
28+Interactive tools built on PHP are put in `php.packages`; composer is
29+for example available at `php.packages.composer`.
30+
31+Most extensions that come with PHP, as well as some popular
32+third-party ones, are available in `php.extensions`; for example, the
33+opcache extension shipped with PHP is available at
34+`php.extensions.opcache` and the third-party ImageMagick extension at
35+`php.extensions.imagick`.
36+
37+### Installing PHP with extensions {#ssec-php-user-guide-installing-with-extensions}
38+
39+A PHP package with specific extensions enabled can be built using
40+`php.withExtensions`. This is a function which accepts an anonymous
41+function as its only argument; the function should accept two named
42+parameters: `enabled` - a list of currently enabled extensions and
43+`all` - the set of all extensions, and return a list of wanted
44+extensions. For example, a PHP package with all default extensions and
45+ImageMagick enabled:
46+
47+```nix
48+php.withExtensions ({ enabled, all }:
49+ enabled ++ [ all.imagick ])
50+```
51+
52+To exclude some, but not all, of the default extensions, you can
53+filter the `enabled` list like this:
54+
55+```nix
56+php.withExtensions ({ enabled, all }:
57+ (lib.filter (e: e != php.extensions.opcache) enabled)
58+ ++ [ all.imagick ])
59+```
60+
61+To build your list of extensions from the ground up, you can simply
62+ignore `enabled`:
63+
64+```nix
65+php.withExtensions ({ all, ... }: with all; [ imagick opcache ])
66+```
67+
68+`php.withExtensions` provides extensions by wrapping a minimal php
69+base package, providing a `php.ini` file listing all extensions to be
70+loaded. You can access this package through the `php.unwrapped`
71+attribute; useful if you, for example, need access to the `dev`
72+output. The generated `php.ini` file can be accessed through the
73+`php.phpIni` attribute.
74+
75+If you want a PHP build with extra configuration in the `php.ini`
76+file, you can use `php.buildEnv`. This function takes two named and
77+optional parameters: `extensions` and `extraConfig`. `extensions`
78+takes an extension specification equivalent to that of
79+`php.withExtensions`, `extraConfig` a string of additional `php.ini`
80+configuration parameters. For example, a PHP package with the opcache
81+and ImageMagick extensions enabled, and `memory_limit` set to `256M`:
82+
83+```nix
84+php.buildEnv {
85+ extensions = { all, ... }: with all; [ imagick opcache ];
86+ extraConfig = "memory_limit=256M";
87+}
88+```
89+
90+#### Example setup for `phpfpm` {#ssec-php-user-guide-installing-with-extensions-phpfpm}
91+
92+You can use the previous examples in a `phpfpm` pool called `foo` as
93+follows:
94+
95+```nix
96+let
97+ myPhp = php.withExtensions ({ all, ... }: with all; [ imagick opcache ]);
98+in {
99+ services.phpfpm.pools."foo".phpPackage = myPhp;
100+};
101+```
102+
103+```nix
104+let
105+ myPhp = php.buildEnv {
106+ extensions = { all, ... }: with all; [ imagick opcache ];
107+ extraConfig = "memory_limit=256M";
108+ };
109+in {
110+ services.phpfpm.pools."foo".phpPackage = myPhp;
111+};
112+```
113+
114+#### Example usage with `nix-shell` {#ssec-php-user-guide-installing-with-extensions-nix-shell}
115+
116+This brings up a temporary environment that contains a PHP interpreter
117+with the extensions `imagick` and `opcache` enabled:
118+
119+```sh
120+nix-shell -p 'php.withExtensions ({ all, ... }: with all; [ imagick opcache ])'
121+```
122+
123+### Installing PHP packages with extensions {#ssec-php-user-guide-installing-packages-with-extensions}
124+
125+All interactive tools use the PHP package you get them from, so all
126+packages at `php.packages.*` use the `php` package with its default
127+extensions. Sometimes this default set of extensions isn't enough and
128+you may want to extend it. A common case of this is the `composer`
129+package: a project may depend on certain extensions and `composer`
130+won't work with that project unless those extensions are loaded.
131+
132+Example of building `composer` with additional extensions:
133+```nix
134+(php.withExtensions ({ all, enabled }:
135+ enabled ++ (with all; [ imagick redis ]))
136+).packages.composer
137+```
138+
139+### Overriding PHP packages {#ssec-php-user-guide-overriding-packages}
140+
141+`php-packages.nix` form a scope, allowing us to override the packages defined within. For example, to apply a patch to a `mysqlnd` extension, you can simply pass an overlay-style function to `php`’s `packageOverrides` argument:
142+
143+```nix
144+php.override {
145+ packageOverrides = final: prev: {
146+ extensions = prev.extensions // {
147+ mysqlnd = prev.extensions.mysqlnd.overrideAttrs (attrs: {
148+ patches = attrs.patches or [] ++ [
149+ …
150+ ];
151+ });
152+ };
153+ };
154+}
155+```
doc/languages-frameworks/python.section.mdnew file+1682
@@ -0,0 +1,1682 @@
1+# Python {#python}
2+
3+## User Guide {#user-guide}
4+
5+### Using Python {#using-python}
6+
7+#### Overview {#overview}
8+
9+Several versions of the Python interpreter are available on Nix, as well as a
10+high amount of packages. The attribute `python3` refers to the default
11+interpreter, which is currently CPython 3.9. The attribute `python` refers to
12+CPython 2.7 for backwards-compatibility. It is also possible to refer to
13+specific versions, e.g. `python38` refers to CPython 3.8, and `pypy` refers to
14+the default PyPy interpreter.
15+
16+Python is used a lot, and in different ways. This affects also how it is
17+packaged. In the case of Python on Nix, an important distinction is made between
18+whether the package is considered primarily an application, or whether it should
19+be used as a library, i.e., of primary interest are the modules in
20+`site-packages` that should be importable.
21+
22+In the Nixpkgs tree Python applications can be found throughout, depending on
23+what they do, and are called from the main package set. Python libraries,
24+however, are in separate sets, with one set per interpreter version.
25+
26+The interpreters have several common attributes. One of these attributes is
27+`pkgs`, which is a package set of Python libraries for this specific
28+interpreter. E.g., the `toolz` package corresponding to the default interpreter
29+is `python.pkgs.toolz`, and the CPython 3.8 version is `python38.pkgs.toolz`.
30+The main package set contains aliases to these package sets, e.g.
31+`pythonPackages` refers to `python.pkgs` and `python38Packages` to
32+`python38.pkgs`.
33+
34+#### Installing Python and packages {#installing-python-and-packages}
35+
36+The Nix and NixOS manuals explain how packages are generally installed. In the
37+case of Python and Nix, it is important to make a distinction between whether the
38+package is considered an application or a library.
39+
40+Applications on Nix are typically installed into your user profile imperatively
41+using `nix-env -i`, and on NixOS declaratively by adding the package name to
42+`environment.systemPackages` in `/etc/nixos/configuration.nix`. Dependencies
43+such as libraries are automatically installed and should not be installed
44+explicitly.
45+
46+The same goes for Python applications. Python applications can be installed in
47+your profile, and will be wrapped to find their exact library dependencies,
48+without impacting other applications or polluting your user environment.
49+
50+But Python libraries you would like to use for development cannot be installed,
51+at least not individually, because they won't be able to find each other
52+resulting in import errors. Instead, it is possible to create an environment
53+with `python.buildEnv` or `python.withPackages` where the interpreter and other
54+executables are wrapped to be able to find each other and all of the modules.
55+
56+In the following examples we will start by creating a simple, ad-hoc environment
57+with a nix-shell that has `numpy` and `toolz` in Python 3.8; then we will create
58+a re-usable environment in a single-file Python script; then we will create a
59+full Python environment for development with this same environment.
60+
61+Philosphically, this should be familiar to users who are used to a `venv` style
62+of development: individual projects create their own Python environments without
63+impacting the global environment or each other.
64+
65+#### Ad-hoc temporary Python environment with `nix-shell` {#ad-hoc-temporary-python-environment-with-nix-shell}
66+
67+The simplest way to start playing with the way nix wraps and sets up Python
68+environments is with `nix-shell` at the cmdline. These environments create a
69+temporary shell session with a Python and a *precise* list of packages (plus
70+their runtime dependencies), with no other Python packages in the Python
71+interpreter's scope.
72+
73+To create a Python 3.8 session with `numpy` and `toolz` available, run:
74+
75+```sh
76+$ nix-shell -p 'python38.withPackages(ps: with ps; [ numpy toolz ])'
77+```
78+
79+By default `nix-shell` will start a `bash` session with this interpreter in our
80+`PATH`, so if we then run:
81+
82+```Python console
83+[nix-shell:~/src/nixpkgs]$ python3
84+Python 3.8.1 (default, Dec 18 2019, 19:06:26)
85+[GCC 9.2.0] on linux
86+Type "help", "copyright", "credits" or "license" for more information.
87+>>> import numpy; import toolz
88+```
89+
90+Note that no other modules are in scope, even if they were imperatively
91+installed into our user environment as a dependency of a Python application:
92+
93+```Python console
94+>>> import requests
95+Traceback (most recent call last):
96+ File "<stdin>", line 1, in <module>
97+ModuleNotFoundError: No module named 'requests'
98+```
99+
100+We can add as many additional modules onto the `nix-shell` as we need, and we
101+will still get 1 wrapped Python interpreter. We can start the interpreter
102+directly like so:
103+
104+```sh
105+$ nix-shell -p 'python38.withPackages(ps: with ps; [ numpy toolz requests ])' --run python3
106+these derivations will be built:
107+ /nix/store/xbdsrqrsfa1yva5s7pzsra8k08gxlbz1-python3-3.8.1-env.drv
108+building '/nix/store/xbdsrqrsfa1yva5s7pzsra8k08gxlbz1-python3-3.8.1-env.drv'...
109+created 277 symlinks in user environment
110+Python 3.8.1 (default, Dec 18 2019, 19:06:26)
111+[GCC 9.2.0] on linux
112+Type "help", "copyright", "credits" or "license" for more information.
113+>>> import requests
114+>>>
115+```
116+
117+Notice that this time it built a new Python environment, which now includes
118+`requests`. Building an environment just creates wrapper scripts that expose the
119+selected dependencies to the interpreter while re-using the actual modules. This
120+means if any other env has installed `requests` or `numpy` in a different
121+context, we don't need to recompile them -- we just recompile the wrapper script
122+that sets up an interpreter pointing to them. This matters much more for "big"
123+modules like `pytorch` or `tensorflow`.
124+
125+Module names usually match their names on [pypi.org](https://pypi.org/), but
126+you can use the [Nixpkgs search website](https://nixos.org/nixos/packages.html)
127+to find them as well (along with non-python packages).
128+
129+At this point we can create throwaway experimental Python environments with
130+arbitrary dependencies. This is a good way to get a feel for how the Python
131+interpreter and dependencies work in Nix and NixOS, but to do some actual
132+development, we'll want to make it a bit more persistent.
133+
134+##### Running Python scripts and using `nix-shell` as shebang {#running-python-scripts-and-using-nix-shell-as-shebang}
135+
136+Sometimes, we have a script whose header looks like this:
137+
138+```python
139+#!/usr/bin/env python3
140+import numpy as np
141+a = np.array([1,2])
142+b = np.array([3,4])
143+print(f"The dot product of {a} and {b} is: {np.dot(a, b)}")
144+```
145+
146+Executing this script requires a `python3` that has `numpy`. Using what we learned
147+in the previous section, we could startup a shell and just run it like so:
148+
149+```ShellSession
150+$ nix-shell -p 'python38.withPackages(ps: with ps; [ numpy ])' --run 'python3 foo.py'
151+The dot product of [1 2] and [3 4] is: 11
152+```
153+
154+But if we maintain the script ourselves, and if there are more dependencies, it
155+may be nice to encode those dependencies in source to make the script re-usable
156+without that bit of knowledge. That can be done by using `nix-shell` as a
157+[shebang](https://en.wikipedia.org/wiki/Shebang_(Unix)), like so:
158+
159+```python
160+#!/usr/bin/env nix-shell
161+#!nix-shell -i python3 -p "python3.withPackages(ps: [ ps.numpy ])"
162+import numpy as np
163+a = np.array([1,2])
164+b = np.array([3,4])
165+print(f"The dot product of {a} and {b} is: {np.dot(a, b)}")
166+```
167+
168+Then we simply execute it, without requiring any environment setup at all!
169+
170+```sh
171+$ ./foo.py
172+The dot product of [1 2] and [3 4] is: 11
173+```
174+
175+If the dependencies are not available on the host where `foo.py` is executed, it
176+will build or download them from a Nix binary cache prior to starting up, prior
177+that it is executed on a machine with a multi-user nix installation.
178+
179+This provides a way to ship a self bootstrapping Python script, akin to a
180+statically linked binary, where it can be run on any machine (provided nix is
181+installed) without having to assume that `numpy` is installed globally on the
182+system.
183+
184+By default it is pulling the import checkout of Nixpkgs itself from our nix
185+channel, which is nice as it cache aligns with our other package builds, but we
186+can make it fully reproducible by pinning the `nixpkgs` import:
187+
188+```python
189+#!/usr/bin/env nix-shell
190+#!nix-shell -i python3 -p "python3.withPackages(ps: [ ps.numpy ])"
191+#!nix-shell -I nixpkgs=https://github.com/NixOS/nixpkgs/archive/d373d80b1207d52621961b16aa4a3438e4f98167.tar.gz
192+import numpy as np
193+a = np.array([1,2])
194+b = np.array([3,4])
195+print(f"The dot product of {a} and {b} is: {np.dot(a, b)}")
196+```
197+
198+This will execute with the exact same versions of Python 3.8, numpy, and system
199+dependencies a year from now as it does today, because it will always use
200+exactly git commit `d373d80b1207d52621961b16aa4a3438e4f98167` of Nixpkgs for all
201+of the package versions.
202+
203+This is also a great way to ensure the script executes identically on different
204+servers.
205+
206+##### Load environment from `.nix` expression {#load-environment-from-.nix-expression}
207+
208+We've now seen how to create an ad-hoc temporary shell session, and how to
209+create a single script with Python dependencies, but in the course of normal
210+development we're usually working in an entire package repository.
211+
212+As explained in the Nix manual, `nix-shell` can also load an expression from a
213+`.nix` file. Say we want to have Python 3.8, `numpy` and `toolz`, like before,
214+in an environment. We can add a `shell.nix` file describing our dependencies:
215+
216+```nix
217+with import <nixpkgs> {};
218+(python38.withPackages (ps: [ps.numpy ps.toolz])).env
219+```
220+
221+And then at the command line, just typing `nix-shell` produces the same
222+environment as before. In a normal project, we'll likely have many more
223+dependencies; this can provide a way for developers to share the environments
224+with each other and with CI builders.
225+
226+What's happening here?
227+
228+1. We begin with importing the Nix Packages collections. `import <nixpkgs>`
229+ imports the `<nixpkgs>` function, `{}` calls it and the `with` statement
230+ brings all attributes of `nixpkgs` in the local scope. These attributes form
231+ the main package set.
232+2. Then we create a Python 3.8 environment with the `withPackages` function, as before.
233+3. The `withPackages` function expects us to provide a function as an argument
234+ that takes the set of all Python packages and returns a list of packages to
235+ include in the environment. Here, we select the packages `numpy` and `toolz`
236+ from the package set.
237+
238+To combine this with `mkShell` you can:
239+
240+```nix
241+with import <nixpkgs> {};
242+let
243+ pythonEnv = python38.withPackages (ps: [
244+ ps.numpy
245+ ps.toolz
246+ ]);
247+in mkShell {
248+ packages = [
249+ pythonEnv
250+
251+ black
252+ mypy
253+
254+ libffi
255+ openssl
256+ ];
257+}
258+```
259+
260+This will create a unified environment that has not just our Python interpreter
261+and its Python dependencies, but also tools like `black` or `mypy` and libraries
262+like `libffi` the `openssl` in scope. This is generic and can span any number of
263+tools or languages across the Nixpkgs ecosystem.
264+
265+##### Installing environments globally on the system {#installing-environments-globally-on-the-system}
266+
267+Up to now, we've been creating environments scoped to an ad-hoc shell session,
268+or a single script, or a single project. This is generally advisable, as it
269+avoids pollution across contexts.
270+
271+However, sometimes we know we will often want a Python with some basic packages,
272+and want this available without having to enter into a shell or build context.
273+This can be useful to have things like vim/emacs editors and plugins or shell
274+tools "just work" without having to set them up, or when running other software
275+that expects packages to be installed globally.
276+
277+To create your own custom environment, create a file in `~/.config/nixpkgs/overlays/`
278+that looks like this:
279+
280+```nix
281+# ~/.config/nixpkgs/overlays/myEnv.nix
282+self: super: {
283+ myEnv = super.buildEnv {
284+ name = "myEnv";
285+ paths = [
286+ # A Python 3 interpreter with some packages
287+ (self.python3.withPackages (
288+ ps: with ps; [
289+ pyflakes
290+ pytest
291+ python-language-server
292+ ]
293+ ))
294+
295+ # Some other packages we'd like as part of this env
296+ self.mypy
297+ self.black
298+ self.ripgrep
299+ self.tmux
300+ ];
301+ };
302+}
303+```
304+
305+You can then build and install this to your profile with:
306+
307+```sh
308+nix-env -iA myEnv
309+```
310+
311+One limitation of this is that you can only have 1 Python env installed
312+globally, since they conflict on the `python` to load out of your `PATH`.
313+
314+If you get a conflict or prefer to keep the setup clean, you can have `nix-env`
315+atomically *uninstall* all other imperatively installed packages and replace
316+your profile with just `myEnv` by using the `--replace` flag.
317+
318+##### Environment defined in `/etc/nixos/configuration.nix` {#environment-defined-in-etcnixosconfiguration.nix}
319+
320+For the sake of completeness, here's how to install the environment system-wide
321+on NixOS.
322+
323+```nix
324+{ # ...
325+
326+ environment.systemPackages = with pkgs; [
327+ (python38.withPackages(ps: with ps; [ numpy toolz ]))
328+ ];
329+}
330+```
331+
332+### Developing with Python {#developing-with-python}
333+
334+Above, we were mostly just focused on use cases and what to do to get started
335+creating working Python environments in nix.
336+
337+Now that you know the basics to be up and running, it is time to take a step
338+back and take a deeper look at how Python packages are packaged on Nix. Then,
339+we will look at how you can use development mode with your code.
340+
341+#### Python library packages in Nixpkgs {#python-library-packages-in-nixpkgs}
342+
343+With Nix all packages are built by functions. The main function in Nix for
344+building Python libraries is `buildPythonPackage`. Let's see how we can build the
345+`toolz` package.
346+
347+```nix
348+{ lib, buildPythonPackage, fetchPypi }:
349+
350+buildPythonPackage rec {
351+ pname = "toolz";
352+ version = "0.10.0";
353+
354+ src = fetchPypi {
355+ inherit pname version;
356+ sha256 = "08fdd5ef7c96480ad11c12d472de21acd32359996f69a5259299b540feba4560";
357+ };
358+
359+ doCheck = false;
360+
361+ meta = with lib; {
362+ homepage = "https://github.com/pytoolz/toolz";
363+ description = "List processing tools and functional utilities";
364+ license = licenses.bsd3;
365+ maintainers = with maintainers; [ fridh ];
366+ };
367+}
368+```
369+
370+What happens here? The function `buildPythonPackage` is called and as argument
371+it accepts a set. In this case the set is a recursive set, `rec`. One of the
372+arguments is the name of the package, which consists of a basename (generally
373+following the name on PyPi) and a version. Another argument, `src` specifies the
374+source, which in this case is fetched from PyPI using the helper function
375+`fetchPypi`. The argument `doCheck` is used to set whether tests should be run
376+when building the package. Furthermore, we specify some (optional) meta
377+information. The output of the function is a derivation.
378+
379+An expression for `toolz` can be found in the Nixpkgs repository. As explained
380+in the introduction of this Python section, a derivation of `toolz` is available
381+for each interpreter version, e.g. `python38.pkgs.toolz` refers to the `toolz`
382+derivation corresponding to the CPython 3.8 interpreter.
383+
384+The above example works when you're directly working on
385+`pkgs/top-level/python-packages.nix` in the Nixpkgs repository. Often though,
386+you will want to test a Nix expression outside of the Nixpkgs tree.
387+
388+The following expression creates a derivation for the `toolz` package,
389+and adds it along with a `numpy` package to a Python environment.
390+
391+```nix
392+with import <nixpkgs> {};
393+
394+( let
395+ my_toolz = python38.pkgs.buildPythonPackage rec {
396+ pname = "toolz";
397+ version = "0.10.0";
398+
399+ src = python38.pkgs.fetchPypi {
400+ inherit pname version;
401+ sha256 = "08fdd5ef7c96480ad11c12d472de21acd32359996f69a5259299b540feba4560";
402+ };
403+
404+ doCheck = false;
405+
406+ meta = {
407+ homepage = "https://github.com/pytoolz/toolz/";
408+ description = "List processing tools and functional utilities";
409+ };
410+ };
411+
412+ in python38.withPackages (ps: [ps.numpy my_toolz])
413+).env
414+```
415+
416+Executing `nix-shell` will result in an environment in which you can use
417+Python 3.8 and the `toolz` package. As you can see we had to explicitly mention
418+for which Python version we want to build a package.
419+
420+So, what did we do here? Well, we took the Nix expression that we used earlier
421+to build a Python environment, and said that we wanted to include our own
422+version of `toolz`, named `my_toolz`. To introduce our own package in the scope
423+of `withPackages` we used a `let` expression. You can see that we used
424+`ps.numpy` to select numpy from the nixpkgs package set (`ps`). We did not take
425+`toolz` from the Nixpkgs package set this time, but instead took our own version
426+that we introduced with the `let` expression.
427+
428+#### Handling dependencies {#handling-dependencies}
429+
430+Our example, `toolz`, does not have any dependencies on other Python packages or
431+system libraries. According to the manual, `buildPythonPackage` uses the
432+arguments `buildInputs` and `propagatedBuildInputs` to specify dependencies. If
433+something is exclusively a build-time dependency, then the dependency should be
434+included in `buildInputs`, but if it is (also) a runtime dependency, then it
435+should be added to `propagatedBuildInputs`. Test dependencies are considered
436+build-time dependencies and passed to `checkInputs`.
437+
438+The following example shows which arguments are given to `buildPythonPackage` in
439+order to build [`datashape`](https://github.com/blaze/datashape).
440+
441+```nix
442+{ lib, buildPythonPackage, fetchPypi, numpy, multipledispatch, python-dateutil, pytest }:
443+
444+buildPythonPackage rec {
445+ pname = "datashape";
446+ version = "0.4.7";
447+
448+ src = fetchPypi {
449+ inherit pname version;
450+ sha256 = "14b2ef766d4c9652ab813182e866f493475e65e558bed0822e38bf07bba1a278";
451+ };
452+
453+ checkInputs = [ pytest ];
454+ propagatedBuildInputs = [ numpy multipledispatch python-dateutil ];
455+
456+ meta = with lib; {
457+ homepage = "https://github.com/ContinuumIO/datashape";
458+ description = "A data description language";
459+ license = licenses.bsd2;
460+ maintainers = with maintainers; [ fridh ];
461+ };
462+}
463+```
464+
465+We can see several runtime dependencies, `numpy`, `multipledispatch`, and
466+`python-dateutil`. Furthermore, we have one `checkInputs`, i.e. `pytest`. `pytest` is a
467+test runner and is only used during the `checkPhase` and is therefore not added
468+to `propagatedBuildInputs`.
469+
470+In the previous case we had only dependencies on other Python packages to consider.
471+Occasionally you have also system libraries to consider. E.g., `lxml` provides
472+Python bindings to `libxml2` and `libxslt`. These libraries are only required
473+when building the bindings and are therefore added as `buildInputs`.
474+
475+```nix
476+{ lib, pkgs, buildPythonPackage, fetchPypi }:
477+
478+buildPythonPackage rec {
479+ pname = "lxml";
480+ version = "3.4.4";
481+
482+ src = fetchPypi {
483+ inherit pname version;
484+ sha256 = "16a0fa97hym9ysdk3rmqz32xdjqmy4w34ld3rm3jf5viqjx65lxk";
485+ };
486+
487+ buildInputs = [ pkgs.libxml2 pkgs.libxslt ];
488+
489+ meta = with lib; {
490+ description = "Pythonic binding for the libxml2 and libxslt libraries";
491+ homepage = "https://lxml.de";
492+ license = licenses.bsd3;
493+ maintainers = with maintainers; [ sjourdois ];
494+ };
495+}
496+```
497+
498+In this example `lxml` and Nix are able to work out exactly where the relevant
499+files of the dependencies are. This is not always the case.
500+
501+The example below shows bindings to The Fastest Fourier Transform in the West,
502+commonly known as FFTW. On Nix we have separate packages of FFTW for the
503+different types of floats (`"single"`, `"double"`, `"long-double"`). The
504+bindings need all three types, and therefore we add all three as `buildInputs`.
505+The bindings don't expect to find each of them in a different folder, and
506+therefore we have to set `LDFLAGS` and `CFLAGS`.
507+
508+```nix
509+{ lib, pkgs, buildPythonPackage, fetchPypi, numpy, scipy }:
510+
511+buildPythonPackage rec {
512+ pname = "pyFFTW";
513+ version = "0.9.2";
514+
515+ src = fetchPypi {
516+ inherit pname version;
517+ sha256 = "f6bbb6afa93085409ab24885a1a3cdb8909f095a142f4d49e346f2bd1b789074";
518+ };
519+
520+ buildInputs = [ pkgs.fftw pkgs.fftwFloat pkgs.fftwLongDouble];
521+
522+ propagatedBuildInputs = [ numpy scipy ];
523+
524+ # Tests cannot import pyfftw. pyfftw works fine though.
525+ doCheck = false;
526+
527+ preConfigure = ''
528+ export LDFLAGS="-L${pkgs.fftw.dev}/lib -L${pkgs.fftwFloat.out}/lib -L${pkgs.fftwLongDouble.out}/lib"
529+ export CFLAGS="-I${pkgs.fftw.dev}/include -I${pkgs.fftwFloat.dev}/include -I${pkgs.fftwLongDouble.dev}/include"
530+ '';
531+
532+ meta = with lib; {
533+ description = "A pythonic wrapper around FFTW, the FFT library, presenting a unified interface for all the supported transforms";
534+ homepage = "http://hgomersall.github.com/pyFFTW";
535+ license = with licenses; [ bsd2 bsd3 ];
536+ maintainers = with maintainers; [ fridh ];
537+ };
538+}
539+```
540+
541+Note also the line `doCheck = false;`, we explicitly disabled running the test-suite.
542+
543+#### Testing Python Packages {#testing-python-packages}
544+
545+It is highly encouraged to have testing as part of the package build. This
546+helps to avoid situations where the package was able to build and install,
547+but is not usable at runtime. Currently, all packages will use the `test`
548+command provided by the setup.py (i.e. `python setup.py test`). However,
549+this is currently deprecated https://github.com/pypa/setuptools/pull/1878
550+and your package should provide its own checkPhase.
551+
552+*NOTE:* The `checkPhase` for python maps to the `installCheckPhase` on a
553+normal derivation. This is due to many python packages not behaving well
554+to the pre-installed version of the package. Version info, and natively
555+compiled extensions generally only exist in the install directory, and
556+thus can cause issues when a test suite asserts on that behavior.
557+
558+*NOTE:* Tests should only be disabled if they don't agree with nix
559+(e.g. external dependencies, network access, flakey tests), however,
560+as many tests should be enabled as possible. Failing tests can still be
561+a good indication that the package is not in a valid state.
562+
563+#### Using pytest {#using-pytest}
564+
565+Pytest is the most common test runner for python repositories. A trivial
566+test run would be:
567+
568+```
569+ checkInputs = [ pytest ];
570+ checkPhase = "pytest";
571+```
572+
573+However, many repositories' test suites do not translate well to nix's build
574+sandbox, and will generally need many tests to be disabled.
575+
576+To filter tests using pytest, one can do the following:
577+
578+```
579+ checkInputs = [ pytest ];
580+ # avoid tests which need additional data or touch network
581+ checkPhase = ''
582+ pytest tests/ --ignore=tests/integration -k 'not download and not update'
583+ '';
584+```
585+
586+`--ignore` will tell pytest to ignore that file or directory from being
587+collected as part of a test run. This is useful is a file uses a package
588+which is not available in nixpkgs, thus skipping that test file is much
589+easier than having to create a new package.
590+
591+`-k` is used to define a predicate for test names. In this example, we are
592+filtering out tests which contain `download` or `update` in their test case name.
593+Only one `-k` argument is allowed, and thus a long predicate should be concatenated
594+with “\\” and wrapped to the next line.
595+
596+*NOTE:* In pytest==6.0.1, the use of “\\” to continue a line (e.g. `-k 'not download \'`) has
597+been removed, in this case, it's recommended to use `pytestCheckHook`.
598+
599+#### Using pytestCheckHook {#using-pytestcheckhook}
600+
601+`pytestCheckHook` is a convenient hook which will substitute the setuptools
602+`test` command for a checkPhase which runs `pytest`. This is also beneficial
603+when a package may need many items disabled to run the test suite.
604+
605+Using the example above, the analagous pytestCheckHook usage would be:
606+
607+```
608+ checkInputs = [ pytestCheckHook ];
609+
610+ # requires additional data
611+ pytestFlagsArray = [ "tests/" "--ignore=tests/integration" ];
612+
613+ disabledTests = [
614+ # touches network
615+ "download"
616+ "update"
617+ ];
618+
619+ disabledTestPaths = [
620+ "tests/test_failing.py"
621+ ];
622+```
623+
624+This is expecially useful when tests need to be conditionallydisabled,
625+for example:
626+
627+```
628+ disabledTests = [
629+ # touches network
630+ "download"
631+ "update"
632+ ] ++ lib.optionals (pythonAtLeast "3.8") [
633+ # broken due to python3.8 async changes
634+ "async"
635+ ] ++ lib.optionals stdenv.isDarwin [
636+ # can fail when building with other packages
637+ "socket"
638+ ];
639+```
640+Trying to concatenate the related strings to disable tests in a regular checkPhase
641+would be much harder to read. This also enables us to comment on why specific tests
642+are disabled.
643+
644+#### Using pythonImportsCheck {#using-pythonimportscheck}
645+
646+Although unit tests are highly prefered to validate correctness of a package, not
647+all packages have test suites that can be ran easily, and some have none at all.
648+To help ensure the package still works, `pythonImportsCheck` can attempt to import
649+the listed modules.
650+
651+```
652+ pythonImportsCheck = [ "requests" "urllib" ];
653+```
654+roughly translates to:
655+```
656+ postCheck = ''
657+ PYTHONPATH=$out/${python.sitePackages}:$PYTHONPATH
658+ python -c "import requests; import urllib"
659+ '';
660+```
661+However, this is done in it's own phase, and not dependent on whether `doCheck = true;`
662+
663+This can also be useful in verifying that the package doesn't assume commonly
664+present packages (e.g. `setuptools`)
665+
666+### Develop local package {#develop-local-package}
667+
668+As a Python developer you're likely aware of [development mode](http://setuptools.readthedocs.io/en/latest/setuptools.html#development-mode)
669+(`python setup.py develop`); instead of installing the package this command
670+creates a special link to the project code. That way, you can run updated code
671+without having to reinstall after each and every change you make. Development
672+mode is also available. Let's see how you can use it.
673+
674+In the previous Nix expression the source was fetched from an url. We can also
675+refer to a local source instead using `src = ./path/to/source/tree;`
676+
677+If we create a `shell.nix` file which calls `buildPythonPackage`, and if `src`
678+is a local source, and if the local source has a `setup.py`, then development
679+mode is activated.
680+
681+In the following example we create a simple environment that has a Python 3.8
682+version of our package in it, as well as its dependencies and other packages we
683+like to have in the environment, all specified with `propagatedBuildInputs`.
684+Indeed, we can just add any package we like to have in our environment to
685+`propagatedBuildInputs`.
686+
687+```nix
688+with import <nixpkgs> {};
689+with python38Packages;
690+
691+buildPythonPackage rec {
692+ name = "mypackage";
693+ src = ./path/to/package/source;
694+ propagatedBuildInputs = [ pytest numpy pkgs.libsndfile ];
695+}
696+```
697+
698+It is important to note that due to how development mode is implemented on Nix
699+it is not possible to have multiple packages simultaneously in development mode.
700+
701+### Organising your packages {#organising-your-packages}
702+
703+So far we discussed how you can use Python on Nix, and how you can develop with
704+it. We've looked at how you write expressions to package Python packages, and we
705+looked at how you can create environments in which specified packages are
706+available.
707+
708+At some point you'll likely have multiple packages which you would
709+like to be able to use in different projects. In order to minimise unnecessary
710+duplication we now look at how you can maintain a repository with your
711+own packages. The important functions here are `import` and `callPackage`.
712+
713+### Including a derivation using `callPackage` {#including-a-derivation-using-callpackage}
714+
715+Earlier we created a Python environment using `withPackages`, and included the
716+`toolz` package via a `let` expression.
717+Let's split the package definition from the environment definition.
718+
719+We first create a function that builds `toolz` in `~/path/to/toolz/release.nix`
720+
721+```nix
722+{ lib, buildPythonPackage }:
723+
724+buildPythonPackage rec {
725+ pname = "toolz";
726+ version = "0.10.0";
727+
728+ src = fetchPypi {
729+ inherit pname version;
730+ sha256 = "08fdd5ef7c96480ad11c12d472de21acd32359996f69a5259299b540feba4560";
731+ };
732+
733+ meta = with lib; {
734+ homepage = "https://github.com/pytoolz/toolz/";
735+ description = "List processing tools and functional utilities";
736+ license = licenses.bsd3;
737+ maintainers = with maintainers; [ fridh ];
738+ };
739+}
740+```
741+
742+It takes an argument `buildPythonPackage`. We now call this function using
743+`callPackage` in the definition of our environment
744+
745+```nix
746+with import <nixpkgs> {};
747+
748+( let
749+ toolz = callPackage /path/to/toolz/release.nix {
750+ buildPythonPackage = python38Packages.buildPythonPackage;
751+ };
752+ in python38.withPackages (ps: [ ps.numpy toolz ])
753+).env
754+```
755+
756+Important to remember is that the Python version for which the package is made
757+depends on the `python` derivation that is passed to `buildPythonPackage`. Nix
758+tries to automatically pass arguments when possible, which is why generally you
759+don't explicitly define which `python` derivation should be used. In the above
760+example we use `buildPythonPackage` that is part of the set `python38Packages`,
761+and in this case the `python38` interpreter is automatically used.
762+
763+## Reference {#reference}
764+
765+### Interpreters {#interpreters}
766+
767+Versions 2.7, 3.7, 3.8 and 3.9 of the CPython interpreter are available as
768+respectively `python27`, `python37`, `python38` and `python39`. The
769+aliases `python2` and `python3` correspond to respectively `python27` and
770+`python39`. The attribute `python` maps to `python2`. The PyPy interpreters
771+compatible with Python 2.7 and 3 are available as `pypy27` and `pypy3`, with
772+aliases `pypy2` mapping to `pypy27` and `pypy` mapping to `pypy2`. The Nix
773+expressions for the interpreters can be found in
774+`pkgs/development/interpreters/python`.
775+
776+All packages depending on any Python interpreter get appended
777+`out/{python.sitePackages}` to `$PYTHONPATH` if such directory
778+exists.
779+
780+#### Missing `tkinter` module standard library {#missing-tkinter-module-standard-library}
781+
782+To reduce closure size the `Tkinter`/`tkinter` is available as a separate package, `pythonPackages.tkinter`.
783+
784+#### Attributes on interpreters packages {#attributes-on-interpreters-packages}
785+
786+Each interpreter has the following attributes:
787+
788+- `libPrefix`. Name of the folder in `${python}/lib/` for corresponding interpreter.
789+- `interpreter`. Alias for `${python}/bin/${executable}`.
790+- `buildEnv`. Function to build python interpreter environments with extra packages bundled together. See section *python.buildEnv function* for usage and documentation.
791+- `withPackages`. Simpler interface to `buildEnv`. See section *python.withPackages function* for usage and documentation.
792+- `sitePackages`. Alias for `lib/${libPrefix}/site-packages`.
793+- `executable`. Name of the interpreter executable, e.g. `python3.8`.
794+- `pkgs`. Set of Python packages for that specific interpreter. The package set can be modified by overriding the interpreter and passing `packageOverrides`.
795+
796+### Optimizations {#optimizations}
797+
798+The Python interpreters are by default not build with optimizations enabled, because
799+the builds are in that case not reproducible. To enable optimizations, override the
800+interpreter of interest, e.g using
801+
802+```
803+let
804+ pkgs = import ./. {};
805+ mypython = pkgs.python3.override {
806+ enableOptimizations = true;
807+ reproducibleBuild = false;
808+ self = mypython;
809+ };
810+in mypython
811+```
812+
813+### Building packages and applications {#building-packages-and-applications}
814+
815+Python libraries and applications that use `setuptools` or
816+`distutils` are typically built with respectively the `buildPythonPackage` and
817+`buildPythonApplication` functions. These two functions also support installing a `wheel`.
818+
819+All Python packages reside in `pkgs/top-level/python-packages.nix` and all
820+applications elsewhere. In case a package is used as both a library and an
821+application, then the package should be in `pkgs/top-level/python-packages.nix`
822+since only those packages are made available for all interpreter versions. The
823+preferred location for library expressions is in
824+`pkgs/development/python-modules`. It is important that these packages are
825+called from `pkgs/top-level/python-packages.nix` and not elsewhere, to guarantee
826+the right version of the package is built.
827+
828+Based on the packages defined in `pkgs/top-level/python-packages.nix` an
829+attribute set is created for each available Python interpreter. The available
830+sets are
831+
832+* `pkgs.python27Packages`
833+* `pkgs.python37Packages`
834+* `pkgs.python38Packages`
835+* `pkgs.python39Packages`
836+* `pkgs.python310Packages`
837+* `pkgs.python311Packages`
838+* `pkgs.pypyPackages`
839+
840+and the aliases
841+
842+* `pkgs.python2Packages` pointing to `pkgs.python27Packages`
843+* `pkgs.python3Packages` pointing to `pkgs.python39Packages`
844+* `pkgs.pythonPackages` pointing to `pkgs.python2Packages`
845+
846+#### `buildPythonPackage` function {#buildpythonpackage-function}
847+
848+The `buildPythonPackage` function is implemented in
849+`pkgs/development/interpreters/python/mk-python-derivation`
850+using setup hooks.
851+
852+The following is an example:
853+
854+```nix
855+{ lib, buildPythonPackage, fetchPypi, hypothesis, setuptools-scm, attrs, py, setuptools, six, pluggy }:
856+
857+buildPythonPackage rec {
858+ pname = "pytest";
859+ version = "3.3.1";
860+
861+ src = fetchPypi {
862+ inherit pname version;
863+ sha256 = "cf8436dc59d8695346fcd3ab296de46425ecab00d64096cebe79fb51ecb2eb93";
864+ };
865+
866+ postPatch = ''
867+ # don't test bash builtins
868+ rm testing/test_argcomplete.py
869+ '';
870+
871+ checkInputs = [ hypothesis ];
872+ nativeBuildInputs = [ setuptools-scm ];
873+ propagatedBuildInputs = [ attrs py setuptools six pluggy ];
874+
875+ meta = with lib; {
876+ maintainers = with maintainers; [ domenkozar lovek323 madjar lsix ];
877+ description = "Framework for writing tests";
878+ };
879+}
880+```
881+
882+The `buildPythonPackage` mainly does four things:
883+
884+* In the `buildPhase`, it calls `${python.interpreter} setup.py bdist_wheel` to
885+ build a wheel binary zipfile.
886+* In the `installPhase`, it installs the wheel file using `pip install *.whl`.
887+* In the `postFixup` phase, the `wrapPythonPrograms` bash function is called to
888+ wrap all programs in the `$out/bin/*` directory to include `$PATH`
889+ environment variable and add dependent libraries to script's `sys.path`.
890+* In the `installCheck` phase, `${python.interpreter} setup.py test` is ran.
891+
892+By default tests are run because `doCheck = true`. Test dependencies, like
893+e.g. the test runner, should be added to `checkInputs`.
894+
895+By default `meta.platforms` is set to the same value
896+as the interpreter unless overridden otherwise.
897+
898+##### `buildPythonPackage` parameters {#buildpythonpackage-parameters}
899+
900+All parameters from `stdenv.mkDerivation` function are still supported. The
901+following are specific to `buildPythonPackage`:
902+
903+* `catchConflicts ? true`: If `true`, abort package build if a package name
904+ appears more than once in dependency tree. Default is `true`.
905+* `disabled` ? false: If `true`, package is not built for the particular Python
906+ interpreter version.
907+* `dontWrapPythonPrograms ? false`: Skip wrapping of Python programs.
908+* `permitUserSite ? false`: Skip setting the `PYTHONNOUSERSITE` environment
909+ variable in wrapped programs.
910+* `format ? "setuptools"`: Format of the source. Valid options are
911+ `"setuptools"`, `"pyproject"`, `"flit"`, `"wheel"`, and `"other"`.
912+ `"setuptools"` is for when the source has a `setup.py` and `setuptools` is
913+ used to build a wheel, `flit`, in case `flit` should be used to build a wheel,
914+ and `wheel` in case a wheel is provided. Use `other` when a custom
915+ `buildPhase` and/or `installPhase` is needed.
916+* `makeWrapperArgs ? []`: A list of strings. Arguments to be passed to
917+ `makeWrapper`, which wraps generated binaries. By default, the arguments to
918+ `makeWrapper` set `PATH` and `PYTHONPATH` environment variables before calling
919+ the binary. Additional arguments here can allow a developer to set environment
920+ variables which will be available when the binary is run. For example,
921+ `makeWrapperArgs = ["--set FOO BAR" "--set BAZ QUX"]`.
922+* `namePrefix`: Prepends text to `${name}` parameter. In case of libraries, this
923+ defaults to `"python3.8-"` for Python 3.8, etc., and in case of applications
924+ to `""`.
925+* `pipInstallFlags ? []`: A list of strings. Arguments to be passed to `pip
926+ install`. To pass options to `python setup.py install`, use
927+ `--install-option`. E.g., `pipInstallFlags=["--install-option='--cpp_implementation'"]`.
928+* `pythonPath ? []`: List of packages to be added into `$PYTHONPATH`. Packages
929+ in `pythonPath` are not propagated (contrary to `propagatedBuildInputs`).
930+* `preShellHook`: Hook to execute commands before `shellHook`.
931+* `postShellHook`: Hook to execute commands after `shellHook`.
932+* `removeBinByteCode ? true`: Remove bytecode from `/bin`. Bytecode is only
933+ created when the filenames end with `.py`.
934+* `setupPyGlobalFlags ? []`: List of flags passed to `setup.py` command.
935+* `setupPyBuildFlags ? []`: List of flags passed to `setup.py build_ext` command.
936+
937+The `stdenv.mkDerivation` function accepts various parameters for describing
938+build inputs (see "Specifying dependencies"). The following are of special
939+interest for Python packages, either because these are primarily used, or
940+because their behaviour is different:
941+
942+* `nativeBuildInputs ? []`: Build-time only dependencies. Typically executables
943+ as well as the items listed in `setup_requires`.
944+* `buildInputs ? []`: Build and/or run-time dependencies that need to be
945+ compiled for the host machine. Typically non-Python libraries which are being
946+ linked.
947+* `checkInputs ? []`: Dependencies needed for running the `checkPhase`. These
948+ are added to `nativeBuildInputs` when `doCheck = true`. Items listed in
949+ `tests_require` go here.
950+* `propagatedBuildInputs ? []`: Aside from propagating dependencies,
951+ `buildPythonPackage` also injects code into and wraps executables with the
952+ paths included in this list. Items listed in `install_requires` go here.
953+
954+##### Overriding Python packages {#overriding-python-packages}
955+
956+The `buildPythonPackage` function has a `overridePythonAttrs` method that can be
957+used to override the package. In the following example we create an environment
958+where we have the `blaze` package using an older version of `pandas`. We
959+override first the Python interpreter and pass `packageOverrides` which contains
960+the overrides for packages in the package set.
961+
962+```nix
963+with import <nixpkgs> {};
964+
965+(let
966+ python = let
967+ packageOverrides = self: super: {
968+ pandas = super.pandas.overridePythonAttrs(old: rec {
969+ version = "0.19.1";
970+ src = super.fetchPypi {
971+ pname = "pandas";
972+ inherit version;
973+ sha256 = "08blshqj9zj1wyjhhw3kl2vas75vhhicvv72flvf1z3jvapgw295";
974+ };
975+ });
976+ };
977+ in pkgs.python3.override {inherit packageOverrides; self = python;};
978+
979+in python.withPackages(ps: [ps.blaze])).env
980+```
981+
982+#### Optional extra dependencies
983+
984+Some packages define optional dependencies for additional features. With
985+`setuptools` this is called `extras_require` and `flit` calls it `extras-require`. A
986+method for supporting this is by declaring the extras of a package in its
987+`passthru`, e.g. in case of the package `dask`
988+
989+```nix
990+passthru.extras-require = {
991+ complete = [ distributed ];
992+};
993+```
994+
995+and letting the package requiring the extra add the list to its dependencies
996+
997+```nix
998+propagatedBuildInputs = [
999+ ...
1000+] ++ dask.extras-require.complete;
1001+```
1002+
1003+Note this method is preferred over adding parameters to builders, as that can
1004+result in packages depending on different variants and thereby causing
1005+collisions.
1006+
1007+#### `buildPythonApplication` function {#buildpythonapplication-function}
1008+
1009+The `buildPythonApplication` function is practically the same as
1010+`buildPythonPackage`. The main purpose of this function is to build a Python
1011+package where one is interested only in the executables, and not importable
1012+modules. For that reason, when adding this package to a `python.buildEnv`, the
1013+modules won't be made available.
1014+
1015+Another difference is that `buildPythonPackage` by default prefixes the names of
1016+the packages with the version of the interpreter. Because this is irrelevant for
1017+applications, the prefix is omitted.
1018+
1019+When packaging a Python application with `buildPythonApplication`, it should be
1020+called with `callPackage` and passed `python` or `pythonPackages` (possibly
1021+specifying an interpreter version), like this:
1022+
1023+```nix
1024+{ lib, python3 }:
1025+
1026+python3.pkgs.buildPythonApplication rec {
1027+ pname = "luigi";
1028+ version = "2.7.9";
1029+
1030+ src = python3.pkgs.fetchPypi {
1031+ inherit pname version;
1032+ sha256 = "035w8gqql36zlan0xjrzz9j4lh9hs0qrsgnbyw07qs7lnkvbdv9x";
1033+ };
1034+
1035+ propagatedBuildInputs = with python3.pkgs; [ tornado python-daemon ];
1036+
1037+ meta = with lib; {
1038+ ...
1039+ };
1040+}
1041+```
1042+
1043+This is then added to `all-packages.nix` just as any other application would be.
1044+
1045+```nix
1046+luigi = callPackage ../applications/networking/cluster/luigi { };
1047+```
1048+
1049+Since the package is an application, a consumer doesn't need to care about
1050+Python versions or modules, which is why they don't go in `pythonPackages`.
1051+
1052+#### `toPythonApplication` function {#topythonapplication-function}
1053+
1054+A distinction is made between applications and libraries, however, sometimes a
1055+package is used as both. In this case the package is added as a library to
1056+`python-packages.nix` and as an application to `all-packages.nix`. To reduce
1057+duplication the `toPythonApplication` can be used to convert a library to an
1058+application.
1059+
1060+The Nix expression shall use `buildPythonPackage` and be called from
1061+`python-packages.nix`. A reference shall be created from `all-packages.nix` to
1062+the attribute in `python-packages.nix`, and the `toPythonApplication` shall be
1063+applied to the reference:
1064+
1065+```nix
1066+youtube-dl = with pythonPackages; toPythonApplication youtube-dl;
1067+```
1068+
1069+#### `toPythonModule` function {#topythonmodule-function}
1070+
1071+In some cases, such as bindings, a package is created using
1072+`stdenv.mkDerivation` and added as attribute in `all-packages.nix`. The Python
1073+bindings should be made available from `python-packages.nix`. The
1074+`toPythonModule` function takes a derivation and makes certain Python-specific
1075+modifications.
1076+
1077+```nix
1078+opencv = toPythonModule (pkgs.opencv.override {
1079+ enablePython = true;
1080+ pythonPackages = self;
1081+});
1082+```
1083+
1084+Do pay attention to passing in the right Python version!
1085+
1086+#### `python.buildEnv` function {#python.buildenv-function}
1087+
1088+Python environments can be created using the low-level `pkgs.buildEnv` function.
1089+This example shows how to create an environment that has the Pyramid Web Framework.
1090+Saving the following as `default.nix`
1091+
1092+```nix
1093+with import <nixpkgs> {};
1094+
1095+python.buildEnv.override {
1096+ extraLibs = [ pythonPackages.pyramid ];
1097+ ignoreCollisions = true;
1098+}
1099+```
1100+
1101+and running `nix-build` will create
1102+
1103+```
1104+/nix/store/cf1xhjwzmdki7fasgr4kz6di72ykicl5-python-2.7.8-env
1105+```
1106+
1107+with wrapped binaries in `bin/`.
1108+
1109+You can also use the `env` attribute to create local environments with needed
1110+packages installed. This is somewhat comparable to `virtualenv`. For example,
1111+running `nix-shell` with the following `shell.nix`
1112+
1113+```nix
1114+with import <nixpkgs> {};
1115+
1116+(python3.buildEnv.override {
1117+ extraLibs = with python3Packages; [ numpy requests ];
1118+}).env
1119+```
1120+
1121+will drop you into a shell where Python will have the
1122+specified packages in its path.
1123+
1124+##### `python.buildEnv` arguments {#python.buildenv-arguments}
1125+
1126+
1127+* `extraLibs`: List of packages installed inside the environment.
1128+* `postBuild`: Shell command executed after the build of environment.
1129+* `ignoreCollisions`: Ignore file collisions inside the environment (default is `false`).
1130+* `permitUserSite`: Skip setting the `PYTHONNOUSERSITE` environment variable in
1131+ wrapped binaries in the environment.
1132+
1133+#### `python.withPackages` function {#python.withpackages-function}
1134+
1135+The `python.withPackages` function provides a simpler interface to the `python.buildEnv` functionality.
1136+It takes a function as an argument that is passed the set of python packages and returns the list
1137+of the packages to be included in the environment. Using the `withPackages` function, the previous
1138+example for the Pyramid Web Framework environment can be written like this:
1139+
1140+```nix
1141+with import <nixpkgs> {};
1142+
1143+python.withPackages (ps: [ps.pyramid])
1144+```
1145+
1146+`withPackages` passes the correct package set for the specific interpreter
1147+version as an argument to the function. In the above example, `ps` equals
1148+`pythonPackages`. But you can also easily switch to using python3:
1149+
1150+```nix
1151+with import <nixpkgs> {};
1152+
1153+python3.withPackages (ps: [ps.pyramid])
1154+```
1155+
1156+Now, `ps` is set to `python3Packages`, matching the version of the interpreter.
1157+
1158+As `python.withPackages` simply uses `python.buildEnv` under the hood, it also
1159+supports the `env` attribute. The `shell.nix` file from the previous section can
1160+thus be also written like this:
1161+
1162+```nix
1163+with import <nixpkgs> {};
1164+
1165+(python38.withPackages (ps: [ps.numpy ps.requests])).env
1166+```
1167+
1168+In contrast to `python.buildEnv`, `python.withPackages` does not support the
1169+more advanced options such as `ignoreCollisions = true` or `postBuild`. If you
1170+need them, you have to use `python.buildEnv`.
1171+
1172+Python 2 namespace packages may provide `__init__.py` that collide. In that case
1173+`python.buildEnv` should be used with `ignoreCollisions = true`.
1174+
1175+#### Setup hooks {#setup-hooks}
1176+
1177+The following are setup hooks specifically for Python packages. Most of these
1178+are used in `buildPythonPackage`.
1179+
1180+- `eggUnpackhook` to move an egg to the correct folder so it can be installed
1181+ with the `eggInstallHook`
1182+- `eggBuildHook` to skip building for eggs.
1183+- `eggInstallHook` to install eggs.
1184+- `flitBuildHook` to build a wheel using `flit`.
1185+- `pipBuildHook` to build a wheel using `pip` and PEP 517. Note a build system
1186+ (e.g. `setuptools` or `flit`) should still be added as `nativeBuildInput`.
1187+- `pipInstallHook` to install wheels.
1188+- `pytestCheckHook` to run tests with `pytest`. See [example usage](#using-pytestcheckhook).
1189+- `pythonCatchConflictsHook` to check whether a Python package is not already existing.
1190+- `pythonImportsCheckHook` to check whether importing the listed modules works.
1191+- `pythonRemoveBinBytecode` to remove bytecode from the `/bin` folder.
1192+- `setuptoolsBuildHook` to build a wheel using `setuptools`.
1193+- `setuptoolsCheckHook` to run tests with `python setup.py test`.
1194+- `venvShellHook` to source a Python 3 `venv` at the `venvDir` location. A
1195+ `venv` is created if it does not yet exist. `postVenvCreation` can be used to
1196+ to run commands only after venv is first created.
1197+- `wheelUnpackHook` to move a wheel to the correct folder so it can be installed
1198+ with the `pipInstallHook`.
1199+
1200+### Development mode {#development-mode}
1201+
1202+Development or editable mode is supported. To develop Python packages
1203+`buildPythonPackage` has additional logic inside `shellPhase` to run `pip
1204+install -e . --prefix $TMPDIR/`for the package.
1205+
1206+Warning: `shellPhase` is executed only if `setup.py` exists.
1207+
1208+Given a `default.nix`:
1209+
1210+```nix
1211+with import <nixpkgs> {};
1212+
1213+pythonPackages.buildPythonPackage {
1214+ name = "myproject";
1215+ buildInputs = with pythonPackages; [ pyramid ];
1216+
1217+ src = ./.;
1218+}
1219+```
1220+
1221+Running `nix-shell` with no arguments should give you the environment in which
1222+the package would be built with `nix-build`.
1223+
1224+Shortcut to setup environments with C headers/libraries and Python packages:
1225+
1226+```shell
1227+nix-shell -p pythonPackages.pyramid zlib libjpeg git
1228+```
1229+
1230+Note: There is a boolean value `lib.inNixShell` set to `true` if nix-shell is invoked.
1231+
1232+### Tools {#tools}
1233+
1234+Packages inside nixpkgs are written by hand. However many tools exist in
1235+community to help save time. No tool is preferred at the moment.
1236+
1237+- [pypi2nix](https://github.com/nix-community/pypi2nix): Generate Nix
1238+ expressions for your Python project. Note that [sharing derivations from
1239+ pypi2nix with nixpkgs is possible but not
1240+ encouraged](https://github.com/nix-community/pypi2nix/issues/222#issuecomment-443497376).
1241+- [nixpkgs-pytools](https://github.com/nix-community/nixpkgs-pytools)
1242+- [poetry2nix](https://github.com/nix-community/poetry2nix)
1243+
1244+### Deterministic builds {#deterministic-builds}
1245+
1246+The Python interpreters are now built deterministically. Minor modifications had
1247+to be made to the interpreters in order to generate deterministic bytecode. This
1248+has security implications and is relevant for those using Python in a
1249+`nix-shell`.
1250+
1251+When the environment variable `DETERMINISTIC_BUILD` is set, all bytecode will
1252+have timestamp 1. The `buildPythonPackage` function sets `DETERMINISTIC_BUILD=1`
1253+and [PYTHONHASHSEED=0](https://docs.python.org/3.8/using/cmdline.html#envvar-PYTHONHASHSEED).
1254+Both are also exported in `nix-shell`.
1255+
1256+### Automatic tests {#automatic-tests}
1257+
1258+It is recommended to test packages as part of the build process.
1259+Source distributions (`sdist`) often include test files, but not always.
1260+
1261+By default the command `python setup.py test` is run as part of the
1262+`checkPhase`, but often it is necessary to pass a custom `checkPhase`. An
1263+example of such a situation is when `py.test` is used.
1264+
1265+#### Common issues {#common-issues}
1266+
1267+* Non-working tests can often be deselected. By default `buildPythonPackage`
1268+ runs `python setup.py test`. Most Python modules follows the standard test
1269+ protocol where the pytest runner can be used instead. `py.test` supports a
1270+ `-k` parameter to ignore test methods or classes:
1271+
1272+ ```nix
1273+ buildPythonPackage {
1274+ # ...
1275+ # assumes the tests are located in tests
1276+ checkInputs = [ pytest ];
1277+ checkPhase = ''
1278+ py.test -k 'not function_name and not other_function' tests
1279+ '';
1280+ }
1281+ ```
1282+
1283+* Tests that attempt to access `$HOME` can be fixed by using the following
1284+ work-around before running tests (e.g. `preCheck`): `export HOME=$(mktemp -d)`
1285+
1286+## FAQ {#faq}
1287+
1288+### How to solve circular dependencies? {#how-to-solve-circular-dependencies}
1289+
1290+Consider the packages `A` and `B` that depend on each other. When packaging `B`,
1291+a solution is to override package `A` not to depend on `B` as an input. The same
1292+should also be done when packaging `A`.
1293+
1294+### How to override a Python package? {#how-to-override-a-python-package}
1295+
1296+We can override the interpreter and pass `packageOverrides`. In the following
1297+example we rename the `pandas` package and build it.
1298+
1299+```nix
1300+with import <nixpkgs> {};
1301+
1302+(let
1303+ python = let
1304+ packageOverrides = self: super: {
1305+ pandas = super.pandas.overridePythonAttrs(old: {name="foo";});
1306+ };
1307+ in pkgs.python38.override {inherit packageOverrides;};
1308+
1309+in python.withPackages(ps: [ps.pandas])).env
1310+```
1311+
1312+Using `nix-build` on this expression will build an environment that contains the
1313+package `pandas` but with the new name `foo`.
1314+
1315+All packages in the package set will use the renamed package. A typical use case
1316+is to switch to another version of a certain package. For example, in the
1317+Nixpkgs repository we have multiple versions of `django` and `scipy`. In the
1318+following example we use a different version of `scipy` and create an
1319+environment that uses it. All packages in the Python package set will now use
1320+the updated `scipy` version.
1321+
1322+```nix
1323+with import <nixpkgs> {};
1324+
1325+( let
1326+ packageOverrides = self: super: {
1327+ scipy = super.scipy_0_17;
1328+ };
1329+ in (pkgs.python38.override {inherit packageOverrides;}).withPackages (ps: [ps.blaze])
1330+).env
1331+```
1332+
1333+The requested package `blaze` depends on `pandas` which itself depends on `scipy`.
1334+
1335+If you want the whole of Nixpkgs to use your modifications, then you can use
1336+`overlays` as explained in this manual. In the following example we build a
1337+`inkscape` using a different version of `numpy`.
1338+
1339+```nix
1340+let
1341+ pkgs = import <nixpkgs> {};
1342+ newpkgs = import pkgs.path { overlays = [ (self: super: {
1343+ python38 = let
1344+ packageOverrides = python-self: python-super: {
1345+ numpy = python-super.numpy_1_18;
1346+ };
1347+ in super.python38.override {inherit packageOverrides;};
1348+ } ) ]; };
1349+in newpkgs.inkscape
1350+```
1351+
1352+### `python setup.py bdist_wheel` cannot create .whl {#python-setup.py-bdist_wheel-cannot-create-.whl}
1353+
1354+Executing `python setup.py bdist_wheel` in a `nix-shell `fails with
1355+```
1356+ValueError: ZIP does not support timestamps before 1980
1357+```
1358+
1359+This is because files from the Nix store (which have a timestamp of the UNIX
1360+epoch of January 1, 1970) are included in the .ZIP, but .ZIP archives follow the
1361+DOS convention of counting timestamps from 1980.
1362+
1363+The command `bdist_wheel` reads the `SOURCE_DATE_EPOCH` environment variable,
1364+which `nix-shell` sets to 1. Unsetting this variable or giving it a value
1365+corresponding to 1980 or later enables building wheels.
1366+
1367+Use 1980 as timestamp:
1368+
1369+```shell
1370+nix-shell --run "SOURCE_DATE_EPOCH=315532800 python3 setup.py bdist_wheel"
1371+```
1372+
1373+or the current time:
1374+
1375+```shell
1376+nix-shell --run "SOURCE_DATE_EPOCH=$(date +%s) python3 setup.py bdist_wheel"
1377+```
1378+
1379+or unset `SOURCE_DATE_EPOCH`:
1380+
1381+```shell
1382+nix-shell --run "unset SOURCE_DATE_EPOCH; python3 setup.py bdist_wheel"
1383+```
1384+
1385+### `install_data` / `data_files` problems {#install_data-data_files-problems}
1386+
1387+If you get the following error:
1388+
1389+```
1390+could not create '/nix/store/6l1bvljpy8gazlsw2aw9skwwp4pmvyxw-python-2.7.8/etc':
1391+Permission denied
1392+```
1393+
1394+This is a [known bug](https://github.com/pypa/setuptools/issues/130) in
1395+`setuptools`. Setuptools `install_data` does not respect `--prefix`. An example
1396+of such package using the feature is `pkgs/tools/X11/xpra/default.nix`.
1397+
1398+As workaround install it as an extra `preInstall` step:
1399+
1400+```shell
1401+${python.interpreter} setup.py install_data --install-dir=$out --root=$out
1402+sed -i '/ = data\_files/d' setup.py
1403+```
1404+
1405+### Rationale of non-existent global site-packages {#rationale-of-non-existent-global-site-packages}
1406+
1407+On most operating systems a global `site-packages` is maintained. This however
1408+becomes problematic if you want to run multiple Python versions or have multiple
1409+versions of certain libraries for your projects. Generally, you would solve such
1410+issues by creating virtual environments using `virtualenv`.
1411+
1412+On Nix each package has an isolated dependency tree which, in the case of
1413+Python, guarantees the right versions of the interpreter and libraries or
1414+packages are available. There is therefore no need to maintain a global `site-packages`.
1415+
1416+If you want to create a Python environment for development, then the recommended
1417+method is to use `nix-shell`, either with or without the `python.buildEnv`
1418+function.
1419+
1420+### How to consume Python modules using pip in a virtual environment like I am used to on other Operating Systems? {#how-to-consume-python-modules-using-pip-in-a-virtual-environment-like-i-am-used-to-on-other-operating-systems}
1421+
1422+While this approach is not very idiomatic from Nix perspective, it can still be
1423+useful when dealing with pre-existing projects or in situations where it's not
1424+feasible or desired to write derivations for all required dependencies.
1425+
1426+This is an example of a `default.nix` for a `nix-shell`, which allows to consume
1427+a virtual environment created by `venv`, and install Python modules through
1428+`pip` the traditional way.
1429+
1430+Create this `default.nix` file, together with a `requirements.txt` and simply
1431+execute `nix-shell`.
1432+
1433+```nix
1434+with import <nixpkgs> { };
1435+
1436+let
1437+ pythonPackages = python3Packages;
1438+in pkgs.mkShell rec {
1439+ name = "impurePythonEnv";
1440+ venvDir = "./.venv";
1441+ buildInputs = [
1442+ # A Python interpreter including the 'venv' module is required to bootstrap
1443+ # the environment.
1444+ pythonPackages.python
1445+
1446+ # This execute some shell code to initialize a venv in $venvDir before
1447+ # dropping into the shell
1448+ pythonPackages.venvShellHook
1449+
1450+ # Those are dependencies that we would like to use from nixpkgs, which will
1451+ # add them to PYTHONPATH and thus make them accessible from within the venv.
1452+ pythonPackages.numpy
1453+ pythonPackages.requests
1454+
1455+ # In this particular example, in order to compile any binary extensions they may
1456+ # require, the Python modules listed in the hypothetical requirements.txt need
1457+ # the following packages to be installed locally:
1458+ taglib
1459+ openssl
1460+ git
1461+ libxml2
1462+ libxslt
1463+ libzip
1464+ zlib
1465+ ];
1466+
1467+ # Run this command, only after creating the virtual environment
1468+ postVenvCreation = ''
1469+ unset SOURCE_DATE_EPOCH
1470+ pip install -r requirements.txt
1471+ '';
1472+
1473+ # Now we can execute any commands within the virtual environment.
1474+ # This is optional and can be left out to run pip manually.
1475+ postShellHook = ''
1476+ # allow pip to install wheels
1477+ unset SOURCE_DATE_EPOCH
1478+ '';
1479+
1480+}
1481+```
1482+
1483+In case the supplied venvShellHook is insufficient, or when Python 2 support is
1484+needed, you can define your own shell hook and adapt to your needs like in the
1485+following example:
1486+
1487+```nix
1488+with import <nixpkgs> { };
1489+
1490+let
1491+ venvDir = "./.venv";
1492+ pythonPackages = python3Packages;
1493+in pkgs.mkShell rec {
1494+ name = "impurePythonEnv";
1495+ buildInputs = [
1496+ pythonPackages.python
1497+ # Needed when using python 2.7
1498+ # pythonPackages.virtualenv
1499+ # ...
1500+ ];
1501+
1502+ # This is very close to how venvShellHook is implemented, but
1503+ # adapted to use 'virtualenv'
1504+ shellHook = ''
1505+ SOURCE_DATE_EPOCH=$(date +%s)
1506+
1507+ if [ -d "${venvDir}" ]; then
1508+ echo "Skipping venv creation, '${venvDir}' already exists"
1509+ else
1510+ echo "Creating new venv environment in path: '${venvDir}'"
1511+ # Note that the module venv was only introduced in python 3, so for 2.7
1512+ # this needs to be replaced with a call to virtualenv
1513+ ${pythonPackages.python.interpreter} -m venv "${venvDir}"
1514+ fi
1515+
1516+ # Under some circumstances it might be necessary to add your virtual
1517+ # environment to PYTHONPATH, which you can do here too;
1518+ # PYTHONPATH=$PWD/${venvDir}/${pythonPackages.python.sitePackages}/:$PYTHONPATH
1519+
1520+ source "${venvDir}/bin/activate"
1521+
1522+ # As in the previous example, this is optional.
1523+ pip install -r requirements.txt
1524+ '';
1525+}
1526+```
1527+
1528+Note that the `pip install` is an imperative action. So every time `nix-shell`
1529+is executed it will attempt to download the Python modules listed in
1530+requirements.txt. However these will be cached locally within the `virtualenv`
1531+folder and not downloaded again.
1532+
1533+### How to override a Python package from `configuration.nix`? {#how-to-override-a-python-package-from-configuration.nix}
1534+
1535+If you need to change a package's attribute(s) from `configuration.nix` you could do:
1536+
1537+```nix
1538+ nixpkgs.config.packageOverrides = super: {
1539+ python = super.python.override {
1540+ packageOverrides = python-self: python-super: {
1541+ twisted = python-super.twisted.overrideAttrs (oldAttrs: {
1542+ src = super.fetchPypi {
1543+ pname = "twisted";
1544+ version = "19.10.0";
1545+ sha256 = "7394ba7f272ae722a74f3d969dcf599bc4ef093bc392038748a490f1724a515d";
1546+ extension = "tar.bz2";
1547+ };
1548+ });
1549+ };
1550+ };
1551+ };
1552+```
1553+
1554+`pythonPackages.twisted` is now globally overridden.
1555+All packages and also all NixOS services that reference `twisted`
1556+(such as `services.buildbot-worker`) now use the new definition.
1557+Note that `python-super` refers to the old package set and `python-self`
1558+to the new, overridden version.
1559+
1560+To modify only a Python package set instead of a whole Python derivation, use
1561+this snippet:
1562+
1563+```nix
1564+ myPythonPackages = pythonPackages.override {
1565+ overrides = self: super: {
1566+ twisted = ...;
1567+ };
1568+ }
1569+```
1570+
1571+### How to override a Python package using overlays? {#how-to-override-a-python-package-using-overlays}
1572+
1573+Use the following overlay template:
1574+
1575+```nix
1576+self: super: {
1577+ python = super.python.override {
1578+ packageOverrides = python-self: python-super: {
1579+ twisted = python-super.twisted.overrideAttrs (oldAttrs: {
1580+ src = super.fetchPypi {
1581+ pname = "twisted";
1582+ version = "19.10.0";
1583+ sha256 = "7394ba7f272ae722a74f3d969dcf599bc4ef093bc392038748a490f1724a515d";
1584+ extension = "tar.bz2";
1585+ };
1586+ });
1587+ };
1588+ };
1589+}
1590+```
1591+
1592+### How to use Intel’s MKL with numpy and scipy? {#how-to-use-intels-mkl-with-numpy-and-scipy}
1593+
1594+MKL can be configured using an overlay. See the section "[Using overlays to
1595+configure alternatives](#sec-overlays-alternatives-blas-lapack)".
1596+
1597+### What inputs do `setup_requires`, `install_requires` and `tests_require` map to? {#what-inputs-do-setup_requires-install_requires-and-tests_require-map-to}
1598+
1599+In a `setup.py` or `setup.cfg` it is common to declare dependencies:
1600+
1601+* `setup_requires` corresponds to `nativeBuildInputs`
1602+* `install_requires` corresponds to `propagatedBuildInputs`
1603+* `tests_require` corresponds to `checkInputs`
1604+
1605+## Contributing {#contributing}
1606+
1607+### Contributing guidelines {#contributing-guidelines}
1608+
1609+The following rules are desired to be respected:
1610+
1611+* Python libraries are called from `python-packages.nix` and packaged with
1612+ `buildPythonPackage`. The expression of a library should be in
1613+ `pkgs/development/python-modules/<name>/default.nix`.
1614+* Python applications live outside of `python-packages.nix` and are packaged
1615+ with `buildPythonApplication`.
1616+* Make sure libraries build for all Python interpreters.
1617+* By default we enable tests. Make sure the tests are found and, in the case of
1618+ libraries, are passing for all interpreters. If certain tests fail they can be
1619+ disabled individually. Try to avoid disabling the tests altogether. In any
1620+ case, when you disable tests, leave a comment explaining why.
1621+* Commit names of Python libraries should reflect that they are Python
1622+ libraries, so write for example `pythonPackages.numpy: 1.11 -> 1.12`.
1623+* Attribute names in `python-packages.nix` as well as `pname`s should match the
1624+ library's name on PyPI, but be normalized according to [PEP
1625+ 0503](https://www.python.org/dev/peps/pep-0503/#normalized-names). This means
1626+ that characters should be converted to lowercase and `.` and `_` should be
1627+ replaced by a single `-` (foo-bar-baz instead of Foo__Bar.baz).
1628+ If necessary, `pname` has to be given a different value within `fetchPypi`.
1629+* Attribute names in `python-packages.nix` should be sorted alphanumerically to
1630+ avoid merge conflicts and ease locating attributes.
1631+
1632+## Package set maintenance
1633+
1634+The whole Python package set has a lot of packages that do not see regular
1635+updates, because they either are a very fragile component in the Python
1636+ecosystem, like for example the `hypothesis` package, or packages that have
1637+no maintainer, so maintenance falls back to the package set maintainers.
1638+
1639+### Updating packages in bulk
1640+
1641+There is a tool to update alot of python libraries in bulk, it exists at
1642+`maintainers/scripts/update-python-libraries` with this repository.
1643+
1644+It can quickly update minor or major versions for all packages selected
1645+and create update commits, and supports the `fetchPypi`, `fetchurl` and
1646+`fetchFromGitHub` fetchers. When updating lots of packages that are
1647+hosted on GitHub, exporting a `GITHUB_API_TOKEN` is highly recommended.
1648+
1649+Updating packages in bulk leads to lots of breakages, which is why a
1650+stabilization period on the `python-unstable` branch is required.
1651+
1652+Once the branch is sufficiently stable it should normally be merged
1653+into the `staging` branch.
1654+
1655+An exemplary call to update all python libraries between minor versions
1656+would be:
1657+
1658+```ShellSession
1659+$ maintainers/scripts/update-python-libraries --target minor --commit --use-pkgs-prefix pkgs/development/python-modules/**/default.nix
1660+```
1661+
1662+## CPython Update Schedule
1663+
1664+With [PEP 602](https://www.python.org/dev/peps/pep-0602/), CPython now
1665+follows a yearly release cadence. In nixpkgs, all supported interpreters
1666+are made available, but only the most recent two
1667+interpreters package sets are built; this is a compromise between being
1668+the latest interpreter, and what the majority of the Python packages support.
1669+
1670+New CPython interpreters are released in October. Generally, it takes some
1671+time for the majority of active Python projects to support the latest stable
1672+interpreter. To help ease the migration for Nixpkgs users
1673+between Python interpreters the schedule below will be used:
1674+
1675+| When | Event |
1676+| --- | --- |
1677+| After YY.11 Release | Bump CPython package set window. The latest and previous latest stable should now be built. |
1678+| After YY.05 Release | Bump default CPython interpreter to latest stable. |
1679+
1680+In practice, this means that the Python community will have had a stable interpreter
1681+for ~2 months before attempting to update the package set. And this will
1682+allow for ~7 months for Python applications to support the latest interpreter.
doc/languages-frameworks/qt.section.mdnew file+160
@@ -0,0 +1,160 @@
1+# Qt {#sec-language-qt}
2+
3+Writing Nix expressions for Qt libraries and applications is largely similar as for other C++ software.
4+This section assumes some knowledge of the latter.
5+There are two problems that the Nixpkgs Qt infrastructure addresses,
6+which are not shared by other C++ software:
7+
8+1. There are usually multiple supported versions of Qt in Nixpkgs.
9+ All of a package's dependencies must be built with the same version of Qt.
10+ This is similar to the version constraints imposed on interpreted languages like Python.
11+2. Qt makes extensive use of runtime dependency detection.
12+ Runtime dependencies are made into build dependencies through wrappers.
13+
14+## Nix expression for a Qt package (default.nix) {#qt-default-nix}
15+
16+```{=docbook}
17+<programlisting>
18+{ stdenv, lib, qtbase, wrapQtAppsHook }: <co xml:id='qt-default-nix-co-1' />
19+
20+stdenv.mkDerivation {
21+ pname = "myapp";
22+ version = "1.0";
23+
24+ buildInputs = [ qtbase ];
25+ nativeBuildInputs = [ wrapQtAppsHook ]; <co xml:id='qt-default-nix-co-2' />
26+}
27+</programlisting>
28+
29+ <calloutlist>
30+ <callout arearefs='qt-default-nix-co-1'>
31+ <para>
32+ Import Qt modules directly, that is: <literal>qtbase</literal>, <literal>qtdeclarative</literal>, etc.
33+ <emphasis>Do not</emphasis> import Qt package sets such as <literal>qt5</literal>
34+ because the Qt versions of dependencies may not be coherent, causing build and runtime failures.
35+ </para>
36+ </callout>
37+ <callout arearefs='qt-default-nix-co-2'>
38+ <para>
39+ All Qt packages must include <literal>wrapQtAppsHook</literal> in
40+ <literal>nativeBuildInputs</literal>, or you must explicitly set
41+ <literal>dontWrapQtApps</literal>.
42+ </para>
43+ </callout>
44+ </calloutlist>
45+```
46+
47+## Locating runtime dependencies {#qt-runtime-dependencies}
48+
49+Qt applications must be wrapped to find runtime dependencies.
50+Include `wrapQtAppsHook` in `nativeBuildInputs`:
51+
52+```nix
53+{ stdenv, wrapQtAppsHook }:
54+
55+stdenv.mkDerivation {
56+ # ...
57+ nativeBuildInputs = [ wrapQtAppsHook ];
58+}
59+```
60+
61+Add entries to `qtWrapperArgs` are to modify the wrappers created by
62+`wrapQtAppsHook`:
63+
64+```nix
65+{ stdenv, wrapQtAppsHook }:
66+
67+stdenv.mkDerivation {
68+ # ...
69+ nativeBuildInputs = [ wrapQtAppsHook ];
70+ qtWrapperArgs = [ ''--prefix PATH : /path/to/bin'' ];
71+}
72+```
73+
74+The entries are passed as arguments to [wrapProgram](#fun-wrapProgram).
75+
76+Set `dontWrapQtApps` to stop applications from being wrapped automatically.
77+Wrap programs manually with `wrapQtApp`, using the syntax of
78+[wrapProgram](#fun-wrapProgram):
79+
80+```nix
81+{ stdenv, lib, wrapQtAppsHook }:
82+
83+stdenv.mkDerivation {
84+ # ...
85+ nativeBuildInputs = [ wrapQtAppsHook ];
86+ dontWrapQtApps = true;
87+ preFixup = ''
88+ wrapQtApp "$out/bin/myapp" --prefix PATH : /path/to/bin
89+ '';
90+}
91+```
92+
93+::: {.note}
94+`wrapQtAppsHook` ignores files that are non-ELF executables.
95+This means that scripts won't be automatically wrapped so you'll need to manually wrap them as previously mentioned.
96+An example of when you'd always need to do this is with Python applications that use PyQt.
97+:::
98+
99+## Adding a library to Nixpkgs {#adding-a-library-to-nixpkgs}
100+
101+Add Qt libraries to `qt5-packages.nix` to make them available for every
102+supported Qt version.
103+
104+### Example adding a Qt library {#qt-library-all-packages-nix}
105+
106+The following represents the contents of `qt5-packages.nix`.
107+
108+```nix
109+{
110+ # ...
111+
112+ mylib = callPackage ../path/to/mylib {};
113+
114+ # ...
115+}
116+```
117+
118+Libraries are built with every available version of Qt.
119+Use the `meta.broken` attribute to disable the package for unsupported Qt versions:
120+
121+```nix
122+{ stdenv, lib, qtbase }:
123+
124+stdenv.mkDerivation {
125+ # ...
126+ # Disable this library with Qt < 5.9.0
127+ meta.broken = lib.versionOlder qtbase.version "5.9.0";
128+}
129+```
130+
131+## Adding an application to Nixpkgs {#adding-an-application-to-nixpkgs}
132+
133+Add Qt applications to `qt5-packages.nix`. Add an alias to `all-packages.nix`
134+to select the Qt 5 version used for the application.
135+
136+### Example adding a Qt application {#qt-application-all-packages-nix}
137+
138+The following represents the contents of `qt5-packages.nix`.
139+
140+```nix
141+{
142+ # ...
143+
144+ myapp = callPackage ../path/to/myapp {};
145+
146+ # ...
147+}
148+```
149+
150+The following represents the contents of `all-packages.nix`.
151+
152+```nix
153+{
154+ # ...
155+
156+ myapp = libsForQt5.myapp;
157+
158+ # ...
159+}
160+```
doc/languages-frameworks/r.section.mdnew file+127
@@ -0,0 +1,127 @@
1+# R {#r}
2+
3+## Installation {#installation}
4+
5+Define an environment for R that contains all the libraries that you'd like to
6+use by adding the following snippet to your $HOME/.config/nixpkgs/config.nix file:
7+
8+```nix
9+{
10+ packageOverrides = super: let self = super.pkgs; in
11+ {
12+
13+ rEnv = super.rWrapper.override {
14+ packages = with self.rPackages; [
15+ devtools
16+ ggplot2
17+ reshape2
18+ yaml
19+ optparse
20+ ];
21+ };
22+ };
23+}
24+```
25+
26+Then you can use `nix-env -f "<nixpkgs>" -iA rEnv` to install it into your user
27+profile. The set of available libraries can be discovered by running the
28+command `nix-env -f "<nixpkgs>" -qaP -A rPackages`. The first column from that
29+output is the name that has to be passed to rWrapper in the code snipped above.
30+
31+However, if you'd like to add a file to your project source to make the
32+environment available for other contributors, you can create a `default.nix`
33+file like so:
34+
35+```nix
36+with import <nixpkgs> {};
37+{
38+ myProject = stdenv.mkDerivation {
39+ name = "myProject";
40+ version = "1";
41+ src = if lib.inNixShell then null else nix;
42+
43+ buildInputs = with rPackages; [
44+ R
45+ ggplot2
46+ knitr
47+ ];
48+ };
49+}
50+```
51+and then run `nix-shell .` to be dropped into a shell with those packages
52+available.
53+
54+## RStudio {#rstudio}
55+
56+RStudio uses a standard set of packages and ignores any custom R
57+environments or installed packages you may have. To create a custom
58+environment, see `rstudioWrapper`, which functions similarly to
59+`rWrapper`:
60+
61+```nix
62+{
63+ packageOverrides = super: let self = super.pkgs; in
64+ {
65+
66+ rstudioEnv = super.rstudioWrapper.override {
67+ packages = with self.rPackages; [
68+ dplyr
69+ ggplot2
70+ reshape2
71+ ];
72+ };
73+ };
74+}
75+```
76+
77+Then like above, `nix-env -f "<nixpkgs>" -iA rstudioEnv` will install
78+this into your user profile.
79+
80+Alternatively, you can create a self-contained `shell.nix` without the need to
81+modify any configuration files:
82+
83+```nix
84+{ pkgs ? import <nixpkgs> {}
85+}:
86+
87+pkgs.rstudioWrapper.override {
88+ packages = with pkgs.rPackages; [ dplyr ggplot2 reshape2 ];
89+}
90+
91+```
92+
93+Executing `nix-shell` will then drop you into an environment equivalent to the
94+one above. If you need additional packages just add them to the list and
95+re-enter the shell.
96+
97+## Updating the package set {#updating-the-package-set}
98+
99+There is a script and associated environment for regenerating the package
100+sets and synchronising the rPackages tree to the current CRAN and matching
101+BIOC release. These scripts are found in the `pkgs/development/r-modules`
102+directory and executed as follows:
103+
104+```bash
105+nix-shell generate-shell.nix
106+
107+Rscript generate-r-packages.R cran > cran-packages.nix.new
108+mv cran-packages.nix.new cran-packages.nix
109+
110+Rscript generate-r-packages.R bioc > bioc-packages.nix.new
111+mv bioc-packages.nix.new bioc-packages.nix
112+
113+Rscript generate-r-packages.R bioc-annotation > bioc-annotation-packages.nix.new
114+mv bioc-annotation-packages.nix.new bioc-annotation-packages.nix
115+
116+Rscript generate-r-packages.R bioc-experiment > bioc-experiment-packages.nix.new
117+mv bioc-experiment-packages.nix.new bioc-experiment-packages.nix
118+```
119+
120+`generate-r-packages.R <repo>` reads `<repo>-packages.nix`, therefore
121+the renaming.
122+
123+Some packages require overrides to specify external dependencies or other
124+patches and special requirements. These overrides are specified in the
125+`pkgs/development/r-modules/default.nix` file. As the `*-packages.nix`
126+contents are automatically generated it should not be edited and broken
127+builds should be addressed using overrides.
doc/languages-frameworks/ruby.section.mdnew file+283
@@ -0,0 +1,283 @@
1+# Ruby {#sec-language-ruby}
2+
3+## Using Ruby {#using-ruby}
4+
5+Several versions of Ruby interpreters are available on Nix, as well as over 250 gems and many applications written in Ruby. The attribute `ruby` refers to the default Ruby interpreter, which is currently MRI 2.6. It's also possible to refer to specific versions, e.g. `ruby_2_y`, `jruby`, or `mruby`.
6+
7+In the Nixpkgs tree, Ruby packages can be found throughout, depending on what they do, and are called from the main package set. Ruby gems, however are separate sets, and there's one default set for each interpreter (currently MRI only).
8+
9+There are two main approaches for using Ruby with gems. One is to use a specifically locked `Gemfile` for an application that has very strict dependencies. The other is to depend on the common gems, which we'll explain further down, and rely on them being updated regularly.
10+
11+The interpreters have common attributes, namely `gems`, and `withPackages`. So you can refer to `ruby.gems.nokogiri`, or `ruby_2_7.gems.nokogiri` to get the Nokogiri gem already compiled and ready to use.
12+
13+Since not all gems have executables like `nokogiri`, it's usually more convenient to use the `withPackages` function like this: `ruby.withPackages (p: with p; [ nokogiri ])`. This will also make sure that the Ruby in your environment will be able to find the gem and it can be used in your Ruby code (for example via `ruby` or `irb` executables) via `require "nokogiri"` as usual.
14+
15+### Temporary Ruby environment with `nix-shell` {#temporary-ruby-environment-with-nix-shell}
16+
17+Rather than having a single Ruby environment shared by all Ruby development projects on a system, Nix allows you to create separate environments per project. `nix-shell` gives you the possibility to temporarily load another environment akin to a combined `chruby` or `rvm` and `bundle exec`.
18+
19+There are two methods for loading a shell with Ruby packages. The first and recommended method is to create an environment with `ruby.withPackages` and load that.
20+
21+```ShellSession
22+$ nix-shell -p "ruby.withPackages (ps: with ps; [ nokogiri pry ])"
23+```
24+
25+The other method, which is not recommended, is to create an environment and list all the packages directly.
26+
27+```ShellSession
28+$ nix-shell -p ruby.gems.nokogiri ruby.gems.pry
29+```
30+
31+Again, it's possible to launch the interpreter from the shell. The Ruby interpreter has the attribute `gems` which contains all Ruby gems for that specific interpreter.
32+
33+#### Load Ruby environment from `.nix` expression {#load-ruby-environment-from-.nix-expression}
34+
35+As explained in the Nix manual, `nix-shell` can also load an expression from a `.nix` file. Say we want to have Ruby 2.6, `nokogori`, and `pry`. Consider a `shell.nix` file with:
36+
37+```nix
38+with import <nixpkgs> {};
39+ruby.withPackages (ps: with ps; [ nokogiri pry ])
40+```
41+
42+What's happening here?
43+
44+1. We begin with importing the Nix Packages collections. `import <nixpkgs>` imports the `<nixpkgs>` function, `{}` calls it and the `with` statement brings all attributes of `nixpkgs` in the local scope. These attributes form the main package set.
45+2. Then we create a Ruby environment with the `withPackages` function.
46+3. The `withPackages` function expects us to provide a function as an argument that takes the set of all ruby gems and returns a list of packages to include in the environment. Here, we select the packages `nokogiri` and `pry` from the package set.
47+
48+#### Execute command with `--run` {#execute-command-with---run}
49+
50+A convenient flag for `nix-shell` is `--run`. It executes a command in the `nix-shell`. We can e.g. directly open a `pry` REPL:
51+
52+```ShellSession
53+$ nix-shell -p "ruby.withPackages (ps: with ps; [ nokogiri pry ])" --run "pry"
54+```
55+
56+Or immediately require `nokogiri` in pry:
57+
58+```ShellSession
59+$ nix-shell -p "ruby.withPackages (ps: with ps; [ nokogiri pry ])" --run "pry -rnokogiri"
60+```
61+
62+Or run a script using this environment:
63+
64+```ShellSession
65+$ nix-shell -p "ruby.withPackages (ps: with ps; [ nokogiri pry ])" --run "ruby example.rb"
66+```
67+
68+#### Using `nix-shell` as shebang {#using-nix-shell-as-shebang}
69+
70+In fact, for the last case, there is a more convenient method. You can add a [shebang](<https://en.wikipedia.org/wiki/Shebang_(Unix)>) to your script specifying which dependencies `nix-shell` needs. With the following shebang, you can just execute `./example.rb`, and it will run with all dependencies.
71+
72+```ruby
73+#! /usr/bin/env nix-shell
74+#! nix-shell -i ruby -p "ruby.withPackages (ps: with ps; [ nokogiri rest-client ])"
75+
76+require 'nokogiri'
77+require 'rest-client'
78+
79+body = RestClient.get('http://example.com').body
80+puts Nokogiri::HTML(body).at('h1').text
81+```
82+
83+## Developing with Ruby {#developing-with-ruby}
84+
85+### Using an existing Gemfile {#using-an-existing-gemfile}
86+
87+In most cases, you'll already have a `Gemfile.lock` listing all your dependencies. This can be used to generate a `gemset.nix` which is used to fetch the gems and combine them into a single environment. The reason why you need to have a separate file for this, is that Nix requires you to have a checksum for each input to your build. Since the `Gemfile.lock` that `bundler` generates doesn't provide us with checksums, we have to first download each gem, calculate its SHA256, and store it in this separate file.
88+
89+So the steps from having just a `Gemfile` to a `gemset.nix` are:
90+
91+```ShellSession
92+$ bundle lock
93+$ bundix
94+```
95+
96+If you already have a `Gemfile.lock`, you can simply run `bundix` and it will work the same.
97+
98+To update the gems in your `Gemfile.lock`, you may use the `bundix -l` flag, which will create a new `Gemfile.lock` in case the `Gemfile` has a more recent time of modification.
99+
100+Once the `gemset.nix` is generated, it can be used in a `bundlerEnv` derivation. Here is an example you could use for your `shell.nix`:
101+
102+```nix
103+# ...
104+let
105+ gems = bundlerEnv {
106+ name = "gems-for-some-project";
107+ gemdir = ./.;
108+ };
109+in mkShell { packages = [ gems gems.wrappedRuby ]; }
110+```
111+
112+With this file in your directory, you can run `nix-shell` to build and use the gems. The important parts here are `bundlerEnv` and `wrappedRuby`.
113+
114+The `bundlerEnv` is a wrapper over all the gems in your gemset. This means that all the `/lib` and `/bin` directories will be available, and the executables of all gems (even of indirect dependencies) will end up in your `$PATH`. The `wrappedRuby` provides you with all executables that come with Ruby itself, but wrapped so they can easily find the gems in your gemset.
115+
116+One common issue that you might have is that you have Ruby 2.6, but also `bundler` in your gemset. That leads to a conflict for `/bin/bundle` and `/bin/bundler`. You can resolve this by wrapping either your Ruby or your gems in a `lowPrio` call. So in order to give the `bundler` from your gemset priority, it would be used like this:
117+
118+```nix
119+# ...
120+mkShell { buildInputs = [ gems (lowPrio gems.wrappedRuby) ]; }
121+```
122+
123+### Gem-specific configurations and workarounds {#gem-specific-configurations-and-workarounds}
124+
125+In some cases, especially if the gem has native extensions, you might need to modify the way the gem is built.
126+
127+This is done via a common configuration file that includes all of the workarounds for each gem.
128+
129+This file lives at `/pkgs/development/ruby-modules/gem-config/default.nix`, since it already contains a lot of entries, it should be pretty easy to add the modifications you need for your needs.
130+
131+In the meanwhile, or if the modification is for a private gem, you can also add the configuration to only your own environment.
132+
133+Two places that allow this modification are the `ruby` derivation, or `bundlerEnv`.
134+
135+Here's the `ruby` one:
136+
137+```nix
138+{ pg_version ? "10", pkgs ? import <nixpkgs> { } }:
139+let
140+ myRuby = pkgs.ruby.override {
141+ defaultGemConfig = pkgs.defaultGemConfig // {
142+ pg = attrs: {
143+ buildFlags =
144+ [ "--with-pg-config=${pkgs."postgresql_${pg_version}"}/bin/pg_config" ];
145+ };
146+ };
147+ };
148+in myRuby.withPackages (ps: with ps; [ pg ])
149+```
150+
151+And an example with `bundlerEnv`:
152+
153+```nix
154+{ pg_version ? "10", pkgs ? import <nixpkgs> { } }:
155+let
156+ gems = pkgs.bundlerEnv {
157+ name = "gems-for-some-project";
158+ gemdir = ./.;
159+ gemConfig = pkgs.defaultGemConfig // {
160+ pg = attrs: {
161+ buildFlags =
162+ [ "--with-pg-config=${pkgs."postgresql_${pg_version}"}/bin/pg_config" ];
163+ };
164+ };
165+ };
166+in mkShell { buildInputs = [ gems gems.wrappedRuby ]; }
167+```
168+
169+And finally via overlays:
170+
171+```nix
172+{ pg_version ? "10" }:
173+let
174+ pkgs = import <nixpkgs> {
175+ overlays = [
176+ (self: super: {
177+ defaultGemConfig = super.defaultGemConfig // {
178+ pg = attrs: {
179+ buildFlags = [
180+ "--with-pg-config=${
181+ pkgs."postgresql_${pg_version}"
182+ }/bin/pg_config"
183+ ];
184+ };
185+ };
186+ })
187+ ];
188+ };
189+in pkgs.ruby.withPackages (ps: with ps; [ pg ])
190+```
191+
192+Then we can get whichever postgresql version we desire and the `pg` gem will always reference it correctly:
193+
194+```ShellSession
195+$ nix-shell --argstr pg_version 9_4 --run 'ruby -rpg -e "puts PG.library_version"'
196+90421
197+
198+$ nix-shell --run 'ruby -rpg -e "puts PG.library_version"'
199+100007
200+```
201+
202+Of course for this use-case one could also use overlays since the configuration for `pg` depends on the `postgresql` alias, but for demonstration purposes this has to suffice.
203+
204+### Platform-specific gems
205+
206+Right now, bundix has some issues with pre-built, platform-specific gems: [bundix PR #68](https://github.com/nix-community/bundix/pull/68).
207+Until this is solved, you can tell bundler to not use platform-specific gems and instead build them from source each time:
208+- globally (will be set in `~/.config/.bundle/config`):
209+```shell
210+$ bundle config set force_ruby_platform true
211+```
212+- locally (will be set in `<project-root>/.bundle/config`):
213+```shell
214+$ bundle config set --local force_ruby_platform true
215+```
216+
217+### Adding a gem to the default gemset {#adding-a-gem-to-the-default-gemset}
218+
219+Now that you know how to get a working Ruby environment with Nix, it's time to go forward and start actually developing with Ruby. We will first have a look at how Ruby gems are packaged on Nix. Then, we will look at how you can use development mode with your code.
220+
221+All gems in the standard set are automatically generated from a single `Gemfile`. The dependency resolution is done with `bundler` and makes it more likely that all gems are compatible to each other.
222+
223+In order to add a new gem to nixpkgs, you can put it into the `/pkgs/development/ruby-modules/with-packages/Gemfile` and run `./maintainers/scripts/update-ruby-packages`.
224+
225+To test that it works, you can then try using the gem with:
226+
227+```shell
228+NIX_PATH=nixpkgs=$PWD nix-shell -p "ruby.withPackages (ps: with ps; [ name-of-your-gem ])"
229+```
230+
231+### Packaging applications {#packaging-applications}
232+
233+A common task is to add a ruby executable to nixpkgs, popular examples would be `chef`, `jekyll`, or `sass`. A good way to do that is to use the `bundlerApp` function, that allows you to make a package that only exposes the listed executables, otherwise the package may cause conflicts through common paths like `bin/rake` or `bin/bundler` that aren't meant to be used.
234+
235+The absolute easiest way to do that is to write a `Gemfile` along these lines:
236+
237+```ruby
238+source 'https://rubygems.org' do
239+ gem 'mdl'
240+end
241+```
242+
243+If you want to package a specific version, you can use the standard Gemfile syntax for that, e.g. `gem 'mdl', '0.5.0'`, but if you want the latest stable version anyway, it's easier to update by simply running the `bundle lock` and `bundix` steps again.
244+
245+Now you can also make a `default.nix` that looks like this:
246+
247+```nix
248+{ bundlerApp }:
249+
250+bundlerApp {
251+ pname = "mdl";
252+ gemdir = ./.;
253+ exes = [ "mdl" ];
254+}
255+```
256+
257+All that's left to do is to generate the corresponding `Gemfile.lock` and `gemset.nix` as described above in the `Using an existing Gemfile` section.
258+
259+#### Packaging executables that require wrapping {#packaging-executables-that-require-wrapping}
260+
261+Sometimes your app will depend on other executables at runtime, and tries to find it through the `PATH` environment variable.
262+
263+In this case, you can provide a `postBuild` hook to `bundlerApp` that wraps the gem in another script that prefixes the `PATH`.
264+
265+Of course you could also make a custom `gemConfig` if you know exactly how to patch it, but it's usually much easier to maintain with a simple wrapper so the patch doesn't have to be adjusted for each version.
266+
267+Here's another example:
268+
269+```nix
270+{ lib, bundlerApp, makeWrapper, git, gnutar, gzip }:
271+
272+bundlerApp {
273+ pname = "r10k";
274+ gemdir = ./.;
275+ exes = [ "r10k" ];
276+
277+ buildInputs = [ makeWrapper ];
278+
279+ postBuild = ''
280+ wrapProgram $out/bin/r10k --prefix PATH : ${lib.makeBinPath [ git gnutar gzip ]}
281+ '';
282+}
283+```
doc/languages-frameworks/rust.section.mdnew file+1008
@@ -0,0 +1,1008 @@
1+# Rust {#rust}
2+
3+To install the rust compiler and cargo put
4+
5+```nix
6+environment.systemPackages = [
7+ rustc
8+ cargo
9+];
10+```
11+
12+into your `configuration.nix` or bring them into scope with `nix-shell -p rustc cargo`.
13+
14+For other versions such as daily builds (beta and nightly),
15+use either `rustup` from nixpkgs (which will manage the rust installation in your home directory),
16+or use a community maintained [Rust overlay](#using-community-rust-overlays).
17+
18+## Compiling Rust applications with Cargo {#compiling-rust-applications-with-cargo}
19+
20+Rust applications are packaged by using the `buildRustPackage` helper from `rustPlatform`:
21+
22+```nix
23+{ lib, fetchFromGitHub, rustPlatform }:
24+
25+rustPlatform.buildRustPackage rec {
26+ pname = "ripgrep";
27+ version = "12.1.1";
28+
29+ src = fetchFromGitHub {
30+ owner = "BurntSushi";
31+ repo = pname;
32+ rev = version;
33+ sha256 = "1hqps7l5qrjh9f914r5i6kmcz6f1yb951nv4lby0cjnp5l253kps";
34+ };
35+
36+ cargoSha256 = "03wf9r2csi6jpa7v5sw5lpxkrk4wfzwmzx7k3991q3bdjzcwnnwp";
37+
38+ meta = with lib; {
39+ description = "A fast line-oriented regex search tool, similar to ag and ack";
40+ homepage = "https://github.com/BurntSushi/ripgrep";
41+ license = licenses.unlicense;
42+ maintainers = [ maintainers.tailhook ];
43+ };
44+}
45+```
46+
47+`buildRustPackage` requires either the `cargoSha256` or the
48+`cargoHash` attribute which is computed over all crate sources of this
49+package. `cargoHash256` is used for traditional Nix SHA-256 hashes,
50+such as the one in the example above. `cargoHash` should instead be
51+used for [SRI](https://www.w3.org/TR/SRI/) hashes. For example:
52+
53+```nix
54+ cargoHash = "sha256-l1vL2ZdtDRxSGvP0X/l3nMw8+6WF67KPutJEzUROjg8=";
55+```
56+
57+Both types of hashes are permitted when contributing to nixpkgs. The
58+Cargo hash is obtained by inserting a fake checksum into the
59+expression and building the package once. The correct checksum can
60+then be taken from the failed build. A fake hash can be used for
61+`cargoSha256` as follows:
62+
63+```nix
64+ cargoSha256 = lib.fakeSha256;
65+```
66+
67+For `cargoHash` you can use:
68+
69+```nix
70+ cargoHash = lib.fakeHash;
71+```
72+
73+Per the instructions in the [Cargo Book](https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html)
74+best practices guide, Rust applications should always commit the `Cargo.lock`
75+file in git to ensure a reproducible build. However, a few packages do not, and
76+Nix depends on this file, so if it is missing you can use `cargoPatches` to
77+apply it in the `patchPhase`. Consider sending a PR upstream with a note to the
78+maintainer describing why it's important to include in the application.
79+
80+The fetcher will verify that the `Cargo.lock` file is in sync with the `src`
81+attribute, and fail the build if not. It will also will compress the vendor
82+directory into a tar.gz archive.
83+
84+The tarball with vendored dependencies contains a directory with the
85+package's `name`, which is normally composed of `pname` and
86+`version`. This means that the vendored dependencies hash
87+(`cargoSha256`/`cargoHash`) is dependent on the package name and
88+version. The `cargoDepsName` attribute can be used to use another name
89+for the directory of vendored dependencies. For example, the hash can
90+be made invariant to the version by setting `cargoDepsName` to
91+`pname`:
92+
93+```nix
94+rustPlatform.buildRustPackage rec {
95+ pname = "broot";
96+ version = "1.2.0";
97+
98+ src = fetchCrate {
99+ inherit pname version;
100+ sha256 = "1mqaynrqaas82f5957lx31x80v74zwmwmjxxlbywajb61vh00d38";
101+ };
102+
103+ cargoHash = "sha256-JmBZcDVYJaK1cK05cxx5BrnGWp4t8ca6FLUbvIot67s=";
104+ cargoDepsName = pname;
105+
106+ # ...
107+}
108+```
109+
110+### Importing a `Cargo.lock` file {#importing-a-cargo.lock-file}
111+
112+Using `cargoSha256` or `cargoHash` is tedious when using
113+`buildRustPackage` within a project, since it requires that the hash
114+is updated after every change to `Cargo.lock`. Therefore,
115+`buildRustPackage` also supports vendoring dependencies directly from
116+a `Cargo.lock` file using the `cargoLock` argument. For example:
117+
118+```nix
119+rustPlatform.buildRustPackage {
120+ pname = "myproject";
121+ version = "1.0.0";
122+
123+ cargoLock = {
124+ lockFile = ./Cargo.lock;
125+ };
126+
127+ # ...
128+}
129+```
130+
131+This will retrieve the dependencies using fixed-output derivations from
132+the specified lockfile.
133+
134+One caveat is that `Cargo.lock` cannot be patched in the `patchPhase`
135+because it runs after the dependencies have already been fetched. If
136+you need to patch or generate the lockfile you can alternatively set
137+`cargoLock.lockFileContents` to a string of its contents:
138+
139+```nix
140+rustPlatform.buildRustPackage {
141+ pname = "myproject";
142+ version = "1.0.0";
143+
144+ cargoLock = let
145+ fixupLockFile = path: f (builtins.readFile path);
146+ in {
147+ lockFileContents = fixupLockFile ./Cargo.lock;
148+ };
149+
150+ # ...
151+}
152+```
153+
154+Note that setting `cargoLock.lockFile` or `cargoLock.lockFileContents`
155+doesn't add a `Cargo.lock` to your `src`, and a `Cargo.lock` is still
156+required to build a rust package. A simple fix is to use:
157+
158+```nix
159+postPatch = ''
160+ cp ${./Cargo.lock} Cargo.lock
161+'';
162+```
163+
164+The output hash of each dependency that uses a git source must be
165+specified in the `outputHashes` attribute. For example:
166+
167+```nix
168+rustPlatform.buildRustPackage rec {
169+ pname = "myproject";
170+ version = "1.0.0";
171+
172+ cargoLock = {
173+ lockFile = ./Cargo.lock;
174+ outputHashes = {
175+ "finalfusion-0.14.0" = "17f4bsdzpcshwh74w5z119xjy2if6l2wgyjy56v621skr2r8y904";
176+ };
177+ };
178+
179+ # ...
180+}
181+```
182+
183+If you do not specify an output hash for a git dependency, building
184+the package will fail and inform you of which crate needs to be
185+added. To find the correct hash, you can first use `lib.fakeSha256` or
186+`lib.fakeHash` as a stub hash. Building the package (and thus the
187+vendored dependencies) will then inform you of the correct hash.
188+
189+### Cargo features {#cargo-features}
190+
191+You can disable default features using `buildNoDefaultFeatures`, and
192+extra features can be added with `buildFeatures`.
193+
194+If you want to use different features for check phase, you can use
195+`checkNoDefaultFeatures` and `checkFeatures`. They are only passed to
196+`cargo test` and not `cargo build`. If left unset, they default to
197+`buildNoDefaultFeatures` and `buildFeatures`.
198+
199+For example:
200+
201+```nix
202+rustPlatform.buildRustPackage rec {
203+ pname = "myproject";
204+ version = "1.0.0";
205+
206+ buildNoDefaultFeatures = true;
207+ buildFeatures = [ "color" "net" ];
208+
209+ # disable network features in tests
210+ checkFeatures = [ "color" ];
211+
212+ # ...
213+}
214+```
215+
216+### Cross compilation {#cross-compilation}
217+
218+By default, Rust packages are compiled for the host platform, just like any
219+other package is. The `--target` passed to rust tools is computed from this.
220+By default, it takes the `stdenv.hostPlatform.config` and replaces components
221+where they are known to differ. But there are ways to customize the argument:
222+
223+ - To choose a different target by name, define
224+ `stdenv.hostPlatform.rustc.config` as that name (a string), and that
225+ name will be used instead.
226+
227+ For example:
228+
229+ ```nix
230+ import <nixpkgs> {
231+ crossSystem = (import <nixpkgs/lib>).systems.examples.armhf-embedded // {
232+ rustc.config = "thumbv7em-none-eabi";
233+ };
234+ }
235+ ```
236+
237+ will result in:
238+
239+ ```shell
240+ --target thumbv7em-none-eabi
241+ ```
242+
243+ - To pass a completely custom target, define
244+ `stdenv.hostPlatform.rustc.config` with its name, and
245+ `stdenv.hostPlatform.rustc.platform` with the value. The value will be
246+ serialized to JSON in a file called
247+ `${stdenv.hostPlatform.rustc.config}.json`, and the path of that file
248+ will be used instead.
249+
250+ For example:
251+
252+ ```nix
253+ import <nixpkgs> {
254+ crossSystem = (import <nixpkgs/lib>).systems.examples.armhf-embedded // {
255+ rustc.config = "thumb-crazy";
256+ rustc.platform = { foo = ""; bar = ""; };
257+ };
258+ }
259+ ```
260+
261+ will result in:
262+
263+ ```shell
264+ --target /nix/store/asdfasdfsadf-thumb-crazy.json # contains {"foo":"","bar":""}
265+ ```
266+
267+Note that currently custom targets aren't compiled with `std`, so `cargo test`
268+will fail. This can be ignored by adding `doCheck = false;` to your derivation.
269+
270+### Running package tests {#running-package-tests}
271+
272+When using `buildRustPackage`, the `checkPhase` is enabled by default and runs
273+`cargo test` on the package to build. To make sure that we don't compile the
274+sources twice and to actually test the artifacts that will be used at runtime,
275+the tests will be ran in the `release` mode by default.
276+
277+However, in some cases the test-suite of a package doesn't work properly in the
278+`release` mode. For these situations, the mode for `checkPhase` can be changed like
279+so:
280+
281+```nix
282+rustPlatform.buildRustPackage {
283+ /* ... */
284+ checkType = "debug";
285+}
286+```
287+
288+Please note that the code will be compiled twice here: once in `release` mode
289+for the `buildPhase`, and again in `debug` mode for the `checkPhase`.
290+
291+Test flags, e.g., `--package foo`, can be passed to `cargo test` via the
292+`cargoTestFlags` attribute.
293+
294+Another attribute, called `checkFlags`, is used to pass arguments to the test
295+binary itself, as stated
296+[here](https://doc.rust-lang.org/cargo/commands/cargo-test.html).
297+
298+#### Tests relying on the structure of the `target/` directory {#tests-relying-on-the-structure-of-the-target-directory}
299+
300+Some tests may rely on the structure of the `target/` directory. Those tests
301+are likely to fail because we use `cargo --target` during the build. This means that
302+the artifacts
303+[are stored in `target/<architecture>/release/`](https://doc.rust-lang.org/cargo/guide/build-cache.html),
304+rather than in `target/release/`.
305+
306+This can only be worked around by patching the affected tests accordingly.
307+
308+#### Disabling package-tests {#disabling-package-tests}
309+
310+In some instances, it may be necessary to disable testing altogether (with `doCheck = false;`):
311+
312+* If no tests exist -- the `checkPhase` should be explicitly disabled to skip
313+ unnecessary build steps to speed up the build.
314+* If tests are highly impure (e.g. due to network usage).
315+
316+There will obviously be some corner-cases not listed above where it's sensible to disable tests.
317+The above are just guidelines, and exceptions may be granted on a case-by-case basis.
318+
319+However, please check if it's possible to disable a problematic subset of the
320+test suite and leave a comment explaining your reasoning.
321+
322+#### Setting `test-threads` {#setting-test-threads}
323+
324+`buildRustPackage` will use parallel test threads by default,
325+sometimes it may be necessary to disable this so the tests run consecutively.
326+
327+```nix
328+rustPlatform.buildRustPackage {
329+ /* ... */
330+ dontUseCargoParallelTests = true;
331+}
332+```
333+
334+### Building a package in `debug` mode {#building-a-package-in-debug-mode}
335+
336+By default, `buildRustPackage` will use `release` mode for builds. If a package
337+should be built in `debug` mode, it can be configured like so:
338+
339+```nix
340+rustPlatform.buildRustPackage {
341+ /* ... */
342+ buildType = "debug";
343+}
344+```
345+
346+In this scenario, the `checkPhase` will be ran in `debug` mode as well.
347+
348+### Custom `build`/`install`-procedures {#custom-buildinstall-procedures}
349+
350+Some packages may use custom scripts for building/installing, e.g. with a `Makefile`.
351+In these cases, it's recommended to override the `buildPhase`/`installPhase`/`checkPhase`.
352+
353+Otherwise, some steps may fail because of the modified directory structure of `target/`.
354+
355+### Building a crate with an absent or out-of-date Cargo.lock file {#building-a-crate-with-an-absent-or-out-of-date-cargo.lock-file}
356+
357+`buildRustPackage` needs a `Cargo.lock` file to get all dependencies in the
358+source code in a reproducible way. If it is missing or out-of-date one can use
359+the `cargoPatches` attribute to update or add it.
360+
361+```nix
362+rustPlatform.buildRustPackage rec {
363+ (...)
364+ cargoPatches = [
365+ # a patch file to add/update Cargo.lock in the source code
366+ ./add-Cargo.lock.patch
367+ ];
368+}
369+```
370+
371+## Compiling non-Rust packages that include Rust code {#compiling-non-rust-packages-that-include-rust-code}
372+
373+Several non-Rust packages incorporate Rust code for performance- or
374+security-sensitive parts. `rustPlatform` exposes several functions and
375+hooks that can be used to integrate Cargo in non-Rust packages.
376+
377+### Vendoring of dependencies {#vendoring-of-dependencies}
378+
379+Since network access is not allowed in sandboxed builds, Rust crate
380+dependencies need to be retrieved using a fetcher. `rustPlatform`
381+provides the `fetchCargoTarball` fetcher, which vendors all
382+dependencies of a crate. For example, given a source path `src`
383+containing `Cargo.toml` and `Cargo.lock`, `fetchCargoTarball`
384+can be used as follows:
385+
386+```nix
387+cargoDeps = rustPlatform.fetchCargoTarball {
388+ inherit src;
389+ hash = "sha256-BoHIN/519Top1NUBjpB/oEMqi86Omt3zTQcXFWqrek0=";
390+};
391+```
392+
393+The `src` attribute is required, as well as a hash specified through
394+one of the `sha256` or `hash` attributes. The following optional
395+attributes can also be used:
396+
397+* `name`: the name that is used for the dependencies tarball. If
398+ `name` is not specified, then the name `cargo-deps` will be used.
399+* `sourceRoot`: when the `Cargo.lock`/`Cargo.toml` are in a
400+ subdirectory, `sourceRoot` specifies the relative path to these
401+ files.
402+* `patches`: patches to apply before vendoring. This is useful when
403+ the `Cargo.lock`/`Cargo.toml` files need to be patched before
404+ vendoring.
405+
406+If a `Cargo.lock` file is available, you can alternatively use the
407+`importCargoLock` function. In contrast to `fetchCargoTarball`, this
408+function does not require a hash (unless git dependencies are used)
409+and fetches every dependency as a separate fixed-output derivation.
410+`importCargoLock` can be used as follows:
411+
412+```
413+cargoDeps = rustPlatform.importCargoLock {
414+ lockFile = ./Cargo.lock;
415+};
416+```
417+
418+If the `Cargo.lock` file includes git dependencies, then their output
419+hashes need to be specified since they are not available through the
420+lock file. For example:
421+
422+```
423+cargoDeps = rustPlatform.importCargoLock {
424+ lockFile = ./Cargo.lock;
425+ outputHashes = {
426+ "rand-0.8.3" = "0ya2hia3cn31qa8894s3av2s8j5bjwb6yq92k0jsnlx7jid0jwqa";
427+ };
428+};
429+```
430+
431+If you do not specify an output hash for a git dependency, building
432+`cargoDeps` will fail and inform you of which crate needs to be
433+added. To find the correct hash, you can first use `lib.fakeSha256` or
434+`lib.fakeHash` as a stub hash. Building `cargoDeps` will then inform
435+you of the correct hash.
436+
437+### Hooks {#hooks}
438+
439+`rustPlatform` provides the following hooks to automate Cargo builds:
440+
441+* `cargoSetupHook`: configure Cargo to use dependencies vendored
442+ through `fetchCargoTarball`. This hook uses the `cargoDeps`
443+ environment variable to find the vendored dependencies. If a project
444+ already vendors its dependencies, the variable `cargoVendorDir` can
445+ be used instead. When the `Cargo.toml`/`Cargo.lock` files are not in
446+ `sourceRoot`, then the optional `cargoRoot` is used to specify the
447+ Cargo root directory relative to `sourceRoot`.
448+* `cargoBuildHook`: use Cargo to build a crate. If the crate to be
449+ built is a crate in e.g. a Cargo workspace, the relative path to the
450+ crate to build can be set through the optional `buildAndTestSubdir`
451+ environment variable. Features can be specified with
452+ `cargoBuildNoDefaultFeatures` and `cargoBuildFeatures`. Additional
453+ Cargo build flags can be passed through `cargoBuildFlags`.
454+* `maturinBuildHook`: use [Maturin](https://github.com/PyO3/maturin)
455+ to build a Python wheel. Similar to `cargoBuildHook`, the optional
456+ variable `buildAndTestSubdir` can be used to build a crate in a
457+ Cargo workspace. Additional Maturin flags can be passed through
458+ `maturinBuildFlags`.
459+* `cargoCheckHook`: run tests using Cargo. The build type for checks
460+ can be set using `cargoCheckType`. Features can be specified with
461+ `cargoCheckNoDefaultFeaatures` and `cargoCheckFeatures`. Additional
462+ flags can be passed to the tests using `checkFlags` and
463+ `checkFlagsArray`. By default, tests are run in parallel. This can
464+ be disabled by setting `dontUseCargoParallelTests`.
465+* `cargoInstallHook`: install binaries and static/shared libraries
466+ that were built using `cargoBuildHook`.
467+* `bindgenHook`: for crates which use `bindgen` as a build dependency, lets
468+ `bindgen` find `libclang` and `libclang` find the libraries in `buildInputs`.
469+
470+### Examples {#examples}
471+
472+#### Python package using `setuptools-rust` {#python-package-using-setuptools-rust}
473+
474+For Python packages using `setuptools-rust`, you can use
475+`fetchCargoTarball` and `cargoSetupHook` to retrieve and set up Cargo
476+dependencies. The build itself is then performed by
477+`buildPythonPackage`.
478+
479+The following example outlines how the `tokenizers` Python package is
480+built. Since the Python package is in the `source/bindings/python`
481+directory of the `tokenizers` project's source archive, we use
482+`sourceRoot` to point the tooling to this directory:
483+
484+```nix
485+{ fetchFromGitHub
486+, buildPythonPackage
487+, rustPlatform
488+, setuptools-rust
489+}:
490+
491+buildPythonPackage rec {
492+ pname = "tokenizers";
493+ version = "0.10.0";
494+
495+ src = fetchFromGitHub {
496+ owner = "huggingface";
497+ repo = pname;
498+ rev = "python-v${version}";
499+ hash = "sha256-rQ2hRV52naEf6PvRsWVCTN7B1oXAQGmnpJw4iIdhamw=";
500+ };
501+
502+ cargoDeps = rustPlatform.fetchCargoTarball {
503+ inherit src sourceRoot;
504+ name = "${pname}-${version}";
505+ hash = "sha256-BoHIN/519Top1NUBjpB/oEMqi86Omt3zTQcXFWqrek0=";
506+ };
507+
508+ sourceRoot = "source/bindings/python";
509+
510+ nativeBuildInputs = [ setuptools-rust ] ++ (with rustPlatform; [
511+ cargoSetupHook
512+ rust.cargo
513+ rust.rustc
514+ ]);
515+
516+ # ...
517+}
518+```
519+
520+In some projects, the Rust crate is not in the main Python source
521+directory. In such cases, the `cargoRoot` attribute can be used to
522+specify the crate's directory relative to `sourceRoot`. In the
523+following example, the crate is in `src/rust`, as specified in the
524+`cargoRoot` attribute. Note that we also need to specify the correct
525+path for `fetchCargoTarball`.
526+
527+```nix
528+
529+{ buildPythonPackage
530+, fetchPypi
531+, rustPlatform
532+, setuptools-rust
533+, openssl
534+}:
535+
536+buildPythonPackage rec {
537+ pname = "cryptography";
538+ version = "3.4.2"; # Also update the hash in vectors.nix
539+
540+ src = fetchPypi {
541+ inherit pname version;
542+ sha256 = "1i1mx5y9hkyfi9jrrkcw804hmkcglxi6rmf7vin7jfnbr2bf4q64";
543+ };
544+
545+ cargoDeps = rustPlatform.fetchCargoTarball {
546+ inherit src;
547+ sourceRoot = "${pname}-${version}/${cargoRoot}";
548+ name = "${pname}-${version}";
549+ hash = "sha256-PS562W4L1NimqDV2H0jl5vYhL08H9est/pbIxSdYVfo=";
550+ };
551+
552+ cargoRoot = "src/rust";
553+
554+ # ...
555+}
556+```
557+
558+#### Python package using `maturin` {#python-package-using-maturin}
559+
560+Python packages that use [Maturin](https://github.com/PyO3/maturin)
561+can be built with `fetchCargoTarball`, `cargoSetupHook`, and
562+`maturinBuildHook`. For example, the following (partial) derivation
563+builds the `retworkx` Python package. `fetchCargoTarball` and
564+`cargoSetupHook` are used to fetch and set up the crate dependencies.
565+`maturinBuildHook` is used to perform the build.
566+
567+```nix
568+{ lib
569+, buildPythonPackage
570+, rustPlatform
571+, fetchFromGitHub
572+}:
573+
574+buildPythonPackage rec {
575+ pname = "retworkx";
576+ version = "0.6.0";
577+
578+ src = fetchFromGitHub {
579+ owner = "Qiskit";
580+ repo = "retworkx";
581+ rev = version;
582+ sha256 = "11n30ldg3y3y6qxg3hbj837pnbwjkqw3nxq6frds647mmmprrd20";
583+ };
584+
585+ cargoDeps = rustPlatform.fetchCargoTarball {
586+ inherit src;
587+ name = "${pname}-${version}";
588+ hash = "sha256-heOBK8qi2nuc/Ib+I/vLzZ1fUUD/G/KTw9d7M4Hz5O0=";
589+ };
590+
591+ format = "pyproject";
592+
593+ nativeBuildInputs = with rustPlatform; [ cargoSetupHook maturinBuildHook ];
594+
595+ # ...
596+}
597+```
598+
599+## Compiling Rust crates using Nix instead of Cargo {#compiling-rust-crates-using-nix-instead-of-cargo}
600+
601+### Simple operation {#simple-operation}
602+
603+When run, `cargo build` produces a file called `Cargo.lock`,
604+containing pinned versions of all dependencies. Nixpkgs contains a
605+tool called `carnix` (`nix-env -iA nixos.carnix`), which can be used
606+to turn a `Cargo.lock` into a Nix expression.
607+
608+That Nix expression calls `rustc` directly (hence bypassing Cargo),
609+and can be used to compile a crate and all its dependencies. Here is
610+an example for a minimal `hello` crate:
611+
612+```ShellSession
613+$ cargo new hello
614+$ cd hello
615+$ cargo build
616+ Compiling hello v0.1.0 (file:///tmp/hello)
617+ Finished dev [unoptimized + debuginfo] target(s) in 0.20 secs
618+$ carnix -o hello.nix --src ./. Cargo.lock --standalone
619+$ nix-build hello.nix -A hello_0_1_0
620+```
621+
622+Now, the file produced by the call to `carnix`, called `hello.nix`, looks like:
623+
624+```nix
625+# Generated by carnix 0.6.5: carnix -o hello.nix --src ./. Cargo.lock --standalone
626+{ stdenv, buildRustCrate, fetchgit }:
627+let kernel = stdenv.buildPlatform.parsed.kernel.name;
628+ # ... (content skipped)
629+in
630+rec {
631+ hello = f: hello_0_1_0 { features = hello_0_1_0_features { hello_0_1_0 = f; }; };
632+ hello_0_1_0_ = { dependencies?[], buildDependencies?[], features?[] }: buildRustCrate {
633+ crateName = "hello";
634+ version = "0.1.0";
635+ authors = [ "pe@pijul.org <pe@pijul.org>" ];
636+ src = ./.;
637+ inherit dependencies buildDependencies features;
638+ };
639+ hello_0_1_0 = { features?(hello_0_1_0_features {}) }: hello_0_1_0_ {};
640+ hello_0_1_0_features = f: updateFeatures f (rec {
641+ hello_0_1_0.default = (f.hello_0_1_0.default or true);
642+ }) [ ];
643+}
644+```
645+
646+In particular, note that the argument given as `--src` is copied
647+verbatim to the source. If we look at a more complicated
648+dependencies, for instance by adding a single line `libc="*"` to our
649+`Cargo.toml`, we first need to run `cargo build` to update the
650+`Cargo.lock`. Then, `carnix` needs to be run again, and produces the
651+following nix file:
652+
653+```nix
654+# Generated by carnix 0.6.5: carnix -o hello.nix --src ./. Cargo.lock --standalone
655+{ stdenv, buildRustCrate, fetchgit }:
656+let kernel = stdenv.buildPlatform.parsed.kernel.name;
657+ # ... (content skipped)
658+in
659+rec {
660+ hello = f: hello_0_1_0 { features = hello_0_1_0_features { hello_0_1_0 = f; }; };
661+ hello_0_1_0_ = { dependencies?[], buildDependencies?[], features?[] }: buildRustCrate {
662+ crateName = "hello";
663+ version = "0.1.0";
664+ authors = [ "pe@pijul.org <pe@pijul.org>" ];
665+ src = ./.;
666+ inherit dependencies buildDependencies features;
667+ };
668+ libc_0_2_36_ = { dependencies?[], buildDependencies?[], features?[] }: buildRustCrate {
669+ crateName = "libc";
670+ version = "0.2.36";
671+ authors = [ "The Rust Project Developers" ];
672+ sha256 = "01633h4yfqm0s302fm0dlba469bx8y6cs4nqc8bqrmjqxfxn515l";
673+ inherit dependencies buildDependencies features;
674+ };
675+ hello_0_1_0 = { features?(hello_0_1_0_features {}) }: hello_0_1_0_ {
676+ dependencies = mapFeatures features ([ libc_0_2_36 ]);
677+ };
678+ hello_0_1_0_features = f: updateFeatures f (rec {
679+ hello_0_1_0.default = (f.hello_0_1_0.default or true);
680+ libc_0_2_36.default = true;
681+ }) [ libc_0_2_36_features ];
682+ libc_0_2_36 = { features?(libc_0_2_36_features {}) }: libc_0_2_36_ {
683+ features = mkFeatures (features.libc_0_2_36 or {});
684+ };
685+ libc_0_2_36_features = f: updateFeatures f (rec {
686+ libc_0_2_36.default = (f.libc_0_2_36.default or true);
687+ libc_0_2_36.use_std =
688+ (f.libc_0_2_36.use_std or false) ||
689+ (f.libc_0_2_36.default or false) ||
690+ (libc_0_2_36.default or false);
691+ }) [];
692+}
693+```
694+
695+Here, the `libc` crate has no `src` attribute, so `buildRustCrate`
696+will fetch it from [crates.io](https://crates.io). A `sha256`
697+attribute is still needed for Nix purity.
698+
699+### Handling external dependencies {#handling-external-dependencies}
700+
701+Some crates require external libraries. For crates from
702+[crates.io](https://crates.io), such libraries can be specified in
703+`defaultCrateOverrides` package in nixpkgs itself.
704+
705+Starting from that file, one can add more overrides, to add features
706+or build inputs by overriding the hello crate in a separate file.
707+
708+```nix
709+with import <nixpkgs> {};
710+((import ./hello.nix).hello {}).override {
711+ crateOverrides = defaultCrateOverrides // {
712+ hello = attrs: { buildInputs = [ openssl ]; };
713+ };
714+}
715+```
716+
717+Here, `crateOverrides` is expected to be a attribute set, where the
718+key is the crate name without version number and the value a function.
719+The function gets all attributes passed to `buildRustCrate` as first
720+argument and returns a set that contains all attribute that should be
721+overwritten.
722+
723+For more complicated cases, such as when parts of the crate's
724+derivation depend on the crate's version, the `attrs` argument of
725+the override above can be read, as in the following example, which
726+patches the derivation:
727+
728+```nix
729+with import <nixpkgs> {};
730+((import ./hello.nix).hello {}).override {
731+ crateOverrides = defaultCrateOverrides // {
732+ hello = attrs: lib.optionalAttrs (lib.versionAtLeast attrs.version "1.0") {
733+ postPatch = ''
734+ substituteInPlace lib/zoneinfo.rs \
735+ --replace "/usr/share/zoneinfo" "${tzdata}/share/zoneinfo"
736+ '';
737+ };
738+ };
739+}
740+```
741+
742+Another situation is when we want to override a nested
743+dependency. This actually works in the exact same way, since the
744+`crateOverrides` parameter is forwarded to the crate's
745+dependencies. For instance, to override the build inputs for crate
746+`libc` in the example above, where `libc` is a dependency of the main
747+crate, we could do:
748+
749+```nix
750+with import <nixpkgs> {};
751+((import hello.nix).hello {}).override {
752+ crateOverrides = defaultCrateOverrides // {
753+ libc = attrs: { buildInputs = []; };
754+ };
755+}
756+```
757+
758+### Options and phases configuration {#options-and-phases-configuration}
759+
760+Actually, the overrides introduced in the previous section are more
761+general. A number of other parameters can be overridden:
762+
763+- The version of `rustc` used to compile the crate:
764+
765+ ```nix
766+ (hello {}).override { rust = pkgs.rust; };
767+ ```
768+
769+- Whether to build in release mode or debug mode (release mode by
770+ default):
771+
772+ ```nix
773+ (hello {}).override { release = false; };
774+ ```
775+
776+- Whether to print the commands sent to `rustc` when building
777+ (equivalent to `--verbose` in cargo:
778+
779+ ```nix
780+ (hello {}).override { verbose = false; };
781+ ```
782+
783+- Extra arguments to be passed to `rustc`:
784+
785+ ```nix
786+ (hello {}).override { extraRustcOpts = "-Z debuginfo=2"; };
787+ ```
788+
789+- Phases, just like in any other derivation, can be specified using
790+ the following attributes: `preUnpack`, `postUnpack`, `prePatch`,
791+ `patches`, `postPatch`, `preConfigure` (in the case of a Rust crate,
792+ this is run before calling the "build" script), `postConfigure`
793+ (after the "build" script),`preBuild`, `postBuild`, `preInstall` and
794+ `postInstall`. As an example, here is how to create a new module
795+ before running the build script:
796+
797+ ```nix
798+ (hello {}).override {
799+ preConfigure = ''
800+ echo "pub const PATH=\"${hi.out}\";" >> src/path.rs"
801+ '';
802+ };
803+ ```
804+
805+### Features {#features}
806+
807+One can also supply features switches. For example, if we want to
808+compile `diesel_cli` only with the `postgres` feature, and no default
809+features, we would write:
810+
811+```nix
812+(callPackage ./diesel.nix {}).diesel {
813+ default = false;
814+ postgres = true;
815+}
816+```
817+
818+Where `diesel.nix` is the file generated by Carnix, as explained above.
819+
820+## Setting Up `nix-shell` {#setting-up-nix-shell}
821+
822+Oftentimes you want to develop code from within `nix-shell`. Unfortunately
823+`buildRustCrate` does not support common `nix-shell` operations directly
824+(see [this issue](https://github.com/NixOS/nixpkgs/issues/37945))
825+so we will use `stdenv.mkDerivation` instead.
826+
827+Using the example `hello` project above, we want to do the following:
828+
829+- Have access to `cargo` and `rustc`
830+- Have the `openssl` library available to a crate through it's _normal_
831+ compilation mechanism (`pkg-config`).
832+
833+A typical `shell.nix` might look like:
834+
835+```nix
836+with import <nixpkgs> {};
837+
838+stdenv.mkDerivation {
839+ name = "rust-env";
840+ nativeBuildInputs = [
841+ rustc cargo
842+
843+ # Example Build-time Additional Dependencies
844+ pkg-config
845+ ];
846+ buildInputs = [
847+ # Example Run-time Additional Dependencies
848+ openssl
849+ ];
850+
851+ # Set Environment Variables
852+ RUST_BACKTRACE = 1;
853+}
854+```
855+
856+You should now be able to run the following:
857+
858+```ShellSession
859+$ nix-shell --pure
860+$ cargo build
861+$ cargo test
862+```
863+
864+### Controlling Rust Version Inside `nix-shell` {#controlling-rust-version-inside-nix-shell}
865+
866+To control your rust version (i.e. use nightly) from within `shell.nix` (or
867+other nix expressions) you can use the following `shell.nix`
868+
869+```nix
870+# Latest Nightly
871+with import <nixpkgs> {};
872+let src = fetchFromGitHub {
873+ owner = "mozilla";
874+ repo = "nixpkgs-mozilla";
875+ # commit from: 2019-05-15
876+ rev = "9f35c4b09fd44a77227e79ff0c1b4b6a69dff533";
877+ sha256 = "18h0nvh55b5an4gmlgfbvwbyqj91bklf1zymis6lbdh75571qaz0";
878+ };
879+in
880+with import "${src.out}/rust-overlay.nix" pkgs pkgs;
881+stdenv.mkDerivation {
882+ name = "rust-env";
883+ buildInputs = [
884+ # Note: to use stable, just replace `nightly` with `stable`
885+ latest.rustChannels.nightly.rust
886+
887+ # Add some extra dependencies from `pkgs`
888+ pkg-config openssl
889+ ];
890+
891+ # Set Environment Variables
892+ RUST_BACKTRACE = 1;
893+}
894+```
895+
896+Now run:
897+
898+```ShellSession
899+$ rustc --version
900+rustc 1.26.0-nightly (188e693b3 2018-03-26)
901+```
902+
903+To see that you are using nightly.
904+
905+## Using community Rust overlays {#using-community-rust-overlays}
906+
907+There are two community maintained approaches to Rust toolchain management:
908+- [oxalica's Rust overlay](https://github.com/oxalica/rust-overlay)
909+- [fenix](https://github.com/nix-community/fenix)
910+
911+Oxalica's overlay allows you to select a particular Rust version and components.
912+See [their documentation](https://github.com/oxalica/rust-overlay#rust-overlay) for more
913+detailed usage.
914+
915+Fenix is an alternative to `rustup` and can also be used as an overlay.
916+
917+Both oxalica's overlay and fenix better integrate with nix and cache optimizations.
918+Because of this and ergonomics, either of those community projects
919+should be preferred to the Mozilla's Rust overlay (`nixpkgs-mozilla`).
920+
921+### How to select a specific `rustc` and toolchain version {#how-to-select-a-specific-rustc-and-toolchain-version}
922+
923+You can consume the oxalica overlay and use it to grab a specific Rust toolchain version.
924+Here is an example `shell.nix` showing how to grab the current stable toolchain:
925+```nix
926+{ pkgs ? import <nixpkgs> {
927+ overlays = [
928+ (import (fetchTarball "https://github.com/oxalica/rust-overlay/archive/master.tar.gz"))
929+ ];
930+ }
931+}:
932+pkgs.mkShell {
933+ nativeBuildInputs = with pkgs; [
934+ pkg-config
935+ rust-bin.stable.latest.minimal
936+ ];
937+}
938+```
939+
940+You can try this out by:
941+1. Saving that to `shell.nix`
942+2. Executing `nix-shell --pure --command 'rustc --version'`
943+
944+As of writing, this prints out `rustc 1.56.0 (09c42c458 2021-10-18)`.
945+
946+### How to use an overlay toolchain in a derivation {#how-to-use-an-overlay-toolchain-in-a-derivation}
947+
948+You can also use an overlay's Rust toolchain with `buildRustPackage`.
949+The below snippet demonstrates invoking `buildRustPackage` with an oxalica overlay selected Rust toolchain:
950+```nix
951+with import <nixpkgs> {
952+ overlays = [
953+ (import (fetchTarball "https://github.com/oxalica/rust-overlay/archive/master.tar.gz"))
954+ ];
955+};
956+
957+rustPlatform.buildRustPackage rec {
958+ pname = "ripgrep";
959+ version = "12.1.1";
960+ nativeBuildInputs = [
961+ rust-bin.stable.latest.minimal
962+ ];
963+
964+ src = fetchFromGitHub {
965+ owner = "BurntSushi";
966+ repo = "ripgrep";
967+ rev = version;
968+ sha256 = "1hqps7l5qrjh9f914r5i6kmcz6f1yb951nv4lby0cjnp5l253kps";
969+ };
970+
971+ cargoSha256 = "03wf9r2csi6jpa7v5sw5lpxkrk4wfzwmzx7k3991q3bdjzcwnnwp";
972+
973+ meta = with lib; {
974+ description = "A fast line-oriented regex search tool, similar to ag and ack";
975+ homepage = "https://github.com/BurntSushi/ripgrep";
976+ license = licenses.unlicense;
977+ maintainers = [ maintainers.tailhook ];
978+ };
979+}
980+```
981+
982+Follow the below steps to try that snippet.
983+1. create a new directory
984+1. save the above snippet as `default.nix` in that directory
985+1. cd into that directory and run `nix-build`
986+
987+### Rust overlay installation {#rust-overlay-installation}
988+
989+You can use this overlay by either changing your local nixpkgs configuration,
990+or by adding the overlay declaratively in a nix expression, e.g. in `configuration.nix`.
991+For more information see [the manual on installing overlays](#sec-overlays-install).
992+
993+### Declarative Rust overlay installation {#declarative-rust-overlay-installation}
994+
995+This snippet shows how to use oxalica's Rust overlay.
996+Add the following to your `configuration.nix`, `home-configuration.nix`, `shell.nix`, or similar:
997+
998+```nix
999+{ pkgs ? import <nixpkgs> {
1000+ overlays = [
1001+ (import (builtins.fetchTarball "https://github.com/oxalica/rust-overlay/archive/master.tar.gz"))
1002+ # Further overlays go here
1003+ ];
1004+ };
1005+};
1006+```
1007+
1008+Note that this will fetch the latest overlay version when rebuilding your system.
doc/languages-frameworks/texlive.section.mdnew file+129
@@ -0,0 +1,129 @@
1+# TeX Live {#sec-language-texlive}
2+
3+Since release 15.09 there is a new TeX Live packaging that lives entirely under attribute `texlive`.
4+
5+## User's guide {#sec-language-texlive-user-guide}
6+
7+- For basic usage just pull `texlive.combined.scheme-basic` for an environment with basic LaTeX support.
8+
9+- It typically won't work to use separately installed packages together. Instead, you can build a custom set of packages like this. Most CTAN packages should be available:
10+
11+ ```nix
12+ texlive.combine {
13+ inherit (texlive) scheme-small collection-langkorean algorithms cm-super;
14+ }
15+ ```
16+
17+- There are all the schemes, collections and a few thousand packages, as defined upstream (perhaps with tiny differences).
18+
19+- By default you only get executables and files needed during runtime, and a little documentation for the core packages. To change that, you need to add `pkgFilter` function to `combine`.
20+
21+ ```nix
22+ texlive.combine {
23+ # inherit (texlive) whatever-you-want;
24+ pkgFilter = pkg:
25+ pkg.tlType == "run" || pkg.tlType == "bin" || pkg.pname == "cm-super";
26+ # elem tlType [ "run" "bin" "doc" "source" ]
27+ # there are also other attributes: version, name
28+ }
29+ ```
30+
31+- You can list packages e.g. by `nix repl`.
32+
33+ ```ShellSession
34+ $ nix repl
35+ nix-repl> :l <nixpkgs>
36+ nix-repl> texlive.collection-[TAB]
37+ ```
38+
39+- Note that the wrapper assumes that the result has a chance to be useful. For example, the core executables should be present, as well as some core data files. The supported way of ensuring this is by including some scheme, for example `scheme-basic`, into the combination.
40+
41+## Custom packages {#sec-language-texlive-custom-packages}
42+
43+
44+You may find that you need to use an external TeX package. A derivation for such package has to provide contents of the "texmf" directory in its output and provide the `tlType` attribute. Here is a (very verbose) example:
45+
46+```nix
47+with import <nixpkgs> {};
48+
49+let
50+ foiltex_run = stdenvNoCC.mkDerivation {
51+ pname = "latex-foiltex";
52+ version = "2.1.4b";
53+ passthru.tlType = "run";
54+
55+ srcs = [
56+ (fetchurl {
57+ url = "http://mirrors.ctan.org/macros/latex/contrib/foiltex/foiltex.dtx";
58+ sha256 = "07frz0krpz7kkcwlayrwrj2a2pixmv0icbngyw92srp9fp23cqpz";
59+ })
60+ (fetchurl {
61+ url = "http://mirrors.ctan.org/macros/latex/contrib/foiltex/foiltex.ins";
62+ sha256 = "09wkyidxk3n3zvqxfs61wlypmbhi1pxmjdi1kns9n2ky8ykbff99";
63+ })
64+ ];
65+
66+ unpackPhase = ''
67+ runHook preUnpack
68+
69+ for _src in $srcs; do
70+ cp "$_src" $(stripHash "$_src")
71+ done
72+
73+ runHook postUnpack
74+ '';
75+
76+ nativeBuildInputs = [ texlive.combined.scheme-small ];
77+
78+ dontConfigure = true;
79+
80+ buildPhase = ''
81+ runHook preBuild
82+
83+ # Generate the style files
84+ latex foiltex.ins
85+
86+ runHook postBuild
87+ '';
88+
89+ installPhase = ''
90+ runHook preInstall
91+
92+ path="$out/tex/latex/foiltex"
93+ mkdir -p "$path"
94+ cp *.{cls,def,clo} "$path/"
95+
96+ runHook postInstall
97+ '';
98+
99+ meta = with lib; {
100+ description = "A LaTeX2e class for overhead transparencies";
101+ license = licenses.unfreeRedistributable;
102+ maintainers = with maintainers; [ veprbl ];
103+ platforms = platforms.all;
104+ };
105+ };
106+ foiltex = { pkgs = [ foiltex_run ]; };
107+
108+ latex_with_foiltex = texlive.combine {
109+ inherit (texlive) scheme-small;
110+ inherit foiltex;
111+ };
112+in
113+ runCommand "test.pdf" {
114+ nativeBuildInputs = [ latex_with_foiltex ];
115+ } ''
116+cat >test.tex <<EOF
117+\documentclass{foils}
118+
119+\title{Presentation title}
120+\date{}
121+
122+\begin{document}
123+\maketitle
124+\end{document}
125+EOF
126+ pdflatex test.tex
127+ cp test.pdf $out
128+''
129+```
doc/languages-frameworks/titanium.section.mdnew file+110
@@ -0,0 +1,110 @@
1+# Titanium {#titanium}
2+
3+The Nixpkgs repository contains facilities to deploy a variety of versions of
4+the [Titanium SDK](https://www.appcelerator.com) versions, a cross-platform
5+mobile app development framework using JavaScript as an implementation language,
6+and includes a function abstraction making it possible to build Titanium
7+applications for Android and iOS devices from source code.
8+
9+Not all Titanium features supported -- currently, it can only be used to build
10+Android and iOS apps.
11+
12+## Building a Titanium app {#building-a-titanium-app}
13+
14+We can build a Titanium app from source for Android or iOS and for debugging or
15+release purposes by invoking the `titaniumenv.buildApp {}` function:
16+
17+```nix
18+titaniumenv.buildApp {
19+ name = "myapp";
20+ src = ./myappsource;
21+
22+ preBuild = "";
23+ target = "android"; # or 'iphone'
24+ tiVersion = "7.1.0.GA";
25+ release = true;
26+
27+ androidsdkArgs = {
28+ platformVersions = [ "25" "26" ];
29+ };
30+ androidKeyStore = ./keystore;
31+ androidKeyAlias = "myfirstapp";
32+ androidKeyStorePassword = "secret";
33+
34+ xcodeBaseDir = "/Applications/Xcode.app";
35+ xcodewrapperArgs = {
36+ version = "9.3";
37+ };
38+ iosMobileProvisioningProfile = ./myprovisioning.profile;
39+ iosCertificateName = "My Company";
40+ iosCertificate = ./mycertificate.p12;
41+ iosCertificatePassword = "secret";
42+ iosVersion = "11.3";
43+ iosBuildStore = false;
44+
45+ enableWirelessDistribution = true;
46+ installURL = "/installipa.php";
47+}
48+```
49+
50+The `titaniumenv.buildApp {}` function takes the following parameters:
51+
52+* The `name` parameter refers to the name in the Nix store.
53+* The `src` parameter refers to the source code location of the app that needs
54+ to be built.
55+* `preRebuild` contains optional build instructions that are carried out before
56+ the build starts.
57+* `target` indicates for which device the app must be built. Currently only
58+ 'android' and 'iphone' (for iOS) are supported.
59+* `tiVersion` can be used to optionally override the requested Titanium version
60+ in `tiapp.xml`. If not specified, it will use the version in `tiapp.xml`.
61+* `release` should be set to true when building an app for submission to the
62+ Google Playstore or Apple Appstore. Otherwise, it should be false.
63+
64+When the `target` has been set to `android`, we can configure the following
65+parameters:
66+
67+* The `androidSdkArgs` parameter refers to an attribute set that propagates all
68+ parameters to the `androidenv.composeAndroidPackages {}` function. This can
69+ be used to install all relevant Android plugins that may be needed to perform
70+ the Android build. If no parameters are given, it will deploy the platform
71+ SDKs for API-levels 25 and 26 by default.
72+
73+When the `release` parameter has been set to true, you need to provide
74+parameters to sign the app:
75+
76+* `androidKeyStore` is the path to the keystore file
77+* `androidKeyAlias` is the key alias
78+* `androidKeyStorePassword` refers to the password to open the keystore file.
79+
80+When the `target` has been set to `iphone`, we can configure the following
81+parameters:
82+
83+* The `xcodeBaseDir` parameter refers to the location where Xcode has been
84+ installed. When none value is given, the above value is the default.
85+* The `xcodewrapperArgs` parameter passes arbitrary parameters to the
86+ `xcodeenv.composeXcodeWrapper {}` function. This can, for example, be used
87+ to adjust the default version of Xcode.
88+
89+When `release` has been set to true, you also need to provide the following
90+parameters:
91+
92+* `iosMobileProvisioningProfile` refers to a mobile provisioning profile needed
93+ for signing.
94+* `iosCertificateName` refers to the company name in the P12 certificate.
95+* `iosCertificate` refers to the path to the P12 file.
96+* `iosCertificatePassword` contains the password to open the P12 file.
97+* `iosVersion` refers to the iOS SDK version to use. It defaults to the latest
98+ version.
99+* `iosBuildStore` should be set to `true` when building for the Apple Appstore
100+ submission. For enterprise or ad-hoc builds it should be set to `false`.
101+
102+When `enableWirelessDistribution` has been enabled, you must also provide the
103+path of the PHP script (`installURL`) (that is included with the iOS build
104+environment) to enable wireless ad-hoc installations.
105+
106+## Emulating or simulating the app {#emulating-or-simulating-the-app}
107+
108+It is also possible to simulate the correspond iOS simulator build by using
109+`xcodeenv.simulateApp {}` and emulate an Android APK by using
110+`androidenv.emulateApp {}`.
doc/languages-frameworks/vim.section.mdnew file+351
@@ -0,0 +1,351 @@
1+# Vim {#vim}
2+
3+Both Neovim and Vim can be configured to include your favorite plugins
4+and additional libraries.
5+
6+Loading can be deferred; see examples.
7+
8+At the moment we support three different methods for managing plugins:
9+
10+- Vim packages (*recommend*)
11+- VAM (=vim-addon-manager)
12+- Pathogen
13+- vim-plug
14+
15+## Custom configuration {#custom-configuration}
16+
17+Adding custom .vimrc lines can be done using the following code:
18+
19+```nix
20+vim_configurable.customize {
21+ # `name` optionally specifies the name of the executable and package
22+ name = "vim-with-plugins";
23+
24+ vimrcConfig.customRC = ''
25+ set hidden
26+ '';
27+}
28+```
29+
30+This configuration is used when Vim is invoked with the command specified as name, in this case `vim-with-plugins`.
31+You can also omit `name` to customize Vim itself. See the
32+[definition of `vimUtils.makeCustomizable`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/editors/vim/plugins/vim-utils.nix#L408)
33+for all supported options.
34+
35+For Neovim the `configure` argument can be overridden to achieve the same:
36+
37+```nix
38+neovim.override {
39+ configure = {
40+ customRC = ''
41+ # here your custom configuration goes!
42+ '';
43+ };
44+}
45+```
46+
47+If you want to use `neovim-qt` as a graphical editor, you can configure it by overriding Neovim in an overlay
48+or passing it an overridden Neovimn:
49+
50+```nix
51+neovim-qt.override {
52+ neovim = neovim.override {
53+ configure = {
54+ customRC = ''
55+ # your custom configuration
56+ '';
57+ };
58+ };
59+}
60+```
61+
62+## Managing plugins with Vim packages {#managing-plugins-with-vim-packages}
63+
64+To store you plugins in Vim packages (the native Vim plugin manager, see `:help packages`) the following example can be used:
65+
66+```nix
67+vim_configurable.customize {
68+ vimrcConfig.packages.myVimPackage = with pkgs.vimPlugins; {
69+ # loaded on launch
70+ start = [ youcompleteme fugitive ];
71+ # manually loadable by calling `:packadd $plugin-name`
72+ # however, if a Vim plugin has a dependency that is not explicitly listed in
73+ # opt that dependency will always be added to start to avoid confusion.
74+ opt = [ phpCompletion elm-vim ];
75+ # To automatically load a plugin when opening a filetype, add vimrc lines like:
76+ # autocmd FileType php :packadd phpCompletion
77+ };
78+}
79+```
80+
81+`myVimPackage` is an arbitrary name for the generated package. You can choose any name you like.
82+For Neovim the syntax is:
83+
84+```nix
85+neovim.override {
86+ configure = {
87+ customRC = ''
88+ # here your custom configuration goes!
89+ '';
90+ packages.myVimPackage = with pkgs.vimPlugins; {
91+ # see examples below how to use custom packages
92+ start = [ ];
93+ # If a Vim plugin has a dependency that is not explicitly listed in
94+ # opt that dependency will always be added to start to avoid confusion.
95+ opt = [ ];
96+ };
97+ };
98+}
99+```
100+
101+The resulting package can be added to `packageOverrides` in `~/.nixpkgs/config.nix` to make it installable:
102+
103+```nix
104+{
105+ packageOverrides = pkgs: with pkgs; {
106+ myVim = vim_configurable.customize {
107+ # `name` specifies the name of the executable and package
108+ name = "vim-with-plugins";
109+ # add here code from the example section
110+ };
111+ myNeovim = neovim.override {
112+ configure = {
113+ # add here code from the example section
114+ };
115+ };
116+ };
117+}
118+```
119+
120+After that you can install your special grafted `myVim` or `myNeovim` packages.
121+
122+### What if your favourite Vim plugin isn’t already packaged? {#what-if-your-favourite-vim-plugin-isnt-already-packaged}
123+
124+If one of your favourite plugins isn't packaged, you can package it yourself:
125+
126+```nix
127+{ config, pkgs, ... }:
128+
129+let
130+ easygrep = pkgs.vimUtils.buildVimPlugin {
131+ name = "vim-easygrep";
132+ src = pkgs.fetchFromGitHub {
133+ owner = "dkprice";
134+ repo = "vim-easygrep";
135+ rev = "d0c36a77cc63c22648e792796b1815b44164653a";
136+ sha256 = "0y2p5mz0d5fhg6n68lhfhl8p4mlwkb82q337c22djs4w5zyzggbc";
137+ };
138+ };
139+in
140+{
141+ environment.systemPackages = [
142+ (
143+ pkgs.neovim.override {
144+ configure = {
145+ packages.myPlugins = with pkgs.vimPlugins; {
146+ start = [
147+ vim-go # already packaged plugin
148+ easygrep # custom package
149+ ];
150+ opt = [];
151+ };
152+ # ...
153+ };
154+ }
155+ )
156+ ];
157+}
158+```
159+
160+### Specificities for some plugins
161+#### Tree sitter
162+
163+By default `nvim-treesitter` encourages you to download, compile and install
164+the required tree-sitter grammars at run time with `:TSInstall`. This works
165+poorly on NixOS. Instead, to install the `nvim-treesitter` plugins with a set
166+of precompiled grammars, you can use `nvim-treesitter.withPlugins` function:
167+
168+```nix
169+(pkgs.neovim.override {
170+ configure = {
171+ packages.myPlugins = with pkgs.vimPlugins; {
172+ start = [
173+ (nvim-treesitter.withPlugins (
174+ plugins: with plugins; [
175+ tree-sitter-nix
176+ tree-sitter-python
177+ ]
178+ ))
179+ ];
180+ };
181+ };
182+})
183+```
184+
185+To enable all grammars packaged in nixpkgs, use `(pkgs.vimPlugins.nvim-treesitter.withPlugins (plugins: pkgs.tree-sitter.allGrammars))`.
186+
187+## Managing plugins with vim-plug {#managing-plugins-with-vim-plug}
188+
189+To use [vim-plug](https://github.com/junegunn/vim-plug) to manage your Vim
190+plugins the following example can be used:
191+
192+```nix
193+vim_configurable.customize {
194+ vimrcConfig.packages.myVimPackage = with pkgs.vimPlugins; {
195+ # loaded on launch
196+ plug.plugins = [ youcompleteme fugitive phpCompletion elm-vim ];
197+ };
198+}
199+```
200+
201+For Neovim the syntax is:
202+
203+```nix
204+neovim.override {
205+ configure = {
206+ customRC = ''
207+ # here your custom configuration goes!
208+ '';
209+ plug.plugins = with pkgs.vimPlugins; [
210+ vim-go
211+ ];
212+ };
213+}
214+```
215+
216+## Managing plugins with VAM {#managing-plugins-with-vam}
217+
218+### Handling dependencies of Vim plugins {#handling-dependencies-of-vim-plugins}
219+
220+VAM introduced .json files supporting dependencies without versioning
221+assuming that "using latest version" is ok most of the time.
222+
223+### Example {#example}
224+
225+First create a vim-scripts file having one plugin name per line. Example:
226+
227+```vim
228+"tlib"
229+{'name': 'vim-addon-sql'}
230+{'filetype_regex': '\%(vim)$', 'names': ['reload', 'vim-dev-plugin']}
231+```
232+
233+Such vim-scripts file can be read by VAM as well like this:
234+
235+```vim
236+call vam#Scripts(expand('~/.vim-scripts'), {})
237+```
238+
239+Create a default.nix file:
240+
241+```nix
242+{ nixpkgs ? import <nixpkgs> {}, compiler ? "ghc7102" }:
243+nixpkgs.vim_configurable.customize { name = "vim"; vimrcConfig.vam.pluginDictionaries = [ "vim-addon-vim2nix" ]; }
244+```
245+
246+Create a generate.vim file:
247+
248+```vim
249+ActivateAddons vim-addon-vim2nix
250+let vim_scripts = "vim-scripts"
251+call nix#ExportPluginsForNix({
252+\ 'path_to_nixpkgs': eval('{"'.substitute(substitute(substitute($NIX_PATH, ':', ',', 'g'), '=',':', 'g'), '\([:,]\)', '"\1"',"g").'"}')["nixpkgs"],
253+\ 'cache_file': '/tmp/vim2nix-cache',
254+\ 'try_catch': 0,
255+\ 'plugin_dictionaries': ["vim-addon-manager"]+map(readfile(vim_scripts), 'eval(v:val)')
256+\ })
257+```
258+
259+Then run
260+
261+```bash
262+nix-shell -p vimUtils.vim_with_vim2nix --command "vim -c 'source generate.vim'"
263+```
264+
265+You should get a Vim buffer with the nix derivations (output1) and vam.pluginDictionaries (output2).
266+You can add your Vim to your system's configuration file like this and start it by "vim-my":
267+
268+```nix
269+my-vim =
270+ let plugins = let inherit (vimUtils) buildVimPluginFrom2Nix; in {
271+ copy paste output1 here
272+ }; in vim_configurable.customize {
273+ name = "vim-my";
274+
275+ vimrcConfig.vam.knownPlugins = plugins; # optional
276+ vimrcConfig.vam.pluginDictionaries = [
277+ copy paste output2 here
278+ ];
279+
280+ # Pathogen would be
281+ # vimrcConfig.pathogen.knownPlugins = plugins; # plugins
282+ # vimrcConfig.pathogen.pluginNames = ["tlib"];
283+ };
284+```
285+
286+Sample output1:
287+
288+```nix
289+"reload" = buildVimPluginFrom2Nix { # created by nix#NixDerivation
290+ name = "reload";
291+ src = fetchgit {
292+ url = "https://github.com/xolox/vim-reload";
293+ rev = "0a601a668727f5b675cb1ddc19f6861f3f7ab9e1";
294+ sha256 = "0vb832l9yxj919f5hfg6qj6bn9ni57gnjd3bj7zpq7d4iv2s4wdh";
295+ };
296+ dependencies = ["nim-misc"];
297+
298+};
299+[...]
300+```
301+
302+Sample output2:
303+
304+```nix
305+[
306+ ''vim-addon-manager''
307+ ''tlib''
308+ { "name" = ''vim-addon-sql''; }
309+ { "filetype_regex" = ''\%(vim)$$''; "names" = [ ''reload'' ''vim-dev-plugin'' ]; }
310+]
311+```
312+
313+## Adding new plugins to nixpkgs {#adding-new-plugins-to-nixpkgs}
314+
315+Nix expressions for Vim plugins are stored in [pkgs/applications/editors/vim/plugins](https://github.com/NixOS/nixpkgs/tree/master/pkgs/applications/editors/vim/plugins). For the vast majority of plugins, Nix expressions are automatically generated by running [`./update.py`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/editors/vim/plugins/update.py). This creates a [generated.nix](https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/editors/vim/plugins/generated.nix) file based on the plugins listed in [vim-plugin-names](https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/editors/vim/plugins/vim-plugin-names). Plugins are listed in alphabetical order in `vim-plugin-names` using the format `[github username]/[repository]@[gitref]`. For example https://github.com/scrooloose/nerdtree becomes `scrooloose/nerdtree`.
316+
317+Some plugins require overrides in order to function properly. Overrides are placed in [overrides.nix](https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/editors/vim/plugins/overrides.nix). Overrides are most often required when a plugin requires some dependencies, or extra steps are required during the build process. For example `deoplete-fish` requires both `deoplete-nvim` and `vim-fish`, and so the following override was added:
318+
319+```nix
320+deoplete-fish = super.deoplete-fish.overrideAttrs(old: {
321+ dependencies = with super; [ deoplete-nvim vim-fish ];
322+});
323+```
324+
325+Sometimes plugins require an override that must be changed when the plugin is updated. This can cause issues when Vim plugins are auto-updated but the associated override isn't updated. For these plugins, the override should be written so that it specifies all information required to install the plugin, and running `./update.py` doesn't change the derivation for the plugin. Manually updating the override is required to update these types of plugins. An example of such a plugin is `LanguageClient-neovim`.
326+
327+To add a new plugin, run `./update.py --add "[owner]/[name]"`. **NOTE**: This script automatically commits to your git repository. Be sure to check out a fresh branch before running.
328+
329+Finally, there are some plugins that are also packaged in nodePackages because they have Javascript-related build steps, such as running webpack. Those plugins are not listed in `vim-plugin-names` or managed by `update.py` at all, and are included separately in `overrides.nix`. Currently, all these plugins are related to the `coc.nvim` ecosystem of Language Server Protocol integration with vim/neovim.
330+
331+## Updating plugins in nixpkgs {#updating-plugins-in-nixpkgs}
332+
333+Run the update script with a GitHub API token that has at least `public_repo` access. Running the script without the token is likely to result in rate-limiting (429 errors). For steps on creating an API token, please refer to [GitHub's token documentation](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token).
334+
335+```sh
336+GITHUB_API_TOKEN=my_token ./pkgs/applications/editors/vim/plugins/update.py
337+```
338+
339+Alternatively, set the number of processes to a lower count to avoid rate-limiting.
340+
341+```sh
342+./pkgs/applications/editors/vim/plugins/update.py --proc 1
343+```
344+
345+## Important repositories {#important-repositories}
346+
347+- [vim-pi](https://bitbucket.org/vimcommunity/vim-pi) is a plugin repository
348+ from VAM plugin manager meant to be used by others as well used by
349+
350+- [vim2nix](https://github.com/MarcWeber/vim-addon-vim2nix) which generates the
351+ .nix code
doc/manual.xmlnew file+44
@@ -0,0 +1,44 @@
1+<book xmlns="http://docbook.org/ns/docbook"
2+ xmlns:xi="http://www.w3.org/2001/XInclude">
3+ <info>
4+ <title>Nixpkgs Manual</title>
5+ <subtitle>Version <xi:include href=".version" parse="text" />
6+ </subtitle>
7+ </info>
8+ <xi:include href="preface.chapter.xml" />
9+ <part>
10+ <title>Using Nixpkgs</title>
11+ <xi:include href="using/configuration.chapter.xml" />
12+ <xi:include href="using/overlays.chapter.xml" />
13+ <xi:include href="using/overrides.chapter.xml" />
14+ <xi:include href="functions.xml" />
15+ </part>
16+ <part>
17+ <title>Standard environment</title>
18+ <xi:include href="stdenv/stdenv.chapter.xml" />
19+ <xi:include href="stdenv/meta.chapter.xml" />
20+ <xi:include href="stdenv/multiple-output.chapter.xml" />
21+ <xi:include href="stdenv/cross-compilation.chapter.xml" />
22+ <xi:include href="stdenv/platform-notes.chapter.xml" />
23+ </part>
24+ <part>
25+ <title>Builders</title>
26+ <xi:include href="builders/fetchers.chapter.xml" />
27+ <xi:include href="builders/trivial-builders.chapter.xml" />
28+ <xi:include href="builders/testers.chapter.xml" />
29+ <xi:include href="builders/special.xml" />
30+ <xi:include href="builders/images.xml" />
31+ <xi:include href="hooks/index.xml" />
32+ <xi:include href="languages-frameworks/index.xml" />
33+ <xi:include href="builders/packages/index.xml" />
34+ </part>
35+ <part>
36+ <title>Contributing to Nixpkgs</title>
37+ <xi:include href="contributing/quick-start.chapter.xml" />
38+ <xi:include href="contributing/coding-conventions.chapter.xml" />
39+ <xi:include href="contributing/submitting-changes.chapter.xml" />
40+ <xi:include href="contributing/vulnerability-roundup.chapter.xml" />
41+ <xi:include href="contributing/reviewing-contributions.chapter.xml" />
42+ <xi:include href="contributing/contributing-to-documentation.chapter.xml" />
43+ </part>
44+</book>
maintainers/docs/cross.txt → doc/old/cross.txtrenamed+19−21
@@ -41,7 +41,7 @@ NB:
4141
4242Keep in mind that many programs are not very well suited for cross
4343compilation. Either they are not intended to run on other platforms,
44−because the code is highly platform specific, or the configuration proces
44+because the code is highly platform specific, or the configuration process
4545is not written with cross compilation in mind.
4646
4747Nix will not solve these problems for you!
@@ -60,11 +60,11 @@ stdenv.mkDerivation {
6060 name = "binutils-2.16.1-arm";
6161 builder = ./builder.sh;
6262 src = fetchurl {
63− url = http://ftp.nluug.nl/gnu/binutils/binutils-2.16.1.tar.bz2;
64− md5 = "6a9d529efb285071dad10e1f3d2b2967";
63+ url = "http://ftp.nluug.nl/gnu/binutils/binutils-2.16.1.tar.bz2";
64+ sha256 = "1ian3kwh2vg6hr3ymrv48s04gijs539vzrq62xr76bxbhbwnz2np";
6565 };
6666 inherit noSysDirs;
67− configureFlags = "--target=arm-linux";
67+ configureFlags = [ "--target=arm-linux" ];
6868}
6969---
7070
@@ -78,14 +78,14 @@ Step 2: build kernel headers for the target architecture
7878---
7979{stdenv, fetchurl}:
8080
81−assert stdenv.system == "i686-linux";
81+assert stdenv.buildPlatform.system == "i686-linux";
8282
8383stdenv.mkDerivation {
84− name = "linux-headers-2.6.13.4-arm";
84+ name = "linux-headers-2.6.13.1-arm";
8585 builder = ./builder.sh;
8686 src = fetchurl {
87− url = http://www.kernel.org/pub/linux/kernel/v2.6/linux-2.6.13.4.tar.bz2;
88− md5 = "94768d7eef90a9d8174639b2a7d3f58d";
87+ url = "http://www.kernel.org/pub/linux/kernel/v2.6/linux-2.6.13.1.tar.bz2";
88+ sha256 = "12qxmc827fjhaz53kjy7vyrzsaqcg78amiqsb3qm20z26w705lma";
8989 };
9090}
9191---
@@ -152,9 +152,7 @@ stdenv.mkDerivation {
152152 builder = ./builder.sh;
153153 src = fetchurl {
154154 url = ftp://ftp.nluug.nl/pub/gnu/gcc/gcc-4.0.2/gcc-core-4.0.2.tar.bz2;
155− md5 = "f7781398ada62ba255486673e6274b26";
156− #url = ftp://ftp.nluug.nl/pub/gnu/gcc/gcc-4.0.2/gcc-4.0.2.tar.bz2;
157− #md5 = "a659b8388cac9db2b13e056e574ceeb0";
155+ sha256 = "02fxh0asflm8825w23l2jq1wvs7hbnam0jayrivg7zdv2ifnc0rc";
158156 };
159157 # !!! apply only if noSysDirs is set
160158 patches = [./no-sys-dirs.patch ./gcc-inhibit.patch];
@@ -184,10 +182,10 @@ if test "$noSysDirs" = "1"; then
184182 if test "$noSysDirs" = "1"; then
185183 # Figure out what extra flags to pass to the gcc compilers
186184 # being generated to make sure that they use our glibc.
187− if test -e $NIX_GCC/nix-support/orig-glibc; then
188− glibc=$(cat $NIX_GCC/nix-support/orig-glibc)
185+ if test -e $NIX_CC/nix-support/orig-glibc; then
186+ glibc=$(cat $NIX_CC/nix-support/orig-glibc)
189187 # Ugh. Copied from gcc-wrapper/builder.sh. We can't just
190− # source in $NIX_GCC/nix-support/add-flags, since that
188+ # source in $NIX_CC/nix-support/add-flags, since that
191189 # would cause *this* GCC to be linked against the
192190 # *previous* GCC. Need some more modularity there.
193191 extraCFlags="-B$glibc/lib -isystem $glibc/include"
@@ -222,7 +220,7 @@ fi
222220
223221preConfigure=preConfigure
224222preConfigure() {
225−
223+
226224 # Determine the frontends to build.
227225 langs="c"
228226 if test -n "$langCC"; then
@@ -233,9 +231,9 @@ preConfigure() {
233231 fi
234232
235233 # Cross compiler evilness
236− ensureDir $out
237− ensureDir $out/arm-linux
238− ensureDir $out/arm-linux/bin
234+ mkdir -p $out
235+ mkdir -p $out/arm-linux
236+ mkdir -p $out/arm-linux/bin
239237 ln -s $binutilsArm/arm-linux/bin/as $out/arm-linux/bin/as
240238 ln -s $binutilsArm/arm-linux/bin/ld $out/arm-linux/bin/ld
241239 ln -s $binutilsArm/arm-linux/bin/ar $out/arm-linux/bin/ar
@@ -264,7 +262,7 @@ postInstall() {
264262
265263#if test -z "$profiledCompiler"; then
266264 #makeFlags="bootstrap"
267−#else
265+#else
268266 #makeFlags="profiledbootstrap"
269267#fi
270268
@@ -290,7 +288,7 @@ this compiler and verified to be working on a HP Jornada 820 running Linux
290288are "patch", "make" and "wget".
291289
292290If we want to build C++ programs it gets a lot more difficult. GCC has a
293−three step compilation proces. In the first step a simple compiler, called
291+three step compilation process. In the first step a simple compiler, called
294292xgcc, that can compile only C programs is built. With that compiler it
295293compiles itself two more times: one time to build a full compiler, and another
296294time to build a full compiler once again with the freshly built compiler from
@@ -318,7 +316,7 @@ with compilation flags. This is still work in progress for Nix.
318316
319317---
320318
321−After succesfully completing the whole toolchain you can start building
319+After successfully completing the whole toolchain you can start building
322320packages with the newly built tools. To make everything build correctly
323321you will need a stdenv for your target platform. Setting up this platform
324322will take some effort. Right now there is a very experimental setup for
doc/overrides.cssnew file+22
@@ -0,0 +1,22 @@
1+.docbook .xref img[src^=images\/callouts\/],
2+.screen img,
3+.programlisting img,
4+.literallayout img,
5+.synopsis img {
6+ width: 1em;
7+}
8+
9+.calloutlist img {
10+ width: 1.5em;
11+}
12+
13+.prompt,
14+.screen img,
15+.programlisting img,
16+.literallayout img,
17+.synopsis img {
18+ -moz-user-select: none;
19+ -webkit-user-select: none;
20+ -ms-user-select: none;
21+ user-select: none;
22+}
doc/preface.chapter.mdnew file+46
@@ -0,0 +1,46 @@
1+# Preface {#preface}
2+
3+The Nix Packages collection (Nixpkgs) is a set of thousands of packages for the
4+[Nix package manager](https://nixos.org/nix/), released under a
5+[permissive MIT/X11 license](https://github.com/NixOS/nixpkgs/blob/master/COPYING).
6+Packages are available for several platforms, and can be used with the Nix
7+package manager on most GNU/Linux distributions as well as [NixOS](https://nixos.org/nixos).
8+
9+This manual primarily describes how to write packages for the Nix Packages collection
10+(Nixpkgs). Thus it’s mainly for packagers and developers who want to add packages to
11+Nixpkgs. If you like to learn more about the Nix package manager and the Nix
12+expression language, then you are kindly referred to the [Nix manual](https://nixos.org/nix/manual/).
13+The NixOS distribution is documented in the [NixOS manual](https://nixos.org/nixos/manual/).
14+
15+## Overview of Nixpkgs {#overview-of-nixpkgs}
16+
17+Nix expressions describe how to build packages from source and are collected in
18+the [nixpkgs repository](https://github.com/NixOS/nixpkgs). Also included in the
19+collection are Nix expressions for
20+[NixOS modules](https://nixos.org/nixos/manual/index.html#sec-writing-modules).
21+With these expressions the Nix package manager can build binary packages.
22+
23+Packages, including the Nix packages collection, are distributed through
24+[channels](https://nixos.org/nix/manual/#sec-channels). The collection is
25+distributed for users of Nix on non-NixOS distributions through the channel
26+`nixpkgs`. Users of NixOS generally use one of the `nixos-*` channels, e.g.
27+`nixos-19.09`, which includes all packages and modules for the stable NixOS
28+19.09. Stable NixOS releases are generally only given
29+security updates. More up to date packages and modules are available via the
30+`nixos-unstable` channel.
31+
32+Both `nixos-unstable` and `nixpkgs` follow the `master` branch of the Nixpkgs
33+repository, although both do lag the `master` branch by generally
34+[a couple of days](https://status.nixos.org/). Updates to a channel are
35+distributed as soon as all tests for that channel pass, e.g.
36+[this table](https://hydra.nixos.org/job/nixpkgs/trunk/unstable#tabs-constituents)
37+shows the status of tests for the `nixpkgs` channel.
38+
39+The tests are conducted by a cluster called [Hydra](https://nixos.org/hydra/),
40+which also builds binary packages from the Nix expressions in Nixpkgs for
41+`x86_64-linux`, `i686-linux` and `x86_64-darwin`.
42+The binaries are made available via a [binary cache](https://cache.nixos.org).
43+
44+The current Nix expressions of the channels are available in the
45+[`nixpkgs`](https://github.com/NixOS/nixpkgs) repository in branches
46+that correspond to the channel names (e.g. `nixos-19.09-small`).
doc/quote-literals.xsldeleted−40
@@ -1,40 +0,0 @@
1−<?xml version="1.0"?>
2−
3−<xsl:stylesheet
4− version="1.0"
5− xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
6− xmlns:str="http://exslt.org/strings"
7− extension-element-prefixes="str">
8−
9− <xsl:output method="xml"/>
10−
11− <xsl:template match="function|command|literal|varname|filename|option|quote">`<xsl:apply-templates/>'</xsl:template>
12−
13− <xsl:template match="token"><xsl:text> </xsl:text><xsl:apply-templates /><xsl:text>
14−</xsl:text></xsl:template>
15−
16− <xsl:template match="screen|programlisting">
17− <screen><xsl:apply-templates select="str:split(., '
')" /></screen>
18− </xsl:template>
19−
20− <xsl:template match="section[following::section]">
21− <section>
22− <xsl:apply-templates />
23− <screen><xsl:text>
24− </xsl:text></screen>
25− </section>
26− </xsl:template>
27−
28− <xsl:template match="*">
29− <xsl:element name="{name(.)}" namespace="{namespace-uri(.)}">
30− <xsl:copy-of select="namespace::*" />
31− <xsl:for-each select="@*">
32− <xsl:attribute name="{name(.)}" namespace="{namespace-uri(.)}">
33− <xsl:value-of select="."/>
34− </xsl:attribute>
35− </xsl:for-each>
36− <xsl:apply-templates/>
37− </xsl:element>
38− </xsl:template>
39−
40−</xsl:stylesheet>
doc/release-notes.xml+632−188
@@ -1,206 +1,650 @@
1−<?xml version="1.0"?>
2−<!DOCTYPE book
3− PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
4− "http://www.docbook.org/xml/4.3/docbook-xml-4.3.zip"
5−[
6−]>
7−
8−<article><title>Nixpkgs Release Notes</title>
9−
10−
11−<section><title>Release 0.9 (January 31, 2006)</title>
12−
13−<para>There have been zillions of changes since the last release of
14−Nixpkgs. Many packages have been added or updated. The following are
15−some of the more notable changes:</para>
16−
17−<itemizedlist>
18−
19− <listitem><para>Distribution files have been moved to <ulink
20− url="http://nix.cs.uu.nl/" />.</para></listitem>
21−
22− <listitem><para>The C library on Linux, Glibc, has been updated to
23− version 2.3.6.</para></listitem>
24−
25− <listitem><para>The default compiler is now GCC 3.4.5. GCC 4.0.2 is
26− also available.</para></listitem>
27−
28− <listitem><para>The old, unofficial Xlibs has been replaced by the
29− official modularised X11 distribution from X.org, i.e., X11R7.0.
30− X11R7.0 consists of 287 (!) packages, all of which are in Nixpkgs
31− though not all have been tested. It is now possible to build a
32− working X server (previously we only had X client libraries). We
33− use a fully Nixified X server on NixOS.</para></listitem>
34−
35− <listitem><para>The Sun JDK 5 has been purified, i.e., it doesn't
36− require any non-Nix components such as
37− <filename>/lib/ld-linux.so.2</filename>. This means that Java
38− applications such as Eclipse and Azureus can run on
39− NixOS.</para></listitem>
40−
41− <listitem><para>Hardware-accelerated OpenGL support, used by games
42− like Quake 3 (which is now built from source).</para></listitem>
43−
44− <listitem><para>Improved support for FreeBSD on
45− x86.</para></listitem>
46−
47− <listitem><para>Improved Haskell support; e.g., the GHC build is now
48− pure.</para></listitem>
49−
50− <listitem><para>Some support for cross-compilation: cross-compiling
51− builds of GCC and Binutils, and cross-compiled builds of the C
52− library uClibc.</para></listitem>
53−
54− <listitem><para>Notable new packages:
55−
56− <itemizedlist>
57−
58− <listitem><para>teTeX, including support for building LaTeX
59− documents using Nix (with automatic dependency
60− determination).</para></listitem>
61−
62− <listitem><para>Ruby.</para></listitem>
63−
64− <listitem><para>System-level packages to support NixOS,
65− e.g. Grub, GNU <literal>parted</literal> and so
66− on.</para></listitem>
67−
68− <listitem><para><literal>ecj</literal>, the Eclipse Compiler for
69− Java, so we finally have a freely distributable compiler that
70− supports Java 5.0.</para></listitem>
71−
72− <listitem><para><literal>php</literal>.</para></listitem>
73−
74− <listitem><para>The GIMP.</para></listitem>
75−
76− <listitem><para>Inkscape.</para></listitem>
77−
78− <listitem><para>GAIM.</para></listitem>
79−
80− <listitem><para><literal>kdelibs</literal>. This allows us to
81− add KDE-based packages (such as
82− <literal>kcachegrind</literal>).</para></listitem>
83−
84− </itemizedlist>
85−
86− </para></listitem>
87−
88−</itemizedlist>
89−
90−<para>The following people contributed to this release:
91−
92− Andres Löh,
93− Armijn Hemel,
94− Bogdan Dumitriu,
95− Christof Douma,
96− Eelco Dolstra,
97− Eelco Visser,
98− Mart Kolthof,
99− Martin Bravenboer,
100− Rob Vermaas and
101− Roy van den Broek.
102−
103−</para>
104−
105−</section>
106−
107−
108−<section><title>Release 0.8 (April 11, 2005)</title>
109−
110−<para>This release is mostly to remain synchronised with the changed
111−hashing scheme in Nix 0.8.</para>
112−
113−<para>Notable updates:
114−
115−<itemizedlist>
116−
117− <listitem><para>Adobe Reader 7.0</para></listitem>
118−
119− <listitem><para>Various security updates (zlib 1.2.2, etc.)</para></listitem>
120−
121−</itemizedlist>
122−
123−</para>
124−
125−</section>
126−
127−
128−<section><title>Release 0.7 (March 14, 2005)</title>
129−
130−<itemizedlist>
131−
132−<listitem>
133−
134− <para>The bootstrap process for the standard build
135− environment on Linux (stdenv-linux) has been improved. It is no
136− longer dependent in its initial bootstrap stages on the system
137− Glibc, GCC, and other tools. Rather, Nixpkgs contains a statically
138− linked bash and curl, and uses that to download other statically
139− linked tools. These are then used to build a Glibc and dynamically
140− linked versions of all other tools.</para>
141−
142− <para>This change also makes the bootstrap process faster. For
143− instance, GCC is built only once instead of three times.</para>
144−
145− <para>(Contributed by Armijn Hemel.)</para>
146−
147−</listitem>
148−
149−<listitem>
150−
151− <para>Tarballs used by Nixpkgs are now obtained from the same server
152− that hosts Nixpkgs (<ulink url="http://catamaran.labs.cs.uu.nl/" />).
153− This reduces the risk of packages being unbuildable due to moved or
154− deleted files on various servers.</para>
155−
156−</listitem>
157−
158−<listitem>
159−
160− <para>There now is a generic mechanism for building Perl modules.
161− See the various Perl modules defined in
162− pkgs/system/all-packages-generic.nix.</para>
1+<?xml version="1.0" encoding="UTF-8"?>
2+<article xmlns="http://docbook.org/ns/docbook"
3+ xmlns:xlink="http://www.w3.org/1999/xlink">
4+ <title>Nixpkgs Release Notes</title>
5+ <section xml:id="release-notes-0.14">
6+ <title>Release 0.14 (June 4, 2012)</title>
7+
8+ <para>
9+ In preparation for the switch from Subversion to Git, this release is mainly the prevent the Nixpkgs version number from going backwards. (This would happen because prerelease version numbers produced for the Git repository are lower than those for the Subversion repository.)
10+ </para>
16311
164−</listitem>
12+ <para>
13+ Since the last release, there have been thousands of changes and new packages by numerous contributors. For details, see the commit logs.
14+ </para>
15+ </section>
16+ <section xml:id="release-notes-0.13">
17+ <title>Release 0.13 (February 5, 2010)</title>
18+
19+ <para>
20+ As always, there are many changes. Some of the most important updates are:
21+ <itemizedlist>
22+ <listitem>
23+ <para>
24+ Glibc 2.9.
25+ </para>
26+ </listitem>
27+ <listitem>
28+ <para>
29+ GCC 4.3.3.
30+ </para>
31+ </listitem>
32+ <listitem>
33+ <para>
34+ Linux 2.6.32.
35+ </para>
36+ </listitem>
37+ <listitem>
38+ <para>
39+ X.org 7.5.
40+ </para>
41+ </listitem>
42+ <listitem>
43+ <para>
44+ KDE 4.3.4.
45+ </para>
46+ </listitem>
47+ </itemizedlist>
48+ </para>
49+ </section>
50+ <section xml:id="release-notes-0.12">
51+ <title>Release 0.12 (April 24, 2009)</title>
52+
53+ <para>
54+ There are way too many additions to Nixpkgs since the last release to list here: for example, the number of packages on Linux has increased from 1002 to 2159. However, some specific improvements are worth listing:
55+ <itemizedlist>
56+ <listitem>
57+ <para>
58+ Nixpkgs now has a manual. In particular, it describes the standard build environment in detail.
59+ </para>
60+ </listitem>
61+ <listitem>
62+ <para>
63+ Major new packages:
64+ <itemizedlist>
65+ <listitem>
66+ <para>
67+ KDE 4.
68+ </para>
69+ </listitem>
70+ <listitem>
71+ <para>
72+ TeXLive.
73+ </para>
74+ </listitem>
75+ <listitem>
76+ <para>
77+ VirtualBox.
78+ </para>
79+ </listitem>
80+ </itemizedlist>
81+ … and many others.
82+ </para>
83+ </listitem>
84+ <listitem>
85+ <para>
86+ Important updates:
87+ <itemizedlist>
88+ <listitem>
89+ <para>
90+ Glibc 2.7.
91+ </para>
92+ </listitem>
93+ <listitem>
94+ <para>
95+ GCC 4.2.4.
96+ </para>
97+ </listitem>
98+ <listitem>
99+ <para>
100+ Linux 2.6.25 — 2.6.28.
101+ </para>
102+ </listitem>
103+ <listitem>
104+ <para>
105+ Firefox 3.
106+ </para>
107+ </listitem>
108+ <listitem>
109+ <para>
110+ X.org 7.3.
111+ </para>
112+ </listitem>
113+ </itemizedlist>
114+ </para>
115+ </listitem>
116+ <listitem>
117+ <para>
118+ Support for building derivations in a virtual machine, including RPM and Debian builds in automatically generated VM images. See <filename>pkgs/build-support/vm/default.nix</filename> for details.
119+ </para>
120+ </listitem>
121+ <listitem>
122+ <para>
123+ Improved support for building Haskell packages.
124+ </para>
125+ </listitem>
126+ </itemizedlist>
127+ </para>
165128
166−<listitem>
129+ <para>
130+ The following people contributed to this release: Andres Löh, Arie Middelkoop, Armijn Hemel, Eelco Dolstra, Lluís Batlle, Ludovic Courtès, Marc Weber, Mart Kolthof, Martin Bravenboer, Michael Raskin, Nicolas Pierron, Peter Simons, Pjotr Prins, Rob Vermaas, Sander van der Burg, Tobias Hammerschmidt, Valentin David, Wouter den Breejen and Yury G. Kudryashov. In addition, several people contributed patches on the <literal>nix-dev</literal> mailing list.
131+ </para>
132+ </section>
133+ <section xml:id="release-notes-0.11">
134+ <title>Release 0.11 (September 11, 2007)</title>
135+
136+ <para>
137+ This release has the following improvements:
138+ <itemizedlist>
139+ <listitem>
140+ <para>
141+ The standard build environment (<literal>stdenv</literal>) is now pure on the <literal>x86_64-linux</literal> and <literal>powerpc-linux</literal> platforms, just as on <literal>i686-linux</literal>. (Purity means that building and using the standard environment has no dependencies outside of the Nix store. For instance, it doesn’t require an external C compiler such as <filename>/usr/bin/gcc</filename>.) Also, the statically linked binaries used in the bootstrap process are now automatically reproducible, making it easy to update the bootstrap tools and to add support for other Linux platforms. See <filename>pkgs/stdenv/linux/make-bootstrap-tools.nix</filename> for details.
142+ </para>
143+ </listitem>
144+ <listitem>
145+ <para>
146+ Hook variables in the generic builder are now executed using the <function>eval</function> shell command. This has a major advantage: you can write hooks directly in Nix expressions. For instance, rather than writing a builder like this:
147+<programlisting>
148+source $stdenv/setup
149+
150+postInstall=postInstall
151+postInstall() {
152+ ln -sf gzip $out/bin/gunzip
153+ ln -sf gzip $out/bin/zcat
154+}
155+
156+genericBuild</programlisting>
157+ (the <literal>gzip</literal> builder), you can just add this attribute to the derivation:
158+<programlisting>
159+postInstall = "ln -sf gzip $out/bin/gunzip; ln -sf gzip $out/bin/zcat";</programlisting>
160+ and so a separate build script becomes unnecessary. This should allow us to get rid of most builders in Nixpkgs.
161+ </para>
162+ </listitem>
163+ <listitem>
164+ <para>
165+ It is now possible to have the generic builder pass arguments to <command>configure</command> and <command>make</command> that contain whitespace. Previously, for example, you could say in a builder,
166+<programlisting>
167+configureFlags="CFLAGS=-O0"</programlisting>
168+ but not
169+<programlisting>
170+configureFlags="CFLAGS=-O0 -g"</programlisting>
171+ since the <literal>-g</literal> would be interpreted as a separate argument to <command>configure</command>. Now you can say
172+<programlisting>
173+configureFlagsArray=("CFLAGS=-O0 -g")</programlisting>
174+ or similarly
175+<programlisting>
176+configureFlagsArray=("CFLAGS=-O0 -g" "LDFLAGS=-L/foo -L/bar")</programlisting>
177+ which does the right thing. Idem for <literal>makeFlags</literal>, <literal>installFlags</literal>, <literal>checkFlags</literal> and <literal>distFlags</literal>.
178+ </para>
179+ <para>
180+ Unfortunately you can't pass arrays to Bash through the environment, so you can't put the array above in a Nix expression, e.g.,
181+<programlisting>
182+configureFlagsArray = ["CFLAGS=-O0 -g"];</programlisting>
183+ since it would just be flattened to a since string. However, you <emphasis>can</emphasis> use the inline hooks described above:
184+<programlisting>
185+preConfigure = "configureFlagsArray=(\"CFLAGS=-O0 -g\")";</programlisting>
186+ </para>
187+ </listitem>
188+ <listitem>
189+ <para>
190+ The function <function>fetchurl</function> now has support for two different kinds of mirroring of files. First, it has support for <emphasis>content-addressable mirrors</emphasis>. For example, given the <function>fetchurl</function> call
191+<programlisting>
192+fetchurl {
193+ url = "http://releases.mozilla.org/<replaceable>...</replaceable>/firefox-2.0.0.6-source.tar.bz2";
194+ sha1 = "eb72f55e4a8bf08e8c6ef227c0ade3d068ba1082";
195+}</programlisting>
196+ <function>fetchurl</function> will first try to download this file from <link
197+ xlink:href="http://tarballs.nixos.org/sha1/eb72f55e4a8bf08e8c6ef227c0ade3d068ba1082"/>. If that file doesn’t exist, it will try the original URL. In general, the “content-addressed” location is <replaceable>mirror</replaceable><literal>/</literal><replaceable>hash-type</replaceable><literal>/</literal><replaceable>hash</replaceable>. There is currently only one content-addressable mirror (<link
198+ xlink:href="http://tarballs.nixos.org"/>), but more can be specified in the <varname>hashedMirrors</varname> attribute in <filename>pkgs/build-support/fetchurl/mirrors.nix</filename>, or by setting the <envar>NIX_HASHED_MIRRORS</envar> environment variable to a whitespace-separated list of URLs.
199+ </para>
200+ <para>
201+ Second, <function>fetchurl</function> has support for widely-mirrored distribution sites such as SourceForge or the Linux kernel archives. Given a URL of the form <literal>mirror://<replaceable>site</replaceable>/<replaceable>path</replaceable></literal>, it will try to download <replaceable>path</replaceable> from a configurable list of mirrors for <replaceable>site</replaceable>. (This idea was borrowed from Gentoo Linux.) Example:
202+<programlisting>
203+fetchurl {
204+ url = mirror://gnu/gcc/gcc-4.2.0/gcc-core-4.2.0.tar.bz2;
205+ sha256 = "0ykhzxhr8857dr97z0j9wyybfz1kjr71xk457cfapfw5fjas4ny1";
206+}</programlisting>
207+ Currently <replaceable>site</replaceable> can be <literal>sourceforge</literal>, <literal>gnu</literal> and <literal>kernel</literal>. The list of mirrors is defined in <filename>pkgs/build-support/fetchurl/mirrors.nix</filename>. You can override the list of mirrors for a particular site by setting the environment variable <envar>NIX_MIRRORS_<replaceable>site</replaceable></envar>, e.g.
208+<programlisting>
209+export NIX_MIRRORS_sourceforge=http://osdn.dl.sourceforge.net/sourceforge/</programlisting>
210+ </para>
211+ </listitem>
212+ <listitem>
213+ <para>
214+ Important updates:
215+ <itemizedlist>
216+ <listitem>
217+ <para>
218+ Glibc 2.5.
219+ </para>
220+ </listitem>
221+ <listitem>
222+ <para>
223+ GCC 4.1.2.
224+ </para>
225+ </listitem>
226+ <listitem>
227+ <para>
228+ Gnome 2.16.3.
229+ </para>
230+ </listitem>
231+ <listitem>
232+ <para>
233+ X11R7.2.
234+ </para>
235+ </listitem>
236+ <listitem>
237+ <para>
238+ Linux 2.6.21.7 and 2.6.22.6.
239+ </para>
240+ </listitem>
241+ <listitem>
242+ <para>
243+ Emacs 22.1.
244+ </para>
245+ </listitem>
246+ </itemizedlist>
247+ </para>
248+ </listitem>
249+ <listitem>
250+ <para>
251+ Major new packages:
252+ <itemizedlist>
253+ <listitem>
254+ <para>
255+ KDE 3.5.6 Base.
256+ </para>
257+ </listitem>
258+ <listitem>
259+ <para>
260+ Wine 0.9.43.
261+ </para>
262+ </listitem>
263+ <listitem>
264+ <para>
265+ OpenOffice 2.2.1.
266+ </para>
267+ </listitem>
268+ <listitem>
269+ <para>
270+ Many Linux system packages to support NixOS.
271+ </para>
272+ </listitem>
273+ </itemizedlist>
274+ </para>
275+ </listitem>
276+ </itemizedlist>
277+ </para>
167278
168− <para>Notable new packages:
279+ <para>
280+ The following people contributed to this release: Andres Löh, Arie Middelkoop, Armijn Hemel, Eelco Dolstra, Marc Weber, Mart Kolthof, Martin Bravenboer, Michael Raskin, Wouter den Breejen and Yury G. Kudryashov.
281+ </para>
282+ </section>
283+ <section xml:id="release-notes-0.10">
284+ <title>Release 0.10 (October 12, 2006)</title>
285+
286+ <note>
287+ <para>
288+ This release of Nixpkgs requires <link
289+xlink:href='https://nixos.org/releases/nix/nix-0.10/'>Nix 0.10</link> or higher.
290+ </para>
291+ </note>
292+
293+ <para>
294+ This release has the following improvements:
295+ </para>
169296
170297 <itemizedlist>
171−
172− <listitem><para>Qt 3</para></listitem>
173− <listitem><para>MySQL</para></listitem>
174− <listitem><para>MythTV</para></listitem>
175− <listitem><para>Mono</para></listitem>
176− <listitem><para>MonoDevelop (alpha)</para></listitem>
177− <listitem><para>Xine</para></listitem>
178−
298+ <listitem>
299+ <para>
300+ <filename>pkgs/system/all-packages-generic.nix</filename> is gone, we now just have <filename>pkgs/top-level/all-packages.nix</filename> that contains all available packages. This should cause much less confusion with users. <filename>all-packages.nix</filename> is a function that by default returns packages for the current platform, but you can override this by specifying a different <varname>system</varname> argument.
301+ </para>
302+ </listitem>
303+ <listitem>
304+ <para>
305+ Certain packages in Nixpkgs are now user-configurable through a configuration file, i.e., without having to edit the Nix expressions in Nixpkgs. For instance, the Firefox provided in the Nixpkgs channel is built without the RealPlayer plugin (for legal reasons). Previously, you could easily enable RealPlayer support by editing the call to the Firefox function in <filename>all-packages.nix</filename>, but such changes are not respected when Firefox is subsequently updated through the Nixpkgs channel.
306+ </para>
307+ <para>
308+ The Nixpkgs configuration file (found in <filename>~/.nixpkgs/config.nix</filename> or through the <envar>NIXPKGS_CONFIG</envar> environment variable) is an attribute set that contains configuration options that <filename>all-packages.nix</filename> reads and uses for certain packages. For instance, the following configuration file:
309+<programlisting>
310+{
311+ firefox = {
312+ enableRealPlayer = true;
313+ };
314+}</programlisting>
315+ persistently enables RealPlayer support in the Firefox build.
316+ </para>
317+ <para>
318+ (Actually, <literal>firefox.enableRealPlayer</literal> is the <emphasis>only</emphasis> configuration option currently available, but more are sure to be added.)
319+ </para>
320+ </listitem>
321+ <listitem>
322+ <para>
323+ Support for new platforms:
324+ <itemizedlist>
325+ <listitem>
326+ <para>
327+ <literal>i686-cygwin</literal>, i.e., Windows (using <link xlink:href="http://www.cygwin.com/">Cygwin</link>). The standard environment on <literal>i686-cygwin</literal> by default builds binaries for the Cygwin environment (i.e., it uses Cygwin tools and produces executables that use the Cygwin library). However, there is also a standard environment that produces binaries that use <link
328+ xlink:href="http://www.mingw.org/">MinGW</link>. You can use it by calling <filename>all-package.nix</filename> with the <varname>stdenvType</varname> argument set to <literal>"i686-mingw"</literal>.
329+ </para>
330+ </listitem>
331+ <listitem>
332+ <para>
333+ <literal>i686-darwin</literal>, i.e., Mac OS X on Intel CPUs.
334+ </para>
335+ </listitem>
336+ <listitem>
337+ <para>
338+ <literal>powerpc-linux</literal>.
339+ </para>
340+ </listitem>
341+ <listitem>
342+ <para>
343+ <literal>x86_64-linux</literal>, i.e., Linux on 64-bit AMD/Intel CPUs. Unlike <literal>i686-linux</literal>, this platform doesn’t have a pure <literal>stdenv</literal> yet.
344+ </para>
345+ </listitem>
346+ </itemizedlist>
347+ </para>
348+ </listitem>
349+ <listitem>
350+ <para>
351+ The default compiler is now GCC 4.1.1.
352+ </para>
353+ </listitem>
354+ <listitem>
355+ <para>
356+ X11 updated to X.org’s X11R7.1.
357+ </para>
358+ </listitem>
359+ <listitem>
360+ <para>
361+ Notable new packages:
362+ <itemizedlist>
363+ <listitem>
364+ <para>
365+ Opera.
366+ </para>
367+ </listitem>
368+ <listitem>
369+ <para>
370+ Microsoft Visual C++ 2005 Express Edition and the Windows SDK.
371+ </para>
372+ </listitem>
373+ </itemizedlist>
374+ In total there are now around 809 packages in Nixpkgs.
375+ </para>
376+ </listitem>
377+ <listitem>
378+ <para>
379+ It is now <emphasis>much</emphasis> easier to override the default C compiler and other tools in <literal>stdenv</literal> for specific packages. <filename>all-packages.nix</filename> provides two utility functions for this purpose: <function>overrideGCC</function> and <function>overrideInStdenv</function>. Both take a <literal>stdenv</literal> and return an augmented <literal>stdenv</literal>; the formed changes the C compiler, and the latter adds additional packages to the front of <literal>stdenv</literal>’s initial <envar>PATH</envar>, allowing tools to be overridden.
380+ </para>
381+ <para>
382+ For instance, the package <varname>strategoxt</varname> doesn’t build with the GNU Make in <literal>stdenv</literal> (version 3.81), so we call it with an augmented <literal>stdenv</literal> that uses GNU Make 3.80:
383+<programlisting>
384+strategoxt = (import ../development/compilers/strategoxt) {
385+ inherit fetchurl pkgconfig sdf aterm;
386+ stdenv = overrideInStdenv stdenv [gnumake380];
387+};
388+
389+gnumake380 = <replaceable>...</replaceable>;</programlisting>
390+ Likewise, there are many packages that don’t compile with the default GCC (4.1.1), but that’s easily fixed:
391+<programlisting>
392+exult = import ../games/exult {
393+ inherit fetchurl SDL SDL_mixer zlib libpng unzip;
394+ stdenv = overrideGCC stdenv gcc34;
395+};</programlisting>
396+ </para>
397+ </listitem>
398+ <listitem>
399+ <para>
400+ It has also become much easier to experiment with changes to the <literal>stdenv</literal> setup script (which notably contains the generic builder). Since edits to <filename>pkgs/stdenv/generic/setup.sh</filename> trigger a rebuild of <emphasis>everything</emphasis>, this was formerly quite painful. But now <literal>stdenv</literal> contains a function to “regenerate” <literal>stdenv</literal> with a different setup script, allowing the use of a different setup script for specific packages:
401+<programlisting>
402+pkg = import <replaceable>...</replaceable> {
403+ stdenv = stdenv.regenerate ./my-setup.sh;
404+ <replaceable>...</replaceable>
405+}</programlisting>
406+ </para>
407+ </listitem>
408+ <listitem>
409+ <para>
410+ Packages can now have a human-readable <emphasis>description</emphasis> field. Package descriptions are shown by <literal>nix-env -qa --description</literal>. In addition, they’re shown on the Nixpkgs release page. A description can be added to a package as follows:
411+<programlisting>
412+stdenv.mkDerivation {
413+ name = "exult-1.2";
414+ <replaceable>...</replaceable>
415+ meta = {
416+ description = "A reimplementation of the Ultima VII game engine";
417+ };
418+}</programlisting>
419+ The <varname>meta</varname> attribute is not passed to the builder, so changes to the description do not trigger a rebuild. Additional <varname>meta</varname> attributes may be defined in the future (such as the URL of the package’s homepage, the license, etc.).
420+ </para>
421+ </listitem>
179422 </itemizedlist>
180423
424+ <para>
425+ The following people contributed to this release: Andres Löh, Armijn Hemel, Christof Douma, Eelco Dolstra, Eelco Visser, Mart Kolthof, Martin Bravenboer, Merijn de Jonge, Rob Vermaas and Roy van den Broek.
181426 </para>
427+ </section>
428+ <section xml:id="release-notes-0.9">
429+ <title>Release 0.9 (January 31, 2006)</title>
182430
183−</listitem>
184−
185−<listitem>
186−
187− <para>Notable updates:
431+ <para>
432+ There have been zillions of changes since the last release of Nixpkgs. Many packages have been added or updated. The following are some of the more notable changes:
433+ </para>
188434
189435 <itemizedlist>
190−
191− <listitem><para>GCC 3.4.3</para></listitem>
192− <listitem><para>Glibc 2.3.4</para></listitem>
193− <listitem><para>GTK 2.6</para></listitem>
194−
436+ <listitem>
437+ <para>
438+ Distribution files have been moved to <link
439+ xlink:href="https://nixos.org/" />.
440+ </para>
441+ </listitem>
442+ <listitem>
443+ <para>
444+ The C library on Linux, Glibc, has been updated to version 2.3.6.
445+ </para>
446+ </listitem>
447+ <listitem>
448+ <para>
449+ The default compiler is now GCC 3.4.5. GCC 4.0.2 is also available.
450+ </para>
451+ </listitem>
452+ <listitem>
453+ <para>
454+ The old, unofficial Xlibs has been replaced by the official modularised X11 distribution from X.org, i.e., X11R7.0. X11R7.0 consists of 287 (!) packages, all of which are in Nixpkgs though not all have been tested. It is now possible to build a working X server (previously we only had X client libraries). We use a fully Nixified X server on NixOS.
455+ </para>
456+ </listitem>
457+ <listitem>
458+ <para>
459+ The Sun JDK 5 has been purified, i.e., it doesn’t require any non-Nix components such as <filename>/lib/ld-linux.so.2</filename>. This means that Java applications such as Eclipse and Azureus can run on NixOS.
460+ </para>
461+ </listitem>
462+ <listitem>
463+ <para>
464+ Hardware-accelerated OpenGL support, used by games like Quake 3 (which is now built from source).
465+ </para>
466+ </listitem>
467+ <listitem>
468+ <para>
469+ Improved support for FreeBSD on x86.
470+ </para>
471+ </listitem>
472+ <listitem>
473+ <para>
474+ Improved Haskell support; e.g., the GHC build is now pure.
475+ </para>
476+ </listitem>
477+ <listitem>
478+ <para>
479+ Some support for cross-compilation: cross-compiling builds of GCC and Binutils, and cross-compiled builds of the C library uClibc.
480+ </para>
481+ </listitem>
482+ <listitem>
483+ <para>
484+ Notable new packages:
485+ <itemizedlist>
486+ <listitem>
487+ <para>
488+ teTeX, including support for building LaTeX documents using Nix (with automatic dependency determination).
489+ </para>
490+ </listitem>
491+ <listitem>
492+ <para>
493+ Ruby.
494+ </para>
495+ </listitem>
496+ <listitem>
497+ <para>
498+ System-level packages to support NixOS, e.g. Grub, GNU <literal>parted</literal> and so on.
499+ </para>
500+ </listitem>
501+ <listitem>
502+ <para>
503+ <literal>ecj</literal>, the Eclipse Compiler for Java, so we finally have a freely distributable compiler that supports Java 5.0.
504+ </para>
505+ </listitem>
506+ <listitem>
507+ <para>
508+ <literal>php</literal>.
509+ </para>
510+ </listitem>
511+ <listitem>
512+ <para>
513+ The GIMP.
514+ </para>
515+ </listitem>
516+ <listitem>
517+ <para>
518+ Inkscape.
519+ </para>
520+ </listitem>
521+ <listitem>
522+ <para>
523+ GAIM.
524+ </para>
525+ </listitem>
526+ <listitem>
527+ <para>
528+ <literal>kdelibs</literal>. This allows us to add KDE-based packages (such as <literal>kcachegrind</literal>).
529+ </para>
530+ </listitem>
531+ </itemizedlist>
532+ </para>
533+ </listitem>
195534 </itemizedlist>
196535
536+ <para>
537+ The following people contributed to this release: Andres Löh, Armijn Hemel, Bogdan Dumitriu, Christof Douma, Eelco Dolstra, Eelco Visser, Mart Kolthof, Martin Bravenboer, Rob Vermaas and Roy van den Broek.
197538 </para>
539+ </section>
540+ <section xml:id="release-notes-0.8">
541+ <title>Release 0.8 (April 11, 2005)</title>
198542
199−</listitem>
200−
201−</itemizedlist>
543+ <para>
544+ This release is mostly to remain synchronised with the changed hashing scheme in Nix 0.8.
545+ </para>
202546
203−</section>
547+ <para>
548+ Notable updates:
549+ <itemizedlist>
550+ <listitem>
551+ <para>
552+ Adobe Reader 7.0
553+ </para>
554+ </listitem>
555+ <listitem>
556+ <para>
557+ Various security updates (zlib 1.2.2, etc.)
558+ </para>
559+ </listitem>
560+ </itemizedlist>
561+ </para>
562+ </section>
563+ <section xml:id="release-notes-0.7">
564+ <title>Release 0.7 (March 14, 2005)</title>
204565
205−
566+ <itemizedlist>
567+ <listitem>
568+ <para>
569+ The bootstrap process for the standard build environment on Linux (stdenv-linux) has been improved. It is no longer dependent in its initial bootstrap stages on the system Glibc, GCC, and other tools. Rather, Nixpkgs contains a statically linked bash and curl, and uses that to download other statically linked tools. These are then used to build a Glibc and dynamically linked versions of all other tools.
570+ </para>
571+ <para>
572+ This change also makes the bootstrap process faster. For instance, GCC is built only once instead of three times.
573+ </para>
574+ <para>
575+ (Contributed by Armijn Hemel.)
576+ </para>
577+ </listitem>
578+ <listitem>
579+ <para>
580+ Tarballs used by Nixpkgs are now obtained from the same server that hosts Nixpkgs (<link
581+ xlink:href="http://catamaran.labs.cs.uu.nl/" />). This reduces the risk of packages being unbuildable due to moved or deleted files on various servers.
582+ </para>
583+ </listitem>
584+ <listitem>
585+ <para>
586+ There now is a generic mechanism for building Perl modules. See the various Perl modules defined in pkgs/system/all-packages-generic.nix.
587+ </para>
588+ </listitem>
589+ <listitem>
590+ <para>
591+ Notable new packages:
592+ <itemizedlist>
593+ <listitem>
594+ <para>
595+ Qt 3
596+ </para>
597+ </listitem>
598+ <listitem>
599+ <para>
600+ MySQL
601+ </para>
602+ </listitem>
603+ <listitem>
604+ <para>
605+ MythTV
606+ </para>
607+ </listitem>
608+ <listitem>
609+ <para>
610+ Mono
611+ </para>
612+ </listitem>
613+ <listitem>
614+ <para>
615+ MonoDevelop (alpha)
616+ </para>
617+ </listitem>
618+ <listitem>
619+ <para>
620+ Xine
621+ </para>
622+ </listitem>
623+ </itemizedlist>
624+ </para>
625+ </listitem>
626+ <listitem>
627+ <para>
628+ Notable updates:
629+ <itemizedlist>
630+ <listitem>
631+ <para>
632+ GCC 3.4.3
633+ </para>
634+ </listitem>
635+ <listitem>
636+ <para>
637+ Glibc 2.3.4
638+ </para>
639+ </listitem>
640+ <listitem>
641+ <para>
642+ GTK 2.6
643+ </para>
644+ </listitem>
645+ </itemizedlist>
646+ </para>
647+ </listitem>
648+ </itemizedlist>
649+ </section>
206650</article>
doc/shell.nixnew file+3
@@ -0,0 +1,3 @@
1+{ pkgs ? import ../. { } }:
2+(import ./default.nix { }).overrideAttrs
3+(x: { buildInputs = (x.buildInputs or [ ]) ++ [ pkgs.xmloscopy pkgs.ruby ]; })
doc/stdenv/cross-compilation.chapter.mdnew file+236
@@ -0,0 +1,236 @@
1+# Cross-compilation {#chap-cross}
2+
3+## Introduction {#sec-cross-intro}
4+
5+"Cross-compilation" means compiling a program on one machine for another type of machine. For example, a typical use of cross-compilation is to compile programs for embedded devices. These devices often don't have the computing power and memory to compile their own programs. One might think that cross-compilation is a fairly niche concern. However, there are significant advantages to rigorously distinguishing between build-time and run-time environments! Significant, because the benefits apply even when one is developing and deploying on the same machine. Nixpkgs is increasingly adopting the opinion that packages should be written with cross-compilation in mind, and Nixpkgs should evaluate in a similar way (by minimizing cross-compilation-specific special cases) whether or not one is cross-compiling.
6+
7+This chapter will be organized in three parts. First, it will describe the basics of how to package software in a way that supports cross-compilation. Second, it will describe how to use Nixpkgs when cross-compiling. Third, it will describe the internal infrastructure supporting cross-compilation.
8+
9+## Packaging in a cross-friendly manner {#sec-cross-packaging}
10+
11+### Platform parameters {#ssec-cross-platform-parameters}
12+
13+Nixpkgs follows the [conventions of GNU autoconf](https://gcc.gnu.org/onlinedocs/gccint/Configure-Terms.html). We distinguish between 3 types of platforms when building a derivation: _build_, _host_, and _target_. In summary, _build_ is the platform on which a package is being built, _host_ is the platform on which it will run. The third attribute, _target_, is relevant only for certain specific compilers and build tools.
14+
15+In Nixpkgs, these three platforms are defined as attribute sets under the names `buildPlatform`, `hostPlatform`, and `targetPlatform`. They are always defined as attributes in the standard environment. That means one can access them like:
16+
17+```nix
18+{ stdenv, fooDep, barDep, ... }: ...stdenv.buildPlatform...
19+```
20+
21+`buildPlatform`
22+
23+: The "build platform" is the platform on which a package is built. Once someone has a built package, or pre-built binary package, the build platform should not matter and can be ignored.
24+
25+`hostPlatform`
26+
27+: The "host platform" is the platform on which a package will be run. This is the simplest platform to understand, but also the one with the worst name.
28+
29+`targetPlatform`
30+
31+: The "target platform" attribute is, unlike the other two attributes, not actually fundamental to the process of building software. Instead, it is only relevant for compatibility with building certain specific compilers and build tools. It can be safely ignored for all other packages.
32+
33+: The build process of certain compilers is written in such a way that the compiler resulting from a single build can itself only produce binaries for a single platform. The task of specifying this single "target platform" is thus pushed to build time of the compiler. The root cause of this is that the compiler (which will be run on the host) and the standard library/runtime (which will be run on the target) are built by a single build process.
34+
35+: There is no fundamental need to think about a single target ahead of time like this. If the tool supports modular or pluggable backends, both the need to specify the target at build time and the constraint of having only a single target disappear. An example of such a tool is LLVM.
36+
37+: Although the existence of a "target platform" is arguably a historical mistake, it is a common one: examples of tools that suffer from it are GCC, Binutils, GHC and Autoconf. Nixpkgs tries to avoid sharing in the mistake where possible. Still, because the concept of a target platform is so ingrained, it is best to support it as is.
38+
39+The exact schema these fields follow is a bit ill-defined due to a long and convoluted evolution, but this is slowly being cleaned up. You can see examples of ones used in practice in `lib.systems.examples`; note how they are not all very consistent. For now, here are few fields can count on them containing:
40+
41+`system`
42+
43+: This is a two-component shorthand for the platform. Examples of this would be "x86_64-darwin" and "i686-linux"; see `lib.systems.doubles` for more. The first component corresponds to the CPU architecture of the platform and the second to the operating system of the platform (`[cpu]-[os]`). This format has built-in support in Nix, such as the `builtins.currentSystem` impure string.
44+
45+`config`
46+
47+: This is a 3- or 4- component shorthand for the platform. Examples of this would be `x86_64-unknown-linux-gnu` and `aarch64-apple-darwin14`. This is a standard format called the "LLVM target triple", as they are pioneered by LLVM. In the 4-part form, this corresponds to `[cpu]-[vendor]-[os]-[abi]`. This format is strictly more informative than the "Nix host double", as the previous format could analogously be termed. This needs a better name than `config`!
48+
49+`parsed`
50+
51+: This is a Nix representation of a parsed LLVM target triple with white-listed components. This can be specified directly, or actually parsed from the `config`. See `lib.systems.parse` for the exact representation.
52+
53+`libc`
54+
55+: This is a string identifying the standard C library used. Valid identifiers include "glibc" for GNU libc, "libSystem" for Darwin's Libsystem, and "uclibc" for µClibc. It should probably be refactored to use the module system, like `parse`.
56+
57+`is*`
58+
59+: These predicates are defined in `lib.systems.inspect`, and slapped onto every platform. They are superior to the ones in `stdenv` as they force the user to be explicit about which platform they are inspecting. Please use these instead of those.
60+
61+`platform`
62+
63+: This is, quite frankly, a dumping ground of ad-hoc settings (it's an attribute set). See `lib.systems.platforms` for examples—there's hopefully one in there that will work verbatim for each platform that is working. Please help us triage these flags and give them better homes!
64+
65+### Theory of dependency categorization {#ssec-cross-dependency-categorization}
66+
67+::: {.note}
68+This is a rather philosophical description that isn't very Nixpkgs-specific. For an overview of all the relevant attributes given to `mkDerivation`, see [](#ssec-stdenv-dependencies). For a description of how everything is implemented, see [](#ssec-cross-dependency-implementation).
69+:::
70+
71+In this section we explore the relationship between both runtime and build-time dependencies and the 3 Autoconf platforms.
72+
73+A run time dependency between two packages requires that their host platforms match. This is directly implied by the meaning of "host platform" and "runtime dependency": The package dependency exists while both packages are running on a single host platform.
74+
75+A build time dependency, however, has a shift in platforms between the depending package and the depended-on package. "build time dependency" means that to build the depending package we need to be able to run the depended-on's package. The depending package's build platform is therefore equal to the depended-on package's host platform.
76+
77+If both the dependency and depending packages aren't compilers or other machine-code-producing tools, we're done. And indeed `buildInputs` and `nativeBuildInputs` have covered these simpler cases for many years. But if the dependency does produce machine code, we might need to worry about its target platform too. In principle, that target platform might be any of the depending package's build, host, or target platforms, but we prohibit dependencies from a "later" platform to an earlier platform to limit confusion because we've never seen a legitimate use for them.
78+
79+Finally, if the depending package is a compiler or other machine-code-producing tool, it might need dependencies that run at "emit time". This is for compilers that (regrettably) insist on being built together with their source languages' standard libraries. Assuming build != host != target, a run-time dependency of the standard library cannot be run at the compiler's build time or run time, but only at the run time of code emitted by the compiler.
80+
81+Putting this all together, that means that we have dependency types of the form "X→ E", which means that the dependency executes on X and emits code for E; each of X and E can be `build`, `host`, or `target`, and E can be `*` to indicate that the dependency is not a compiler-like package.
82+
83+Dependency types describe the relationships that a package has with each of its transitive dependencies. You could think of attaching one or more dependency types to each of the formal parameters at the top of a package's `.nix` file, as well as to all of *their* formal parameters, and so on. Triples like `(foo, bar, baz)`, on the other hand, are a property of an instantiated derivation -- you could would attach a triple `(mips-linux, mips-linux, sparc-solaris)` to a `.drv` file in `/nix/store`.
84+
85+Only nine dependency types matter in practice:
86+
87+#### Possible dependency types {#possible-dependency-types}
88+
89+| Dependency type | Dependency’s host platform | Dependency’s target platform |
90+|-----------------|----------------------------|------------------------------|
91+| build → * | build | (none) |
92+| build → build | build | build |
93+| build → host | build | host |
94+| build → target | build | target |
95+| host → * | host | (none) |
96+| host → host | host | host |
97+| host → target | host | target |
98+| target → * | target | (none) |
99+| target → target | target | target |
100+
101+Let's use `g++` as an example to make this table clearer. `g++` is a C++ compiler written in C. Suppose we are building `g++` with a `(build, host, target)` platform triple of `(foo, bar, baz)`. This means we are using a `foo`-machine to build a copy of `g++` which will run on a `bar`-machine and emit binaries for the `baz`-machine.
102+
103+* `g++` links against the host platform's `glibc` C library, which is a "host→ *" dependency with a triple of `(bar, bar, *)`. Since it is a library, not a compiler, it has no "target".
104+
105+* Since `g++` is written in C, the `gcc` compiler used to compile it is a "build→ host" dependency of `g++` with a triple of `(foo, foo, bar)`. This compiler runs on the build platform and emits code for the host platform.
106+
107+* `gcc` links against the build platform's `glibc` C library, which is a "build→ *" dependency with a triple of `(foo, foo, *)`. Since it is a library, not a compiler, it has no "target".
108+
109+* This `gcc` is itself compiled by an *earlier* copy of `gcc`. This earlier copy of `gcc` is a "build→ build" dependency of `g++` with a triple of `(foo, foo, foo)`. This "early `gcc`" runs on the build platform and emits code for the build platform.
110+
111+* `g++` is bundled with `libgcc`, which includes a collection of target-machine routines for exception handling and
112+software floating point emulation. `libgcc` would be a "target→ *" dependency with triple `(foo, baz, *)`, because it consists of machine code which gets linked against the output of the compiler that we are building. It is a library, not a compiler, so it has no target of its own.
113+
114+* `libgcc` is written in C and compiled with `gcc`. The `gcc` that compiles it will be a "build→ target" dependency with triple `(foo, foo, baz)`. It gets compiled *and run* at `g++`-build-time (on platform `foo`), but must emit code for the `baz`-platform.
115+
116+* `g++` allows inline assembler code, so it depends on access to a copy of the `gas` assembler. This would be a "host→ target" dependency with triple `(foo, bar, baz)`.
117+
118+* `g++` (and `gcc`) include a library `libgccjit.so`, which wrap the compiler in a library to create a just-in-time compiler. In nixpkgs, this library is in the `libgccjit` package; if C++ required that programs have access to a JIT, `g++` would need to add a "target→ target" dependency for `libgccjit` with triple `(foo, baz, baz)`. This would ensure that the compiler ships with a copy of `libgccjit` which both executes on and generates code for the `baz`-platform.
119+
120+* If `g++` itself linked against `libgccjit.so` (for example, to allow compile-time-evaluated C++ expressions), then the `libgccjit` package used to provide this functionality would be a "host→ host" dependency of `g++`: it is code which runs on the `host` and emits code for execution on the `host`.
121+
122+### Cross packaging cookbook {#ssec-cross-cookbook}
123+
124+Some frequently encountered problems when packaging for cross-compilation should be answered here. Ideally, the information above is exhaustive, so this section cannot provide any new information, but it is ludicrous and cruel to expect everyone to spend effort working through the interaction of many features just to figure out the same answer to the same common problem. Feel free to add to this list!
125+
126+#### My package fails to find a binutils command (`cc`/`ar`/`ld` etc.) {#cross-qa-fails-to-find-binutils}
127+Many packages assume that an unprefixed binutils (`cc`/`ar`/`ld` etc.) is available, but Nix doesn't provide one. It only provides a prefixed one, just as it only does for all the other binutils programs. It may be necessary to patch the package to fix the build system to use a prefix. For instance, instead of `cc`, use `${stdenv.cc.targetPrefix}cc`.
128+
129+```nix
130+makeFlags = [ "CC=${stdenv.cc.targetPrefix}cc" ];
131+```
132+
133+#### How do I avoid compiling a GCC cross-compiler from source? {#cross-qa-avoid-compiling-gcc-cross-compiler}
134+On less powerful machines, it can be inconvenient to cross-compile a package only to find out that GCC has to be compiled from source, which could take up to several hours. Nixpkgs maintains a limited [cross-related jobset on Hydra](https://hydra.nixos.org/jobset/nixpkgs/cross-trunk), which tests cross-compilation to various platforms from build platforms "x86\_64-darwin", "x86\_64-linux", and "aarch64-linux". See `pkgs/top-level/release-cross.nix` for the full list of target platforms and packages. For instance, the following invocation fetches the pre-built cross-compiled GCC for `armv6l-unknown-linux-gnueabihf` and builds GNU Hello from source.
135+
136+```ShellSession
137+$ nix-build '<nixpkgs>' -A pkgsCross.raspberryPi.hello
138+```
139+
140+#### What if my package’s build system needs to build a C program to be run under the build environment? {#cross-qa-build-c-program-in-build-environment}
141+
142+Add the following to your `mkDerivation` invocation.
143+
144+```nix
145+depsBuildBuild = [ buildPackages.stdenv.cc ];
146+```
147+
148+#### My package’s testsuite needs to run host platform code. {#cross-testsuite-runs-host-code}
149+
150+Add the following to your `mkDerivation` invocation.
151+
152+```nix
153+doCheck = stdenv.hostPlatform == stdenv.buildPlatform;
154+```
155+
156+## Cross-building packages {#sec-cross-usage}
157+
158+Nixpkgs can be instantiated with `localSystem` alone, in which case there is no cross-compiling and everything is built by and for that system, or also with `crossSystem`, in which case packages run on the latter, but all building happens on the former. Both parameters take the same schema as the 3 (build, host, and target) platforms defined in the previous section. As mentioned above, `lib.systems.examples` has some platforms which are used as arguments for these parameters in practice. You can use them programmatically, or on the command line:
159+
160+```ShellSession
161+$ nix-build '<nixpkgs>' --arg crossSystem '(import <nixpkgs/lib>).systems.examples.fooBarBaz' -A whatever
162+```
163+
164+::: {.note}
165+Eventually we would like to make these platform examples an unnecessary convenience so that
166+
167+```ShellSession
168+$ nix-build '<nixpkgs>' --arg crossSystem '{ config = "<arch>-<os>-<vendor>-<abi>"; }' -A whatever
169+```
170+
171+works in the vast majority of cases. The problem today is dependencies on other sorts of configuration which aren't given proper defaults. We rely on the examples to crudely to set those configuration parameters in some vaguely sane manner on the users behalf. Issue [\#34274](https://github.com/NixOS/nixpkgs/issues/34274) tracks this inconvenience along with its root cause in crufty configuration options.
172+:::
173+
174+While one is free to pass both parameters in full, there's a lot of logic to fill in missing fields. As discussed in the previous section, only one of `system`, `config`, and `parsed` is needed to infer the other two. Additionally, `libc` will be inferred from `parse`. Finally, `localSystem.system` is also _impurely_ inferred based on the platform evaluation occurs. This means it is often not necessary to pass `localSystem` at all, as in the command-line example in the previous paragraph.
175+
176+::: {.note}
177+Many sources (manual, wiki, etc) probably mention passing `system`, `platform`, along with the optional `crossSystem` to Nixpkgs: `import <nixpkgs> { system = ..; platform = ..; crossSystem = ..; }`. Passing those two instead of `localSystem` is still supported for compatibility, but is discouraged. Indeed, much of the inference we do for these parameters is motivated by compatibility as much as convenience.
178+:::
179+
180+One would think that `localSystem` and `crossSystem` overlap horribly with the three `*Platforms` (`buildPlatform`, `hostPlatform,` and `targetPlatform`; see `stage.nix` or the manual). Actually, those identifiers are purposefully not used here to draw a subtle but important distinction: While the granularity of having 3 platforms is necessary to properly *build* packages, it is overkill for specifying the user's *intent* when making a build plan or package set. A simple "build vs deploy" dichotomy is adequate: the sliding window principle described in the previous section shows how to interpolate between the these two "end points" to get the 3 platform triple for each bootstrapping stage. That means for any package a given package set, even those not bound on the top level but only reachable via dependencies or `buildPackages`, the three platforms will be defined as one of `localSystem` or `crossSystem`, with the former replacing the latter as one traverses build-time dependencies. A last simple difference is that `crossSystem` should be null when one doesn't want to cross-compile, while the `*Platform`s are always non-null. `localSystem` is always non-null.
181+
182+## Cross-compilation infrastructure {#sec-cross-infra}
183+
184+### Implementation of dependencies {#ssec-cross-dependency-implementation}
185+
186+The categories of dependencies developed in [](#ssec-cross-dependency-categorization) are specified as lists of derivations given to `mkDerivation`, as documented in [](#ssec-stdenv-dependencies). In short, each list of dependencies for "host → target" is called `deps<host><target>` (where `host`, and `target` values are either `build`, `host`, or `target`), with exceptions for backwards compatibility that `depsBuildHost` is instead called `nativeBuildInputs` and `depsHostTarget` is instead called `buildInputs`. Nixpkgs is now structured so that each `deps<host><target>` is automatically taken from `pkgs<host><target>`. (These `pkgs<host><target>`s are quite new, so there is no special case for `nativeBuildInputs` and `buildInputs`.) For example, `pkgsBuildHost.gcc` should be used at build-time, while `pkgsHostTarget.gcc` should be used at run-time.
187+
188+Now, for most of Nixpkgs's history, there were no `pkgs<host><target>` attributes, and most packages have not been refactored to use it explicitly. Prior to those, there were just `buildPackages`, `pkgs`, and `targetPackages`. Those are now redefined as aliases to `pkgsBuildHost`, `pkgsHostTarget`, and `pkgsTargetTarget`. It is acceptable, even recommended, to use them for libraries to show that the host platform is irrelevant.
189+
190+But before that, there was just `pkgs`, even though both `buildInputs` and `nativeBuildInputs` existed. \[Cross barely worked, and those were implemented with some hacks on `mkDerivation` to override dependencies.\] What this means is the vast majority of packages do not use any explicit package set to populate their dependencies, just using whatever `callPackage` gives them even if they do correctly sort their dependencies into the multiple lists described above. And indeed, asking that users both sort their dependencies, _and_ take them from the right attribute set, is both too onerous and redundant, so the recommended approach (for now) is to continue just categorizing by list and not using an explicit package set.
191+
192+To make this work, we "splice" together the six `pkgsFooBar` package sets and have `callPackage` actually take its arguments from that. This is currently implemented in `pkgs/top-level/splice.nix`. `mkDerivation` then, for each dependency attribute, pulls the right derivation out from the splice. This splicing can be skipped when not cross-compiling as the package sets are the same, but still is a bit slow for cross-compiling. We'd like to do something better, but haven't come up with anything yet.
193+
194+### Bootstrapping {#ssec-bootstrapping}
195+
196+Each of the package sets described above come from a single bootstrapping stage. While `pkgs/top-level/default.nix`, coordinates the composition of stages at a high level, `pkgs/top-level/stage.nix` "ties the knot" (creates the fixed point) of each stage. The package sets are defined per-stage however, so they can be thought of as edges between stages (the nodes) in a graph. Compositions like `pkgsBuildTarget.targetPackages` can be thought of as paths to this graph.
197+
198+While there are many package sets, and thus many edges, the stages can also be arranged in a linear chain. In other words, many of the edges are redundant as far as connectivity is concerned. This hinges on the type of bootstrapping we do. Currently for cross it is:
199+
200+1. `(native, native, native)`
201+
202+2. `(native, native, foreign)`
203+
204+3. `(native, foreign, foreign)`
205+
206+In each stage, `pkgsBuildHost` refers to the previous stage, `pkgsBuildBuild` refers to the one before that, and `pkgsHostTarget` refers to the current one, and `pkgsTargetTarget` refers to the next one. When there is no previous or next stage, they instead refer to the current stage. Note how all the invariants regarding the mapping between dependency and depending packages' build host and target platforms are preserved. `pkgsBuildTarget` and `pkgsHostHost` are more complex in that the stage fitting the requirements isn't always a fixed chain of "prevs" and "nexts" away (modulo the "saturating" self-references at the ends). We just special case each instead. All the primary edges are implemented is in `pkgs/stdenv/booter.nix`, and secondarily aliases in `pkgs/top-level/stage.nix`.
207+
208+::: {.note}
209+The native stages are bootstrapped in legacy ways that predate the current cross implementation. This is why the bootstrapping stages leading up to the final stages are ignored in the previous paragraph.
210+:::
211+
212+If one looks at the 3 platform triples, one can see that they overlap such that one could put them together into a chain like:
213+```
214+(native, native, native, foreign, foreign)
215+```
216+
217+If one imagines the saturating self references at the end being replaced with infinite stages, and then overlays those platform triples, one ends up with the infinite tuple:
218+```
219+(native..., native, native, native, foreign, foreign, foreign...)
220+```
221+One can then imagine any sequence of platforms such that there are bootstrap stages with their 3 platforms determined by "sliding a window" that is the 3 tuple through the sequence. This was the original model for bootstrapping. Without a target platform (assume a better world where all compilers are multi-target and all standard libraries are built in their own derivation), this is sufficient. Conversely if one wishes to cross compile "faster", with a "Canadian Cross" bootstrapping stage where `build != host != target`, more bootstrapping stages are needed since no sliding window provides the pesky `pkgsBuildTarget` package set since it skips the Canadian cross stage's "host".
222+
223+
224+::: {.note}
225+It is much better to refer to `buildPackages` than `targetPackages`, or more broadly package sets that do not mention “target”. There are three reasons for this.
226+
227+First, it is because bootstrapping stages do not have a unique `targetPackages`. For example a `(x86-linux, x86-linux, arm-linux)` and `(x86-linux, x86-linux, x86-windows)` package set both have a `(x86-linux, x86-linux, x86-linux)` package set. Because there is no canonical `targetPackages` for such a native (`build == host == target`) package set, we set their `targetPackages`
228+
229+Second, it is because this is a frequent source of hard-to-follow "infinite recursions" / cycles. When only package sets that don't mention target are used, the package set forms a directed acyclic graph. This means that all cycles that exist are confined to one stage. This means they are a lot smaller, and easier to follow in the code or a backtrace. It also means they are present in native and cross builds alike, and so more likely to be caught by CI and other users.
230+
231+Thirdly, it is because everything target-mentioning only exists to accommodate compilers with lousy build systems that insist on the compiler itself and standard library being built together. Of course that is bad because bigger derivations means longer rebuilds. It is also problematic because it tends to make the standard libraries less like other libraries than they could be, complicating code and build systems alike. Because of the other problems, and because of these innate disadvantages, compilers ought to be packaged another way where possible.
232+:::
233+
234+::: {.note}
235+If one explores Nixpkgs, they will see derivations with names like `gccCross`. Such `*Cross` derivations is a holdover from before we properly distinguished between the host and target platforms—the derivation with “Cross” in the name covered the `build = host != target` case, while the other covered the `host = target`, with build platform the same or not based on whether one was using its `.nativeDrv` or `.crossDrv`. This ugliness will disappear soon.
236+:::
doc/stdenv/meta.chapter.mdnew file+251
@@ -0,0 +1,251 @@
1+# Meta-attributes {#chap-meta}
2+
3+Nix packages can declare *meta-attributes* that contain information about a package such as a description, its homepage, its license, and so on. For instance, the GNU Hello package has a `meta` declaration like this:
4+
5+```nix
6+meta = with lib; {
7+ description = "A program that produces a familiar, friendly greeting";
8+ longDescription = ''
9+ GNU Hello is a program that prints "Hello, world!" when you run it.
10+ It is fully customizable.
11+ '';
12+ homepage = "https://www.gnu.org/software/hello/manual/";
13+ license = licenses.gpl3Plus;
14+ maintainers = [ maintainers.eelco ];
15+ platforms = platforms.all;
16+};
17+```
18+
19+Meta-attributes are not passed to the builder of the package. Thus, a change to a meta-attribute doesn’t trigger a recompilation of the package. The value of a meta-attribute must be a string.
20+
21+The meta-attributes of a package can be queried from the command-line using `nix-env`:
22+
23+```ShellSession
24+$ nix-env -qa hello --json
25+{
26+ "hello": {
27+ "meta": {
28+ "description": "A program that produces a familiar, friendly greeting",
29+ "homepage": "https://www.gnu.org/software/hello/manual/",
30+ "license": {
31+ "fullName": "GNU General Public License version 3 or later",
32+ "shortName": "GPLv3+",
33+ "url": "http://www.fsf.org/licensing/licenses/gpl.html"
34+ },
35+ "longDescription": "GNU Hello is a program that prints \"Hello, world!\" when you run it.\nIt is fully customizable.\n",
36+ "maintainers": [
37+ "Ludovic Court\u00e8s <ludo@gnu.org>"
38+ ],
39+ "platforms": [
40+ "i686-linux",
41+ "x86_64-linux",
42+ "armv5tel-linux",
43+ "armv7l-linux",
44+ "mips32-linux",
45+ "x86_64-darwin",
46+ "i686-cygwin",
47+ "i686-freebsd",
48+ "x86_64-freebsd",
49+ "i686-openbsd",
50+ "x86_64-openbsd"
51+ ],
52+ "position": "/home/user/dev/nixpkgs/pkgs/applications/misc/hello/default.nix:14"
53+ },
54+ "name": "hello-2.9",
55+ "system": "x86_64-linux"
56+ }
57+}
58+```
59+
60+`nix-env` knows about the `description` field specifically:
61+
62+```ShellSession
63+$ nix-env -qa hello --description
64+hello-2.3 A program that produces a familiar, friendly greeting
65+```
66+
67+## Standard meta-attributes {#sec-standard-meta-attributes}
68+
69+It is expected that each meta-attribute is one of the following:
70+
71+### `description` {#var-meta-description}
72+
73+A short (one-line) description of the package. This is shown by `nix-env -q --description` and also on the Nixpkgs release pages.
74+
75+Don’t include a period at the end. Don’t include newline characters. Capitalise the first character. For brevity, don’t repeat the name of package --- just describe what it does.
76+
77+Wrong: `"libpng is a library that allows you to decode PNG images."`
78+
79+Right: `"A library for decoding PNG images"`
80+
81+### `longDescription` {#var-meta-longDescription}
82+
83+An arbitrarily long description of the package.
84+
85+### `branch` {#var-meta-branch}
86+
87+Release branch. Used to specify that a package is not going to receive updates that are not in this branch; for example, Linux kernel 3.0 is supposed to be updated to 3.0.X, not 3.1.
88+
89+### `homepage` {#var-meta-homepage}
90+
91+The package’s homepage. Example: `https://www.gnu.org/software/hello/manual/`
92+
93+### `downloadPage` {#var-meta-downloadPage}
94+
95+The page where a link to the current version can be found. Example: `https://ftp.gnu.org/gnu/hello/`
96+
97+### `changelog` {#var-meta-changelog}
98+
99+A link or a list of links to the location of Changelog for a package. A link may use expansion to refer to the correct changelog version. Example: `"https://git.savannah.gnu.org/cgit/hello.git/plain/NEWS?h=v${version}"`
100+
101+### `license` {#var-meta-license}
102+
103+The license, or licenses, for the package. One from the attribute set defined in [`nixpkgs/lib/licenses.nix`](https://github.com/NixOS/nixpkgs/blob/master/lib/licenses.nix). At this moment using both a list of licenses and a single license is valid. If the license field is in the form of a list representation, then it means that parts of the package are licensed differently. Each license should preferably be referenced by their attribute. The non-list attribute value can also be a space delimited string representation of the contained attribute `shortNames` or `spdxIds`. The following are all valid examples:
104+
105+- Single license referenced by attribute (preferred) `lib.licenses.gpl3Only`.
106+- Single license referenced by its attribute shortName (frowned upon) `"gpl3Only"`.
107+- Single license referenced by its attribute spdxId (frowned upon) `"GPL-3.0-only"`.
108+- Multiple licenses referenced by attribute (preferred) `with lib.licenses; [ asl20 free ofl ]`.
109+- Multiple licenses referenced as a space delimited string of attribute shortNames (frowned upon) `"asl20 free ofl"`.
110+
111+For details, see [Licenses](#sec-meta-license).
112+
113+### `maintainers` {#var-meta-maintainers}
114+
115+A list of the maintainers of this Nix expression. Maintainers are defined in [`nixpkgs/maintainers/maintainer-list.nix`](https://github.com/NixOS/nixpkgs/blob/master/maintainers/maintainer-list.nix). There is no restriction to becoming a maintainer, just add yourself to that list in a separate commit titled “maintainers: add alice”, and reference maintainers with `maintainers = with lib.maintainers; [ alice bob ]`.
116+
117+### `mainProgram` {#var-meta-mainProgram}
118+
119+The name of the main binary for the package. This effects the binary `nix run` executes and falls back to the name of the package. Example: `"rg"`
120+
121+### `priority` {#var-meta-priority}
122+
123+The *priority* of the package, used by `nix-env` to resolve file name conflicts between packages. See the Nix manual page for `nix-env` for details. Example: `"10"` (a low-priority package).
124+
125+### `platforms` {#var-meta-platforms}
126+
127+The list of Nix platform types on which the package is supported. Hydra builds packages according to the platform specified. If no platform is specified, the package does not have prebuilt binaries. An example is:
128+
129+```nix
130+meta.platforms = lib.platforms.linux;
131+```
132+
133+Attribute Set `lib.platforms` defines [various common lists](https://github.com/NixOS/nixpkgs/blob/master/lib/systems/doubles.nix) of platforms types.
134+
135+### `tests` {#var-meta-tests}
136+
137+::: {.warning}
138+This attribute is special in that it is not actually under the `meta` attribute set but rather under the `passthru` attribute set. This is due to how `meta` attributes work, and the fact that they are supposed to contain only metadata, not derivations.
139+:::
140+
141+An attribute set with tests as values. A test is a derivation that builds when the test passes and fails to build otherwise.
142+
143+You can run these tests with:
144+
145+```ShellSession
146+$ cd path/to/nixpkgs
147+$ nix-build -A your-package.tests
148+```
149+
150+#### Package tests
151+
152+Tests that are part of the source package are often executed in the `installCheckPhase`.
153+
154+Prefer `passthru.tests` for tests that are introduced in nixpkgs because:
155+
156+* `passthru.tests` tests the 'real' package, independently from the environment in which it was built
157+* we can run `passthru.tests` independently
158+* `installCheckPhase` adds overhead to each build
159+
160+For more on how to write and run package tests, see <xref linkend="sec-package-tests"/>.
161+
162+#### NixOS tests
163+
164+The NixOS tests are available as `nixosTests` in parameters of derivations. For instance, the OpenSMTPD derivation includes lines similar to:
165+
166+```nix
167+{ /* ... */, nixosTests }:
168+{
169+ # ...
170+ passthru.tests = {
171+ basic-functionality-and-dovecot-integration = nixosTests.opensmtpd;
172+ };
173+}
174+```
175+
176+NixOS tests run in a VM, so they are slower than regular package tests. For more information see [NixOS module tests](https://nixos.org/manual/nixos/stable/#sec-nixos-tests).
177+
178+Alternatively, you can specify other derivations as tests. You can make use of
179+the optional parameter to inject the correct package without
180+relying on non-local definitions, even in the presence of `overrideAttrs`.
181+Here that's `finalAttrs.finalPackage`, but you could choose a different name if
182+`finalAttrs` already exists in your scope.
183+
184+`(mypkg.overrideAttrs f).passthru.tests` will be as expected, as long as the
185+definition of `tests` does not rely on the original `mypkg` or overrides it in
186+all places.
187+
188+```nix
189+# my-package/default.nix
190+{ stdenv, callPackage }:
191+stdenv.mkDerivation (finalAttrs: {
192+ # ...
193+ passthru.tests.example = callPackage ./example.nix { my-package = finalAttrs.finalPackage; };
194+})
195+```
196+
197+```nix
198+# my-package/example.nix
199+{ runCommand, lib, my-package, ... }:
200+runCommand "my-package-test" {
201+ nativeBuildInputs = [ my-package ];
202+ src = lib.sources.sourcesByRegex ./. [ ".*.in" ".*.expected" ];
203+} ''
204+ my-package --help
205+ my-package <example.in >example.actual
206+ diff -U3 --color=auto example.expected example.actual
207+ mkdir $out
208+''
209+```
210+
211+
212+### `timeout` {#var-meta-timeout}
213+
214+A timeout (in seconds) for building the derivation. If the derivation takes longer than this time to build, it can fail due to breaking the timeout. However, all computers do not have the same computing power, hence some builders may decide to apply a multiplicative factor to this value. When filling this value in, try to keep it approximately consistent with other values already present in `nixpkgs`.
215+
216+### `hydraPlatforms` {#var-meta-hydraPlatforms}
217+
218+The list of Nix platform types for which the Hydra instance at `hydra.nixos.org` will build the package. (Hydra is the Nix-based continuous build system.) It defaults to the value of `meta.platforms`. Thus, the only reason to set `meta.hydraPlatforms` is if you want `hydra.nixos.org` to build the package on a subset of `meta.platforms`, or not at all, e.g.
219+
220+```nix
221+meta.platforms = lib.platforms.linux;
222+meta.hydraPlatforms = [];
223+```
224+
225+### `broken` {#var-meta-broken}
226+
227+If set to `true`, the package is marked as "broken", meaning that it won’t show up in `nix-env -qa`, and cannot be built or installed. Such packages should be removed from Nixpkgs eventually unless they are fixed.
228+
229+## Licenses {#sec-meta-license}
230+
231+The `meta.license` attribute should preferably contain a value from `lib.licenses` defined in [`nixpkgs/lib/licenses.nix`](https://github.com/NixOS/nixpkgs/blob/master/lib/licenses.nix), or in-place license description of the same format if the license is unlikely to be useful in another expression.
232+
233+Although it’s typically better to indicate the specific license, a few generic options are available:
234+
235+### `lib.licenses.free`, `"free"` {#lib.licenses.free-free}
236+
237+Catch-all for free software licenses not listed above.
238+
239+### `lib.licenses.unfreeRedistributable`, `"unfree-redistributable"` {#lib.licenses.unfreeredistributable-unfree-redistributable}
240+
241+Unfree package that can be redistributed in binary form. That is, it’s legal to redistribute the *output* of the derivation. This means that the package can be included in the Nixpkgs channel.
242+
243+Sometimes proprietary software can only be redistributed unmodified. Make sure the builder doesn’t actually modify the original binaries; otherwise we’re breaking the license. For instance, the NVIDIA X11 drivers can be redistributed unmodified, but our builder applies `patchelf` to make them work. Thus, its license is `"unfree"` and it cannot be included in the Nixpkgs channel.
244+
245+### `lib.licenses.unfree`, `"unfree"` {#lib.licenses.unfree-unfree}
246+
247+Unfree package that cannot be redistributed. You can build it yourself, but you cannot redistribute the output of the derivation. Thus it cannot be included in the Nixpkgs channel.
248+
249+### `lib.licenses.unfreeRedistributableFirmware`, `"unfree-redistributable-firmware"` {#lib.licenses.unfreeredistributablefirmware-unfree-redistributable-firmware}
250+
251+This package supplies unfree, redistributable firmware. This is a separate value from `unfree-redistributable` because not everybody cares whether firmware is free.
doc/stdenv/multiple-output.chapter.mdnew file+128
@@ -0,0 +1,128 @@
1+# Multiple-output packages {#chap-multiple-output}
2+
3+## Introduction {#sec-multiple-outputs-introduction}
4+
5+The Nix language allows a derivation to produce multiple outputs, which is similar to what is utilized by other Linux distribution packaging systems. The outputs reside in separate Nix store paths, so they can be mostly handled independently of each other, including passing to build inputs, garbage collection or binary substitution. The exception is that building from source always produces all the outputs.
6+
7+The main motivation is to save disk space by reducing runtime closure sizes; consequently also sizes of substituted binaries get reduced. Splitting can be used to have more granular runtime dependencies, for example the typical reduction is to split away development-only files, as those are typically not needed during runtime. As a result, closure sizes of many packages can get reduced to a half or even much less.
8+
9+::: {.note}
10+The reduction effects could be instead achieved by building the parts in completely separate derivations. That would often additionally reduce build-time closures, but it tends to be much harder to write such derivations, as build systems typically assume all parts are being built at once. This compromise approach of single source package producing multiple binary packages is also utilized often by rpm and deb.
11+:::
12+
13+A number of attributes can be used to work with a derivation with multiple outputs. The attribute `outputs` is a list of strings, which are the names of the outputs. For each of these names, an identically named attribute is created, corresponding to that output. The attribute `meta.outputsToInstall` is used to determine the default set of outputs to install when using the derivation name unqualified.
14+
15+## Installing a split package {#sec-multiple-outputs-installing}
16+
17+When installing a package with multiple outputs, the package’s `meta.outputsToInstall` attribute determines which outputs are actually installed. `meta.outputsToInstall` is a list whose [default installs binaries and the associated man pages](https://github.com/NixOS/nixpkgs/blob/f1680774340d5443a1409c3421ced84ac1163ba9/pkgs/stdenv/generic/make-derivation.nix#L310-L320). The following sections describe ways to install different outputs.
18+
19+### Selecting outputs to install via NixOS {#sec-multiple-outputs-installing-nixos}
20+
21+NixOS provides two ways to select the outputs to install for packages listed in `environment.systemPackages`:
22+
23+- The configuration option `environment.extraOutputsToInstall` is appended to each package’s `meta.outputsToInstall` attribute to determine the outputs to install. It can for example be used to install `info` documentation or debug symbols for all packages.
24+
25+- The outputs can be listed as packages in `environment.systemPackages`. For example, the `"out"` and `"info"` outputs for the `coreutils` package can be installed by including `coreutils` and `coreutils.info` in `environment.systemPackages`.
26+
27+### Selecting outputs to install via `nix-env` {#sec-multiple-outputs-installing-nix-env}
28+
29+`nix-env` lacks an easy way to select the outputs to install. When installing a package, `nix-env` always installs the outputs listed in `meta.outputsToInstall`, even when the user explicitly selects an output.
30+
31+::: {.warning}
32+`nix-env` silenty disregards the outputs selected by the user, and instead installs the outputs from `meta.outputsToInstall`. For example,
33+
34+```ShellSession
35+$ nix-env -iA nixpkgs.coreutils.info
36+```
37+
38+installs the `"out"` output (`coreutils.meta.outputsToInstall` is `[ "out" ]`) instead of the requested `"info"`.
39+:::
40+
41+The only recourse to select an output with `nix-env` is to override the package’s `meta.outputsToInstall`, using the functions described in [](#chap-overrides). For example, the following overlay adds the `"info"` output for the `coreutils` package:
42+
43+```nix
44+self: super:
45+{
46+ coreutils = super.coreutils.overrideAttrs (oldAttrs: {
47+ meta = oldAttrs.meta // { outputsToInstall = oldAttrs.meta.outputsToInstall or [ "out" ] ++ [ "info" ]; };
48+ });
49+}
50+```
51+
52+## Using a split package {#sec-multiple-outputs-using-split-packages}
53+
54+In the Nix language the individual outputs can be reached explicitly as attributes, e.g. `coreutils.info`, but the typical case is just using packages as build inputs.
55+
56+When a multiple-output derivation gets into a build input of another derivation, the `dev` output is added if it exists, otherwise the first output is added. In addition to that, `propagatedBuildOutputs` of that package which by default contain `$outputBin` and `$outputLib` are also added. (See [](#multiple-output-file-type-groups).)
57+
58+In some cases it may be desirable to combine different outputs under a single store path. A function `symlinkJoin` can be used to do this. (Note that it may negate some closure size benefits of using a multiple-output package.)
59+
60+## Writing a split derivation {#sec-multiple-outputs-}
61+
62+Here you find how to write a derivation that produces multiple outputs.
63+
64+In nixpkgs there is a framework supporting multiple-output derivations. It tries to cover most cases by default behavior. You can find the source separated in `<nixpkgs/pkgs/build-support/setup-hooks/multiple-outputs.sh>`; it’s relatively well-readable. The whole machinery is triggered by defining the `outputs` attribute to contain the list of desired output names (strings).
65+
66+```nix
67+outputs = [ "bin" "dev" "out" "doc" ];
68+```
69+
70+Often such a single line is enough. For each output an equally named environment variable is passed to the builder and contains the path in nix store for that output. Typically you also want to have the main `out` output, as it catches any files that didn’t get elsewhere.
71+
72+::: {.note}
73+There is a special handling of the `debug` output, described at [](#stdenv-separateDebugInfo).
74+:::
75+
76+### “Binaries first” {#multiple-output-file-binaries-first-convention}
77+
78+A commonly adopted convention in `nixpkgs` is that executables provided by the package are contained within its first output. This convention allows the dependent packages to reference the executables provided by packages in a uniform manner. For instance, provided with the knowledge that the `perl` package contains a `perl` executable it can be referenced as `${pkgs.perl}/bin/perl` within a Nix derivation that needs to execute a Perl script.
79+
80+The `glibc` package is a deliberate single exception to the “binaries first” convention. The `glibc` has `libs` as its first output allowing the libraries provided by `glibc` to be referenced directly (e.g. `${stdenv.glibc}/lib/ld-linux-x86-64.so.2`). The executables provided by `glibc` can be accessed via its `bin` attribute (e.g. `${stdenv.glibc.bin}/bin/ldd`).
81+
82+The reason for why `glibc` deviates from the convention is because referencing a library provided by `glibc` is a very common operation among Nix packages. For instance, third-party executables packaged by Nix are typically patched and relinked with the relevant version of `glibc` libraries from Nix packages (please see the documentation on [patchelf](https://github.com/NixOS/patchelf) for more details).
83+
84+### File type groups {#multiple-output-file-type-groups}
85+
86+The support code currently recognizes some particular kinds of outputs and either instructs the build system of the package to put files into their desired outputs or it moves the files during the fixup phase. Each group of file types has an `outputFoo` variable specifying the output name where they should go. If that variable isn’t defined by the derivation writer, it is guessed – a default output name is defined, falling back to other possibilities if the output isn’t defined.
87+
88+#### `$outputDev` {#outputdev}
89+
90+is for development-only files. These include C(++) headers (`include/`), pkg-config (`lib/pkgconfig/`), cmake (`lib/cmake/`) and aclocal files (`share/aclocal/`). They go to `dev` or `out` by default.
91+
92+#### `$outputBin` {#outputbin}
93+
94+is meant for user-facing binaries, typically residing in `bin/`. They go to `bin` or `out` by default.
95+
96+#### `$outputLib` {#outputlib}
97+
98+is meant for libraries, typically residing in `lib/` and `libexec/`. They go to `lib` or `out` by default.
99+
100+#### `$outputDoc` {#outputdoc}
101+
102+is for user documentation, typically residing in `share/doc/`. It goes to `doc` or `out` by default.
103+
104+#### `$outputDevdoc` {#outputdevdoc}
105+
106+is for _developer_ documentation. Currently we count gtk-doc and devhelp books, typically residing in `share/gtk-doc/` and `share/devhelp/`, in there. It goes to `devdoc` or is removed (!) by default. This is because e.g. gtk-doc tends to be rather large and completely unused by nixpkgs users.
107+
108+#### `$outputMan` {#outputman}
109+
110+is for man pages (except for section 3), typically residing in `share/man/man[0-9]/`. They go to `man` or `$outputBin` by default.
111+
112+#### `$outputDevman` {#outputdevman}
113+
114+is for section 3 man pages, typically residing in `share/man/man[0-9]/`. They go to `devman` or `$outputMan` by default.
115+
116+#### `$outputInfo` {#outputinfo}
117+
118+is for info pages, typically residing in `share/info/`. They go to `info` or `$outputBin` by default.
119+
120+### Common caveats {#sec-multiple-outputs-caveats}
121+
122+- Some configure scripts don’t like some of the parameters passed by default by the framework, e.g. `--docdir=/foo/bar`. You can disable this by setting `setOutputFlags = false;`.
123+
124+- The outputs of a single derivation can retain references to each other, but note that circular references are not allowed. (And each strongly-connected component would act as a single output anyway.)
125+
126+- Most of split packages contain their core functionality in libraries. These libraries tend to refer to various kind of data that typically gets into `out`, e.g. locale strings, so there is often no advantage in separating the libraries into `lib`, as keeping them in `out` is easier.
127+
128+- Some packages have hidden assumptions on install paths, which complicates splitting.
doc/stdenv/platform-notes.chapter.mdnew file+62
@@ -0,0 +1,62 @@
1+# Platform Notes {#chap-platform-notes}
2+
3+## Darwin (macOS) {#sec-darwin}
4+
5+Some common issues when packaging software for Darwin:
6+
7+- The Darwin `stdenv` uses clang instead of gcc. When referring to the compiler `$CC` or `cc` will work in both cases. Some builds hardcode gcc/g++ in their build scripts, that can usually be fixed with using something like `makeFlags = [ "CC=cc" ];` or by patching the build scripts.
8+
9+ ```nix
10+ stdenv.mkDerivation {
11+ name = "libfoo-1.2.3";
12+ # ...
13+ buildPhase = ''
14+ $CC -o hello hello.c
15+ '';
16+ }
17+ ```
18+
19+- On Darwin, libraries are linked using absolute paths, libraries are resolved by their `install_name` at link time. Sometimes packages won’t set this correctly causing the library lookups to fail at runtime. This can be fixed by adding extra linker flags or by running `install_name_tool -id` during the `fixupPhase`.
20+
21+ ```nix
22+ stdenv.mkDerivation {
23+ name = "libfoo-1.2.3";
24+ # ...
25+ makeFlags = lib.optional stdenv.isDarwin "LDFLAGS=-Wl,-install_name,$(out)/lib/libfoo.dylib";
26+ }
27+ ```
28+
29+- Even if the libraries are linked using absolute paths and resolved via their `install_name` correctly, tests can sometimes fail to run binaries. This happens because the `checkPhase` runs before the libraries are installed.
30+
31+ This can usually be solved by running the tests after the `installPhase` or alternatively by using `DYLD_LIBRARY_PATH`. More information about this variable can be found in the *dyld(1)* manpage.
32+
33+ ```
34+ dyld: Library not loaded: /nix/store/7hnmbscpayxzxrixrgxvvlifzlxdsdir-jq-1.5-lib/lib/libjq.1.dylib
35+ Referenced from: /private/tmp/nix-build-jq-1.5.drv-0/jq-1.5/tests/../jq
36+ Reason: image not found
37+ ./tests/jqtest: line 5: 75779 Abort trap: 6
38+ ```
39+
40+ ```nix
41+ stdenv.mkDerivation {
42+ name = "libfoo-1.2.3";
43+ # ...
44+ doInstallCheck = true;
45+ installCheckTarget = "check";
46+ }
47+ ```
48+
49+- Some packages assume xcode is available and use `xcrun` to resolve build tools like `clang`, etc. This causes errors like `xcode-select: error: no developer tools were found at '/Applications/Xcode.app'` while the build doesn’t actually depend on xcode.
50+
51+ ```nix
52+ stdenv.mkDerivation {
53+ name = "libfoo-1.2.3";
54+ # ...
55+ prePatch = ''
56+ substituteInPlace Makefile \
57+ --replace '/usr/bin/xcrun clang' clang
58+ '';
59+ }
60+ ```
61+
62+ The package `xcbuild` can be used to build projects that really depend on Xcode. However, this replacement is not 100% compatible with Xcode and can occasionally cause issues.
doc/stdenv/stdenv.chapter.mdnew file+1323
@@ -0,0 +1,1323 @@
1+# The Standard Environment {#chap-stdenv}
2+
3+The standard build environment in the Nix Packages collection provides an environment for building Unix packages that does a lot of common build tasks automatically. In fact, for Unix packages that use the standard `./configure; make; make install` build interface, you don’t need to write a build script at all; the standard environment does everything automatically. If `stdenv` doesn’t do what you need automatically, you can easily customise or override the various build phases.
4+
5+## Using `stdenv` {#sec-using-stdenv}
6+
7+To build a package with the standard environment, you use the function `stdenv.mkDerivation`, instead of the primitive built-in function `derivation`, e.g.
8+
9+```nix
10+stdenv.mkDerivation {
11+ name = "libfoo-1.2.3";
12+ src = fetchurl {
13+ url = "http://example.org/libfoo-1.2.3.tar.bz2";
14+ sha256 = "0x2g1jqygyr5wiwg4ma1nd7w4ydpy82z9gkcv8vh2v8dn3y58v5m";
15+ };
16+}
17+```
18+
19+(`stdenv` needs to be in scope, so if you write this in a separate Nix expression from `pkgs/all-packages.nix`, you need to pass it as a function argument.) Specifying a `name` and a `src` is the absolute minimum Nix requires. For convenience, you can also use `pname` and `version` attributes and `mkDerivation` will automatically set `name` to `"${pname}-${version}"` by default. Since [RFC 0035](https://github.com/NixOS/rfcs/pull/35), this is preferred for packages in Nixpkgs, as it allows us to reuse the version easily:
20+
21+```nix
22+stdenv.mkDerivation rec {
23+ pname = "libfoo";
24+ version = "1.2.3";
25+ src = fetchurl {
26+ url = "http://example.org/libfoo-source-${version}.tar.bz2";
27+ sha256 = "0x2g1jqygyr5wiwg4ma1nd7w4ydpy82z9gkcv8vh2v8dn3y58v5m";
28+ };
29+}
30+```
31+
32+Many packages have dependencies that are not provided in the standard environment. It’s usually sufficient to specify those dependencies in the `buildInputs` attribute:
33+
34+```nix
35+stdenv.mkDerivation {
36+ name = "libfoo-1.2.3";
37+ ...
38+ buildInputs = [libbar perl ncurses];
39+}
40+```
41+
42+This attribute ensures that the `bin` subdirectories of these packages appear in the `PATH` environment variable during the build, that their `include` subdirectories are searched by the C compiler, and so on. (See [](#ssec-setup-hooks) for details.)
43+
44+Often it is necessary to override or modify some aspect of the build. To make this easier, the standard environment breaks the package build into a number of *phases*, all of which can be overridden or modified individually: unpacking the sources, applying patches, configuring, building, and installing. (There are some others; see [](#sec-stdenv-phases).) For instance, a package that doesn’t supply a makefile but instead has to be compiled "manually" could be handled like this:
45+
46+```nix
47+stdenv.mkDerivation {
48+ name = "fnord-4.5";
49+ ...
50+ buildPhase = ''
51+ gcc foo.c -o foo
52+ '';
53+ installPhase = ''
54+ mkdir -p $out/bin
55+ cp foo $out/bin
56+ '';
57+}
58+```
59+
60+(Note the use of `''`-style string literals, which are very convenient for large multi-line script fragments because they don’t need escaping of `"` and `\`, and because indentation is intelligently removed.)
61+
62+There are many other attributes to customise the build. These are listed in [](#ssec-stdenv-attributes).
63+
64+While the standard environment provides a generic builder, you can still supply your own build script:
65+
66+```nix
67+stdenv.mkDerivation {
68+ name = "libfoo-1.2.3";
69+ ...
70+ builder = ./builder.sh;
71+}
72+```
73+
74+where the builder can do anything it wants, but typically starts with
75+
76+```bash
77+source $stdenv/setup
78+```
79+
80+to let `stdenv` set up the environment (e.g., process the `buildInputs`). If you want, you can still use `stdenv`’s generic builder:
81+
82+```bash
83+source $stdenv/setup
84+
85+buildPhase() {
86+ echo "... this is my custom build phase ..."
87+ gcc foo.c -o foo
88+}
89+
90+installPhase() {
91+ mkdir -p $out/bin
92+ cp foo $out/bin
93+}
94+
95+genericBuild
96+```
97+
98+## Tools provided by `stdenv` {#sec-tools-of-stdenv}
99+
100+The standard environment provides the following packages:
101+
102+- The GNU C Compiler, configured with C and C++ support.
103+- GNU coreutils (contains a few dozen standard Unix commands).
104+- GNU findutils (contains `find`).
105+- GNU diffutils (contains `diff`, `cmp`).
106+- GNU `sed`.
107+- GNU `grep`.
108+- GNU `awk`.
109+- GNU `tar`.
110+- `gzip`, `bzip2` and `xz`.
111+- GNU Make.
112+- Bash. This is the shell used for all builders in the Nix Packages collection. Not using `/bin/sh` removes a large source of portability problems.
113+- The `patch` command.
114+
115+On Linux, `stdenv` also includes the `patchelf` utility.
116+
117+## Specifying dependencies {#ssec-stdenv-dependencies}
118+
119+As described in the Nix manual, almost any `*.drv` store path in a derivation’s attribute set will induce a dependency on that derivation. `mkDerivation`, however, takes a few attributes intended to include all the dependencies of a package. This is done both for structure and consistency, but also so that certain other setup can take place. For example, certain dependencies need their bin directories added to the `PATH`. That is built-in, but other setup is done via a pluggable mechanism that works in conjunction with these dependency attributes. See [](#ssec-setup-hooks) for details.
120+
121+Dependencies can be broken down along three axes: their host and target platforms relative to the new derivation’s, and whether they are propagated. The platform distinctions are motivated by cross compilation; see [](#chap-cross) for exactly what each platform means. [^footnote-stdenv-ignored-build-platform] But even if one is not cross compiling, the platforms imply whether or not the dependency is needed at run-time or build-time, a concept that makes perfect sense outside of cross compilation. By default, the run-time/build-time distinction is just a hint for mental clarity, but with `strictDeps` set it is mostly enforced even in the native case.
122+
123+The extension of `PATH` with dependencies, alluded to above, proceeds according to the relative platforms alone. The process is carried out only for dependencies whose host platform matches the new derivation’s build platform i.e. dependencies which run on the platform where the new derivation will be built. [^footnote-stdenv-native-dependencies-in-path] For each dependency \<dep\> of those dependencies, `dep/bin`, if present, is added to the `PATH` environment variable.
124+
125+A dependency is said to be **propagated** when some of its other-transitive (non-immediate) downstream dependencies also need it as an immediate dependency.
126+[^footnote-stdenv-propagated-dependencies]
127+
128+It is important to note that dependencies are not necessarily propagated as the same sort of dependency that they were before, but rather as the corresponding sort so that the platform rules still line up. To determine the exact rules for dependency propagation, we start by assigning to each dependency a couple of ternary numbers (`-1` for `build`, `0` for `host`, and `1` for `target`) representing its [dependency type](#possible-dependency-types), which captures how its host and target platforms are each "offset" from the depending derivation’s host and target platforms. The following table summarize the different combinations that can be obtained:
129+
130+| `host → target` | attribute name | offset |
131+| ------------------- | ------------------- | -------- |
132+| `build --> build` | `depsBuildBuild` | `-1, -1` |
133+| `build --> host` | `nativeBuildInputs` | `-1, 0` |
134+| `build --> target` | `depsBuildTarget` | `-1, 1` |
135+| `host --> host` | `depsHostHost` | `0, 0` |
136+| `host --> target` | `buildInputs` | `0, 1` |
137+| `target --> target` | `depsTargetTarget` | `1, 1` |
138+
139+Algorithmically, we traverse propagated inputs, accumulating every propagated dependency’s propagated dependencies and adjusting them to account for the “shift in perspective” described by the current dependency’s platform offsets. This results is sort of a transitive closure of the dependency relation, with the offsets being approximately summed when two dependency links are combined. We also prune transitive dependencies whose combined offsets go out-of-bounds, which can be viewed as a filter over that transitive closure removing dependencies that are blatantly absurd.
140+
141+We can define the process precisely with [Natural Deduction](https://en.wikipedia.org/wiki/Natural_deduction) using the inference rules. This probably seems a bit obtuse, but so is the bash code that actually implements it! [^footnote-stdenv-find-inputs-location] They’re confusing in very different ways so… hopefully if something doesn’t make sense in one presentation, it will in the other!
142+
143+```
144+let mapOffset(h, t, i) = i + (if i <= 0 then h else t - 1)
145+
146+propagated-dep(h0, t0, A, B)
147+propagated-dep(h1, t1, B, C)
148+h0 + h1 in {-1, 0, 1}
149+h0 + t1 in {-1, 0, 1}
150+-------------------------------------- Transitive property
151+propagated-dep(mapOffset(h0, t0, h1),
152+ mapOffset(h0, t0, t1),
153+ A, C)
154+```
155+
156+```
157+let mapOffset(h, t, i) = i + (if i <= 0 then h else t - 1)
158+
159+dep(h0, _, A, B)
160+propagated-dep(h1, t1, B, C)
161+h0 + h1 in {-1, 0, 1}
162+h0 + t1 in {-1, 0, -1}
163+----------------------------- Take immediate dependencies' propagated dependencies
164+propagated-dep(mapOffset(h0, t0, h1),
165+ mapOffset(h0, t0, t1),
166+ A, C)
167+```
168+
169+```
170+propagated-dep(h, t, A, B)
171+----------------------------- Propagated dependencies count as dependencies
172+dep(h, t, A, B)
173+```
174+
175+Some explanation of this monstrosity is in order. In the common case, the target offset of a dependency is the successor to the target offset: `t = h + 1`. That means that:
176+
177+```
178+let f(h, t, i) = i + (if i <= 0 then h else t - 1)
179+let f(h, h + 1, i) = i + (if i <= 0 then h else (h + 1) - 1)
180+let f(h, h + 1, i) = i + (if i <= 0 then h else h)
181+let f(h, h + 1, i) = i + h
182+```
183+
184+This is where “sum-like” comes in from above: We can just sum all of the host offsets to get the host offset of the transitive dependency. The target offset is the transitive dependency is simply the host offset + 1, just as it was with the dependencies composed to make this transitive one; it can be ignored as it doesn’t add any new information.
185+
186+Because of the bounds checks, the uncommon cases are `h = t` and `h + 2 = t`. In the former case, the motivation for `mapOffset` is that since its host and target platforms are the same, no transitive dependency of it should be able to “discover” an offset greater than its reduced target offsets. `mapOffset` effectively “squashes” all its transitive dependencies’ offsets so that none will ever be greater than the target offset of the original `h = t` package. In the other case, `h + 1` is skipped over between the host and target offsets. Instead of squashing the offsets, we need to “rip” them apart so no transitive dependencies’ offset is that one.
187+
188+Overall, the unifying theme here is that propagation shouldn’t be introducing transitive dependencies involving platforms the depending package is unaware of. \[One can imagine the dependending package asking for dependencies with the platforms it knows about; other platforms it doesn’t know how to ask for. The platform description in that scenario is a kind of unforagable capability.\] The offset bounds checking and definition of `mapOffset` together ensure that this is the case. Discovering a new offset is discovering a new platform, and since those platforms weren’t in the derivation “spec” of the needing package, they cannot be relevant. From a capability perspective, we can imagine that the host and target platforms of a package are the capabilities a package requires, and the depending package must provide the capability to the dependency.
189+
190+### Variables specifying dependencies {#variables-specifying-dependencies}
191+
192+#### `depsBuildBuild` {#var-stdenv-depsBuildBuild}
193+
194+A list of dependencies whose host and target platforms are the new derivation’s build platform. These are programs and libraries used at build time that produce programs and libraries also used at build time. If the dependency doesn’t care about the target platform (i.e. isn’t a compiler or similar tool), put it in `nativeBuildInputs` instead. The most common use of this `buildPackages.stdenv.cc`, the default C compiler for this role. That example crops up more than one might think in old commonly used C libraries.
195+
196+Since these packages are able to be run at build-time, they are always added to the `PATH`, as described above. But since these packages are only guaranteed to be able to run then, they shouldn’t persist as run-time dependencies. This isn’t currently enforced, but could be in the future.
197+
198+#### `nativeBuildInputs` {#var-stdenv-nativeBuildInputs}
199+
200+A list of dependencies whose host platform is the new derivation’s build platform, and target platform is the new derivation’s host platform. These are programs and libraries used at build-time that, if they are a compiler or similar tool, produce code to run at run-time—i.e. tools used to build the new derivation. If the dependency doesn’t care about the target platform (i.e. isn’t a compiler or similar tool), put it here, rather than in `depsBuildBuild` or `depsBuildTarget`. This could be called `depsBuildHost` but `nativeBuildInputs` is used for historical continuity.
201+
202+Since these packages are able to be run at build-time, they are added to the `PATH`, as described above. But since these packages are only guaranteed to be able to run then, they shouldn’t persist as run-time dependencies. This isn’t currently enforced, but could be in the future.
203+
204+#### `depsBuildTarget` {#var-stdenv-depsBuildTarget}
205+
206+A list of dependencies whose host platform is the new derivation’s build platform, and target platform is the new derivation’s target platform. These are programs used at build time that produce code to run with code produced by the depending package. Most commonly, these are tools used to build the runtime or standard library that the currently-being-built compiler will inject into any code it compiles. In many cases, the currently-being-built-compiler is itself employed for that task, but when that compiler won’t run (i.e. its build and host platform differ) this is not possible. Other times, the compiler relies on some other tool, like binutils, that is always built separately so that the dependency is unconditional.
207+
208+This is a somewhat confusing concept to wrap one’s head around, and for good reason. As the only dependency type where the platform offsets, `-1` and `1`, are not adjacent integers, it requires thinking of a bootstrapping stage *two* away from the current one. It and its use-case go hand in hand and are both considered poor form: try to not need this sort of dependency, and try to avoid building standard libraries and runtimes in the same derivation as the compiler produces code using them. Instead strive to build those like a normal library, using the newly-built compiler just as a normal library would. In short, do not use this attribute unless you are packaging a compiler and are sure it is needed.
209+
210+Since these packages are able to run at build time, they are added to the `PATH`, as described above. But since these packages are only guaranteed to be able to run then, they shouldn’t persist as run-time dependencies. This isn’t currently enforced, but could be in the future.
211+
212+#### `depsHostHost` {#var-stdenv-depsHostHost}
213+
214+A list of dependencies whose host and target platforms match the new derivation’s host platform. In practice, this would usually be tools used by compilers for macros or a metaprogramming system, or libraries used by the macros or metaprogramming code itself. It’s always preferable to use a `depsBuildBuild` dependency in the derivation being built over a `depsHostHost` on the tool doing the building for this purpose.
215+
216+#### `buildInputs` {#var-stdenv-buildInputs}
217+
218+A list of dependencies whose host platform and target platform match the new derivation’s. This would be called `depsHostTarget` but for historical continuity. If the dependency doesn’t care about the target platform (i.e. isn’t a compiler or similar tool), put it here, rather than in `depsBuildBuild`.
219+
220+These are often programs and libraries used by the new derivation at *run*-time, but that isn’t always the case. For example, the machine code in a statically-linked library is only used at run-time, but the derivation containing the library is only needed at build-time. Even in the dynamic case, the library may also be needed at build-time to appease the linker.
221+
222+#### `depsTargetTarget` {#var-stdenv-depsTargetTarget}
223+
224+A list of dependencies whose host platform matches the new derivation’s target platform. These are packages that run on the target platform, e.g. the standard library or run-time deps of standard library that a compiler insists on knowing about. It’s poor form in almost all cases for a package to depend on another from a future stage \[future stage corresponding to positive offset\]. Do not use this attribute unless you are packaging a compiler and are sure it is needed.
225+
226+#### `depsBuildBuildPropagated` {#var-stdenv-depsBuildBuildPropagated}
227+
228+The propagated equivalent of `depsBuildBuild`. This perhaps never ought to be used, but it is included for consistency \[see below for the others\].
229+
230+#### `propagatedNativeBuildInputs` {#var-stdenv-propagatedNativeBuildInputs}
231+
232+The propagated equivalent of `nativeBuildInputs`. This would be called `depsBuildHostPropagated` but for historical continuity. For example, if package `Y` has `propagatedNativeBuildInputs = [X]`, and package `Z` has `buildInputs = [Y]`, then package `Z` will be built as if it included package `X` in its `nativeBuildInputs`. If instead, package `Z` has `nativeBuildInputs = [Y]`, then `Z` will be built as if it included `X` in the `depsBuildBuild` of package `Z`, because of the sum of the two `-1` host offsets.
233+
234+#### `depsBuildTargetPropagated` {#var-stdenv-depsBuildTargetPropagated}
235+
236+The propagated equivalent of `depsBuildTarget`. This is prefixed for the same reason of alerting potential users.
237+
238+#### `depsHostHostPropagated` {#var-stdenv-depsHostHostPropagated}
239+
240+The propagated equivalent of `depsHostHost`.
241+
242+#### `propagatedBuildInputs` {#var-stdenv-propagatedBuildInputs}
243+
244+The propagated equivalent of `buildInputs`. This would be called `depsHostTargetPropagated` but for historical continuity.
245+
246+#### `depsTargetTargetPropagated` {#var-stdenv-depsTargetTargetPropagated}
247+
248+The propagated equivalent of `depsTargetTarget`. This is prefixed for the same reason of alerting potential users.
249+
250+## Attributes {#ssec-stdenv-attributes}
251+
252+### Variables affecting `stdenv` initialisation {#variables-affecting-stdenv-initialisation}
253+
254+#### `NIX_DEBUG` {#var-stdenv-NIX_DEBUG}
255+
256+A natural number indicating how much information to log. If set to 1 or higher, `stdenv` will print moderate debugging information during the build. In particular, the `gcc` and `ld` wrapper scripts will print out the complete command line passed to the wrapped tools. If set to 6 or higher, the `stdenv` setup script will be run with `set -x` tracing. If set to 7 or higher, the `gcc` and `ld` wrapper scripts will also be run with `set -x` tracing.
257+
258+### Attributes affecting build properties {#attributes-affecting-build-properties}
259+
260+#### `enableParallelBuilding` {#var-stdenv-enableParallelBuilding}
261+
262+If set to `true`, `stdenv` will pass specific flags to `make` and other build tools to enable parallel building with up to `build-cores` workers.
263+
264+Unless set to `false`, some build systems with good support for parallel building including `cmake`, `meson`, and `qmake` will set it to `true`.
265+
266+### Special variables {#special-variables}
267+
268+#### `passthru` {#var-stdenv-passthru}
269+
270+This is an attribute set which can be filled with arbitrary values. For example:
271+
272+```nix
273+passthru = {
274+ foo = "bar";
275+ baz = {
276+ value1 = 4;
277+ value2 = 5;
278+ };
279+}
280+```
281+
282+Values inside it are not passed to the builder, so you can change them without triggering a rebuild. However, they can be accessed outside of a derivation directly, as if they were set inside a derivation itself, e.g. `hello.baz.value1`. We don’t specify any usage or schema of `passthru` - it is meant for values that would be useful outside the derivation in other parts of a Nix expression (e.g. in other derivations). An example would be to convey some specific dependency of your derivation which contains a program with plugins support. Later, others who make derivations with plugins can use passed-through dependency to ensure that their plugin would be binary-compatible with built program.
283+
284+#### `passthru.updateScript` {#var-passthru-updateScript}
285+
286+A script to be run by `maintainers/scripts/update.nix` when the package is matched. It needs to be an executable file, either on the file system:
287+
288+```nix
289+passthru.updateScript = ./update.sh;
290+```
291+
292+or inside the expression itself:
293+
294+```nix
295+passthru.updateScript = writeScript "update-zoom-us" ''
296+ #!/usr/bin/env nix-shell
297+ #!nix-shell -i bash -p curl pcre common-updater-scripts
298+
299+ set -eu -o pipefail
300+
301+ version="$(curl -sI https://zoom.us/client/latest/zoom_x86_64.tar.xz | grep -Fi 'Location:' | pcregrep -o1 '/(([0-9]\.?)+)/')"
302+ update-source-version zoom-us "$version"
303+'';
304+```
305+
306+The attribute can also contain a list, a script followed by arguments to be passed to it:
307+
308+```nix
309+passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ];
310+```
311+
312+The script will be run with `UPDATE_NIX_ATTR_PATH` environment variable set to the attribute path it is supposed to update.
313+
314+::: {.note}
315+The script will be usually run from the root of the Nixpkgs repository but you should not rely on that. Also note that the update scripts will be run in parallel by default; you should avoid running `git commit` or any other commands that cannot handle that.
316+:::
317+
318+For information about how to run the updates, execute `nix-shell maintainers/scripts/update.nix`.
319+
320+### Recursive attributes in `mkDerivation`
321+
322+If you pass a function to `mkDerivation`, it will receive as its argument the final arguments, including the overrides when reinvoked via `overrideAttrs`. For example:
323+
324+```nix
325+mkDerivation (finalAttrs: {
326+ pname = "hello";
327+ withFeature = true;
328+ configureFlags =
329+ lib.optionals finalAttrs.withFeature ["--with-feature"];
330+})
331+```
332+
333+Note that this does not use the `rec` keyword to reuse `withFeature` in `configureFlags`.
334+The `rec` keyword works at the syntax level and is unaware of overriding.
335+
336+Instead, the definition references `finalAttrs`, allowing users to change `withFeature`
337+consistently with `overrideAttrs`.
338+
339+`finalAttrs` also contains the attribute `finalPackage`, which includes the output paths, etc.
340+
341+Let's look at a more elaborate example to understand the differences between
342+various bindings:
343+
344+```nix
345+# `pkg` is the _original_ definition (for illustration purposes)
346+let pkg =
347+ mkDerivation (finalAttrs: {
348+ # ...
349+
350+ # An example attribute
351+ packages = [];
352+
353+ # `passthru.tests` is a commonly defined attribute.
354+ passthru.tests.simple = f finalAttrs.finalPackage;
355+
356+ # An example of an attribute containing a function
357+ passthru.appendPackages = packages':
358+ finalAttrs.finalPackage.overrideAttrs (newSelf: super: {
359+ packages = super.packages ++ packages';
360+ });
361+
362+ # For illustration purposes; referenced as
363+ # `(pkg.overrideAttrs(x)).finalAttrs` etc in the text below.
364+ passthru.finalAttrs = finalAttrs;
365+ passthru.original = pkg;
366+ });
367+in pkg
368+```
369+
370+Unlike the `pkg` binding in the above example, the `finalAttrs` parameter always references the final attributes. For instance `(pkg.overrideAttrs(x)).finalAttrs.finalPackage` is identical to `pkg.overrideAttrs(x)`, whereas `(pkg.overrideAttrs(x)).original` is the same as the original `pkg`.
371+
372+See also the section about [`passthru.tests`](#var-meta-tests).
373+
374+## Phases {#sec-stdenv-phases}
375+
376+`stdenv.mkDerivation` sets the Nix [derivation](https://nixos.org/manual/nix/stable/expressions/derivations.html#derivations)'s builder to a script that loads the stdenv `setup.sh` bash library and calls `genericBuild`. Most packaging functions rely on this default builder.
377+
378+This generic command invokes a number of *phases*. Package builds are split into phases to make it easier to override specific parts of the build (e.g., unpacking the sources or installing the binaries).
379+
380+Each phase can be overridden in its entirety either by setting the environment variable `namePhase` to a string containing some shell commands to be executed, or by redefining the shell function `namePhase`. The former is convenient to override a phase from the derivation, while the latter is convenient from a build script. However, typically one only wants to *add* some commands to a phase, e.g. by defining `postInstall` or `preFixup`, as skipping some of the default actions may have unexpected consequences. The default script for each phase is defined in the file `pkgs/stdenv/generic/setup.sh`.
381+
382+When overriding a phase, for example `installPhase`, it is important to start with `runHook preInstall` and end it with `runHook postInstall`, otherwise `preInstall` and `postInstall` will not be run. Even if you don't use them directly, it is good practice to do so anyways for downstream users who would want to add a `postInstall` by overriding your derivation.
383+
384+While inside an interactive `nix-shell`, if you wanted to run all phases in the order they would be run in an actual build, you can invoke `genericBuild` yourself.
385+
386+### Controlling phases {#ssec-controlling-phases}
387+
388+There are a number of variables that control what phases are executed and in what order:
389+
390+#### Variables affecting phase control {#variables-affecting-phase-control}
391+
392+##### `phases` {#var-stdenv-phases}
393+
394+Specifies the phases. You can change the order in which phases are executed, or add new phases, by setting this variable. If it’s not set, the default value is used, which is `$prePhases unpackPhase patchPhase $preConfigurePhases configurePhase $preBuildPhases buildPhase checkPhase $preInstallPhases installPhase fixupPhase installCheckPhase $preDistPhases distPhase $postPhases`.
395+
396+It is discouraged to set this variable, as it is easy to miss some important functionality hidden in some of the less obviously needed phases (like `fixupPhase` which patches the shebang of scripts).
397+Usually, if you just want to add a few phases, it’s more convenient to set one of the variables below (such as `preInstallPhases`).
398+
399+##### `prePhases` {#var-stdenv-prePhases}
400+
401+Additional phases executed before any of the default phases.
402+
403+##### `preConfigurePhases` {#var-stdenv-preConfigurePhases}
404+
405+Additional phases executed just before the configure phase.
406+
407+##### `preBuildPhases` {#var-stdenv-preBuildPhases}
408+
409+Additional phases executed just before the build phase.
410+
411+##### `preInstallPhases` {#var-stdenv-preInstallPhases}
412+
413+Additional phases executed just before the install phase.
414+
415+##### `preFixupPhases` {#var-stdenv-preFixupPhases}
416+
417+Additional phases executed just before the fixup phase.
418+
419+##### `preDistPhases` {#var-stdenv-preDistPhases}
420+
421+Additional phases executed just before the distribution phase.
422+
423+##### `postPhases` {#var-stdenv-postPhases}
424+
425+Additional phases executed after any of the default phases.
426+
427+### The unpack phase {#ssec-unpack-phase}
428+
429+The unpack phase is responsible for unpacking the source code of the package. The default implementation of `unpackPhase` unpacks the source files listed in the `src` environment variable to the current directory. It supports the following files by default:
430+
431+#### Tar files {#tar-files}
432+
433+These can optionally be compressed using `gzip` (`.tar.gz`, `.tgz` or `.tar.Z`), `bzip2` (`.tar.bz2`, `.tbz2` or `.tbz`) or `xz` (`.tar.xz`, `.tar.lzma` or `.txz`).
434+
435+#### Zip files {#zip-files}
436+
437+Zip files are unpacked using `unzip`. However, `unzip` is not in the standard environment, so you should add it to `nativeBuildInputs` yourself.
438+
439+#### Directories in the Nix store {#directories-in-the-nix-store}
440+
441+These are simply copied to the current directory. The hash part of the file name is stripped, e.g. `/nix/store/1wydxgby13cz...-my-sources` would be copied to `my-sources`.
442+
443+Additional file types can be supported by setting the `unpackCmd` variable (see below).
444+
445+#### Variables controlling the unpack phase {#variables-controlling-the-unpack-phase}
446+
447+##### `srcs` / `src` {#var-stdenv-src}
448+
449+The list of source files or directories to be unpacked or copied. One of these must be set. Note that if you use `srcs`, you should also set `sourceRoot` or `setSourceRoot`.
450+
451+##### `sourceRoot` {#var-stdenv-sourceRoot}
452+
453+After running `unpackPhase`, the generic builder changes the current directory to the directory created by unpacking the sources. If there are multiple source directories, you should set `sourceRoot` to the name of the intended directory. Set `sourceRoot = ".";` if you use `srcs` and control the unpack phase yourself.
454+
455+##### `setSourceRoot` {#var-stdenv-setSourceRoot}
456+
457+Alternatively to setting `sourceRoot`, you can set `setSourceRoot` to a shell command to be evaluated by the unpack phase after the sources have been unpacked. This command must set `sourceRoot`.
458+
459+##### `preUnpack` {#var-stdenv-preUnpack}
460+
461+Hook executed at the start of the unpack phase.
462+
463+##### `postUnpack` {#var-stdenv-postUnpack}
464+
465+Hook executed at the end of the unpack phase.
466+
467+##### `dontUnpack` {#var-stdenv-dontUnpack}
468+
469+Set to true to skip the unpack phase.
470+
471+##### `dontMakeSourcesWritable` {#var-stdenv-dontMakeSourcesWritable}
472+
473+If set to `1`, the unpacked sources are *not* made writable. By default, they are made writable to prevent problems with read-only sources. For example, copied store directories would be read-only without this.
474+
475+##### `unpackCmd` {#var-stdenv-unpackCmd}
476+
477+The unpack phase evaluates the string `$unpackCmd` for any unrecognised file. The path to the current source file is contained in the `curSrc` variable.
478+
479+### The patch phase {#ssec-patch-phase}
480+
481+The patch phase applies the list of patches defined in the `patches` variable.
482+
483+#### Variables controlling the patch phase {#variables-controlling-the-patch-phase}
484+
485+##### `dontPatch` {#var-stdenv-dontPatch}
486+
487+Set to true to skip the patch phase.
488+
489+##### `patches` {#var-stdenv-patches}
490+
491+The list of patches. They must be in the format accepted by the `patch` command, and may optionally be compressed using `gzip` (`.gz`), `bzip2` (`.bz2`) or `xz` (`.xz`).
492+
493+##### `patchFlags` {#var-stdenv-patchFlags}
494+
495+Flags to be passed to `patch`. If not set, the argument `-p1` is used, which causes the leading directory component to be stripped from the file names in each patch.
496+
497+##### `prePatch` {#var-stdenv-prePatch}
498+
499+Hook executed at the start of the patch phase.
500+
501+##### `postPatch` {#var-stdenv-postPatch}
502+
503+Hook executed at the end of the patch phase.
504+
505+### The configure phase {#ssec-configure-phase}
506+
507+The configure phase prepares the source tree for building. The default `configurePhase` runs `./configure` (typically an Autoconf-generated script) if it exists.
508+
509+#### Variables controlling the configure phase {#variables-controlling-the-configure-phase}
510+
511+##### `configureScript` {#var-stdenv-configureScript}
512+
513+The name of the configure script. It defaults to `./configure` if it exists; otherwise, the configure phase is skipped. This can actually be a command (like `perl ./Configure.pl`).
514+
515+##### `configureFlags` {#var-stdenv-configureFlags}
516+
517+A list of strings passed as additional arguments to the configure script.
518+
519+##### `dontConfigure` {#var-stdenv-dontConfigure}
520+
521+Set to true to skip the configure phase.
522+
523+##### `configureFlagsArray` {#var-stdenv-configureFlagsArray}
524+
525+A shell array containing additional arguments passed to the configure script. You must use this instead of `configureFlags` if the arguments contain spaces.
526+
527+##### `dontAddPrefix` {#var-stdenv-dontAddPrefix}
528+
529+By default, the flag `--prefix=$prefix` is added to the configure flags. If this is undesirable, set this variable to true.
530+
531+##### `prefix` {#var-stdenv-prefix}
532+
533+The prefix under which the package must be installed, passed via the `--prefix` option to the configure script. It defaults to `$out`.
534+
535+##### `prefixKey` {#var-stdenv-prefixKey}
536+
537+The key to use when specifying the prefix. By default, this is set to `--prefix=` as that is used by the majority of packages.
538+
539+##### `dontAddStaticConfigureFlags`
540+
541+By default, when building statically, stdenv will try to add build system appropriate configure flags to try to enable static builds.
542+
543+If this is undesirable, set this variable to true.
544+
545+##### `dontAddDisableDepTrack` {#var-stdenv-dontAddDisableDepTrack}
546+
547+By default, the flag `--disable-dependency-tracking` is added to the configure flags to speed up Automake-based builds. If this is undesirable, set this variable to true.
548+
549+##### `dontFixLibtool` {#var-stdenv-dontFixLibtool}
550+
551+By default, the configure phase applies some special hackery to all files called `ltmain.sh` before running the configure script in order to improve the purity of Libtool-based packages [^footnote-stdenv-sys-lib-search-path] . If this is undesirable, set this variable to true.
552+
553+##### `dontDisableStatic` {#var-stdenv-dontDisableStatic}
554+
555+By default, when the configure script has `--enable-static`, the option `--disable-static` is added to the configure flags.
556+
557+If this is undesirable, set this variable to true. It is automatically set to true when building statically, for example through `pkgsStatic`.
558+
559+##### `configurePlatforms` {#var-stdenv-configurePlatforms}
560+
561+By default, when cross compiling, the configure script has `--build=...` and `--host=...` passed. Packages can instead pass `[ "build" "host" "target" ]` or a subset to control exactly which platform flags are passed. Compilers and other tools can use this to also pass the target platform. [^footnote-stdenv-build-time-guessing-impurity]
562+
563+##### `preConfigure` {#var-stdenv-preConfigure}
564+
565+Hook executed at the start of the configure phase.
566+
567+##### `postConfigure` {#var-stdenv-postConfigure}
568+
569+Hook executed at the end of the configure phase.
570+
571+### The build phase {#build-phase}
572+
573+The build phase is responsible for actually building the package (e.g. compiling it). The default `buildPhase` simply calls `make` if a file named `Makefile`, `makefile` or `GNUmakefile` exists in the current directory (or the `makefile` is explicitly set); otherwise it does nothing.
574+
575+#### Variables controlling the build phase {#variables-controlling-the-build-phase}
576+
577+##### `dontBuild` {#var-stdenv-dontBuild}
578+
579+Set to true to skip the build phase.
580+
581+##### `makefile` {#var-stdenv-makefile}
582+
583+The file name of the Makefile.
584+
585+##### `makeFlags` {#var-stdenv-makeFlags}
586+
587+A list of strings passed as additional flags to `make`. These flags are also used by the default install and check phase. For setting make flags specific to the build phase, use `buildFlags` (see below).
588+
589+```nix
590+makeFlags = [ "PREFIX=$(out)" ];
591+```
592+
593+::: {.note}
594+The flags are quoted in bash, but environment variables can be specified by using the make syntax.
595+:::
596+
597+##### `makeFlagsArray` {#var-stdenv-makeFlagsArray}
598+
599+A shell array containing additional arguments passed to `make`. You must use this instead of `makeFlags` if the arguments contain spaces, e.g.
600+
601+```nix
602+preBuild = ''
603+ makeFlagsArray+=(CFLAGS="-O0 -g" LDFLAGS="-lfoo -lbar")
604+'';
605+```
606+
607+Note that shell arrays cannot be passed through environment variables, so you cannot set `makeFlagsArray` in a derivation attribute (because those are passed through environment variables): you have to define them in shell code.
608+
609+##### `buildFlags` / `buildFlagsArray` {#var-stdenv-buildFlags}
610+
611+A list of strings passed as additional flags to `make`. Like `makeFlags` and `makeFlagsArray`, but only used by the build phase.
612+
613+##### `preBuild` {#var-stdenv-preBuild}
614+
615+Hook executed at the start of the build phase.
616+
617+##### `postBuild` {#var-stdenv-postBuild}
618+
619+Hook executed at the end of the build phase.
620+
621+You can set flags for `make` through the `makeFlags` variable.
622+
623+Before and after running `make`, the hooks `preBuild` and `postBuild` are called, respectively.
624+
625+### The check phase {#ssec-check-phase}
626+
627+The check phase checks whether the package was built correctly by running its test suite. The default `checkPhase` calls `make check`, but only if the `doCheck` variable is enabled.
628+
629+#### Variables controlling the check phase {#variables-controlling-the-check-phase}
630+
631+##### `doCheck` {#var-stdenv-doCheck}
632+
633+Controls whether the check phase is executed. By default it is skipped, but if `doCheck` is set to true, the check phase is usually executed. Thus you should set
634+
635+```nix
636+doCheck = true;
637+```
638+
639+in the derivation to enable checks. The exception is cross compilation. Cross compiled builds never run tests, no matter how `doCheck` is set, as the newly-built program won’t run on the platform used to build it.
640+
641+##### `makeFlags` / `makeFlagsArray` / `makefile` {#makeflags-makeflagsarray-makefile}
642+
643+See the [build phase](#var-stdenv-makeFlags) for details.
644+
645+##### `checkTarget` {#var-stdenv-checkTarget}
646+
647+The make target that runs the tests. Defaults to `check`.
648+
649+##### `checkFlags` / `checkFlagsArray` {#var-stdenv-checkFlags}
650+
651+A list of strings passed as additional flags to `make`. Like `makeFlags` and `makeFlagsArray`, but only used by the check phase.
652+
653+##### `checkInputs` {#var-stdenv-checkInputs}
654+
655+A list of dependencies used by the phase. This gets included in `nativeBuildInputs` when `doCheck` is set.
656+
657+##### `preCheck` {#var-stdenv-preCheck}
658+
659+Hook executed at the start of the check phase.
660+
661+##### `postCheck` {#var-stdenv-postCheck}
662+
663+Hook executed at the end of the check phase.
664+
665+### The install phase {#ssec-install-phase}
666+
667+The install phase is responsible for installing the package in the Nix store under `out`. The default `installPhase` creates the directory `$out` and calls `make install`.
668+
669+#### Variables controlling the install phase {#variables-controlling-the-install-phase}
670+
671+##### `dontInstall` {#var-stdenv-dontInstall}
672+
673+Set to true to skip the install phase.
674+
675+##### `makeFlags` / `makeFlagsArray` / `makefile` {#makeflags-makeflagsarray-makefile-1}
676+
677+See the [build phase](#var-stdenv-makeFlags) for details.
678+
679+##### `installTargets` {#var-stdenv-installTargets}
680+
681+The make targets that perform the installation. Defaults to `install`. Example:
682+
683+```nix
684+installTargets = "install-bin install-doc";
685+```
686+
687+##### `installFlags` / `installFlagsArray` {#var-stdenv-installFlags}
688+
689+A list of strings passed as additional flags to `make`. Like `makeFlags` and `makeFlagsArray`, but only used by the install phase.
690+
691+##### `preInstall` {#var-stdenv-preInstall}
692+
693+Hook executed at the start of the install phase.
694+
695+##### `postInstall` {#var-stdenv-postInstall}
696+
697+Hook executed at the end of the install phase.
698+
699+### The fixup phase {#ssec-fixup-phase}
700+
701+The fixup phase performs some (Nix-specific) post-processing actions on the files installed under `$out` by the install phase. The default `fixupPhase` does the following:
702+
703+- It moves the `man/`, `doc/` and `info/` subdirectories of `$out` to `share/`.
704+- It strips libraries and executables of debug information.
705+- On Linux, it applies the `patchelf` command to ELF executables and libraries to remove unused directories from the `RPATH` in order to prevent unnecessary runtime dependencies.
706+- It rewrites the interpreter paths of shell scripts to paths found in `PATH`. E.g., `/usr/bin/perl` will be rewritten to `/nix/store/some-perl/bin/perl` found in `PATH`.
707+
708+#### Variables controlling the fixup phase {#variables-controlling-the-fixup-phase}
709+
710+##### `dontFixup` {#var-stdenv-dontFixup}
711+
712+Set to true to skip the fixup phase.
713+
714+##### `dontStrip` {#var-stdenv-dontStrip}
715+
716+If set, libraries and executables are not stripped. By default, they are.
717+
718+##### `dontStripHost` {#var-stdenv-dontStripHost}
719+
720+Like `dontStrip`, but only affects the `strip` command targetting the package’s host platform. Useful when supporting cross compilation, but otherwise feel free to ignore.
721+
722+##### `dontStripTarget` {#var-stdenv-dontStripTarget}
723+
724+Like `dontStrip`, but only affects the `strip` command targetting the packages’ target platform. Useful when supporting cross compilation, but otherwise feel free to ignore.
725+
726+##### `dontMoveSbin` {#var-stdenv-dontMoveSbin}
727+
728+If set, files in `$out/sbin` are not moved to `$out/bin`. By default, they are.
729+
730+##### `stripAllList` {#var-stdenv-stripAllList}
731+
732+List of directories to search for libraries and executables from which *all* symbols should be stripped. By default, it’s empty. Stripping all symbols is risky, since it may remove not just debug symbols but also ELF information necessary for normal execution.
733+
734+##### `stripAllFlags` {#var-stdenv-stripAllFlags}
735+
736+Flags passed to the `strip` command applied to the files in the directories listed in `stripAllList`. Defaults to `-s` (i.e. `--strip-all`).
737+
738+##### `stripDebugList` {#var-stdenv-stripDebugList}
739+
740+List of directories to search for libraries and executables from which only debugging-related symbols should be stripped. It defaults to `lib lib32 lib64 libexec bin sbin`.
741+
742+##### `stripDebugFlags` {#var-stdenv-stripDebugFlags}
743+
744+Flags passed to the `strip` command applied to the files in the directories listed in `stripDebugList`. Defaults to `-S` (i.e. `--strip-debug`).
745+
746+##### `dontPatchELF` {#var-stdenv-dontPatchELF}
747+
748+If set, the `patchelf` command is not used to remove unnecessary `RPATH` entries. Only applies to Linux.
749+
750+##### `dontPatchShebangs` {#var-stdenv-dontPatchShebangs}
751+
752+If set, scripts starting with `#!` do not have their interpreter paths rewritten to paths in the Nix store.
753+
754+##### `dontPruneLibtoolFiles` {#var-stdenv-dontPruneLibtoolFiles}
755+
756+If set, libtool `.la` files associated with shared libraries won’t have their `dependency_libs` field cleared.
757+
758+##### `forceShare` {#var-stdenv-forceShare}
759+
760+The list of directories that must be moved from `$out` to `$out/share`. Defaults to `man doc info`.
761+
762+##### `setupHook` {#var-stdenv-setupHook}
763+
764+A package can export a [setup hook](#ssec-setup-hooks) by setting this variable. The setup hook, if defined, is copied to `$out/nix-support/setup-hook`. Environment variables are then substituted in it using `substituteAll`.
765+
766+##### `preFixup` {#var-stdenv-preFixup}
767+
768+Hook executed at the start of the fixup phase.
769+
770+##### `postFixup` {#var-stdenv-postFixup}
771+
772+Hook executed at the end of the fixup phase.
773+
774+##### `separateDebugInfo` {#stdenv-separateDebugInfo}
775+
776+If set to `true`, the standard environment will enable debug information in C/C++ builds. After installation, the debug information will be separated from the executables and stored in the output named `debug`. (This output is enabled automatically; you don’t need to set the `outputs` attribute explicitly.) To be precise, the debug information is stored in `debug/lib/debug/.build-id/XX/YYYY…`, where \<XXYYYY…\> is the \<build ID\> of the binary — a SHA-1 hash of the contents of the binary. Debuggers like GDB use the build ID to look up the separated debug information.
777+
778+For example, with GDB, you can add
779+
780+```
781+set debug-file-directory ~/.nix-profile/lib/debug
782+```
783+
784+to `~/.gdbinit`. GDB will then be able to find debug information installed via `nix-env -i`.
785+
786+### The installCheck phase {#ssec-installCheck-phase}
787+
788+The installCheck phase checks whether the package was installed correctly by running its test suite against the installed directories. The default `installCheck` calls `make installcheck`.
789+
790+It is often better to add tests that are not part of the source distribution to `passthru.tests` (see <xref linkend="var-meta-tests"/>). This avoids adding overhead to every build and enables us to run them independently.
791+
792+#### Variables controlling the installCheck phase {#variables-controlling-the-installcheck-phase}
793+
794+##### `doInstallCheck` {#var-stdenv-doInstallCheck}
795+
796+Controls whether the installCheck phase is executed. By default it is skipped, but if `doInstallCheck` is set to true, the installCheck phase is usually executed. Thus you should set
797+
798+```nix
799+doInstallCheck = true;
800+```
801+
802+in the derivation to enable install checks. The exception is cross compilation. Cross compiled builds never run tests, no matter how `doInstallCheck` is set, as the newly-built program won’t run on the platform used to build it.
803+
804+##### `installCheckTarget` {#var-stdenv-installCheckTarget}
805+
806+The make target that runs the install tests. Defaults to `installcheck`.
807+
808+##### `installCheckFlags` / `installCheckFlagsArray` {#var-stdenv-installCheckFlags}
809+
810+A list of strings passed as additional flags to `make`. Like `makeFlags` and `makeFlagsArray`, but only used by the installCheck phase.
811+
812+##### `installCheckInputs` {#var-stdenv-installCheckInputs}
813+
814+A list of dependencies used by the phase. This gets included in `nativeBuildInputs` when `doInstallCheck` is set.
815+
816+##### `preInstallCheck` {#var-stdenv-preInstallCheck}
817+
818+Hook executed at the start of the installCheck phase.
819+
820+##### `postInstallCheck` {#var-stdenv-postInstallCheck}
821+
822+Hook executed at the end of the installCheck phase.
823+
824+### The distribution phase {#ssec-distribution-phase}
825+
826+The distribution phase is intended to produce a source distribution of the package. The default `distPhase` first calls `make dist`, then it copies the resulting source tarballs to `$out/tarballs/`. This phase is only executed if the attribute `doDist` is set.
827+
828+#### Variables controlling the distribution phase {#variables-controlling-the-distribution-phase}
829+
830+##### `distTarget` {#var-stdenv-distTarget}
831+
832+The make target that produces the distribution. Defaults to `dist`.
833+
834+##### `distFlags` / `distFlagsArray` {#var-stdenv-distFlags}
835+
836+Additional flags passed to `make`.
837+
838+##### `tarballs` {#var-stdenv-tarballs}
839+
840+The names of the source distribution files to be copied to `$out/tarballs/`. It can contain shell wildcards. The default is `*.tar.gz`.
841+
842+##### `dontCopyDist` {#var-stdenv-dontCopyDist}
843+
844+If set, no files are copied to `$out/tarballs/`.
845+
846+##### `preDist` {#var-stdenv-preDist}
847+
848+Hook executed at the start of the distribution phase.
849+
850+##### `postDist` {#var-stdenv-postDist}
851+
852+Hook executed at the end of the distribution phase.
853+
854+## Shell functions and utilities {#ssec-stdenv-functions}
855+
856+The standard environment provides a number of useful functions.
857+
858+### `makeWrapper` \<executable\> \<wrapperfile\> \<args\> {#fun-makeWrapper}
859+
860+Constructs a wrapper for a program with various possible arguments. It is defined as part of 2 setup-hooks named `makeWrapper` and `makeBinaryWrapper` that implement the same bash functions. Hence, to use it you have to add `makeWrapper` to your `nativeBuildInputs`. Here's an example usage:
861+
862+```bash
863+# adds `FOOBAR=baz` to `$out/bin/foo`’s environment
864+makeWrapper $out/bin/foo $wrapperfile --set FOOBAR baz
865+
866+# prefixes the binary paths of `hello` and `git`
867+# Be advised that paths often should be patched in directly
868+# (via string replacements or in `configurePhase`).
869+makeWrapper $out/bin/foo $wrapperfile --prefix PATH : ${lib.makeBinPath [ hello git ]}
870+```
871+
872+There’s many more kinds of arguments, they are documented in `nixpkgs/pkgs/build-support/setup-hooks/make-wrapper.sh` for the `makeWrapper` implementation and in `nixpkgs/pkgs/build-support/setup-hooks/make-binary-wrapper.sh` for the `makeBinaryWrapper` implementation.
873+
874+`wrapProgram` is a convenience function you probably want to use most of the time, implemented by both `makeWrapper` and `makeBinaryWrapper`.
875+
876+Using the `makeBinaryWrapper` implementation is usually preferred, as it creates a tiny _compiled_ wrapper executable, that can be used as a shebang interpreter. This is needed mostly on Darwin, where shebangs cannot point to scripts, [due to a limitation with the `execve`-syscall](https://stackoverflow.com/questions/67100831/macos-shebang-with-absolute-path-not-working). Compiled wrappers generated by `makeBinaryWrapper` can be inspected with `less <path-to-wrapper>` - by scrolling past the binary data you should be able to see the shell command that generated the executable and there see the environment variables that were injected into the wrapper.
877+
878+### `remove-references-to -t` \<storepath\> [ `-t` \<storepath\> ... ] \<file\> ... {#fun-remove-references-to}
879+
880+Removes the references of the specified files to the specified store files. This is done without changing the size of the file by replacing the hash by `eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee`, and should work on compiled executables. This is meant to be used to remove the dependency of the output on inputs that are known to be unnecessary at runtime. Of course, reckless usage will break the patched programs.
881+To use this, add `removeReferencesTo` to `nativeBuildInputs`.
882+
883+As `remove-references-to` is an actual executable and not a shell function, it can be used with `find`.
884+Example removing all references to the compiler in the output:
885+```nix
886+postInstall = ''
887+ find "$out" -type f -exec remove-references-to -t ${stdenv.cc} '{}' +
888+'';
889+```
890+
891+### `substitute` \<infile\> \<outfile\> \<subs\> {#fun-substitute}
892+
893+Performs string substitution on the contents of \<infile\>, writing the result to \<outfile\>. The substitutions in \<subs\> are of the following form:
894+
895+#### `--replace` \<s1\> \<s2\>
896+
897+Replace every occurrence of the string \<s1\> by \<s2\>.
898+
899+#### `--subst-var` \<varName\>
900+
901+Replace every occurrence of `@varName@` by the contents of the environment variable \<varName\>. This is useful for generating files from templates, using `@...@` in the template as placeholders.
902+
903+#### `--subst-var-by` \<varName\> \<s\>
904+
905+Replace every occurrence of `@varName@` by the string \<s\>.
906+
907+Example:
908+
909+```shell
910+substitute ./foo.in ./foo.out \
911+ --replace /usr/bin/bar $bar/bin/bar \
912+ --replace "a string containing spaces" "some other text" \
913+ --subst-var someVar
914+```
915+
916+### `substituteInPlace` \<file\> \<subs\> {#fun-substituteInPlace}
917+
918+Like `substitute`, but performs the substitutions in place on the file \<file\>.
919+
920+### `substituteAll` \<infile\> \<outfile\> {#fun-substituteAll}
921+
922+Replaces every occurrence of `@varName@`, where \<varName\> is any environment variable, in \<infile\>, writing the result to \<outfile\>. For instance, if \<infile\> has the contents
923+
924+```bash
925+#! @bash@/bin/sh
926+PATH=@coreutils@/bin
927+echo @foo@
928+```
929+
930+and the environment contains `bash=/nix/store/bmwp0q28cf21...-bash-3.2-p39` and `coreutils=/nix/store/68afga4khv0w...-coreutils-6.12`, but does not contain the variable `foo`, then the output will be
931+
932+```bash
933+#! /nix/store/bmwp0q28cf21...-bash-3.2-p39/bin/sh
934+PATH=/nix/store/68afga4khv0w...-coreutils-6.12/bin
935+echo @foo@
936+```
937+
938+That is, no substitution is performed for undefined variables.
939+
940+Environment variables that start with an uppercase letter or an underscore are filtered out, to prevent global variables (like `HOME`) or private variables (like `__ETC_PROFILE_DONE`) from accidentally getting substituted. The variables also have to be valid bash "names", as defined in the bash manpage (alphanumeric or `_`, must not start with a number).
941+
942+### `substituteAllInPlace` \<file\> {#fun-substituteAllInPlace}
943+
944+Like `substituteAll`, but performs the substitutions in place on the file \<file\>.
945+
946+### `stripHash` \<path\> {#fun-stripHash}
947+
948+Strips the directory and hash part of a store path, outputting the name part to `stdout`. For example:
949+
950+```bash
951+# prints coreutils-8.24
952+stripHash "/nix/store/9s9r019176g7cvn2nvcw41gsp862y6b4-coreutils-8.24"
953+```
954+
955+If you wish to store the result in another variable, then the following idiom may be useful:
956+
957+```bash
958+name="/nix/store/9s9r019176g7cvn2nvcw41gsp862y6b4-coreutils-8.24"
959+someVar=$(stripHash $name)
960+```
961+
962+### `wrapProgram` \<executable\> \<makeWrapperArgs\> {#fun-wrapProgram}
963+
964+Convenience function for `makeWrapper` that replaces `<\executable\>` with a wrapper that executes the original program. It takes all the same arguments as `makeWrapper`, except for `--inherit-argv0` (used by the `makeBinaryWrapper` implementation) and `--argv0` (used by both `makeWrapper` and `makeBinaryWrapper` wrapper implementations).
965+
966+If you will apply it multiple times, it will overwrite the wrapper file and you will end up with double wrapping, which should be avoided.
967+
968+## Package setup hooks {#ssec-setup-hooks}
969+
970+Nix itself considers a build-time dependency as merely something that should previously be built and accessible at build time—packages themselves are on their own to perform any additional setup. In most cases, that is fine, and the downstream derivation can deal with its own dependencies. But for a few common tasks, that would result in almost every package doing the same sort of setup work—depending not on the package itself, but entirely on which dependencies were used.
971+
972+In order to alleviate this burden, the setup hook mechanism was written, where any package can include a shell script that \[by convention rather than enforcement by Nix\], any downstream reverse-dependency will source as part of its build process. That allows the downstream dependency to merely specify its dependencies, and lets those dependencies effectively initialize themselves. No boilerplate mirroring the list of dependencies is needed.
973+
974+The setup hook mechanism is a bit of a sledgehammer though: a powerful feature with a broad and indiscriminate area of effect. The combination of its power and implicit use may be expedient, but isn’t without costs. Nix itself is unchanged, but the spirit of added dependencies being effect-free is violated even if the letter isn’t. For example, if a derivation path is mentioned more than once, Nix itself doesn’t care and simply makes sure the dependency derivation is already built just the same—depending is just needing something to exist, and needing is idempotent. However, a dependency specified twice will have its setup hook run twice, and that could easily change the build environment (though a well-written setup hook will therefore strive to be idempotent so this is in fact not observable). More broadly, setup hooks are anti-modular in that multiple dependencies, whether the same or different, should not interfere and yet their setup hooks may well do so.
975+
976+The most typical use of the setup hook is actually to add other hooks which are then run (i.e. after all the setup hooks) on each dependency. For example, the C compiler wrapper’s setup hook feeds itself flags for each dependency that contains relevant libraries and headers. This is done by defining a bash function, and appending its name to one of `envBuildBuildHooks`, `envBuildHostHooks`, `envBuildTargetHooks`, `envHostHostHooks`, `envHostTargetHooks`, or `envTargetTargetHooks`. These 6 bash variables correspond to the 6 sorts of dependencies by platform (there’s 12 total but we ignore the propagated/non-propagated axis).
977+
978+Packages adding a hook should not hard code a specific hook, but rather choose a variable *relative* to how they are included. Returning to the C compiler wrapper example, if the wrapper itself is an `n` dependency, then it only wants to accumulate flags from `n + 1` dependencies, as only those ones match the compiler’s target platform. The `hostOffset` variable is defined with the current dependency’s host offset `targetOffset` with its target offset, before its setup hook is sourced. Additionally, since most environment hooks don’t care about the target platform, that means the setup hook can append to the right bash array by doing something like
979+
980+```bash
981+addEnvHooks "$hostOffset" myBashFunction
982+```
983+
984+The *existence* of setups hooks has long been documented and packages inside Nixpkgs are free to use this mechanism. Other packages, however, should not rely on these mechanisms not changing between Nixpkgs versions. Because of the existing issues with this system, there’s little benefit from mandating it be stable for any period of time.
985+
986+First, let’s cover some setup hooks that are part of Nixpkgs default stdenv. This means that they are run for every package built using `stdenv.mkDerivation`. Some of these are platform specific, so they may run on Linux but not Darwin or vice-versa.
987+
988+### `move-docs.sh` {#move-docs.sh}
989+
990+This setup hook moves any installed documentation to the `/share` subdirectory directory. This includes the man, doc and info directories. This is needed for legacy programs that do not know how to use the `share` subdirectory.
991+
992+### `compress-man-pages.sh` {#compress-man-pages.sh}
993+
994+This setup hook compresses any man pages that have been installed. The compression is done using the gzip program. This helps to reduce the installed size of packages.
995+
996+### `strip.sh` {#strip.sh}
997+
998+This runs the strip command on installed binaries and libraries. This removes unnecessary information like debug symbols when they are not needed. This also helps to reduce the installed size of packages.
999+
1000+### `patch-shebangs.sh` {#patch-shebangs.sh}
1001+
1002+This setup hook patches installed scripts to use the full path to the shebang interpreter. A shebang interpreter is the first commented line of a script telling the operating system which program will run the script (e.g `#!/bin/bash`). In Nix, we want an exact path to that interpreter to be used. This often replaces `/bin/sh` with a path in the Nix store.
1003+
1004+### `audit-tmpdir.sh` {#audit-tmpdir.sh}
1005+
1006+This verifies that no references are left from the install binaries to the directory used to build those binaries. This ensures that the binaries do not need things outside the Nix store. This is currently supported in Linux only.
1007+
1008+### `multiple-outputs.sh` {#multiple-outputs.sh}
1009+
1010+This setup hook adds configure flags that tell packages to install files into any one of the proper outputs listed in `outputs`. This behavior can be turned off by setting `setOutputFlags` to false in the derivation environment. See [](#chap-multiple-output) for more information.
1011+
1012+### `move-sbin.sh` {#move-sbin.sh}
1013+
1014+This setup hook moves any binaries installed in the `sbin/` subdirectory into `bin/`. In addition, a link is provided from `sbin/` to `bin/` for compatibility.
1015+
1016+### `move-lib64.sh` {#move-lib64.sh}
1017+
1018+This setup hook moves any libraries installed in the `lib64/` subdirectory into `lib/`. In addition, a link is provided from `lib64/` to `lib/` for compatibility.
1019+
1020+### `move-systemd-user-units.sh` {#move-systemd-user-units.sh}
1021+
1022+This setup hook moves any systemd user units installed in the `lib/` subdirectory into `share/`. In addition, a link is provided from `share/` to `lib/` for compatibility. This is needed for systemd to find user services when installed into the user profile.
1023+
1024+### `set-source-date-epoch-to-latest.sh` {#set-source-date-epoch-to-latest.sh}
1025+
1026+This sets `SOURCE_DATE_EPOCH` to the modification time of the most recent file.
1027+
1028+### Bintools Wrapper {#bintools-wrapper}
1029+
1030+The Bintools Wrapper wraps the binary utilities for a bunch of miscellaneous purposes. These are GNU Binutils when targetting Linux, and a mix of cctools and GNU binutils for Darwin. \[The “Bintools” name is supposed to be a compromise between “Binutils” and “cctools” not denoting any specific implementation.\] Specifically, the underlying bintools package, and a C standard library (glibc or Darwin’s libSystem, just for the dynamic loader) are all fed in, and dependency finding, hardening (see below), and purity checks for each are handled by the Bintools Wrapper. Packages typically depend on CC Wrapper, which in turn (at run time) depends on the Bintools Wrapper.
1031+
1032+The Bintools Wrapper was only just recently split off from CC Wrapper, so the division of labor is still being worked out. For example, it shouldn’t care about the C standard library, but just take a derivation with the dynamic loader (which happens to be the glibc on linux). Dependency finding however is a task both wrappers will continue to need to share, and probably the most important to understand. It is currently accomplished by collecting directories of host-platform dependencies (i.e. `buildInputs` and `nativeBuildInputs`) in environment variables. The Bintools Wrapper’s setup hook causes any `lib` and `lib64` subdirectories to be added to `NIX_LDFLAGS`. Since the CC Wrapper and the Bintools Wrapper use the same strategy, most of the Bintools Wrapper code is sparsely commented and refers to the CC Wrapper. But the CC Wrapper’s code, by contrast, has quite lengthy comments. The Bintools Wrapper merely cites those, rather than repeating them, to avoid falling out of sync.
1033+
1034+A final task of the setup hook is defining a number of standard environment variables to tell build systems which executables fulfill which purpose. They are defined to just be the base name of the tools, under the assumption that the Bintools Wrapper’s binaries will be on the path. Firstly, this helps poorly-written packages, e.g. ones that look for just `gcc` when `CC` isn’t defined yet `clang` is to be used. Secondly, this helps packages not get confused when cross-compiling, in which case multiple Bintools Wrappers may simultaneously be in use. [^footnote-stdenv-per-platform-wrapper] `BUILD_`- and `TARGET_`-prefixed versions of the normal environment variable are defined for additional Bintools Wrappers, properly disambiguating them.
1035+
1036+A problem with this final task is that the Bintools Wrapper is honest and defines `LD` as `ld`. Most packages, however, firstly use the C compiler for linking, secondly use `LD` anyways, defining it as the C compiler, and thirdly, only so define `LD` when it is undefined as a fallback. This triple-threat means Bintools Wrapper will break those packages, as LD is already defined as the actual linker which the package won’t override yet doesn’t want to use. The workaround is to define, just for the problematic package, `LD` as the C compiler. A good way to do this would be `preConfigure = "LD=$CC"`.
1037+
1038+### CC Wrapper {#cc-wrapper}
1039+
1040+The CC Wrapper wraps a C toolchain for a bunch of miscellaneous purposes. Specifically, a C compiler (GCC or Clang), wrapped binary tools, and a C standard library (glibc or Darwin’s libSystem, just for the dynamic loader) are all fed in, and dependency finding, hardening (see below), and purity checks for each are handled by the CC Wrapper. Packages typically depend on the CC Wrapper, which in turn (at run-time) depends on the Bintools Wrapper.
1041+
1042+Dependency finding is undoubtedly the main task of the CC Wrapper. This works just like the Bintools Wrapper, except that any `include` subdirectory of any relevant dependency is added to `NIX_CFLAGS_COMPILE`. The setup hook itself contains some lengthy comments describing the exact convoluted mechanism by which this is accomplished.
1043+
1044+Similarly, the CC Wrapper follows the Bintools Wrapper in defining standard environment variables with the names of the tools it wraps, for the same reasons described above. Importantly, while it includes a `cc` symlink to the c compiler for portability, the `CC` will be defined using the compiler’s “real name” (i.e. `gcc` or `clang`). This helps lousy build systems that inspect on the name of the compiler rather than run it.
1045+
1046+Here are some more packages that provide a setup hook. Since the list of hooks is extensible, this is not an exhaustive list. The mechanism is only to be used as a last resort, so it might cover most uses.
1047+
1048+### Perl {#setup-hook-perl}
1049+
1050+Adds the `lib/site_perl` subdirectory of each build input to the `PERL5LIB` environment variable. For instance, if `buildInputs` contains Perl, then the `lib/site_perl` subdirectory of each input is added to the `PERL5LIB` environment variable.
1051+
1052+### Python {#setup-hook-python}
1053+
1054+Adds the `lib/${python.libPrefix}/site-packages` subdirectory of each build input to the `PYTHONPATH` environment variable.
1055+
1056+### pkg-config {#setup-hook-pkg-config}
1057+
1058+Adds the `lib/pkgconfig` and `share/pkgconfig` subdirectories of each build input to the `PKG_CONFIG_PATH` environment variable.
1059+
1060+### Automake {#setup-hook-automake}
1061+
1062+Adds the `share/aclocal` subdirectory of each build input to the `ACLOCAL_PATH` environment variable.
1063+
1064+### Autoconf {#setup-hook-autoconf}
1065+
1066+The `autoreconfHook` derivation adds `autoreconfPhase`, which runs autoreconf, libtoolize and automake, essentially preparing the configure script in autotools-based builds. Most autotools-based packages come with the configure script pre-generated, but this hook is necessary for a few packages and when you need to patch the package’s configure scripts.
1067+
1068+### libxml2 {#setup-hook-libxml2}
1069+
1070+Adds every file named `catalog.xml` found under the `xml/dtd` and `xml/xsl` subdirectories of each build input to the `XML_CATALOG_FILES` environment variable.
1071+
1072+### teTeX / TeX Live {#tetex-tex-live}
1073+
1074+Adds the `share/texmf-nix` subdirectory of each build input to the `TEXINPUTS` environment variable.
1075+
1076+### Qt 4 {#qt-4}
1077+
1078+Sets the `QTDIR` environment variable to Qt’s path.
1079+
1080+### gdk-pixbuf {#setup-hook-gdk-pixbuf}
1081+
1082+Exports `GDK_PIXBUF_MODULE_FILE` environment variable to the builder. Add librsvg package to `buildInputs` to get svg support. See also the [setup hook description in GNOME platform docs](#ssec-gnome-hooks-gdk-pixbuf).
1083+
1084+### GHC {#ghc}
1085+
1086+Creates a temporary package database and registers every Haskell build input in it (TODO: how?).
1087+
1088+### GNOME platform {#gnome-platform}
1089+
1090+Hooks related to GNOME platform and related libraries like GLib, GTK and GStreamer are described in [](#sec-language-gnome).
1091+
1092+### autoPatchelfHook {#setup-hook-autopatchelfhook}
1093+
1094+This is a special setup hook which helps in packaging proprietary software in that it automatically tries to find missing shared library dependencies of ELF files based on the given `buildInputs` and `nativeBuildInputs`.
1095+
1096+You can also specify a `runtimeDependencies` variable which lists dependencies to be unconditionally added to rpath of all executables. This is useful for programs that use dlopen 3 to load libraries at runtime.
1097+
1098+In certain situations you may want to run the main command (`autoPatchelf`) of the setup hook on a file or a set of directories instead of unconditionally patching all outputs. This can be done by setting the `dontAutoPatchelf` environment variable to a non-empty value.
1099+
1100+By default `autoPatchelf` will fail as soon as any ELF file requires a dependency which cannot be resolved via the given build inputs. In some situations you might prefer to just leave missing dependencies unpatched and continue to patch the rest. This can be achieved by setting the `autoPatchelfIgnoreMissingDeps` environment variable to a non-empty value. `autoPatchelfIgnoreMissingDeps` can be set to a list like `autoPatchelfIgnoreMissingDeps = [ "libcuda.so.1" "libcudart.so.1" ];` or to simply `[ "*" ]` to ignore all missing dependencies.
1101+
1102+The `autoPatchelf` command also recognizes a `--no-recurse` command line flag, which prevents it from recursing into subdirectories.
1103+
1104+### breakpointHook {#breakpointhook}
1105+
1106+This hook will make a build pause instead of stopping when a failure happens. It prevents nix from cleaning up the build environment immediately and allows the user to attach to a build environment using the `cntr` command. Upon build error it will print instructions on how to use `cntr`, which can be used to enter the environment for debugging. Installing cntr and running the command will provide shell access to the build sandbox of failed build. At `/var/lib/cntr` the sandboxed filesystem is mounted. All commands and files of the system are still accessible within the shell. To execute commands from the sandbox use the cntr exec subcommand. `cntr` is only supported on Linux-based platforms. To use it first add `cntr` to your `environment.systemPackages` on NixOS or alternatively to the root user on non-NixOS systems. Then in the package that is supposed to be inspected, add `breakpointHook` to `nativeBuildInputs`.
1107+
1108+```nix
1109+nativeBuildInputs = [ breakpointHook ];
1110+```
1111+
1112+When a build failure happens there will be an instruction printed that shows how to attach with `cntr` to the build sandbox.
1113+
1114+::: {.note}
1115+::: {.title}
1116+Caution with remote builds
1117+:::
1118+
1119+This won’t work with remote builds as the build environment is on a different machine and can’t be accessed by `cntr`. Remote builds can be turned off by setting `--option builders ''` for `nix-build` or `--builders ''` for `nix build`.
1120+:::
1121+
1122+### installShellFiles {#installshellfiles}
1123+
1124+This hook helps with installing manpages and shell completion files. It exposes 2 shell functions `installManPage` and `installShellCompletion` that can be used from your `postInstall` hook.
1125+
1126+The `installManPage` function takes one or more paths to manpages to install. The manpages must have a section suffix, and may optionally be compressed (with `.gz` suffix). This function will place them into the correct directory.
1127+
1128+The `installShellCompletion` function takes one or more paths to shell completion files. By default it will autodetect the shell type from the completion file extension, but you may also specify it by passing one of `--bash`, `--fish`, or `--zsh`. These flags apply to all paths listed after them (up until another shell flag is given). Each path may also have a custom installation name provided by providing a flag `--name NAME` before the path. If this flag is not provided, zsh completions will be renamed automatically such that `foobar.zsh` becomes `_foobar`. A root name may be provided for all paths using the flag `--cmd NAME`; this synthesizes the appropriate name depending on the shell (e.g. `--cmd foo` will synthesize the name `foo.bash` for bash and `_foo` for zsh). The path may also be a fifo or named fd (such as produced by `<(cmd)`), in which case the shell and name must be provided.
1129+
1130+```nix
1131+nativeBuildInputs = [ installShellFiles ];
1132+postInstall = ''
1133+ installManPage doc/foobar.1 doc/barfoo.3
1134+ # explicit behavior
1135+ installShellCompletion --bash --name foobar.bash share/completions.bash
1136+ installShellCompletion --fish --name foobar.fish share/completions.fish
1137+ installShellCompletion --zsh --name _foobar share/completions.zsh
1138+ # implicit behavior
1139+ installShellCompletion share/completions/foobar.{bash,fish,zsh}
1140+ # using named fd
1141+ installShellCompletion --cmd foobar \
1142+ --bash <($out/bin/foobar --bash-completion) \
1143+ --fish <($out/bin/foobar --fish-completion) \
1144+ --zsh <($out/bin/foobar --zsh-completion)
1145+'';
1146+```
1147+
1148+### libiconv, libintl {#libiconv-libintl}
1149+
1150+A few libraries automatically add to `NIX_LDFLAGS` their library, making their symbols automatically available to the linker. This includes libiconv and libintl (gettext). This is done to provide compatibility between GNU Linux, where libiconv and libintl are bundled in, and other systems where that might not be the case. Sometimes, this behavior is not desired. To disable this behavior, set `dontAddExtraLibs`.
1151+
1152+### validatePkgConfig {#validatepkgconfig}
1153+
1154+The `validatePkgConfig` hook validates all pkg-config (`.pc`) files in a package. This helps catching some common errors in pkg-config files, such as undefined variables.
1155+
1156+### cmake {#cmake}
1157+
1158+Overrides the default configure phase to run the CMake command. By default, we use the Make generator of CMake. In addition, dependencies are added automatically to CMAKE_PREFIX_PATH so that packages are correctly detected by CMake. Some additional flags are passed in to give similar behavior to configure-based packages. You can disable this hook’s behavior by setting configurePhase to a custom value, or by setting dontUseCmakeConfigure. cmakeFlags controls flags passed only to CMake. By default, parallel building is enabled as CMake supports parallel building almost everywhere. When Ninja is also in use, CMake will detect that and use the ninja generator.
1159+
1160+### xcbuildHook {#xcbuildhook}
1161+
1162+Overrides the build and install phases to run the "xcbuild" command. This hook is needed when a project only comes with build files for the XCode build system. You can disable this behavior by setting buildPhase and configurePhase to a custom value. xcbuildFlags controls flags passed only to xcbuild.
1163+
1164+### Meson {#meson}
1165+
1166+Overrides the configure phase to run meson to generate Ninja files. To run these files, you should accompany Meson with ninja. By default, `enableParallelBuilding` is enabled as Meson supports parallel building almost everywhere.
1167+
1168+#### Variables controlling Meson {#variables-controlling-meson}
1169+
1170+##### `mesonFlags` {#mesonflags}
1171+
1172+Controls the flags passed to meson.
1173+
1174+##### `mesonBuildType` {#mesonbuildtype}
1175+
1176+Which [`--buildtype`](https://mesonbuild.com/Builtin-options.html#core-options) to pass to Meson. We default to `plain`.
1177+
1178+##### `mesonAutoFeatures` {#mesonautofeatures}
1179+
1180+What value to set [`-Dauto_features=`](https://mesonbuild.com/Builtin-options.html#core-options) to. We default to `enabled`.
1181+
1182+##### `mesonWrapMode` {#mesonwrapmode}
1183+
1184+What value to set [`-Dwrap_mode=`](https://mesonbuild.com/Builtin-options.html#core-options) to. We default to `nodownload` as we disallow network access.
1185+
1186+##### `dontUseMesonConfigure` {#dontusemesonconfigure}
1187+
1188+Disables using Meson’s `configurePhase`.
1189+
1190+### ninja {#ninja}
1191+
1192+Overrides the build, install, and check phase to run ninja instead of make. You can disable this behavior with the `dontUseNinjaBuild`, `dontUseNinjaInstall`, and `dontUseNinjaCheck`, respectively. Parallel building is enabled by default in Ninja.
1193+
1194+### unzip {#unzip}
1195+
1196+This setup hook will allow you to unzip .zip files specified in `$src`. There are many similar packages like `unrar`, `undmg`, etc.
1197+
1198+### wafHook {#wafhook}
1199+
1200+Overrides the configure, build, and install phases. This will run the “waf” script used by many projects. If `wafPath` (default `./waf`) doesn’t exist, it will copy the version of waf available in Nixpkgs. `wafFlags` can be used to pass flags to the waf script.
1201+
1202+### scons {#scons}
1203+
1204+Overrides the build, install, and check phases. This uses the scons build system as a replacement for make. scons does not provide a configure phase, so everything is managed at build and install time.
1205+
1206+## Purity in Nixpkgs {#sec-purity-in-nixpkgs}
1207+
1208+*Measures taken to prevent dependencies on packages outside the store, and what you can do to prevent them.*
1209+
1210+GCC doesn’t search in locations such as `/usr/include`. In fact, attempts to add such directories through the `-I` flag are filtered out. Likewise, the linker (from GNU binutils) doesn’t search in standard locations such as `/usr/lib`. Programs built on Linux are linked against a GNU C Library that likewise doesn’t search in the default system locations.
1211+
1212+## Hardening in Nixpkgs {#sec-hardening-in-nixpkgs}
1213+
1214+There are flags available to harden packages at compile or link-time. These can be toggled using the `stdenv.mkDerivation` parameters `hardeningDisable` and `hardeningEnable`.
1215+
1216+Both parameters take a list of flags as strings. The special `"all"` flag can be passed to `hardeningDisable` to turn off all hardening. These flags can also be used as environment variables for testing or development purposes.
1217+
1218+For more in-depth information on these hardening flags and hardening in general, refer to the [Debian Wiki](https://wiki.debian.org/Hardening), [Ubuntu Wiki](https://wiki.ubuntu.com/Security/Features), [Gentoo Wiki](https://wiki.gentoo.org/wiki/Project:Hardened), and the [Arch Wiki](https://wiki.archlinux.org/title/Security).
1219+
1220+### Hardening flags enabled by default {#sec-hardening-flags-enabled-by-default}
1221+
1222+The following flags are enabled by default and might require disabling with `hardeningDisable` if the program to package is incompatible.
1223+
1224+#### `format` {#format}
1225+
1226+Adds the `-Wformat -Wformat-security -Werror=format-security` compiler options. At present, this warns about calls to `printf` and `scanf` functions where the format string is not a string literal and there are no format arguments, as in `printf(foo);`. This may be a security hole if the format string came from untrusted input and contains `%n`.
1227+
1228+This needs to be turned off or fixed for errors similar to:
1229+
1230+```
1231+/tmp/nix-build-zynaddsubfx-2.5.2.drv-0/zynaddsubfx-2.5.2/src/UI/guimain.cpp:571:28: error: format not a string literal and no format arguments [-Werror=format-security]
1232+ printf(help_message);
1233+ ^
1234+cc1plus: some warnings being treated as errors
1235+```
1236+
1237+#### `stackprotector` {#stackprotector}
1238+
1239+Adds the `-fstack-protector-strong --param ssp-buffer-size=4` compiler options. This adds safety checks against stack overwrites rendering many potential code injection attacks into aborting situations. In the best case this turns code injection vulnerabilities into denial of service or into non-issues (depending on the application).
1240+
1241+This needs to be turned off or fixed for errors similar to:
1242+
1243+```
1244+bin/blib.a(bios_console.o): In function `bios_handle_cup':
1245+/tmp/nix-build-ipxe-20141124-5cbdc41.drv-0/ipxe-5cbdc41/src/arch/i386/firmware/pcbios/bios_console.c:86: undefined reference to `__stack_chk_fail'
1246+```
1247+
1248+#### `fortify` {#fortify}
1249+
1250+Adds the `-O2 -D_FORTIFY_SOURCE=2` compiler options. During code generation the compiler knows a great deal of information about buffer sizes (where possible), and attempts to replace insecure unlimited length buffer function calls with length-limited ones. This is especially useful for old, crufty code. Additionally, format strings in writable memory that contain `%n` are blocked. If an application depends on such a format string, it will need to be worked around.
1251+
1252+Additionally, some warnings are enabled which might trigger build failures if compiler warnings are treated as errors in the package build. In this case, set `NIX_CFLAGS_COMPILE` to `-Wno-error=warning-type`.
1253+
1254+This needs to be turned off or fixed for errors similar to:
1255+
1256+```
1257+malloc.c:404:15: error: return type is an incomplete type
1258+malloc.c:410:19: error: storage size of 'ms' isn't known
1259+
1260+strdup.h:22:1: error: expected identifier or '(' before '__extension__'
1261+
1262+strsep.c:65:23: error: register name not specified for 'delim'
1263+
1264+installwatch.c:3751:5: error: conflicting types for '__open_2'
1265+
1266+fcntl2.h:50:4: error: call to '__open_missing_mode' declared with attribute error: open with O_CREAT or O_TMPFILE in second argument needs 3 arguments
1267+```
1268+
1269+#### `pic` {#pic}
1270+
1271+Adds the `-fPIC` compiler options. This options adds support for position independent code in shared libraries and thus making ASLR possible.
1272+
1273+Most notably, the Linux kernel, kernel modules and other code not running in an operating system environment like boot loaders won’t build with PIC enabled. The compiler will is most cases complain that PIC is not supported for a specific build.
1274+
1275+This needs to be turned off or fixed for assembler errors similar to:
1276+
1277+```
1278+ccbLfRgg.s: Assembler messages:
1279+ccbLfRgg.s:33: Error: missing or invalid displacement expression `private_key_len@GOTOFF'
1280+```
1281+
1282+#### `strictoverflow` {#strictoverflow}
1283+
1284+Signed integer overflow is undefined behaviour according to the C standard. If it happens, it is an error in the program as it should check for overflow before it can happen, not afterwards. GCC provides built-in functions to perform arithmetic with overflow checking, which are correct and faster than any custom implementation. As a workaround, the option `-fno-strict-overflow` makes gcc behave as if signed integer overflows were defined.
1285+
1286+This flag should not trigger any build or runtime errors.
1287+
1288+#### `relro` {#relro}
1289+
1290+Adds the `-z relro` linker option. During program load, several ELF memory sections need to be written to by the linker, but can be turned read-only before turning over control to the program. This prevents some GOT (and .dtors) overwrite attacks, but at least the part of the GOT used by the dynamic linker (.got.plt) is still vulnerable.
1291+
1292+This flag can break dynamic shared object loading. For instance, the module systems of Xorg and OpenCV are incompatible with this flag. In almost all cases the `bindnow` flag must also be disabled and incompatible programs typically fail with similar errors at runtime.
1293+
1294+#### `bindnow` {#bindnow}
1295+
1296+Adds the `-z bindnow` linker option. During program load, all dynamic symbols are resolved, allowing for the complete GOT to be marked read-only (due to `relro`). This prevents GOT overwrite attacks. For very large applications, this can incur some performance loss during initial load while symbols are resolved, but this shouldn’t be an issue for daemons.
1297+
1298+This flag can break dynamic shared object loading. For instance, the module systems of Xorg and PHP are incompatible with this flag. Programs incompatible with this flag often fail at runtime due to missing symbols, like:
1299+
1300+```
1301+intel_drv.so: undefined symbol: vgaHWFreeHWRec
1302+```
1303+
1304+### Hardening flags disabled by default {#sec-hardening-flags-disabled-by-default}
1305+
1306+The following flags are disabled by default and should be enabled with `hardeningEnable` for packages that take untrusted input like network services.
1307+
1308+#### `pie` {#pie}
1309+
1310+This flag is disabled by default for normal `glibc` based NixOS package builds, but enabled by default for `musl` based package builds.
1311+
1312+Adds the `-fPIE` compiler and `-pie` linker options. Position Independent Executables are needed to take advantage of Address Space Layout Randomization, supported by modern kernel versions. While ASLR can already be enforced for data areas in the stack and heap (brk and mmap), the code areas must be compiled as position-independent. Shared libraries already do this with the `pic` flag, so they gain ASLR automatically, but binary .text regions need to be build with `pie` to gain ASLR. When this happens, ROP attacks are much harder since there are no static locations to bounce off of during a memory corruption attack.
1313+
1314+Static libraries need to be compiled with `-fPIE` so that executables can link them in with the `-pie` linker option.
1315+If the libraries lack `-fPIE`, you will get the error `recompile with -fPIE`.
1316+
1317+[^footnote-stdenv-ignored-build-platform]: The build platform is ignored because it is a mere implementation detail of the package satisfying the dependency: As a general programming principle, dependencies are always *specified* as interfaces, not concrete implementation.
1318+[^footnote-stdenv-native-dependencies-in-path]: Currently, this means for native builds all dependencies are put on the `PATH`. But in the future that may not be the case for sake of matching cross: the platforms would be assumed to be unique for native and cross builds alike, so only the `depsBuild*` and `nativeBuildInputs` would be added to the `PATH`.
1319+[^footnote-stdenv-propagated-dependencies]: Nix itself already takes a package’s transitive dependencies into account, but this propagation ensures nixpkgs-specific infrastructure like setup hooks (mentioned above) also are run as if the propagated dependency.
1320+[^footnote-stdenv-find-inputs-location]: The `findInputs` function, currently residing in `pkgs/stdenv/generic/setup.sh`, implements the propagation logic.
1321+[^footnote-stdenv-sys-lib-search-path]: It clears the `sys_lib_*search_path` variables in the Libtool script to prevent Libtool from using libraries in `/usr/lib` and such.
1322+[^footnote-stdenv-build-time-guessing-impurity]: Eventually these will be passed building natively as well, to improve determinism: build-time guessing, as is done today, is a risk of impurity.
1323+[^footnote-stdenv-per-platform-wrapper]: Each wrapper targets a single platform, so if binaries for multiple platforms are needed, the underlying binaries must be wrapped multiple times. As this is a property of the wrapper itself, the multiple wrappings are needed whether or not the same underlying binaries can target multiple platforms.
doc/style.css+127−70
@@ -8,16 +8,15 @@
88
99body
1010{
11− font-family: sans-serif;
11+ font-family: "Nimbus Sans L", sans-serif;
12+ font-size: 1em;
1213 background: white;
13−
1414 margin: 2em 1em 2em 1em;
1515}
1616
17−h1,h2,h3
17+h1, h2, h3, h4
1818{
1919 color: #005aa0;
20− text-align: left;
2120}
2221
2322h1 /* title */
@@ -30,52 +29,88 @@ h2 /* chapters, appendices, subtitle */
3029 font-size: 180%;
3130}
3231
32+div.book
33+{
34+ text-align: center;
35+}
36+
37+div.book > div
38+{
39+ /*
40+ * based on https://medium.com/@zkareemz/golden-ratio-62b3b6d4282a
41+ * we do 70 characters per line to fit code listings better
42+ * 70 * (font-size / 1.618)
43+ * expression for emacs:
44+ * (* 70 (/ 1 1.618))
45+ */
46+ max-width: 43.2em;
47+ text-align: left;
48+ margin: auto;
49+}
50+
3351/* Extra space between chapters, appendices. */
34−div.chapter > div.titlepage h2, div.appendix > div.titlepage h2
35−{
52+div.chapter > div.titlepage h2, div.appendix > div.titlepage h2
53+{
3654 margin-top: 1.5em;
37−/* border-top: solid #005aa0; */
3855}
3956
40−div.sect1 h2 /* sections */
57+div.section > div.titlepage h2 /* sections */
4158{
4259 font-size: 150%;
60+ margin-top: 1.5em;
4361}
4462
45−div.refnamediv h2, div.refsynopsisdiv h2, div.refsection h2 /* refentry parts */
63+h3 /* subsections */
4664{
4765 font-size: 125%;
4866}
4967
50−div.refsection h3
68+div.simplesect h2
5169{
5270 font-size: 110%;
5371}
5472
55−h3 /* subsections */
73+div.appendix h3
5674{
75+ font-size: 150%;
76+ margin-top: 1.5em;
77+}
78+
79+div.refnamediv h2, div.refsynopsisdiv h2, div.refsection h2 /* refentry parts */
80+{
81+ margin-top: 1.4em;
5782 font-size: 125%;
5883}
5984
85+div.refsection h3
86+{
87+ font-size: 110%;
88+}
6089
6190
6291/***************************************************************************
63− Program listings:
92+ Examples:
6493 ***************************************************************************/
6594
6695div.example
6796{
68− border: 1px solid #6185a0;
97+ border: 1px solid #b0b0b0;
6998 padding: 6px 6px;
70− margin-left: 3em;
71− margin-right: 3em;
72− background: #eeeeee;
99+ margin-left: 1.5em;
100+ margin-right: 1.5em;
101+ background: #f4f4f8;
102+ border-radius: 0.4em;
103+ box-shadow: 0.4em 0.4em 0.5em #e0e0e0;
73104}
74105
75−pre.programlisting
106+div.example p.title
76107{
77− color: #600000;
78− font-family: monospace;
108+ margin-top: 0em;
109+}
110+
111+div.example pre
112+{
113+ box-shadow: none;
79114}
80115
81116
@@ -83,41 +118,64 @@ pre.programlisting
83118 Screen dumps:
84119 ***************************************************************************/
85120
86−pre.screen
121+pre.screen, pre.programlisting
87122{
88− border: 1px solid #6185a0;
89− padding: 6px 6px;
90− margin-left: 3em;
91− margin-right: 3em;
92− color: #600000;
93− background: #eeeeee;
123+ border: 1px solid #b0b0b0;
124+ padding: 3px 3px;
125+ margin-left: 0.5em;
126+ margin-right: 0.5em;
127+
128+ background: #f4f4f8;
94129 font-family: monospace;
95− /* font-size: 90%; */
130+ border-radius: 0.4em;
131+ box-shadow: 0.4em 0.4em 0.5em #e0e0e0;
96132}
97133
134+div.example pre.programlisting
135+{
136+ border: 0px;
137+ padding: 0 0;
138+ margin: 0 0 0 0;
139+}
98140
99141/***************************************************************************
100142 Notes, warnings etc:
101143 ***************************************************************************/
102144
103−.note,.warning
145+.note, .warning
104146{
105− margin-top: 1em;
147+ border: 1px solid #b0b0b0;
148+ padding: 3px 3px;
149+ margin-left: 1.5em;
150+ margin-right: 1.5em;
106151 margin-bottom: 1em;
107− border: 1px solid #6185a0;
108− padding: 0px 1em;
152+ padding: 0.3em 0.3em 0.3em 0.3em;
109153 background: #fffff5;
154+ border-radius: 0.4em;
155+ box-shadow: 0.4em 0.4em 0.5em #e0e0e0;
110156}
111157
112−div.note,div.warning
158+div.note, div.warning
113159{
114160 font-style: italic;
115161}
116162
117−div.warning h3
163+div.note h3, div.warning h3
118164{
119165 color: red;
120166 font-size: 100%;
167+ padding-right: 0.5em;
168+ display: inline;
169+}
170+
171+div.note p, div.warning p
172+{
173+ margin-bottom: 0em;
174+}
175+
176+div.note h3 + p, div.warning h3 + p
177+{
178+ display: inline;
121179}
122180
123181div.note h3
@@ -133,23 +191,29 @@ div.navfooter *
133191
134192
135193/***************************************************************************
136− Links colors and highlighting:
194+ Links colors and highlighting:
137195 ***************************************************************************/
138196
197+a { text-decoration: none; }
198+a:hover { text-decoration: underline; }
139199a:link { color: #0048b3; }
140200a:visited { color: #002a6a; }
141−a:hover { background: #ffffcd; }
142201
143202
144203/***************************************************************************
145204 Table of contents:
146205 ***************************************************************************/
147206
148−.toc
207+div.toc
149208{
150209 font-size: 90%;
151210}
152211
212+div.toc dl
213+{
214+ margin-top: 0em;
215+ margin-bottom: 0em;
216+}
153217
154218
155219/***************************************************************************
@@ -164,20 +228,20 @@ tt, code
164228.term
165229{
166230 font-weight: bold;
167−
231+
168232}
169233
170−div.variablelist dd
234+div.variablelist dd p, div.glosslist dd p
171235{
172− margin-bottom: 1em;
236+ margin-top: 0em;
173237}
174238
175−.default
239+div.variablelist dd, div.glosslist dd
176240{
177− font-style: italic;
241+ margin-left: 1.5em;
178242}
179243
180−.availability
244+div.glosslist dt
181245{
182246 font-style: italic;
183247}
@@ -187,48 +251,41 @@ div.variablelist dd
187251 color: #400000;
188252}
189253
190−
191−div.informaltable table
254+span.command strong
192255{
193− border: 1px solid #6185a0;
194− width: 100%;
256+ font-weight: normal;
257+ color: #400000;
195258}
196259
197−div.informaltable td
260+div.calloutlist table
198261{
199− border: 0;
200− padding: 5px;
262+ box-shadow: none;
201263}
202264
203−div.informaltable td.default
265+table
204266{
205− text-align: right;
267+ border-collapse: collapse;
268+ box-shadow: 0.4em 0.4em 0.5em #e0e0e0;
206269}
207270
208−div.informaltable th
271+table.simplelist
209272{
210− text-align: left;
211− color: #005aa0;
212− border: 0;
213− padding: 5px;
214− background: #fffff5;
215− font-weight: normal;
216− font-style: italic;
273+ text-align: left;
274+ color: #005aa0;
275+ border: 0;
276+ padding: 5px;
277+ background: #fffff5;
278+ font-weight: normal;
279+ font-style: italic;
280+ box-shadow: none;
281+ margin-bottom: 1em;
217282}
218283
219−td.varname, td.tagname, td.paramname
220−{
221− font-weight: bold;
222− vertical-align: top;
284+div.navheader table, div.navfooter table {
285+ box-shadow: none;
223286}
224287
225−div.epigraph
288+div.affiliation
226289{
227290 font-style: italic;
228− text-align: right;
229−}
230−
231−table.productionset table.productionset
232−{
233− font-family: monospace;
234291}
doc/using/configuration.chapter.mdnew file+356
@@ -0,0 +1,356 @@
1+# Global configuration {#chap-packageconfig}
2+
3+Nix comes with certain defaults about what packages can and cannot be installed, based on a package's metadata. By default, Nix will prevent installation if any of the following criteria are true:
4+
5+- The package is thought to be broken, and has had its `meta.broken` set to `true`.
6+
7+- The package isn't intended to run on the given system, as none of its `meta.platforms` match the given system.
8+
9+- The package's `meta.license` is set to a license which is considered to be unfree.
10+
11+- The package has known security vulnerabilities but has not or can not be updated for some reason, and a list of issues has been entered in to the package's `meta.knownVulnerabilities`.
12+
13+Note that all this is checked during evaluation already, and the check includes any package that is evaluated. In particular, all build-time dependencies are checked. `nix-env -qa` will (attempt to) hide any packages that would be refused.
14+
15+Each of these criteria can be altered in the nixpkgs configuration.
16+
17+The nixpkgs configuration for a NixOS system is set in the `configuration.nix`, as in the following example:
18+
19+```nix
20+{
21+ nixpkgs.config = {
22+ allowUnfree = true;
23+ };
24+}
25+```
26+
27+However, this does not allow unfree software for individual users. Their configurations are managed separately.
28+
29+A user's nixpkgs configuration is stored in a user-specific configuration file located at `~/.config/nixpkgs/config.nix`. For example:
30+
31+```nix
32+{
33+ allowUnfree = true;
34+}
35+```
36+
37+Note that we are not able to test or build unfree software on Hydra due to policy. Most unfree licenses prohibit us from either executing or distributing the software.
38+
39+## Installing broken packages {#sec-allow-broken}
40+
41+There are two ways to try compiling a package which has been marked as broken.
42+
43+- For allowing the build of a broken package once, you can use an environment variable for a single invocation of the nix tools:
44+
45+ ```ShellSession
46+ $ export NIXPKGS_ALLOW_BROKEN=1
47+ ```
48+
49+- For permanently allowing broken packages to be built, you may add `allowBroken = true;` to your user's configuration file, like this:
50+
51+ ```nix
52+ {
53+ allowBroken = true;
54+ }
55+ ```
56+
57+
58+## Installing packages on unsupported systems {#sec-allow-unsupported-system}
59+
60+There are also two ways to try compiling a package which has been marked as unsupported for the given system.
61+
62+- For allowing the build of an unsupported package once, you can use an environment variable for a single invocation of the nix tools:
63+
64+ ```ShellSession
65+ $ export NIXPKGS_ALLOW_UNSUPPORTED_SYSTEM=1
66+ ```
67+
68+- For permanently allowing unsupported packages to be built, you may add `allowUnsupportedSystem = true;` to your user's configuration file, like this:
69+
70+ ```nix
71+ {
72+ allowUnsupportedSystem = true;
73+ }
74+ ```
75+
76+The difference between a package being unsupported on some system and being broken is admittedly a bit fuzzy. If a program *ought* to work on a certain platform, but doesn't, the platform should be included in `meta.platforms`, but marked as broken with e.g. `meta.broken = !hostPlatform.isWindows`. Of course, this begs the question of what \"ought\" means exactly. That is left to the package maintainer.
77+
78+## Installing unfree packages {#sec-allow-unfree}
79+
80+There are several ways to tweak how Nix handles a package which has been marked as unfree.
81+
82+- To temporarily allow all unfree packages, you can use an environment variable for a single invocation of the nix tools:
83+
84+ ```ShellSession
85+ $ export NIXPKGS_ALLOW_UNFREE=1
86+ ```
87+
88+- It is possible to permanently allow individual unfree packages, while still blocking unfree packages by default using the `allowUnfreePredicate` configuration option in the user configuration file.
89+
90+ This option is a function which accepts a package as a parameter, and returns a boolean. The following example configuration accepts a package and always returns false:
91+
92+ ```nix
93+ {
94+ allowUnfreePredicate = (pkg: false);
95+ }
96+ ```
97+
98+ For a more useful example, try the following. This configuration only allows unfree packages named roon-server and visual studio code:
99+
100+ ```nix
101+ {
102+ allowUnfreePredicate = pkg: builtins.elem (lib.getName pkg) [
103+ "roon-server"
104+ "vscode"
105+ ];
106+ }
107+ ```
108+
109+- It is also possible to allow and block licenses that are specifically acceptable or not acceptable, using `allowlistedLicenses` and `blocklistedLicenses`, respectively.
110+
111+ The following example configuration allowlists the licenses `amd` and `wtfpl`:
112+
113+ ```nix
114+ {
115+ allowlistedLicenses = with lib.licenses; [ amd wtfpl ];
116+ }
117+ ```
118+
119+ The following example configuration blocklists the `gpl3Only` and `agpl3Only` licenses:
120+
121+ ```nix
122+ {
123+ blocklistedLicenses = with lib.licenses; [ agpl3Only gpl3Only ];
124+ }
125+ ```
126+
127+ Note that `allowlistedLicenses` only applies to unfree licenses unless `allowUnfree` is enabled. It is not a generic allowlist for all types of licenses. `blocklistedLicenses` applies to all licenses.
128+
129+A complete list of licenses can be found in the file `lib/licenses.nix` of the nixpkgs tree.
130+
131+## Installing insecure packages {#sec-allow-insecure}
132+
133+There are several ways to tweak how Nix handles a package which has been marked as insecure.
134+
135+- To temporarily allow all insecure packages, you can use an environment variable for a single invocation of the nix tools:
136+
137+ ```ShellSession
138+ $ export NIXPKGS_ALLOW_INSECURE=1
139+ ```
140+
141+- It is possible to permanently allow individual insecure packages, while still blocking other insecure packages by default using the `permittedInsecurePackages` configuration option in the user configuration file.
142+
143+ The following example configuration permits the installation of the hypothetically insecure package `hello`, version `1.2.3`:
144+
145+ ```nix
146+ {
147+ permittedInsecurePackages = [
148+ "hello-1.2.3"
149+ ];
150+ }
151+ ```
152+
153+- It is also possible to create a custom policy around which insecure packages to allow and deny, by overriding the `allowInsecurePredicate` configuration option.
154+
155+ The `allowInsecurePredicate` option is a function which accepts a package and returns a boolean, much like `allowUnfreePredicate`.
156+
157+ The following configuration example only allows insecure packages with very short names:
158+
159+ ```nix
160+ {
161+ allowInsecurePredicate = pkg: builtins.stringLength (lib.getName pkg) <= 5;
162+ }
163+ ```
164+
165+ Note that `permittedInsecurePackages` is only checked if `allowInsecurePredicate` is not specified.
166+
167+## Modify packages via `packageOverrides` {#sec-modify-via-packageOverrides}
168+
169+You can define a function called `packageOverrides` in your local `~/.config/nixpkgs/config.nix` to override Nix packages. It must be a function that takes pkgs as an argument and returns a modified set of packages.
170+
171+```nix
172+{
173+ packageOverrides = pkgs: rec {
174+ foo = pkgs.foo.override { ... };
175+ };
176+}
177+```
178+
179+## Declarative Package Management {#sec-declarative-package-management}
180+
181+### Build an environment {#sec-building-environment}
182+
183+Using `packageOverrides`, it is possible to manage packages declaratively. This means that we can list all of our desired packages within a declarative Nix expression. For example, to have `aspell`, `bc`, `ffmpeg`, `coreutils`, `gdb`, `nixUnstable`, `emscripten`, `jq`, `nox`, and `silver-searcher`, we could use the following in `~/.config/nixpkgs/config.nix`:
184+
185+```nix
186+{
187+ packageOverrides = pkgs: with pkgs; {
188+ myPackages = pkgs.buildEnv {
189+ name = "my-packages";
190+ paths = [
191+ aspell
192+ bc
193+ coreutils
194+ gdb
195+ ffmpeg
196+ nixUnstable
197+ emscripten
198+ jq
199+ nox
200+ silver-searcher
201+ ];
202+ };
203+ };
204+}
205+```
206+
207+To install it into our environment, you can just run `nix-env -iA nixpkgs.myPackages`. If you want to load the packages to be built from a working copy of `nixpkgs` you just run `nix-env -f. -iA myPackages`. To explore what's been installed, just look through `~/.nix-profile/`. You can see that a lot of stuff has been installed. Some of this stuff is useful some of it isn't. Let's tell Nixpkgs to only link the stuff that we want:
208+
209+```nix
210+{
211+ packageOverrides = pkgs: with pkgs; {
212+ myPackages = pkgs.buildEnv {
213+ name = "my-packages";
214+ paths = [
215+ aspell
216+ bc
217+ coreutils
218+ gdb
219+ ffmpeg
220+ nixUnstable
221+ emscripten
222+ jq
223+ nox
224+ silver-searcher
225+ ];
226+ pathsToLink = [ "/share" "/bin" ];
227+ };
228+ };
229+}
230+```
231+
232+`pathsToLink` tells Nixpkgs to only link the paths listed which gets rid of the extra stuff in the profile. `/bin` and `/share` are good defaults for a user environment, getting rid of the clutter. If you are running on Nix on MacOS, you may want to add another path as well, `/Applications`, that makes GUI apps available.
233+
234+### Getting documentation {#sec-getting-documentation}
235+
236+After building that new environment, look through `~/.nix-profile` to make sure everything is there that we wanted. Discerning readers will note that some files are missing. Look inside `~/.nix-profile/share/man/man1/` to verify this. There are no man pages for any of the Nix tools! This is because some packages like Nix have multiple outputs for things like documentation (see section 4). Let's make Nix install those as well.
237+
238+```nix
239+{
240+ packageOverrides = pkgs: with pkgs; {
241+ myPackages = pkgs.buildEnv {
242+ name = "my-packages";
243+ paths = [
244+ aspell
245+ bc
246+ coreutils
247+ ffmpeg
248+ nixUnstable
249+ emscripten
250+ jq
251+ nox
252+ silver-searcher
253+ ];
254+ pathsToLink = [ "/share/man" "/share/doc" "/bin" ];
255+ extraOutputsToInstall = [ "man" "doc" ];
256+ };
257+ };
258+}
259+```
260+
261+This provides us with some useful documentation for using our packages. However, if we actually want those manpages to be detected by man, we need to set up our environment. This can also be managed within Nix expressions.
262+
263+```nix
264+{
265+ packageOverrides = pkgs: with pkgs; rec {
266+ myProfile = writeText "my-profile" ''
267+ export PATH=$HOME/.nix-profile/bin:/nix/var/nix/profiles/default/bin:/sbin:/bin:/usr/sbin:/usr/bin
268+ export MANPATH=$HOME/.nix-profile/share/man:/nix/var/nix/profiles/default/share/man:/usr/share/man
269+ '';
270+ myPackages = pkgs.buildEnv {
271+ name = "my-packages";
272+ paths = [
273+ (runCommand "profile" {} ''
274+ mkdir -p $out/etc/profile.d
275+ cp ${myProfile} $out/etc/profile.d/my-profile.sh
276+ '')
277+ aspell
278+ bc
279+ coreutils
280+ ffmpeg
281+ man
282+ nixUnstable
283+ emscripten
284+ jq
285+ nox
286+ silver-searcher
287+ ];
288+ pathsToLink = [ "/share/man" "/share/doc" "/bin" "/etc" ];
289+ extraOutputsToInstall = [ "man" "doc" ];
290+ };
291+ };
292+}
293+```
294+
295+For this to work fully, you must also have this script sourced when you are logged in. Try adding something like this to your `~/.profile` file:
296+
297+```ShellSession
298+#!/bin/sh
299+if [ -d $HOME/.nix-profile/etc/profile.d ]; then
300+ for i in $HOME/.nix-profile/etc/profile.d/*.sh; do
301+ if [ -r $i ]; then
302+ . $i
303+ fi
304+ done
305+fi
306+```
307+
308+Now just run `source $HOME/.profile` and you can starting loading man pages from your environment.
309+
310+### GNU info setup {#sec-gnu-info-setup}
311+
312+Configuring GNU info is a little bit trickier than man pages. To work correctly, info needs a database to be generated. This can be done with some small modifications to our environment scripts.
313+
314+```nix
315+{
316+ packageOverrides = pkgs: with pkgs; rec {
317+ myProfile = writeText "my-profile" ''
318+ export PATH=$HOME/.nix-profile/bin:/nix/var/nix/profiles/default/bin:/sbin:/bin:/usr/sbin:/usr/bin
319+ export MANPATH=$HOME/.nix-profile/share/man:/nix/var/nix/profiles/default/share/man:/usr/share/man
320+ export INFOPATH=$HOME/.nix-profile/share/info:/nix/var/nix/profiles/default/share/info:/usr/share/info
321+ '';
322+ myPackages = pkgs.buildEnv {
323+ name = "my-packages";
324+ paths = [
325+ (runCommand "profile" {} ''
326+ mkdir -p $out/etc/profile.d
327+ cp ${myProfile} $out/etc/profile.d/my-profile.sh
328+ '')
329+ aspell
330+ bc
331+ coreutils
332+ ffmpeg
333+ man
334+ nixUnstable
335+ emscripten
336+ jq
337+ nox
338+ silver-searcher
339+ texinfoInteractive
340+ ];
341+ pathsToLink = [ "/share/man" "/share/doc" "/share/info" "/bin" "/etc" ];
342+ extraOutputsToInstall = [ "man" "doc" "info" ];
343+ postBuild = ''
344+ if [ -x $out/bin/install-info -a -w $out/share/info ]; then
345+ shopt -s nullglob
346+ for i in $out/share/info/*.info $out/share/info/*.info.gz; do
347+ $out/bin/install-info $i $out/share/info/dir
348+ done
349+ fi
350+ '';
351+ };
352+ };
353+}
354+```
355+
356+`postBuild` tells Nixpkgs to run a command after building the environment. In this case, `install-info` adds the installed info pages to `dir` which is GNU info's default root node. Note that `texinfoInteractive` is added to the environment to give the `install-info` command.
doc/using/overlays.chapter.mdnew file+167
@@ -0,0 +1,167 @@
1+# Overlays {#chap-overlays}
2+
3+This chapter describes how to extend and change Nixpkgs using overlays. Overlays are used to add layers in the fixed-point used by Nixpkgs to compose the set of all packages.
4+
5+Nixpkgs can be configured with a list of overlays, which are applied in order. This means that the order of the overlays can be significant if multiple layers override the same package.
6+
7+## Installing overlays {#sec-overlays-install}
8+
9+The list of overlays can be set either explicitly in a Nix expression, or through `<nixpkgs-overlays>` or user configuration files.
10+
11+### Set overlays in NixOS or Nix expressions {#sec-overlays-argument}
12+
13+On a NixOS system the value of the `nixpkgs.overlays` option, if present, is passed to the system Nixpkgs directly as an argument. Note that this does not affect the overlays for non-NixOS operations (e.g. `nix-env`), which are [looked up](#sec-overlays-lookup) independently.
14+
15+The list of overlays can be passed explicitly when importing nixpkgs, for example `import <nixpkgs> { overlays = [ overlay1 overlay2 ]; }`.
16+
17+NOTE: DO NOT USE THIS in nixpkgs. Further overlays can be added by calling the `pkgs.extend` or `pkgs.appendOverlays`, although it is often preferable to avoid these functions, because they recompute the Nixpkgs fixpoint, which is somewhat expensive to do.
18+
19+### Install overlays via configuration lookup {#sec-overlays-lookup}
20+
21+The list of overlays is determined as follows.
22+
23+1. First, if an [`overlays` argument](#sec-overlays-argument) to the Nixpkgs function itself is given, then that is used and no path lookup will be performed.
24+
25+2. Otherwise, if the Nix path entry `<nixpkgs-overlays>` exists, we look for overlays at that path, as described below.
26+
27+ See the section on `NIX_PATH` in the Nix manual for more details on how to set a value for `<nixpkgs-overlays>.`
28+
29+3. If one of `~/.config/nixpkgs/overlays.nix` and `~/.config/nixpkgs/overlays/` exists, then we look for overlays at that path, as described below. It is an error if both exist.
30+
31+If we are looking for overlays at a path, then there are two cases:
32+
33+- If the path is a file, then the file is imported as a Nix expression and used as the list of overlays.
34+
35+- If the path is a directory, then we take the content of the directory, order it lexicographically, and attempt to interpret each as an overlay by:
36+
37+ - Importing the file, if it is a `.nix` file.
38+
39+ - Importing a top-level `default.nix` file, if it is a directory.
40+
41+Because overlays that are set in NixOS configuration do not affect non-NixOS operations such as `nix-env`, the `overlays.nix` option provides a convenient way to use the same overlays for a NixOS system configuration and user configuration: the same file can be used as `overlays.nix` and imported as the value of `nixpkgs.overlays`.
42+
43+## Defining overlays {#sec-overlays-definition}
44+
45+Overlays are Nix functions which accept two arguments, conventionally called `self` and `super`, and return a set of packages. For example, the following is a valid overlay.
46+
47+```nix
48+self: super:
49+
50+{
51+ boost = super.boost.override {
52+ python = self.python3;
53+ };
54+ rr = super.callPackage ./pkgs/rr {
55+ stdenv = self.stdenv_32bit;
56+ };
57+}
58+```
59+
60+The first argument (`self`) corresponds to the final package set. You should use this set for the dependencies of all packages specified in your overlay. For example, all the dependencies of `rr` in the example above come from `self`, as well as the overridden dependencies used in the `boost` override.
61+
62+The second argument (`super`) corresponds to the result of the evaluation of the previous stages of Nixpkgs. It does not contain any of the packages added by the current overlay, nor any of the following overlays. This set should be used either to refer to packages you wish to override, or to access functions defined in Nixpkgs. For example, the original recipe of `boost` in the above example, comes from `super`, as well as the `callPackage` function.
63+
64+The value returned by this function should be a set similar to `pkgs/top-level/all-packages.nix`, containing overridden and/or new packages.
65+
66+Overlays are similar to other methods for customizing Nixpkgs, in particular the `packageOverrides` attribute described in [](#sec-modify-via-packageOverrides). Indeed, `packageOverrides` acts as an overlay with only the `super` argument. It is therefore appropriate for basic use, but overlays are more powerful and easier to distribute.
67+
68+## Using overlays to configure alternatives {#sec-overlays-alternatives}
69+
70+Certain software packages have different implementations of the same interface. Other distributions have functionality to switch between these. For example, Debian provides [DebianAlternatives](https://wiki.debian.org/DebianAlternatives). Nixpkgs has what we call `alternatives`, which are configured through overlays.
71+
72+### BLAS/LAPACK {#sec-overlays-alternatives-blas-lapack}
73+
74+In Nixpkgs, we have multiple implementations of the BLAS/LAPACK numerical linear algebra interfaces. They are:
75+
76+- [OpenBLAS](https://www.openblas.net/)
77+
78+ The Nixpkgs attribute is `openblas` for ILP64 (integer width = 64 bits) and `openblasCompat` for LP64 (integer width = 32 bits). `openblasCompat` is the default.
79+
80+- [LAPACK reference](http://www.netlib.org/lapack/) (also provides BLAS and CBLAS)
81+
82+ The Nixpkgs attribute is `lapack-reference`.
83+
84+- [Intel MKL](https://software.intel.com/en-us/mkl) (only works on the x86_64 architecture, unfree)
85+
86+ The Nixpkgs attribute is `mkl`.
87+
88+- [BLIS](https://github.com/flame/blis)
89+
90+ BLIS, available through the attribute `blis`, is a framework for linear algebra kernels. In addition, it implements the BLAS interface.
91+
92+- [AMD BLIS/LIBFLAME](https://developer.amd.com/amd-aocl/blas-library/) (optimized for modern AMD x86_64 CPUs)
93+
94+ The AMD fork of the BLIS library, with attribute `amd-blis`, extends BLIS with optimizations for modern AMD CPUs. The changes are usually submitted to the upstream BLIS project after some time. However, AMD BLIS typically provides some performance improvements on AMD Zen CPUs. The complementary AMD LIBFLAME library, with attribute `amd-libflame`, provides a LAPACK implementation.
95+
96+Introduced in [PR #83888](https://github.com/NixOS/nixpkgs/pull/83888), we are able to override the `blas` and `lapack` packages to use different implementations, through the `blasProvider` and `lapackProvider` argument. This can be used to select a different provider. BLAS providers will have symlinks in `$out/lib/libblas.so.3` and `$out/lib/libcblas.so.3` to their respective BLAS libraries. Likewise, LAPACK providers will have symlinks in `$out/lib/liblapack.so.3` and `$out/lib/liblapacke.so.3` to their respective LAPACK libraries. For example, Intel MKL is both a BLAS and LAPACK provider. An overlay can be created to use Intel MKL that looks like:
97+
98+```nix
99+self: super:
100+
101+{
102+ blas = super.blas.override {
103+ blasProvider = self.mkl;
104+ };
105+
106+ lapack = super.lapack.override {
107+ lapackProvider = self.mkl;
108+ };
109+}
110+```
111+
112+This overlay uses Intel's MKL library for both BLAS and LAPACK interfaces. Note that the same can be accomplished at runtime using `LD_LIBRARY_PATH` of `libblas.so.3` and `liblapack.so.3`. For instance:
113+
114+```ShellSession
115+$ LD_LIBRARY_PATH=$(nix-build -A mkl)/lib${LD_LIBRARY_PATH:+:}$LD_LIBRARY_PATH nix-shell -p octave --run octave
116+```
117+
118+Intel MKL requires an `openmp` implementation when running with multiple processors. By default, `mkl` will use Intel's `iomp` implementation if no other is specified, but this is a runtime-only dependency and binary compatible with the LLVM implementation. To use that one instead, Intel recommends users set it with `LD_PRELOAD`. Note that `mkl` is only available on `x86_64-linux` and `x86_64-darwin`. Moreover, Hydra is not building and distributing pre-compiled binaries using it.
119+
120+To override `blas` and `lapack` with its reference implementations (i.e. for development purposes), one can use the following overlay:
121+
122+```nix
123+self: super:
124+
125+{
126+ blas = super.blas.override {
127+ blasProvider = self.lapack-reference;
128+ };
129+
130+ lapack = super.lapack.override {
131+ lapackProvider = self.lapack-reference;
132+ };
133+}
134+```
135+
136+For BLAS/LAPACK switching to work correctly, all packages must depend on `blas` or `lapack`. This ensures that only one BLAS/LAPACK library is used at one time. There are two versions of BLAS/LAPACK currently in the wild, `LP64` (integer size = 32 bits) and `ILP64` (integer size = 64 bits). The attributes `blas` and `lapack` are `LP64` by default. Their `ILP64` version are provided through the attributes `blas-ilp64` and `lapack-ilp64`. Some software needs special flags or patches to work with `ILP64`. You can check if `ILP64` is used in Nixpkgs with `blas.isILP64` and `lapack.isILP64`. Some software does NOT work with `ILP64`, and derivations need to specify an assertion to prevent this. You can prevent `ILP64` from being used with the following:
137+
138+```nix
139+{ stdenv, blas, lapack, ... }:
140+
141+assert (!blas.isILP64) && (!lapack.isILP64);
142+
143+stdenv.mkDerivation {
144+ ...
145+}
146+```
147+
148+### Switching the MPI implementation {#sec-overlays-alternatives-mpi}
149+
150+All programs that are built with [MPI](https://en.wikipedia.org/wiki/Message_Passing_Interface) support use the generic attribute `mpi` as an input. At the moment Nixpkgs natively provides two different MPI implementations:
151+
152+- [Open MPI](https://www.open-mpi.org/) (default), attribute name
153+ `openmpi`
154+
155+- [MPICH](https://www.mpich.org/), attribute name `mpich`
156+
157+- [MVAPICH](https://mvapich.cse.ohio-state.edu/), attribute name `mvapich`
158+
159+To provide MPI enabled applications that use `MPICH`, instead of the default `Open MPI`, simply use the following overlay:
160+
161+```nix
162+self: super:
163+
164+{
165+ mpi = self.mpich;
166+}
167+```
doc/using/overrides.chapter.mdnew file+108
This diff is too big to show here.
flake.nixnew file+49
This diff is too big to show here.
lib/asserts.nixnew file+42
This diff is too big to show here.
lib/attrsets.nixnew file+630
This diff is too big to show here.
lib/cli.nixnew file+83
This diff is too big to show here.
lib/customisation.nixnew file+296
This diff is too big to show here.
lib/debug.nixnew file+291
This diff is too big to show here.
lib/default.nixnew file+160
This diff is too big to show here.
lib/deprecated.nixnew file+278
This diff is too big to show here.
lib/fetchers.nixnew file+13
This diff is too big to show here.
lib/filesystem.nixnew file+57
This diff is too big to show here.
lib/fixed-points.nixnew file+113
This diff is too big to show here.
lib/flake.nixnew file+5
This diff is too big to show here.
lib/flakes.nixnew file+22
This diff is too big to show here.
lib/generators.nixnew file+406
This diff is too big to show here.
lib/kernel.nixnew file+26
This diff is too big to show here.
lib/licenses.nixnew file+964
This diff is too big to show here.
lib/lists.nixnew file+669
This diff is too big to show here.
lib/meta.nixnew file+143
This diff is too big to show here.
lib/minver.nixnew file+2
This diff is too big to show here.
lib/modules.nixnew file+1198
This diff is too big to show here.
lib/options.nixnew file+330
This diff is too big to show here.
lib/sources.nixnew file+284
This diff is too big to show here.
lib/strings-with-deps.nixnew file+84
This diff is too big to show here.
lib/strings.nixnew file+968
This diff is too big to show here.
lib/systems/architectures.nixnew file+107
This diff is too big to show here.
lib/systems/default.nixnew file+186
This diff is too big to show here.
lib/systems/doubles.nixnew file+110
This diff is too big to show here.
lib/systems/examples.nixnew file+333
This diff is too big to show here.
lib/systems/inspect.nixnew file+79
This diff is too big to show here.
lib/systems/parse.nixnew file+496
This diff is too big to show here.
lib/systems/platforms.nixnew file+572
This diff is too big to show here.
lib/systems/supported.nixnew file+26
This diff is too big to show here.
lib/tests/check-eval.nixnew file+7
This diff is too big to show here.
lib/tests/flakes/subflakeTest/flake.nixnew file+8
This diff is too big to show here.
lib/tests/flakes/subflakeTest/subflake/flake.nixnew file+5
This diff is too big to show here.
lib/tests/maintainers.nixnew file+80
This diff is too big to show here.
lib/tests/misc.nixnew file+1192
This diff is too big to show here.
lib/tests/modules.shnew file+343
This diff is too big to show here.
lib/tests/modules/adhoc-freeformType-survives-type-merge.nixnew file+14
This diff is too big to show here.
lib/tests/modules/alias-with-priority-can-override.nixnew file+55
This diff is too big to show here.
lib/tests/modules/alias-with-priority.nixnew file+55
This diff is too big to show here.
lib/tests/modules/attrsOf-conditional-check.nixnew file+7
This diff is too big to show here.
lib/tests/modules/attrsOf-lazy-check.nixnew file+7
This diff is too big to show here.
lib/tests/modules/declare-attrsOf.nixnew file+13
This diff is too big to show here.
lib/tests/modules/declare-attrsOfSub-any-enable.nixnew file+29
This diff is too big to show here.
lib/tests/modules/declare-bare-submodule-deep-option-duplicate.nixnew file+10
This diff is too big to show here.
lib/tests/modules/declare-bare-submodule-deep-option.nixnew file+10
This diff is too big to show here.
lib/tests/modules/declare-bare-submodule-nested-option.nixnew file+19
This diff is too big to show here.
lib/tests/modules/declare-bare-submodule.nixnew file+18
This diff is too big to show here.
lib/tests/modules/declare-coerced-value-unsound.nixnew file+10
This diff is too big to show here.
lib/tests/modules/declare-coerced-value.nixnew file+10
This diff is too big to show here.
lib/tests/modules/declare-either.nixnew file+5
This diff is too big to show here.
lib/tests/modules/declare-enable-nested.nixnew file+14
This diff is too big to show here.
lib/tests/modules/declare-enable.nixnew file+14
This diff is too big to show here.
lib/tests/modules/declare-int-between-value.nixnew file+9
This diff is too big to show here.
lib/tests/modules/declare-int-positive-value-nested.nixnew file+9
This diff is too big to show here.
lib/tests/modules/declare-int-positive-value.nixnew file+9
This diff is too big to show here.
lib/tests/modules/declare-int-unsigned-value.nixnew file+9
This diff is too big to show here.
lib/tests/modules/declare-lazyAttrsOf.nixnew file+6
This diff is too big to show here.
lib/tests/modules/declare-oneOf.nixnew file+9
This diff is too big to show here.
lib/tests/modules/declare-set.nixnew file+12
This diff is too big to show here.
lib/tests/modules/declare-submodule-via-evalModules.nixnew file+28
This diff is too big to show here.
lib/tests/modules/declare-submoduleWith-modules.nixnew file+28
This diff is too big to show here.
lib/tests/modules/declare-submoduleWith-noshorthand.nixnew file+13
This diff is too big to show here.
lib/tests/modules/declare-submoduleWith-path.nixnew file+12
This diff is too big to show here.
lib/tests/modules/declare-submoduleWith-shorthand.nixnew file+14
This diff is too big to show here.
lib/tests/modules/declare-submoduleWith-special.nixnew file+17
This diff is too big to show here.
lib/tests/modules/declare-variants.nixnew file+9
This diff is too big to show here.
lib/tests/modules/default.nixnew file+8
This diff is too big to show here.
lib/tests/modules/define-_module-args-custom.nixnew file+7
This diff is too big to show here.
lib/tests/modules/define-attrsOfSub-bar-enable.nixnew file+3
This diff is too big to show here.
lib/tests/modules/define-attrsOfSub-bar.nixnew file+3
This diff is too big to show here.
lib/tests/modules/define-attrsOfSub-foo-enable-force.nixnew file+5
This diff is too big to show here.
lib/tests/modules/define-attrsOfSub-foo-enable-if.nixnew file+5
This diff is too big to show here.
lib/tests/modules/define-attrsOfSub-foo-enable.nixnew file+3
This diff is too big to show here.
lib/tests/modules/define-attrsOfSub-foo-force-enable.nixnew file+7
This diff is too big to show here.
lib/tests/modules/define-attrsOfSub-foo-if-enable.nixnew file+7
This diff is too big to show here.
lib/tests/modules/define-attrsOfSub-foo.nixnew file+3
This diff is too big to show here.
lib/tests/modules/define-attrsOfSub-force-foo-enable.nixnew file+7
This diff is too big to show here.
lib/tests/modules/define-attrsOfSub-if-foo-enable.nixnew file+7
This diff is too big to show here.
lib/tests/modules/define-bare-submodule-values.nixnew file+4
This diff is too big to show here.
lib/tests/modules/define-enable-force.nixnew file+5
This diff is too big to show here.
lib/tests/modules/define-enable-with-custom-arg.nixnew file+7
This diff is too big to show here.
lib/tests/modules/define-enable.nixnew file+3
This diff is too big to show here.
lib/tests/modules/define-force-attrsOfSub-foo-enable.nixnew file+5
This diff is too big to show here.
lib/tests/modules/define-force-enable.nixnew file+5
This diff is too big to show here.
lib/tests/modules/define-if-attrsOfSub-foo-enable.nixnew file+5
This diff is too big to show here.
lib/tests/modules/define-module-check.nixnew file+3
This diff is too big to show here.
lib/tests/modules/define-option-dependently-nested.nixnew file+16
This diff is too big to show here.
lib/tests/modules/define-option-dependently.nixnew file+16
This diff is too big to show here.
lib/tests/modules/define-shorthandOnlyDefinesConfig-true.nixnew file+1
This diff is too big to show here.
lib/tests/modules/define-submoduleWith-noshorthand.nixnew file+3
This diff is too big to show here.
lib/tests/modules/define-submoduleWith-shorthand.nixnew file+3
This diff is too big to show here.
lib/tests/modules/define-value-int-negative.nixnew file+3
This diff is too big to show here.
lib/tests/modules/define-value-int-positive.nixnew file+3
This diff is too big to show here.
lib/tests/modules/define-value-int-zero.nixnew file+3
This diff is too big to show here.
lib/tests/modules/define-value-list.nixnew file+3
This diff is too big to show here.
lib/tests/modules/define-value-string-arbitrary.nixnew file+3
This diff is too big to show here.
lib/tests/modules/define-value-string-bigint.nixnew file+3
This diff is too big to show here.
lib/tests/modules/define-value-string-properties.nixnew file+12
This diff is too big to show here.
lib/tests/modules/define-value-string.nixnew file+3
This diff is too big to show here.
lib/tests/modules/define-variant.nixnew file+22
This diff is too big to show here.
lib/tests/modules/disable-declare-enable.nixnew file+5
This diff is too big to show here.
lib/tests/modules/disable-define-enable.nixnew file+5
This diff is too big to show here.
lib/tests/modules/disable-enable-modules.nixnew file+5
This diff is too big to show here.
lib/tests/modules/disable-recursive/bar.nixnew file+5
This diff is too big to show here.
lib/tests/modules/disable-recursive/disable-bar.nixnew file+7
This diff is too big to show here.
lib/tests/modules/disable-recursive/disable-foo.nixnew file+7
This diff is too big to show here.
lib/tests/modules/disable-recursive/foo.nixnew file+5
This diff is too big to show here.
lib/tests/modules/disable-recursive/main.nixnew file+8
This diff is too big to show here.
lib/tests/modules/emptyValues.nixnew file+36
This diff is too big to show here.
lib/tests/modules/extendModules-168767-imports.nixnew file+41
This diff is too big to show here.
lib/tests/modules/freeform-attrsOf.nixnew file+3
This diff is too big to show here.
lib/tests/modules/freeform-lazyAttrsOf.nixnew file+3
This diff is too big to show here.
lib/tests/modules/freeform-nested.nixnew file+14
This diff is too big to show here.
lib/tests/modules/freeform-str-dep-unstr.nixnew file+8
This diff is too big to show here.
lib/tests/modules/freeform-submodules.nixnew file+22
This diff is too big to show here.
lib/tests/modules/freeform-unstr-dep-str.nixnew file+8
This diff is too big to show here.
lib/tests/modules/functionTo/list-order.nixnew file+25
This diff is too big to show here.
lib/tests/modules/functionTo/merging-attrs.nixnew file+27
This diff is too big to show here.
lib/tests/modules/functionTo/merging-list.nixnew file+24
This diff is too big to show here.
lib/tests/modules/functionTo/trivial.nixnew file+17
This diff is too big to show here.
lib/tests/modules/functionTo/wrong-type.nixnew file+18
This diff is too big to show here.
lib/tests/modules/import-custom-arg.nixnew file+6
This diff is too big to show here.
lib/tests/modules/import-from-store.nixnew file+11
This diff is too big to show here.
lib/tests/modules/optionTypeFile.nixnew file+28
This diff is too big to show here.
lib/tests/modules/optionTypeMerging.nixnew file+27
This diff is too big to show here.
lib/tests/modules/raw.nixnew file+30
This diff is too big to show here.
lib/tests/modules/types-anything/attrs-coercible.nixnew file+12
This diff is too big to show here.
lib/tests/modules/types-anything/equal-atoms.nixnew file+26
This diff is too big to show here.
lib/tests/modules/types-anything/functions.nixnew file+23
This diff is too big to show here.
lib/tests/modules/types-anything/lists.nixnew file+16
This diff is too big to show here.
lib/tests/modules/types-anything/mk-mods.nixnew file+44
This diff is too big to show here.
lib/tests/modules/types-anything/nested-attrs.nixnew file+22
This diff is too big to show here.
lib/tests/release.nixnew file+40
This diff is too big to show here.
lib/tests/sources.shnew file+61
This diff is too big to show here.
lib/tests/systems.nixnew file+39
This diff is too big to show here.
lib/trivial.nixnew file+513
This diff is too big to show here.
lib/types.nixnew file+764
This diff is too big to show here.
lib/versions.nixnew file+49
This diff is too big to show here.
lib/zip-int-bits.nixnew file+39
This diff is too big to show here.
maintainers/docs/bugs.txtdeleted−62
This diff is too big to show here.
maintainers/docs/classification.txtdeleted−116
This diff is too big to show here.
maintainers/docs/static-initial-envdeleted−32
This diff is too big to show here.
maintainers/docs/todo.txtdeleted−16
This diff is too big to show here.
maintainers/docs/uclibc-cross.txtdeleted−27
This diff is too big to show here.
maintainers/maintainer-list.nixnew file+14481
This diff is too big to show here.
maintainers/scripts/all-tarballs.nixnew file+16
This diff is too big to show here.
maintainers/scripts/build.nixnew file+55
This diff is too big to show here.
maintainers/scripts/check-hydra-by-maintainer.nixnew file+68
This diff is too big to show here.
maintainers/scripts/check-maintainer-github-handles.shnew file+66
This diff is too big to show here.
maintainers/scripts/copy-tarballs.plnew file+240
This diff is too big to show here.
maintainers/scripts/db-to-md.shnew file+88
This diff is too big to show here.
maintainers/scripts/debian-patches.shnew file+34
This diff is too big to show here.
maintainers/scripts/dep-licenses.shnew file+57
This diff is too big to show here.
maintainers/scripts/doc/escape-code-markup.pynew file+97
This diff is too big to show here.
maintainers/scripts/doc/replace-xrefs-by-empty-links.pynew file+32
This diff is too big to show here.
maintainers/scripts/doc/unknown-code-language.luanew file+12
This diff is too big to show here.
maintainers/scripts/evacuate-urls.shdeleted−36
This diff is too big to show here.
maintainers/scripts/eval-release.nixnew file+24
This diff is too big to show here.
maintainers/scripts/eval-release.shnew file+11
This diff is too big to show here.
maintainers/scripts/feature-freeze-teams.plnew file+98
This diff is too big to show here.
maintainers/scripts/fetch-kde-qt.shnew file+61
This diff is too big to show here.
maintainers/scripts/find-tarballs.nixnew file+50
This diff is too big to show here.
maintainers/scripts/haskell/dependencies.nixnew file+10
This diff is too big to show here.
maintainers/scripts/haskell/hydra-report.hsnew file+490
This diff is too big to show here.
maintainers/scripts/haskell/maintained-broken-pkgs.nixnew file+22
This diff is too big to show here.
maintainers/scripts/haskell/maintainer-handles.nixnew file+7
This diff is too big to show here.
maintainers/scripts/haskell/mark-broken.shnew file+47
This diff is too big to show here.
maintainers/scripts/haskell/merge-and-open-pr.shnew file+122
This diff is too big to show here.
maintainers/scripts/haskell/regenerate-hackage-packages.shnew file+46
This diff is too big to show here.
maintainers/scripts/haskell/regenerate-transitive-broken-packages.shnew file+15
This diff is too big to show here.
maintainers/scripts/haskell/test-configurations.nixnew file+136
This diff is too big to show here.
maintainers/scripts/haskell/transitive-broken-packages.nixnew file+16
This diff is too big to show here.
maintainers/scripts/haskell/update-cabal2nix-unstable.shnew file+17
This diff is too big to show here.
maintainers/scripts/haskell/update-hackage.shnew file+35
This diff is too big to show here.
maintainers/scripts/haskell/update-stackage.shnew file+70
This diff is too big to show here.
maintainers/scripts/haskell/upload-nixos-package-list-to-hackage.shnew file+22
This diff is too big to show here.
maintainers/scripts/hydra-eval-failures.pynew file+112
This diff is too big to show here.
maintainers/scripts/hydra_eval_checknew file+13
This diff is too big to show here.
maintainers/scripts/luarocks-config.luanew file+4
This diff is too big to show here.
maintainers/scripts/luarocks-packages.csvnew file+87
This diff is too big to show here.
maintainers/scripts/nix-call-packagenew file+5
This diff is too big to show here.
maintainers/scripts/nix-diff.shnew file+277
This diff is too big to show here.
maintainers/scripts/nix-generate-from-cpan.nixnew file+25
This diff is too big to show here.
maintainers/scripts/nix-generate-from-cpan.plnew file+466
This diff is too big to show here.
maintainers/scripts/nixpkgs-lint.nixnew file+24
This diff is too big to show here.
maintainers/scripts/nixpkgs-lint.plnew file+173
This diff is too big to show here.
maintainers/scripts/patchelf-hints.shnew file+84
This diff is too big to show here.
maintainers/scripts/pluginupdate.pynew file+701
This diff is too big to show here.
maintainers/scripts/rebuild-amount.shnew file+133
This diff is too big to show here.
maintainers/scripts/remove-old-aliases.pynew file+211
This diff is too big to show here.
maintainers/scripts/update-channel-branches.shnew file+112
This diff is too big to show here.
maintainers/scripts/update-luarocks-packagesnew file+218
This diff is too big to show here.
maintainers/scripts/update-luarocks-shell.nixnew file+13
This diff is too big to show here.
maintainers/scripts/update-python-librariesnew file+5
This diff is too big to show here.
maintainers/scripts/update-redirected-urls.shnew file+12
This diff is too big to show here.
maintainers/scripts/update-ruby-packagesnew file+16
This diff is too big to show here.
maintainers/scripts/update.nixnew file+212
This diff is too big to show here.
maintainers/scripts/update.pynew file+229
This diff is too big to show here.
maintainers/scripts/vanity-manual-equalities.txtnew file+7
This diff is too big to show here.
maintainers/scripts/vanity.shnew file+122
This diff is too big to show here.
maintainers/team-list.nixnew file+669
This diff is too big to show here.
nixos/COPYINGnew file+18
This diff is too big to show here.
nixos/READMEnew file+5
This diff is too big to show here.
nixos/default.nixnew file+20
This diff is too big to show here.
nixos/doc/manual/.gitignorenew file+2
This diff is too big to show here.
nixos/doc/manual/Makefilenew file+30
This diff is too big to show here.
nixos/doc/manual/README.mdnew file+3
This diff is too big to show here.
nixos/doc/manual/administration/boot-problems.section.mdnew file+41
This diff is too big to show here.
nixos/doc/manual/administration/cleaning-store.chapter.mdnew file+62
This diff is too big to show here.
nixos/doc/manual/administration/container-networking.section.mdnew file+44
This diff is too big to show here.
nixos/doc/manual/administration/containers.chapter.mdnew file+28
This diff is too big to show here.
nixos/doc/manual/administration/control-groups.chapter.mdnew file+59
This diff is too big to show here.
nixos/doc/manual/administration/declarative-containers.section.mdnew file+48
This diff is too big to show here.
nixos/doc/manual/administration/imperative-containers.section.mdnew file+115
This diff is too big to show here.
nixos/doc/manual/administration/logging.chapter.mdnew file+38
This diff is too big to show here.
nixos/doc/manual/administration/maintenance-mode.section.mdnew file+11
This diff is too big to show here.
nixos/doc/manual/administration/network-problems.section.mdnew file+21
This diff is too big to show here.
nixos/doc/manual/administration/rebooting.chapter.mdnew file+30
This diff is too big to show here.
nixos/doc/manual/administration/rollback.section.mdnew file+38
This diff is too big to show here.
nixos/doc/manual/administration/running.xmlnew file+21
This diff is too big to show here.
nixos/doc/manual/administration/service-mgmt.chapter.mdnew file+120
This diff is too big to show here.
nixos/doc/manual/administration/store-corruption.section.mdnew file+28
This diff is too big to show here.
nixos/doc/manual/administration/troubleshooting.chapter.mdnew file+12
This diff is too big to show here.
nixos/doc/manual/administration/user-sessions.chapter.mdnew file+43
This diff is too big to show here.
nixos/doc/manual/configuration/abstractions.section.mdnew file+80
This diff is too big to show here.
nixos/doc/manual/configuration/ad-hoc-network-config.section.mdnew file+13
This diff is too big to show here.
nixos/doc/manual/configuration/ad-hoc-packages.section.mdnew file+51
This diff is too big to show here.
nixos/doc/manual/configuration/adding-custom-packages.section.mdnew file+74
This diff is too big to show here.
nixos/doc/manual/configuration/config-file.section.mdnew file+175
This diff is too big to show here.
nixos/doc/manual/configuration/config-syntax.chapter.mdnew file+19
This diff is too big to show here.
nixos/doc/manual/configuration/configuration.xmlnew file+31
This diff is too big to show here.
nixos/doc/manual/configuration/customizing-packages.section.mdnew file+74
This diff is too big to show here.
nixos/doc/manual/configuration/declarative-packages.section.mdnew file+46
This diff is too big to show here.
nixos/doc/manual/configuration/file-systems.chapter.mdnew file+42
This diff is too big to show here.
nixos/doc/manual/configuration/firewall.section.mdnew file+32
This diff is too big to show here.
nixos/doc/manual/configuration/gpu-accel.chapter.mdnew file+204
This diff is too big to show here.
nixos/doc/manual/configuration/ipv4-config.section.mdnew file+35
This diff is too big to show here.
nixos/doc/manual/configuration/ipv6-config.section.mdnew file+42
This diff is too big to show here.
nixos/doc/manual/configuration/kubernetes.chapter.mdnew file+104
This diff is too big to show here.
nixos/doc/manual/configuration/linux-kernel.chapter.mdnew file+140
This diff is too big to show here.
nixos/doc/manual/configuration/luks-file-systems.section.mdnew file+77
This diff is too big to show here.
nixos/doc/manual/configuration/modularity.section.mdnew file+133
This diff is too big to show here.
nixos/doc/manual/configuration/network-manager.section.mdnew file+42
This diff is too big to show here.
nixos/doc/manual/configuration/networking.chapter.mdnew file+16
This diff is too big to show here.
nixos/doc/manual/configuration/package-mgmt.chapter.mdnew file+18
This diff is too big to show here.
nixos/doc/manual/configuration/profiles.chapter.mdnew file+34
This diff is too big to show here.
nixos/doc/manual/configuration/profiles/all-hardware.section.mdnew file+11
This diff is too big to show here.
nixos/doc/manual/configuration/profiles/base.section.mdnew file+7
This diff is too big to show here.
nixos/doc/manual/configuration/profiles/clone-config.section.mdnew file+11
This diff is too big to show here.
nixos/doc/manual/configuration/profiles/demo.section.mdnew file+4
This diff is too big to show here.
nixos/doc/manual/configuration/profiles/docker-container.section.mdnew file+7
This diff is too big to show here.
nixos/doc/manual/configuration/profiles/graphical.section.mdnew file+10
This diff is too big to show here.
nixos/doc/manual/configuration/profiles/hardened.section.mdnew file+20
This diff is too big to show here.
nixos/doc/manual/configuration/profiles/headless.section.mdnew file+9
This diff is too big to show here.
nixos/doc/manual/configuration/profiles/installation-device.section.mdnew file+24
This diff is too big to show here.
nixos/doc/manual/configuration/profiles/minimal.section.mdnew file+9
This diff is too big to show here.
nixos/doc/manual/configuration/profiles/qemu-guest.section.mdnew file+7
This diff is too big to show here.
nixos/doc/manual/configuration/renaming-interfaces.section.mdnew file+51
This diff is too big to show here.
nixos/doc/manual/configuration/ssh.section.mdnew file+19
This diff is too big to show here.
nixos/doc/manual/configuration/sshfs-file-systems.section.mdnew file+104
This diff is too big to show here.
nixos/doc/manual/configuration/subversion.chapter.mdnew file+102
This diff is too big to show here.
nixos/doc/manual/configuration/summary.section.mdnew file+46
This diff is too big to show here.
nixos/doc/manual/configuration/user-mgmt.chapter.mdnew file+92
This diff is too big to show here.
nixos/doc/manual/configuration/wayland.chapter.mdnew file+27
This diff is too big to show here.
nixos/doc/manual/configuration/wireless.section.mdnew file+67
This diff is too big to show here.
nixos/doc/manual/configuration/x-windows.chapter.mdnew file+337
This diff is too big to show here.
nixos/doc/manual/configuration/xfce.chapter.mdnew file+52
This diff is too big to show here.
nixos/doc/manual/contributing-to-this-manual.chapter.mdnew file+13
This diff is too big to show here.
nixos/doc/manual/default.nixnew file+268
This diff is too big to show here.
nixos/doc/manual/development/activation-script.section.mdnew file+72
This diff is too big to show here.
nixos/doc/manual/development/assertions.section.mdnew file+40
This diff is too big to show here.
nixos/doc/manual/development/building-parts.chapter.mdnew file+74
This diff is too big to show here.
nixos/doc/manual/development/development.xmlnew file+19
This diff is too big to show here.
nixos/doc/manual/development/freeform-modules.section.mdnew file+79
This diff is too big to show here.
nixos/doc/manual/development/importing-modules.section.mdnew file+46
This diff is too big to show here.
nixos/doc/manual/development/linking-nixos-tests-to-packages.section.mdnew file+6
This diff is too big to show here.
nixos/doc/manual/development/meta-attributes.section.mdnew file+66
This diff is too big to show here.
nixos/doc/manual/development/nixos-tests.chapter.mdnew file+13
This diff is too big to show here.
nixos/doc/manual/development/option-declarations.section.mdnew file+221
This diff is too big to show here.
nixos/doc/manual/development/option-def.section.mdnew file+91
This diff is too big to show here.
nixos/doc/manual/development/option-types.section.mdnew file+583
This diff is too big to show here.
nixos/doc/manual/development/replace-modules.section.mdnew file+64
This diff is too big to show here.
nixos/doc/manual/development/running-nixos-tests-interactively.section.mdnew file+35
This diff is too big to show here.
nixos/doc/manual/development/running-nixos-tests.section.mdnew file+31
This diff is too big to show here.
nixos/doc/manual/development/settings-options.section.mdnew file+251
This diff is too big to show here.
nixos/doc/manual/development/sources.chapter.mdnew file+77
This diff is too big to show here.
nixos/doc/manual/development/testing-installer.chapter.mdnew file+18
This diff is too big to show here.
nixos/doc/manual/development/unit-handling.section.mdnew file+62
This diff is too big to show here.
nixos/doc/manual/development/what-happens-during-a-system-switch.chapter.mdnew file+53
This diff is too big to show here.
nixos/doc/manual/development/writing-documentation.chapter.mdnew file+93
This diff is too big to show here.
nixos/doc/manual/development/writing-modules.chapter.mdnew file+208
This diff is too big to show here.
nixos/doc/manual/development/writing-nixos-tests.section.mdnew file+382
This diff is too big to show here.
nixos/doc/manual/from_md/README.mdnew file+5
This diff is too big to show here.
nixos/doc/manual/from_md/administration/boot-problems.section.xmlnew file+144
This diff is too big to show here.
nixos/doc/manual/from_md/administration/cleaning-store.chapter.xmlnew file+72
This diff is too big to show here.
nixos/doc/manual/from_md/administration/container-networking.section.xmlnew file+54
This diff is too big to show here.
nixos/doc/manual/from_md/administration/containers.chapter.xmlnew file+31
This diff is too big to show here.
nixos/doc/manual/from_md/administration/control-groups.chapter.xmlnew file+67
This diff is too big to show here.
nixos/doc/manual/from_md/administration/declarative-containers.section.xmlnew file+60
This diff is too big to show here.
nixos/doc/manual/from_md/administration/imperative-containers.section.xmlnew file+132
This diff is too big to show here.
nixos/doc/manual/from_md/administration/logging.chapter.xmlnew file+45
This diff is too big to show here.
nixos/doc/manual/from_md/administration/maintenance-mode.section.xmlnew file+14
This diff is too big to show here.
nixos/doc/manual/from_md/administration/network-problems.section.xmlnew file+25
This diff is too big to show here.
nixos/doc/manual/from_md/administration/rebooting.chapter.xmlnew file+38
This diff is too big to show here.
nixos/doc/manual/from_md/administration/rollback.section.xmlnew file+42
This diff is too big to show here.
nixos/doc/manual/from_md/administration/service-mgmt.chapter.xmlnew file+141
This diff is too big to show here.
nixos/doc/manual/from_md/administration/store-corruption.section.xmlnew file+34
This diff is too big to show here.
nixos/doc/manual/from_md/administration/troubleshooting.chapter.xmlnew file+12
This diff is too big to show here.
nixos/doc/manual/from_md/administration/user-sessions.chapter.xmlnew file+46
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/abstractions.section.xmlnew file+101
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/ad-hoc-network-config.section.xmlnew file+16
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/ad-hoc-packages.section.xmlnew file+59
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/adding-custom-packages.section.xmlnew file+80
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/config-file.section.xmlnew file+231
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/config-syntax.chapter.xmlnew file+21
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/customizing-packages.section.xmlnew file+90
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/declarative-packages.section.xmlnew file+53
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/file-systems.chapter.xmlnew file+55
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/firewall.section.xmlnew file+39
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/gpu-accel.chapter.xmlnew file+239
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/ipv4-config.section.xmlnew file+43
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/ipv6-config.section.xmlnew file+47
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/kubernetes.chapter.xmlnew file+126
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/linux-kernel.chapter.xmlnew file+157
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/luks-file-systems.section.xmlnew file+84
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/modularity.section.xmlnew file+152
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/network-manager.section.xmlnew file+49
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/networking.chapter.xmlnew file+15
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/package-mgmt.chapter.xmlnew file+28
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/profiles.chapter.xmlnew file+38
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/profiles/all-hardware.section.xmlnew file+15
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/profiles/base.section.xmlnew file+10
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/profiles/clone-config.section.xmlnew file+16
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/profiles/demo.section.xmlnew file+10
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/profiles/docker-container.section.xmlnew file+12
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/profiles/graphical.section.xmlnew file+14
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/profiles/hardened.section.xmlnew file+25
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/profiles/headless.section.xmlnew file+15
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/profiles/installation-device.section.xmlnew file+32
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/profiles/minimal.section.xmlnew file+13
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/profiles/qemu-guest.section.xmlnew file+11
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/renaming-interfaces.section.xmlnew file+62
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/ssh.section.xmlnew file+23
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/sshfs-file-systems.section.xmlnew file+139
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/subversion.chapter.xmlnew file+121
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/summary.section.xmlnew file+332
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/user-mgmt.chapter.xmlnew file+105
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/wayland.chapter.xmlnew file+31
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/wireless.section.xmlnew file+73
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/x-windows.chapter.xmlnew file+381
This diff is too big to show here.
nixos/doc/manual/from_md/configuration/xfce.chapter.xmlnew file+62
This diff is too big to show here.
nixos/doc/manual/from_md/contributing-to-this-manual.chapter.xmlnew file+22
This diff is too big to show here.
nixos/doc/manual/from_md/development/activation-script.section.xmlnew file+150
This diff is too big to show here.
nixos/doc/manual/from_md/development/assertions.section.xmlnew file+58
This diff is too big to show here.
nixos/doc/manual/from_md/development/building-parts.chapter.xmlnew file+124
This diff is too big to show here.
nixos/doc/manual/from_md/development/freeform-modules.section.xmlnew file+87
This diff is too big to show here.
nixos/doc/manual/from_md/development/importing-modules.section.xmlnew file+47
This diff is too big to show here.
nixos/doc/manual/from_md/development/linking-nixos-tests-to-packages.section.xmlnew file+10
This diff is too big to show here.
nixos/doc/manual/from_md/development/meta-attributes.section.xmlnew file+95
This diff is too big to show here.
nixos/doc/manual/from_md/development/nixos-tests.chapter.xmlnew file+14
This diff is too big to show here.
nixos/doc/manual/from_md/development/option-declarations.section.xmlnew file+327
This diff is too big to show here.
nixos/doc/manual/from_md/development/option-def.section.xmlnew file+104
This diff is too big to show here.
nixos/doc/manual/from_md/development/option-types.section.xmlnew file+1038
This diff is too big to show here.
nixos/doc/manual/from_md/development/replace-modules.section.xmlnew file+70
This diff is too big to show here.
nixos/doc/manual/from_md/development/running-nixos-tests-interactively.section.xmlnew file+39
This diff is too big to show here.
nixos/doc/manual/from_md/development/running-nixos-tests.section.xmlnew file+34
This diff is too big to show here.
nixos/doc/manual/from_md/development/settings-options.section.xmlnew file+421
This diff is too big to show here.
nixos/doc/manual/from_md/development/sources.chapter.xmlnew file+90
This diff is too big to show here.
nixos/doc/manual/from_md/development/testing-installer.chapter.xmlnew file+22
This diff is too big to show here.
nixos/doc/manual/from_md/development/unit-handling.section.xmlnew file+131
This diff is too big to show here.
nixos/doc/manual/from_md/development/what-happens-during-a-system-switch.chapter.xmlnew file+122
This diff is too big to show here.
nixos/doc/manual/from_md/development/writing-documentation.chapter.xmlnew file+144
This diff is too big to show here.
nixos/doc/manual/from_md/development/writing-modules.chapter.xmlnew file+245
This diff is too big to show here.
nixos/doc/manual/from_md/development/writing-nixos-tests.section.xmlnew file+655
This diff is too big to show here.
nixos/doc/manual/from_md/installation/building-nixos.chapter.xmlnew file+106
This diff is too big to show here.
nixos/doc/manual/from_md/installation/changing-config.chapter.xmlnew file+117
This diff is too big to show here.
nixos/doc/manual/from_md/installation/installing-behind-a-proxy.section.xmlnew file+41
This diff is too big to show here.
nixos/doc/manual/from_md/installation/installing-from-other-distro.section.xmlnew file+388
This diff is too big to show here.
nixos/doc/manual/from_md/installation/installing-pxe.section.xmlnew file+42
This diff is too big to show here.
nixos/doc/manual/from_md/installation/installing-usb.section.xmlnew file+35
This diff is too big to show here.
nixos/doc/manual/from_md/installation/installing-virtualbox-guest.section.xmlnew file+92
This diff is too big to show here.
nixos/doc/manual/from_md/installation/installing.chapter.xmlnew file+645
This diff is too big to show here.
nixos/doc/manual/from_md/installation/obtaining.chapter.xmlnew file+48
This diff is too big to show here.
nixos/doc/manual/from_md/installation/upgrading.chapter.xmlnew file+152
This diff is too big to show here.
nixos/doc/manual/from_md/release-notes/rl-1310.section.xmlnew file+6
This diff is too big to show here.
nixos/doc/manual/from_md/release-notes/rl-1404.section.xmlnew file+189
This diff is too big to show here.
nixos/doc/manual/from_md/release-notes/rl-1412.section.xmlnew file+466
This diff is too big to show here.
nixos/doc/manual/from_md/release-notes/rl-1509.section.xmlnew file+776
This diff is too big to show here.
nixos/doc/manual/from_md/release-notes/rl-1603.section.xmlnew file+695
This diff is too big to show here.
nixos/doc/manual/from_md/release-notes/rl-1609.section.xmlnew file+273
This diff is too big to show here.
nixos/doc/manual/from_md/release-notes/rl-1703.section.xmlnew file+818
This diff is too big to show here.
nixos/doc/manual/from_md/release-notes/rl-1709.section.xmlnew file+922
This diff is too big to show here.
nixos/doc/manual/from_md/release-notes/rl-1803.section.xmlnew file+879
This diff is too big to show here.
nixos/doc/manual/from_md/release-notes/rl-1809.section.xmlnew file+941
This diff is too big to show here.
nixos/doc/manual/from_md/release-notes/rl-1903.section.xmlnew file+790
This diff is too big to show here.
nixos/doc/manual/from_md/release-notes/rl-1909.section.xmlnew file+1197
This diff is too big to show here.
nixos/doc/manual/from_md/release-notes/rl-2003.section.xmlnew file+1497
This diff is too big to show here.
nixos/doc/manual/from_md/release-notes/rl-2009.section.xmlnew file+2210
This diff is too big to show here.
nixos/doc/manual/from_md/release-notes/rl-2105.section.xmlnew file+1567
This diff is too big to show here.
nixos/doc/manual/from_md/release-notes/rl-2111.section.xmlnew file+2091
This diff is too big to show here.
nixos/doc/manual/from_md/release-notes/rl-2205.section.xmlnew file+2470
This diff is too big to show here.
nixos/doc/manual/installation/building-nixos.chapter.mdnew file+77
This diff is too big to show here.
nixos/doc/manual/installation/changing-config.chapter.mdnew file+100
This diff is too big to show here.
nixos/doc/manual/installation/installation.xmlnew file+18
This diff is too big to show here.
nixos/doc/manual/installation/installing-behind-a-proxy.section.mdnew file+29
This diff is too big to show here.
nixos/doc/manual/installation/installing-from-other-distro.section.mdnew file+279
This diff is too big to show here.
nixos/doc/manual/installation/installing-pxe.section.mdnew file+32
This diff is too big to show here.
nixos/doc/manual/installation/installing-usb.section.mdnew file+31
This diff is too big to show here.
nixos/doc/manual/installation/installing-virtualbox-guest.section.mdnew file+59
This diff is too big to show here.
nixos/doc/manual/installation/installing.chapter.mdnew file+482
This diff is too big to show here.
nixos/doc/manual/installation/obtaining.chapter.mdnew file+26
This diff is too big to show here.
nixos/doc/manual/installation/upgrading.chapter.mdnew file+118
This diff is too big to show here.
nixos/doc/manual/man-configuration.xmlnew file+31
This diff is too big to show here.
nixos/doc/manual/man-nixos-build-vms.xmlnew file+138
This diff is too big to show here.
nixos/doc/manual/man-nixos-enter.xmlnew file+154
This diff is too big to show here.
nixos/doc/manual/man-nixos-generate-config.xmlnew file+214
This diff is too big to show here.
nixos/doc/manual/man-nixos-install.xmlnew file+357
This diff is too big to show here.
nixos/doc/manual/man-nixos-option.xmlnew file+134
This diff is too big to show here.
nixos/doc/manual/man-nixos-rebuild.xmlnew file+716
This diff is too big to show here.
nixos/doc/manual/man-nixos-version.xmlnew file+137
This diff is too big to show here.
nixos/doc/manual/man-pages.xmlnew file+25
This diff is too big to show here.
nixos/doc/manual/manual.xmlnew file+24
This diff is too big to show here.
nixos/doc/manual/md-to-db.shnew file+49
This diff is too big to show here.
nixos/doc/manual/preface.xmlnew file+42
This diff is too big to show here.
nixos/doc/manual/release-notes/release-notes.xmlnew file+28
This diff is too big to show here.
nixos/doc/manual/release-notes/rl-1310.section.mdnew file+3
This diff is too big to show here.
nixos/doc/manual/release-notes/rl-1404.section.mdnew file+81
This diff is too big to show here.
nixos/doc/manual/release-notes/rl-1412.section.mdnew file+171
This diff is too big to show here.
nixos/doc/manual/release-notes/rl-1509.section.mdnew file+319
This diff is too big to show here.
nixos/doc/manual/release-notes/rl-1603.section.mdnew file+282
This diff is too big to show here.
nixos/doc/manual/release-notes/rl-1609.section.mdnew file+73
This diff is too big to show here.
nixos/doc/manual/release-notes/rl-1703.section.mdnew file+303
This diff is too big to show here.
nixos/doc/manual/release-notes/rl-1709.section.mdnew file+316
This diff is too big to show here.
nixos/doc/manual/release-notes/rl-1803.section.mdnew file+286
This diff is too big to show here.
nixos/doc/manual/release-notes/rl-1809.section.mdnew file+332
This diff is too big to show here.
nixos/doc/manual/release-notes/rl-1903.section.mdnew file+214
This diff is too big to show here.
nixos/doc/manual/release-notes/rl-1909.section.mdnew file+313
This diff is too big to show here.
nixos/doc/manual/release-notes/rl-2003.section.mdnew file+507
This diff is too big to show here.
nixos/doc/manual/release-notes/rl-2009.section.mdnew file+747
This diff is too big to show here.
nixos/doc/manual/release-notes/rl-2105.section.mdnew file+428
This diff is too big to show here.
nixos/doc/manual/release-notes/rl-2111.section.mdnew file+575
This diff is too big to show here.
nixos/doc/manual/release-notes/rl-2205.section.mdnew file+878
This diff is too big to show here.
nixos/doc/manual/shell.nixnew file+8
This diff is too big to show here.
nixos/doc/varlistentry-fixer.rbnew file+124
This diff is too big to show here.
nixos/doc/xmlformat.confnew file+72
This diff is too big to show here.
nixos/lib/build-vms.nixnew file+113
This diff is too big to show here.
nixos/lib/default.nixnew file+33
This diff is too big to show here.
nixos/lib/eval-cacheable-options.nixnew file+53
This diff is too big to show here.
nixos/lib/eval-config-minimal.nixnew file+49
This diff is too big to show here.
nixos/lib/eval-config.nixnew file+111
This diff is too big to show here.
nixos/lib/from-env.nixnew file+4
This diff is too big to show here.
nixos/lib/make-channel.nixnew file+31
This diff is too big to show here.
nixos/lib/make-disk-image.nixnew file+444
This diff is too big to show here.
nixos/lib/make-ext4-fs.nixnew file+86
This diff is too big to show here.
nixos/lib/make-iso9660-image.nixnew file+65
This diff is too big to show here.
nixos/lib/make-iso9660-image.shnew file+139
This diff is too big to show here.
nixos/lib/make-multi-disk-zfs-image.nixnew file+333
This diff is too big to show here.
nixos/lib/make-options-doc/default.nixnew file+169
This diff is too big to show here.
nixos/lib/make-options-doc/generateAsciiDoc.pynew file+37
This diff is too big to show here.
nixos/lib/make-options-doc/generateCommonMark.pynew file+27
This diff is too big to show here.
nixos/lib/make-options-doc/mergeJSON.pynew file+95
This diff is too big to show here.
nixos/lib/make-options-doc/options-to-docbook.xslnew file+246
This diff is too big to show here.
nixos/lib/make-options-doc/optionsJSONtoXML.nixnew file+6
This diff is too big to show here.
nixos/lib/make-options-doc/postprocess-option-descriptions.xslnew file+115
This diff is too big to show here.
nixos/lib/make-options-doc/sortXML.pynew file+27
This diff is too big to show here.
nixos/lib/make-single-disk-zfs-image.nixnew file+322
This diff is too big to show here.
nixos/lib/make-squashfs.nixnew file+35
This diff is too big to show here.
nixos/lib/make-system-tarball.nixnew file+56
This diff is too big to show here.
nixos/lib/make-system-tarball.shnew file+57
This diff is too big to show here.
nixos/lib/qemu-common.nixnew file+32
This diff is too big to show here.
nixos/lib/systemd-lib.nixnew file+426
This diff is too big to show here.
nixos/lib/systemd-types.nixnew file+69
This diff is too big to show here.
nixos/lib/systemd-unit-options.nixnew file+711
This diff is too big to show here.
nixos/lib/test-driver/default.nixnew file+32
This diff is too big to show here.
nixos/lib/test-driver/setup.pynew file+13
This diff is too big to show here.
nixos/lib/test-driver/test_driver/__init__.pynew file+128
This diff is too big to show here.
nixos/lib/test-driver/test_driver/driver.pynew file+226
This diff is too big to show here.
nixos/lib/test-driver/test_driver/logger.pynew file+105
This diff is too big to show here.
nixos/lib/test-driver/test_driver/machine.pynew file+1023
This diff is too big to show here.
nixos/lib/test-driver/test_driver/polling_condition.pynew file+77
This diff is too big to show here.
nixos/lib/test-driver/test_driver/vlan.pynew file+58
This diff is too big to show here.
nixos/lib/testing-python.nixnew file+250
This diff is too big to show here.
nixos/lib/utils.nixnew file+218
This diff is too big to show here.
nixos/maintainers/option-usages.nixnew file+192
This diff is too big to show here.
nixos/maintainers/scripts/azure-new/.gitignorenew file+1
This diff is too big to show here.
nixos/maintainers/scripts/azure-new/README.mdnew file+42
This diff is too big to show here.
nixos/maintainers/scripts/azure-new/boot-vm.shnew file+36
This diff is too big to show here.
nixos/maintainers/scripts/azure-new/common.shnew file+7
This diff is too big to show here.
nixos/maintainers/scripts/azure-new/examples/basic/image.nixnew file+10
This diff is too big to show here.
nixos/maintainers/scripts/azure-new/examples/basic/system.nixnew file+34
This diff is too big to show here.
nixos/maintainers/scripts/azure-new/shell.nixnew file+13
This diff is too big to show here.
nixos/maintainers/scripts/azure-new/upload-image.shnew file+58
This diff is too big to show here.
nixos/maintainers/scripts/azure/create-azure.shnew file+8
This diff is too big to show here.
nixos/maintainers/scripts/azure/upload-azure.shnew file+22
This diff is too big to show here.
nixos/maintainers/scripts/cloudstack/cloudstack-image.nixnew file+22
This diff is too big to show here.
nixos/maintainers/scripts/ec2/amazon-image-zfs.nixnew file+12
This diff is too big to show here.
nixos/maintainers/scripts/ec2/amazon-image.nixnew file+165
This diff is too big to show here.
nixos/maintainers/scripts/ec2/create-amis.shnew file+342
This diff is too big to show here.
nixos/maintainers/scripts/gce/create-gce.shnew file+35
This diff is too big to show here.
nixos/maintainers/scripts/lxd/lxd-image-inner.nixnew file+102
This diff is too big to show here.
nixos/maintainers/scripts/lxd/lxd-image.nixnew file+34
This diff is too big to show here.
nixos/maintainers/scripts/lxd/nix.tplnew file+9
This diff is too big to show here.
nixos/maintainers/scripts/openstack/openstack-image-zfs.nixnew file+101
This diff is too big to show here.
nixos/maintainers/scripts/openstack/openstack-image.nixnew file+27
This diff is too big to show here.
nixos/modules/config/appstream.nixnew file+25
This diff is too big to show here.
nixos/modules/config/console.nixnew file+217
This diff is too big to show here.
nixos/modules/config/debug-info.nixnew file+45
This diff is too big to show here.
nixos/modules/config/fonts/fontconfig.nixnew file+475
This diff is too big to show here.
nixos/modules/config/fonts/fontdir.nixnew file+67
This diff is too big to show here.
nixos/modules/config/fonts/fonts.nixnew file+81
This diff is too big to show here.
nixos/modules/config/fonts/ghostscript.nixnew file+33
This diff is too big to show here.
nixos/modules/config/gnu.nixnew file+44
This diff is too big to show here.
nixos/modules/config/gtk/gtk-icon-cache.nixnew file+87
This diff is too big to show here.
nixos/modules/config/i18n.nixnew file+97
This diff is too big to show here.
nixos/modules/config/iproute2.nixnew file+32
This diff is too big to show here.
nixos/modules/config/krb5/default.nixnew file+369
This diff is too big to show here.
nixos/modules/config/ldap.nixnew file+303
This diff is too big to show here.
nixos/modules/config/locale.nixnew file+94
This diff is too big to show here.
nixos/modules/config/malloc.nixnew file+117
This diff is too big to show here.
nixos/modules/config/networking.nixnew file+237
This diff is too big to show here.
nixos/modules/config/no-x-libs.nixnew file+44
This diff is too big to show here.
nixos/modules/config/nsswitch.nixnew file+136
This diff is too big to show here.
nixos/modules/config/power-management.nixnew file+106
This diff is too big to show here.
nixos/modules/config/pulseaudio.nixnew file+331
This diff is too big to show here.
nixos/modules/config/qt5.nixnew file+104
This diff is too big to show here.
nixos/modules/config/resolvconf.nixnew file+145
This diff is too big to show here.
nixos/modules/config/shells-environment.nixnew file+224
This diff is too big to show here.
nixos/modules/config/swap.nixnew file+249
This diff is too big to show here.
nixos/modules/config/sysctl.nixnew file+63
This diff is too big to show here.
nixos/modules/config/system-environment.nixnew file+104
This diff is too big to show here.
nixos/modules/config/system-path.nixnew file+189
This diff is too big to show here.
nixos/modules/config/terminfo.nixnew file+57
This diff is too big to show here.
nixos/modules/config/unix-odbc-drivers.nixnew file+38
This diff is too big to show here.
nixos/modules/config/update-users-groups.plnew file+365
This diff is too big to show here.
nixos/modules/config/users-groups.nixnew file+715
This diff is too big to show here.
nixos/modules/config/vte.nixnew file+56
This diff is too big to show here.
nixos/modules/config/xdg/autostart.nixnew file+26
This diff is too big to show here.
nixos/modules/config/xdg/icons.nixnew file+42
This diff is too big to show here.
nixos/modules/config/xdg/menus.nixnew file+29
This diff is too big to show here.
nixos/modules/config/xdg/mime.nixnew file+102
This diff is too big to show here.
nixos/modules/config/xdg/portal.nixnew file+81
This diff is too big to show here.
nixos/modules/config/xdg/portals/wlr.nixnew file+67
This diff is too big to show here.
nixos/modules/config/xdg/sounds.nixnew file+30
This diff is too big to show here.
nixos/modules/config/zram.nixnew file+203
This diff is too big to show here.
nixos/modules/hardware/acpilight.nixnew file+25
This diff is too big to show here.
nixos/modules/hardware/all-firmware.nixnew file+97
This diff is too big to show here.
nixos/modules/hardware/bladeRF.nixnew file+28
This diff is too big to show here.
nixos/modules/hardware/brillo.nixnew file+22
This diff is too big to show here.
nixos/modules/hardware/ckb-next.nixnew file+53
This diff is too big to show here.
nixos/modules/hardware/corectrl.nixnew file+62
This diff is too big to show here.
nixos/modules/hardware/cpu/amd-microcode.nixnew file+29
This diff is too big to show here.
nixos/modules/hardware/cpu/intel-microcode.nixnew file+29
This diff is too big to show here.
nixos/modules/hardware/cpu/intel-sgx.nixnew file+69
This diff is too big to show here.
nixos/modules/hardware/device-tree.nixnew file+205
This diff is too big to show here.
nixos/modules/hardware/digitalbitbox.nixnew file+30
This diff is too big to show here.
nixos/modules/hardware/flirc.nixnew file+12
This diff is too big to show here.
nixos/modules/hardware/gkraken.nixnew file+18
This diff is too big to show here.
nixos/modules/hardware/gpgsmartcards.nixnew file+37
This diff is too big to show here.
nixos/modules/hardware/hackrf.nixnew file+23
This diff is too big to show here.
nixos/modules/hardware/i2c.nixnew file+43
This diff is too big to show here.
nixos/modules/hardware/keyboard/teck.nixnew file+16
This diff is too big to show here.
nixos/modules/hardware/keyboard/zsa.nixnew file+24
This diff is too big to show here.
nixos/modules/hardware/ksm.nixnew file+38
This diff is too big to show here.
nixos/modules/hardware/ledger.nixnew file+14
This diff is too big to show here.
nixos/modules/hardware/logitech.nixnew file+96
This diff is too big to show here.
nixos/modules/hardware/mcelog.nixnew file+35
This diff is too big to show here.
nixos/modules/hardware/network/ath-user-regd.nixnew file+31
This diff is too big to show here.
nixos/modules/hardware/network/b43.nixnew file+30
This diff is too big to show here.
nixos/modules/hardware/network/broadcom-43xx.nixnew file+3
This diff is too big to show here.
nixos/modules/hardware/network/intel-2200bg.nixnew file+30
This diff is too big to show here.
nixos/modules/hardware/network/smc-2632w/default.nixnew file+9
This diff is too big to show here.
nixos/modules/hardware/network/smc-2632w/firmware/cis/SMC2632W-v1.02.cisnew file+8
This diff is too big to show here.
nixos/modules/hardware/network/zydas-zd1211.nixnew file+5
This diff is too big to show here.
nixos/modules/hardware/nitrokey.nixnew file+27
This diff is too big to show here.
nixos/modules/hardware/onlykey/default.nixnew file+33
This diff is too big to show here.
nixos/modules/hardware/onlykey/onlykey.udevnew file+18
This diff is too big to show here.
nixos/modules/hardware/opengl.nixnew file+157
This diff is too big to show here.
nixos/modules/hardware/openrazer.nixnew file+146
This diff is too big to show here.
nixos/modules/hardware/opentabletdriver.nixnew file+69
This diff is too big to show here.
nixos/modules/hardware/pcmcia.nixnew file+60
This diff is too big to show here.
nixos/modules/hardware/printers.nixnew file+130
This diff is too big to show here.
nixos/modules/hardware/raid/hpsa.nixnew file+64
This diff is too big to show here.
nixos/modules/hardware/rtl-sdr.nixnew file+23
This diff is too big to show here.
nixos/modules/hardware/sata.nixnew file+100
This diff is too big to show here.
nixos/modules/hardware/sensor/hddtemp.nixnew file+81
This diff is too big to show here.
nixos/modules/hardware/sensor/iio.nixnew file+35
This diff is too big to show here.
nixos/modules/hardware/steam-hardware.nixnew file+32
This diff is too big to show here.
nixos/modules/hardware/system-76.nixnew file+89
This diff is too big to show here.
nixos/modules/hardware/tuxedo-keyboard.nixnew file+35
This diff is too big to show here.
nixos/modules/hardware/ubertooth.nixnew file+29
This diff is too big to show here.
nixos/modules/hardware/uinput.nixnew file+19
This diff is too big to show here.
nixos/modules/hardware/usb-wwan.nixnew file+39
This diff is too big to show here.
nixos/modules/hardware/video/amdgpu-pro.nixnew file+71
This diff is too big to show here.
nixos/modules/hardware/video/bumblebee.nixnew file+93
This diff is too big to show here.
nixos/modules/hardware/video/capture/mwprocapture.nixnew file+56
This diff is too big to show here.
nixos/modules/hardware/video/displaylink.nixnew file+76
This diff is too big to show here.
nixos/modules/hardware/video/hidpi.nixnew file+16
This diff is too big to show here.
nixos/modules/hardware/video/nvidia.nixnew file+399
This diff is too big to show here.
nixos/modules/hardware/video/radeon.nixnew file+3
This diff is too big to show here.
nixos/modules/hardware/video/switcheroo-control.nixnew file+18
This diff is too big to show here.
nixos/modules/hardware/video/uvcvideo/default.nixnew file+64
This diff is too big to show here.
nixos/modules/hardware/video/uvcvideo/uvcdynctrl-udev-rules.nixnew file+45
This diff is too big to show here.
nixos/modules/hardware/video/webcam/facetimehd.nixnew file+52
This diff is too big to show here.
nixos/modules/hardware/wooting.nixnew file+12
This diff is too big to show here.
nixos/modules/hardware/xone.nixnew file+23
This diff is too big to show here.
nixos/modules/hardware/xpadneo.nixnew file+29
This diff is too big to show here.
nixos/modules/i18n/input-method/default.nixnew file+74
This diff is too big to show here.
nixos/modules/i18n/input-method/default.xmlnew file+291
This diff is too big to show here.
nixos/modules/i18n/input-method/fcitx.nixnew file+46
This diff is too big to show here.
nixos/modules/i18n/input-method/fcitx5.nixnew file+47
This diff is too big to show here.
nixos/modules/i18n/input-method/hime.nixnew file+14
This diff is too big to show here.
nixos/modules/i18n/input-method/ibus.nixnew file+86
This diff is too big to show here.
nixos/modules/i18n/input-method/kime.nixnew file+51
This diff is too big to show here.
nixos/modules/i18n/input-method/nabi.nixnew file+16
This diff is too big to show here.
nixos/modules/i18n/input-method/uim.nixnew file+37
This diff is too big to show here.
nixos/modules/installer/cd-dvd/channel.nixnew file+50
This diff is too big to show here.
nixos/modules/installer/cd-dvd/installation-cd-base.nixnew file+50
This diff is too big to show here.
nixos/modules/installer/cd-dvd/installation-cd-graphical-base.nixnew file+62
This diff is too big to show here.
nixos/modules/installer/cd-dvd/installation-cd-graphical-calamares-gnome.nixnew file+59
This diff is too big to show here.
nixos/modules/installer/cd-dvd/installation-cd-graphical-calamares-plasma5.nixnew file+49
This diff is too big to show here.
nixos/modules/installer/cd-dvd/installation-cd-graphical-calamares.nixnew file+20
This diff is too big to show here.
nixos/modules/installer/cd-dvd/installation-cd-graphical-gnome.nixnew file+36
This diff is too big to show here.
nixos/modules/installer/cd-dvd/installation-cd-graphical-plasma5-new-kernel.nixnew file+7
This diff is too big to show here.
nixos/modules/installer/cd-dvd/installation-cd-graphical-plasma5.nixnew file+48
This diff is too big to show here.
nixos/modules/installer/cd-dvd/installation-cd-minimal-new-kernel.nixnew file+7
This diff is too big to show here.
nixos/modules/installer/cd-dvd/installation-cd-minimal.nixnew file+14
This diff is too big to show here.
nixos/modules/installer/cd-dvd/iso-image.nixnew file+822
This diff is too big to show here.
nixos/modules/installer/cd-dvd/sd-image-aarch64-new-kernel.nixnew file+14
This diff is too big to show here.
nixos/modules/installer/cd-dvd/sd-image-aarch64.nixnew file+14
This diff is too big to show here.
nixos/modules/installer/cd-dvd/sd-image-armv7l-multiplatform.nixnew file+14
This diff is too big to show here.
nixos/modules/installer/cd-dvd/sd-image-raspberrypi.nixnew file+14
This diff is too big to show here.
nixos/modules/installer/cd-dvd/sd-image.nixnew file+14
This diff is too big to show here.
nixos/modules/installer/cd-dvd/system-tarball-fuloong2f.nixnew file+160
This diff is too big to show here.
nixos/modules/installer/cd-dvd/system-tarball-pc-readme.txtnew file+89
This diff is too big to show here.
nixos/modules/installer/cd-dvd/system-tarball-pc.nixnew file+163
This diff is too big to show here.
nixos/modules/installer/cd-dvd/system-tarball-sheevaplug.nixnew file+172
This diff is too big to show here.
nixos/modules/installer/cd-dvd/system-tarball.nixnew file+93
This diff is too big to show here.
nixos/modules/installer/kexec/kexec-boot.nixnew file+51
This diff is too big to show here.
nixos/modules/installer/netboot/netboot-base.nixnew file+17
This diff is too big to show here.
nixos/modules/installer/netboot/netboot-minimal.nixnew file+10
This diff is too big to show here.
nixos/modules/installer/netboot/netboot.nixnew file+120
This diff is too big to show here.
nixos/modules/installer/scan/detected.nixnew file+12
This diff is too big to show here.
nixos/modules/installer/scan/not-detected.nixnew file+6
This diff is too big to show here.
nixos/modules/installer/sd-card/sd-image-aarch64-installer.nixnew file+10
This diff is too big to show here.
nixos/modules/installer/sd-card/sd-image-aarch64-new-kernel-installer.nixnew file+10
This diff is too big to show here.
nixos/modules/installer/sd-card/sd-image-aarch64-new-kernel.nixnew file+7
This diff is too big to show here.
nixos/modules/installer/sd-card/sd-image-aarch64.nixnew file+83
This diff is too big to show here.
nixos/modules/installer/sd-card/sd-image-armv7l-multiplatform-installer.nixnew file+10
This diff is too big to show here.
nixos/modules/installer/sd-card/sd-image-armv7l-multiplatform.nixnew file+52
This diff is too big to show here.
nixos/modules/installer/sd-card/sd-image-raspberrypi-installer.nixnew file+10
This diff is too big to show here.
nixos/modules/installer/sd-card/sd-image-raspberrypi.nixnew file+41
This diff is too big to show here.
nixos/modules/installer/sd-card/sd-image-riscv64-qemu-installer.nixnew file+10
This diff is too big to show here.
nixos/modules/installer/sd-card/sd-image-riscv64-qemu.nixnew file+32
This diff is too big to show here.
nixos/modules/installer/sd-card/sd-image-x86_64.nixnew file+27
This diff is too big to show here.
nixos/modules/installer/sd-card/sd-image.nixnew file+269
This diff is too big to show here.
nixos/modules/installer/tools/get-version-suffixnew file+22
This diff is too big to show here.
nixos/modules/installer/tools/nix-fallback-paths.nixnew file+7
This diff is too big to show here.
nixos/modules/installer/tools/nixos-build-vms/build-vms.nixnew file+31
This diff is too big to show here.
nixos/modules/installer/tools/nixos-build-vms/nixos-build-vms.shnew file+53
This diff is too big to show here.
nixos/modules/installer/tools/nixos-enter.shnew file+109
This diff is too big to show here.
nixos/modules/installer/tools/nixos-generate-config.plnew file+682
This diff is too big to show here.
nixos/modules/installer/tools/nixos-install.shnew file+218
This diff is too big to show here.
nixos/modules/installer/tools/nixos-option/default.nixnew file+1
This diff is too big to show here.
nixos/modules/installer/tools/nixos-version.shnew file+24
This diff is too big to show here.
nixos/modules/installer/tools/tools.nixnew file+240
This diff is too big to show here.
nixos/modules/installer/virtualbox-demo.nixnew file+61
This diff is too big to show here.
nixos/modules/misc/assertions.nixnew file+34
This diff is too big to show here.
nixos/modules/misc/crashdump.nixnew file+76
This diff is too big to show here.
nixos/modules/misc/documentation.nixnew file+347
This diff is too big to show here.
nixos/modules/misc/extra-arguments.nixnew file+7
This diff is too big to show here.
nixos/modules/misc/ids.nixnew file+677
This diff is too big to show here.
nixos/modules/misc/label.nixnew file+72
This diff is too big to show here.
nixos/modules/misc/lib.nixnew file+15
This diff is too big to show here.
nixos/modules/misc/locate.nixnew file+313
This diff is too big to show here.
nixos/modules/misc/man-db.nixnew file+73
This diff is too big to show here.
nixos/modules/misc/mandoc.nixnew file+61
This diff is too big to show here.
nixos/modules/misc/meta.nixnew file+76
This diff is too big to show here.
nixos/modules/misc/nixops-autoluks.nixnew file+43
This diff is too big to show here.
nixos/modules/misc/nixpkgs.nixnew file+259
This diff is too big to show here.
nixos/modules/misc/nixpkgs/test.nixnew file+8
This diff is too big to show here.
nixos/modules/misc/passthru.nixnew file+16
This diff is too big to show here.
nixos/modules/misc/version.nixnew file+153
This diff is too big to show here.
nixos/modules/misc/wordlist.nixnew file+59
This diff is too big to show here.
nixos/modules/module-list.nixnew file+1263
This diff is too big to show here.
nixos/modules/profiles/all-hardware.nixnew file+123
This diff is too big to show here.
nixos/modules/profiles/base.nixnew file+58
This diff is too big to show here.
nixos/modules/profiles/clone-config.nixnew file+109
This diff is too big to show here.
nixos/modules/profiles/demo.nixnew file+21
This diff is too big to show here.
nixos/modules/profiles/docker-container.nixnew file+61
This diff is too big to show here.
nixos/modules/profiles/graphical.nixnew file+20
This diff is too big to show here.
nixos/modules/profiles/hardened.nixnew file+118
This diff is too big to show here.
nixos/modules/profiles/headless.nixnew file+25
This diff is too big to show here.
nixos/modules/profiles/installation-device.nixnew file+121
This diff is too big to show here.
nixos/modules/profiles/minimal.nixnew file+19
This diff is too big to show here.
nixos/modules/profiles/qemu-guest.nixnew file+17
This diff is too big to show here.
nixos/modules/programs/_1password-gui.nixnew file+68
This diff is too big to show here.
nixos/modules/programs/_1password.nixnew file+44
This diff is too big to show here.
nixos/modules/programs/adb.nixnew file+29
This diff is too big to show here.
nixos/modules/programs/appgate-sdp.nixnew file+25
This diff is too big to show here.
nixos/modules/programs/atop.nixnew file+155
This diff is too big to show here.
nixos/modules/programs/autojump.nixnew file+33
This diff is too big to show here.
nixos/modules/programs/bandwhich.nixnew file+31
This diff is too big to show here.
nixos/modules/programs/bash-my-aws.nixnew file+25
This diff is too big to show here.
nixos/modules/programs/bash/bash-completion.nixnew file+37
This diff is too big to show here.
nixos/modules/programs/bash/bash.nixnew file+217
This diff is too big to show here.
nixos/modules/programs/bash/inputrcnew file+37
This diff is too big to show here.
nixos/modules/programs/bash/ls-colors.nixnew file+20
This diff is too big to show here.
nixos/modules/programs/bash/undistract-me.nixnew file+36
This diff is too big to show here.
nixos/modules/programs/bcc.nixnew file+9
This diff is too big to show here.
nixos/modules/programs/browserpass.nixnew file+32
This diff is too big to show here.
nixos/modules/programs/calls.nixnew file+27
This diff is too big to show here.
nixos/modules/programs/captive-browser.nixnew file+152
This diff is too big to show here.
nixos/modules/programs/ccache.nixnew file+85
This diff is too big to show here.
nixos/modules/programs/cdemu.nixnew file+62
This diff is too big to show here.
nixos/modules/programs/chromium.nixnew file+115
This diff is too big to show here.
nixos/modules/programs/clickshare.nixnew file+21
This diff is too big to show here.
nixos/modules/programs/cnping.nixnew file+21
This diff is too big to show here.
nixos/modules/programs/command-not-found/command-not-found.nixnew file+95
This diff is too big to show here.
nixos/modules/programs/command-not-found/command-not-found.plnew file+77
This diff is too big to show here.
nixos/modules/programs/criu.nixnew file+27
This diff is too big to show here.
nixos/modules/programs/dconf.nixnew file+66
This diff is too big to show here.
nixos/modules/programs/digitalbitbox/default.nixnew file+39
This diff is too big to show here.
nixos/modules/programs/digitalbitbox/doc.xmlnew file+74
This diff is too big to show here.
nixos/modules/programs/dmrconfig.nixnew file+38
This diff is too big to show here.
nixos/modules/programs/droidcam.nixnew file+16
This diff is too big to show here.
nixos/modules/programs/environment.nixnew file+67
This diff is too big to show here.
nixos/modules/programs/evince.nixnew file+51
This diff is too big to show here.
nixos/modules/programs/extra-container.nixnew file+17
This diff is too big to show here.
nixos/modules/programs/feedbackd.nixnew file+33
This diff is too big to show here.
nixos/modules/programs/file-roller.nixnew file+48
This diff is too big to show here.
nixos/modules/programs/firejail.nixnew file+97
This diff is too big to show here.
nixos/modules/programs/fish.nixnew file+320
This diff is too big to show here.
nixos/modules/programs/fish_completion-generator.patchnew file+14
This diff is too big to show here.
nixos/modules/programs/flashrom.nixnew file+26
This diff is too big to show here.
nixos/modules/programs/flexoptix-app.nixnew file+25
This diff is too big to show here.
nixos/modules/programs/freetds.nixnew file+61
This diff is too big to show here.
nixos/modules/programs/fuse.nixnew file+37
This diff is too big to show here.
nixos/modules/programs/gamemode.nixnew file+98
This diff is too big to show here.
nixos/modules/programs/geary.nixnew file+24
This diff is too big to show here.
nixos/modules/programs/git.nixnew file+69
This diff is too big to show here.
nixos/modules/programs/gnome-disks.nixnew file+50
This diff is too big to show here.
nixos/modules/programs/gnome-documents.nixnew file+54
This diff is too big to show here.
nixos/modules/programs/gnome-terminal.nixnew file+38
This diff is too big to show here.
nixos/modules/programs/gnupg.nixnew file+154
This diff is too big to show here.
nixos/modules/programs/gpaste.nixnew file+36
This diff is too big to show here.
nixos/modules/programs/gphoto2.nixnew file+30
This diff is too big to show here.
nixos/modules/programs/hamster.nixnew file+15
This diff is too big to show here.
nixos/modules/programs/htop.nixnew file+58
This diff is too big to show here.
nixos/modules/programs/iftop.nixnew file+20
This diff is too big to show here.
nixos/modules/programs/iotop.nixnew file+19
This diff is too big to show here.
nixos/modules/programs/java.nixnew file+58
This diff is too big to show here.
nixos/modules/programs/k3b.nixnew file+52
This diff is too big to show here.
nixos/modules/programs/k40-whisperer.nixnew file+40
This diff is too big to show here.
nixos/modules/programs/kbdlight.nixnew file+21
This diff is too big to show here.
nixos/modules/programs/kclock.nixnew file+13
This diff is too big to show here.
nixos/modules/programs/kdeconnect.nixnew file+35
This diff is too big to show here.
nixos/modules/programs/less.nixnew file+134
This diff is too big to show here.
nixos/modules/programs/liboping.nixnew file+24
This diff is too big to show here.
nixos/modules/programs/light.nixnew file+27
This diff is too big to show here.
nixos/modules/programs/mininet.nixnew file+39
This diff is too big to show here.
nixos/modules/programs/mosh.nixnew file+43
This diff is too big to show here.
nixos/modules/programs/msmtp.nixnew file+106
This diff is too big to show here.
nixos/modules/programs/mtr.nixnew file+41
This diff is too big to show here.
nixos/modules/programs/nano.nixnew file+42
This diff is too big to show here.
nixos/modules/programs/nbd.nixnew file+19
This diff is too big to show here.
nixos/modules/programs/neovim.nixnew file+166
This diff is too big to show here.
nixos/modules/programs/nethoscope.nixnew file+30
This diff is too big to show here.
nixos/modules/programs/nix-ld.nixnew file+12
This diff is too big to show here.
nixos/modules/programs/nm-applet.nixnew file+31
This diff is too big to show here.
nixos/modules/programs/nncp.nixnew file+101
This diff is too big to show here.
nixos/modules/programs/noisetorch.nixnew file+28
This diff is too big to show here.
nixos/modules/programs/npm.nixnew file+54
This diff is too big to show here.
nixos/modules/programs/oblogout.nixnew file+11
This diff is too big to show here.
nixos/modules/programs/pantheon-tweaks.nixnew file+19
This diff is too big to show here.
nixos/modules/programs/partition-manager.nixnew file+19
This diff is too big to show here.
nixos/modules/programs/phosh.nixnew file+162
This diff is too big to show here.
nixos/modules/programs/plotinus.nixnew file+36
This diff is too big to show here.
nixos/modules/programs/plotinus.xmlnew file+30
This diff is too big to show here.
nixos/modules/programs/proxychains.nixnew file+165
This diff is too big to show here.
nixos/modules/programs/qt5ct.nixnew file+31
This diff is too big to show here.
nixos/modules/programs/screen.nixnew file+33
This diff is too big to show here.
nixos/modules/programs/seahorse.nixnew file+46
This diff is too big to show here.
nixos/modules/programs/sedutil.nixnew file+18
This diff is too big to show here.
nixos/modules/programs/shadow.nixnew file+129
This diff is too big to show here.
nixos/modules/programs/singularity.nixnew file+34
This diff is too big to show here.
nixos/modules/programs/slock.nixnew file+31
This diff is too big to show here.
nixos/modules/programs/spacefm.nixnew file+55
This diff is too big to show here.
nixos/modules/programs/ssh.nixnew file+357
This diff is too big to show here.
nixos/modules/programs/starship.nixnew file+51
This diff is too big to show here.
nixos/modules/programs/steam.nixnew file+63
This diff is too big to show here.
nixos/modules/programs/sway.nixnew file+150
This diff is too big to show here.
nixos/modules/programs/sysdig.nixnew file+14
This diff is too big to show here.
nixos/modules/programs/system-config-printer.nixnew file+32
This diff is too big to show here.
nixos/modules/programs/systemtap.nixnew file+29
This diff is too big to show here.
nixos/modules/programs/thefuck.nixnew file+40
This diff is too big to show here.
nixos/modules/programs/tmux.nixnew file+201
This diff is too big to show here.
nixos/modules/programs/traceroute.nixnew file+28
This diff is too big to show here.
nixos/modules/programs/tsm-client.nixnew file+287
This diff is too big to show here.
nixos/modules/programs/turbovnc.nixnew file+54
This diff is too big to show here.
nixos/modules/programs/udevil.nixnew file+19
This diff is too big to show here.
nixos/modules/programs/usbtop.nixnew file+21
This diff is too big to show here.
nixos/modules/programs/vim.nixnew file+33
This diff is too big to show here.
nixos/modules/programs/virtualbox.nixnew file+8
This diff is too big to show here.
nixos/modules/programs/wavemon.nixnew file+30
This diff is too big to show here.
nixos/modules/programs/waybar.nixnew file+20
This diff is too big to show here.
nixos/modules/programs/weylus.nixnew file+47
This diff is too big to show here.
nixos/modules/programs/wireshark.nixnew file+42
This diff is too big to show here.
nixos/modules/programs/wshowkeys.nixnew file+27
This diff is too big to show here.
nixos/modules/programs/xfs_quota.nixnew file+110
This diff is too big to show here.
nixos/modules/programs/xonsh.nixnew file+86
This diff is too big to show here.
nixos/modules/programs/xss-lock.nixnew file+45
This diff is too big to show here.
nixos/modules/programs/xwayland.nixnew file+50
This diff is too big to show here.
nixos/modules/programs/yabar.nixnew file+163
This diff is too big to show here.
nixos/modules/programs/zmap.nixnew file+18
This diff is too big to show here.
nixos/modules/programs/zsh/oh-my-zsh.nixnew file+146
This diff is too big to show here.
nixos/modules/programs/zsh/oh-my-zsh.xmlnew file+155
This diff is too big to show here.
nixos/modules/programs/zsh/zinputrcnew file+42
This diff is too big to show here.
nixos/modules/programs/zsh/zsh-autoenv.nixnew file+28
This diff is too big to show here.
nixos/modules/programs/zsh/zsh-autosuggestions.nixnew file+73
This diff is too big to show here.
nixos/modules/programs/zsh/zsh-syntax-highlighting.nixnew file+107
This diff is too big to show here.
nixos/modules/programs/zsh/zsh.nixnew file+303
This diff is too big to show here.
nixos/modules/rename.nixnew file+103
This diff is too big to show here.
nixos/modules/security/acme/default.nixnew file+921
This diff is too big to show here.
nixos/modules/security/acme/doc.xmlnew file+413
This diff is too big to show here.
nixos/modules/security/acme/mk-cert-ownership-assertion.nixnew file+4
This diff is too big to show here.
nixos/modules/security/apparmor.nixnew file+216
This diff is too big to show here.
nixos/modules/security/apparmor/includes.nixnew file+317
This diff is too big to show here.
nixos/modules/security/apparmor/profiles.nixnew file+11
This diff is too big to show here.
nixos/modules/security/audit.nixnew file+123
This diff is too big to show here.
nixos/modules/security/auditd.nixnew file+31
This diff is too big to show here.
nixos/modules/security/ca.nixnew file+89
This diff is too big to show here.
nixos/modules/security/chromium-suid-sandbox.nixnew file+38
This diff is too big to show here.
nixos/modules/security/dhparams.nixnew file+177
This diff is too big to show here.
nixos/modules/security/doas.nixnew file+288
This diff is too big to show here.
nixos/modules/security/duosec.nixnew file+240
This diff is too big to show here.
nixos/modules/security/google_oslogin.nixnew file+71
This diff is too big to show here.
nixos/modules/security/lock-kernel-modules.nixnew file+58
This diff is too big to show here.
nixos/modules/security/misc.nixnew file+155
This diff is too big to show here.
nixos/modules/security/oath.nixnew file+50
This diff is too big to show here.
nixos/modules/security/pam.nixnew file+1259
This diff is too big to show here.
nixos/modules/security/pam_mount.nixnew file+174
This diff is too big to show here.
nixos/modules/security/pam_usb.nixnew file+52
This diff is too big to show here.
nixos/modules/security/polkit.nixnew file+112
This diff is too big to show here.
nixos/modules/security/rngd.nixnew file+16
This diff is too big to show here.
nixos/modules/security/rtkit.nixnew file+47
This diff is too big to show here.
nixos/modules/security/sudo.nixnew file+265
This diff is too big to show here.
nixos/modules/security/systemd-confinement.nixnew file+202
This diff is too big to show here.
nixos/modules/security/tpm2.nixnew file+184
This diff is too big to show here.
nixos/modules/security/wrappers/default.nixnew file+305
This diff is too big to show here.
nixos/modules/security/wrappers/wrapper.cnew file+233
This diff is too big to show here.
nixos/modules/security/wrappers/wrapper.nixnew file+21
This diff is too big to show here.
nixos/modules/services/admin/meshcentral.nixnew file+53
This diff is too big to show here.
nixos/modules/services/admin/oxidized.nixnew file+118
This diff is too big to show here.
nixos/modules/services/admin/pgadmin.nixnew file+127
This diff is too big to show here.
nixos/modules/services/admin/salt/master.nixnew file+63
This diff is too big to show here.
nixos/modules/services/admin/salt/minion.nixnew file+67
This diff is too big to show here.
nixos/modules/services/amqp/activemq/ActiveMQBroker.javanew file+19
This diff is too big to show here.
nixos/modules/services/amqp/activemq/default.nixnew file+135
This diff is too big to show here.
nixos/modules/services/amqp/rabbitmq.nixnew file+228
This diff is too big to show here.
nixos/modules/services/audio/alsa.nixnew file+133
This diff is too big to show here.
nixos/modules/services/audio/botamusique.nixnew file+115
This diff is too big to show here.
nixos/modules/services/audio/hqplayerd.nixnew file+142
This diff is too big to show here.
nixos/modules/services/audio/icecast.nixnew file+131
This diff is too big to show here.
nixos/modules/services/audio/jack.nixnew file+294
This diff is too big to show here.
nixos/modules/services/audio/jmusicbot.nixnew file+48
This diff is too big to show here.
nixos/modules/services/audio/liquidsoap.nixnew file+69
This diff is too big to show here.
nixos/modules/services/audio/mopidy.nixnew file+108
This diff is too big to show here.
nixos/modules/services/audio/mpd.nixnew file+265
This diff is too big to show here.
nixos/modules/services/audio/mpdscribble.nixnew file+213
This diff is too big to show here.
nixos/modules/services/audio/navidrome.nixnew file+71
This diff is too big to show here.
nixos/modules/services/audio/networkaudiod.nixnew file+19
This diff is too big to show here.
nixos/modules/services/audio/roon-bridge.nixnew file+76
This diff is too big to show here.
nixos/modules/services/audio/roon-server.nixnew file+79
This diff is too big to show here.
nixos/modules/services/audio/slimserver.nixnew file+73
This diff is too big to show here.
nixos/modules/services/audio/snapserver.nixnew file+323
This diff is too big to show here.
nixos/modules/services/audio/spotifyd.nixnew file+68
This diff is too big to show here.
nixos/modules/services/audio/squeezelite.nixnew file+46
This diff is too big to show here.
nixos/modules/services/audio/ympd.nixnew file+57
This diff is too big to show here.
nixos/modules/services/backup/automysqlbackup.nixnew file+119
This diff is too big to show here.
nixos/modules/services/backup/bacula.nixnew file+578
This diff is too big to show here.
nixos/modules/services/backup/borgbackup.nixnew file+730
This diff is too big to show here.
nixos/modules/services/backup/borgbackup.xmlnew file+209
This diff is too big to show here.
nixos/modules/services/backup/borgmatic.nixnew file+57
This diff is too big to show here.
nixos/modules/services/backup/btrbk.nixnew file+220
This diff is too big to show here.
nixos/modules/services/backup/duplicati.nixnew file+86
This diff is too big to show here.
nixos/modules/services/backup/duplicity.nixnew file+196
This diff is too big to show here.
nixos/modules/services/backup/mysql-backup.nixnew file+130
This diff is too big to show here.
nixos/modules/services/backup/postgresql-backup.nixnew file+164
This diff is too big to show here.
nixos/modules/services/backup/postgresql-wal-receiver.nixnew file+204
This diff is too big to show here.
nixos/modules/services/backup/restic-rest-server.nixnew file+111
This diff is too big to show here.
nixos/modules/services/backup/restic.nixnew file+290
This diff is too big to show here.
nixos/modules/services/backup/rsnapshot.nixnew file+75
This diff is too big to show here.
nixos/modules/services/backup/sanoid.nixnew file+204
This diff is too big to show here.
nixos/modules/services/backup/syncoid.nixnew file+421
This diff is too big to show here.
nixos/modules/services/backup/tarsnap.nixnew file+408
This diff is too big to show here.
nixos/modules/services/backup/tsm.nixnew file+125
This diff is too big to show here.
nixos/modules/services/backup/zfs-replication.nixnew file+90
This diff is too big to show here.
nixos/modules/services/backup/znapzend.nixnew file+469
This diff is too big to show here.
nixos/modules/services/backup/zrepl.nixnew file+57
This diff is too big to show here.
nixos/modules/services/blockchain/ethereum/geth.nixnew file+179
This diff is too big to show here.
nixos/modules/services/cluster/corosync/default.nixnew file+112
This diff is too big to show here.
nixos/modules/services/cluster/hadoop/conf.nixnew file+44
This diff is too big to show here.
nixos/modules/services/cluster/hadoop/default.nixnew file+223
This diff is too big to show here.
nixos/modules/services/cluster/hadoop/hdfs.nixnew file+204
This diff is too big to show here.
nixos/modules/services/cluster/hadoop/yarn.nixnew file+200
This diff is too big to show here.
nixos/modules/services/cluster/k3s/default.nixnew file+128
This diff is too big to show here.
nixos/modules/services/cluster/kubernetes/addon-manager.nixnew file+171
This diff is too big to show here.
nixos/modules/services/cluster/kubernetes/addons/dns.nixnew file+368
This diff is too big to show here.
nixos/modules/services/cluster/kubernetes/apiserver.nixnew file+500
This diff is too big to show here.
nixos/modules/services/cluster/kubernetes/controller-manager.nixnew file+176
This diff is too big to show here.
nixos/modules/services/cluster/kubernetes/default.nixnew file+315
This diff is too big to show here.
nixos/modules/services/cluster/kubernetes/flannel.nixnew file+100
This diff is too big to show here.
nixos/modules/services/cluster/kubernetes/kubelet.nixnew file+398
This diff is too big to show here.
nixos/modules/services/cluster/kubernetes/pki.nixnew file+406
This diff is too big to show here.
nixos/modules/services/cluster/kubernetes/proxy.nixnew file+102
This diff is too big to show here.
nixos/modules/services/cluster/kubernetes/scheduler.nixnew file+101
This diff is too big to show here.
nixos/modules/services/cluster/pacemaker/default.nixnew file+52
This diff is too big to show here.
nixos/modules/services/cluster/spark/default.nixnew file+162
This diff is too big to show here.
nixos/modules/services/computing/boinc/client.nixnew file+131
This diff is too big to show here.
nixos/modules/services/computing/foldingathome/client.nixnew file+91
This diff is too big to show here.
nixos/modules/services/computing/slurm/slurm.nixnew file+437
This diff is too big to show here.
nixos/modules/services/computing/torque/mom.nixnew file+63
This diff is too big to show here.
nixos/modules/services/computing/torque/server.nixnew file+96
This diff is too big to show here.
nixos/modules/services/continuous-integration/buildbot/master.nixnew file+290
This diff is too big to show here.
nixos/modules/services/continuous-integration/buildbot/worker.nixnew file+198
This diff is too big to show here.
nixos/modules/services/continuous-integration/buildkite-agents.nixnew file+280
This diff is too big to show here.
nixos/modules/services/continuous-integration/github-runner.nixnew file+320
This diff is too big to show here.
nixos/modules/services/continuous-integration/gitlab-runner.nixnew file+588
This diff is too big to show here.
nixos/modules/services/continuous-integration/gocd-agent/default.nixnew file+218
This diff is too big to show here.
nixos/modules/services/continuous-integration/gocd-server/default.nixnew file+212
This diff is too big to show here.
nixos/modules/services/continuous-integration/hail.nixnew file+61
This diff is too big to show here.
nixos/modules/services/continuous-integration/hercules-ci-agent/common.nixnew file+266
This diff is too big to show here.
nixos/modules/services/continuous-integration/hercules-ci-agent/default.nixnew file+101
This diff is too big to show here.
nixos/modules/services/continuous-integration/hydra/default.nixnew file+501
This diff is too big to show here.
nixos/modules/services/continuous-integration/jenkins/default.nixnew file+249
This diff is too big to show here.
nixos/modules/services/continuous-integration/jenkins/job-builder.nixnew file+241
This diff is too big to show here.
nixos/modules/services/continuous-integration/jenkins/slave.nixnew file+82
This diff is too big to show here.
nixos/modules/services/databases/aerospike.nixnew file+156
This diff is too big to show here.
nixos/modules/services/databases/cassandra.nixnew file+563
This diff is too big to show here.
nixos/modules/services/databases/clickhouse.nixnew file+78
This diff is too big to show here.
nixos/modules/services/databases/cockroachdb.nixnew file+225
This diff is too big to show here.
nixos/modules/services/databases/couchdb.nixnew file+231
This diff is too big to show here.
nixos/modules/services/databases/firebird.nixnew file+168
This diff is too big to show here.
nixos/modules/services/databases/foundationdb.nixnew file+429
This diff is too big to show here.
nixos/modules/services/databases/foundationdb.xmlnew file+443
This diff is too big to show here.
nixos/modules/services/databases/hbase.nixnew file+149
This diff is too big to show here.
nixos/modules/services/databases/influxdb.nixnew file+197
This diff is too big to show here.
nixos/modules/services/databases/influxdb2.nixnew file+66
This diff is too big to show here.
nixos/modules/services/databases/memcached.nixnew file+118
This diff is too big to show here.
nixos/modules/services/databases/monetdb.nixnew file+100
This diff is too big to show here.
nixos/modules/services/databases/mongodb.nixnew file+197
This diff is too big to show here.
nixos/modules/services/databases/mysql.nixnew file+521
This diff is too big to show here.
nixos/modules/services/databases/neo4j.nixnew file+673
This diff is too big to show here.
nixos/modules/services/databases/openldap.nixnew file+325
This diff is too big to show here.
nixos/modules/services/databases/opentsdb.nixnew file+108
This diff is too big to show here.
nixos/modules/services/databases/pgmanage.nixnew file+207
This diff is too big to show here.
nixos/modules/services/databases/postgresql.nixnew file+424
This diff is too big to show here.
nixos/modules/services/databases/postgresql.xmlnew file+214
This diff is too big to show here.
nixos/modules/services/databases/redis.nixnew file+391
This diff is too big to show here.
nixos/modules/services/databases/rethinkdb.nixnew file+108
This diff is too big to show here.
nixos/modules/services/databases/riak.nixnew file+162
This diff is too big to show here.
nixos/modules/services/databases/victoriametrics.nixnew file+78
This diff is too big to show here.
nixos/modules/services/desktops/accountsservice.nixnew file+58
This diff is too big to show here.
nixos/modules/services/desktops/bamf.nixnew file+27
This diff is too big to show here.
nixos/modules/services/desktops/blueman.nixnew file+25
This diff is too big to show here.
nixos/modules/services/desktops/cpupower-gui.nixnew file+56
This diff is too big to show here.
nixos/modules/services/desktops/dleyna-renderer.nixnew file+28
This diff is too big to show here.
nixos/modules/services/desktops/dleyna-server.nixnew file+28
This diff is too big to show here.
nixos/modules/services/desktops/espanso.nixnew file+24
This diff is too big to show here.
nixos/modules/services/desktops/flatpak.nixnew file+56
This diff is too big to show here.
nixos/modules/services/desktops/flatpak.xmlnew file+56
This diff is too big to show here.
nixos/modules/services/desktops/geoclue2.nixnew file+270
This diff is too big to show here.
nixos/modules/services/desktops/gnome/at-spi2-core.nixnew file+57
This diff is too big to show here.
nixos/modules/services/desktops/gnome/chrome-gnome-shell.nixnew file+41
This diff is too big to show here.
nixos/modules/services/desktops/gnome/evolution-data-server.nixnew file+71
This diff is too big to show here.
nixos/modules/services/desktops/gnome/glib-networking.nixnew file+45
This diff is too big to show here.
nixos/modules/services/desktops/gnome/gnome-initial-setup.nixnew file+98
This diff is too big to show here.
nixos/modules/services/desktops/gnome/gnome-keyring.nixnew file+63
This diff is too big to show here.
nixos/modules/services/desktops/gnome/gnome-online-accounts.nixnew file+51
This diff is too big to show here.
nixos/modules/services/desktops/gnome/gnome-online-miners.nixnew file+51
This diff is too big to show here.
nixos/modules/services/desktops/gnome/gnome-remote-desktop.nixnew file+32
This diff is too big to show here.
nixos/modules/services/desktops/gnome/gnome-settings-daemon.nixnew file+70
This diff is too big to show here.
nixos/modules/services/desktops/gnome/gnome-user-share.nixnew file+48
This diff is too big to show here.
nixos/modules/services/desktops/gnome/rygel.nixnew file+44
This diff is too big to show here.
nixos/modules/services/desktops/gnome/sushi.nixnew file+50
This diff is too big to show here.
nixos/modules/services/desktops/gnome/tracker-miners.nixnew file+54
This diff is too big to show here.
nixos/modules/services/desktops/gnome/tracker.nixnew file+76
This diff is too big to show here.
nixos/modules/services/desktops/gsignond.nixnew file+45
This diff is too big to show here.
nixos/modules/services/desktops/gvfs.nixnew file+64
This diff is too big to show here.
nixos/modules/services/desktops/malcontent.nixnew file+40
This diff is too big to show here.
nixos/modules/services/desktops/neard.nixnew file+23
This diff is too big to show here.
nixos/modules/services/desktops/pipewire/daemon/client-rt.conf.jsonnew file+39
This diff is too big to show here.
nixos/modules/services/desktops/pipewire/daemon/client.conf.jsonnew file+31
This diff is too big to show here.
nixos/modules/services/desktops/pipewire/daemon/jack.conf.jsonnew file+38
This diff is too big to show here.
nixos/modules/services/desktops/pipewire/daemon/minimal.conf.jsonnew file+118
This diff is too big to show here.
nixos/modules/services/desktops/pipewire/daemon/pipewire-pulse.conf.jsonnew file+100
This diff is too big to show here.
nixos/modules/services/desktops/pipewire/daemon/pipewire.conf.jsonnew file+96
This diff is too big to show here.
nixos/modules/services/desktops/pipewire/media-session/alsa-monitor.conf.jsonnew file+34
This diff is too big to show here.
nixos/modules/services/desktops/pipewire/media-session/bluez-monitor.conf.jsonnew file+36
This diff is too big to show here.
nixos/modules/services/desktops/pipewire/media-session/media-session.conf.jsonnew file+68
This diff is too big to show here.
nixos/modules/services/desktops/pipewire/media-session/v4l2-monitor.conf.jsonnew file+30
This diff is too big to show here.
nixos/modules/services/desktops/pipewire/pipewire-media-session.nixnew file+141
This diff is too big to show here.
nixos/modules/services/desktops/pipewire/pipewire.nixnew file+262
This diff is too big to show here.
nixos/modules/services/desktops/pipewire/wireplumber.nixnew file+54
This diff is too big to show here.
nixos/modules/services/desktops/profile-sync-daemon.nixnew file+77
This diff is too big to show here.
nixos/modules/services/desktops/system-config-printer.nixnew file+41
This diff is too big to show here.
nixos/modules/services/desktops/telepathy.nixnew file+48
This diff is too big to show here.
nixos/modules/services/desktops/tumbler.nixnew file+52
This diff is too big to show here.
nixos/modules/services/desktops/zeitgeist.nixnew file+31
This diff is too big to show here.
nixos/modules/services/development/blackfire.nixnew file+60
This diff is too big to show here.
nixos/modules/services/development/blackfire.xmlnew file+46
This diff is too big to show here.
nixos/modules/services/development/bloop.nixnew file+54
This diff is too big to show here.
nixos/modules/services/development/distccd.nixnew file+155
This diff is too big to show here.
nixos/modules/services/development/hoogle.nixnew file+81
This diff is too big to show here.
nixos/modules/services/development/jupyter/default.nixnew file+202
This diff is too big to show here.
nixos/modules/services/development/jupyter/kernel-options.nixnew file+60
This diff is too big to show here.
nixos/modules/services/development/jupyterhub/default.nixnew file+202
This diff is too big to show here.
nixos/modules/services/development/lorri.nixnew file+55
This diff is too big to show here.
nixos/modules/services/development/rstudio-server/default.nixnew file+107
This diff is too big to show here.
nixos/modules/services/development/zammad.nixnew file+323
This diff is too big to show here.
nixos/modules/services/display-managers/greetd.nixnew file+111
This diff is too big to show here.
nixos/modules/services/editors/emacs.nixnew file+103
This diff is too big to show here.
nixos/modules/services/editors/emacs.xmlnew file+580
This diff is too big to show here.
nixos/modules/services/editors/haste.nixnew file+86
This diff is too big to show here.
nixos/modules/services/editors/infinoted.nixnew file+160
This diff is too big to show here.
nixos/modules/services/finance/odoo.nixnew file+122
This diff is too big to show here.
nixos/modules/services/games/asf.nixnew file+236
This diff is too big to show here.
nixos/modules/services/games/crossfire-server.nixnew file+179
This diff is too big to show here.
nixos/modules/services/games/deliantra-server.nixnew file+172
This diff is too big to show here.
nixos/modules/services/games/factorio.nixnew file+277
This diff is too big to show here.
nixos/modules/services/games/freeciv.nixnew file+187
This diff is too big to show here.
nixos/modules/services/games/minecraft-server.nixnew file+257
This diff is too big to show here.
nixos/modules/services/games/minetest-server.nixnew file+107
This diff is too big to show here.
nixos/modules/services/games/openarena.nixnew file+56
This diff is too big to show here.
nixos/modules/services/games/quake3-server.nixnew file+112
This diff is too big to show here.
nixos/modules/services/games/teeworlds.nixnew file+119
This diff is too big to show here.
nixos/modules/services/games/terraria.nixnew file+169
This diff is too big to show here.
nixos/modules/services/hardware/acpid.nixnew file+155
This diff is too big to show here.
nixos/modules/services/hardware/actkbd.nixnew file+133
This diff is too big to show here.
nixos/modules/services/hardware/auto-cpufreq.nixnew file+24
This diff is too big to show here.
nixos/modules/services/hardware/bluetooth.nixnew file+141
This diff is too big to show here.
nixos/modules/services/hardware/bolt.nixnew file+34
This diff is too big to show here.
nixos/modules/services/hardware/brltty.nixnew file+57
This diff is too big to show here.
nixos/modules/services/hardware/ddccontrol.nixnew file+39
This diff is too big to show here.
nixos/modules/services/hardware/fancontrol.nixnew file+48
This diff is too big to show here.
nixos/modules/services/hardware/freefall.nixnew file+64
This diff is too big to show here.
nixos/modules/services/hardware/fwupd.nixnew file+134
This diff is too big to show here.
nixos/modules/services/hardware/illum.nixnew file+35
This diff is too big to show here.
nixos/modules/services/hardware/interception-tools.nixnew file+62
This diff is too big to show here.
nixos/modules/services/hardware/irqbalance.nixnew file+24
This diff is too big to show here.
nixos/modules/services/hardware/joycond.nixnew file+36
This diff is too big to show here.
nixos/modules/services/hardware/lcd.nixnew file+171
This diff is too big to show here.
nixos/modules/services/hardware/lirc.nixnew file+100
This diff is too big to show here.
nixos/modules/services/hardware/nvidia-optimus.nixnew file+43
This diff is too big to show here.
nixos/modules/services/hardware/pcscd.nixnew file+73
This diff is too big to show here.
nixos/modules/services/hardware/pommed.nixnew file+50
This diff is too big to show here.
nixos/modules/services/hardware/power-profiles-daemon.nixnew file+55
This diff is too big to show here.
nixos/modules/services/hardware/rasdaemon.nixnew file+170
This diff is too big to show here.
nixos/modules/services/hardware/ratbagd.nixnew file+27
This diff is too big to show here.
nixos/modules/services/hardware/sane.nixnew file+197
This diff is too big to show here.
nixos/modules/services/hardware/sane_extra_backends/brscan4.nixnew file+112
This diff is too big to show here.
nixos/modules/services/hardware/sane_extra_backends/brscan4_etc_files.nixnew file+68
This diff is too big to show here.
nixos/modules/services/hardware/sane_extra_backends/brscan5.nixnew file+110
This diff is too big to show here.
nixos/modules/services/hardware/sane_extra_backends/brscan5_etc_files.nixnew file+77
This diff is too big to show here.
nixos/modules/services/hardware/sane_extra_backends/dsseries.nixnew file+26
This diff is too big to show here.
nixos/modules/services/hardware/spacenavd.nixnew file+24
This diff is too big to show here.
nixos/modules/services/hardware/tcsd.nixnew file+162
This diff is too big to show here.
nixos/modules/services/hardware/thermald.nixnew file+57
This diff is too big to show here.
nixos/modules/services/hardware/thinkfan.nixnew file+224
This diff is too big to show here.
nixos/modules/services/hardware/throttled.nixnew file+36
This diff is too big to show here.
nixos/modules/services/hardware/tlp.nixnew file+124
This diff is too big to show here.
nixos/modules/services/hardware/trezord.nixnew file+70
This diff is too big to show here.
nixos/modules/services/hardware/trezord.xmlnew file+26
This diff is too big to show here.
nixos/modules/services/hardware/triggerhappy.nixnew file+122
This diff is too big to show here.
nixos/modules/services/hardware/udev.nixnew file+443
This diff is too big to show here.
nixos/modules/services/hardware/udisks2.nixnew file+85
This diff is too big to show here.
nixos/modules/services/hardware/undervolt.nixnew file+190
This diff is too big to show here.
nixos/modules/services/hardware/upower.nixnew file+239
This diff is too big to show here.
nixos/modules/services/hardware/usbmuxd.nixnew file+76
This diff is too big to show here.
nixos/modules/services/hardware/usbrelayd.nixnew file+44
This diff is too big to show here.
nixos/modules/services/hardware/vdr.nixnew file+82
This diff is too big to show here.
nixos/modules/services/hardware/xow.nixnew file+20
This diff is too big to show here.
nixos/modules/services/home-automation/home-assistant.nixnew file+552
This diff is too big to show here.
nixos/modules/services/home-automation/zigbee2mqtt.nixnew file+142
This diff is too big to show here.
nixos/modules/services/logging/SystemdJournal2Gelf.nixnew file+60
This diff is too big to show here.
nixos/modules/services/logging/awstats.nixnew file+257
This diff is too big to show here.
nixos/modules/services/logging/filebeat.nixnew file+253
This diff is too big to show here.
nixos/modules/services/logging/fluentd.nixnew file+58
This diff is too big to show here.
nixos/modules/services/logging/graylog.nixnew file+169
This diff is too big to show here.
nixos/modules/services/logging/heartbeat.nixnew file+74
This diff is too big to show here.
nixos/modules/services/logging/journalbeat.nixnew file+94
This diff is too big to show here.
nixos/modules/services/logging/journaldriver.nixnew file+112
This diff is too big to show here.
nixos/modules/services/logging/journalwatch.nixnew file+265
This diff is too big to show here.
nixos/modules/services/logging/klogd.nixnew file+9
This diff is too big to show here.
nixos/modules/services/logging/logcheck.nixnew file+242
This diff is too big to show here.
nixos/modules/services/logging/logrotate.nixnew file+403
This diff is too big to show here.
nixos/modules/services/logging/logstash.nixnew file+194
This diff is too big to show here.
nixos/modules/services/logging/promtail.nixnew file+91
This diff is too big to show here.
nixos/modules/services/logging/rsyslogd.nixnew file+105
This diff is too big to show here.
nixos/modules/services/logging/syslog-ng.nixnew file+101
This diff is too big to show here.
nixos/modules/services/logging/syslogd.nixnew file+130
This diff is too big to show here.
nixos/modules/services/logging/vector.nixnew file+64
This diff is too big to show here.
nixos/modules/services/mail/clamsmtp.nixnew file+181
This diff is too big to show here.
nixos/modules/services/mail/davmail.nixnew file+99
This diff is too big to show here.
nixos/modules/services/mail/dkimproxy-out.nixnew file+120
This diff is too big to show here.
nixos/modules/services/mail/dovecot.nixnew file+462
This diff is too big to show here.
nixos/modules/services/mail/dspam.nixnew file+150
This diff is too big to show here.
nixos/modules/services/mail/exim.nixnew file+132
This diff is too big to show here.
nixos/modules/services/mail/maddy.nixnew file+273
This diff is too big to show here.
nixos/modules/services/mail/mail.nixnew file+34
This diff is too big to show here.
nixos/modules/services/mail/mailcatcher.nixnew file+68
This diff is too big to show here.
nixos/modules/services/mail/mailhog.nixnew file+82
This diff is too big to show here.
nixos/modules/services/mail/mailman.nixnew file+469
This diff is too big to show here.
nixos/modules/services/mail/mailman.xmlnew file+94
This diff is too big to show here.
nixos/modules/services/mail/mlmmj.nixnew file+171
This diff is too big to show here.
nixos/modules/services/mail/nullmailer.nixnew file+244
This diff is too big to show here.
nixos/modules/services/mail/offlineimap.nixnew file+72
This diff is too big to show here.
nixos/modules/services/mail/opendkim.nixnew file+167
This diff is too big to show here.
nixos/modules/services/mail/opensmtpd.nixnew file+135
This diff is too big to show here.
nixos/modules/services/mail/pfix-srsd.nixnew file+56
This diff is too big to show here.
nixos/modules/services/mail/postfix.nixnew file+993
This diff is too big to show here.
nixos/modules/services/mail/postfixadmin.nixnew file+199
This diff is too big to show here.
nixos/modules/services/mail/postgrey.nixnew file+205
This diff is too big to show here.
nixos/modules/services/mail/postsrsd.nixnew file+135
This diff is too big to show here.
nixos/modules/services/mail/roundcube.nixnew file+249
This diff is too big to show here.
nixos/modules/services/mail/rspamd.nixnew file+446
This diff is too big to show here.
nixos/modules/services/mail/rss2email.nixnew file+135
This diff is too big to show here.
nixos/modules/services/mail/spamassassin.nixnew file+191
This diff is too big to show here.
nixos/modules/services/mail/sympa.nixnew file+590
This diff is too big to show here.
nixos/modules/services/matrix/matrix-synapse-log_config.yamlnew file+25
This diff is too big to show here.
nixos/modules/services/matrix/matrix-synapse.nixnew file+773
This diff is too big to show here.
nixos/modules/services/matrix/matrix-synapse.xmlnew file+231
This diff is too big to show here.
nixos/modules/services/matrix/mjolnir.nixnew file+242
This diff is too big to show here.
nixos/modules/services/matrix/mjolnir.xmlnew file+134
This diff is too big to show here.
nixos/modules/services/matrix/pantalaimon-options.nixnew file+70
This diff is too big to show here.
nixos/modules/services/matrix/pantalaimon.nixnew file+70
This diff is too big to show here.
nixos/modules/services/misc/airsonic.nixnew file+179
This diff is too big to show here.
nixos/modules/services/misc/ananicy.nixnew file+107
This diff is too big to show here.
nixos/modules/services/misc/ankisyncd.nixnew file+79
This diff is too big to show here.
nixos/modules/services/misc/apache-kafka.nixnew file+151
This diff is too big to show here.
nixos/modules/services/misc/autofs.nixnew file+100
This diff is too big to show here.
nixos/modules/services/misc/autorandr.nixnew file+359
This diff is too big to show here.
nixos/modules/services/misc/bazarr.nixnew file+77
This diff is too big to show here.
nixos/modules/services/misc/beanstalkd.nixnew file+63
This diff is too big to show here.
nixos/modules/services/misc/bees.nixnew file+132
This diff is too big to show here.
nixos/modules/services/misc/bepasty.nixnew file+179
This diff is too big to show here.
nixos/modules/services/misc/calibre-server.nixnew file+86
This diff is too big to show here.
nixos/modules/services/misc/canto-daemon.nixnew file+37
This diff is too big to show here.
nixos/modules/services/misc/cfdyndns.nixnew file+82
This diff is too big to show here.
nixos/modules/services/misc/cgminer.nixnew file+148
This diff is too big to show here.
nixos/modules/services/misc/clipcat.nixnew file+31
This diff is too big to show here.
nixos/modules/services/misc/clipmenu.nixnew file+31
This diff is too big to show here.
nixos/modules/services/misc/confd.nixnew file+90
This diff is too big to show here.
nixos/modules/services/misc/cpuminer-cryptonight.nixnew file+66
This diff is too big to show here.
nixos/modules/services/misc/dendrite.nixnew file+273
This diff is too big to show here.
nixos/modules/services/misc/devmon.nixnew file+25
This diff is too big to show here.
nixos/modules/services/misc/dictd.nixnew file+65
This diff is too big to show here.
nixos/modules/services/misc/disnix.nixnew file+98
This diff is too big to show here.
nixos/modules/services/misc/docker-registry.nixnew file+159
This diff is too big to show here.
nixos/modules/services/misc/domoticz.nixnew file+51
This diff is too big to show here.
nixos/modules/services/misc/duckling.nixnew file+39
This diff is too big to show here.
nixos/modules/services/misc/dwm-status.nixnew file+73
This diff is too big to show here.
nixos/modules/services/misc/dysnomia.nixnew file+265
This diff is too big to show here.
nixos/modules/services/misc/errbot.nixnew file+104
This diff is too big to show here.
nixos/modules/services/misc/etcd.nixnew file+205
This diff is too big to show here.
nixos/modules/services/misc/etebase-server.nixnew file+226
This diff is too big to show here.
nixos/modules/services/misc/etesync-dav.nixnew file+92
This diff is too big to show here.
nixos/modules/services/misc/ethminer.nixnew file+117
This diff is too big to show here.
nixos/modules/services/misc/exhibitor.nixnew file+422
This diff is too big to show here.
nixos/modules/services/misc/felix.nixnew file+104
This diff is too big to show here.
nixos/modules/services/misc/freeswitch.nixnew file+104
This diff is too big to show here.
nixos/modules/services/misc/fstrim.nixnew file+46
This diff is too big to show here.
nixos/modules/services/misc/gammu-smsd.nixnew file+253
This diff is too big to show here.
nixos/modules/services/misc/geoipupdate.nixnew file+187
This diff is too big to show here.
nixos/modules/services/misc/gitea.nixnew file+658
This diff is too big to show here.
nixos/modules/services/misc/gitit.nixnew file+725
This diff is too big to show here.
nixos/modules/services/misc/gitlab.nixnew file+1456
This diff is too big to show here.
nixos/modules/services/misc/gitlab.xmlnew file+151
This diff is too big to show here.
nixos/modules/services/misc/gitolite.nixnew file+234
This diff is too big to show here.
nixos/modules/services/misc/gitweb.nixnew file+60
This diff is too big to show here.
nixos/modules/services/misc/gogs.nixnew file+274
This diff is too big to show here.
nixos/modules/services/misc/gollum.nixnew file+121
This diff is too big to show here.
nixos/modules/services/misc/gpsd.nixnew file+116
This diff is too big to show here.
nixos/modules/services/misc/greenclip.nixnew file+31
This diff is too big to show here.
nixos/modules/services/misc/headphones.nixnew file+89
This diff is too big to show here.
nixos/modules/services/misc/heisenbridge.nixnew file+222
This diff is too big to show here.
nixos/modules/services/misc/ihaskell.nixnew file+65
This diff is too big to show here.
nixos/modules/services/misc/input-remapper.nixnew file+30
This diff is too big to show here.
nixos/modules/services/misc/irkerd.nixnew file+67
This diff is too big to show here.
nixos/modules/services/misc/jackett.nixnew file+82
This diff is too big to show here.
nixos/modules/services/misc/jellyfin.nixnew file+122
This diff is too big to show here.
nixos/modules/services/misc/klipper.nixnew file+117
This diff is too big to show here.
nixos/modules/services/misc/leaps.nixnew file+62
This diff is too big to show here.
nixos/modules/services/misc/libreddit.nixnew file+66
This diff is too big to show here.
nixos/modules/services/misc/lidarr.nixnew file+89
This diff is too big to show here.
nixos/modules/services/misc/lifecycled.nixnew file+164
This diff is too big to show here.
nixos/modules/services/misc/logkeys.nixnew file+30
This diff is too big to show here.
nixos/modules/services/misc/mame.nixnew file+69
This diff is too big to show here.
nixos/modules/services/misc/matrix-appservice-discord.nixnew file+161
This diff is too big to show here.
nixos/modules/services/misc/matrix-appservice-irc.nixnew file+232
This diff is too big to show here.
nixos/modules/services/misc/matrix-conduit.nixnew file+149
This diff is too big to show here.
nixos/modules/services/misc/mautrix-facebook.nixnew file+195
This diff is too big to show here.
nixos/modules/services/misc/mautrix-telegram.nixnew file+181
This diff is too big to show here.
nixos/modules/services/misc/mbpfan.nixnew file+107
This diff is too big to show here.
nixos/modules/services/misc/mediatomb.nixnew file+394
This diff is too big to show here.
nixos/modules/services/misc/metabase.nixnew file+103
This diff is too big to show here.
nixos/modules/services/misc/moonraker.nixnew file+178
This diff is too big to show here.
nixos/modules/services/misc/mx-puppet-discord.nixnew file+122
This diff is too big to show here.
nixos/modules/services/misc/n8n.nixnew file+79
This diff is too big to show here.
nixos/modules/services/misc/nitter.nixnew file+358
This diff is too big to show here.
nixos/modules/services/misc/nix-daemon.nixnew file+826
This diff is too big to show here.
nixos/modules/services/misc/nix-gc.nixnew file+106
This diff is too big to show here.
nixos/modules/services/misc/nix-optimise.nixnew file+57
This diff is too big to show here.
nixos/modules/services/misc/nix-ssh-serve.nixnew file+69
This diff is too big to show here.
nixos/modules/services/misc/novacomd.nixnew file+31
This diff is too big to show here.
nixos/modules/services/misc/nzbget.nixnew file+117
This diff is too big to show here.
nixos/modules/services/misc/nzbhydra2.nixnew file+78
This diff is too big to show here.
nixos/modules/services/misc/octoprint.nixnew file+133
This diff is too big to show here.
nixos/modules/services/misc/ombi.nixnew file+81
This diff is too big to show here.
nixos/modules/services/misc/osrm.nixnew file+86
This diff is too big to show here.
nixos/modules/services/misc/owncast.nixnew file+98
This diff is too big to show here.
nixos/modules/services/misc/packagekit.nixnew file+74
This diff is too big to show here.
nixos/modules/services/misc/paperless.nixnew file+320
This diff is too big to show here.
nixos/modules/services/misc/parsoid.nixnew file+129
This diff is too big to show here.
nixos/modules/services/misc/pinnwand.nixnew file+103
This diff is too big to show here.
nixos/modules/services/misc/plex.nixnew file+180
This diff is too big to show here.
nixos/modules/services/misc/plikd.nixnew file+82
This diff is too big to show here.
nixos/modules/services/misc/podgrab.nixnew file+50
This diff is too big to show here.
nixos/modules/services/misc/prowlarr.nixnew file+41
This diff is too big to show here.
nixos/modules/services/misc/pykms.nixnew file+92
This diff is too big to show here.
nixos/modules/services/misc/radarr.nixnew file+75
This diff is too big to show here.
nixos/modules/services/misc/redmine.nixnew file+384
This diff is too big to show here.
nixos/modules/services/misc/ripple-data-api.nixnew file+195
This diff is too big to show here.
nixos/modules/services/misc/rippled.nixnew file+438
This diff is too big to show here.
nixos/modules/services/misc/rmfakecloud.nixnew file+147
This diff is too big to show here.
nixos/modules/services/misc/safeeyes.nixnew file+51
This diff is too big to show here.
nixos/modules/services/misc/sdrplay.nixnew file+35
This diff is too big to show here.
nixos/modules/services/misc/serviio.nixnew file+87
This diff is too big to show here.
nixos/modules/services/misc/sickbeard.nixnew file+95
This diff is too big to show here.
nixos/modules/services/misc/signald.nixnew file+105
This diff is too big to show here.
nixos/modules/services/misc/siproxd.nixnew file+179
This diff is too big to show here.
nixos/modules/services/misc/snapper.nixnew file+187
This diff is too big to show here.
nixos/modules/services/misc/sonarr.nixnew file+76
This diff is too big to show here.
nixos/modules/services/misc/sourcehut/builds.nixnew file+236
This diff is too big to show here.
nixos/modules/services/misc/sourcehut/default.nixnew file+1386
This diff is too big to show here.
nixos/modules/services/misc/sourcehut/dispatch.nixnew file+127
This diff is too big to show here.
nixos/modules/services/misc/sourcehut/git.nixnew file+217
This diff is too big to show here.
nixos/modules/services/misc/sourcehut/hg.nixnew file+175
This diff is too big to show here.
nixos/modules/services/misc/sourcehut/hub.nixnew file+120
This diff is too big to show here.
nixos/modules/services/misc/sourcehut/lists.nixnew file+187
This diff is too big to show here.
nixos/modules/services/misc/sourcehut/man.nixnew file+124
This diff is too big to show here.
nixos/modules/services/misc/sourcehut/meta.nixnew file+213
This diff is too big to show here.
nixos/modules/services/misc/sourcehut/paste.nixnew file+135
This diff is too big to show here.
nixos/modules/services/misc/sourcehut/service.nixnew file+375
This diff is too big to show here.
nixos/modules/services/misc/sourcehut/sourcehut.xmlnew file+119
This diff is too big to show here.
nixos/modules/services/misc/sourcehut/todo.nixnew file+163
This diff is too big to show here.
nixos/modules/services/misc/spice-vdagentd.nixnew file+30
This diff is too big to show here.
nixos/modules/services/misc/ssm-agent.nixnew file+73
This diff is too big to show here.
nixos/modules/services/misc/sssd.nixnew file+97
This diff is too big to show here.
nixos/modules/services/misc/subsonic.nixnew file+169
This diff is too big to show here.
nixos/modules/services/misc/sundtek.nixnew file+33
This diff is too big to show here.
nixos/modules/services/misc/svnserve.nixnew file+46
This diff is too big to show here.
nixos/modules/services/misc/synergy.nixnew file+149
This diff is too big to show here.
nixos/modules/services/misc/sysprof.nixnew file+19
This diff is too big to show here.
nixos/modules/services/misc/taskserver/default.nixnew file+573
This diff is too big to show here.
nixos/modules/services/misc/taskserver/doc.xmlnew file+135
This diff is too big to show here.
nixos/modules/services/misc/taskserver/helper-tool.pynew file+688
This diff is too big to show here.
nixos/modules/services/misc/tautulli.nixnew file+81
This diff is too big to show here.
nixos/modules/services/misc/tiddlywiki.nixnew file+52
This diff is too big to show here.
nixos/modules/services/misc/tp-auto-kbbl.nixnew file+58
This diff is too big to show here.
nixos/modules/services/misc/tzupdate.nixnew file+45
This diff is too big to show here.
nixos/modules/services/misc/uhub.nixnew file+112
This diff is too big to show here.
nixos/modules/services/misc/weechat.nixnew file+63
This diff is too big to show here.
nixos/modules/services/misc/weechat.xmlnew file+66
This diff is too big to show here.
nixos/modules/services/misc/xmr-stak.nixnew file+93
This diff is too big to show here.
nixos/modules/services/misc/xmrig.nixnew file+76
This diff is too big to show here.
nixos/modules/services/misc/zoneminder.nixnew file+370
This diff is too big to show here.
nixos/modules/services/misc/zookeeper.nixnew file+165
This diff is too big to show here.
nixos/modules/services/monitoring/alerta.nixnew file+111
This diff is too big to show here.
nixos/modules/services/monitoring/apcupsd.nixnew file+191
This diff is too big to show here.
nixos/modules/services/monitoring/arbtt.nixnew file+62
This diff is too big to show here.
nixos/modules/services/monitoring/bosun.nixnew file+165
This diff is too big to show here.
nixos/modules/services/monitoring/cadvisor.nixnew file+142
This diff is too big to show here.
nixos/modules/services/monitoring/collectd.nixnew file+166
This diff is too big to show here.
nixos/modules/services/monitoring/das_watchdog.nixnew file+34
This diff is too big to show here.
nixos/modules/services/monitoring/datadog-agent.nixnew file+296
This diff is too big to show here.
nixos/modules/services/monitoring/dd-agent/dd-agent-defaults.nixnew file+8
This diff is too big to show here.
nixos/modules/services/monitoring/dd-agent/dd-agent.nixnew file+236
This diff is too big to show here.
nixos/modules/services/monitoring/dd-agent/update-dd-agent-defaultsnew file+9
This diff is too big to show here.
nixos/modules/services/monitoring/do-agent.nixnew file+25
This diff is too big to show here.
nixos/modules/services/monitoring/fusion-inventory.nixnew file+63
This diff is too big to show here.
nixos/modules/services/monitoring/grafana-image-renderer.nixnew file+150
This diff is too big to show here.
nixos/modules/services/monitoring/grafana-reporter.nixnew file+67
This diff is too big to show here.
nixos/modules/services/monitoring/grafana.nixnew file+728
This diff is too big to show here.
nixos/modules/services/monitoring/graphite.nixnew file+582
This diff is too big to show here.
nixos/modules/services/monitoring/hdaps.nixnew file+23
This diff is too big to show here.
nixos/modules/services/monitoring/heapster.nixnew file+59
This diff is too big to show here.
nixos/modules/services/monitoring/incron.nixnew file+103
This diff is too big to show here.
nixos/modules/services/monitoring/kapacitor.nixnew file+188
This diff is too big to show here.
nixos/modules/services/monitoring/loki.nixnew file+114
This diff is too big to show here.
nixos/modules/services/monitoring/longview.nixnew file+160
This diff is too big to show here.
nixos/modules/services/monitoring/mackerel-agent.nixnew file+110
This diff is too big to show here.
nixos/modules/services/monitoring/metricbeat.nixnew file+151
This diff is too big to show here.
nixos/modules/services/monitoring/mimir.nixnew file+63
This diff is too big to show here.
nixos/modules/services/monitoring/monit.nixnew file+48
This diff is too big to show here.
nixos/modules/services/monitoring/munin.nixnew file+404
This diff is too big to show here.
nixos/modules/services/monitoring/nagios.nixnew file+213
This diff is too big to show here.
nixos/modules/services/monitoring/netdata.nixnew file+310
This diff is too big to show here.
nixos/modules/services/monitoring/parsedmarc.mdnew file+113
This diff is too big to show here.
nixos/modules/services/monitoring/parsedmarc.nixnew file+542
This diff is too big to show here.
nixos/modules/services/monitoring/parsedmarc.xmlnew file+125
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/alertmanager.nixnew file+187
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/default.nixnew file+1828
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters.nixnew file+303
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters.xmlnew file+248
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/apcupsd.nixnew file+38
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/artifactory.nixnew file+59
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/bind.nixnew file+54
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/bird.nixnew file+50
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/bitcoin.nixnew file+82
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/blackbox.nixnew file+70
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/buildkite-agent.nixnew file+64
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/collectd.nixnew file+77
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/dmarc.nixnew file+117
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/dnsmasq.nixnew file+38
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/domain.nixnew file+19
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/dovecot.nixnew file+92
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/fastly.nixnew file+41
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/flow.nixnew file+50
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/fritzbox.nixnew file+38
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/influxdb.nixnew file+34
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/jitsi.nixnew file+40
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/json.nixnew file+43
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/kea.nixnew file+47
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/keylight.nixnew file+19
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/knot.nixnew file+54
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/lnd.nixnew file+46
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/mail.nixnew file+176
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/mikrotik.nixnew file+66
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/minio.nixnew file+64
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/modemmanager.nixnew file+37
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/nextcloud.nixnew file+58
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/nginx.nixnew file+68
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/nginxlog.nixnew file+51
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/node.nixnew file+49
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/openldap.nixnew file+67
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/openvpn.nixnew file+39
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/pihole.nixnew file+74
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/postfix.nixnew file+98
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/postgres.nixnew file+88
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/process.nixnew file+46
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/pve.nixnew file+118
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/py-air-control.nixnew file+53
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/redis.nixnew file+19
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/rspamd.nixnew file+97
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/rtl_433.nixnew file+83
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/script.nixnew file+64
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/smartctl.nixnew file+75
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/smokeping.nixnew file+61
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/snmp.nixnew file+68
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/sql.nixnew file+108
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/surfboard.nixnew file+31
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/systemd.nixnew file+22
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/tor.nixnew file+44
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/unbound.nixnew file+63
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/unifi-poller.nixnew file+34
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/unifi.nixnew file+66
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/varnish.nixnew file+89
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/wireguard.nixnew file+71
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/pushgateway.nixnew file+166
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/xmpp-alerts.nixnew file+55
This diff is too big to show here.
nixos/modules/services/monitoring/riemann-dash.nixnew file+81
This diff is too big to show here.
nixos/modules/services/monitoring/riemann-tools.nixnew file+70
This diff is too big to show here.
nixos/modules/services/monitoring/riemann.nixnew file+105
This diff is too big to show here.
nixos/modules/services/monitoring/scollector.nixnew file+134
This diff is too big to show here.
nixos/modules/services/monitoring/smartd.nixnew file+253
This diff is too big to show here.
nixos/modules/services/monitoring/statsd.nixnew file+149
This diff is too big to show here.
nixos/modules/services/monitoring/sysstat.nixnew file+76
This diff is too big to show here.
nixos/modules/services/monitoring/teamviewer.nixnew file+49
This diff is too big to show here.
nixos/modules/services/monitoring/telegraf.nixnew file+90
This diff is too big to show here.
nixos/modules/services/monitoring/thanos.nixnew file+838
This diff is too big to show here.
nixos/modules/services/monitoring/tuptime.nixnew file+91
This diff is too big to show here.
nixos/modules/services/monitoring/unifi-poller.nixnew file+318
This diff is too big to show here.
nixos/modules/services/monitoring/ups.nixnew file+263
This diff is too big to show here.
nixos/modules/services/monitoring/uptime.nixnew file+100
This diff is too big to show here.
nixos/modules/services/monitoring/vnstat.nixnew file+60
This diff is too big to show here.
nixos/modules/services/monitoring/zabbix-agent.nixnew file+178
This diff is too big to show here.
nixos/modules/services/monitoring/zabbix-proxy.nixnew file+323
This diff is too big to show here.
nixos/modules/services/monitoring/zabbix-server.nixnew file+320
This diff is too big to show here.
nixos/modules/services/network-filesystems/cachefilesd.nixnew file+63
This diff is too big to show here.
nixos/modules/services/network-filesystems/ceph.nixnew file+406
This diff is too big to show here.
nixos/modules/services/network-filesystems/davfs2.nixnew file+93
This diff is too big to show here.
nixos/modules/services/network-filesystems/diod.nixnew file+159
This diff is too big to show here.
nixos/modules/services/network-filesystems/drbd.nixnew file+63
This diff is too big to show here.
nixos/modules/services/network-filesystems/glusterfs.nixnew file+208
This diff is too big to show here.
nixos/modules/services/network-filesystems/ipfs.nixnew file+323
This diff is too big to show here.
nixos/modules/services/network-filesystems/kbfs.nixnew file+118
This diff is too big to show here.
nixos/modules/services/network-filesystems/litestream/default.nixnew file+100
This diff is too big to show here.
nixos/modules/services/network-filesystems/litestream/litestream.xmlnew file+65
This diff is too big to show here.
nixos/modules/services/network-filesystems/moosefs.nixnew file+249
This diff is too big to show here.
nixos/modules/services/network-filesystems/netatalk.nixnew file+97
This diff is too big to show here.
nixos/modules/services/network-filesystems/nfsd.nixnew file+175
This diff is too big to show here.
nixos/modules/services/network-filesystems/openafs/client.nixnew file+252
This diff is too big to show here.
nixos/modules/services/network-filesystems/openafs/lib.nixnew file+33
This diff is too big to show here.
nixos/modules/services/network-filesystems/openafs/server.nixnew file+269
This diff is too big to show here.
nixos/modules/services/network-filesystems/orangefs/client.nixnew file+96
This diff is too big to show here.
nixos/modules/services/network-filesystems/orangefs/server.nixnew file+225
This diff is too big to show here.
nixos/modules/services/network-filesystems/rsyncd.nixnew file+128
This diff is too big to show here.
nixos/modules/services/network-filesystems/samba-wsdd.nixnew file+124
This diff is too big to show here.
nixos/modules/services/network-filesystems/samba.nixnew file+253
This diff is too big to show here.
nixos/modules/services/network-filesystems/tahoe.nixnew file+366
This diff is too big to show here.
nixos/modules/services/network-filesystems/u9fs.nixnew file+78
This diff is too big to show here.
nixos/modules/services/network-filesystems/webdav-server-rs.nixnew file+144
This diff is too big to show here.
nixos/modules/services/network-filesystems/webdav.nixnew file+107
This diff is too big to show here.
nixos/modules/services/network-filesystems/xtreemfs.nixnew file+495
This diff is too big to show here.
nixos/modules/services/network-filesystems/yandex-disk.nixnew file+116
This diff is too big to show here.
nixos/modules/services/networking/3proxy.nixnew file+413
This diff is too big to show here.
nixos/modules/services/networking/adguardhome.nixnew file+140
This diff is too big to show here.
nixos/modules/services/networking/amuled.nixnew file+83
This diff is too big to show here.
nixos/modules/services/networking/antennas.nixnew file+80
This diff is too big to show here.
nixos/modules/services/networking/aria2.nixnew file+131
This diff is too big to show here.
nixos/modules/services/networking/asterisk.nixnew file+232
This diff is too big to show here.
nixos/modules/services/networking/atftpd.nixnew file+65
This diff is too big to show here.
nixos/modules/services/networking/autossh.nixnew file+113
This diff is too big to show here.
nixos/modules/services/networking/avahi-daemon.nixnew file+286
This diff is too big to show here.
nixos/modules/services/networking/babeld.nixnew file+144
This diff is too big to show here.
nixos/modules/services/networking/bee-clef.nixnew file+107
This diff is too big to show here.
nixos/modules/services/networking/bee.nixnew file+149
This diff is too big to show here.
nixos/modules/services/networking/biboumi.nixnew file+270
This diff is too big to show here.
nixos/modules/services/networking/bind.nixnew file+274
This diff is too big to show here.
nixos/modules/services/networking/bird.nixnew file+102
This diff is too big to show here.
nixos/modules/services/networking/bitcoind.nixnew file+261
This diff is too big to show here.
nixos/modules/services/networking/bitlbee.nixnew file+189
This diff is too big to show here.
nixos/modules/services/networking/blockbook-frontend.nixnew file+278
This diff is too big to show here.
nixos/modules/services/networking/blocky.nixnew file+40
This diff is too big to show here.
nixos/modules/services/networking/charybdis.nix+114
This diff is too big to show here.
nixos/modules/services/networking/cjdns.nix+304
This diff is too big to show here.
nixos/modules/services/networking/cloudflare-dyndns.nix+93
This diff is too big to show here.
nixos/modules/services/networking/cntlm.nix+126
This diff is too big to show here.
nixos/modules/services/networking/connman.nix+162
This diff is too big to show here.
nixos/modules/services/networking/consul.nix+285
This diff is too big to show here.
nixos/modules/services/networking/coredns.nix+50
This diff is too big to show here.
nixos/modules/services/networking/corerad.nix+82
This diff is too big to show here.
nixos/modules/services/networking/coturn.nix+365
This diff is too big to show here.
nixos/modules/services/networking/create_ap.nix+50
This diff is too big to show here.
nixos/modules/services/networking/croc.nix+86
This diff is too big to show here.
nixos/modules/services/networking/dante.nix+62
This diff is too big to show here.
nixos/modules/services/networking/ddclient.nix+239
This diff is too big to show here.
nixos/modules/services/networking/dhcpcd.nix+250
This diff is too big to show here.
nixos/modules/services/networking/dhcpd.nix+223
This diff is too big to show here.
nixos/modules/services/networking/dnscache.nix+108
This diff is too big to show here.
nixos/modules/services/networking/dnscrypt-proxy2.nix+124
This diff is too big to show here.
nixos/modules/services/networking/dnscrypt-wrapper.nix+286
This diff is too big to show here.
nixos/modules/services/networking/dnsdist.nix+53
This diff is too big to show here.
nixos/modules/services/networking/dnsmasq.nix+130
This diff is too big to show here.
nixos/modules/services/networking/doh-proxy-rust.nix+60
This diff is too big to show here.
nixos/modules/services/networking/ejabberd.nix+157
This diff is too big to show here.
nixos/modules/services/networking/envoy.nix+84
This diff is too big to show here.
nixos/modules/services/networking/epmd.nix+72
This diff is too big to show here.
nixos/modules/services/networking/ergo.nix+143
This diff is too big to show here.
nixos/modules/services/networking/ergochat.nix+155
This diff is too big to show here.
nixos/modules/services/networking/eternal-terminal.nix+95
This diff is too big to show here.
nixos/modules/services/networking/fakeroute.nix+65
This diff is too big to show here.
nixos/modules/services/networking/ferm.nix+63
This diff is too big to show here.
nixos/modules/services/networking/fireqos.nix+52
This diff is too big to show here.
nixos/modules/services/networking/firewall.nix+584
This diff is too big to show here.
nixos/modules/services/networking/flannel.nix+192
This diff is too big to show here.
nixos/modules/services/networking/freenet.nix+64
This diff is too big to show here.
nixos/modules/services/networking/freeradius.nix+86
This diff is too big to show here.
nixos/modules/services/networking/frr.nix+211
This diff is too big to show here.
nixos/modules/services/networking/gateone.nix+59
This diff is too big to show here.
nixos/modules/services/networking/gdomap.nix+29
This diff is too big to show here.
nixos/modules/services/networking/ghostunnel.nix+242
This diff is too big to show here.
nixos/modules/services/networking/git-daemon.nix+131
This diff is too big to show here.
nixos/modules/services/networking/globalprotect-vpn.nix+43
This diff is too big to show here.
nixos/modules/services/networking/gnunet.nix+170
This diff is too big to show here.
nixos/modules/services/networking/go-neb.nix+79
This diff is too big to show here.
nixos/modules/services/networking/go-shadowsocks2.nix+30
This diff is too big to show here.
nixos/modules/services/networking/gobgpd.nix+64
This diff is too big to show here.
nixos/modules/services/networking/gvpe.nix+130
This diff is too big to show here.
nixos/modules/services/networking/hans.nix+145
This diff is too big to show here.
nixos/modules/services/networking/haproxy.nix+112
This diff is too big to show here.
nixos/modules/services/networking/headscale.nix+490
This diff is too big to show here.
nixos/modules/services/networking/helpers.nix+11
This diff is too big to show here.
nixos/modules/services/networking/hostapd.nix+219
This diff is too big to show here.
nixos/modules/services/networking/htpdate.nix+80
This diff is too big to show here.
nixos/modules/services/networking/https-dns-proxy.nix+128
This diff is too big to show here.
nixos/modules/services/networking/hylafax/default.nix+31
This diff is too big to show here.
nixos/modules/services/networking/hylafax/faxq-default.nix+12
This diff is too big to show here.
nixos/modules/services/networking/hylafax/faxq-wait.sh+29
This diff is too big to show here.
nixos/modules/services/networking/hylafax/hfaxd-default.nix+10
This diff is too big to show here.
nixos/modules/services/networking/hylafax/modem-default.nix+22
This diff is too big to show here.
nixos/modules/services/networking/hylafax/options.nix+372
This diff is too big to show here.
nixos/modules/services/networking/hylafax/spool.sh+111
This diff is too big to show here.
nixos/modules/services/networking/hylafax/systemd.nix+249
This diff is too big to show here.
nixos/modules/services/networking/i2p.nix+34
This diff is too big to show here.
nixos/modules/services/networking/i2pd.nix+691
This diff is too big to show here.
nixos/modules/services/networking/icecream/daemon.nix+155
This diff is too big to show here.
nixos/modules/services/networking/icecream/scheduler.nix+101
This diff is too big to show here.
nixos/modules/services/networking/inspircd.nix+62
This diff is too big to show here.
nixos/modules/services/networking/iodine.nix+198
This diff is too big to show here.
nixos/modules/services/networking/iperf3.nix+97
This diff is too big to show here.
nixos/modules/services/networking/ircd-hybrid/builder.sh+31
This diff is too big to show here.
nixos/modules/services/networking/ircd-hybrid/control.in+26
This diff is too big to show here.
nixos/modules/services/networking/ircd-hybrid/default.nix+133
This diff is too big to show here.
nixos/modules/services/networking/ircd-hybrid/ircd.conf+1051
This diff is too big to show here.
nixos/modules/services/networking/iscsi/initiator.nix+84
This diff is too big to show here.
nixos/modules/services/networking/iscsi/root-initiator.nix+190
This diff is too big to show here.
nixos/modules/services/networking/iscsi/target.nix+53
This diff is too big to show here.
nixos/modules/services/networking/iwd.nix+71
This diff is too big to show here.
nixos/modules/services/networking/jibri/default.nix+417
This diff is too big to show here.
nixos/modules/services/networking/jibri/logging.properties-journal+32
This diff is too big to show here.
nixos/modules/services/networking/jicofo.nix+152
This diff is too big to show here.
nixos/modules/services/networking/jitsi-videobridge.nix+288
This diff is too big to show here.
nixos/modules/services/networking/kea.nix+449
This diff is too big to show here.
nixos/modules/services/networking/keepalived/default.nix+303
This diff is too big to show here.
nixos/modules/services/networking/keepalived/virtual-ip-options.nix+50
This diff is too big to show here.
nixos/modules/services/networking/keepalived/vrrp-instance-options.nix+133
This diff is too big to show here.
nixos/modules/services/networking/keepalived/vrrp-script-options.nix+64
This diff is too big to show here.
nixos/modules/services/networking/keybase.nix+47
This diff is too big to show here.
nixos/modules/services/networking/knot.nix+152
This diff is too big to show here.
nixos/modules/services/networking/kresd.nix+151
This diff is too big to show here.
nixos/modules/services/networking/lambdabot.nix+82
This diff is too big to show here.
nixos/modules/services/networking/libreswan.nix+160
This diff is too big to show here.
nixos/modules/services/networking/lldpd.nix+39
This diff is too big to show here.
nixos/modules/services/networking/logmein-hamachi.nix+50
This diff is too big to show here.
nixos/modules/services/networking/lxd-image-server.nix+133
This diff is too big to show here.
nixos/modules/services/networking/magic-wormhole-mailbox-server.nix+28
This diff is too big to show here.
nixos/modules/services/networking/matterbridge.nix+120
This diff is too big to show here.
nixos/modules/services/networking/minidlna.nix+193
This diff is too big to show here.
nixos/modules/services/networking/miniupnpd.nix+79
This diff is too big to show here.
nixos/modules/services/networking/miredo.nix+92
This diff is too big to show here.
nixos/modules/services/networking/mjpg-streamer.nix+80
This diff is too big to show here.
nixos/modules/services/networking/monero.nix+244
This diff is too big to show here.
nixos/modules/services/networking/morty.nix+98
This diff is too big to show here.
nixos/modules/services/networking/mosquitto.md+102
This diff is too big to show here.
nixos/modules/services/networking/mosquitto.nix+673
This diff is too big to show here.
nixos/modules/services/networking/mosquitto.xml+147
This diff is too big to show here.
nixos/modules/services/networking/mozillavpn.nix+19
This diff is too big to show here.
nixos/modules/services/networking/mstpd.nix+33
This diff is too big to show here.
nixos/modules/services/networking/mtprotoproxy.nix+110
This diff is too big to show here.
nixos/modules/services/networking/mtr-exporter.nix+87
This diff is too big to show here.
nixos/modules/services/networking/mullvad-vpn.nix+50
This diff is too big to show here.
nixos/modules/services/networking/multipath.nix+557
This diff is too big to show here.
nixos/modules/services/networking/murmur.nix+318
This diff is too big to show here.
nixos/modules/services/networking/mxisd.nix+127
This diff is too big to show here.
nixos/modules/services/networking/namecoind.nix+199
This diff is too big to show here.
nixos/modules/services/networking/nar-serve.nix+55
This diff is too big to show here.
nixos/modules/services/networking/nat.nix+364
This diff is too big to show here.
nixos/modules/services/networking/nats.nix+158
This diff is too big to show here.
nixos/modules/services/networking/nbd.nix+159
This diff is too big to show here.
nixos/modules/services/networking/ncdns.nix+283
This diff is too big to show here.
nixos/modules/services/networking/ndppd.nix+189
This diff is too big to show here.
nixos/modules/services/networking/nebula.nix+217
This diff is too big to show here.
nixos/modules/services/networking/networkmanager.nix+571
This diff is too big to show here.
nixos/modules/services/networking/nextdns.nix+44
This diff is too big to show here.
nixos/modules/services/networking/nftables.nix+131
This diff is too big to show here.
nixos/modules/services/networking/nghttpx/backend-params-submodule.nix+131
This diff is too big to show here.
nixos/modules/services/networking/nghttpx/backend-submodule.nix+50
This diff is too big to show here.
nixos/modules/services/networking/nghttpx/default.nix+118
This diff is too big to show here.
nixos/modules/services/networking/nghttpx/frontend-params-submodule.nix+64
This diff is too big to show here.
nixos/modules/services/networking/nghttpx/frontend-submodule.nix+36
This diff is too big to show here.
nixos/modules/services/networking/nghttpx/nghttpx-options.nix+142
This diff is too big to show here.
nixos/modules/services/networking/nghttpx/server-options.nix+18
This diff is too big to show here.
nixos/modules/services/networking/nghttpx/tls-submodule.nix+21
This diff is too big to show here.
nixos/modules/services/networking/ngircd.nix+62
This diff is too big to show here.
nixos/modules/services/networking/nix-serve.nix+91
This diff is too big to show here.
nixos/modules/services/networking/nix-store-gcs-proxy.nix+75
This diff is too big to show here.
nixos/modules/services/networking/nixops-dns.nix+78
This diff is too big to show here.
nixos/modules/services/networking/nntp-proxy.nix+234
This diff is too big to show here.
nixos/modules/services/networking/nomad.nix+178
This diff is too big to show here.
nixos/modules/services/networking/nsd.nix+992
This diff is too big to show here.
nixos/modules/services/networking/ntopng.nix+160
This diff is too big to show here.
nixos/modules/services/networking/ntp/chrony.nix+178
This diff is too big to show here.
nixos/modules/services/networking/ntp/ntpd.nix+150
This diff is too big to show here.
nixos/modules/services/networking/ntp/openntpd.nix+85
This diff is too big to show here.
nixos/modules/services/networking/nullidentdmod.nix+34
This diff is too big to show here.
nixos/modules/services/networking/nylon.nix+166
This diff is too big to show here.
nixos/modules/services/networking/ocserv.nix+99
This diff is too big to show here.
nixos/modules/services/networking/ofono.nix+44
This diff is too big to show here.
nixos/modules/services/networking/oidentd.nix+44
This diff is too big to show here.
nixos/modules/services/networking/onedrive.nix+71
This diff is too big to show here.
nixos/modules/services/networking/onedrive.xml+34
This diff is too big to show here.
nixos/modules/services/networking/openconnect.nix+137
This diff is too big to show here.
nixos/modules/services/networking/openvpn.nix+219
This diff is too big to show here.
nixos/modules/services/networking/ostinato.nix+104
This diff is too big to show here.
nixos/modules/services/networking/owamp.nix+45
This diff is too big to show here.
nixos/modules/services/networking/pdns-recursor.nix+211
This diff is too big to show here.
nixos/modules/services/networking/pdnsd.nix+91
This diff is too big to show here.
nixos/modules/services/networking/pixiecore.nix+135
This diff is too big to show here.
nixos/modules/services/networking/pleroma.nix+149
This diff is too big to show here.
nixos/modules/services/networking/pleroma.xml+188
This diff is too big to show here.
nixos/modules/services/networking/polipo.nix+112
This diff is too big to show here.
nixos/modules/services/networking/powerdns.nix+47
This diff is too big to show here.
nixos/modules/services/networking/pppd.nix+154
This diff is too big to show here.
nixos/modules/services/networking/pptpd.nix+124
This diff is too big to show here.
nixos/modules/services/networking/prayer.nix+90
This diff is too big to show here.
nixos/modules/services/networking/privoxy.nix+279
This diff is too big to show here.
nixos/modules/services/networking/prosody.nix+883
This diff is too big to show here.
nixos/modules/services/networking/prosody.xml+87
This diff is too big to show here.
nixos/modules/services/networking/quassel.nix+139
This diff is too big to show here.
nixos/modules/services/networking/quicktun.nix+118
This diff is too big to show here.
nixos/modules/services/networking/quorum.nix+231
This diff is too big to show here.
nixos/modules/services/networking/radicale.nix+204
This diff is too big to show here.
nixos/modules/services/networking/radvd.nix+77
This diff is too big to show here.
nixos/modules/services/networking/rdnssd.nix+82
This diff is too big to show here.
nixos/modules/services/networking/redsocks.nix+272
This diff is too big to show here.
nixos/modules/services/networking/resilio.nix+265
This diff is too big to show here.
nixos/modules/services/networking/robustirc-bridge.nix+47
This diff is too big to show here.
nixos/modules/services/networking/rpcbind.nix+46
This diff is too big to show here.
nixos/modules/services/networking/rxe.nix+52
This diff is too big to show here.
nixos/modules/services/networking/sabnzbd.nix+77
This diff is too big to show here.
nixos/modules/services/networking/seafile.nix+287
This diff is too big to show here.
nixos/modules/services/networking/searx.nix+231
This diff is too big to show here.
nixos/modules/services/networking/shadowsocks.nix+158
This diff is too big to show here.
nixos/modules/services/networking/shairport-sync.nix+112
This diff is too big to show here.
nixos/modules/services/networking/shellhub-agent.nix+100
This diff is too big to show here.
nixos/modules/services/networking/shorewall.nix+70
This diff is too big to show here.
nixos/modules/services/networking/shorewall6.nix+70
This diff is too big to show here.
nixos/modules/services/networking/shout.nix+115
This diff is too big to show here.
nixos/modules/services/networking/skydns.nix+93
This diff is too big to show here.
nixos/modules/services/networking/smartdns.nix+62
This diff is too big to show here.
nixos/modules/services/networking/smokeping.nix+362
This diff is too big to show here.
nixos/modules/services/networking/sniproxy.nix+88
This diff is too big to show here.
nixos/modules/services/networking/snowflake-proxy.nix+81
This diff is too big to show here.
nixos/modules/services/networking/softether.nix+163
This diff is too big to show here.
nixos/modules/services/networking/soju.nix+114
This diff is too big to show here.
nixos/modules/services/networking/solanum.nix+109
This diff is too big to show here.
nixos/modules/services/networking/spacecookie.nix+216
This diff is too big to show here.
nixos/modules/services/networking/spiped.nix+220
This diff is too big to show here.
nixos/modules/services/networking/squid.nix+187
This diff is too big to show here.
nixos/modules/services/networking/ssh/lshd.nix+189
This diff is too big to show here.
nixos/modules/services/networking/ssh/sshd.nix+572
This diff is too big to show here.
nixos/modules/services/networking/sslh.nix+168
This diff is too big to show here.
nixos/modules/services/networking/strongswan-swanctl/module.nix+84
This diff is too big to show here.
nixos/modules/services/networking/strongswan-swanctl/param-constructors.nix+162
This diff is too big to show here.
nixos/modules/services/networking/strongswan-swanctl/param-lib.nix+82
This diff is too big to show here.
nixos/modules/services/networking/strongswan-swanctl/swanctl-params.nix+1310
This diff is too big to show here.
nixos/modules/services/networking/strongswan.nix+170
This diff is too big to show here.
nixos/modules/services/networking/stubby.nix+89
This diff is too big to show here.
nixos/modules/services/networking/stunnel.nix+238
This diff is too big to show here.
nixos/modules/services/networking/supplicant.nix+240
This diff is too big to show here.
nixos/modules/services/networking/supybot.nix+163
This diff is too big to show here.
nixos/modules/services/networking/syncplay.nix+96
This diff is too big to show here.
nixos/modules/services/networking/syncthing-relay.nix+121
This diff is too big to show here.
nixos/modules/services/networking/syncthing.nix+601
This diff is too big to show here.
nixos/modules/services/networking/tailscale.nix+52
This diff is too big to show here.
nixos/modules/services/networking/tcpcrypt.nix+80
This diff is too big to show here.
nixos/modules/services/networking/teamspeak3.nix+160
This diff is too big to show here.
nixos/modules/services/networking/tedicross.nix+100
This diff is too big to show here.
nixos/modules/services/networking/teleport.nix+99
This diff is too big to show here.
nixos/modules/services/networking/tetrd.nix+96
This diff is too big to show here.
nixos/modules/services/networking/tftpd.nix+46
This diff is too big to show here.
nixos/modules/services/networking/thelounge.nix+106
This diff is too big to show here.
nixos/modules/services/networking/tinc.nix+439
This diff is too big to show here.
nixos/modules/services/networking/tinydns.nix+59
This diff is too big to show here.
nixos/modules/services/networking/tox-bootstrapd.nix+74
This diff is too big to show here.
nixos/modules/services/networking/tox-node.nix+90
This diff is too big to show here.
nixos/modules/services/networking/toxvpn.nix+70
This diff is too big to show here.
nixos/modules/services/networking/trickster.nix+113
This diff is too big to show here.
nixos/modules/services/networking/tvheadend.nix+63
This diff is too big to show here.
nixos/modules/services/networking/ucarp.nix+183
This diff is too big to show here.
nixos/modules/services/networking/unbound.nix+314
This diff is too big to show here.
nixos/modules/services/networking/unifi.nix+202
This diff is too big to show here.
nixos/modules/services/networking/v2ray.nix+95
This diff is too big to show here.
nixos/modules/services/networking/vsftpd.nix+329
This diff is too big to show here.
nixos/modules/services/networking/wasabibackend.nix+160
This diff is too big to show here.
nixos/modules/services/networking/websockify.nix+54
This diff is too big to show here.
nixos/modules/services/networking/wg-netmanager.nix+42
This diff is too big to show here.
nixos/modules/services/networking/wg-quick.nix+311
This diff is too big to show here.
nixos/modules/services/networking/wireguard.nix+503
This diff is too big to show here.
nixos/modules/services/networking/wpa_supplicant.nix+541
This diff is too big to show here.
nixos/modules/services/networking/x2goserver.nix+164
This diff is too big to show here.
nixos/modules/services/networking/xandikos.nix+148
This diff is too big to show here.
nixos/modules/services/networking/xinetd.nix+147
This diff is too big to show here.
nixos/modules/services/networking/xl2tpd.nix+143
This diff is too big to show here.
nixos/modules/services/networking/xrdp.nix+185
This diff is too big to show here.
nixos/modules/services/networking/yggdrasil.nix+201
This diff is too big to show here.
nixos/modules/services/networking/yggdrasil.xml+156
This diff is too big to show here.
nixos/modules/services/networking/zerobin.nix+102
This diff is too big to show here.
nixos/modules/services/networking/zeronet.nix+94
This diff is too big to show here.
nixos/modules/services/networking/zerotierone.nix+81
This diff is too big to show here.
nixos/modules/services/networking/znc/default.nix+335
This diff is too big to show here.
nixos/modules/services/networking/znc/options.nix+270
This diff is too big to show here.
nixos/modules/services/printing/cupsd.nix+460
This diff is too big to show here.
nixos/modules/services/scheduling/atd.nix+106
This diff is too big to show here.
nixos/modules/services/scheduling/cron.nix+138
This diff is too big to show here.
nixos/modules/services/scheduling/fcron.nix+170
This diff is too big to show here.
nixos/modules/services/search/elasticsearch-curator.nix+95
This diff is too big to show here.
nixos/modules/services/search/elasticsearch.nix+239
This diff is too big to show here.
nixos/modules/services/search/hound.nix+127
This diff is too big to show here.
nixos/modules/services/search/kibana.nix+213
This diff is too big to show here.
nixos/modules/services/search/meilisearch.md+39
This diff is too big to show here.
nixos/modules/services/search/meilisearch.nix+132
This diff is too big to show here.
nixos/modules/services/search/meilisearch.xml+85
This diff is too big to show here.
nixos/modules/services/search/solr.nix+110
This diff is too big to show here.
nixos/modules/services/security/aesmd.nix+236
This diff is too big to show here.
nixos/modules/services/security/certmgr.nix+201
This diff is too big to show here.
nixos/modules/services/security/cfssl.nix+222
This diff is too big to show here.
nixos/modules/services/security/clamav.nix+151
This diff is too big to show here.
nixos/modules/services/security/fail2ban.nix+340
This diff is too big to show here.
nixos/modules/services/security/fprintd.nix+64
This diff is too big to show here.
nixos/modules/services/security/haka.nix+156
This diff is too big to show here.
nixos/modules/services/security/haveged.nix+77
This diff is too big to show here.
nixos/modules/services/security/hockeypuck.nix+106
This diff is too big to show here.
nixos/modules/services/security/hologram-agent.nix+58
This diff is too big to show here.
nixos/modules/services/security/hologram-server.nix+130
This diff is too big to show here.
nixos/modules/services/security/munge.nix+68
This diff is too big to show here.
nixos/modules/services/security/nginx-sso.nix+67
This diff is too big to show here.
nixos/modules/services/security/oauth2_proxy.nix+594
This diff is too big to show here.
nixos/modules/services/security/oauth2_proxy_nginx.nix+66
This diff is too big to show here.
nixos/modules/services/security/opensnitch.nix+125
This diff is too big to show here.
nixos/modules/services/security/physlock.nix+139
This diff is too big to show here.
nixos/modules/services/security/privacyidea.nix+309
This diff is too big to show here.
nixos/modules/services/security/shibboleth-sp.nix+75
This diff is too big to show here.
nixos/modules/services/security/sks.nix+146
This diff is too big to show here.
nixos/modules/services/security/sshguard.nix+161
This diff is too big to show here.
nixos/modules/services/security/sslmate-agent.nix+32
This diff is too big to show here.
nixos/modules/services/security/step-ca.nix+146
This diff is too big to show here.
nixos/modules/services/security/tor.nix+1067
This diff is too big to show here.
nixos/modules/services/security/torify.nix+80
This diff is too big to show here.
nixos/modules/services/security/torsocks.nix+121
This diff is too big to show here.
nixos/modules/services/security/usbguard.nix+214
This diff is too big to show here.
nixos/modules/services/security/vault.nix+204
This diff is too big to show here.
nixos/modules/services/security/vaultwarden/backup.sh+17
This diff is too big to show here.
nixos/modules/services/security/vaultwarden/default.nix+185
This diff is too big to show here.
nixos/modules/services/security/yubikey-agent.nix+66
This diff is too big to show here.
nixos/modules/services/system/cachix-agent/default.nix+57
This diff is too big to show here.
nixos/modules/services/system/cloud-init.nix+194
This diff is too big to show here.
nixos/modules/services/system/dbus.nix+139
This diff is too big to show here.
nixos/modules/services/system/earlyoom.nix+160
This diff is too big to show here.
nixos/modules/services/system/kerberos/default.nix+75
This diff is too big to show here.
nixos/modules/services/system/kerberos/heimdal.nix+68
This diff is too big to show here.
nixos/modules/services/system/kerberos/mit.nix+68
This diff is too big to show here.
nixos/modules/services/system/localtime.nix+49
This diff is too big to show here.
nixos/modules/services/system/nscd.conf+34
This diff is too big to show here.
nixos/modules/services/system/nscd.nix+96
This diff is too big to show here.
nixos/modules/services/system/saslauthd.nix+62
This diff is too big to show here.
nixos/modules/services/system/self-deploy.nix+173
This diff is too big to show here.
nixos/modules/services/system/systembus-notify.nix+27
This diff is too big to show here.
nixos/modules/services/system/uptimed.nix+60
This diff is too big to show here.
nixos/modules/services/torrent/deluge.nix+279
This diff is too big to show here.
nixos/modules/services/torrent/flexget.nix+100
This diff is too big to show here.
nixos/modules/services/torrent/magnetico.nix+220
This diff is too big to show here.
nixos/modules/services/torrent/opentracker.nix+45
This diff is too big to show here.
nixos/modules/services/torrent/peerflix.nix+71
This diff is too big to show here.
nixos/modules/services/torrent/rtorrent.nix+211
This diff is too big to show here.
nixos/modules/services/torrent/transmission.nix+487
This diff is too big to show here.
nixos/modules/services/ttys/getty.nix+162
This diff is too big to show here.
nixos/modules/services/ttys/gpm.nix+57
This diff is too big to show here.
nixos/modules/services/ttys/kmscon.nix+116
This diff is too big to show here.
nixos/modules/services/video/epgstation/default.nix+334
This diff is too big to show here.
nixos/modules/services/video/epgstation/streaming.json+140
This diff is too big to show here.
nixos/modules/services/video/mirakurun.nix+204
This diff is too big to show here.
nixos/modules/services/video/replay-sorcery.nix+72
This diff is too big to show here.
nixos/modules/services/video/rtsp-simple-server.nix+80
This diff is too big to show here.
nixos/modules/services/video/unifi-video.nix+271
This diff is too big to show here.
nixos/modules/services/wayland/cage.nix+103
This diff is too big to show here.
nixos/modules/services/web-apps/atlassian/confluence.nix+197
This diff is too big to show here.
nixos/modules/services/web-apps/atlassian/crowd.nix+164
This diff is too big to show here.
nixos/modules/services/web-apps/atlassian/jira.nix+205
This diff is too big to show here.
nixos/modules/services/web-apps/baget.nix+170
This diff is too big to show here.
nixos/modules/services/web-apps/bookstack.nix+449
This diff is too big to show here.
nixos/modules/services/web-apps/calibre-web.nix+165
This diff is too big to show here.
nixos/modules/services/web-apps/code-server.nix+139
This diff is too big to show here.
nixos/modules/services/web-apps/convos.nix+72
This diff is too big to show here.
nixos/modules/services/web-apps/cryptpad.nix+54
This diff is too big to show here.
nixos/modules/services/web-apps/dex.nix+118
This diff is too big to show here.
nixos/modules/services/web-apps/discourse.nix+1093
This diff is too big to show here.
nixos/modules/services/web-apps/discourse.xml+355
This diff is too big to show here.
nixos/modules/services/web-apps/documize.nix+150
This diff is too big to show here.
nixos/modules/services/web-apps/dokuwiki.nix+439
This diff is too big to show here.
nixos/modules/services/web-apps/engelsystem.nix+186
This diff is too big to show here.
nixos/modules/services/web-apps/ethercalc.nix+62
This diff is too big to show here.
nixos/modules/services/web-apps/fluidd.nix+66
This diff is too big to show here.
nixos/modules/services/web-apps/galene.nix+214
This diff is too big to show here.
nixos/modules/services/web-apps/gerrit.nix+242
This diff is too big to show here.
nixos/modules/services/web-apps/gotify-server.nix+49
This diff is too big to show here.
nixos/modules/services/web-apps/grocy.nix+172
This diff is too big to show here.
nixos/modules/services/web-apps/grocy.xml+77
This diff is too big to show here.
nixos/modules/services/web-apps/hedgedoc.nix+1038
This diff is too big to show here.
nixos/modules/services/web-apps/hledger-web.nix+142
This diff is too big to show here.
nixos/modules/services/web-apps/icingaweb2/icingaweb2.nix+262
This diff is too big to show here.
nixos/modules/services/web-apps/icingaweb2/module-monitoring.nix+157
This diff is too big to show here.
nixos/modules/services/web-apps/ihatemoney/default.nix+153
This diff is too big to show here.
nixos/modules/services/web-apps/invidious.nix+264
This diff is too big to show here.
nixos/modules/services/web-apps/invoiceplane.nix+305
This diff is too big to show here.
nixos/modules/services/web-apps/isso.nix+69
This diff is too big to show here.
nixos/modules/services/web-apps/jirafeau.nix+173
This diff is too big to show here.
nixos/modules/services/web-apps/jitsi-meet.nix+452
This diff is too big to show here.
nixos/modules/services/web-apps/jitsi-meet.xml+55
This diff is too big to show here.
nixos/modules/services/web-apps/keycloak.nix+683
This diff is too big to show here.
nixos/modules/services/web-apps/keycloak.xml+202
This diff is too big to show here.
nixos/modules/services/web-apps/lemmy.md+34
This diff is too big to show here.
nixos/modules/services/web-apps/lemmy.nix+236
This diff is too big to show here.
nixos/modules/services/web-apps/lemmy.xml+56
This diff is too big to show here.
nixos/modules/services/web-apps/limesurvey.nix+280
This diff is too big to show here.
nixos/modules/services/web-apps/mastodon.nix+638
This diff is too big to show here.
nixos/modules/services/web-apps/matomo-doc.xml+107
This diff is too big to show here.
nixos/modules/services/web-apps/matomo.nix+335
This diff is too big to show here.
nixos/modules/services/web-apps/mattermost.nix+344
This diff is too big to show here.
nixos/modules/services/web-apps/mediawiki.nix+475
This diff is too big to show here.
nixos/modules/services/web-apps/miniflux.nix+127
This diff is too big to show here.
nixos/modules/services/web-apps/moodle.nix+315
This diff is too big to show here.
nixos/modules/services/web-apps/netbox.nix+265
This diff is too big to show here.
nixos/modules/services/web-apps/nextcloud.nix+1008
This diff is too big to show here.
nixos/modules/services/web-apps/nextcloud.xml+291
This diff is too big to show here.
nixos/modules/services/web-apps/nexus.nix+156
This diff is too big to show here.
nixos/modules/services/web-apps/nifi.nix+318
This diff is too big to show here.
nixos/modules/services/web-apps/node-red.nix+149
This diff is too big to show here.
nixos/modules/services/web-apps/openwebrx.nix+34
This diff is too big to show here.
nixos/modules/services/web-apps/peertube.nix+475
This diff is too big to show here.
nixos/modules/services/web-apps/pgpkeyserver-lite.nix+78
This diff is too big to show here.
nixos/modules/services/web-apps/pict-rs.md+88
This diff is too big to show here.
nixos/modules/services/web-apps/pict-rs.nix+50
This diff is too big to show here.
nixos/modules/services/web-apps/pict-rs.xml+162
This diff is too big to show here.
nixos/modules/services/web-apps/plantuml-server.nix+140
This diff is too big to show here.
nixos/modules/services/web-apps/plausible.nix+292
This diff is too big to show here.
nixos/modules/services/web-apps/plausible.xml+51
This diff is too big to show here.
nixos/modules/services/web-apps/powerdns-admin.nix+152
This diff is too big to show here.
nixos/modules/services/web-apps/prosody-filer.nix+86
This diff is too big to show here.
nixos/modules/services/web-apps/restya-board.nix+380
This diff is too big to show here.
nixos/modules/services/web-apps/rss-bridge.nix+125
This diff is too big to show here.
nixos/modules/services/web-apps/selfoss.nix+164
This diff is too big to show here.
nixos/modules/services/web-apps/shiori.nix+96
This diff is too big to show here.
nixos/modules/services/web-apps/sogo.nix+271
This diff is too big to show here.
nixos/modules/services/web-apps/timetagger.nix+80
This diff is too big to show here.
nixos/modules/services/web-apps/trilium.nix+146
This diff is too big to show here.
nixos/modules/services/web-apps/tt-rss.nix+686
This diff is too big to show here.
nixos/modules/services/web-apps/vikunja.nix+145
This diff is too big to show here.
nixos/modules/services/web-apps/virtlyst.nix+73
This diff is too big to show here.
nixos/modules/services/web-apps/whitebophir.nix+52
This diff is too big to show here.
nixos/modules/services/web-apps/wiki-js.nix+139
This diff is too big to show here.
nixos/modules/services/web-apps/wordpress.nix+480
This diff is too big to show here.
nixos/modules/services/web-apps/youtrack.nix+181
This diff is too big to show here.
nixos/modules/services/web-apps/zabbix.nix+238
This diff is too big to show here.
nixos/modules/services/web-servers/agate.nix+148
This diff is too big to show here.
nixos/modules/services/web-servers/apache-httpd/default.nix+834
This diff is too big to show here.
nixos/modules/services/web-servers/apache-httpd/location-options.nix+54
This diff is too big to show here.
nixos/modules/services/web-servers/apache-httpd/vhost-options.nix+295
This diff is too big to show here.
nixos/modules/services/web-servers/caddy/default.nix+339
This diff is too big to show here.
nixos/modules/services/web-servers/caddy/vhost-options.nix+79
This diff is too big to show here.
nixos/modules/services/web-servers/darkhttpd.nix+77
This diff is too big to show here.
nixos/modules/services/web-servers/fcgiwrap.nix+72
This diff is too big to show here.
nixos/modules/services/web-servers/hitch/default.nix+111
This diff is too big to show here.
nixos/modules/services/web-servers/hydron.nix+165
This diff is too big to show here.
nixos/modules/services/web-servers/jboss/builder.sh+72
This diff is too big to show here.
nixos/modules/services/web-servers/jboss/default.nix+88
This diff is too big to show here.
nixos/modules/services/web-servers/lighttpd/cgit.nix+93
This diff is too big to show here.
nixos/modules/services/web-servers/lighttpd/collectd.nix+62
This diff is too big to show here.
nixos/modules/services/web-servers/lighttpd/default.nix+268
This diff is too big to show here.
nixos/modules/services/web-servers/lighttpd/gitweb.nix+52
This diff is too big to show here.
nixos/modules/services/web-servers/mighttpd2.nix+132
This diff is too big to show here.
nixos/modules/services/web-servers/minio.nix+130
This diff is too big to show here.
nixos/modules/services/web-servers/molly-brown.nix+101
This diff is too big to show here.
nixos/modules/services/web-servers/nginx/default.nix+1009
This diff is too big to show here.
nixos/modules/services/web-servers/nginx/gitweb.nix+94
This diff is too big to show here.
nixos/modules/services/web-servers/nginx/location-options.nix+132
This diff is too big to show here.
nixos/modules/services/web-servers/nginx/vhost-options.nix+297
This diff is too big to show here.
nixos/modules/services/web-servers/phpfpm/default.nix+282
This diff is too big to show here.
nixos/modules/services/web-servers/pomerium.nix+135
This diff is too big to show here.
nixos/modules/services/web-servers/tomcat.nix+423
This diff is too big to show here.
nixos/modules/services/web-servers/traefik.nix+170
This diff is too big to show here.
nixos/modules/services/web-servers/trafficserver/default.nix+310
This diff is too big to show here.
nixos/modules/services/web-servers/trafficserver/ip_allow.json+36
This diff is too big to show here.
nixos/modules/services/web-servers/trafficserver/logging.json+37
This diff is too big to show here.
nixos/modules/services/web-servers/ttyd.nix+196
This diff is too big to show here.
nixos/modules/services/web-servers/unit/default.nix+155
This diff is too big to show here.
nixos/modules/services/web-servers/uwsgi.nix+229
This diff is too big to show here.
nixos/modules/services/web-servers/varnish/default.nix+115
This diff is too big to show here.
nixos/modules/services/web-servers/zope2.nix+262
This diff is too big to show here.
nixos/modules/services/x11/clight.nix+131
This diff is too big to show here.
nixos/modules/services/x11/colord.nix+41
This diff is too big to show here.
nixos/modules/services/x11/desktop-managers/cde.nix+73
This diff is too big to show here.
nixos/modules/services/x11/desktop-managers/cinnamon.nix+218
This diff is too big to show here.
nixos/modules/services/x11/desktop-managers/default.nix+99
This diff is too big to show here.
nixos/modules/services/x11/desktop-managers/enlightenment.nix+124
This diff is too big to show here.
nixos/modules/services/x11/desktop-managers/gnome.nix+582
This diff is too big to show here.
nixos/modules/services/x11/desktop-managers/gnome.xml+253
This diff is too big to show here.
nixos/modules/services/x11/desktop-managers/kodi.nix+41
This diff is too big to show here.
nixos/modules/services/x11/desktop-managers/lumina.nix+46
This diff is too big to show here.
nixos/modules/services/x11/desktop-managers/lxqt.nix+76
This diff is too big to show here.
nixos/modules/services/x11/desktop-managers/mate.nix+83
This diff is too big to show here.
nixos/modules/services/x11/desktop-managers/none.nix+46
This diff is too big to show here.
nixos/modules/services/x11/desktop-managers/pantheon.nix+314
This diff is too big to show here.
nixos/modules/services/x11/desktop-managers/pantheon.xml+120
This diff is too big to show here.
nixos/modules/services/x11/desktop-managers/plasma5.nix+579
This diff is too big to show here.
nixos/modules/services/x11/desktop-managers/retroarch.nix+40
This diff is too big to show here.
nixos/modules/services/x11/desktop-managers/surf-display.nix+128
This diff is too big to show here.
nixos/modules/services/x11/desktop-managers/xfce.nix+179
This diff is too big to show here.
nixos/modules/services/x11/desktop-managers/xterm.nix+38
This diff is too big to show here.
nixos/modules/services/x11/display-managers/account-service-util.nix+44
This diff is too big to show here.
nixos/modules/services/x11/display-managers/default.nix+503
This diff is too big to show here.
nixos/modules/services/x11/display-managers/gdm.nix+331
This diff is too big to show here.
nixos/modules/services/x11/display-managers/lightdm-greeters/enso-os.nix+140
This diff is too big to show here.
nixos/modules/services/x11/display-managers/lightdm-greeters/gtk.nix+174
This diff is too big to show here.
nixos/modules/services/x11/display-managers/lightdm-greeters/mini.nix+100
This diff is too big to show here.
nixos/modules/services/x11/display-managers/lightdm-greeters/pantheon.nix+49
This diff is too big to show here.
nixos/modules/services/x11/display-managers/lightdm-greeters/tiny.nix+92
This diff is too big to show here.
nixos/modules/services/x11/display-managers/lightdm.nix+328
This diff is too big to show here.
nixos/modules/services/x11/display-managers/sddm.nix+288
This diff is too big to show here.
nixos/modules/services/x11/display-managers/set-session.py+89
This diff is too big to show here.
nixos/modules/services/x11/display-managers/slim.nix+16
This diff is too big to show here.
nixos/modules/services/x11/display-managers/startx.nix+54
This diff is too big to show here.
nixos/modules/services/x11/display-managers/sx.nix+34
This diff is too big to show here.
nixos/modules/services/x11/display-managers/xpra.nix+252
This diff is too big to show here.
nixos/modules/services/x11/extra-layouts.nix+135
This diff is too big to show here.
nixos/modules/services/x11/fractalart.nix+36
This diff is too big to show here.
nixos/modules/services/x11/gdk-pixbuf.nix+45
This diff is too big to show here.
nixos/modules/services/x11/hardware/cmt.nix+59
This diff is too big to show here.
nixos/modules/services/x11/hardware/digimend.nix+38
This diff is too big to show here.
nixos/modules/services/x11/hardware/libinput.nix+291
This diff is too big to show here.
nixos/modules/services/x11/hardware/synaptics.nix+218
This diff is too big to show here.
nixos/modules/services/x11/hardware/wacom.nix+48
This diff is too big to show here.
nixos/modules/services/x11/imwheel.nix+71
This diff is too big to show here.
nixos/modules/services/x11/picom.nix+335
This diff is too big to show here.
nixos/modules/services/x11/redshift.nix+138
This diff is too big to show here.
nixos/modules/services/x11/terminal-server.nix+56
This diff is too big to show here.
nixos/modules/services/x11/touchegg.nix+38
This diff is too big to show here.
nixos/modules/services/x11/unclutter-xfixes.nix+58
This diff is too big to show here.
nixos/modules/services/x11/unclutter.nix+82
This diff is too big to show here.
nixos/modules/services/x11/urserver.nix+38
This diff is too big to show here.
nixos/modules/services/x11/urxvtd.nix+50
This diff is too big to show here.
nixos/modules/services/x11/window-managers/2bwm.nix+37
This diff is too big to show here.
nixos/modules/services/x11/window-managers/afterstep.nix+25
This diff is too big to show here.
nixos/modules/services/x11/window-managers/awesome.nix+66
This diff is too big to show here.
nixos/modules/services/x11/window-managers/berry.nix+25
This diff is too big to show here.
nixos/modules/services/x11/window-managers/bspwm.nix+77
This diff is too big to show here.
nixos/modules/services/x11/window-managers/clfswm.nix+34
This diff is too big to show here.
nixos/modules/services/x11/window-managers/cwm.nix+23
This diff is too big to show here.
nixos/modules/services/x11/window-managers/default.nix+88
This diff is too big to show here.
nixos/modules/services/x11/window-managers/dwm.nix+37
This diff is too big to show here.
nixos/modules/services/x11/window-managers/e16.nix+26
This diff is too big to show here.
nixos/modules/services/x11/window-managers/evilwm.nix+25
This diff is too big to show here.
nixos/modules/services/x11/window-managers/exwm.nix+69
This diff is too big to show here.
nixos/modules/services/x11/window-managers/fluxbox.nix+25
This diff is too big to show here.
nixos/modules/services/x11/window-managers/fvwm.nix+41
This diff is too big to show here.
nixos/modules/services/x11/window-managers/herbstluftwm.nix+47
This diff is too big to show here.
nixos/modules/services/x11/window-managers/i3.nix+78
This diff is too big to show here.
nixos/modules/services/x11/window-managers/icewm.nix+27
This diff is too big to show here.
nixos/modules/services/x11/window-managers/jwm.nix+25
This diff is too big to show here.
nixos/modules/services/x11/window-managers/leftwm.nix+25
This diff is too big to show here.
nixos/modules/services/x11/window-managers/lwm.nix+25
This diff is too big to show here.
nixos/modules/services/x11/window-managers/metacity.nix+30
This diff is too big to show here.
nixos/modules/services/x11/window-managers/mlvwm.nix+41
This diff is too big to show here.
nixos/modules/services/x11/window-managers/mwm.nix+25
This diff is too big to show here.
nixos/modules/services/x11/window-managers/none.nix+12
This diff is too big to show here.
nixos/modules/services/x11/window-managers/notion.nix+26
This diff is too big to show here.
nixos/modules/services/x11/window-managers/openbox.nix+24
This diff is too big to show here.
nixos/modules/services/x11/window-managers/oroborus.nix+25
This diff is too big to show here.
nixos/modules/services/x11/window-managers/pekwm.nix+25
This diff is too big to show here.
nixos/modules/services/x11/window-managers/qtile.nix+32
This diff is too big to show here.
nixos/modules/services/x11/window-managers/ratpoison.nix+25
This diff is too big to show here.
nixos/modules/services/x11/window-managers/sawfish.nix+25
This diff is too big to show here.
nixos/modules/services/x11/window-managers/smallwm.nix+25
This diff is too big to show here.
nixos/modules/services/x11/window-managers/spectrwm.nix+27
This diff is too big to show here.
nixos/modules/services/x11/window-managers/stumpwm.nix+24
This diff is too big to show here.
nixos/modules/services/x11/window-managers/tinywm.nix+25
This diff is too big to show here.
nixos/modules/services/x11/window-managers/twm.nix+37
This diff is too big to show here.
nixos/modules/services/x11/window-managers/windowlab.nix+22
This diff is too big to show here.
nixos/modules/services/x11/window-managers/windowmaker.nix+25
This diff is too big to show here.
nixos/modules/services/x11/window-managers/wmderland.nix+61
This diff is too big to show here.
nixos/modules/services/x11/window-managers/wmii.nix+39
This diff is too big to show here.
nixos/modules/services/x11/window-managers/xmonad.nix+203
This diff is too big to show here.
nixos/modules/services/x11/window-managers/yeahwm.nix+25
This diff is too big to show here.
nixos/modules/services/x11/xautolock.nix+141
This diff is too big to show here.
nixos/modules/services/x11/xbanish.nix+31
This diff is too big to show here.
nixos/modules/services/x11/xfs.conf+15
This diff is too big to show here.
nixos/modules/services/x11/xfs.nix+46
This diff is too big to show here.
nixos/modules/services/x11/xserver.nix+874
This diff is too big to show here.
nixos/modules/system/activation/activation-script.nix+272
This diff is too big to show here.
nixos/modules/system/activation/no-clone.nix+8
This diff is too big to show here.
nixos/modules/system/activation/switch-to-configuration.pl+932
This diff is too big to show here.
nixos/modules/system/activation/top-level.nix+362
This diff is too big to show here.
nixos/modules/system/boot/binfmt.nix+325
This diff is too big to show here.
nixos/modules/system/boot/emergency-mode.nix+37
This diff is too big to show here.
nixos/modules/system/boot/grow-partition.nix+53
This diff is too big to show here.
nixos/modules/system/boot/initrd-network.nix+148
This diff is too big to show here.
nixos/modules/system/boot/initrd-openvpn.nix+81
This diff is too big to show here.
nixos/modules/system/boot/initrd-ssh.nix+215
This diff is too big to show here.
nixos/modules/system/boot/kernel.nix+350
This diff is too big to show here.
nixos/modules/system/boot/kernel_config.nix+117
This diff is too big to show here.
nixos/modules/system/boot/kexec.nix+32
This diff is too big to show here.
nixos/modules/system/boot/loader/efi.nix+20
This diff is too big to show here.
nixos/modules/system/boot/loader/generations-dir/generations-dir-builder.sh+106
This diff is too big to show here.
nixos/modules/system/boot/loader/generations-dir/generations-dir.nix+62
This diff is too big to show here.
nixos/modules/system/boot/loader/generic-extlinux-compatible/default.nix+82
This diff is too big to show here.
nixos/modules/system/boot/loader/generic-extlinux-compatible/extlinux-conf-builder.nix+8
This diff is too big to show here.
nixos/modules/system/boot/loader/generic-extlinux-compatible/extlinux-conf-builder.sh+157
This diff is too big to show here.
nixos/modules/system/boot/loader/grub/grub.nix+874
This diff is too big to show here.
nixos/modules/system/boot/loader/grub/install-grub.pl+782
This diff is too big to show here.
nixos/modules/system/boot/loader/grub/ipxe.nix+64
This diff is too big to show here.
nixos/modules/system/boot/loader/grub/memtest.nix+116
This diff is too big to show here.
nixos/modules/system/boot/loader/init-script/init-script-builder.sh+92
This diff is too big to show here.
nixos/modules/system/boot/loader/init-script/init-script.nix+51
This diff is too big to show here.
nixos/modules/system/boot/loader/loader.nix+20
This diff is too big to show here.
nixos/modules/system/boot/loader/raspberrypi/raspberrypi-builder.nix+9
This diff is too big to show here.
nixos/modules/system/boot/loader/raspberrypi/raspberrypi-builder.sh+143
This diff is too big to show here.
nixos/modules/system/boot/loader/raspberrypi/raspberrypi.nix+105
This diff is too big to show here.
nixos/modules/system/boot/loader/raspberrypi/uboot-builder.nix+37
This diff is too big to show here.
nixos/modules/system/boot/loader/raspberrypi/uboot-builder.sh+38
This diff is too big to show here.
nixos/modules/system/boot/loader/systemd-boot/systemd-boot-builder.py+316
This diff is too big to show here.
nixos/modules/system/boot/loader/systemd-boot/systemd-boot.nix+303
This diff is too big to show here.
nixos/modules/system/boot/luksroot.nix+1008
This diff is too big to show here.
nixos/modules/system/boot/modprobe.nix+70
This diff is too big to show here.
nixos/modules/system/boot/networkd.nix+1986
This diff is too big to show here.
nixos/modules/system/boot/pbkdf2-sha512.c+38
This diff is too big to show here.
nixos/modules/system/boot/plymouth.nix+237
This diff is too big to show here.
nixos/modules/system/boot/resolved.nix+183
This diff is too big to show here.
nixos/modules/system/boot/shutdown.nix+27
This diff is too big to show here.
nixos/modules/system/boot/stage-1-init.sh+639
This diff is too big to show here.
nixos/modules/system/boot/stage-1.nix+736
This diff is too big to show here.
nixos/modules/system/boot/stage-2-init.sh+144
This diff is too big to show here.
nixos/modules/system/boot/stage-2.nix+71
This diff is too big to show here.
nixos/modules/system/boot/systemd.nix+624
This diff is too big to show here.
nixos/modules/system/boot/systemd/coredump.nix+57
This diff is too big to show here.
nixos/modules/system/boot/systemd/initrd-secrets.nix+36
This diff is too big to show here.
nixos/modules/system/boot/systemd/initrd.nix+502
This diff is too big to show here.
nixos/modules/system/boot/systemd/journald.nix+131
This diff is too big to show here.
nixos/modules/system/boot/systemd/logind.nix+114
This diff is too big to show here.
nixos/modules/system/boot/systemd/nspawn.nix+131
This diff is too big to show here.
nixos/modules/system/boot/systemd/shutdown.nix+58
This diff is too big to show here.
nixos/modules/system/boot/systemd/tmpfiles.nix+120
This diff is too big to show here.
nixos/modules/system/boot/systemd/user.nix+153
This diff is too big to show here.
nixos/modules/system/boot/timesyncd.nix+86
This diff is too big to show here.
nixos/modules/system/boot/tmp.nix+64
This diff is too big to show here.
nixos/modules/system/build.nix+21
This diff is too big to show here.
nixos/modules/system/etc/etc-activation.nix+12
This diff is too big to show here.
nixos/modules/system/etc/etc.nix+201
This diff is too big to show here.
nixos/modules/system/etc/setup-etc.pl+146
This diff is too big to show here.
nixos/modules/system/etc/test.nix+70
This diff is too big to show here.
nixos/modules/tasks/auto-upgrade.nix+253
This diff is too big to show here.
nixos/modules/tasks/bcache.nix+23
This diff is too big to show here.
nixos/modules/tasks/cpu-freq.nix+90
This diff is too big to show here.
nixos/modules/tasks/encrypted-devices.nix+87
This diff is too big to show here.
nixos/modules/tasks/filesystems.nix+414
This diff is too big to show here.
nixos/modules/tasks/filesystems/apfs.nix+22
This diff is too big to show here.
nixos/modules/tasks/filesystems/bcachefs.nix+65
This diff is too big to show here.
nixos/modules/tasks/filesystems/btrfs.nix+149
This diff is too big to show here.
nixos/modules/tasks/filesystems/cifs.nix+25
This diff is too big to show here.
nixos/modules/tasks/filesystems/ecryptfs.nix+24
This diff is too big to show here.
nixos/modules/tasks/filesystems/exfat.nix+13
This diff is too big to show here.
nixos/modules/tasks/filesystems/ext.nix+28
This diff is too big to show here.
nixos/modules/tasks/filesystems/f2fs.nix+25
This diff is too big to show here.
nixos/modules/tasks/filesystems/glusterfs.nix+11
This diff is too big to show here.
nixos/modules/tasks/filesystems/jfs.nix+19
This diff is too big to show here.
nixos/modules/tasks/filesystems/nfs.nix+135
This diff is too big to show here.
nixos/modules/tasks/filesystems/ntfs.nix+11
This diff is too big to show here.
nixos/modules/tasks/filesystems/reiserfs.nix+25
This diff is too big to show here.
nixos/modules/tasks/filesystems/unionfs-fuse.nix+43
This diff is too big to show here.
nixos/modules/tasks/filesystems/vboxsf.nix+23
This diff is too big to show here.
nixos/modules/tasks/filesystems/vfat.nix+25
This diff is too big to show here.
nixos/modules/tasks/filesystems/xfs.nix+30
This diff is too big to show here.
nixos/modules/tasks/filesystems/zfs.nix+771
This diff is too big to show here.
nixos/modules/tasks/lvm.nix+133
This diff is too big to show here.
nixos/modules/tasks/network-interfaces-scripted.nix+627
This diff is too big to show here.
nixos/modules/tasks/network-interfaces-systemd.nix+408
This diff is too big to show here.
nixos/modules/tasks/network-interfaces.nix+1549
This diff is too big to show here.
nixos/modules/tasks/powertop.nix+29
This diff is too big to show here.
nixos/modules/tasks/scsi-link-power-management.nix+54
This diff is too big to show here.
nixos/modules/tasks/snapraid.nix+230
This diff is too big to show here.
nixos/modules/tasks/swraid.nix+43
This diff is too big to show here.
nixos/modules/tasks/trackpoint.nix+108
This diff is too big to show here.
nixos/modules/tasks/tty-backgrounds-combine.sh+32
This diff is too big to show here.
nixos/modules/testing/minimal-kernel.nix+28
This diff is too big to show here.
nixos/modules/testing/service-runner.nix+127
This diff is too big to show here.
nixos/modules/testing/test-instrumentation.nix+134
This diff is too big to show here.
nixos/modules/virtualisation/amazon-ec2-amis.nix+444
This diff is too big to show here.
nixos/modules/virtualisation/amazon-image.nix+180
This diff is too big to show here.
nixos/modules/virtualisation/amazon-init.nix+87
This diff is too big to show here.
nixos/modules/virtualisation/amazon-options.nix+74
This diff is too big to show here.
nixos/modules/virtualisation/anbox.nix+138
This diff is too big to show here.
nixos/modules/virtualisation/azure-agent-entropy.patch+17
This diff is too big to show here.
nixos/modules/virtualisation/azure-agent.nix+194
This diff is too big to show here.
nixos/modules/virtualisation/azure-bootstrap-blobs.nix+3
This diff is too big to show here.
nixos/modules/virtualisation/azure-common.nix+70
This diff is too big to show here.
nixos/modules/virtualisation/azure-config-user.nix+12
This diff is too big to show here.
nixos/modules/virtualisation/azure-config.nix+5
This diff is too big to show here.
nixos/modules/virtualisation/azure-image.nix+71
This diff is too big to show here.
nixos/modules/virtualisation/azure-images.nix+5
This diff is too big to show here.
nixos/modules/virtualisation/brightbox-config.nix+5
This diff is too big to show here.
nixos/modules/virtualisation/brightbox-image.nix+166
This diff is too big to show here.
nixos/modules/virtualisation/build-vm.nix+58
This diff is too big to show here.
nixos/modules/virtualisation/cloudstack-config.nix+40
This diff is too big to show here.
nixos/modules/virtualisation/container-config.nix+31
This diff is too big to show here.
nixos/modules/virtualisation/containerd.nix+101
This diff is too big to show here.
nixos/modules/virtualisation/containers.nix+156
This diff is too big to show here.
nixos/modules/virtualisation/cri-o.nix+163
This diff is too big to show here.
nixos/modules/virtualisation/digital-ocean-config.nix+197
This diff is too big to show here.
nixos/modules/virtualisation/digital-ocean-image.nix+70
This diff is too big to show here.
nixos/modules/virtualisation/digital-ocean-init.nix+95
This diff is too big to show here.
nixos/modules/virtualisation/docker-image.nix+57
This diff is too big to show here.
nixos/modules/virtualisation/docker-rootless.nix+102
This diff is too big to show here.
nixos/modules/virtualisation/docker.nix+252
This diff is too big to show here.
nixos/modules/virtualisation/ec2-amis.nix+9
This diff is too big to show here.
nixos/modules/virtualisation/ec2-data.nix+91
This diff is too big to show here.
nixos/modules/virtualisation/ec2-metadata-fetcher.nix+77
This diff is too big to show here.
nixos/modules/virtualisation/ecs-agent.nix+45
This diff is too big to show here.
nixos/modules/virtualisation/gce-images.nix+17
This diff is too big to show here.
nixos/modules/virtualisation/google-compute-config.nix+102
This diff is too big to show here.
nixos/modules/virtualisation/google-compute-image.nix+71
This diff is too big to show here.
nixos/modules/virtualisation/grow-partition.nix+3
This diff is too big to show here.
nixos/modules/virtualisation/hyperv-guest.nix+66
This diff is too big to show here.
nixos/modules/virtualisation/hyperv-image.nix+71
This diff is too big to show here.
nixos/modules/virtualisation/kubevirt.nix+30
This diff is too big to show here.
nixos/modules/virtualisation/kvmgt.nix+86
This diff is too big to show here.
nixos/modules/virtualisation/libvirtd.nix+396
This diff is too big to show here.
nixos/modules/virtualisation/lxc-container.nix+174
This diff is too big to show here.
nixos/modules/virtualisation/lxc.nix+86
This diff is too big to show here.
nixos/modules/virtualisation/lxcfs.nix+45
This diff is too big to show here.
nixos/modules/virtualisation/lxd.nix+182
This diff is too big to show here.
nixos/modules/virtualisation/nixos-containers.nix+881
This diff is too big to show here.
nixos/modules/virtualisation/oci-containers.nix+365
This diff is too big to show here.
nixos/modules/virtualisation/openstack-config.nix+90
This diff is too big to show here.
nixos/modules/virtualisation/openstack-metadata-fetcher.nix+22
This diff is too big to show here.
nixos/modules/virtualisation/openstack-options.nix+71
This diff is too big to show here.
nixos/modules/virtualisation/openvswitch.nix+145
This diff is too big to show here.
nixos/modules/virtualisation/parallels-guest.nix+155
This diff is too big to show here.
nixos/modules/virtualisation/podman/default.nix+187
This diff is too big to show here.
nixos/modules/virtualisation/podman/dnsname.nix+36
This diff is too big to show here.
nixos/modules/virtualisation/podman/network-socket-ghostunnel.nix+34
This diff is too big to show here.
nixos/modules/virtualisation/podman/network-socket.nix+95
This diff is too big to show here.
nixos/modules/virtualisation/proxmox-image.nix+169
This diff is too big to show here.
nixos/modules/virtualisation/proxmox-lxc.nix+64
This diff is too big to show here.
nixos/modules/virtualisation/qemu-guest-agent.nix+45
This diff is too big to show here.
nixos/modules/virtualisation/qemu-vm.nix+1052
This diff is too big to show here.
nixos/modules/virtualisation/railcar.nix+124
This diff is too big to show here.
nixos/modules/virtualisation/spice-usb-redirection.nix+26
This diff is too big to show here.
nixos/modules/virtualisation/vagrant-guest.nix+58
This diff is too big to show here.
nixos/modules/virtualisation/vagrant-virtualbox-image.nix+60
This diff is too big to show here.
nixos/modules/virtualisation/virtualbox-guest.nix+93
This diff is too big to show here.
nixos/modules/virtualisation/virtualbox-host.nix+168
This diff is too big to show here.
nixos/modules/virtualisation/virtualbox-image.nix+215
This diff is too big to show here.
nixos/modules/virtualisation/vmware-guest.nix+86
This diff is too big to show here.
nixos/modules/virtualisation/vmware-host.nix+166
This diff is too big to show here.
nixos/modules/virtualisation/vmware-image.nix+91
This diff is too big to show here.
nixos/modules/virtualisation/waydroid.nix+75
This diff is too big to show here.
nixos/modules/virtualisation/xe-guest-utilities.nix+52
This diff is too big to show here.
nixos/modules/virtualisation/xen-dom0.nix+453
This diff is too big to show here.
nixos/modules/virtualisation/xen-domU.nix+19
This diff is too big to show here.
nixos/release-combined.nix+162
This diff is too big to show here.
nixos/release-small.nix+127
This diff is too big to show here.
nixos/release.nix+386
This diff is too big to show here.
nixos/tests/3proxy.nix+189
This diff is too big to show here.
nixos/tests/acme.nix+597
This diff is too big to show here.
nixos/tests/adguardhome.nix+57
This diff is too big to show here.
nixos/tests/aesmd.nix+62
This diff is too big to show here.
nixos/tests/agda.nix+50
This diff is too big to show here.
nixos/tests/airsonic.nix+28
This diff is too big to show here.
nixos/tests/all-terminfo.nix+31
This diff is too big to show here.
nixos/tests/all-tests.nix+616
This diff is too big to show here.
nixos/tests/amazon-init-shell.nix+40
This diff is too big to show here.
nixos/tests/apfs.nix+54
This diff is too big to show here.
nixos/tests/apparmor.nix+82
This diff is too big to show here.
nixos/tests/atd.nix+31
This diff is too big to show here.
nixos/tests/atop.nix+226
This diff is too big to show here.
nixos/tests/avahi.nix+79
This diff is too big to show here.
nixos/tests/babeld.nix+142
This diff is too big to show here.
nixos/tests/bazarr.nix+26
This diff is too big to show here.
nixos/tests/bcachefs.nix+33
This diff is too big to show here.
nixos/tests/beanstalkd.nix+49
This diff is too big to show here.
nixos/tests/bees.nix+62
This diff is too big to show here.
nixos/tests/bind.nix+28
This diff is too big to show here.
nixos/tests/bird.nix+129
This diff is too big to show here.
nixos/tests/bitcoind.nix+46
This diff is too big to show here.
nixos/tests/bittorrent.nix+164
This diff is too big to show here.
nixos/tests/blockbook-frontend.nix+28
This diff is too big to show here.
nixos/tests/blocky.nix+34
This diff is too big to show here.
nixos/tests/boot-stage1.nix+164
This diff is too big to show here.
nixos/tests/boot.nix+148
This diff is too big to show here.
nixos/tests/borgbackup.nix+208
This diff is too big to show here.
nixos/tests/botamusique.nix+51
This diff is too big to show here.
nixos/tests/bpf.nix+29
This diff is too big to show here.
nixos/tests/breitbandmessung.nix+33
This diff is too big to show here.
nixos/tests/brscan5.nix+43
This diff is too big to show here.
nixos/tests/btrbk.nix+110
This diff is too big to show here.
nixos/tests/buildbot.nix+113
This diff is too big to show here.
nixos/tests/buildkite-agents.nix+31
This diff is too big to show here.
nixos/tests/caddy.nix+107
This diff is too big to show here.
nixos/tests/cadvisor.nix+34
This diff is too big to show here.
nixos/tests/cage.nix+36
This diff is too big to show here.
nixos/tests/cagebreak.nix+64
This diff is too big to show here.
nixos/tests/calibre-web.nix+43
This diff is too big to show here.
nixos/tests/cassandra.nix+132
This diff is too big to show here.
nixos/tests/ceph-multi-node.nix+233
This diff is too big to show here.
nixos/tests/ceph-single-node-bluestore.nix+196
This diff is too big to show here.
nixos/tests/ceph-single-node.nix+196
This diff is too big to show here.
nixos/tests/certmgr.nix+155
This diff is too big to show here.
nixos/tests/cfssl.nix+67
This diff is too big to show here.
nixos/tests/charliecloud.nix+43
This diff is too big to show here.
nixos/tests/chromium.nix+260
This diff is too big to show here.
nixos/tests/cjdns.nix+121
This diff is too big to show here.
nixos/tests/clickhouse.nix+32
This diff is too big to show here.
nixos/tests/cloud-init.nix+109
This diff is too big to show here.
nixos/tests/cntr.nix+75
This diff is too big to show here.
nixos/tests/cockroachdb.nix+124
This diff is too big to show here.
nixos/tests/collectd.nix+38
This diff is too big to show here.
nixos/tests/common/acme/client/default.nix+16
This diff is too big to show here.
nixos/tests/common/acme/server/README.md+21
This diff is too big to show here.
nixos/tests/common/acme/server/acme.test.cert.pem+19
This diff is too big to show here.
nixos/tests/common/acme/server/acme.test.key.pem+27
This diff is too big to show here.
nixos/tests/common/acme/server/ca.cert.pem+20
This diff is too big to show here.
nixos/tests/common/acme/server/ca.key.pem+27
This diff is too big to show here.
nixos/tests/common/acme/server/default.nix+141
This diff is too big to show here.
nixos/tests/common/acme/server/generate-certs.nix+29
This diff is too big to show here.
nixos/tests/common/acme/server/snakeoil-certs.nix+13
This diff is too big to show here.
nixos/tests/common/auto.nix+68
This diff is too big to show here.
nixos/tests/common/ec2.nix+66
This diff is too big to show here.
nixos/tests/common/lxd/config.yaml+24
This diff is too big to show here.
nixos/tests/common/resolver.nix+141
This diff is too big to show here.
nixos/tests/common/user-account.nix+15
This diff is too big to show here.
nixos/tests/common/wayland-cage.nix+13
This diff is too big to show here.
nixos/tests/common/webroot/news-rss.xml+27
This diff is too big to show here.
nixos/tests/common/x11.nix+17
This diff is too big to show here.
nixos/tests/consul.nix+229
This diff is too big to show here.
nixos/tests/containers-bridge.nix+99
This diff is too big to show here.
nixos/tests/containers-custom-pkgs.nix+34
This diff is too big to show here.
nixos/tests/containers-ephemeral.nix+54
This diff is too big to show here.
nixos/tests/containers-extra_veth.nix+91
This diff is too big to show here.
nixos/tests/containers-hosts.nix+49
This diff is too big to show here.
nixos/tests/containers-imperative.nix+166
This diff is too big to show here.
nixos/tests/containers-ip.nix+74
This diff is too big to show here.
nixos/tests/containers-macvlans.nix+82
This diff is too big to show here.
nixos/tests/containers-names.nix+37
This diff is too big to show here.
nixos/tests/containers-nested.nix+30
This diff is too big to show here.
nixos/tests/containers-physical_interfaces.nix+131
This diff is too big to show here.
nixos/tests/containers-portforward.nix+59
This diff is too big to show here.
nixos/tests/containers-reloadable.nix+71
This diff is too big to show here.
nixos/tests/containers-restart_networking.nix+113
This diff is too big to show here.
nixos/tests/containers-tmpfs.nix+90
This diff is too big to show here.
nixos/tests/convos.nix+30
This diff is too big to show here.
nixos/tests/corerad.nix+89
This diff is too big to show here.
nixos/tests/coturn.nix+29
This diff is too big to show here.
nixos/tests/couchdb.nix+63
This diff is too big to show here.
nixos/tests/cri-o.nix+19
This diff is too big to show here.
nixos/tests/croc.nix+51
This diff is too big to show here.
nixos/tests/cryptpad.nix+18
This diff is too big to show here.
nixos/tests/custom-ca.nix+193
This diff is too big to show here.
nixos/tests/deluge.nix+61
This diff is too big to show here.
nixos/tests/dendrite.nix+99
This diff is too big to show here.
nixos/tests/dex-oidc.nix+78
This diff is too big to show here.
nixos/tests/dhparams.nix+142
This diff is too big to show here.
nixos/tests/disable-installer-tools.nix+29
This diff is too big to show here.
nixos/tests/discourse.nix+201
This diff is too big to show here.
nixos/tests/dnscrypt-proxy2.nix+36
This diff is too big to show here.
nixos/tests/dnscrypt-wrapper/default.nix+72
This diff is too big to show here.
nixos/tests/dnscrypt-wrapper/public.key+1
This diff is too big to show here.
nixos/tests/dnscrypt-wrapper/secret.key+1
This diff is too big to show here.
nixos/tests/dnsdist.nix+48
This diff is too big to show here.
nixos/tests/doas.nix+98
This diff is too big to show here.
nixos/tests/docker-edge.nix+49
This diff is too big to show here.
nixos/tests/docker-registry.nix+61
This diff is too big to show here.
nixos/tests/docker-rootless.nix+41
This diff is too big to show here.
nixos/tests/docker-tools-cross.nix+76
This diff is too big to show here.
nixos/tests/docker-tools-overlay.nix+33
This diff is too big to show here.
nixos/tests/docker-tools.nix+423
This diff is too big to show here.
nixos/tests/docker.nix+52
This diff is too big to show here.
nixos/tests/documize.nix+62
This diff is too big to show here.
nixos/tests/doh-proxy-rust.nix+43
This diff is too big to show here.
nixos/tests/dokuwiki.nix+111
This diff is too big to show here.
nixos/tests/domination.nix+26
This diff is too big to show here.
nixos/tests/dovecot.nix+82
This diff is too big to show here.
nixos/tests/drbd.nix+87
This diff is too big to show here.
nixos/tests/earlyoom.nix+16
This diff is too big to show here.
nixos/tests/ec2.nix+158
This diff is too big to show here.
nixos/tests/ecryptfs.nix+85
This diff is too big to show here.
nixos/tests/elk.nix+305
This diff is too big to show here.
nixos/tests/emacs-daemon.nix+48
This diff is too big to show here.
nixos/tests/empty-file
This diff is too big to show here.
nixos/tests/engelsystem.nix+41
This diff is too big to show here.
nixos/tests/enlightenment.nix+96
This diff is too big to show here.
nixos/tests/env.nix+36
This diff is too big to show here.
nixos/tests/envoy.nix+33
This diff is too big to show here.
nixos/tests/ergo.nix+18
This diff is too big to show here.
nixos/tests/ergochat.nix+97
This diff is too big to show here.
nixos/tests/etcd-cluster.nix+154
This diff is too big to show here.
nixos/tests/etcd.nix+25
This diff is too big to show here.
nixos/tests/etebase-server.nix+50
This diff is too big to show here.
nixos/tests/etesync-dav.nix+21
This diff is too big to show here.
nixos/tests/fancontrol.nix+34
This diff is too big to show here.
nixos/tests/fcitx/config+12
This diff is too big to show here.
nixos/tests/fcitx/default.nix+141
This diff is too big to show here.
nixos/tests/fcitx/profile+4
This diff is too big to show here.
nixos/tests/fenics.nix+49
This diff is too big to show here.
nixos/tests/ferm.nix+75
This diff is too big to show here.
nixos/tests/firefox.nix+116
This diff is too big to show here.
nixos/tests/firejail.nix+91
This diff is too big to show here.
nixos/tests/firewall.nix+65
This diff is too big to show here.
nixos/tests/fish.nix+24
This diff is too big to show here.
nixos/tests/flannel.nix+57
This diff is too big to show here.
nixos/tests/fluentd.nix+49
This diff is too big to show here.
nixos/tests/fluidd.nix+21
This diff is too big to show here.
nixos/tests/fontconfig-default-fonts.nix+32
This diff is too big to show here.
nixos/tests/freeswitch.nix+29
This diff is too big to show here.
nixos/tests/frr.nix+104
This diff is too big to show here.
nixos/tests/fsck.nix+31
This diff is too big to show here.
nixos/tests/ft2-clone.nix+35
This diff is too big to show here.
nixos/tests/gerrit.nix+54
This diff is too big to show here.
nixos/tests/geth.nix+41
This diff is too big to show here.
nixos/tests/ghostunnel.nix+103
This diff is too big to show here.
nixos/tests/git/hub.nix+17
This diff is too big to show here.
nixos/tests/gitdaemon.nix+71
This diff is too big to show here.
nixos/tests/gitea.nix+110
This diff is too big to show here.
nixos/tests/gitlab.nix+438
This diff is too big to show here.
nixos/tests/gitolite-fcgiwrap.nix+93
This diff is too big to show here.
nixos/tests/gitolite.nix+138
This diff is too big to show here.
nixos/tests/glusterfs.nix+68
This diff is too big to show here.
nixos/tests/gnome-xorg.nix+96
This diff is too big to show here.
nixos/tests/gnome.nix+97
This diff is too big to show here.
nixos/tests/go-neb.nix+44
This diff is too big to show here.
nixos/tests/gobgpd.nix+71
This diff is too big to show here.
nixos/tests/gocd-agent.nix+48
This diff is too big to show here.
nixos/tests/gocd-server.nix+28
This diff is too big to show here.
nixos/tests/google-oslogin/default.nix+74
This diff is too big to show here.
nixos/tests/google-oslogin/server.nix+27
This diff is too big to show here.
nixos/tests/google-oslogin/server.py+135
This diff is too big to show here.
nixos/tests/gotify-server.nix+50
This diff is too big to show here.
nixos/tests/grafana.nix+109
This diff is too big to show here.
nixos/tests/graphite.nix+48
This diff is too big to show here.
nixos/tests/graylog.nix+115
This diff is too big to show here.
nixos/tests/grocy.nix+47
This diff is too big to show here.
nixos/tests/grub.nix+60
This diff is too big to show here.
nixos/tests/gvisor.nix+49
This diff is too big to show here.
nixos/tests/hadoop/default.nix+7
This diff is too big to show here.
nixos/tests/hadoop/hadoop.nix+255
This diff is too big to show here.
nixos/tests/hadoop/hdfs.nix+84
This diff is too big to show here.
nixos/tests/hadoop/yarn.nix+45
This diff is too big to show here.
nixos/tests/haka.nix+24
This diff is too big to show here.
nixos/tests/haproxy.nix+54
This diff is too big to show here.
nixos/tests/hardened.nix+101
This diff is too big to show here.
nixos/tests/haste-server.nix+23
This diff is too big to show here.
nixos/tests/hbase.nix+30
This diff is too big to show here.
nixos/tests/hedgedoc.nix+60
This diff is too big to show here.
nixos/tests/herbstluftwm.nix+37
This diff is too big to show here.
nixos/tests/hibernate.nix+133
This diff is too big to show here.
nixos/tests/hitch/default.nix+33
This diff is too big to show here.
nixos/tests/hitch/example.pem+53
This diff is too big to show here.
nixos/tests/hitch/example/index.txt+1
This diff is too big to show here.
nixos/tests/hledger-web.nix+50
This diff is too big to show here.
nixos/tests/hocker-fetchdocker/default.nix+16
This diff is too big to show here.
nixos/tests/hocker-fetchdocker/hello-world-container.nix+19
This diff is too big to show here.
nixos/tests/hocker-fetchdocker/machine.nix+26
This diff is too big to show here.
nixos/tests/hockeypuck.nix+63
This diff is too big to show here.
nixos/tests/home-assistant.nix+156
This diff is too big to show here.
nixos/tests/hostname.nix+72
This diff is too big to show here.
nixos/tests/hound.nix+59
This diff is too big to show here.
nixos/tests/hydra/common.nix+48
This diff is too big to show here.
nixos/tests/hydra/create-trivial-project.sh+59
This diff is too big to show here.
nixos/tests/hydra/default.nix+59
This diff is too big to show here.
nixos/tests/i3wm.nix+46
This diff is too big to show here.
nixos/tests/icingaweb2.nix+71
This diff is too big to show here.
nixos/tests/iftop.nix+33
This diff is too big to show here.
nixos/tests/ihatemoney/default.nix+78
This diff is too big to show here.
nixos/tests/ihatemoney/rates.json+39
This diff is too big to show here.
nixos/tests/ihatemoney/server.crt+28
This diff is too big to show here.
nixos/tests/ihatemoney/server.key+52
This diff is too big to show here.
nixos/tests/image-contents.nix+51
This diff is too big to show here.
nixos/tests/incron.nix+52
This diff is too big to show here.
nixos/tests/influxdb.nix+40
This diff is too big to show here.
nixos/tests/initrd-network-openvpn/default.nix+145
This diff is too big to show here.
nixos/tests/initrd-network-openvpn/initrd.ovpn+29
This diff is too big to show here.
nixos/tests/initrd-network-openvpn/shared.key+21
This diff is too big to show here.
nixos/tests/initrd-network-ssh/default.nix+79
This diff is too big to show here.
nixos/tests/initrd-network-ssh/generate-keys.nix+10
This diff is too big to show here.
nixos/tests/initrd-network-ssh/id_ed25519+7
This diff is too big to show here.
nixos/tests/initrd-network-ssh/id_ed25519.pub+1
This diff is too big to show here.
nixos/tests/initrd-network-ssh/ssh_host_ed25519_key+7
This diff is too big to show here.
nixos/tests/initrd-network-ssh/ssh_host_ed25519_key.pub+1
This diff is too big to show here.
nixos/tests/initrd-network.nix+33
This diff is too big to show here.
nixos/tests/initrd-secrets.nix+41
This diff is too big to show here.
nixos/tests/input-remapper.nix+52
This diff is too big to show here.
nixos/tests/inspircd.nix+93
This diff is too big to show here.
nixos/tests/installed-tests/appstream-qt.nix+9
This diff is too big to show here.
nixos/tests/installed-tests/appstream.nix+9
This diff is too big to show here.
nixos/tests/installed-tests/colord.nix+5
This diff is too big to show here.
nixos/tests/installed-tests/default.nix+111
This diff is too big to show here.
nixos/tests/installed-tests/flatpak-builder.nix+14
This diff is too big to show here.
nixos/tests/installed-tests/flatpak.nix+17
This diff is too big to show here.
nixos/tests/installed-tests/fwupd.nix+11
This diff is too big to show here.
nixos/tests/installed-tests/gcab.nix+5
This diff is too big to show here.
nixos/tests/installed-tests/gdk-pixbuf.nix+13
This diff is too big to show here.
nixos/tests/installed-tests/gjs.nix+12
This diff is too big to show here.
nixos/tests/installed-tests/glib-networking.nix+5
This diff is too big to show here.
nixos/tests/installed-tests/glib-testing.nix+5
This diff is too big to show here.
nixos/tests/installed-tests/gnome-photos.nix+35
This diff is too big to show here.
nixos/tests/installed-tests/graphene.nix+5
This diff is too big to show here.
nixos/tests/installed-tests/gsconnect.nix+7
This diff is too big to show here.
nixos/tests/installed-tests/ibus.nix+16
This diff is too big to show here.
nixos/tests/installed-tests/libgdata.nix+11
This diff is too big to show here.
nixos/tests/installed-tests/libjcat.nix+5
This diff is too big to show here.
nixos/tests/installed-tests/librsvg.nix+9
This diff is too big to show here.
nixos/tests/installed-tests/libxmlb.nix+5
This diff is too big to show here.
nixos/tests/installed-tests/malcontent.nix+5
This diff is too big to show here.
nixos/tests/installed-tests/ostree.nix+12
This diff is too big to show here.
nixos/tests/installed-tests/pipewire.nix+15
This diff is too big to show here.
nixos/tests/installed-tests/power-profiles-daemon.nix+9
This diff is too big to show here.
nixos/tests/installed-tests/xdg-desktop-portal.nix+9
This diff is too big to show here.
nixos/tests/installer-systemd-stage-1.nix+33
This diff is too big to show here.
nixos/tests/installer.nix+825
This diff is too big to show here.
nixos/tests/invidious.nix+81
This diff is too big to show here.
nixos/tests/invoiceplane.nix+82
This diff is too big to show here.
nixos/tests/iodine.nix+64
This diff is too big to show here.
nixos/tests/ipfs.nix+44
This diff is too big to show here.
nixos/tests/ipv6.nix+130
This diff is too big to show here.
nixos/tests/iscsi-multipath-root.nix+267
This diff is too big to show here.
nixos/tests/iscsi-root.nix+161
This diff is too big to show here.
nixos/tests/isso.nix+30
This diff is too big to show here.
nixos/tests/jackett.nix+19
This diff is too big to show here.
nixos/tests/jellyfin.nix+155
This diff is too big to show here.
nixos/tests/jenkins-cli.nix+30
This diff is too big to show here.
nixos/tests/jenkins.nix+132
This diff is too big to show here.
nixos/tests/jibri.nix+69
This diff is too big to show here.
nixos/tests/jirafeau.nix+22
This diff is too big to show here.
nixos/tests/jitsi-meet.nix+49
This diff is too big to show here.
nixos/tests/k3s-single-node-docker.nix+84
This diff is too big to show here.
nixos/tests/k3s-single-node.nix+82
This diff is too big to show here.
nixos/tests/kafka.nix+79
This diff is too big to show here.
nixos/tests/kbd-setfont-decompress.nix+21
This diff is too big to show here.
nixos/tests/kbd-update-search-paths-patch.nix+19
This diff is too big to show here.
nixos/tests/kea.nix+73
This diff is too big to show here.
nixos/tests/keepalived.nix+42
This diff is too big to show here.
nixos/tests/keepassxc.nix+68
This diff is too big to show here.
nixos/tests/kerberos/default.nix+7
This diff is too big to show here.
nixos/tests/kerberos/heimdal.nix+42
This diff is too big to show here.
nixos/tests/kerberos/mit.nix+41
This diff is too big to show here.
nixos/tests/kernel-generic.nix+41
This diff is too big to show here.
nixos/tests/kernel-latest-ath-user-regd.nix+17
This diff is too big to show here.
nixos/tests/kexec.nix+50
This diff is too big to show here.
nixos/tests/keycloak.nix+180
This diff is too big to show here.
nixos/tests/keymap.nix+196
This diff is too big to show here.
nixos/tests/knot.nix+216
This diff is too big to show here.
nixos/tests/krb5/default.nix+5
This diff is too big to show here.
nixos/tests/krb5/deprecated-config.nix+50
This diff is too big to show here.
nixos/tests/krb5/example-config.nix+112
This diff is too big to show here.
nixos/tests/ksm.nix+22
This diff is too big to show here.
nixos/tests/kubernetes/base.nix+107
This diff is too big to show here.
nixos/tests/kubernetes/default.nix+15
This diff is too big to show here.
nixos/tests/kubernetes/dns.nix+151
This diff is too big to show here.
nixos/tests/kubernetes/e2e.nix+40
This diff is too big to show here.
nixos/tests/kubernetes/rbac.nix+164
This diff is too big to show here.
nixos/tests/leaps.nix+32
This diff is too big to show here.
nixos/tests/libinput.nix+38
This diff is too big to show here.
nixos/tests/libreddit.nix+19
This diff is too big to show here.
nixos/tests/libresprite.nix+30
This diff is too big to show here.
nixos/tests/libreswan.nix+134
This diff is too big to show here.
nixos/tests/lidarr.nix+20
This diff is too big to show here.
nixos/tests/lightdm.nix+28
This diff is too big to show here.
nixos/tests/limesurvey.nix+26
This diff is too big to show here.
nixos/tests/litestream.nix+93
This diff is too big to show here.
nixos/tests/locate.nix+62
This diff is too big to show here.
nixos/tests/login.nix+59
This diff is too big to show here.
nixos/tests/logrotate.nix+152
This diff is too big to show here.
nixos/tests/loki.nix+56
This diff is too big to show here.
nixos/tests/lorri/builder.sh+3
This diff is too big to show here.
nixos/tests/lorri/default.nix+26
This diff is too big to show here.
nixos/tests/lorri/fake-shell.nix+5
This diff is too big to show here.
nixos/tests/lvm2/default.nix+45
This diff is too big to show here.
nixos/tests/lvm2/systemd-stage-1.nix+104
This diff is too big to show here.
nixos/tests/lvm2/thinpool.nix+32
This diff is too big to show here.
nixos/tests/lvm2/vdo.nix+27
This diff is too big to show here.
nixos/tests/lxd-image-server.nix+94
This diff is too big to show here.
nixos/tests/lxd-nftables.nix+51
This diff is too big to show here.
nixos/tests/lxd.nix+114
This diff is too big to show here.
nixos/tests/maddy.nix+58
This diff is too big to show here.
nixos/tests/maestral.nix+72
This diff is too big to show here.
nixos/tests/magic-wormhole-mailbox-server.nix+38
This diff is too big to show here.
nixos/tests/magnetico.nix+41
This diff is too big to show here.
nixos/tests/mailcatcher.nix+35
This diff is too big to show here.
nixos/tests/mailhog.nix+24
This diff is too big to show here.
nixos/tests/make-test-python.nix+9
This diff is too big to show here.
nixos/tests/man.nix+100
This diff is too big to show here.
nixos/tests/matomo.nix+48
This diff is too big to show here.
nixos/tests/matrix-appservice-irc.nix+224
This diff is too big to show here.
nixos/tests/matrix-conduit.nix+95
This diff is too big to show here.
nixos/tests/matrix-synapse.nix+221
This diff is too big to show here.
nixos/tests/matrix/mjolnir.nix+170
This diff is too big to show here.
nixos/tests/matrix/pantalaimon.nix+88
This diff is too big to show here.
nixos/tests/mattermost.nix+124
This diff is too big to show here.
nixos/tests/mediatomb.nix+81
This diff is too big to show here.
nixos/tests/mediawiki.nix+28
This diff is too big to show here.
nixos/tests/meilisearch.nix+60
This diff is too big to show here.
nixos/tests/memcached.nix+24
This diff is too big to show here.
nixos/tests/metabase.nix+19
This diff is too big to show here.
nixos/tests/minecraft-server.nix+37
This diff is too big to show here.
nixos/tests/minecraft.nix+28
This diff is too big to show here.
nixos/tests/minidlna.nix+41
This diff is too big to show here.
nixos/tests/miniflux.nix+82
This diff is too big to show here.
nixos/tests/minio.nix+58
This diff is too big to show here.
nixos/tests/misc.nix+163
This diff is too big to show here.
nixos/tests/mod_perl.nix+53
This diff is too big to show here.
nixos/tests/molly-brown.nix+71
This diff is too big to show here.
nixos/tests/mongodb.nix+58
This diff is too big to show here.
nixos/tests/moodle.nix+22
This diff is too big to show here.
nixos/tests/moonraker.nix+45
This diff is too big to show here.
nixos/tests/moosefs.nix+89
This diff is too big to show here.
nixos/tests/morty.nix+30
This diff is too big to show here.
nixos/tests/mosquitto.nix+208
This diff is too big to show here.
nixos/tests/mpd.nix+134
This diff is too big to show here.
nixos/tests/mpich-example.c+21
This diff is too big to show here.
nixos/tests/mpv.nix+28
This diff is too big to show here.
nixos/tests/mtp.nix+109
This diff is too big to show here.
nixos/tests/mumble.nix+85
This diff is too big to show here.
nixos/tests/munin.nix+44
This diff is too big to show here.
nixos/tests/musescore.nix+86
This diff is too big to show here.
nixos/tests/mutable-users.nix+73
This diff is too big to show here.
nixos/tests/mxisd.nix+21
This diff is too big to show here.
nixos/tests/mysql/common.nix+10
This diff is too big to show here.
nixos/tests/mysql/mariadb-galera.nix+250
This diff is too big to show here.
nixos/tests/mysql/mysql-autobackup.nix+53
This diff is too big to show here.
nixos/tests/mysql/mysql-backup.nix+72
This diff is too big to show here.
nixos/tests/mysql/mysql-replication.nix+101
This diff is too big to show here.
nixos/tests/mysql/mysql.nix+149
This diff is too big to show here.
nixos/tests/mysql/testdb.sql+11
This diff is too big to show here.
nixos/tests/n8n.nix+25
This diff is too big to show here.
nixos/tests/nagios.nix+116
This diff is too big to show here.
nixos/tests/nar-serve.nix+48
This diff is too big to show here.
nixos/tests/nat.nix+120
This diff is too big to show here.
nixos/tests/nats.nix+63
This diff is too big to show here.
nixos/tests/navidrome.nix+12
This diff is too big to show here.
nixos/tests/nbd.nix+103
This diff is too big to show here.
nixos/tests/ncdns.nix+93
This diff is too big to show here.
nixos/tests/ndppd.nix+60
This diff is too big to show here.
nixos/tests/nebula.nix+223
This diff is too big to show here.
nixos/tests/neo4j.nix+20
This diff is too big to show here.
nixos/tests/netdata.nix+38
This diff is too big to show here.
nixos/tests/networking-proxy.nix+134
This diff is too big to show here.
nixos/tests/networking.nix+937
This diff is too big to show here.
nixos/tests/nextcloud/basic.nix+112
This diff is too big to show here.
nixos/tests/nextcloud/default.nix+21
This diff is too big to show here.
nixos/tests/nextcloud/with-mysql-and-memcached.nix+89
This diff is too big to show here.
nixos/tests/nextcloud/with-postgresql-and-redis.nix+102
This diff is too big to show here.
nixos/tests/nexus.nix+32
This diff is too big to show here.
nixos/tests/nfs/default.nix+9
This diff is too big to show here.
nixos/tests/nfs/kerberos.nix+133
This diff is too big to show here.
nixos/tests/nfs/simple.nix+94
This diff is too big to show here.
nixos/tests/nghttpx.nix+61
This diff is too big to show here.
nixos/tests/nginx-auth.nix+47
This diff is too big to show here.
nixos/tests/nginx-etag.nix+88
This diff is too big to show here.
nixos/tests/nginx-modsecurity.nix+39
This diff is too big to show here.
nixos/tests/nginx-pubhtml.nix+21
This diff is too big to show here.
nixos/tests/nginx-sandbox.nix+65
This diff is too big to show here.
nixos/tests/nginx-sso.nix+48
This diff is too big to show here.
nixos/tests/nginx-variants.nix+33
This diff is too big to show here.
nixos/tests/nginx.nix+129
This diff is too big to show here.
nixos/tests/nitter.nix+18
This diff is too big to show here.
nixos/tests/nix-ld.nix+20
This diff is too big to show here.
nixos/tests/nix-serve-ssh.nix+45
This diff is too big to show here.
nixos/tests/nix-serve.nix+22
This diff is too big to show here.
nixos/tests/nixops/default.nix+114
This diff is too big to show here.
nixos/tests/nixops/legacy/base-configuration.nix+31
This diff is too big to show here.
nixos/tests/nixops/legacy/nixops.nix+15
This diff is too big to show here.
nixos/tests/nixos-generate-config.nix+41
This diff is too big to show here.
nixos/tests/node-red.nix+31
This diff is too big to show here.
nixos/tests/nomad.nix+97
This diff is too big to show here.
nixos/tests/noto-fonts.nix+44
This diff is too big to show here.
nixos/tests/novacomd.nix+28
This diff is too big to show here.
nixos/tests/nsd.nix+109
This diff is too big to show here.
nixos/tests/nzbget.nix+46
This diff is too big to show here.
nixos/tests/nzbhydra2.nix+17
This diff is too big to show here.
nixos/tests/oci-containers.nix+43
This diff is too big to show here.
nixos/tests/odoo.nix+27
This diff is too big to show here.
nixos/tests/oh-my-zsh.nix+18
This diff is too big to show here.
nixos/tests/ombi.nix+18
This diff is too big to show here.
nixos/tests/openarena.nix+71
This diff is too big to show here.
nixos/tests/openldap.nix+130
This diff is too big to show here.
nixos/tests/openresty-lua.nix+55
This diff is too big to show here.
nixos/tests/opensmtpd-rspamd.nix+141
This diff is too big to show here.
nixos/tests/opensmtpd.nix+125
This diff is too big to show here.
nixos/tests/openssh.nix+118
This diff is too big to show here.
nixos/tests/openstack-image.nix+98
This diff is too big to show here.
nixos/tests/opentabletdriver.nix+30
This diff is too big to show here.
nixos/tests/orangefs.nix+82
This diff is too big to show here.
nixos/tests/os-prober.nix+121
This diff is too big to show here.
nixos/tests/osrm-backend.nix+57
This diff is too big to show here.
nixos/tests/overlayfs.nix+47
This diff is too big to show here.
nixos/tests/owncast.nix+42
This diff is too big to show here.
nixos/tests/pacemaker.nix+110
This diff is too big to show here.
nixos/tests/packagekit.nix+25
This diff is too big to show here.
nixos/tests/pam/pam-file-contents.nix+25
This diff is too big to show here.
nixos/tests/pam/pam-oath-login.nix+108
This diff is too big to show here.
nixos/tests/pam/pam-u2f.nix+25
This diff is too big to show here.
nixos/tests/pam/pam-ussh.nix+70
This diff is too big to show here.
nixos/tests/pam/test_chfn.py+27
This diff is too big to show here.
nixos/tests/pantheon.nix+58
This diff is too big to show here.
nixos/tests/paperless.nix+44
This diff is too big to show here.
nixos/tests/parsedmarc/default.nix+235
This diff is too big to show here.
nixos/tests/pdns-recursor.nix+15
This diff is too big to show here.
nixos/tests/peerflix.nix+23
This diff is too big to show here.
nixos/tests/pgadmin4-standalone.nix+43
This diff is too big to show here.
nixos/tests/pgadmin4.nix+132
This diff is too big to show here.
nixos/tests/pgjwt.nix+34
This diff is too big to show here.
nixos/tests/pgmanage.nix+41
This diff is too big to show here.
nixos/tests/php/default.nix+16
This diff is too big to show here.
nixos/tests/php/fpm.nix+59
This diff is too big to show here.
nixos/tests/php/httpd.nix+34
This diff is too big to show here.
nixos/tests/php/pcre.nix+42
This diff is too big to show here.
nixos/tests/pict-rs.nix+17
This diff is too big to show here.
nixos/tests/pinnwand.nix+94
This diff is too big to show here.
nixos/tests/plasma5-systemd-start.nix+42
This diff is too big to show here.
nixos/tests/plasma5.nix+61
This diff is too big to show here.
nixos/tests/plausible.nix+49
This diff is too big to show here.
nixos/tests/pleroma.nix+249
This diff is too big to show here.
nixos/tests/plikd.nix+27
This diff is too big to show here.
nixos/tests/plotinus.nix+28
This diff is too big to show here.
nixos/tests/podgrab.nix+34
This diff is too big to show here.
nixos/tests/podman/default.nix+144
This diff is too big to show here.
nixos/tests/podman/dnsname.nix+42
This diff is too big to show here.
nixos/tests/podman/tls-ghostunnel.nix+150
This diff is too big to show here.
nixos/tests/pomerium.nix+102
This diff is too big to show here.
nixos/tests/postfix-raise-smtpd-tls-security-level.nix+41
This diff is too big to show here.
nixos/tests/postfix.nix+77
This diff is too big to show here.
nixos/tests/postfixadmin.nix+31
This diff is too big to show here.
nixos/tests/postgis.nix+29
This diff is too big to show here.
nixos/tests/postgresql-wal-receiver.nix+119
This diff is too big to show here.
nixos/tests/postgresql.nix+137
This diff is too big to show here.
nixos/tests/power-profiles-daemon.nix+45
This diff is too big to show here.
nixos/tests/powerdns-admin.nix+117
This diff is too big to show here.
nixos/tests/powerdns.nix+66
This diff is too big to show here.
nixos/tests/pppd.nix+62
This diff is too big to show here.
nixos/tests/predictable-interface-names.nix+37
This diff is too big to show here.
nixos/tests/printing.nix+128
This diff is too big to show here.
nixos/tests/privacyidea.nix+43
This diff is too big to show here.
nixos/tests/privoxy.nix+113
This diff is too big to show here.
nixos/tests/prometheus-exporters.nix+1342
This diff is too big to show here.
nixos/tests/prometheus.nix+339
This diff is too big to show here.
nixos/tests/prowlarr.nix+18
This diff is too big to show here.
nixos/tests/proxy.nix+90
This diff is too big to show here.
nixos/tests/pt2-clone.nix+35
This diff is too big to show here.
nixos/tests/pulseaudio.nix+71
This diff is too big to show here.
nixos/tests/qboot.nix+13
This diff is too big to show here.
nixos/tests/quorum.nix+102
This diff is too big to show here.
nixos/tests/rabbitmq.nix+27
This diff is too big to show here.
nixos/tests/radarr.nix+18
This diff is too big to show here.
nixos/tests/radicale.nix+95
This diff is too big to show here.
nixos/tests/rasdaemon.nix+34
This diff is too big to show here.
nixos/tests/redis.nix+46
This diff is too big to show here.
nixos/tests/redmine.nix+44
This diff is too big to show here.
nixos/tests/resolv.nix+46
This diff is too big to show here.
nixos/tests/restart-by-activation-script.nix+73
This diff is too big to show here.
nixos/tests/restic.nix+96
This diff is too big to show here.
nixos/tests/retroarch.nix+49
This diff is too big to show here.
nixos/tests/riak.nix+18
This diff is too big to show here.
nixos/tests/robustirc-bridge.nix+29
This diff is too big to show here.
nixos/tests/roundcube.nix+31
This diff is too big to show here.
nixos/tests/rspamd.nix+313
This diff is too big to show here.
nixos/tests/rss2email.nix+66
This diff is too big to show here.
nixos/tests/rstudio-server.nix+24
This diff is too big to show here.
nixos/tests/rsyncd.nix+36
This diff is too big to show here.
nixos/tests/rsyslogd.nix+40
This diff is too big to show here.
nixos/tests/rxe.nix+47
This diff is too big to show here.
nixos/tests/sabnzbd.nix+22
This diff is too big to show here.
nixos/tests/samba-wsdd.nix+44
This diff is too big to show here.
nixos/tests/samba.nix+46
This diff is too big to show here.
nixos/tests/sanoid.nix+112
This diff is too big to show here.
nixos/tests/sddm.nix+69
This diff is too big to show here.
nixos/tests/seafile.nix+121
This diff is too big to show here.
nixos/tests/searx.nix+114
This diff is too big to show here.
nixos/tests/service-runner.nix+36
This diff is too big to show here.
nixos/tests/sfxr-qt.nix+32
This diff is too big to show here.
nixos/tests/shadow.nix+119
This diff is too big to show here.
nixos/tests/shadowsocks/common.nix+84
This diff is too big to show here.
nixos/tests/shadowsocks/default.nix+16
This diff is too big to show here.
nixos/tests/shattered-pixel-dungeon.nix+30
This diff is too big to show here.
nixos/tests/shiori.nix+80
This diff is too big to show here.
nixos/tests/signal-desktop.nix+69
This diff is too big to show here.
nixos/tests/simple.nix+17
This diff is too big to show here.
nixos/tests/slurm.nix+168
This diff is too big to show here.
nixos/tests/smokeping.nix+34
This diff is too big to show here.
nixos/tests/snapcast.nix+90
This diff is too big to show here.
nixos/tests/snapper.nix+35
This diff is too big to show here.
nixos/tests/soapui.nix+24
This diff is too big to show here.
nixos/tests/sogo.nix+58
This diff is too big to show here.
nixos/tests/solanum.nix+97
This diff is too big to show here.
nixos/tests/solr.nix+56
This diff is too big to show here.
nixos/tests/sonarr.nix+18
This diff is too big to show here.
nixos/tests/sourcehut.nix+212
This diff is too big to show here.
nixos/tests/spacecookie.nix+56
This diff is too big to show here.
nixos/tests/spark/default.nix+27
This diff is too big to show here.
nixos/tests/spark/spark_sample.py+40
This diff is too big to show here.
nixos/tests/specialisation.nix+43
This diff is too big to show here.
nixos/tests/ssh-keys.nix+15
This diff is too big to show here.
nixos/tests/sslh.nix+83
This diff is too big to show here.
nixos/tests/sssd-ldap.nix+94
This diff is too big to show here.
nixos/tests/sssd.nix+17
This diff is too big to show here.
nixos/tests/starship.nix+42
This diff is too big to show here.
nixos/tests/step-ca.nix+77
This diff is too big to show here.
nixos/tests/strongswan-swanctl.nix+148
This diff is too big to show here.
nixos/tests/sudo.nix+106
This diff is too big to show here.
nixos/tests/sway.nix+138
This diff is too big to show here.
nixos/tests/switch-test.nix+1048
This diff is too big to show here.
nixos/tests/sympa.nix+35
This diff is too big to show here.
nixos/tests/syncthing-init.nix+31
This diff is too big to show here.
nixos/tests/syncthing-relay.nix+26
This diff is too big to show here.
nixos/tests/syncthing.nix+65
This diff is too big to show here.
nixos/tests/systemd-analyze.nix+46
This diff is too big to show here.
nixos/tests/systemd-binfmt.nix+90
This diff is too big to show here.
nixos/tests/systemd-boot.nix+254
This diff is too big to show here.
nixos/tests/systemd-confinement.nix+184
This diff is too big to show here.
nixos/tests/systemd-cryptenroll.nix+54
This diff is too big to show here.
nixos/tests/systemd-escaping.nix+45
This diff is too big to show here.
nixos/tests/systemd-initrd-btrfs-raid.nix+45
This diff is too big to show here.
nixos/tests/systemd-initrd-luks-keyfile.nix+53
This diff is too big to show here.
nixos/tests/systemd-initrd-luks-password.nix+48
This diff is too big to show here.
nixos/tests/systemd-initrd-simple.nix+44
This diff is too big to show here.
nixos/tests/systemd-initrd-swraid.nix+50
This diff is too big to show here.
nixos/tests/systemd-journal.nix+22
This diff is too big to show here.
nixos/tests/systemd-machinectl.nix+85
This diff is too big to show here.
nixos/tests/systemd-misc.nix+62
This diff is too big to show here.
nixos/tests/systemd-networkd-dhcpserver-static-leases.nix+81
This diff is too big to show here.
nixos/tests/systemd-networkd-dhcpserver.nix+58
This diff is too big to show here.
nixos/tests/systemd-networkd-ipv6-prefix-delegation.nix+284
This diff is too big to show here.
nixos/tests/systemd-networkd-vrf.nix+223
This diff is too big to show here.
nixos/tests/systemd-networkd.nix+123
This diff is too big to show here.
nixos/tests/systemd-nspawn.nix+60
This diff is too big to show here.
nixos/tests/systemd-shutdown.nix+26
This diff is too big to show here.
nixos/tests/systemd-timesyncd.nix+52
This diff is too big to show here.
nixos/tests/systemd.nix+200
This diff is too big to show here.
nixos/tests/taskserver.nix+283
This diff is too big to show here.
nixos/tests/teeworlds.nix+55
This diff is too big to show here.
nixos/tests/telegraf.nix+33
This diff is too big to show here.
nixos/tests/teleport.nix+99
This diff is too big to show here.
nixos/tests/terminal-emulators.nix+207
This diff is too big to show here.
nixos/tests/thelounge.nix+29
This diff is too big to show here.
nixos/tests/tiddlywiki.nix+69
This diff is too big to show here.
nixos/tests/tigervnc.nix+53
This diff is too big to show here.
nixos/tests/timezone.nix+50
This diff is too big to show here.
nixos/tests/tinc/default.nix+139
This diff is too big to show here.
nixos/tests/tinc/snakeoil-keys.nix+157
This diff is too big to show here.
nixos/tests/tinydns.nix+40
This diff is too big to show here.
nixos/tests/tinywl.nix+57
This diff is too big to show here.
nixos/tests/tomcat.nix+21
This diff is too big to show here.
nixos/tests/tor.nix+25
This diff is too big to show here.
nixos/tests/traefik.nix+89
This diff is too big to show here.
nixos/tests/trafficserver.nix+177
This diff is too big to show here.
nixos/tests/transmission.nix+23
This diff is too big to show here.
nixos/tests/trezord.nix+19
This diff is too big to show here.
nixos/tests/trickster.nix+37
This diff is too big to show here.
nixos/tests/trilium-server.nix+53
This diff is too big to show here.
nixos/tests/tsm-client-gui.nix+57
This diff is too big to show here.
nixos/tests/tuptime.nix+29
This diff is too big to show here.
nixos/tests/turbovnc-headless-server.nix+172
This diff is too big to show here.
nixos/tests/tuxguitar.nix+24
This diff is too big to show here.
nixos/tests/txredisapi.nix+29
This diff is too big to show here.
nixos/tests/ucarp.nix+66
This diff is too big to show here.
nixos/tests/udisks2.nix+69
This diff is too big to show here.
nixos/tests/unbound.nix+315
This diff is too big to show here.
nixos/tests/unifi.nix+36
This diff is too big to show here.
nixos/tests/upnp.nix+96
This diff is too big to show here.
nixos/tests/usbguard.nix+62
This diff is too big to show here.
nixos/tests/user-activation-scripts.nix+33
This diff is too big to show here.
nixos/tests/uwsgi.nix+81
This diff is too big to show here.
nixos/tests/v2ray.nix+83
This diff is too big to show here.
nixos/tests/vault-postgresql.nix+69
This diff is too big to show here.
nixos/tests/vault.nix+25
This diff is too big to show here.
nixos/tests/vaultwarden.nix+187
This diff is too big to show here.
nixos/tests/vector.nix+37
This diff is too big to show here.
nixos/tests/vengi-tools.nix+29
This diff is too big to show here.
nixos/tests/victoriametrics.nix+33
This diff is too big to show here.
nixos/tests/vikunja.nix+65
This diff is too big to show here.
nixos/tests/virtualbox.nix+531
This diff is too big to show here.
nixos/tests/vscodium.nix+78
This diff is too big to show here.
nixos/tests/vsftpd.nix+42
This diff is too big to show here.
nixos/tests/wasabibackend.nix+38
This diff is too big to show here.
nixos/tests/web-apps/mastodon.nix+170
This diff is too big to show here.
nixos/tests/web-apps/netbox.nix+30
This diff is too big to show here.
nixos/tests/web-apps/nifi.nix+30
This diff is too big to show here.
nixos/tests/web-apps/peertube.nix+131
This diff is too big to show here.
nixos/tests/web-servers/agate.nix+29
This diff is too big to show here.
nixos/tests/web-servers/unit-php.nix+47
This diff is too big to show here.
nixos/tests/wiki-js.nix+152
This diff is too big to show here.
nixos/tests/wine.nix+48
This diff is too big to show here.
nixos/tests/wireguard/basic.nix+74
This diff is too big to show here.
nixos/tests/wireguard/default.nix+27
This diff is too big to show here.
nixos/tests/wireguard/generated.nix+64
This diff is too big to show here.
nixos/tests/wireguard/make-peer.nix+23
This diff is too big to show here.
nixos/tests/wireguard/namespaces.nix+84
This diff is too big to show here.
nixos/tests/wireguard/snakeoil-keys.nix+11
This diff is too big to show here.
nixos/tests/wireguard/wg-quick.nix+67
This diff is too big to show here.
nixos/tests/without-nix.nix+32
This diff is too big to show here.
nixos/tests/wmderland.nix+54
This diff is too big to show here.
nixos/tests/wordpress.nix+90
This diff is too big to show here.
nixos/tests/wpa_supplicant.nix+96
This diff is too big to show here.
nixos/tests/xandikos.nix+70
This diff is too big to show here.
nixos/tests/xautolock.nix+24
This diff is too big to show here.
nixos/tests/xfce.nix+45
This diff is too big to show here.
nixos/tests/xmonad-xdg-autostart.nix+35
This diff is too big to show here.
nixos/tests/xmonad.nix+114
This diff is too big to show here.
nixos/tests/xmpp/ejabberd.nix+278
This diff is too big to show here.
nixos/tests/xmpp/prosody-mysql.nix+124
This diff is too big to show here.
nixos/tests/xmpp/prosody.nix+92
This diff is too big to show here.
nixos/tests/xmpp/xmpp-sendmessage.nix+84
This diff is too big to show here.
nixos/tests/xrdp.nix+47
This diff is too big to show here.
nixos/tests/xss-lock.nix+44
This diff is too big to show here.
nixos/tests/xterm.nix+23
This diff is too big to show here.
nixos/tests/xxh.nix+67
This diff is too big to show here.
nixos/tests/yabar.nix+33
This diff is too big to show here.
nixos/tests/yggdrasil.nix+162
This diff is too big to show here.
nixos/tests/zammad.nix+60
This diff is too big to show here.
nixos/tests/zfs.nix+180
This diff is too big to show here.
nixos/tests/zigbee2mqtt.nix+23
This diff is too big to show here.
nixos/tests/zoneminder.nix+23
This diff is too big to show here.
nixos/tests/zookeeper.nix+46
This diff is too big to show here.
nixos/tests/zrepl.nix+66
This diff is too big to show here.
nixos/tests/zsh-history.nix+35
This diff is too big to show here.
pkgs/applications/accessibility/contrast/default.nix+75
This diff is too big to show here.
pkgs/applications/accessibility/dasher/default.nix+70
This diff is too big to show here.
pkgs/applications/accessibility/espeakup/default.nix+46
This diff is too big to show here.
pkgs/applications/accessibility/mousetweaks/default.nix+49
This diff is too big to show here.
pkgs/applications/accessibility/squeekboard/default.nix+73
This diff is too big to show here.
pkgs/applications/accessibility/svkbd/default.nix+59
This diff is too big to show here.
pkgs/applications/accessibility/wvkbd/default.nix+36
This diff is too big to show here.
pkgs/applications/audio/AMB-plugins/default.nix+33
This diff is too big to show here.
pkgs/applications/audio/CHOWTapeModel/default.nix+78
This diff is too big to show here.
pkgs/applications/audio/ChowCentaur/default.nix+53
This diff is too big to show here.
pkgs/applications/audio/ChowKick/default.nix+106
This diff is too big to show here.
pkgs/applications/audio/ChowPhaser/default.nix+76
This diff is too big to show here.
pkgs/applications/audio/FIL-plugins/default.nix+37
This diff is too big to show here.
pkgs/applications/audio/LibreArp/default.nix+53
This diff is too big to show here.
pkgs/applications/audio/LibreArp/lv2.nix+53
This diff is too big to show here.
pkgs/applications/audio/MMA/default.nix+70
This diff is too big to show here.
pkgs/applications/audio/a2jmidid/default.nix+30
This diff is too big to show here.
pkgs/applications/audio/aacgain/default.nix+68
This diff is too big to show here.
pkgs/applications/audio/abcde/default.nix+61
This diff is too big to show here.
pkgs/applications/audio/adlplug/default.nix+105
This diff is too big to show here.
pkgs/applications/audio/aeolus/default.nix+32
This diff is too big to show here.
pkgs/applications/audio/aether-lv2/default.nix+33
This diff is too big to show here.
pkgs/applications/audio/airwave/default.nix+92
This diff is too big to show here.
pkgs/applications/audio/aj-snapshot/default.nix+31
This diff is too big to show here.
pkgs/applications/audio/amarok/default.nix+38
This diff is too big to show here.
pkgs/applications/audio/amberol/default.nix+75
This diff is too big to show here.
pkgs/applications/audio/ams-lv2/default.nix+27
This diff is too big to show here.
pkgs/applications/audio/ams/default.nix+48
This diff is too big to show here.
pkgs/applications/audio/apple-music-electron/default.nix+32
This diff is too big to show here.
pkgs/applications/audio/ardour/as-flags.patch+12
This diff is too big to show here.
pkgs/applications/audio/ardour/default.nix+190
This diff is too big to show here.
pkgs/applications/audio/ario/default.nix+46
This diff is too big to show here.
pkgs/applications/audio/artyFX/default.nix+27
This diff is too big to show here.
pkgs/applications/audio/ashuffle/default.nix+34
This diff is too big to show here.
pkgs/applications/audio/asunder/default.nix+52
This diff is too big to show here.
pkgs/applications/audio/aucatctl/default.nix+37
This diff is too big to show here.
pkgs/applications/audio/audacious/default.nix+70
This diff is too big to show here.
pkgs/applications/audio/audacity/default.nix+205
This diff is too big to show here.
pkgs/applications/audio/audio-recorder/default.nix+44
This diff is too big to show here.
pkgs/applications/audio/aumix/default.nix+45
This diff is too big to show here.
pkgs/applications/audio/autotalent/default.nix+30
This diff is too big to show here.
pkgs/applications/audio/axoloti/default.nix+101
This diff is too big to show here.
pkgs/applications/audio/axoloti/dfu-util.nix+31
This diff is too big to show here.
pkgs/applications/audio/axoloti/libusb1.nix+39
This diff is too big to show here.
pkgs/applications/audio/bambootracker/default.nix+46
This diff is too big to show here.