29035 files changed+1459348−634808
26035 more files changed are not listed.
.editorconfig+6−34
@@ -47,43 +47,31 @@ indent_style = space
4747insert_final_newline = unset
4848trim_trailing_whitespace = unset
4949
50−[*.{key,ovpn}]
50+[*.{asc,key,ovpn}]
5151insert_final_newline = unset
5252end_of_line = unset
53+trim_trailing_whitespace = unset
5354
5455[*.lock]
5556indent_size = unset
5657
57−[deps.nix]
58−insert_final_newline = unset
59−[pkgs/tools/networking/dd-agent/*-deps.nix]
60−insert_final_newline = unset
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
6162
6263[eggs.nix]
6364trim_trailing_whitespace = unset
6465
65−[gemset.nix]
66−insert_final_newline = unset
67−
68−[node-{composition,packages,packages-generated}.nix]
69−insert_final_newline = unset
70−
7166[nixos/modules/services/networking/ircd-hybrid/*.{conf,in}]
7267trim_trailing_whitespace = unset
7368
74−[nixos/tests/systemd-networkd-vrf.nix]
75−trim_trailing_whitespace = unset
76−
7769[pkgs/build-support/dotnetenv/Wrapper/**]
7870end_of_line = unset
7971indent_style = unset
8072insert_final_newline = unset
8173trim_trailing_whitespace = unset
8274
83−[pkgs/build-support/upstream-updater/**]
84−indent_style = unset
85−trim_trailing_whitespace = unset
86−
8775[pkgs/development/compilers/elm/registry.dat]
8876end_of_line = unset
8977insert_final_newline = unset
@@ -92,24 +80,8 @@ insert_final_newline = unset
9280indent_style = unset
9381trim_trailing_whitespace = unset
9482
95−[pkgs/development/mobile/androidenv/generated/{addons,packages}.nix]
96−trim_trailing_whitespace = unset
97−
98−[pkgs/development/node-packages/composition.nix]
99−insert_final_newline = unset
100−
101−[pkgs/development/{perl-modules,ocaml-modules,tools/ocaml}/**]
102−indent_style = unset
103−
10483[pkgs/servers/dict/wordnet_structures.py]
10584trim_trailing_whitespace = unset
10685
10786[pkgs/tools/misc/timidity/timidity.cfg]
10887trim_trailing_whitespace = unset
109−
110−[pkgs/tools/security/enpass/data.json]
111−insert_final_newline = unset
112−trim_trailing_whitespace = unset
113−
114−[pkgs/top-level/emscripten-packages.nix]
115−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
.github/CODEOWNERS+141−72
@@ -6,12 +6,16 @@
66#
77# For documentation on this file, see https://help.github.com/articles/about-codeowners/
88# 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.
913
1014# This file
1115/.github/CODEOWNERS @edolstra
1216
1317# GitHub actions
14−/.github/workflows @Mic92 @zowoq
18+/.github/workflows @NixOS/Security @Mic92 @zowoq
1519/.github/workflows/merge-staging @FRidh
1620
1721# EditorConfig
@@ -19,28 +23,36 @@
1923
2024# Libraries
2125/lib @edolstra @nbp @infinisil
22−/lib/systems @nbp @ericson2314 @matthewbauer
26+/lib/systems @alyssais @nbp @ericson2314 @matthewbauer
2327/lib/generators.nix @edolstra @nbp @Profpatsch
2428/lib/cli.nix @edolstra @nbp @Profpatsch
2529/lib/debug.nix @edolstra @nbp @Profpatsch
2630/lib/asserts.nix @edolstra @nbp @Profpatsch
2731
2832# Nixpkgs Internals
29−/default.nix @nbp
30−/pkgs/top-level/default.nix @nbp @Ericson2314
31−/pkgs/top-level/impure.nix @nbp @Ericson2314
32−/pkgs/top-level/stage.nix @nbp @Ericson2314 @matthewbauer
33−/pkgs/top-level/splice.nix @Ericson2314 @matthewbauer
34−/pkgs/top-level/release-cross.nix @Ericson2314 @matthewbauer
35−/pkgs/stdenv/generic @Ericson2314 @matthewbauer
36−/pkgs/stdenv/cross @Ericson2314 @matthewbauer
37−/pkgs/build-support/cc-wrapper @Ericson2314 @orivej
38−/pkgs/build-support/bintools-wrapper @Ericson2314 @orivej
39−/pkgs/build-support/setup-hooks @Ericson2314
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
4046
4147# Nixpkgs build-support
4248/pkgs/build-support/writers @lassulus @Profpatsch
4349
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+
4456# NixOS Internals
4557/nixos/default.nix @nbp @infinisil
4658/nixos/lib/from-env.nix @nbp @infinisil
@@ -58,10 +70,17 @@
5870/nixos/doc/manual/development/writing-modules.xml @nbp
5971/nixos/doc/manual/man-nixos-option.xml @nbp
6072/nixos/modules/installer/tools/nixos-option.sh @nbp
73+/nixos/modules/system @dasJ
6174
6275# NixOS integration test driver
6376/nixos/lib/test-driver @tfc
6477
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+
6584# Updaters
6685## update.nix
6786/maintainers/scripts/update.nix @jtojnar
@@ -70,39 +89,40 @@
7089/pkgs/common-updater/scripts/update-source-version @jtojnar
7190
7291# Python-related code and docs
73−/maintainers/scripts/update-python-libraries @FRidh
74−/pkgs/top-level/python-packages.nix @FRidh @jonringer
75−/pkgs/development/interpreters/python @FRidh
76−/pkgs/development/python-modules @FRidh @jonringer
77−/doc/languages-frameworks/python.section.md @FRidh
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
7899
79100# Haskell
80−/pkgs/development/compilers/ghc @cdepillabout
81−/pkgs/development/haskell-modules @cdepillabout
82−/pkgs/development/haskell-modules/default.nix @cdepillabout
83−/pkgs/development/haskell-modules/generic-builder.nix @cdepillabout
84−/pkgs/development/haskell-modules/hoogle.nix @cdepillabout
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
85108
86109# Perl
87−/pkgs/development/interpreters/perl @volth @stigtsp
88−/pkgs/top-level/perl-packages.nix @volth @stigtsp
89−/pkgs/development/perl-modules @volth @stigtsp
110+/pkgs/development/interpreters/perl @stigtsp @zakame
111+/pkgs/top-level/perl-packages.nix @stigtsp @zakame
112+/pkgs/development/perl-modules @stigtsp @zakame
90113
91114# R
92−/pkgs/applications/science/math/R @peti
93−/pkgs/development/r-modules @peti
115+/pkgs/applications/science/math/R @jbedo
116+/pkgs/development/r-modules @jbedo
94117
95118# Ruby
96−/pkgs/development/interpreters/ruby @alyssais
97−/pkgs/development/ruby-modules @alyssais
119+/pkgs/development/interpreters/ruby @marsam
120+/pkgs/development/ruby-modules @marsam
98121
99122# Rust
100123/pkgs/development/compilers/rust @Mic92 @LnL7 @zowoq
101−/pkgs/build-support/rust @andir @zowoq
102−
103−# Darwin-related
104−/pkgs/stdenv/darwin @NixOS/darwin-maintainers
105−/pkgs/os-specific/darwin @NixOS/darwin-maintainers
124+/pkgs/build-support/rust @zowoq
125+/doc/languages-frameworks/rust.section.md @zowoq
106126
107127# C compilers
108128/pkgs/development/compilers/gcc @matthewbauer
@@ -112,21 +132,18 @@
112132/pkgs/top-level/unix-tools.nix @matthewbauer
113133/pkgs/development/tools/xcbuild @matthewbauer
114134
115−# Beam-related (Erlang, Elixir, LFE, etc)
116−/pkgs/development/beam-modules @gleber
117−/pkgs/development/interpreters/erlang @gleber
118−/pkgs/development/interpreters/lfe @gleber
119−/pkgs/development/interpreters/elixir @gleber
120−/pkgs/development/tools/build-managers/rebar @gleber
121−/pkgs/development/tools/build-managers/rebar3 @gleber
122−/pkgs/development/tools/erlang @gleber
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
123143
124144# Jetbrains
125145/pkgs/applications/editors/jetbrains @edwtjo
126146
127−# Eclipse
128−/pkgs/applications/editors/eclipse @rycee
129−
130147# Licenses
131148/lib/licenses.nix @alyssais
132149
@@ -137,7 +154,7 @@
137154/pkgs/development/libraries/qt-5 @ttuegel
138155
139156# PostgreSQL and related stuff
140−/pkgs/servers/sql/postgresql @thoughtpolice
157+/pkgs/servers/sql/postgresql @thoughtpolice @marsam
141158/nixos/modules/services/databases/postgresql.xml @thoughtpolice
142159/nixos/modules/services/databases/postgresql.nix @thoughtpolice
143160/nixos/tests/postgresql.nix @thoughtpolice
@@ -150,21 +167,39 @@
150167/nixos/tests/hardened.nix @joachifm
151168/pkgs/os-specific/linux/kernel/hardened-config.nix @joachifm
152169
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+
153178# Network Time Daemons
154179/pkgs/tools/networking/chrony @thoughtpolice
155180/pkgs/tools/networking/ntp @thoughtpolice
156181/pkgs/tools/networking/openntpd @thoughtpolice
157182/nixos/modules/services/networking/ntp @thoughtpolice
158183
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+
159194# Dhall
160−/pkgs/development/dhall-modules @Gabriel439 @Profpatsch
161−/pkgs/development/interpreters/dhall @Gabriel439 @Profpatsch
195+/pkgs/development/dhall-modules @Gabriel439 @Profpatsch @ehmry
196+/pkgs/development/interpreters/dhall @Gabriel439 @Profpatsch @ehmry
162197
163198# Idris
164199/pkgs/development/idris-modules @Infinisil
165200
166201# Bazel
167−/pkgs/development/tools/build-managers/bazel @mboes @Profpatsch
202+/pkgs/development/tools/build-managers/bazel @Profpatsch
168203
169204# NixOS modules for e-mail and dns services
170205/nixos/modules/services/mail/mailman.nix @peti
@@ -173,19 +208,18 @@
173208/nixos/modules/services/mail/rspamd.nix @peti
174209
175210# Emacs
176−/pkgs/applications/editors/emacs-modes @adisbladis
177−/pkgs/applications/editors/emacs @adisbladis
178−/pkgs/top-level/emacs-packages.nix @adisbladis
211+/pkgs/applications/editors/emacs/elisp-packages @adisbladis
212+/pkgs/applications/editors/emacs @adisbladis
213+/pkgs/top-level/emacs-packages.nix @adisbladis
179214
180215# Neovim
181−/pkgs/applications/editors/neovim @jonringer
182−/pkgs/applications/editors/neovim @teto
216+/pkgs/applications/editors/neovim @jonringer @teto
183217
184218# VimPlugins
185−/pkgs/misc/vim-plugins @jonringer @softinio
219+/pkgs/applications/editors/vim/plugins @jonringer
186220
187221# VsCode Extensions
188−/pkgs/misc/vscode-extensions @jonringer
222+/pkgs/applications/editors/vscode/extensions @jonringer
189223
190224# Prometheus exporter modules and tests
191225/nixos/modules/services/monitoring/prometheus/exporters.nix @WilliButz
@@ -193,30 +227,65 @@
193227/nixos/tests/prometheus-exporters.nix @WilliButz
194228
195229# PHP interpreter, packages, extensions, tests and documentation
196−/doc/languages-frameworks/php.section.md @NixOS/php
197−/nixos/tests/php @NixOS/php
198−/pkgs/build-support/build-pecl.nix @NixOS/php
199−/pkgs/development/interpreters/php @NixOS/php
200−/pkgs/development/php-packages @NixOS/php
201−/pkgs/top-level/php-packages.nix @NixOS/php
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
202236
203237# Podman, CRI-O modules and related
204−/nixos/modules/virtualisation/containers.nix @NixOS/podman @zowoq
205−/nixos/modules/virtualisation/cri-o.nix @NixOS/podman @zowoq
206−/nixos/modules/virtualisation/podman.nix @NixOS/podman @zowoq
207−/nixos/tests/cri-o.nix @NixOS/podman @zowoq
208−/nixos/tests/podman.nix @NixOS/podman @zowoq
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
209243
210244# Docker tools
211−/pkgs/build-support/docker @roberth @utdemir
212−/nixos/tests/docker-tools-overlay.nix @roberth
213−/nixos/tests/docker-tools.nix @roberth
214−/doc/builders/images/dockertools.xml @roberth
245+/pkgs/build-support/docker @roberth
246+/nixos/tests/docker-tools* @roberth
247+/doc/builders/images/dockertools.section.md @roberth
215248
216249# Blockchains
217250/pkgs/applications/blockchains @mmahut @RaghavSood
218251
219252# Go
253+/doc/languages-frameworks/go.section.md @kalbasit @Mic92 @zowoq
220254/pkgs/development/compilers/go @kalbasit @Mic92 @zowoq
221255/pkgs/development/go-modules @kalbasit @Mic92 @zowoq
222256/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/CONTRIBUTING.mddeleted−63
@@ -1,63 +0,0 @@
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−* Format the commit messages in the following way:
15−
16− ```
17− (pkg-name | nixos/<module>): (from -> to | init at version | refactor | etc)
18−
19− (Motivation for change. Additional information.)
20− ```
21−
22− 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).
23−
24− Examples:
25−
26− * nginx: init at 2.0.1
27− * firefox: 54.0.1 -> 55.0
28− * nixos/hydra: add bazBaz option
29−
30− Dual baz behavior is needed to do foo.
31− * nixos/nginx: refactor config generation
32−
33− The old config generation system used impure shell scripts and could break in specific circumstances (see #1234).
34−
35−* `meta.description` should:
36− * Be capitalized.
37− * Not start with the package name.
38− * Not have a period at the end.
39−* `meta.license` must be set and fit the upstream license.
40− * If there is no upstream license, `meta.license` should default to `stdenv.lib.licenses.unfree`.
41−* `meta.maintainers` must be set.
42−
43−See the nixpkgs manual for more details on [standard meta-attributes](https://nixos.org/nixpkgs/manual/#sec-standard-meta-attributes) and on how to [submit changes to nixpkgs](https://nixos.org/nixpkgs/manual/#chap-submitting-changes).
44−
45−## Writing good commit messages
46−
47−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.
48−
49−For package version upgrades and such a one-line commit message is usually sufficient.
50−
51−## Backporting changes
52−
53−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).
54−
55−1. Take note of the commits in which the change was introduced into `master` branch.
56−2. Check out the target _release branch_, e.g. `release-20.09`. Do not use a _channel branch_ like `nixos-20.09` or `nixpkgs-20.09`.
57−3. Create a branch for your change, e.g. `git checkout -b backport`.
58−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.
59−5. Push to GitHub and open a backport pull request. Make sure to select the release branch (e.g. `release-20.09`) 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. `[20.09]`.
60−
61−## Reviewing contributions
62−
63−See the nixpkgs manual for more details on how to [Review contributions](https://nixos.org/nixpkgs/manual/#chap-reviewing-contributions).
.github/ISSUE_TEMPLATE/bug_report.md+10−13
@@ -7,37 +7,34 @@ assignees: ''
77
88---
99
10−**Describe the bug**
10+### Describe the bug
1111A clear and concise description of what the bug is.
1212
13−**To Reproduce**
13+### Steps To Reproduce
1414Steps to reproduce the behavior:
15151. ...
16162. ...
17173. ...
1818
19−**Expected behavior**
19+### Expected behavior
2020A clear and concise description of what you expected to happen.
2121
22−**Screenshots**
22+### Screenshots
2323If applicable, add screenshots to help explain your problem.
2424
25−**Additional context**
25+### Additional context
2626Add any other context about the problem here.
2727
28−**Notify maintainers**
28+### Notify maintainers
2929<!--
3030Please @ people who are in the `meta.maintainers` list of the offending package or module.
3131If in doubt, check `git blame` for whoever last touched something.
3232-->
3333
34−**Metadata**
34+### Metadata
3535Please run `nix-shell -p nix-info --run "nix-info -m"` and paste the result.
3636
37−Maintainer information:
38−```yaml
39−# a list of nixpkgs attributes affected by the problem
40−attribute:
41−# a list of nixos modules affected by the problem
42−module:
37+```console
38+[user@system:~]$ nix-shell -p nix-info --run "nix-info -m"
39+output here
4340```
.github/ISSUE_TEMPLATE/out_of_date_package_report.md+3−3
@@ -13,10 +13,10 @@ assignees: ''
1313<!-- Note that these are hard requirements -->
1414
1515<!--
16−You can use the "Go to file" functionality on github to find the package
16+You can use the "Go to file" functionality on GitHub to find the package
1717Then you can go to the history for this package
1818Find the latest "package_name: old_version -> new_version" commit
19−The "new_version" is the the current version of the package
19+The "new_version" is the current version of the package
2020-->
2121- [ ] Checked the [nixpkgs master branch](https://github.com/NixOS/nixpkgs)
2222<!--
@@ -29,7 +29,7 @@ There's a high chance that you'll have the new version right away while helping
2929###### Project name
3030`nix search` name:
3131<!--
32−The current version can be found easily with the same process than above for checking the master branch
32+The current version can be found easily with the same process as above for checking the master branch
3333If an open PR is present for the package, take this version as the current one and link to the PR
3434-->
3535current version:
.github/PULL_REQUEST_TEMPLATE.md+32−19
@@ -1,28 +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+
132<!--
233To help with the large amounts of pull requests, we would appreciate your
334reviews of other pull requests, especially simple package updates. Just leave a
435comment describing what you have tested in the relevant package/service.
536Reviewing helps to reduce the average time-to-merge for everyone.
637Thanks a lot if you do!
38+
739List of open PRs: https://github.com/NixOS/nixpkgs/pulls
840Reviewing guidelines: https://nixos.org/manual/nixpkgs/unstable/#chap-reviewing-contributions
941-->
10−
11−###### Motivation for this change
12−
13−
14−###### Things done
15−
16−<!-- Please check what applies. Note that these are not hard requirements but merely serve as information for reviewers. -->
17−
18−- [ ] Tested using sandboxing ([nix.useSandbox](https://nixos.org/nixos/manual/options.html#opt-nix.useSandbox) on NixOS, or option `sandbox` in [`nix.conf`](https://nixos.org/nix/manual/#sec-conf-file) on non-NixOS linux)
19−- Built on platform(s)
20− - [ ] NixOS
21− - [ ] macOS
22− - [ ] other Linux distributions
23−- [ ] Tested via one or more NixOS test(s) if existing and applicable for the change (look inside [nixos/tests](https://github.com/NixOS/nixpkgs/blob/master/nixos/tests))
24−- [ ] Tested compilation of all pkgs that depend on this change using `nix-shell -p nixpkgs-review --run "nixpkgs-review wip"`
25−- [ ] Tested execution of all binary files (usually in `./result/bin/`)
26−- [ ] Determined the impact on package closure size (by running `nix path-info -S` before and after)
27−- [ ] Ensured that relevant documentation is up to date
28−- [ ] Fits [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/.github/CONTRIBUTING.md).
.github/STALE-BOT.md+1−1
@@ -3,7 +3,7 @@
33- Thanks for your contribution!
44- To remove the stale label, just leave a new comment.
55- _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/) or on the [#nixos IRC channel](https://webchat.freenode.net/#nixos).
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).
77
88## Suggestions for PRs
99
.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/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.yml+23−17
@@ -1,37 +1,43 @@
11name: "Checking EditorConfig"
22
3+permissions: read-all
4+
35on:
4− pull_request:
6+ # avoids approving first time contributors
7+ pull_request_target:
58 branches-ignore:
69 - 'release-**'
710
811jobs:
912 tests:
1013 runs-on: ubuntu-latest
11− if: github.repository_owner == 'NixOS'
14+ if: "github.repository_owner == 'NixOS' && !contains(github.event.pull_request.title, '[skip editorconfig]')"
1215 steps:
1316 - name: Get list of changed files from PR
1417 env:
1518 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
1619 run: |
17− echo 'PR_DIFF<<EOF' >> $GITHUB_ENV
1820 gh api \
1921 repos/NixOS/nixpkgs/pulls/${{github.event.number}}/files --paginate \
2022 | jq '.[] | select(.status != "removed") | .filename' \
21− >> $GITHUB_ENV
22− echo 'EOF' >> $GITHUB_ENV
23− - uses: actions/checkout@v2
24− if: env.PR_DIFF
25− - name: Fetch editorconfig-checker
26− if: env.PR_DIFF
27− env:
28− ECC_VERSION: "2.2.0"
29− ECC_URL: "https://github.com/editorconfig-checker/editorconfig-checker/releases/download"
23+ > "$HOME/changed_files"
24+ - name: print list of changed files
3025 run: |
31− curl -sSf -O -L -C - "$ECC_URL/$ECC_VERSION/ec-linux-amd64.tar.gz" && \
32− tar xzf ec-linux-amd64.tar.gz && \
33− mv ./bin/ec-linux-amd64 ./bin/editorconfig-checker
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>'
3438 - name: Checking EditorConfig
35− if: env.PR_DIFF
3639 run: |
37− echo "$PR_DIFF" | xargs ./bin/editorconfig-checker -disable-indent-size
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/merge-staging.ymldeleted−39
@@ -1,39 +0,0 @@
1−name: "merge staging(-next)"
2−
3−on:
4− schedule:
5− # * is a special character in YAML so you have to quote this string
6− # Merge every 6 hours
7− - cron: '0 */6 * * *'
8−
9−jobs:
10− sync-branch:
11− if: github.repository == 'NixOS/nixpkgs'
12− runs-on: ubuntu-latest
13− steps:
14− - uses: actions/checkout@v2
15−
16− - name: Merge master into staging-next
17− uses: devmasx/merge-branch@v1.3.1
18− with:
19− type: now
20− from_branch: master
21− target_branch: staging-next
22− github_token: ${{ secrets.GITHUB_TOKEN }}
23−
24− - name: Merge staging-next into staging
25− uses: devmasx/merge-branch@v1.3.1
26− with:
27− type: now
28− from_branch: staging-next
29− target_branch: staging
30− github_token: ${{ secrets.GITHUB_TOKEN }}
31−
32− - name: Comment on failure
33− uses: peter-evans/create-or-update-comment@v1
34− if: ${{ failure() }}
35− with:
36− issue-number: 105153
37− body: |
38− An automatic merge [failed](https://github.com/NixOS/nixpkgs/actions/runs/${{ github.run_id }}).
39−
.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-set.yml+6−1
@@ -3,6 +3,11 @@ name: "set pending status"
33on:
44 pull_request_target:
55
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+
611jobs:
712 action:
813 runs-on: ubuntu-latest
@@ -16,5 +21,5 @@ jobs:
1621 -X POST \
1722 -H "Accept: application/vnd.github.v3+json" \
1823 -H "Authorization: token $GITHUB_TOKEN" \
19− -d '{"state": "failure", "target_url": " ", "description": "This failed status will be cleared when ofborg finishes eval.", "context": "Wait for ofborg"}' \
24+ -d '{"state": "pending", "target_url": " ", "description": "This pending status will be cleared when ofborg starts eval.", "context": "Wait for ofborg"}' \
2025 "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/rebase-staging.ymldeleted−56
@@ -1,56 +0,0 @@
1−on:
2− issue_comment:
3− types:
4− - created
5−
6−# This action allows people with write access to the repo to rebase a PRs base branch from
7−# master to staging by commenting `/rebase-staging` on the PR while avoiding CODEOWNER notifications.
8−
9−jobs:
10− rebase:
11− runs-on: ubuntu-latest
12− if: github.repository_owner == 'NixOS' && github.event.issue.pull_request != '' && contains(github.event.comment.body, '/rebase-staging')
13− steps:
14− - uses: scherermichael-oss/action-has-permission@1.0.6
15− id: check-write-access
16− with:
17− required-permission: write
18− env:
19− GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
20− - name: check base branch is master
21− if: steps.check-write-access.outputs.has-permission
22− run: |
23− if [ "$(curl https://api.github.com/repos/NixOS/nixpkgs/pulls/${{ github.event.issue.number }} | jq -r '.base.ref')" != "master" ]; then
24− echo "This action only works when the current base branch is master."
25− exit 1
26− fi
27− - uses: actions/checkout@v2
28− with:
29− fetch-depth: 0
30− if: steps.check-write-access.outputs.has-permission
31− - name: rebase pull request
32− if: steps.check-write-access.outputs.has-permission
33− env:
34− GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
35− PULL_REQUEST: ${{ github.event.issue.number }}
36− run: |
37− git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
38− git config --global user.name "github-actions[bot]"
39− git fetch origin
40− gh pr checkout "$PULL_REQUEST"
41− git rebase \
42− --onto="$(git merge-base origin/master origin/staging)" \
43− "HEAD~$(git rev-list --count HEAD ^master)"
44− git push --force
45− curl \
46− -X POST \
47− -H "Accept: application/vnd.github.v3+json" \
48− -H "Authorization: token $GITHUB_TOKEN" \
49− -d '{ "base": "staging" }' \
50− "https://api.github.com/repos/NixOS/nixpkgs/pulls/$PULL_REQUEST"
51− - uses: peter-evans/create-or-update-comment@v1
52− if: ${{ failure() }}
53− with:
54− issue-number: ${{ github.event.issue.number }}
55− body: |
56− [Failed to rebase on `staging`](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 }}).
.gitignore+7
@@ -2,8 +2,12 @@
22,*
33.*.swp
44.*.swo
5+.idea/
6+.vscode/
7+outputs/
58result
69result-*
10+source/
711/doc/NEWS.html
812/doc/NEWS.txt
913/doc/manual.html
@@ -20,3 +24,6 @@ __pycache__
2024
2125# generated by pkgs/common-updater/update-script.nix
2226update-git-commits.txt
27+
28+# JetBrains IDEA module declaration file
29+/nixpkgs.iml
.version+1−1
@@ -1 +1 @@
1−21.03
1+22.05
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).
COPYING+1−1
@@ -1,4 +1,4 @@
1−Copyright (c) 2003-2020 Eelco Dolstra and the Nixpkgs/NixOS contributors
1+Copyright (c) 2003-2022 Eelco Dolstra and the Nixpkgs/NixOS contributors
22
33Permission is hereby granted, free of charge, to any person obtaining
44a copy of this software and associated documentation files (the
README.md+17−11
@@ -1,14 +1,19 @@
11<p align="center">
2− <a href="https://nixos.org/nixos"><img src="https://nixos.org/logo/nixos-hires.png" width="500px" alt="NixOS logo" /></a>
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>
38</p>
49
510<p align="center">
6− <a href="https://www.codetriage.com/nixos/nixpkgs"><img src="https://www.codetriage.com/nixos/nixpkgs/badges/users.svg" alt="Code Triagers badge" /></a>
7− <a href="https://opencollective.com/nixos"><img src="https://opencollective.com/nixos/tiers/supporter/badge.svg?label=Supporter&color=brightgreen" alt="Open Collective supporters" /></a>
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>
813</p>
914
1015[Nixpkgs](https://github.com/nixos/nixpkgs) is a collection of over
11−60,000 software packages that can be installed with the
16+80,000 software packages that can be installed with the
1217[Nix](https://nixos.org/nix/) package manager. It also implements
1318[NixOS](https://nixos.org/nixos/), a purely-functional Linux distribution.
1419
@@ -21,10 +26,10 @@
2126# Community
2227
2328* [Discourse Forum](https://discourse.nixos.org/)
24−* [IRC - #nixos on freenode.net](irc://irc.freenode.net/#nixos)
29+* [Matrix Chat](https://matrix.to/#/#community:nixos.org)
2530* [NixOS Weekly](https://weekly.nixos.org/)
2631* [Community-maintained wiki](https://nixos.wiki/)
27−* [Community-maintained list of ways to get in touch](https://nixos.wiki/wiki/Get_In_Touch#Chat) (Discord, Matrix, Telegram, other IRC channels, etc.)
32+* [Community-maintained list of ways to get in touch](https://nixos.wiki/wiki/Get_In_Touch#Chat) (Discord, Telegram, IRC, etc.)
2833
2934# Other Project Repositories
3035
@@ -46,14 +51,14 @@ Nixpkgs and NixOS are built and tested by our continuous integration
4651system, [Hydra](https://hydra.nixos.org/).
4752
4853* [Continuous package builds for unstable/master](https://hydra.nixos.org/jobset/nixos/trunk-combined)
49−* [Continuous package builds for the NixOS 20.09 release](https://hydra.nixos.org/jobset/nixos/release-20.09)
54+* [Continuous package builds for the NixOS 21.11 release](https://hydra.nixos.org/jobset/nixos/release-21.11)
5055* [Tests for unstable/master](https://hydra.nixos.org/job/nixos/trunk-combined/tested#tabs-constituents)
51−* [Tests for the NixOS 20.09 release](https://hydra.nixos.org/job/nixos/release-20.09/tested#tabs-constituents)
56+* [Tests for the NixOS 21.11 release](https://hydra.nixos.org/job/nixos/release-21.11/tested#tabs-constituents)
5257
5358Artifacts successfully built with Hydra are published to cache at
5459https://cache.nixos.org/. When successful build and test criteria are
5560met, the Nixpkgs expressions are distributed via [Nix
56−channels](https://nixos.org/nix/manual/#sec-channels).
61+channels](https://nixos.org/manual/nix/stable/package-management/channels.html).
5762
5863# Contributing
5964
@@ -87,7 +92,7 @@ Most contributions are based on and merged into these branches:
8792 deemed of sufficiently high quality
8893
8994For more information about contributing to the project, please visit
90−the [contributing page](https://github.com/NixOS/nixpkgs/blob/master/.github/CONTRIBUTING.md).
95+the [contributing page](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
9196
9297# Donations
9398
@@ -97,7 +102,8 @@ Foundation](https://nixos.org/nixos/foundation.html). To ensure the
97102continuity and expansion of the NixOS infrastructure, we are looking
98103for donations to our organization.
99104
100−You can donate to the NixOS foundation by using Open Collective:
105+You can donate to the NixOS foundation through [SEPA bank
106+transfers](https://nixos.org/donate.html) or by using Open Collective:
101107
102108<a href="https://opencollective.com/nixos#support"><img src="https://opencollective.com/nixos/tiers/supporter.svg?width=890" /></a>
103109
doc/Makefile+26−14
@@ -1,4 +1,20 @@
1−MD_TARGETS=$(addsuffix .xml, $(basename $(shell find . -type f -regex '.*\.md$$')))
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
218
319.PHONY: all
420all: validate format out/html/index.html out/epub/manual.epub
@@ -22,7 +38,7 @@ fix-misc-xml:
2238.PHONY: clean
2339clean:
2440 rm -f ${MD_TARGETS} doc-support/result .version manual-full.xml functions/library/locations.xml functions/library/generated
25− rm -rf ./out/ ./highlightjs
41+ rm -rf ./out/ ./highlightjs ./media
2642
2743.PHONY: validate
2844validate: manual-full.xml doc-support/result
@@ -39,7 +55,7 @@ out/html/index.html: doc-support/result manual-full.xml style.css highlightjs
3955 mkdir -p out/html/highlightjs/
4056 cp -r highlightjs out/html/
4157
42− cp -r media out/html/
58+ cp -r $(pandoc_media_dir) out/html/
4359 cp ./overrides.css out/html/
4460 cp ./style.css out/html/style.css
4561
@@ -54,7 +70,7 @@ out/epub/manual.epub: manual-full.xml
5470 doc-support/result/epub.xsl \
5571 ./manual-full.xml
5672
57− cp -r media out/epub/scratch/OEBPS
73+ cp -r $(pandoc_media_dir) out/epub/scratch/OEBPS
5874 cp ./overrides.css out/epub/scratch/OEBPS
5975 cp ./style.css out/epub/scratch/OEBPS
6076 mkdir -p out/epub/scratch/OEBPS/images/callouts/
@@ -89,16 +105,12 @@ functions/library/generated: doc-support/result
89105 ln -rfs ./doc-support/result/function-docs functions/library/generated
90106
91107%.section.xml: %.section.md
92− pandoc $^ -t docbook \
93− --extract-media=media \
94− --lua-filter=$(PANDOC_LUA_FILTERS_DIR)/diagram-generator.lua \
95− -f markdown+smart \
96− | cat > $@
108+ $(PANDOC) $^ -t docbook \
109+ $(pandoc_flags) \
110+ -o $@
97111
98112%.chapter.xml: %.chapter.md
99− pandoc $^ -t docbook \
113+ $(PANDOC) $^ -t docbook \
100114 --top-level-division=chapter \
101− --extract-media=media \
102− --lua-filter=$(PANDOC_LUA_FILTERS_DIR)/diagram-generator.lua \
103− -f markdown+smart \
104− | cat > $@
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.md+66−22
@@ -1,8 +1,16 @@
11# Fetchers {#chap-pkgs-fetchers}
22
3−When using Nix, you will frequently need to download source code and other files from the internet. Nixpkgs comes with a few helper functions that allow you to fetch fixed-output derivations in a structured way.
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.
44
5−The two fetcher primitives 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.
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.
614
715```nix
816{ stdenv, fetchurl }:
@@ -16,55 +24,91 @@ stdenv.mkDerivation {
1624}
1725```
1826
19−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.
20−
21−`fetchpatch` works very similarly to `fetchurl` with the same arguments expected. It expects patch files as a source and 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.
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.
2228
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.
2330
24−Other fetcher functions allow you to add source code directly from a VCS such as subversion or git. These are mostly straightforward nambes based on the name of the command used with the VCS system. Because they give you a working repository, they act most like `fetchzip`.
31+Most other fetchers return a directory rather than a single file.
2532
26−## `fetchsvn`
33+## `fetchsvn` {#fetchsvn}
2734
2835Used with Subversion. Expects `url` to a Subversion directory, `rev`, and `sha256`.
2936
30−## `fetchgit`
37+## `fetchgit` {#fetchgit}
3138
3239Used 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`.
3340
34−## `fetchfossil`
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}
3562
3663Used with Fossil. Expects `url` to a Fossil archive, `rev`, and `sha256`.
3764
38−## `fetchcvs`
65+## `fetchcvs` {#fetchcvs}
3966
4067Used with CVS. Expects `cvsRoot`, `tag`, and `sha256`.
4168
42−## `fetchhg`
69+## `fetchhg` {#fetchhg}
4370
4471Used with Mercurial. Expects `url`, `rev`, and `sha256`.
4572
4673A 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.
4774
48−## `fetchFromGitHub`
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.
4978
50−`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.
79+## `fetchFromGitHub` {#fetchfromgithub}
5180
52−## `fetchFromGitLab`
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.
5382
54−This is used with GitLab repositories. The arguments expected are very similar to fetchFromGitHub above.
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.
5584
56−## `fetchFromGitiles`
85+## `fetchFromGitLab` {#fetchfromgitlab}
5786
58−This is used with Gitiles repositories. The arguments expected are similar to fetchgit.
87+This is used with GitLab repositories. The arguments expected are very similar to `fetchFromGitHub` above.
5988
60−## `fetchFromBitbucket`
89+## `fetchFromGitiles` {#fetchfromgitiles}
90+
91+This is used with Gitiles repositories. The arguments expected are similar to `fetchgit`.
92+
93+## `fetchFromBitbucket` {#fetchfrombitbucket}
6194
6295This is used with BitBucket repositories. The arguments expected are very similar to fetchFromGitHub above.
6396
64−## `fetchFromSavannah`
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.
65104
66−This is used with Savannah repositories. The arguments expected are very similar to fetchFromGitHub above.
105+## `fetchFromSourcehut` {#fetchfromsourcehut}
67106
68−## `fetchFromRepoOrCz`
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`.
69111
70−This is used with repo.or.cz repositories. The arguments expected are very similar to fetchFromGitHub above.
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.xml+4−4
@@ -5,8 +5,8 @@
55 <para>
66 This chapter describes tools for creating various types of images.
77 </para>
8− <xi:include href="images/appimagetools.xml" />
9− <xi:include href="images/dockertools.xml" />
10− <xi:include href="images/ocitools.xml" />
11− <xi:include href="images/snaptools.xml" />
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" />
1212</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/appimagetools.xmldeleted−102
@@ -1,102 +0,0 @@
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-pkgs-appimageTools">
5− <title>pkgs.appimageTools</title>
6−
7− <para>
8− <varname>pkgs.appimageTools</varname> is a set of functions for extracting and wrapping <link xlink:href="https://appimage.org/">AppImage</link> 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, <literal>pkgs.appimage-run</literal> can be used as well.
9− </para>
10−
11− <warning>
12− <para>
13− The <varname>appimageTools</varname> API is unstable and may be subject to backwards-incompatible changes in the future.
14− </para>
15− </warning>
16−
17− <section xml:id="ssec-pkgs-appimageTools-formats">
18− <title>AppImage formats</title>
19−
20− <para>
21− There are different formats for AppImages, see <link xlink:href="https://github.com/AppImage/AppImageSpec/blob/74ad9ca2f94bf864a4a0dac1f369dd4f00bd1c28/draft.md#image-format">the specification</link> for details.
22− </para>
23−
24− <itemizedlist>
25− <listitem>
26− <para>
27− Type 1 images are ISO 9660 files that are also ELF executables.
28− </para>
29− </listitem>
30− <listitem>
31− <para>
32− Type 2 images are ELF executables with an appended filesystem.
33− </para>
34− </listitem>
35− </itemizedlist>
36−
37− <para>
38− They can be told apart with <command>file -k</command>:
39− </para>
40−
41−<screen>
42−<prompt>$ </prompt>file -k type1.AppImage
43−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,
44−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
45−
46−<prompt>$ </prompt>file -k type2.AppImage
47−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
48−</screen>
49−
50− <para>
51− Note how the type 1 AppImage is described as an <literal>ISO 9660 CD-ROM filesystem</literal>, and the type 2 AppImage is not.
52− </para>
53− </section>
54−
55− <section xml:id="ssec-pkgs-appimageTools-wrapping">
56− <title>Wrapping</title>
57−
58− <para>
59− Depending on the type of AppImage you're wrapping, you'll have to use <varname>wrapType1</varname> or <varname>wrapType2</varname>.
60− </para>
61−
62−<programlisting>
63−appimageTools.wrapType2 { # or wrapType1
64− name = "patchwork"; <co xml:id='ex-appimageTools-wrapping-1' />
65− src = fetchurl { <co xml:id='ex-appimageTools-wrapping-2' />
66− url = "https://github.com/ssbc/patchwork/releases/download/v3.11.4/Patchwork-3.11.4-linux-x86_64.AppImage";
67− sha256 = "1blsprpkvm0ws9b96gb36f0rbf8f5jgmw4x6dsb1kswr4ysf591s";
68− };
69− extraPkgs = pkgs: with pkgs; [ ]; <co xml:id='ex-appimageTools-wrapping-3' />
70−}</programlisting>
71−
72− <calloutlist>
73− <callout arearefs='ex-appimageTools-wrapping-1'>
74− <para>
75− <varname>name</varname> specifies the name of the resulting image.
76− </para>
77− </callout>
78− <callout arearefs='ex-appimageTools-wrapping-2'>
79− <para>
80− <varname>src</varname> specifies the AppImage file to extract.
81− </para>
82− </callout>
83− <callout arearefs='ex-appimageTools-wrapping-3'>
84− <para>
85− <varname>extraPkgs</varname> 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:
86− <itemizedlist>
87− <listitem>
88− <para>
89− Looking through the extracted AppImage files, reading its scripts and running <command>patchelf</command> and <command>ldd</command> on its executables. This can also be done in <command>appimage-run</command>, by setting <command>APPIMAGE_DEBUG_EXEC=bash</command>.
90− </para>
91− </listitem>
92− <listitem>
93− <para>
94− Running <command>strace -vfefile</command> on the wrapped executable, looking for libraries that can't be found.
95− </para>
96− </listitem>
97− </itemizedlist>
98− </para>
99− </callout>
100− </calloutlist>
101− </section>
102−</section>
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/dockertools.xmldeleted−499
@@ -1,499 +0,0 @@
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-pkgs-dockerTools">
5− <title>pkgs.dockerTools</title>
6−
7− <para>
8− <varname>pkgs.dockerTools</varname> is a set of functions for creating and manipulating Docker images according to the <link xlink:href="https://github.com/moby/moby/blob/master/image/spec/v1.2.md#docker-image-specification-v120"> Docker Image Specification v1.2.0 </link>. Docker itself is not used to perform any of the operations done by these functions.
9− </para>
10−
11− <section xml:id="ssec-pkgs-dockerTools-buildImage">
12− <title>buildImage</title>
13−
14− <para>
15− This function is analogous to the <command>docker build</command> 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 <command>docker load</command>.
16− </para>
17−
18− <para>
19− The parameters of <varname>buildImage</varname> with relative example values are described below:
20− </para>
21−
22− <example xml:id='ex-dockerTools-buildImage'>
23− <title>Docker build</title>
24−<programlisting>
25−buildImage {
26− name = "redis"; <co xml:id='ex-dockerTools-buildImage-1' />
27− tag = "latest"; <co xml:id='ex-dockerTools-buildImage-2' />
28−
29− fromImage = someBaseImage; <co xml:id='ex-dockerTools-buildImage-3' />
30− fromImageName = null; <co xml:id='ex-dockerTools-buildImage-4' />
31− fromImageTag = "latest"; <co xml:id='ex-dockerTools-buildImage-5' />
32−
33− contents = pkgs.redis; <co xml:id='ex-dockerTools-buildImage-6' />
34− runAsRoot = '' <co xml:id='ex-dockerTools-buildImage-runAsRoot' />
35− #!${pkgs.runtimeShell}
36− mkdir -p /data
37− '';
38−
39− config = { <co xml:id='ex-dockerTools-buildImage-8' />
40− Cmd = [ "/bin/redis-server" ];
41− WorkingDir = "/data";
42− Volumes = {
43− "/data" = {};
44− };
45− };
46−}
47−</programlisting>
48− </example>
49−
50− <para>
51− The above example will build a Docker image <literal>redis/latest</literal> from the given base image. Loading and running this image in Docker results in <literal>redis-server</literal> being started automatically.
52− </para>
53−
54− <calloutlist>
55− <callout arearefs='ex-dockerTools-buildImage-1'>
56− <para>
57− <varname>name</varname> specifies the name of the resulting image. This is the only required argument for <varname>buildImage</varname>.
58− </para>
59− </callout>
60− <callout arearefs='ex-dockerTools-buildImage-2'>
61− <para>
62− <varname>tag</varname> specifies the tag of the resulting image. By default it's <literal>null</literal>, which indicates that the nix output hash will be used as tag.
63− </para>
64− </callout>
65− <callout arearefs='ex-dockerTools-buildImage-3'>
66− <para>
67− <varname>fromImage</varname> is the repository tarball containing the base image. It must be a valid Docker image, such as exported by <command>docker save</command>. By default it's <literal>null</literal>, which can be seen as equivalent to <literal>FROM scratch</literal> of a <filename>Dockerfile</filename>.
68− </para>
69− </callout>
70− <callout arearefs='ex-dockerTools-buildImage-4'>
71− <para>
72− <varname>fromImageName</varname> can be used to further specify the base image within the repository, in case it contains multiple images. By default it's <literal>null</literal>, in which case <varname>buildImage</varname> will peek the first image available in the repository.
73− </para>
74− </callout>
75− <callout arearefs='ex-dockerTools-buildImage-5'>
76− <para>
77− <varname>fromImageTag</varname> 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 <literal>null</literal>, in which case <varname>buildImage</varname> will peek the first tag available for the base image.
78− </para>
79− </callout>
80− <callout arearefs='ex-dockerTools-buildImage-6'>
81− <para>
82− <varname>contents</varname> is a derivation that will be copied in the new layer of the resulting image. This can be similarly seen as <command>ADD contents/ /</command> in a <filename>Dockerfile</filename>. By default it's <literal>null</literal>.
83− </para>
84− </callout>
85− <callout arearefs='ex-dockerTools-buildImage-runAsRoot'>
86− <para>
87− <varname>runAsRoot</varname> 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 <varname>contents</varname> derivation. This can be similarly seen as <command>RUN ...</command> in a <filename>Dockerfile</filename>.
88− <note>
89− <para>
90− Using this parameter requires the <literal>kvm</literal> device to be available.
91− </para>
92− </note>
93− </para>
94− </callout>
95− <callout arearefs='ex-dockerTools-buildImage-8'>
96− <para>
97− <varname>config</varname> 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 <link xlink:href="https://github.com/moby/moby/blob/master/image/spec/v1.2.md#image-json-field-descriptions"> Docker Image Specification v1.2.0 </link>.
98− </para>
99− </callout>
100− </calloutlist>
101−
102− <para>
103− After the new layer has been created, its closure (to which <varname>contents</varname>, <varname>config</varname> and <varname>runAsRoot</varname> contribute) will be copied in the layer itself. Only new dependencies that are not already in the existing layers will be copied.
104− </para>
105−
106− <para>
107− At the end of the process, only one new single layer will be produced and added to the resulting image.
108− </para>
109−
110− <para>
111− The resulting repository will only list the single image <varname>image/tag</varname>. In the case of <xref linkend='ex-dockerTools-buildImage'/> it would be <varname>redis/latest</varname>.
112− </para>
113−
114− <para>
115− It is possible to inspect the arguments with which an image was built using its <varname>buildArgs</varname> attribute.
116− </para>
117−
118− <note>
119− <para>
120− If you see errors similar to <literal>getProtocolByName: does not exist (no such protocol name: tcp)</literal> you may need to add <literal>pkgs.iana-etc</literal> to <varname>contents</varname>.
121− </para>
122− </note>
123−
124− <note>
125− <para>
126− If you see errors similar to <literal>Error_Protocol ("certificate has unknown CA",True,UnknownCa)</literal> you may need to add <literal>pkgs.cacert</literal> to <varname>contents</varname>.
127− </para>
128− </note>
129−
130− <example xml:id="example-pkgs-dockerTools-buildImage-creation-date">
131− <title>Impurely Defining a Docker Layer's Creation Date</title>
132− <para>
133− By default <function>buildImage</function> will use a static date of one second past the UNIX Epoch. This allows <function>buildImage</function> to produce binary reproducible images. When listing images with <command>docker images</command>, the newly created images will be listed like this:
134− </para>
135−<screen>
136−<prompt>$ </prompt>docker images
137−REPOSITORY TAG IMAGE ID CREATED SIZE
138−hello latest 08c791c7846e 48 years ago 25.2MB
139−</screen>
140− <para>
141− You can break binary reproducibility but have a sorted, meaningful <literal>CREATED</literal> column by setting <literal>created</literal> to <literal>now</literal>.
142− </para>
143−<programlisting><![CDATA[
144−pkgs.dockerTools.buildImage {
145− name = "hello";
146− tag = "latest";
147− created = "now";
148− contents = pkgs.hello;
149−
150− config.Cmd = [ "/bin/hello" ];
151−}
152−]]></programlisting>
153− <para>
154− and now the Docker CLI will display a reasonable date and sort the images as expected:
155−<screen>
156−<prompt>$ </prompt>docker images
157−REPOSITORY TAG IMAGE ID CREATED SIZE
158−hello latest de2bf4786de6 About a minute ago 25.2MB
159−</screen>
160− however, the produced images will not be binary reproducible.
161− </para>
162− </example>
163− </section>
164−
165− <section xml:id="ssec-pkgs-dockerTools-buildLayeredImage">
166− <title>buildLayeredImage</title>
167−
168− <para>
169− 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 <function>streamLayeredImage</function> instead, which this function uses internally.
170− </para>
171−
172− <variablelist>
173− <varlistentry>
174− <term>
175− <varname>name</varname>
176− </term>
177− <listitem>
178− <para>
179− The name of the resulting image.
180− </para>
181− </listitem>
182− </varlistentry>
183− <varlistentry>
184− <term>
185− <varname>tag</varname> <emphasis>optional</emphasis>
186− </term>
187− <listitem>
188− <para>
189− Tag of the generated image.
190− </para>
191− <para>
192− <emphasis>Default:</emphasis> the output path's hash
193− </para>
194− </listitem>
195− </varlistentry>
196− <varlistentry>
197− <term>
198− <varname>contents</varname> <emphasis>optional</emphasis>
199− </term>
200− <listitem>
201− <para>
202− Top level paths in the container. Either a single derivation, or a list of derivations.
203− </para>
204− <para>
205− <emphasis>Default:</emphasis> <literal>[]</literal>
206− </para>
207− </listitem>
208− </varlistentry>
209− <varlistentry>
210− <term>
211− <varname>config</varname> <emphasis>optional</emphasis>
212− </term>
213− <listitem>
214− <para>
215− Run-time configuration of the container. A full list of the options are available at in the <link xlink:href="https://github.com/moby/moby/blob/master/image/spec/v1.2.md#image-json-field-descriptions"> Docker Image Specification v1.2.0 </link>.
216− </para>
217− <para>
218− <emphasis>Default:</emphasis> <literal>{}</literal>
219− </para>
220− </listitem>
221− </varlistentry>
222− <varlistentry>
223− <term>
224− <varname>created</varname> <emphasis>optional</emphasis>
225− </term>
226− <listitem>
227− <para>
228− Date and time the layers were created. Follows the same <literal>now</literal> exception supported by <literal>buildImage</literal>.
229− </para>
230− <para>
231− <emphasis>Default:</emphasis> <literal>1970-01-01T00:00:01Z</literal>
232− </para>
233− </listitem>
234− </varlistentry>
235− <varlistentry>
236− <term>
237− <varname>maxLayers</varname> <emphasis>optional</emphasis>
238− </term>
239− <listitem>
240− <para>
241− Maximum number of layers to create.
242− </para>
243− <para>
244− <emphasis>Default:</emphasis> <literal>100</literal>
245− </para>
246− <para>
247− <emphasis>Maximum:</emphasis> <literal>125</literal>
248− </para>
249− </listitem>
250− </varlistentry>
251− <varlistentry>
252− <term>
253− <varname>extraCommands</varname> <emphasis>optional</emphasis>
254− </term>
255− <listitem>
256− <para>
257− 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.
258− </para>
259− </listitem>
260− </varlistentry>
261− </variablelist>
262−
263− <section xml:id="dockerTools-buildLayeredImage-arg-contents">
264− <title>Behavior of <varname>contents</varname> in the final image</title>
265−
266− <para>
267− Each path directly listed in <varname>contents</varname> will have a symlink in the root of the image.
268− </para>
269−
270− <para>
271− For example:
272−<programlisting><![CDATA[
273−pkgs.dockerTools.buildLayeredImage {
274− name = "hello";
275− contents = [ pkgs.hello ];
276−}
277−]]></programlisting>
278− will create symlinks for all the paths in the <literal>hello</literal> package:
279−<screen><![CDATA[
280−/bin/hello -> /nix/store/h1zb1padqbbb7jicsvkmrym3r6snphxg-hello-2.10/bin/hello
281−/share/info/hello.info -> /nix/store/h1zb1padqbbb7jicsvkmrym3r6snphxg-hello-2.10/share/info/hello.info
282−/share/locale/bg/LC_MESSAGES/hello.mo -> /nix/store/h1zb1padqbbb7jicsvkmrym3r6snphxg-hello-2.10/share/locale/bg/LC_MESSAGES/hello.mo
283−]]></screen>
284− </para>
285− </section>
286−
287− <section xml:id="dockerTools-buildLayeredImage-arg-config">
288− <title>Automatic inclusion of <varname>config</varname> references</title>
289−
290− <para>
291− The closure of <varname>config</varname> is automatically included in the closure of the final image.
292− </para>
293−
294− <para>
295− This allows you to make very simple Docker images with very little code. This container will start up and run <command>hello</command>:
296−<programlisting><![CDATA[
297−pkgs.dockerTools.buildLayeredImage {
298− name = "hello";
299− config.Cmd = [ "${pkgs.hello}/bin/hello" ];
300−}
301−]]></programlisting>
302− </para>
303− </section>
304−
305− <section xml:id="dockerTools-buildLayeredImage-arg-maxLayers">
306− <title>Adjusting <varname>maxLayers</varname></title>
307−
308− <para>
309− Increasing the <varname>maxLayers</varname> increases the number of layers which have a chance to be shared between different images.
310− </para>
311−
312− <para>
313− Modern Docker installations support up to 128 layers, however older versions support as few as 42.
314− </para>
315−
316− <para>
317− If the produced image will not be extended by other Docker builds, it is safe to set <varname>maxLayers</varname> to <literal>128</literal>. However it will be impossible to extend the image further.
318− </para>
319−
320− <para>
321− The first (<literal>maxLayers-2</literal>) most "popular" paths will have their own individual layers, then layer #<literal>maxLayers-1</literal> will contain all the remaining "unpopular" paths, and finally layer #<literal>maxLayers</literal> will contain the Image configuration.
322− </para>
323−
324− <para>
325− Docker's Layers are not inherently ordered, they are content-addressable and are not explicitly layered until they are composed in to an Image.
326− </para>
327− </section>
328− </section>
329−
330− <section xml:id="ssec-pkgs-dockerTools-streamLayeredImage">
331− <title>streamLayeredImage</title>
332−
333− <para>
334− 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 <function>buildLayeredImage</function>. 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.
335− </para>
336−
337− <para>
338− The image produced by running the output script can be piped directly into <command>docker load</command>, to load it into the local docker daemon:
339− <screen><![CDATA[
340−$(nix-build) | docker load
341− ]]></screen>
342− </para>
343− <para>
344− Alternatively, the image be piped via <command>gzip</command> into <command>skopeo</command>, e.g. to copy it into a registry:
345− <screen><![CDATA[
346−$(nix-build) | gzip --fast | skopeo copy docker-archive:/dev/stdin docker://some_docker_registry/myimage:tag
347− ]]></screen>
348− </para>
349− </section>
350−
351− <section xml:id="ssec-pkgs-dockerTools-fetchFromRegistry">
352− <title>pullImage</title>
353−
354− <para>
355− This function is analogous to the <command>docker pull</command> command, in that it can be used to pull a Docker image from a Docker registry. By default <link xlink:href="https://hub.docker.com/">Docker Hub</link> is used to pull images.
356− </para>
357−
358− <para>
359− Its parameters are described in the example below:
360− </para>
361−
362− <example xml:id='ex-dockerTools-pullImage'>
363− <title>Docker pull</title>
364−<programlisting>
365−pullImage {
366− imageName = "nixos/nix"; <co xml:id='ex-dockerTools-pullImage-1' />
367− imageDigest = "sha256:20d9485b25ecfd89204e843a962c1bd70e9cc6858d65d7f5fadc340246e2116b"; <co xml:id='ex-dockerTools-pullImage-2' />
368− finalImageName = "nix"; <co xml:id='ex-dockerTools-pullImage-3' />
369− finalImageTag = "1.11"; <co xml:id='ex-dockerTools-pullImage-4' />
370− sha256 = "0mqjy3zq2v6rrhizgb9nvhczl87lcfphq9601wcprdika2jz7qh8"; <co xml:id='ex-dockerTools-pullImage-5' />
371− os = "linux"; <co xml:id='ex-dockerTools-pullImage-6' />
372− arch = "x86_64"; <co xml:id='ex-dockerTools-pullImage-7' />
373−}
374−</programlisting>
375− </example>
376−
377− <calloutlist>
378− <callout arearefs='ex-dockerTools-pullImage-1'>
379− <para>
380− <varname>imageName</varname> specifies the name of the image to be downloaded, which can also include the registry namespace (e.g. <literal>nixos</literal>). This argument is required.
381− </para>
382− </callout>
383− <callout arearefs='ex-dockerTools-pullImage-2'>
384− <para>
385− <varname>imageDigest</varname> specifies the digest of the image to be downloaded. This argument is required.
386− </para>
387− </callout>
388− <callout arearefs='ex-dockerTools-pullImage-3'>
389− <para>
390− <varname>finalImageName</varname>, 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 <varname>imageName</varname>.
391− </para>
392− </callout>
393− <callout arearefs='ex-dockerTools-pullImage-4'>
394− <para>
395− <varname>finalImageTag</varname>, 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 <literal>latest</literal>.
396− </para>
397− </callout>
398− <callout arearefs='ex-dockerTools-pullImage-5'>
399− <para>
400− <varname>sha256</varname> is the checksum of the whole fetched image. This argument is required.
401− </para>
402− </callout>
403− <callout arearefs='ex-dockerTools-pullImage-6'>
404− <para>
405− <varname>os</varname>, if specified, is the operating system of the fetched image. By default it's <literal>linux</literal>.
406− </para>
407− </callout>
408− <callout arearefs='ex-dockerTools-pullImage-7'>
409− <para>
410− <varname>arch</varname>, if specified, is the cpu architecture of the fetched image. By default it's <literal>x86_64</literal>.
411− </para>
412− </callout>
413− </calloutlist>
414−
415− <para>
416− <literal>nix-prefetch-docker</literal> command can be used to get required image parameters:
417−<screen>
418−<prompt>$ </prompt>nix run nixpkgs.nix-prefetch-docker -c nix-prefetch-docker --image-name mysql --image-tag 5
419−</screen>
420− Since a given <varname>imageName</varname> may transparently refer to a manifest list of images which support multiple architectures and/or operating systems, you can supply the <option>--os</option> and <option>--arch</option> 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.
421−<screen>
422−<prompt>$ </prompt>nix-prefetch-docker --image-name mysql --image-tag 5 --arch x86_64 --os linux
423−</screen>
424− Desired image name and tag can be set using <option>--final-image-name</option> and <option>--final-image-tag</option> arguments:
425−<screen>
426−<prompt>$ </prompt>nix-prefetch-docker --image-name mysql --image-tag 5 --final-image-name eu.gcr.io/my-project/mysql --final-image-tag prod
427−</screen>
428− </para>
429− </section>
430−
431− <section xml:id="ssec-pkgs-dockerTools-exportImage">
432− <title>exportImage</title>
433−
434− <para>
435− This function is analogous to the <command>docker export</command> 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 <command>docker import</command>.
436− </para>
437−
438− <note>
439− <para>
440− Using this function requires the <literal>kvm</literal> device to be available.
441− </para>
442− </note>
443−
444− <para>
445− The parameters of <varname>exportImage</varname> are the following:
446− </para>
447−
448− <example xml:id='ex-dockerTools-exportImage'>
449− <title>Docker export</title>
450−<programlisting>
451−exportImage {
452− fromImage = someLayeredImage;
453− fromImageName = null;
454− fromImageTag = null;
455−
456− name = someLayeredImage.name;
457−}
458−</programlisting>
459− </example>
460−
461− <para>
462− The parameters relative to the base image have the same synopsis as described in <xref linkend='ssec-pkgs-dockerTools-buildImage'/>, except that <varname>fromImage</varname> is the only required argument in this case.
463− </para>
464−
465− <para>
466− The <varname>name</varname> argument is the name of the derivation output, which defaults to <varname>fromImage.name</varname>.
467− </para>
468− </section>
469−
470− <section xml:id="ssec-pkgs-dockerTools-shadowSetup">
471− <title>shadowSetup</title>
472−
473− <para>
474− 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 <varname>runAsRoot</varname> <xref linkend='ex-dockerTools-buildImage-runAsRoot'/> script for cases like in the example below:
475− </para>
476−
477− <example xml:id='ex-dockerTools-shadowSetup'>
478− <title>Shadow base files</title>
479−<programlisting>
480−buildImage {
481− name = "shadow-basic";
482−
483− runAsRoot = ''
484− #!${pkgs.runtimeShell}
485− ${shadowSetup}
486− groupadd -r redis
487− useradd -r -g redis redis
488− mkdir /data
489− chown redis:redis /data
490− '';
491−}
492−</programlisting>
493− </example>
494−
495− <para>
496− Creating base files like <literal>/etc/passwd</literal> or <literal>/etc/login.defs</literal> is necessary for shadow-utils to manipulate users and groups.
497− </para>
498− </section>
499−</section>
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/ocitools.xmldeleted−61
@@ -1,61 +0,0 @@
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-pkgs-ociTools">
5− <title>pkgs.ociTools</title>
6−
7− <para>
8− <varname>pkgs.ociTools</varname> is a set of functions for creating containers according to the <link xlink:href="https://github.com/opencontainers/runtime-spec">OCI container specification v1.0.0</link>. Beyond that it makes no assumptions about the container runner you choose to use to run the created container.
9− </para>
10−
11− <section xml:id="ssec-pkgs-ociTools-buildContainer">
12− <title>buildContainer</title>
13−
14− <para>
15− This function creates a simple OCI container that runs a single command inside of it. An OCI container consists of a <varname>config.json</varname> and a rootfs directory.The nix store of the container will contain all referenced dependencies of the given command.
16− </para>
17−
18− <para>
19− The parameters of <varname>buildContainer</varname> with an example value are described below:
20− </para>
21−
22− <example xml:id='ex-ociTools-buildContainer'>
23− <title>Build Container</title>
24−<programlisting>
25−buildContainer {
26− args = [ (with pkgs; writeScript "run.sh" ''
27− #!${bash}/bin/bash
28− exec ${bash}/bin/bash
29− '').outPath ]; <co xml:id='ex-ociTools-buildContainer-1' />
30−
31− mounts = {
32− "/data" = {
33− type = "none";
34− source = "/var/lib/mydata";
35− options = [ "bind" ];
36− };
37− };<co xml:id='ex-ociTools-buildContainer-2' />
38−
39− readonly = false; <co xml:id='ex-ociTools-buildContainer-3' />
40−}
41−</programlisting>
42− <calloutlist>
43− <callout arearefs='ex-ociTools-buildContainer-1'>
44− <para>
45− <varname>args</varname> specifies a set of arguments to run inside the container. This is the only required argument for <varname>buildContainer</varname>. All referenced packages inside the derivation will be made available inside the container
46− </para>
47− </callout>
48− <callout arearefs='ex-ociTools-buildContainer-2'>
49− <para>
50− <varname>mounts</varname> 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)
51− </para>
52− </callout>
53− <callout arearefs='ex-ociTools-buildContainer-3'>
54− <para>
55− <varname>readonly</varname> makes the container's rootfs read-only if it is set to true. The default value is false <literal>false</literal>.
56− </para>
57− </callout>
58− </calloutlist>
59− </example>
60− </section>
61−</section>
doc/builders/images/snap/example-firefox.nixdeleted−28
@@ -1,28 +0,0 @@
1−let
2− inherit (import <nixpkgs> { }) snapTools firefox;
3−in snapTools.makeSnap {
4− meta = {
5− name = "nix-example-firefox";
6− summary = firefox.meta.description;
7− architectures = [ "amd64" ];
8− apps.nix-example-firefox = {
9− command = "${firefox}/bin/firefox";
10− plugs = [
11− "pulseaudio"
12− "camera"
13− "browser-support"
14− "avahi-observe"
15− "cups-control"
16− "desktop"
17− "desktop-legacy"
18− "gsettings"
19− "home"
20− "network"
21− "mount-observe"
22− "removable-media"
23− "x11"
24− ];
25− };
26− confinement = "strict";
27− };
28−}
doc/builders/images/snap/example-hello.nixdeleted−12
@@ -1,12 +0,0 @@
1−let
2− inherit (import <nixpkgs> { }) snapTools hello;
3−in snapTools.makeSnap {
4− meta = {
5− name = "hello";
6− summary = hello.meta.description;
7− description = hello.meta.longDescription;
8− architectures = [ "amd64" ];
9− confinement = "strict";
10− apps.hello.command = "${hello}/bin/hello";
11− };
12−}
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/images/snaptools.xmldeleted−59
@@ -1,59 +0,0 @@
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-pkgs-snapTools">
5− <title>pkgs.snapTools</title>
6−
7− <para>
8− <varname>pkgs.snapTools</varname> is a set of functions for creating Snapcraft images. Snap and Snapcraft is not used to perform these operations.
9− </para>
10−
11− <section xml:id="ssec-pkgs-snapTools-makeSnap-signature">
12− <title>The makeSnap Function</title>
13−
14− <para>
15− <function>makeSnap</function> takes a single named argument, <parameter>meta</parameter>. This argument mirrors <link xlink:href="https://docs.snapcraft.io/snap-format">the upstream <filename>snap.yaml</filename> format</link> exactly.
16− </para>
17−
18− <para>
19− The <parameter>base</parameter> should not be be specified, as <function>makeSnap</function> will force set it.
20− </para>
21−
22− <para>
23− Currently, <function>makeSnap</function> does not support creating GUI stubs.
24− </para>
25− </section>
26−
27− <section xml:id="ssec-pkgs-snapTools-build-a-snap-hello">
28− <title>Build a Hello World Snap</title>
29−
30− <example xml:id="ex-snapTools-buildSnap-hello">
31− <title>Making a Hello World Snap</title>
32− <para>
33− The following expression packages GNU Hello as a Snapcraft snap.
34− </para>
35−<programlisting><xi:include href="./snap/example-hello.nix" parse="text" /></programlisting>
36− <para>
37− <command>nix-build</command> this expression and install it with <command>snap install ./result --dangerous</command>. <command>hello</command> will now be the Snapcraft version of the package.
38− </para>
39− </example>
40− </section>
41−
42− <section xml:id="ssec-pkgs-snapTools-build-a-snap-firefox">
43− <title>Build a Hello World Snap</title>
44−
45− <example xml:id="ex-snapTools-buildSnap-firefox">
46− <title>Making a Graphical Snap</title>
47− <para>
48− 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.
49− </para>
50−<programlisting><xi:include href="./snap/example-firefox.nix" parse="text" /></programlisting>
51− <para>
52− <command>nix-build</command> this expression and install it with <command>snap install ./result --dangerous</command>. <command>nix-example-firefox</command> will now be the Snapcraft version of the Firefox package.
53− </para>
54− <para>
55− The specific meaning behind plugs can be looked up in the <link xlink:href="https://docs.snapcraft.io/supported-interfaces">Snapcraft interface documentation</link>.
56− </para>
57− </example>
58− </section>
59−</section>
doc/builders/packages/cataclysm-dda.section.md+38−3
@@ -1,6 +1,6 @@
1−# Cataclysm: Dark Days Ahead
1+# Cataclysm: Dark Days Ahead {#cataclysm-dark-days-ahead}
22
3−## How to install Cataclysm DDA
3+## How to install Cataclysm DDA {#how-to-install-cataclysm-dda}
44
55To install the latest stable release of Cataclysm DDA to your profile, execute
66`nix-env -f "<nixpkgs>" -iA cataclysm-dda`. For the curses build (build
@@ -34,7 +34,42 @@ cataclysm-dda.override {
3434}
3535```
3636
37−## Customizing with mods
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}
3873
3974To install Cataclysm DDA with mods of your choice, you can use `withMods`
4075attribute:
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/citrix.xmldeleted−46
@@ -1,46 +0,0 @@
1−<section xmlns="http://docbook.org/ns/docbook"
2− xmlns:xlink="http://www.w3.org/1999/xlink"
3− xml:id="sec-citrix">
4− <title>Citrix Workspace</title>
5−
6− <para>
7− The <link xlink:href="https://www.citrix.com/products/workspace-app/">Citrix Workspace App</link> is a remote desktop viewer which provides access to <link xlink:href="https://www.citrix.com/products/xenapp-xendesktop/">XenDesktop</link> installations.
8− </para>
9−
10− <section xml:id="sec-citrix-base">
11− <title>Basic usage</title>
12−
13− <para>
14− The tarball archive needs to be downloaded manually as the license agreements of the vendor for <link xlink:href="https://www.citrix.de/downloads/workspace-app/linux/workspace-app-for-linux-latest.html">Citrix Workspace</link> needs to be accepted first. Then run <command>nix-prefetch-url file://$PWD/linuxx64-$version.tar.gz</command>. With the archive available in the store the package can be built and installed with Nix.
15− </para>
16− </section>
17−
18− <section xml:id="sec-citrix-selfservice">
19− <title>Citrix Selfservice</title>
20− <para>
21− The <link xlink:href="https://support.citrix.com/article/CTX200337">selfservice</link> is an application managing Citrix desktops and applications. Please note that this feature only works with at least <package>citrix_workspace_20_06_0</package> and later versions.
22− </para>
23− <para>
24− In order to set this up, you first have to <link xlink:href="https://its.uiowa.edu/support/article/102186">download the <literal>.cr</literal> file from the Netscaler Gateway</link>. After that you can configure the <command>selfservice</command> like this:
25−<screen>
26−<prompt>$ </prompt>storebrowse -C ~/Downloads/receiverconfig.cr
27−<prompt>$ </prompt>selfservice
28−</screen>
29− </para>
30− </section>
31−
32− <section xml:id="sec-citrix-custom-certs">
33− <title>Custom certificates</title>
34−
35− <para>
36− The <literal>Citrix Workspace App</literal> in <literal>nixpkgs</literal> trusts several certificates <link xlink:href="https://curl.haxx.se/docs/caextract.html">from the Mozilla database</link> 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 <link xlink:href="https://developer-docs.citrix.com/projects/receiver-for-linux-command-reference/en/13.7/"><literal>$ICAROOT</literal></link>, however this directory is a store path in <literal>nixpkgs</literal>. In order to work around this issue the package provides a simple mechanism to add custom certificates without rebuilding the entire package using <literal>symlinkJoin</literal>:
37−<programlisting>
38−<![CDATA[with import <nixpkgs> { config.allowUnfree = true; };
39−let extraCerts = [ ./custom-cert-1.pem ./custom-cert-2.pem /* ... */ ]; in
40−citrix_workspace.override {
41− inherit extraCerts;
42−}]]>
43−</programlisting>
44− </para>
45− </section>
46−</section>
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/dlib.xmldeleted−24
@@ -1,24 +0,0 @@
1−<section xmlns="http://docbook.org/ns/docbook"
2− xmlns:xlink="http://www.w3.org/1999/xlink"
3− xml:id="dlib">
4− <title>DLib</title>
5−
6− <para>
7− <link xlink:href="http://dlib.net/">DLib</link> is a modern, C++-based toolkit which provides several machine learning algorithms.
8− </para>
9−
10− <section xml:id="compiling-without-avx-support">
11− <title>Compiling without AVX support</title>
12−
13− <para>
14− Especially older CPUs don't support <link xlink:href="https://en.wikipedia.org/wiki/Advanced_Vector_Extensions">AVX</link> (<abbrev>Advanced Vector Extensions</abbrev>) instructions that are used by DLib to optimize their algorithms.
15− </para>
16−
17− <para>
18− On the affected hardware errors like <literal>Illegal instruction</literal> will occur. In those cases AVX support needs to be disabled:
19−<programlisting>self: super: {
20− dlib = super.dlib.override { avxSupport = false; };
21−}</programlisting>
22− </para>
23− </section>
24−</section>
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/eclipse.xmldeleted−72
@@ -1,72 +0,0 @@
1−<section xmlns="http://docbook.org/ns/docbook"
2− xmlns:xlink="http://www.w3.org/1999/xlink"
3− xml:id="sec-eclipse">
4− <title>Eclipse</title>
5−
6− <para>
7− The Nix expressions related to the Eclipse platform and IDE are in <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/editors/eclipse"><filename>pkgs/applications/editors/eclipse</filename></link>.
8− </para>
9−
10− <para>
11− 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:
12−<screen>
13−<prompt>$ </prompt>nix-env -f '<nixpkgs>' -qaP -A eclipses --description
14−</screen>
15− Once an Eclipse variant is installed it can be run using the <command>eclipse</command> 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.
16− </para>
17−
18− <para>
19− 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 <emphasis>Eclipse environment</emphasis>. This type of environment is created using the function <varname>eclipseWithPlugins</varname> found inside the <varname>nixpkgs.eclipses</varname> attribute set. This function takes as argument <literal>{ eclipse, plugins ? [], jvmArgs ? [] }</literal> where <varname>eclipse</varname> is a one of the Eclipse packages described above, <varname>plugins</varname> is a list of plugin derivations, and <varname>jvmArgs</varname> 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
20−<screen>
21−packageOverrides = pkgs: {
22− myEclipse = with pkgs.eclipses; eclipseWithPlugins {
23− eclipse = eclipse-platform;
24− jvmArgs = [ "-Xmx2048m" ];
25− plugins = [ plugins.color-theme ];
26− };
27−}
28−</screen>
29− to your Nixpkgs configuration (<filename>~/.config/nixpkgs/config.nix</filename>) and install it by running <command>nix-env -f '<nixpkgs>' -iA myEclipse</command> and afterward run Eclipse as usual. It is possible to find out which plugins are available for installation using <varname>eclipseWithPlugins</varname> by running
30−<screen>
31−<prompt>$ </prompt>nix-env -f '<nixpkgs>' -qaP -A eclipses.plugins --description
32−</screen>
33− </para>
34−
35− <para>
36− 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 <varname>buildEclipseUpdateSite</varname> and <varname>buildEclipsePlugin</varname> functions found in the <varname>nixpkgs.eclipses.plugins</varname> attribute set. Use the <varname>buildEclipseUpdateSite</varname> function to install a plugin distributed as an Eclipse update site. This function takes <literal>{ name, src }</literal> as argument where <literal>src</literal> 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 <varname>buildEclipsePlugin</varname> function can be used to install a plugin that consists of a pair of feature and plugin JARs. This function takes an argument <literal>{ name, srcFeature, srcPlugin }</literal> where <literal>srcFeature</literal> and <literal>srcPlugin</literal> are the feature and plugin JARs, respectively.
37− </para>
38−
39− <para>
40− Expanding the previous example with two plugins using the above functions we have
41−<screen>
42−packageOverrides = pkgs: {
43− myEclipse = with pkgs.eclipses; eclipseWithPlugins {
44− eclipse = eclipse-platform;
45− jvmArgs = [ "-Xmx2048m" ];
46− plugins = [
47− plugins.color-theme
48− (plugins.buildEclipsePlugin {
49− name = "myplugin1-1.0";
50− srcFeature = fetchurl {
51− url = "http://…/features/myplugin1.jar";
52− sha256 = "123…";
53− };
54− srcPlugin = fetchurl {
55− url = "http://…/plugins/myplugin1.jar";
56− sha256 = "123…";
57− };
58− });
59− (plugins.buildEclipseUpdateSite {
60− name = "myplugin2-1.0";
61− src = fetchurl {
62− stripRoot = false;
63− url = "http://…/myplugin2.zip";
64− sha256 = "123…";
65− };
66− });
67− ];
68− };
69−}
70−</screen>
71− </para>
72−</section>
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/elm.xmldeleted−17
@@ -1,17 +0,0 @@
1−<section xmlns="http://docbook.org/ns/docbook"
2− xmlns:xlink="http://www.w3.org/1999/xlink"
3− xml:id="sec-elm">
4− <title>Elm</title>
5−
6− <para>
7− To start a development environment do <command>nix-shell -p elmPackages.elm elmPackages.elm-format</command>
8− </para>
9−
10− <para>
11− To update Elm compiler, see <filename>nixpkgs/pkgs/development/compilers/elm/README.md</filename>.
12− </para>
13−
14− <para>
15− To package Elm applications, <link xlink:href="https://github.com/hercules-ci/elm2nix#elm2nix">read about elm2nix</link>.
16− </para>
17−</section>
doc/builders/packages/emacs.section.md+8−8
@@ -2,12 +2,12 @@
22
33## Configuring Emacs {#sec-emacs-config}
44
5−The Emacs package comes with some extra helpers to make it easier to configure. `emacsWithPackages` 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:
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:
66
77```nix
88{
99 packageOverrides = pkgs: with pkgs; {
10− myEmacs = emacsWithPackages (epkgs: (with epkgs.melpaStablePackages; [
10+ myEmacs = emacs.pkgs.withPackages (epkgs: (with epkgs.melpaStablePackages; [
1111 company
1212 counsel
1313 flycheck
@@ -20,7 +20,7 @@ The Emacs package comes with some extra helpers to make it easier to configure.
2020}
2121```
2222
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 provide a `default.el` file in `/share/emacs/site-start/`. Emacs knows to load this file automatically when it starts.
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.
2424
2525```nix
2626{
@@ -36,7 +36,7 @@ You can install it like any other packages via `nix-env -iA myEmacs`. However, t
3636 ;; load some packages
3737
3838 (use-package company
39− :bind ("<C-tab>" . company-complete)
39+ :bind ("<C-tab>" . company-complete)
4040 :diminish company-mode
4141 :commands (company-mode global-company-mode)
4242 :defer 1
@@ -84,7 +84,7 @@ You can install it like any other packages via `nix-env -iA myEmacs`. However, t
8484 (projectile-global-mode))
8585 '';
8686
87− myEmacs = emacsWithPackages (epkgs: (with epkgs.melpaStablePackages; [
87+ myEmacs = emacs.pkgs.withPackages (epkgs: (with epkgs.melpaStablePackages; [
8888 (runCommand "default.el" {} ''
8989 mkdir -p $out/share/emacs/site-lisp
9090 cp ${myEmacsConfig} $out/share/emacs/site-lisp/default.el
@@ -101,16 +101,16 @@ You can install it like any other packages via `nix-env -iA myEmacs`. However, t
101101}
102102```
103103
104−This provides a fairly full Emacs start file. It will load in addition to the user's presonal config. You can always disable it by passing `-q` to the Emacs command.
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.
105105
106−Sometimes `emacsWithPackages` 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 this priorities when some package is installed as a dependency. You can override it on 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'`.
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'`.
107107
108108```nix
109109overrides = self: super: rec {
110110 haskell-mode = self.melpaPackages.haskell-mode;
111111 ...
112112};
113−((emacsPackagesGen emacs).overrideScope' overrides).emacsWithPackages
113+((emacsPackagesFor emacs).overrideScope' overrides).withPackages
114114 (p: with p; [
115115 # here both these package will use haskell-mode of our own choice
116116 ghc-mod
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.md+10−8
@@ -1,12 +1,13 @@
11# Firefox {#sec-firefox}
22
3−## Build wrapped Firefox with extensions and policies
3+## Build wrapped Firefox with extensions and policies {#build-wrapped-firefox-with-extensions-and-policies}
44
5−The `wrapFirefox` function allows to pass policies, preferences and extension that are available to firefox. With the help of `fetchFirefoxAddon` this allows build a firefox version that already comes with addons pre-installed:
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:
66
77```nix
88{
9− myFirefox = wrapFirefox firefox-unwrapped {
9+ # Nix firefox addons only work with the firefox-esr package.
10+ myFirefox = wrapFirefox firefox-esr-unwrapped {
1011 nixExtensions = [
1112 (fetchFirefoxAddon {
1213 name = "ublock"; # Has to be unique!
@@ -39,11 +40,12 @@ The `wrapFirefox` function allows to pass policies, preferences and extension th
3940}
4041```
4142
42−If `nixExtensions != null` then all manually installed addons will be uninstalled from your browser profile.
43−To view available enterprise policies visit [enterprise policies](https://github.com/mozilla/policy-templates#enterprisepoliciesenabled)
44−or type into the Firefox url bar: `about:policies#documentation`.
45−Nix installed addons do not have a valid signature, which is why signature verification is disabled. This does not compromise security because downloaded addons are checksumed and manual addons can't be installed. Also make sure that the `name` field of fetchFirefoxAddon is unique. If you remove an addon from the nixExtensions array, rebuild and start Firefox the removed addon will be completly removed with all of its settings.
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.
4647
4748## Troubleshooting {#sec-firefox-troubleshooting}
48−If addons do not appear installed although they have been defined in your nix configuration file reset the local addon state of your Firefox profile by clicking `help -> restart with addons disabled -> restart -> refresh firefox`. This can happen if you switch from manual addon mode to nix addon mode and then back to manual mode and then again to nix addon mode.
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.
4950
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/ibus.xmldeleted−57
@@ -1,57 +0,0 @@
1−<section xmlns="http://docbook.org/ns/docbook"
2− xmlns:xlink="http://www.w3.org/1999/xlink"
3− xml:id="sec-ibus-typing-booster">
4− <title>ibus-engines.typing-booster</title>
5−
6− <para>
7− This package is an ibus-based completion method to speed up typing.
8− </para>
9−
10− <section xml:id="sec-ibus-typing-booster-activate">
11− <title>Activating the engine</title>
12−
13− <para>
14− IBus needs to be configured accordingly to activate <literal>typing-booster</literal>. The configuration depends on the desktop manager in use. For detailed instructions, please refer to the <link xlink:href="https://mike-fabian.github.io/ibus-typing-booster/documentation.html">upstream docs</link>.
15− </para>
16−
17− <para>
18− On NixOS you need to explicitly enable <literal>ibus</literal> with given engines before customizing your desktop to use <literal>typing-booster</literal>. This can be achieved using the <literal>ibus</literal> module:
19−<programlisting>{ pkgs, ... }: {
20− i18n.inputMethod = {
21− enabled = "ibus";
22− ibus.engines = with pkgs.ibus-engines; [ typing-booster ];
23− };
24−}</programlisting>
25− </para>
26− </section>
27−
28− <section xml:id="sec-ibus-typing-booster-customize-hunspell">
29− <title>Using custom hunspell dictionaries</title>
30−
31− <para>
32− The IBus engine is based on <literal>hunspell</literal> to support completion in many languages. By default the dictionaries <literal>de-de</literal>, <literal>en-us</literal>, <literal>fr-moderne</literal> <literal>es-es</literal>, <literal>it-it</literal>, <literal>sv-se</literal> and <literal>sv-fi</literal> are in use. To add another dictionary, the package can be overridden like this:
33−<programlisting>ibus-engines.typing-booster.override {
34− langs = [ "de-at" "en-gb" ];
35−}</programlisting>
36− </para>
37−
38− <para>
39− <emphasis>Note: each language passed to <literal>langs</literal> must be an attribute name in <literal>pkgs.hunspellDicts</literal>.</emphasis>
40− </para>
41− </section>
42−
43− <section xml:id="sec-ibus-typing-booster-emoji-picker">
44− <title>Built-in emoji picker</title>
45−
46− <para>
47− The <literal>ibus-engines.typing-booster</literal> package contains a program named <literal>emoji-picker</literal>. To display all emojis correctly, a special font such as <literal>noto-fonts-emoji</literal> is needed:
48− </para>
49−
50− <para>
51− On NixOS it can be installed using the following expression:
52−<programlisting>{ pkgs, ... }: {
53− fonts.fonts = with pkgs; [ noto-fonts-emoji ];
54−}</programlisting>
55− </para>
56− </section>
57−</section>
doc/builders/packages/index.xml+8−5
@@ -5,16 +5,19 @@
55 <para>
66 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.
77 </para>
8− <xi:include href="citrix.xml" />
9− <xi:include href="dlib.xml" />
10− <xi:include href="eclipse.xml" />
11− <xi:include href="elm.xml" />
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" />
1212 <xi:include href="emacs.section.xml" />
1313 <xi:include href="firefox.section.xml" />
14− <xi:include href="ibus.xml" />
14+ <xi:include href="fish.section.xml" />
15+ <xi:include href="fuse.section.xml" />
16+ <xi:include href="ibus.section.xml" />
1517 <xi:include href="kakoune.section.xml" />
1618 <xi:include href="linux.section.xml" />
1719 <xi:include href="locales.section.xml" />
20+ <xi:include href="etc-files.section.xml" />
1821 <xi:include href="nginx.section.xml" />
1922 <xi:include href="opengl.section.xml" />
2023 <xi:include href="shell-helpers.section.xml" />
doc/builders/packages/linux.section.md+11−11
@@ -4,7 +4,7 @@ The Nix expressions to build the Linux kernel are in [`pkgs/os-specific/linux/ke
44
55The 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`).
66
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:
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:
88
99```nix
1010modulesTree = [kernel]
@@ -14,28 +14,28 @@ modulesTree = [kernel]
1414
1515How to add a new (major) version of the Linux kernel to Nixpkgs:
1616
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.
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.
1818
19−2. Add the new kernel to `all-packages.nix` (e.g., create an attribute `kernel_2_6_22`).
19+2. Add the new kernel to the `kernels` attribute set in `linux-kernels.nix` (e.g., create an attribute `kernel_2_6_22`).
2020
21213. 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:
2222
23− 1. Make an 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`).
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`).
2424
25− 2. Copy the config file for this platform (e.g. `config-2.6.22-i686-smp`) to `.config` in the kernel source tree.
25+ 2. Copy the config file for this platform (e.g., `config-2.6.22-i686-smp`) to `.config` in the kernel source tree.
2626
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`).
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`).
2828
29− 4. If needed you can also run `make menuconfig`:
29+ 4. If needed, you can also run `make menuconfig`:
3030
3131 ```ShellSession
32− $ nix-env -i ncurses
32+ $ nix-env -f "<nixpkgs>" -iA ncurses
3333 $ export NIX_CFLAGS_LINK=-lncurses
3434 $ make menuconfig ARCH=arch
3535 ```
3636
37− 5. Copy `.config` over the new config file (e.g. `config-2.6.22-i686-smp`).
37+ 5. Copy `.config` over the new config file (e.g., `config-2.6.22-i686-smp`).
3838
39−4. Test building the kernel: `nix-build -A kernel_2_6_22`. If it compiles, ship it! For extra credit, try booting NixOS with it.
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.
4040
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 `all-packages.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.
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.md+2−2
@@ -1,5 +1,5 @@
11# Locales {#locales}
22
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.
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.
44
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.
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.md+2−2
@@ -4,8 +4,8 @@
44
55## ETags on static files served from the Nix store {#sec-nginx-etag}
66
7−HTTP has a couple 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).
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).
88
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.
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.
1010
1111As 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.md+3−3
@@ -4,12 +4,12 @@ OpenGL support varies depending on which hardware is used and which drivers are
44
55Broadly, we support both GL vendors: Mesa and NVIDIA.
66
7−## NixOS Desktop
7+## NixOS Desktop {#nixos-desktop}
88
99The 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.
1010
11−## Nix on GNU/Linux
11+## Nix on GNU/Linux {#nix-on-gnulinux}
1212
1313If 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.
1414
15−For proprietary video drivers you might have luck with also adding the corresponding video driver package.
15+For proprietary video drivers, you might have luck with also adding the corresponding video driver package.
doc/builders/packages/shell-helpers.section.md+1−1
@@ -4,7 +4,7 @@ Some packages provide the shell integration to be more useful. But unlike other
44
55- `fzf` : `fzf-share`
66
7−E.g. `fzf` can then used in the `.bashrc` like this:
7+E.g. `fzf` can then be used in the `.bashrc` like this:
88
99```bash
1010source "$(fzf-share)/completion.bash"
doc/builders/packages/steam.section.md+17−23
@@ -2,24 +2,25 @@
22
33## Steam in Nix {#sec-steam-nix}
44
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.
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`.
66
77Nix problems and constraints:
88
9−- We don't have `/bin/bash` and many scripts point there. Similarly for `/usr/bin/python`.
9+- We don't have `/bin/bash` and many scripts point there. Same thing for `/usr/bin/python`.
1010- We don't have the dynamic loader in `/lib`.
11−- The `steam.sh` script in \$HOME can not be patched, as it is checked and rewritten by steam.
11+- The `steam.sh` script in `$HOME` cannot be patched, as it is checked and rewritten by steam.
1212- The steam binary cannot be patched, it's also checked.
1313
1414The 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.
1515
1616## How to play {#sec-steam-play}
1717
18−Use `programs.steam.enable = true;` if you want to add steam to systemPackages and also enable a few workarrounds aswell as Steam controller support or other Steam supported controllers such as the DualShock 4 or Nintendo Switch Pr.
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.
1919
2020## Troubleshooting {#sec-steam-troub}
2121
2222- **Steam fails to start. What do I do?**
23+
2324 Try to run
2425
2526 ```ShellSession
@@ -31,38 +32,31 @@ Use `programs.steam.enable = true;` if you want to add steam to systemPackages a
3132- **Using the FOSS Radeon or nouveau (nvidia) drivers**
3233
3334 - The `newStdcpp` parameter was removed since NixOS 17.09 and should not be needed anymore.
34− - Steam ships statically linked with a version of libcrypto that conflics with the one dynamically loaded by radeonsi_dri.so. If you get the error
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+
3537 ```
3638 steam.sh: line 713: 7842 Segmentation fault (core dumped)
3739 ```
40+
3841 have a look at [this pull request](https://github.com/NixOS/nixpkgs/pull/20269).
3942
4043- **Java**
4144
42− 1. There is no java in steam chrootenv by default. If you get a message like
45+ 1. There is no java in steam chrootenv by default. If you get a message like:
4346
44− ```
45− /home/foo/.local/share/Steam/SteamApps/common/towns/towns.sh: line 1: java: command not found
46− ```
47+ ```
48+ /home/foo/.local/share/Steam/SteamApps/common/towns/towns.sh: line 1: java: command not found
49+ ```
4750
48− You need to add
51+ you need to add:
4952
50− ```nix
51− steam.override { withJava = true; };
52− ```
53+ ```nix
54+ steam.override { withJava = true; };
55+ ```
5356
5457## steam-run {#sec-steam-run}
5558
56−The FHS-compatible chroot used for steam can also be used to run other linux games that expect a FHS environment. To do it, add
57−
58−```nix
59−pkgs.steam.override ({
60− nativeOnly = true;
61− newStdcpp = true;
62− }).run
63−```
64−
65−to your configuration, rebuild, and run the game with
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:
6660
6761```
6862steam-run ./foo
doc/builders/packages/urxvt.section.md+4−4
@@ -4,7 +4,7 @@ Urxvt, also known as rxvt-unicode, is a highly customizable terminal emulator.
44
55## Configuring urxvt {#sec-urxvt-conf}
66
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
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:
88
99```nix
1010rxvt-unicode.override {
@@ -58,14 +58,14 @@ rxvt-unicode.override {
5858
5959## Packaging urxvt plugins {#sec-urxvt-pkg}
6060
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`.
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`.
6262
6363A 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.
6464
65−If the plugin is itself a perl package that needs to be imported from other plugins or scripts, add the following passthrough:
65+If the plugin is itself a Perl package that needs to be imported from other plugins or scripts, add the following passthrough:
6666
6767```nix
6868passthru.perlPackages = [ "self" ];
6969```
7070
71−This will make the urxvt wrapper pick up the dependency and set up the perl path accordingly.
71+This will make the urxvt wrapper pick up the dependency and set up the Perl path accordingly.
doc/builders/packages/weechat.section.md+6−6
@@ -1,6 +1,6 @@
1−# Weechat {#sec-weechat}
1+# WeeChat {#sec-weechat}
22
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
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:
44
55```nix
66weechat.override {configure = {availablePlugins, ...}: {
@@ -13,7 +13,7 @@ If the `configure` function returns an attrset without the `plugins` attribute,
1313
1414The plugins currently available are `python`, `perl`, `ruby`, `guile`, `tcl` and `lua`.
1515
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:
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:
1717
1818```nix
1919weechat.override { configure = {availablePlugins, ...}: {
@@ -41,7 +41,7 @@ weechat.override {
4141 configure = { availablePlugins, ... }: {
4242 init = ''
4343 /set foo bar
44− /server add freenode chat.freenode.org
44+ /server add libera irc.libera.chat
4545 '';
4646 };
4747}
@@ -49,7 +49,7 @@ weechat.override {
4949
5050Further values can be added to the list of commands when running `weechat --run-command "your-commands"`.
5151
52−Additionally it's possible to specify scripts to be loaded when starting `weechat`. These will be loaded before the commands from `init`:
52+Additionally, it's possible to specify scripts to be loaded when starting `weechat`. These will be loaded before the commands from `init`:
5353
5454```nix
5555weechat.override {
@@ -64,7 +64,7 @@ weechat.override {
6464}
6565```
6666
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:
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:
6868
6969```nix
7070{ stdenv, fetchurl }:
doc/builders/packages/xorg.section.md+4−4
@@ -2,7 +2,7 @@
22
33The 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.
44
5−## Katamari Tarballs
5+## Katamari Tarballs {#katamari-tarballs}
66
77X.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:
88
@@ -14,11 +14,11 @@ cat $(PRINT_PATH=1 nix-prefetch-url $url | tail -n 1) \
1414 | sort > "tarballs-$release.list"
1515```
1616
17−## Individual Tarballs
17+## Individual Tarballs {#individual-tarballs}
1818
1919The 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`.
2020
21−## Generating Nix Expressions
21+## Generating Nix Expressions {#generating-nix-expressions}
2222
2323The generator is invoked as follows:
2424
@@ -29,6 +29,6 @@ cd pkgs/servers/x11/xorg
2929
3030For 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.)
3131
32−## Overriding the Generator
32+## Overriding the Generator {#overriding-the-generator}
3333
3434If 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/fhs-environments.section.md+6−2
@@ -18,6 +18,8 @@
1818 Additional commands to be executed for finalizing the derivation with runner script.
1919- `runScript`
2020 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.
2123
2224One can create a simple environment using a `shell.nix` like that:
2325
@@ -28,7 +30,7 @@ One can create a simple environment using a `shell.nix` like that:
2830 name = "simple-x11-env";
2931 targetPkgs = pkgs: (with pkgs;
3032 [ udev
31− alsaLib
33+ alsa-lib
3234 ]) ++ (with pkgs.xorg;
3335 [ libX11
3436 libXcursor
@@ -36,10 +38,12 @@ One can create a simple environment using a `shell.nix` like that:
3638 ]);
3739 multiPkgs = pkgs: (with pkgs;
3840 [ udev
39− alsaLib
41+ alsa-lib
4042 ]);
4143 runScript = "bash";
4244}).env
4345```
4446
4547Running `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.md+27−5
@@ -1,15 +1,37 @@
11# pkgs.mkShell {#sec-pkgs-mkShell}
22
3−`pkgs.mkShell` is a special kind of derivation that is only useful when using it combined with `nix-shell`. It will in fact fail to instantiate when invoked with `nix-build`.
3+`pkgs.mkShell` is a specialized `stdenv.mkDerivation` that removes some
4+repetition when using it with `nix-shell` (or `nix develop`).
45
56## Usage {#sec-pkgs-mkShell-usage}
67
8+Here is a common usage example:
9+
710```nix
811{ pkgs ? import <nixpkgs> {} }:
912pkgs.mkShell {
10− # this will make all the build inputs from hello and gnutar
11− # available to the shell environment
12− inputsFrom = with pkgs; [ hello gnutar ];
13− buildInputs = [ pkgs.gnumake ];
13+ packages = [ pkgs.gnumake ];
14+
15+ inputsFrom = [ pkgs.hello pkgs.gnutar ];
16+
17+ shellHook = ''
18+ export DEBUG=1
19+ '';
1420}
1521```
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.md+173−2
@@ -35,10 +35,10 @@ This works just like `runCommand`. The only difference is that it also provides
3535
3636## `runCommandLocal` {#trivial-builder-runCommandLocal}
3737
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 roundrip and can speed up a build.
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.
3939
4040::: {.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`.
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`.
4242:::
4343
4444## `writeTextFile`, `writeText`, `writeTextDir`, `writeScript`, `writeScriptBin` {#trivial-builder-writeText}
@@ -47,6 +47,177 @@ These functions write `text` to the Nix store. This is useful for creating scrip
4747
4848Many more commands wrap `writeTextFile` including `writeText`, `writeTextDir`, `writeScript`, and `writeScriptBin`. These are convenience functions over `writeTextFile`.
4949
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+
50154## `symlinkJoin` {#trivial-builder-symlinkJoin}
51155
52156This 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/coding-conventions.xmldeleted−934
@@ -1,934 +0,0 @@
1−<chapter xmlns="http://docbook.org/ns/docbook"
2− xmlns:xlink="http://www.w3.org/1999/xlink"
3− xml:id="chap-conventions">
4− <title>Coding conventions</title>
5− <section xml:id="sec-syntax">
6− <title>Syntax</title>
7−
8− <itemizedlist>
9− <listitem>
10− <para>
11− Use 2 spaces of indentation per indentation level in Nix expressions, 4 spaces in shell scripts.
12− </para>
13− </listitem>
14− <listitem>
15− <para>
16− Do not use tab characters, i.e. configure your editor to use soft tabs. For instance, use <literal>(setq-default indent-tabs-mode nil)</literal> in Emacs. Everybody has different tab settings so it’s asking for trouble.
17− </para>
18− </listitem>
19− <listitem>
20− <para>
21− Use <literal>lowerCamelCase</literal> for variable names, not <literal>UpperCamelCase</literal>. Note, this rule does not apply to package attribute names, which instead follow the rules in <xref linkend="sec-package-naming"/>.
22− </para>
23− </listitem>
24− <listitem>
25− <para>
26− Function calls with attribute set arguments are written as
27−<programlisting>
28−foo {
29− arg = ...;
30−}
31−</programlisting>
32− not
33−<programlisting>
34−foo
35−{
36− arg = ...;
37−}
38−</programlisting>
39− Also fine is
40−<programlisting>
41−foo { arg = ...; }
42−</programlisting>
43− if it's a short call.
44− </para>
45− </listitem>
46− <listitem>
47− <para>
48− In attribute sets or lists that span multiple lines, the attribute names or list elements should be aligned:
49−<programlisting>
50−# A long list.
51−list = [
52− elem1
53− elem2
54− elem3
55−];
56−
57−# A long attribute set.
58−attrs = {
59− attr1 = short_expr;
60− attr2 =
61− if true then big_expr else big_expr;
62−};
63−
64−# Combined
65−listOfAttrs = [
66− {
67− attr1 = 3;
68− attr2 = "fff";
69− }
70− {
71− attr1 = 5;
72− attr2 = "ggg";
73− }
74−];
75−</programlisting>
76− </para>
77− </listitem>
78− <listitem>
79− <para>
80− Short lists or attribute sets can be written on one line:
81−<programlisting>
82−# A short list.
83−list = [ elem1 elem2 elem3 ];
84−
85−# A short set.
86−attrs = { x = 1280; y = 1024; };
87−</programlisting>
88− </para>
89− </listitem>
90− <listitem>
91− <para>
92− Breaking in the middle of a function argument can give hard-to-read code, like
93−<programlisting>
94−someFunction { x = 1280;
95− y = 1024; } otherArg
96− yetAnotherArg
97−</programlisting>
98− (especially if the argument is very large, spanning multiple lines).
99− </para>
100− <para>
101− Better:
102−<programlisting>
103−someFunction
104− { x = 1280; y = 1024; }
105− otherArg
106− yetAnotherArg
107−</programlisting>
108− or
109−<programlisting>
110−let res = { x = 1280; y = 1024; };
111−in someFunction res otherArg yetAnotherArg
112−</programlisting>
113− </para>
114− </listitem>
115− <listitem>
116− <para>
117− The bodies of functions, asserts, and withs are not indented to prevent a lot of superfluous indentation levels, i.e.
118−<programlisting>
119−{ arg1, arg2 }:
120−assert system == "i686-linux";
121−stdenv.mkDerivation { ...
122−</programlisting>
123− not
124−<programlisting>
125−{ arg1, arg2 }:
126− assert system == "i686-linux";
127− stdenv.mkDerivation { ...
128−</programlisting>
129− </para>
130− </listitem>
131− <listitem>
132− <para>
133− Function formal arguments are written as:
134−<programlisting>
135−{ arg1, arg2, arg3 }:
136−</programlisting>
137− but if they don't fit on one line they're written as:
138−<programlisting>
139−{ arg1, arg2, arg3
140−, arg4, ...
141−, # Some comment...
142− argN
143−}:
144−</programlisting>
145− </para>
146− </listitem>
147− <listitem>
148− <para>
149− Functions should list their expected arguments as precisely as possible. That is, write
150−<programlisting>
151−{ stdenv, fetchurl, perl }: <replaceable>...</replaceable>
152−</programlisting>
153− instead of
154−<programlisting>
155−args: with args; <replaceable>...</replaceable>
156−</programlisting>
157− or
158−<programlisting>
159−{ stdenv, fetchurl, perl, ... }: <replaceable>...</replaceable>
160−</programlisting>
161− </para>
162− <para>
163− For functions that are truly generic in the number of arguments (such as wrappers around <varname>mkDerivation</varname>) that have some required arguments, you should write them using an <literal>@</literal>-pattern:
164−<programlisting>
165−{ stdenv, doCoverageAnalysis ? false, ... } @ args:
166−
167−stdenv.mkDerivation (args // {
168− <replaceable>...</replaceable> if doCoverageAnalysis then "bla" else "" <replaceable>...</replaceable>
169−})
170−</programlisting>
171− instead of
172−<programlisting>
173−args:
174−
175−args.stdenv.mkDerivation (args // {
176− <replaceable>...</replaceable> if args ? doCoverageAnalysis && args.doCoverageAnalysis then "bla" else "" <replaceable>...</replaceable>
177−})
178−</programlisting>
179− </para>
180− </listitem>
181− </itemizedlist>
182− </section>
183− <section xml:id="sec-package-naming">
184− <title>Package naming</title>
185−
186− <para>
187− The key words <emphasis>must</emphasis>, <emphasis>must not</emphasis>, <emphasis>required</emphasis>, <emphasis>shall</emphasis>, <emphasis>shall not</emphasis>, <emphasis>should</emphasis>, <emphasis>should not</emphasis>, <emphasis>recommended</emphasis>, <emphasis>may</emphasis>, and <emphasis>optional</emphasis> in this section are to be interpreted as described in <link xlink:href="https://tools.ietf.org/html/rfc2119">RFC 2119</link>. Only <emphasis>emphasized</emphasis> words are to be interpreted in this way.
188− </para>
189−
190− <para>
191− In Nixpkgs, there are generally three different names associated with a package:
192− <itemizedlist>
193− <listitem>
194− <para>
195− The <varname>name</varname> attribute of the derivation (excluding the version part). This is what most users see, in particular when using <command>nix-env</command>.
196− </para>
197− </listitem>
198− <listitem>
199− <para>
200− The variable name used for the instantiated package in <filename>all-packages.nix</filename>, and when passing it as a dependency to other functions. Typically this is called the <emphasis>package attribute name</emphasis>. This is what Nix expression authors see. It can also be used when installing using <command>nix-env -iA</command>.
201− </para>
202− </listitem>
203− <listitem>
204− <para>
205− The filename for (the directory containing) the Nix expression.
206− </para>
207− </listitem>
208− </itemizedlist>
209− Most of the time, these are the same. For instance, the package <literal>e2fsprogs</literal> has a <varname>name</varname> attribute <literal>"e2fsprogs-<replaceable>version</replaceable>"</literal>, is bound to the variable name <varname>e2fsprogs</varname> in <filename>all-packages.nix</filename>, and the Nix expression is in <filename>pkgs/os-specific/linux/e2fsprogs/default.nix</filename>.
210− </para>
211−
212− <para>
213− There are a few naming guidelines:
214− <itemizedlist>
215− <listitem>
216− <para>
217− The <literal>name</literal> attribute <emphasis>should</emphasis> be identical to the upstream package name.
218− </para>
219− </listitem>
220− <listitem>
221− <para>
222− The <literal>name</literal> attribute <emphasis>must not</emphasis> contain uppercase letters — e.g., <literal>"mplayer-1.0rc2"</literal> instead of <literal>"MPlayer-1.0rc2"</literal>.
223− </para>
224− </listitem>
225− <listitem>
226− <para>
227− The version part of the <literal>name</literal> attribute <emphasis>must</emphasis> start with a digit (following a dash) — e.g., <literal>"hello-0.3.1rc2"</literal>.
228− </para>
229− </listitem>
230− <listitem>
231− <para>
232− If a package is not a release but a commit from a repository, then the version part of the name <emphasis>must</emphasis> be the date of that (fetched) commit. The date <emphasis>must</emphasis> be in <literal>"YYYY-MM-DD"</literal> format. Also append <literal>"unstable"</literal> to the name - e.g., <literal>"pkgname-unstable-2014-09-23"</literal>.
233− </para>
234− </listitem>
235− <listitem>
236− <para>
237− Dashes in the package name <emphasis>should</emphasis> be preserved in new variable names, rather than converted to underscores or camel cased — e.g., <varname>http-parser</varname> instead of <varname>http_parser</varname> or <varname>httpParser</varname>. The hyphenated style is preferred in all three package names.
238− </para>
239− </listitem>
240− <listitem>
241− <para>
242− If there are multiple versions of a package, this <emphasis>should</emphasis> be reflected in the variable names in <filename>all-packages.nix</filename>, e.g. <varname>json-c-0-9</varname> and <varname>json-c-0-11</varname>. If there is an obvious “default” version, make an attribute like <literal>json-c = json-c-0-9;</literal>. See also <xref linkend="sec-versioning" />
243− </para>
244− </listitem>
245− </itemizedlist>
246− </para>
247− </section>
248− <section xml:id="sec-organisation">
249− <title>File naming and organisation</title>
250−
251− <para>
252− Names of files and directories should be in lowercase, with dashes between words — not in camel case. For instance, it should be <filename>all-packages.nix</filename>, not <filename>allPackages.nix</filename> or <filename>AllPackages.nix</filename>.
253− </para>
254−
255− <section xml:id="sec-hierarchy">
256− <title>Hierarchy</title>
257−
258− <para>
259− Each package should be stored in its own directory somewhere in the <filename>pkgs/</filename> tree, i.e. in <filename>pkgs/<replaceable>category</replaceable>/<replaceable>subcategory</replaceable>/<replaceable>...</replaceable>/<replaceable>pkgname</replaceable></filename>. Below are some rules for picking the right category for a package. Many packages fall under several categories; what matters is the <emphasis>primary</emphasis> purpose of a package. For example, the <literal>libxml2</literal> package builds both a library and some tools; but it’s a library foremost, so it goes under <filename>pkgs/development/libraries</filename>.
260− </para>
261−
262− <para>
263− When in doubt, consider refactoring the <filename>pkgs/</filename> tree, e.g. creating new categories or splitting up an existing category.
264− </para>
265−
266− <variablelist>
267− <varlistentry>
268− <term>
269− If it’s used to support <emphasis>software development</emphasis>:
270− </term>
271− <listitem>
272− <variablelist>
273− <varlistentry>
274− <term>
275− If it’s a <emphasis>library</emphasis> used by other packages:
276− </term>
277− <listitem>
278− <para>
279− <filename>development/libraries</filename> (e.g. <filename>libxml2</filename>)
280− </para>
281− </listitem>
282− </varlistentry>
283− <varlistentry>
284− <term>
285− If it’s a <emphasis>compiler</emphasis>:
286− </term>
287− <listitem>
288− <para>
289− <filename>development/compilers</filename> (e.g. <filename>gcc</filename>)
290− </para>
291− </listitem>
292− </varlistentry>
293− <varlistentry>
294− <term>
295− If it’s an <emphasis>interpreter</emphasis>:
296− </term>
297− <listitem>
298− <para>
299− <filename>development/interpreters</filename> (e.g. <filename>guile</filename>)
300− </para>
301− </listitem>
302− </varlistentry>
303− <varlistentry>
304− <term>
305− If it’s a (set of) development <emphasis>tool(s)</emphasis>:
306− </term>
307− <listitem>
308− <variablelist>
309− <varlistentry>
310− <term>
311− If it’s a <emphasis>parser generator</emphasis> (including lexers):
312− </term>
313− <listitem>
314− <para>
315− <filename>development/tools/parsing</filename> (e.g. <filename>bison</filename>, <filename>flex</filename>)
316− </para>
317− </listitem>
318− </varlistentry>
319− <varlistentry>
320− <term>
321− If it’s a <emphasis>build manager</emphasis>:
322− </term>
323− <listitem>
324− <para>
325− <filename>development/tools/build-managers</filename> (e.g. <filename>gnumake</filename>)
326− </para>
327− </listitem>
328− </varlistentry>
329− <varlistentry>
330− <term>
331− Else:
332− </term>
333− <listitem>
334− <para>
335− <filename>development/tools/misc</filename> (e.g. <filename>binutils</filename>)
336− </para>
337− </listitem>
338− </varlistentry>
339− </variablelist>
340− </listitem>
341− </varlistentry>
342− <varlistentry>
343− <term>
344− Else:
345− </term>
346− <listitem>
347− <para>
348− <filename>development/misc</filename>
349− </para>
350− </listitem>
351− </varlistentry>
352− </variablelist>
353− </listitem>
354− </varlistentry>
355− <varlistentry>
356− <term>
357− If it’s a (set of) <emphasis>tool(s)</emphasis>:
358− </term>
359− <listitem>
360− <para>
361− (A tool is a relatively small program, especially one intended to be used non-interactively.)
362− </para>
363− <variablelist>
364− <varlistentry>
365− <term>
366− If it’s for <emphasis>networking</emphasis>:
367− </term>
368− <listitem>
369− <para>
370− <filename>tools/networking</filename> (e.g. <filename>wget</filename>)
371− </para>
372− </listitem>
373− </varlistentry>
374− <varlistentry>
375− <term>
376− If it’s for <emphasis>text processing</emphasis>:
377− </term>
378− <listitem>
379− <para>
380− <filename>tools/text</filename> (e.g. <filename>diffutils</filename>)
381− </para>
382− </listitem>
383− </varlistentry>
384− <varlistentry>
385− <term>
386− If it’s a <emphasis>system utility</emphasis>, i.e., something related or essential to the operation of a system:
387− </term>
388− <listitem>
389− <para>
390− <filename>tools/system</filename> (e.g. <filename>cron</filename>)
391− </para>
392− </listitem>
393− </varlistentry>
394− <varlistentry>
395− <term>
396− If it’s an <emphasis>archiver</emphasis> (which may include a compression function):
397− </term>
398− <listitem>
399− <para>
400− <filename>tools/archivers</filename> (e.g. <filename>zip</filename>, <filename>tar</filename>)
401− </para>
402− </listitem>
403− </varlistentry>
404− <varlistentry>
405− <term>
406− If it’s a <emphasis>compression</emphasis> program:
407− </term>
408− <listitem>
409− <para>
410− <filename>tools/compression</filename> (e.g. <filename>gzip</filename>, <filename>bzip2</filename>)
411− </para>
412− </listitem>
413− </varlistentry>
414− <varlistentry>
415− <term>
416− If it’s a <emphasis>security</emphasis>-related program:
417− </term>
418− <listitem>
419− <para>
420− <filename>tools/security</filename> (e.g. <filename>nmap</filename>, <filename>gnupg</filename>)
421− </para>
422− </listitem>
423− </varlistentry>
424− <varlistentry>
425− <term>
426− Else:
427− </term>
428− <listitem>
429− <para>
430− <filename>tools/misc</filename>
431− </para>
432− </listitem>
433− </varlistentry>
434− </variablelist>
435− </listitem>
436− </varlistentry>
437− <varlistentry>
438− <term>
439− If it’s a <emphasis>shell</emphasis>:
440− </term>
441− <listitem>
442− <para>
443− <filename>shells</filename> (e.g. <filename>bash</filename>)
444− </para>
445− </listitem>
446− </varlistentry>
447− <varlistentry>
448− <term>
449− If it’s a <emphasis>server</emphasis>:
450− </term>
451− <listitem>
452− <variablelist>
453− <varlistentry>
454− <term>
455− If it’s a web server:
456− </term>
457− <listitem>
458− <para>
459− <filename>servers/http</filename> (e.g. <filename>apache-httpd</filename>)
460− </para>
461− </listitem>
462− </varlistentry>
463− <varlistentry>
464− <term>
465− If it’s an implementation of the X Windowing System:
466− </term>
467− <listitem>
468− <para>
469− <filename>servers/x11</filename> (e.g. <filename>xorg</filename> — this includes the client libraries and programs)
470− </para>
471− </listitem>
472− </varlistentry>
473− <varlistentry>
474− <term>
475− Else:
476− </term>
477− <listitem>
478− <para>
479− <filename>servers/misc</filename>
480− </para>
481− </listitem>
482− </varlistentry>
483− </variablelist>
484− </listitem>
485− </varlistentry>
486− <varlistentry>
487− <term>
488− If it’s a <emphasis>desktop environment</emphasis>:
489− </term>
490− <listitem>
491− <para>
492− <filename>desktops</filename> (e.g. <filename>kde</filename>, <filename>gnome</filename>, <filename>enlightenment</filename>)
493− </para>
494− </listitem>
495− </varlistentry>
496− <varlistentry>
497− <term>
498− If it’s a <emphasis>window manager</emphasis>:
499− </term>
500− <listitem>
501− <para>
502− <filename>applications/window-managers</filename> (e.g. <filename>awesome</filename>, <filename>stumpwm</filename>)
503− </para>
504− </listitem>
505− </varlistentry>
506− <varlistentry>
507− <term>
508− If it’s an <emphasis>application</emphasis>:
509− </term>
510− <listitem>
511− <para>
512− A (typically large) program with a distinct user interface, primarily used interactively.
513− </para>
514− <variablelist>
515− <varlistentry>
516− <term>
517− If it’s a <emphasis>version management system</emphasis>:
518− </term>
519− <listitem>
520− <para>
521− <filename>applications/version-management</filename> (e.g. <filename>subversion</filename>)
522− </para>
523− </listitem>
524− </varlistentry>
525− <varlistentry>
526− <term>
527− If it’s a <emphasis>terminal emulator</emphasis>:
528− </term>
529− <listitem>
530− <para>
531− <filename>applications/terminal-emulators</filename> (e.g. <filename>alacritty</filename> or <filename>rxvt</filename> or <filename>termite</filename>)
532− </para>
533− </listitem>
534− </varlistentry>
535− <varlistentry>
536− <term>
537− If it’s for <emphasis>video playback / editing</emphasis>:
538− </term>
539− <listitem>
540− <para>
541− <filename>applications/video</filename> (e.g. <filename>vlc</filename>)
542− </para>
543− </listitem>
544− </varlistentry>
545− <varlistentry>
546− <term>
547− If it’s for <emphasis>graphics viewing / editing</emphasis>:
548− </term>
549− <listitem>
550− <para>
551− <filename>applications/graphics</filename> (e.g. <filename>gimp</filename>)
552− </para>
553− </listitem>
554− </varlistentry>
555− <varlistentry>
556− <term>
557− If it’s for <emphasis>networking</emphasis>:
558− </term>
559− <listitem>
560− <variablelist>
561− <varlistentry>
562− <term>
563− If it’s a <emphasis>mailreader</emphasis>:
564− </term>
565− <listitem>
566− <para>
567− <filename>applications/networking/mailreaders</filename> (e.g. <filename>thunderbird</filename>)
568− </para>
569− </listitem>
570− </varlistentry>
571− <varlistentry>
572− <term>
573− If it’s a <emphasis>newsreader</emphasis>:
574− </term>
575− <listitem>
576− <para>
577− <filename>applications/networking/newsreaders</filename> (e.g. <filename>pan</filename>)
578− </para>
579− </listitem>
580− </varlistentry>
581− <varlistentry>
582− <term>
583− If it’s a <emphasis>web browser</emphasis>:
584− </term>
585− <listitem>
586− <para>
587− <filename>applications/networking/browsers</filename> (e.g. <filename>firefox</filename>)
588− </para>
589− </listitem>
590− </varlistentry>
591− <varlistentry>
592− <term>
593− Else:
594− </term>
595− <listitem>
596− <para>
597− <filename>applications/networking/misc</filename>
598− </para>
599− </listitem>
600− </varlistentry>
601− </variablelist>
602− </listitem>
603− </varlistentry>
604− <varlistentry>
605− <term>
606− Else:
607− </term>
608− <listitem>
609− <para>
610− <filename>applications/misc</filename>
611− </para>
612− </listitem>
613− </varlistentry>
614− </variablelist>
615− </listitem>
616− </varlistentry>
617− <varlistentry>
618− <term>
619− If it’s <emphasis>data</emphasis> (i.e., does not have a straight-forward executable semantics):
620− </term>
621− <listitem>
622− <variablelist>
623− <varlistentry>
624− <term>
625− If it’s a <emphasis>font</emphasis>:
626− </term>
627− <listitem>
628− <para>
629− <filename>data/fonts</filename>
630− </para>
631− </listitem>
632− </varlistentry>
633− <varlistentry>
634− <term>
635− If it’s an <emphasis>icon theme</emphasis>:
636− </term>
637− <listitem>
638− <para>
639− <filename>data/icons</filename>
640− </para>
641− </listitem>
642− </varlistentry>
643− <varlistentry>
644− <term>
645− If it’s related to <emphasis>SGML/XML processing</emphasis>:
646− </term>
647− <listitem>
648− <variablelist>
649− <varlistentry>
650− <term>
651− If it’s an <emphasis>XML DTD</emphasis>:
652− </term>
653− <listitem>
654− <para>
655− <filename>data/sgml+xml/schemas/xml-dtd</filename> (e.g. <filename>docbook</filename>)
656− </para>
657− </listitem>
658− </varlistentry>
659− <varlistentry>
660− <term>
661− If it’s an <emphasis>XSLT stylesheet</emphasis>:
662− </term>
663− <listitem>
664− <para>
665− (Okay, these are executable...)
666− </para>
667− <para>
668− <filename>data/sgml+xml/stylesheets/xslt</filename> (e.g. <filename>docbook-xsl</filename>)
669− </para>
670− </listitem>
671− </varlistentry>
672− </variablelist>
673− </listitem>
674− </varlistentry>
675− <varlistentry>
676− <term>
677− If it’s a <emphasis>theme</emphasis> for a <emphasis>desktop environment</emphasis>,
678− a <emphasis>window manager</emphasis> or a <emphasis>display manager</emphasis>:
679− </term>
680− <listitem>
681− <para>
682− <filename>data/themes</filename>
683− </para>
684− </listitem>
685− </varlistentry>
686− </variablelist>
687− </listitem>
688− </varlistentry>
689− <varlistentry>
690− <term>
691− If it’s a <emphasis>game</emphasis>:
692− </term>
693− <listitem>
694− <para>
695− <filename>games</filename>
696− </para>
697− </listitem>
698− </varlistentry>
699− <varlistentry>
700− <term>
701− Else:
702− </term>
703− <listitem>
704− <para>
705− <filename>misc</filename>
706− </para>
707− </listitem>
708− </varlistentry>
709− </variablelist>
710− </section>
711−
712− <section xml:id="sec-versioning">
713− <title>Versioning</title>
714−
715− <para>
716− 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.
717− </para>
718−
719− <para>
720− If there is only one version of a package, its Nix expression should be named <filename>e2fsprogs/default.nix</filename>. If there are multiple versions, this should be reflected in the filename, e.g. <filename>e2fsprogs/1.41.8.nix</filename> and <filename>e2fsprogs/1.41.9.nix</filename>. 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 <filename>firefox/2.0.nix</filename> and <filename>firefox/3.5.nix</filename>, respectively (which, at a given point, might contain versions <literal>2.0.0.20</literal> and <literal>3.5.4</literal>). If a version requires many auxiliary files, you can use a subdirectory for each version, e.g. <filename>firefox/2.0/default.nix</filename> and <filename>firefox/3.5/default.nix</filename>.
721− </para>
722−
723− <para>
724− All versions of a package <emphasis>must</emphasis> be included in <filename>all-packages.nix</filename> to make sure that they evaluate correctly.
725− </para>
726− </section>
727− </section>
728− <section xml:id="sec-sources">
729− <title>Fetching Sources</title>
730−
731− <para>
732− 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 <literal>fetchurl</literal>. Note that you should also prefer protocols which have a corresponding proxy environment variable.
733− </para>
734−
735− <para>
736− You can find many source fetch helpers in <literal>pkgs/build-support/fetch*</literal>.
737− </para>
738−
739− <para>
740− In the file <literal>pkgs/top-level/all-packages.nix</literal> you can find fetch helpers, these have names on the form <literal>fetchFrom*</literal>. The intention of these are to provide snapshot fetches but using the same api as some of the version controlled fetchers from <literal>pkgs/build-support/</literal>. As an example going from bad to good:
741− <itemizedlist>
742− <listitem>
743− <para>
744− Bad: Uses <literal>git://</literal> which won't be proxied.
745−<programlisting>
746−src = fetchgit {
747− url = "git://github.com/NixOS/nix.git";
748− rev = "1f795f9f44607cc5bec70d1300150bfefcef2aae";
749− sha256 = "1cw5fszffl5pkpa6s6wjnkiv6lm5k618s32sp60kvmvpy7a2v9kg";
750−}
751−</programlisting>
752− </para>
753− </listitem>
754− <listitem>
755− <para>
756− Better: This is ok, but an archive fetch will still be faster.
757−<programlisting>
758−src = fetchgit {
759− url = "https://github.com/NixOS/nix.git";
760− rev = "1f795f9f44607cc5bec70d1300150bfefcef2aae";
761− sha256 = "1cw5fszffl5pkpa6s6wjnkiv6lm5k618s32sp60kvmvpy7a2v9kg";
762−}
763−</programlisting>
764− </para>
765− </listitem>
766− <listitem>
767− <para>
768− Best: Fetches a snapshot archive and you get the rev you want.
769−<programlisting>
770−src = fetchFromGitHub {
771− owner = "NixOS";
772− repo = "nix";
773− rev = "1f795f9f44607cc5bec70d1300150bfefcef2aae";
774− sha256 = "1i2yxndxb6yc9l6c99pypbd92lfq5aac4klq7y2v93c9qvx2cgpc";
775−}
776−</programlisting>
777− Find the value to put as <literal>sha256</literal> by running <literal>nix run -f '<nixpkgs>' nix-prefetch-github -c nix-prefetch-github --rev 1f795f9f44607cc5bec70d1300150bfefcef2aae NixOS nix</literal> or <literal>nix-prefetch-url --unpack https://github.com/NixOS/nix/archive/1f795f9f44607cc5bec70d1300150bfefcef2aae.tar.gz</literal>.
778− </para>
779− </listitem>
780− </itemizedlist>
781− </para>
782− </section>
783− <section xml:id="sec-source-hashes">
784− <title>Obtaining source hash</title>
785−
786− <para>
787− Preferred source hash type is sha256. There are several ways to get it.
788− </para>
789−
790− <orderedlist>
791− <listitem>
792− <para>
793− Prefetch URL (with <literal>nix-prefetch-<replaceable>XXX</replaceable> <replaceable>URL</replaceable></literal>, where <replaceable>XXX</replaceable> is one of <literal>url</literal>, <literal>git</literal>, <literal>hg</literal>, <literal>cvs</literal>, <literal>bzr</literal>, <literal>svn</literal>). Hash is printed to stdout.
794− </para>
795− </listitem>
796− <listitem>
797− <para>
798− Prefetch by package source (with <literal>nix-prefetch-url '<nixpkgs>' -A <replaceable>PACKAGE</replaceable>.src</literal>, where <replaceable>PACKAGE</replaceable> is package attribute name). Hash is printed to stdout.
799− </para>
800− <para>
801− 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 (<literal>.srcs</literal>, architecture-dependent sources, etc).
802− </para>
803− </listitem>
804− <listitem>
805− <para>
806− Upstream provided hash: use it when upstream provides <literal>sha256</literal> or <literal>sha512</literal> (when upstream provides <literal>md5</literal>, don't use it, compute <literal>sha256</literal> instead).
807− </para>
808− <para>
809− A little nuance is that <literal>nix-prefetch-*</literal> tools produce hash encoded with <literal>base32</literal>, but upstream usually provides hexadecimal (<literal>base16</literal>) encoding. Fetchers understand both formats. Nixpkgs does not standardize on any one format.
810− </para>
811− <para>
812− You can convert between formats with nix-hash, for example:
813−<screen>
814−<prompt>$ </prompt>nix-hash --type sha256 --to-base32 <replaceable>HASH</replaceable>
815−</screen>
816− </para>
817− </listitem>
818− <listitem>
819− <para>
820− Extracting hash from local source tarball can be done with <literal>sha256sum</literal>. Use <literal>nix-prefetch-url file:///path/to/tarball </literal> if you want base32 hash.
821− </para>
822− </listitem>
823− <listitem>
824− <para>
825− Fake hash: set fake hash in package expression, perform build and extract correct hash from error Nix prints.
826− </para>
827− <para>
828− For package updates it is enough to change one symbol to make hash fake. For new packages, you can use <literal>lib.fakeSha256</literal>, <literal>lib.fakeSha512</literal> or any other fake hash.
829− </para>
830− <para>
831− This is last resort method when reconstructing source URL is non-trivial and <literal>nix-prefetch-url -A</literal> isn't applicable (for example, <link xlink:href="https://github.com/NixOS/nixpkgs/blob/d2ab091dd308b99e4912b805a5eb088dd536adb9/pkgs/applications/video/kodi/default.nix#L73"> one of <literal>kodi</literal> dependencies</link>). 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.
832− </para>
833− <warning>
834− <para>
835− This method has security problems. Check below for details.
836− </para>
837− </warning>
838− </listitem>
839− </orderedlist>
840−
841− <section xml:id="sec-source-hashes-security">
842− <title>Obtaining hashes securely</title>
843−
844− <para>
845− 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:
846− </para>
847−
848− <itemizedlist>
849− <listitem>
850− <para>
851− <literal>http://</literal> URLs are not secure to prefetch hash from;
852− </para>
853− </listitem>
854− <listitem>
855− <para>
856− hashes from upstream (in method 3) should be obtained via secure protocol;
857− </para>
858− </listitem>
859− <listitem>
860− <para>
861− <literal>https://</literal> URLs are secure in methods 1, 2, 3;
862− </para>
863− </listitem>
864− <listitem>
865− <para>
866− <literal>https://</literal> 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 <literal>https://</literal> URL and prefetch it with method 1.
867− </para>
868− </listitem>
869− </itemizedlist>
870− </section>
871− </section>
872− <section xml:id="sec-patches">
873− <title>Patches</title>
874−
875− <para>
876− Patches available online should be retrieved using <literal>fetchpatch</literal>.
877− </para>
878−
879− <para>
880−<programlisting>
881−patches = [
882− (fetchpatch {
883− name = "fix-check-for-using-shared-freetype-lib.patch";
884− url = "http://git.ghostscript.com/?p=ghostpdl.git;a=patch;h=8f5d285";
885− sha256 = "1f0k043rng7f0rfl9hhb89qzvvksqmkrikmm38p61yfx51l325xr";
886− })
887−];
888−</programlisting>
889− </para>
890−
891− <para>
892− Otherwise, you can add a <literal>.patch</literal> file to the <literal>nixpkgs</literal> repository. In the interest of keeping our maintenance burden to a minimum, only patches that are unique to <literal>nixpkgs</literal> should be added in this way.
893− </para>
894−
895− <para>
896−<programlisting>
897−patches = [ ./0001-changes.patch ];
898−</programlisting>
899− </para>
900−
901− <para>
902− If you do need to do create this sort of patch file, one way to do so is with git:
903− <orderedlist>
904− <listitem>
905− <para>
906− Move to the root directory of the source code you're patching.
907−<screen>
908−<prompt>$ </prompt>cd the/program/source</screen>
909− </para>
910− </listitem>
911− <listitem>
912− <para>
913− If a git repository is not already present, create one and stage all of the source files.
914−<screen>
915−<prompt>$ </prompt>git init
916−<prompt>$ </prompt>git add .</screen>
917− </para>
918− </listitem>
919− <listitem>
920− <para>
921− Edit some files to make whatever changes need to be included in the patch.
922− </para>
923− </listitem>
924− <listitem>
925− <para>
926− Use git to create a diff, and pipe the output to a patch file:
927−<screen>
928−<prompt>$ </prompt>git diff > nixpkgs/pkgs/the/package/0001-changes.patch</screen>
929− </para>
930− </listitem>
931− </orderedlist>
932− </para>
933− </section>
934−</chapter>
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/contributing-to-documentation.xmldeleted−30
@@ -1,30 +0,0 @@
1−<chapter xmlns="http://docbook.org/ns/docbook"
2− xmlns:xlink="http://www.w3.org/1999/xlink"
3− xml:id="chap-contributing">
4− <title>Contributing to this documentation</title>
5− <para>
6− The DocBook sources of the Nixpkgs manual are in the <filename
7−xlink:href="https://github.com/NixOS/nixpkgs/tree/master/doc">doc</filename> subdirectory of the Nixpkgs repository.
8− </para>
9− <para>
10− You can quickly check your edits with <command>make</command>:
11− </para>
12−<screen>
13−<prompt>$ </prompt>cd /path/to/nixpkgs/doc
14−<prompt>$ </prompt>nix-shell
15−<prompt>[nix-shell]$ </prompt>make
16−</screen>
17− <para>
18− If you experience problems, run <command>make debug</command> to help understand the docbook errors.
19− </para>
20− <para>
21− After making modifications to the manual, it's important to build it before committing. You can do that as follows:
22−<screen>
23−<prompt>$ </prompt>cd /path/to/nixpkgs/doc
24−<prompt>$ </prompt>nix-shell
25−<prompt>[nix-shell]$ </prompt>make clean
26−<prompt>[nix-shell]$ </prompt>nix-build .
27−</screen>
28− If the build succeeds, the manual will be in <filename>./result/share/doc/nixpkgs/manual.html</filename>.
29− </para>
30−</chapter>
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/quick-start.xmldeleted−152
@@ -1,152 +0,0 @@
1−<chapter xmlns="http://docbook.org/ns/docbook"
2− xmlns:xlink="http://www.w3.org/1999/xlink"
3− xml:id="chap-quick-start">
4− <title>Quick Start to Adding a Package</title>
5− <para>
6− To add a package to Nixpkgs:
7− <orderedlist>
8− <listitem>
9− <para>
10− Checkout the Nixpkgs source tree:
11−<screen>
12−<prompt>$ </prompt>git clone https://github.com/NixOS/nixpkgs
13−<prompt>$ </prompt>cd nixpkgs</screen>
14− </para>
15− </listitem>
16− <listitem>
17− <para>
18− Find a good place in the Nixpkgs tree to add the Nix expression for your package. For instance, a library package typically goes into <filename>pkgs/development/libraries/<replaceable>pkgname</replaceable></filename>, while a web browser goes into <filename>pkgs/applications/networking/browsers/<replaceable>pkgname</replaceable></filename>. See <xref linkend="sec-organisation" /> for some hints on the tree organisation. Create a directory for your package, e.g.
19−<screen>
20−<prompt>$ </prompt>mkdir pkgs/development/libraries/libfoo</screen>
21− </para>
22− </listitem>
23− <listitem>
24− <para>
25− 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 <emphasis>function</emphasis> 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 <filename>default.nix</filename>.
26−<screen>
27−<prompt>$ </prompt>emacs pkgs/development/libraries/libfoo/default.nix
28−<prompt>$ </prompt>git add pkgs/development/libraries/libfoo/default.nix</screen>
29− </para>
30− <para>
31− You can have a look at the existing Nix expressions under <filename>pkgs/</filename> to see how it’s done. Here are some good ones:
32− <itemizedlist>
33− <listitem>
34− <para>
35− GNU Hello: <link
36− xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/misc/hello/default.nix"><filename>pkgs/applications/misc/hello/default.nix</filename></link>. Trivial package, which specifies some <varname>meta</varname> attributes which is good practice.
37− </para>
38− </listitem>
39− <listitem>
40− <para>
41− GNU cpio: <link
42− xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/archivers/cpio/default.nix"><filename>pkgs/tools/archivers/cpio/default.nix</filename></link>. Also a simple package. The generic builder in <varname>stdenv</varname> does everything for you. It has no dependencies beyond <varname>stdenv</varname>.
43− </para>
44− </listitem>
45− <listitem>
46− <para>
47− GNU Multiple Precision arithmetic library (GMP): <link
48− xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/libraries/gmp/5.1.x.nix"><filename>pkgs/development/libraries/gmp/5.1.x.nix</filename></link>. Also done by the generic builder, but has a dependency on <varname>m4</varname>.
49− </para>
50− </listitem>
51− <listitem>
52− <para>
53− Pan, a GTK-based newsreader: <link
54− xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/networking/newsreaders/pan/default.nix"><filename>pkgs/applications/networking/newsreaders/pan/default.nix</filename></link>. Has an optional dependency on <varname>gtkspell</varname>, which is only built if <varname>spellCheck</varname> is <literal>true</literal>.
55− </para>
56− </listitem>
57− <listitem>
58− <para>
59− Apache HTTPD: <link
60− xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/servers/http/apache-httpd/2.4.nix"><filename>pkgs/servers/http/apache-httpd/2.4.nix</filename></link>. A bunch of optional features, variable substitutions in the configure flags, a post-install hook, and miscellaneous hackery.
61− </para>
62− </listitem>
63− <listitem>
64− <para>
65− Thunderbird: <link
66− xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/networking/mailreaders/thunderbird/default.nix"><filename>pkgs/applications/networking/mailreaders/thunderbird/default.nix</filename></link>. Lots of dependencies.
67− </para>
68− </listitem>
69− <listitem>
70− <para>
71− JDiskReport, a Java utility: <link
72− xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/jdiskreport/default.nix"><filename>pkgs/tools/misc/jdiskreport/default.nix</filename></link>. Nixpkgs doesn’t have a decent <varname>stdenv</varname> for Java yet so this is pretty ad-hoc.
73− </para>
74− </listitem>
75− <listitem>
76− <para>
77− XML::Simple, a Perl module: <link
78− xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/top-level/perl-packages.nix"><filename>pkgs/top-level/perl-packages.nix</filename></link> (search for the <varname>XMLSimple</varname> attribute). Most Perl modules are so simple to build that they are defined directly in <filename>perl-packages.nix</filename>; no need to make a separate file for them.
79− </para>
80− </listitem>
81− <listitem>
82− <para>
83− Adobe Reader: <link
84− xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/misc/adobe-reader/default.nix"><filename>pkgs/applications/misc/adobe-reader/default.nix</filename></link>. Shows how binary-only packages can be supported. In particular the <link
85− xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/misc/adobe-reader/builder.sh">builder</link> uses <command>patchelf</command> to set the RUNPATH and ELF interpreter of the executables so that the right libraries are found at runtime.
86− </para>
87− </listitem>
88− </itemizedlist>
89− </para>
90− <para>
91− Some notes:
92− <itemizedlist>
93− <listitem>
94− <para>
95− All <varname linkend="chap-meta">meta</varname> attributes are optional, but it’s still a good idea to provide at least the <varname>description</varname>, <varname>homepage</varname> and <varname
96− linkend="sec-meta-license">license</varname>.
97− </para>
98− </listitem>
99− <listitem>
100− <para>
101− You can use <command>nix-prefetch-url</command> <replaceable>url</replaceable> to get the SHA-256 hash of source distributions. There are similar commands as <command>nix-prefetch-git</command> and <command>nix-prefetch-hg</command> available in <literal>nix-prefetch-scripts</literal> package.
102− </para>
103− </listitem>
104− <listitem>
105− <para>
106− A list of schemes for <literal>mirror://</literal> URLs can be found in <link
107− xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/build-support/fetchurl/mirrors.nix"><filename>pkgs/build-support/fetchurl/mirrors.nix</filename></link>.
108− </para>
109− </listitem>
110− </itemizedlist>
111− </para>
112− <para>
113− The exact syntax and semantics of the Nix expression language, including the built-in function, are described in the Nix manual in the <link
114− xlink:href="https://hydra.nixos.org/job/nix/trunk/tarball/latest/download-by-type/doc/manual/#chap-writing-nix-expressions">chapter on writing Nix expressions</link>.
115− </para>
116− </listitem>
117− <listitem>
118− <para>
119− Add a call to the function defined in the previous step to <link
120− xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/top-level/all-packages.nix"><filename>pkgs/top-level/all-packages.nix</filename></link> with some descriptive name for the variable, e.g. <varname>libfoo</varname>.
121−<screen>
122−<prompt>$ </prompt>emacs pkgs/top-level/all-packages.nix</screen>
123− </para>
124− <para>
125− 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.
126− </para>
127− </listitem>
128− <listitem>
129− <para>
130− To test whether the package builds, run the following command from the root of the nixpkgs source tree:
131−<screen>
132−<prompt>$ </prompt>nix-build -A libfoo</screen>
133− where <varname>libfoo</varname> should be the variable name defined in the previous step. You may want to add the flag <option>-K</option> to keep the temporary build directory in case something fails. If the build succeeds, a symlink <filename>./result</filename> to the package in the Nix store is created.
134− </para>
135− </listitem>
136− <listitem>
137− <para>
138− If you want to install the package into your profile (optional), do
139−<screen>
140−<prompt>$ </prompt>nix-env -f . -iA libfoo</screen>
141− </para>
142− </listitem>
143− <listitem>
144− <para>
145− Optionally commit the new package and open a pull request <link
146− xlink:href="https://github.com/NixOS/nixpkgs/pulls">to nixpkgs</link>, or use <link
147− xlink:href="https://discourse.nixos.org/t/about-the-patches-category/477"> the Patches category</link> on Discourse for sending a patch without a GitHub account.
148− </para>
149− </listitem>
150− </orderedlist>
151− </para>
152−</chapter>
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/reviewing-contributions.xmldeleted−488
@@ -1,488 +0,0 @@
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− version="5.0"
5− xml:id="chap-reviewing-contributions">
6− <title>Reviewing contributions</title>
7− <warning>
8− <para>
9− The following section is a draft, and the policy for reviewing is still being discussed in issues such as <link
10− xlink:href="https://github.com/NixOS/nixpkgs/issues/11166">#11166 </link> and <link
11− xlink:href="https://github.com/NixOS/nixpkgs/issues/20836">#20836 </link>.
12− </para>
13− </warning>
14− <para>
15− 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.
16− </para>
17− <para>
18− 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 <link
19− xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc">most recently</link> and the <link
20− xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-asc">least recently</link> updated pull requests. We highly encourage looking at <link xlink:href="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"> this list of ready to merge, unreviewed pull requests</link>.
21− </para>
22− <para>
23− 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.
24− </para>
25− <para>
26− 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.
27− </para>
28− <para>
29− 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.
30− </para>
31− <para>
32− 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.
33− </para>
34− <section xml:id="reviewing-contributions-package-updates">
35− <title>Package updates</title>
36−
37− <para>
38− 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.
39− </para>
40−
41− <para>
42− It can happen that non-trivial updates include patches or more complex changes.
43− </para>
44−
45− <para>
46− Reviewing process:
47− </para>
48−
49− <itemizedlist>
50− <listitem>
51− <para>
52− Ensure that the package versioning fits the guidelines.
53− </para>
54− </listitem>
55− <listitem>
56− <para>
57− Ensure that the commit text fits the guidelines.
58− </para>
59− </listitem>
60− <listitem>
61− <para>
62− Ensure that the package maintainers are notified.
63− </para>
64− <itemizedlist>
65− <listitem>
66− <para>
67− <link xlink:href="https://help.github.com/articles/about-codeowners/">CODEOWNERS</link> will make GitHub notify users based on the submitted changes, but it can happen that it misses some of the package maintainers.
68− </para>
69− </listitem>
70− </itemizedlist>
71− </listitem>
72− <listitem>
73− <para>
74− Ensure that the meta field information is correct.
75− </para>
76− <itemizedlist>
77− <listitem>
78− <para>
79− License can change with version updates, so it should be checked to match the upstream license.
80− </para>
81− </listitem>
82− <listitem>
83− <para>
84− 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.
85− </para>
86− </listitem>
87− </itemizedlist>
88− </listitem>
89− <listitem>
90− <para>
91− Ensure that the code contains no typos.
92− </para>
93− </listitem>
94− <listitem>
95− <para>
96− Building the package locally.
97− </para>
98− <itemizedlist>
99− <listitem>
100− <para>
101− 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.
102− </para>
103− <para>
104− 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.
105−<screen>
106−<prompt>$ </prompt>git fetch origin nixos-unstable <co xml:id='reviewing-rebase-2' />
107−<prompt>$ </prompt>git fetch origin pull/PRNUMBER/head <co xml:id='reviewing-rebase-3' />
108−<prompt>$ </prompt>git rebase --onto nixos-unstable BASEBRANCH FETCH_HEAD <co
109− xml:id='reviewing-rebase-4' />
110−</screen>
111− <calloutlist>
112− <callout arearefs='reviewing-rebase-2'>
113− <para>
114− Fetching the nixos-unstable branch.
115− </para>
116− </callout>
117− <callout arearefs='reviewing-rebase-3'>
118− <para>
119− Fetching the pull request changes, <varname>PRNUMBER</varname> is the number at the end of the pull request title and <varname>BASEBRANCH</varname> the base branch of the pull request.
120− </para>
121− </callout>
122− <callout arearefs='reviewing-rebase-4'>
123− <para>
124− Rebasing the pull request changes to the nixos-unstable branch.
125− </para>
126− </callout>
127− </calloutlist>
128− </para>
129− </listitem>
130− <listitem>
131− <para>
132− The <link xlink:href="https://github.com/Mic92/nixpkgs-review">nixpkgs-review</link> tool can be used to review a pull request content in a single command. <varname>PRNUMBER</varname> should be replaced by the number at the end of the pull request title. You can also provide the full github pull request url.
133− </para>
134−<screen>
135−<prompt>$ </prompt>nix-shell -p nixpkgs-review --run "nixpkgs-review pr PRNUMBER"
136−</screen>
137− </listitem>
138− </itemizedlist>
139− </listitem>
140− <listitem>
141− <para>
142− Running every binary.
143− </para>
144− </listitem>
145− </itemizedlist>
146−
147− <example xml:id="reviewing-contributions-sample-package-update">
148− <title>Sample template for a package update review</title>
149−<screen>
150−##### Reviewed points
151−
152−- [ ] package name fits guidelines
153−- [ ] package version fits guidelines
154−- [ ] package build on ARCHITECTURE
155−- [ ] executables tested on ARCHITECTURE
156−- [ ] all depending packages build
157−
158−##### Possible improvements
159−
160−##### Comments
161−
162−</screen>
163− </example>
164− </section>
165− <section xml:id="reviewing-contributions-new-packages">
166− <title>New packages</title>
167−
168− <para>
169− New packages are a common type of pull requests. These pull requests consists in adding a new nix-expression for a package.
170− </para>
171−
172− <para>
173− Reviewing process:
174− </para>
175−
176− <itemizedlist>
177− <listitem>
178− <para>
179− Ensure that the package versioning is fitting the guidelines.
180− </para>
181− </listitem>
182− <listitem>
183− <para>
184− Ensure that the commit name is fitting the guidelines.
185− </para>
186− </listitem>
187− <listitem>
188− <para>
189− Ensure that the meta field contains correct information.
190− </para>
191− <itemizedlist>
192− <listitem>
193− <para>
194− License must be checked to be fitting upstream license.
195− </para>
196− </listitem>
197− <listitem>
198− <para>
199− Platforms should be set or the package will not get binary substitutes.
200− </para>
201− </listitem>
202− <listitem>
203− <para>
204− A maintainer must be set. This can be the package submitter or a community member that accepts to take maintainership of the package.
205− </para>
206− </listitem>
207− </itemizedlist>
208− </listitem>
209− <listitem>
210− <para>
211− Ensure that the code contains no typos.
212− </para>
213− </listitem>
214− <listitem>
215− <para>
216− Ensure the package source.
217− </para>
218− <itemizedlist>
219− <listitem>
220− <para>
221− Mirrors urls should be used when available.
222− </para>
223− </listitem>
224− <listitem>
225− <para>
226− The most appropriate function should be used (e.g. packages from GitHub should use <literal>fetchFromGitHub</literal>).
227− </para>
228− </listitem>
229− </itemizedlist>
230− </listitem>
231− <listitem>
232− <para>
233− Building the package locally.
234− </para>
235− </listitem>
236− <listitem>
237− <para>
238− Running every binary.
239− </para>
240− </listitem>
241− </itemizedlist>
242−
243− <example xml:id="reviewing-contributions-sample-new-package">
244− <title>Sample template for a new package review</title>
245−<screen>
246−##### Reviewed points
247−
248−- [ ] package path fits guidelines
249−- [ ] package name fits guidelines
250−- [ ] package version fits guidelines
251−- [ ] package build on ARCHITECTURE
252−- [ ] executables tested on ARCHITECTURE
253−- [ ] `meta.description` is set and fits guidelines
254−- [ ] `meta.license` fits upstream license
255−- [ ] `meta.platforms` is set
256−- [ ] `meta.maintainers` is set
257−- [ ] build time only dependencies are declared in `nativeBuildInputs`
258−- [ ] source is fetched using the appropriate function
259−- [ ] phases are respected
260−- [ ] patches that are remotely available are fetched with `fetchpatch`
261−
262−##### Possible improvements
263−
264−##### Comments
265−
266−</screen>
267− </example>
268− </section>
269− <section xml:id="reviewing-contributions-module-updates">
270− <title>Module updates</title>
271−
272− <para>
273− Module updates are submissions changing modules in some ways. These often contains changes to the options or introduce new options.
274− </para>
275−
276− <para>
277− Reviewing process
278− </para>
279−
280− <itemizedlist>
281− <listitem>
282− <para>
283− Ensure that the module maintainers are notified.
284− </para>
285− <itemizedlist>
286− <listitem>
287− <para>
288− <link xlink:href="https://help.github.com/articles/about-codeowners/">CODEOWNERS</link> will make GitHub notify users based on the submitted changes, but it can happen that it misses some of the package maintainers.
289− </para>
290− </listitem>
291− </itemizedlist>
292− </listitem>
293− <listitem>
294− <para>
295− Ensure that the module tests, if any, are succeeding.
296− </para>
297− </listitem>
298− <listitem>
299− <para>
300− Ensure that the introduced options are correct.
301− </para>
302− <itemizedlist>
303− <listitem>
304− <para>
305− Type should be appropriate (string related types differs in their merging capabilities, <literal>optionSet</literal> and <literal>string</literal> types are deprecated).
306− </para>
307− </listitem>
308− <listitem>
309− <para>
310− Description, default and example should be provided.
311− </para>
312− </listitem>
313− </itemizedlist>
314− </listitem>
315− <listitem>
316− <para>
317− Ensure that option changes are backward compatible.
318− </para>
319− <itemizedlist>
320− <listitem>
321− <para>
322− <literal>mkRenamedOptionModule</literal> and <literal>mkAliasOptionModule</literal> functions provide way to make option changes backward compatible.
323− </para>
324− </listitem>
325− </itemizedlist>
326− </listitem>
327− <listitem>
328− <para>
329− Ensure that removed options are declared with <literal>mkRemovedOptionModule</literal>
330− </para>
331− </listitem>
332− <listitem>
333− <para>
334− Ensure that changes that are not backward compatible are mentioned in release notes.
335− </para>
336− </listitem>
337− <listitem>
338− <para>
339− Ensure that documentations affected by the change is updated.
340− </para>
341− </listitem>
342− </itemizedlist>
343−
344− <example xml:id="reviewing-contributions-sample-module-update">
345− <title>Sample template for a module update review</title>
346−<screen>
347−##### Reviewed points
348−
349−- [ ] changes are backward compatible
350−- [ ] removed options are declared with `mkRemovedOptionModule`
351−- [ ] changes that are not backward compatible are documented in release notes
352−- [ ] module tests succeed on ARCHITECTURE
353−- [ ] options types are appropriate
354−- [ ] options description is set
355−- [ ] options example is provided
356−- [ ] documentation affected by the changes is updated
357−
358−##### Possible improvements
359−
360−##### Comments
361−
362−</screen>
363− </example>
364− </section>
365− <section xml:id="reviewing-contributions-new-modules">
366− <title>New modules</title>
367−
368− <para>
369− New modules submissions introduce a new module to NixOS.
370− </para>
371−
372− <itemizedlist>
373− <listitem>
374− <para>
375− Ensure that the module tests, if any, are succeeding.
376− </para>
377− </listitem>
378− <listitem>
379− <para>
380− Ensure that the introduced options are correct.
381− </para>
382− <itemizedlist>
383− <listitem>
384− <para>
385− Type should be appropriate (string related types differs in their merging capabilities, <literal>optionSet</literal> and <literal>string</literal> types are deprecated).
386− </para>
387− </listitem>
388− <listitem>
389− <para>
390− Description, default and example should be provided.
391− </para>
392− </listitem>
393− </itemizedlist>
394− </listitem>
395− <listitem>
396− <para>
397− Ensure that module <literal>meta</literal> field is present
398− </para>
399− <itemizedlist>
400− <listitem>
401− <para>
402− Maintainers should be declared in <literal>meta.maintainers</literal>.
403− </para>
404− </listitem>
405− <listitem>
406− <para>
407− Module documentation should be declared with <literal>meta.doc</literal>.
408− </para>
409− </listitem>
410− </itemizedlist>
411− </listitem>
412− <listitem>
413− <para>
414− Ensure that the module respect other modules functionality.
415− </para>
416− <itemizedlist>
417− <listitem>
418− <para>
419− For example, enabling a module should not open firewall ports by default.
420− </para>
421− </listitem>
422− </itemizedlist>
423− </listitem>
424− </itemizedlist>
425−
426− <example xml:id="reviewing-contributions-sample-new-module">
427− <title>Sample template for a new module review</title>
428−<screen>
429−##### Reviewed points
430−
431−- [ ] module path fits the guidelines
432−- [ ] module tests succeed on ARCHITECTURE
433−- [ ] options have appropriate types
434−- [ ] options have default
435−- [ ] options have example
436−- [ ] options have descriptions
437−- [ ] No unneeded package is added to environment.systemPackages
438−- [ ] meta.maintainers is set
439−- [ ] module documentation is declared in meta.doc
440−
441−##### Possible improvements
442−
443−##### Comments
444−
445−</screen>
446− </example>
447− </section>
448− <section xml:id="reviewing-contributions-other-submissions">
449− <title>Other submissions</title>
450−
451− <para>
452− Other type of submissions requires different reviewing steps.
453− </para>
454−
455− <para>
456− 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.
457− </para>
458−
459− <para>
460− Container system, boot system and library changes are some examples of the pull requests fitting this category.
461− </para>
462− </section>
463− <section xml:id="reviewing-contributions--merging-pull-requests">
464− <title>Merging pull requests</title>
465−
466− <para>
467− It is possible for community members that have enough knowledge and experience on a special topic to contribute by merging pull requests.
468− </para>
469−
470−<!--
471−The following paragraphs about how to deal with unactive contributors is just a
472−proposition and should be modified to what the community agrees to be the right
473−policy.
474−
475−<para>Please note that contributors with commit rights unactive for more than
476− three months will have their commit rights revoked.</para>
477−-->
478−
479− <para>
480− Please see the discussion in <link xlink:href="https://github.com/NixOS/nixpkgs/issues/50105">GitHub nixpkgs issue #50105</link> for information on how to proceed to be granted this level of access.
481− </para>
482−
483− <para>
484− In a case a contributor definitively leaves the Nix community, they should create an issue or post on <link
485− xlink:href="https://discourse.nixos.org">Discourse</link> with references of packages and modules they maintain so the maintainership can be taken over by other contributors.
486− </para>
487− </section>
488−</chapter>
doc/contributing/submitting-changes.chapter.md+94−19
@@ -43,13 +43,13 @@
4343 - nixpkgs:
4444
4545 - update pkg
46− - `nix-env -i pkg-name -f <path to your local nixpkgs folder>`
46+ - `nix-env -iA pkg-attribute-name -f <path to your local nixpkgs folder>`
4747 - add pkg
4848 - Make sure it’s in `pkgs/top-level/all-packages.nix`
49− - `nix-env -i pkg-name -f <path to your local nixpkgs folder>`
49+ - `nix-env -iA pkg-attribute-name -f <path to your local nixpkgs folder>`
5050 - _If you don’t want to install pkg in you profile_.
51− - `nix-build -A pkg-attribute-name <path to your local nixpkgs folder>/default.nix` and check results in the folder `result`. It will appear in the same directory where you did `nix-build`.
52− - If you did `nix-env -i pkg-name` you can do `nix-env -e pkg-name` to uninstall it from your system.
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.
5353
5454 - NixOS and its modules:
5555 - 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`.
@@ -62,26 +62,75 @@
6262
6363- Push your changes to your fork of nixpkgs.
6464- Create the pull request
65−- Follow [the contribution guidelines](https://github.com/NixOS/nixpkgs/blob/master/.github/CONTRIBUTING.md#submitting-changes).
65+- Follow [the contribution guidelines](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md#submitting-changes).
6666
6767## Submitting security fixes {#submitting-changes-submitting-security-fixes}
6868
6969Security fixes are submitted in the same way as other changes and thus the same guidelines apply.
7070
71−If the security fix comes in the form of a patch and a CVE is available, then the name of the patch should be the CVE identifier, so e.g. `CVE-2019-13636.patch` in the case of a patch that is included in the Nixpkgs tree. If a patch is fetched the name needs to be set as well, e.g.:
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.:
7274
73−```nix
74−(fetchpatch {
75− name = "CVE-2019-11068.patch";
76− url = "https://gitlab.gnome.org/GNOME/libxslt/commit/e03553605b45c88f0b4b2980adfbbb8f6fca2fd6.patch";
77− sha256 = "0pkpb4837km15zgg6h57bncp66d5lwrlvkr73h0lanywq7zrwhj8";
78−})
79−```
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+ ```
8082
8183If 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.
8284
8385Critical security fixes may by-pass the staging branches and be delivered directly to release branches such as `master` and `release-*`.
8486
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+
85134## Pull Request Template {#submitting-changes-pull-request-template}
86135
87136The 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.
@@ -114,7 +163,7 @@ Many Nix packages are designed to run on multiple platforms. As such, it’s imp
114163
115164### Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests) {#submitting-changes-nixos-tests}
116165
117−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 only apply to packages with NixOS modules defined and 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).
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).
118167
119168### Tested compilation of all pkgs that depend on this change using `nixpkgs-review` {#submitting-changes-tested-compilation}
120169
@@ -144,7 +193,7 @@ It’s important to test any executables generated by a build when you change or
144193
145194### Meets Nixpkgs contribution standards {#submitting-changes-contribution-standards}
146195
147−The last checkbox is fits [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/.github/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.
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.
148197
149198## Hotfixing pull requests {#submitting-changes-hotfixing-pull-requests}
150199
@@ -174,10 +223,13 @@ digraph {
174223 "staging-next" -> master [color="#E85EB0"] [label="stabilization ends"] [fontcolor="#E85EB0"]
175224 "staging" -> "staging-next" [color="#E85EB0"] [label="stabilization starts"] [fontcolor="#E85EB0"]
176225
177− master -> "staging-next" -> staging [color="#5F5EE8"] [label="every six hours/any time"] [fontcolor="#5F5EE8"]
226+ master -> "staging-next" -> staging [color="#5F5EE8"] [label="every six hours (GitHub Action)"] [fontcolor="#5F5EE8"]
178227}
179228```
180229
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+
181233### Master branch {#submitting-changes-master-branch}
182234
183235The `master` branch is the main development branch. It should only see non-breaking commits that do not cause mass rebuilds.
@@ -188,15 +240,27 @@ The `staging` branch is a development branch where mass-rebuilds go. It should o
188240
189241### Staging-next branch {#submitting-changes-staging-next-branch}
190242
191−The `staging-next` branch is for stabilizing mass-rebuilds submitted to the `staging` branch prior to merging them into `master`. Mass-rebuilds should go via the `staging` branch. It should only see non-breaking commits that are fixing issues blocking it from being merged into the `master ` branch.
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.
192244
193245If 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.
194246
195247### Stable release branches {#submitting-changes-stable-release-branches}
196248
197−For cherry-picking a commit to a stable release branch (“backporting”), use `git cherry-pick -x <original commit>` so that the original commit id is included in the commit.
249+The same staging workflow applies to stable release branches, but the main branch is called `release-*` instead of `master`.
198250
199−Add a reason for the backport by using `git cherry-pick -xe <original commit>` instead when it is not obvious from the original commit message. It is not needed when it's a minor version update that includes security and bug fixes but don't add new features or when the commit fixes an otherwise broken package.
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.
200264
201265Here is an example of a cherry-picked commit message with good reason description:
202266
@@ -215,3 +279,14 @@ Other examples of reasons are:
215279- Previously the build would fail due to, e.g., `getaddrinfo` not being defined
216280- The previous download links were all broken
217281- 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.nix+4−5
@@ -15,11 +15,7 @@ in pkgs.stdenv.mkDerivation {
1515 xmlformat
1616 ];
1717
18− src = ./.;
19−
20− makeFlags = [
21− "PANDOC_LUA_FILTERS_DIR=${pkgs.pandoc-lua-filters}/share/pandoc/filters"
22− ];
18+ src = lib.cleanSource ./.;
2319
2420 postPatch = ''
2521 ln -s ${doc-support} ./doc-support/result
@@ -37,4 +33,7 @@ in pkgs.stdenv.mkDerivation {
3733 echo "doc manual $dest manual.html" >> $out/nix-support/hydra-build-products
3834 echo "doc manual $dest nixpkgs-manual.epub" >> $out/nix-support/hydra-build-products
3935 '';
36+
37+ # Environment variables
38+ PANDOC_LUA_FILTERS_DIR = "${pkgs.pandoc-lua-filters}/share/pandoc/filters";
4039}
doc/doc-support/lib-function-docs.nix+1
@@ -22,5 +22,6 @@ with pkgs; stdenv.mkDerivation {
2222 docgen lists 'List manipulation functions'
2323 docgen debug 'Debugging functions'
2424 docgen options 'NixOS / nixpkgs option handling'
25+ docgen sources 'Source filtering functions'
2526 '';
2627}
doc/functions.xml+4−4
@@ -7,8 +7,8 @@
77 The nixpkgs repository has several utility functions to manipulate Nix expressions.
88 </para>
99 <xi:include href="functions/library.xml" />
10− <xi:include href="functions/generators.xml" />
11− <xi:include href="functions/debug.xml" />
12− <xi:include href="functions/prefer-remote-fetch.xml" />
13− <xi:include href="functions/nix-gitignore.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" />
1414</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/debug.xmldeleted−14
@@ -1,14 +0,0 @@
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-debug">
5− <title>Debugging Nix Expressions</title>
6−
7− <para>
8− 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.
9− </para>
10−
11− <para>
12− In the <literal>lib/debug.nix</literal> file you will find a number of functions that help (pretty-)printing values while evaluation is runnnig. You can even specify how deep these values should be printed recursively, and transform them on the fly. Please consult the docstrings in <literal>lib/debug.nix</literal> for usage information.
13− </para>
14−</section>
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/generators.xmldeleted−74
@@ -1,74 +0,0 @@
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-generators">
5− <title>Generators</title>
6−
7− <para>
8− Generators are functions that create file formats from nix data structures, e. g. for configuration files. There are generators available for: <literal>INI</literal>, <literal>JSON</literal> and <literal>YAML</literal>
9− </para>
10−
11− <para>
12− All generators follow a similar call interface: <code>generatorName configFunctions data</code>, where <literal>configFunctions</literal> 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 <code>mkSectionName ? (name: libStr.escape [ "[" "]" ] name)</code> from the <literal>INI</literal> generator. It receives the name of a section and sanitizes it. The default <literal>mkSectionName</literal> escapes <literal>[</literal> and <literal>]</literal> with a backslash.
13− </para>
14−
15− <para>
16− 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 <literal>: </literal> as separator, the strings <literal>"yes"</literal>/<literal>"no"</literal> as boolean values and requires all string values to be quoted:
17− </para>
18−
19−<programlisting>
20−with lib;
21−let
22− customToINI = generators.toINI {
23− # specifies how to format a key/value pair
24− mkKeyValue = generators.mkKeyValueDefault {
25− # specifies the generated string for a subset of nix values
26− mkValueString = v:
27− if v == true then ''"yes"''
28− else if v == false then ''"no"''
29− else if isString v then ''"${v}"''
30− # and delegats all other values to the default generator
31− else generators.mkValueStringDefault {} v;
32− } ":";
33− };
34−
35−# the INI file can now be given as plain old nix values
36−in customToINI {
37− main = {
38− pushinfo = true;
39− autopush = false;
40− host = "localhost";
41− port = 42;
42− };
43− mergetool = {
44− merge = "diff3";
45− };
46−}
47−</programlisting>
48−
49− <para>
50− This will produce the following INI file as nix string:
51− </para>
52−
53−<programlisting>
54−[main]
55−autopush:"no"
56−host:"localhost"
57−port:42
58−pushinfo:"yes"
59−str\:ange:"very::strange"
60−
61−[mergetool]
62−merge:"diff3"
63−</programlisting>
64−
65− <note>
66− <para>
67− Nix store paths can be converted to strings by enclosing a derivation attribute like so: <code>"${drv}"</code>.
68− </para>
69− </note>
70−
71− <para>
72− Detailed documentation for each generator can be found in <literal>lib/generators.nix</literal>.
73− </para>
74−</section>
doc/functions/library.xml+2
@@ -25,4 +25,6 @@
2525 <xi:include href="./library/generated/debug.xml" />
2626
2727 <xi:include href="./library/generated/options.xml" />
28+
29+ <xi:include href="./library/generated/sources.xml" />
2830</section>
doc/functions/library/asserts.xml+1−1
@@ -103,7 +103,7 @@ stderr> assert failed
103103 <title>Ensuring a user provided a possible value</title>
104104<programlisting><![CDATA[
105105let sslLibrary = "bearssl";
106−in lib.asserts.assertOneOf "sslLibrary" sslLibrary [ "openssl" "bearssl" ];
106+in lib.asserts.assertOneOf "sslLibrary" sslLibrary [ "openssl" "libressl" ];
107107=> false
108108stderr> trace: sslLibrary must be one of "openssl", "libressl", but is: "bearssl"
109109 ]]></programlisting>
doc/functions/library/attrsets.xml+43−6
@@ -7,7 +7,7 @@
77 <section xml:id="function-library-lib.attrsets.attrByPath">
88 <title><function>lib.attrset.attrByPath</function></title>
99
10− <subtitle><literal>attrByPath :: [String] -> Any -> AttrSet</literal>
10+ <subtitle><literal>attrByPath :: [String] -> Any -> AttrSet -> Any</literal>
1111 </subtitle>
1212
1313 <xi:include href="./locations.xml" xpointer="lib.attrsets.attrByPath" />
@@ -772,7 +772,7 @@ nameValuePair "some" 6
772772 <title>Modifying each value of an attribute set</title>
773773<programlisting><![CDATA[
774774lib.attrsets.mapAttrs
775− (name: value: name + "-" value)
775+ (name: value: name + "-" + value)
776776 { x = "foo"; y = "bar"; }
777777=> { x = "x-foo"; y = "y-bar"; }
778778]]></programlisting>
@@ -855,7 +855,7 @@ lib.attrsets.mapAttrs' (name: value: lib.attrsets.nameValuePair ("foo_" + name)
855855 <title><function>lib.attrsets.mapAttrsToList</function></title>
856856
857857 <subtitle><literal>mapAttrsToList :: (String -> Any -> Any) ->
858− AttrSet -> Any</literal>
858+ AttrSet -> [Any]</literal>
859859 </subtitle>
860860
861861 <xi:include href="./locations.xml" xpointer="lib.attrsets.mapAttrsToList" />
@@ -1474,7 +1474,7 @@ lib.attrsets.zipAttrsWith
14741474 <section xml:id="function-library-lib.attrsets.zipAttrs">
14751475 <title><function>lib.attrsets.zipAttrs</function></title>
14761476
1477− <subtitle><literal>zipAttrsWith :: [ AttrSet ] -> AttrSet</literal>
1477+ <subtitle><literal>zipAttrs :: [ AttrSet ] -> AttrSet</literal>
14781478 </subtitle>
14791479
14801480 <xi:include href="./locations.xml" xpointer="lib.attrsets.zipAttrs" />
@@ -1677,8 +1677,7 @@ recursiveUpdate
16771677 <xi:include href="./locations.xml" xpointer="lib.attrsets.recurseIntoAttrs" />
16781678
16791679 <para>
1680− Make various Nix tools consider the contents of the resulting
1681− attribute set when looking for what to build, find, etc.
1680+ Make various Nix tools consider the contents of the resulting attribute set when looking for what to build, find, etc.
16821681 </para>
16831682
16841683 <para>
@@ -1711,4 +1710,42 @@ recursiveUpdate
17111710 </example>
17121711 </section>
17131712
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>
17141751</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/nix-gitignore.xmldeleted−70
@@ -1,70 +0,0 @@
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-pkgs-nix-gitignore">
5− <title>pkgs.nix-gitignore</title>
6−
7− <para>
8− <function>pkgs.nix-gitignore</function> is a function that acts similarly to <literal>builtins.filterSource</literal> but also allows filtering with the help of the gitignore format.
9− </para>
10−
11− <section xml:id="sec-pkgs-nix-gitignore-usage">
12− <title>Usage</title>
13−
14− <para>
15− <literal>pkgs.nix-gitignore</literal> exports a number of functions, but you'll most likely need either <literal>gitignoreSource</literal> or <literal>gitignoreSourcePure</literal>. 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.
16− </para>
17−
18−<programlisting><![CDATA[
19−{ pkgs ? import <nixpkgs> {} }:
20−
21− nix-gitignore.gitignoreSource [] ./source
22− # Simplest version
23−
24− nix-gitignore.gitignoreSource "supplemental-ignores\n" ./source
25− # This one reads the ./source/.gitignore and concats the auxiliary ignores
26−
27− nix-gitignore.gitignoreSourcePure "ignore-this\nignore-that\n" ./source
28− # Use this string as gitignore, don't read ./source/.gitignore.
29−
30− nix-gitignore.gitignoreSourcePure ["ignore-this\nignore-that\n", ~/.gitignore] ./source
31− # It also accepts a list (of strings and paths) that will be concatenated
32− # once the paths are turned to strings via readFile.
33− ]]></programlisting>
34−
35− <para>
36− These functions are derived from the <literal>Filter</literal> functions by setting the first filter argument to <literal>(_: _: true)</literal>:
37− </para>
38−
39−<programlisting><![CDATA[
40−gitignoreSourcePure = gitignoreFilterSourcePure (_: _: true);
41−gitignoreSource = gitignoreFilterSource (_: _: true);
42− ]]></programlisting>
43−
44− <para>
45− Those filter functions accept the same arguments the <literal>builtins.filterSource</literal> function would pass to its filters, thus <literal>fn: gitignoreFilterSourcePure fn ""</literal> should be extensionally equivalent to <literal>filterSource</literal>. The file is blacklisted iff it's blacklisted by either your filter or the gitignoreFilter.
46− </para>
47−
48− <para>
49− If you want to make your own filter from scratch, you may use
50− </para>
51−
52−<programlisting><![CDATA[
53−gitignoreFilter = ign: root: filterPattern (gitignoreToPatterns ign) root;
54− ]]></programlisting>
55− </section>
56−
57− <section xml:id="sec-pkgs-nix-gitignore-usage-recursive">
58− <title>gitignore files in subdirectories</title>
59−
60− <para>
61− If you wish to use a filter that would search for .gitignore files in subdirectories, just like git does by default, use this function:
62− </para>
63−
64−<programlisting><![CDATA[
65−gitignoreFilterRecursiveSource = filter: patterns: root:
66−# OR
67−gitignoreRecursiveSource = gitignoreFilterSourcePure (_: _: true);
68− ]]></programlisting>
69− </section>
70−</section>
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/functions/prefer-remote-fetch.xmldeleted−21
@@ -1,21 +0,0 @@
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-prefer-remote-fetch">
5− <title>prefer-remote-fetch overlay</title>
6−
7− <para>
8− <function>prefer-remote-fetch</function> 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:
9−<programlisting>
10−self: super:
11− (super.prefer-remote-fetch self super)
12−</programlisting>
13− A full configuration example for that sets the overlay up for your own account, could look like this
14−<screen>
15−<prompt>$ </prompt>mkdir ~/.config/nixpkgs/overlays/
16−<prompt>$ </prompt>cat > ~/.config/nixpkgs/overlays/prefer-remote-fetch.nix <<EOF
17− self: super: super.prefer-remote-fetch self super
18−EOF
19−</screen>
20− </para>
21−</section>
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.md+178−33
@@ -1,67 +1,126 @@
1−---
2−title: Agda
3−author: Alex Rice (alexarice)
4−date: 2020-01-06
5−---
6−# Agda
1+# Agda {#agda}
72
8−## How to use Agda
3+## How to use Agda {#how-to-use-agda}
94
10−Agda can be installed from `agda`:
11−```
12−$ nix-env -iA agda
13−```
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.
147
15−To use Agda with libraries, the `agda.withPackages` function can be used. This function either takes:
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:
1613
1714* A list of packages,
1815* or a function which returns a list of packages when given the `agdaPackages` attribute set,
1916* 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).
2018
2119For example, suppose we wanted a version of Agda which has access to the standard library. This can be obtained with the expressions:
2220
23−```
21+```nix
2422agda.withPackages [ agdaPackages.standard-library ]
2523```
2624
2725or
2826
29−```
27+```nix
3028agda.withPackages (p: [ p.standard-library ])
3129```
3230
3331or can be called as in the [Compiling Agda](#compiling-agda) section.
3432
35−If you want to use a library in your home directory (for instance if it is a development version) then typecheck it manually (using `agda.withPackages` if necessary) and then override the `src` attribute of the package to point to your local repository.
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
3635
37−Agda will not by default use these libraries. To tell Agda to use the library we have some options:
38−
39−* Call `agda` with the library flag:
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+])
4043```
41−$ agda -l standard-library -i . MyFile.agda
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+])
4259```
43−* Write a `my-library.agda-lib` file for the project you are working on which may look like:
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+])
4472```
45−name: my-library
46−include: .
47−depend: standard-library
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+])
4890```
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+ ```
49106* Create the file `~/.agda/defaults` and add any libraries you want to use by default.
50107
51108More information can be found in the [official Agda documentation on library management](https://agda.readthedocs.io/en/v2.6.1/tools/package-system.html).
52109
53−## Compiling Agda
54−Agda modules can be compiled with the `--compile` flag. A version of `ghc` with `ieee` is made available to the Agda program via the `--with-compiler` flag.
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.
55113This can be overridden by a different version of `ghc` as follows:
56114
57−```
115+```nix
58116agda.withPackages {
59117 pkgs = [ ... ];
60118 ghc = haskell.compiler.ghcHEAD;
61119}
62120```
63121
64−## Writing Agda packages
122+## Writing Agda packages {#writing-agda-packages}
123+
65124To write a nix derivation for an Agda library, first check that the library has a `*.agda-lib` file.
66125
67126A derivation can then be written using `agdaPackages.mkDerivation`. This has similar arguments to `stdenv.mkDerivation` with the following additions:
@@ -70,27 +129,66 @@ A derivation can then be written using `agdaPackages.mkDerivation`. This has sim
70129* `libraryName` should be the name that appears in the `*.agda-lib` file, defaulting to `pname`.
71130* `libraryFile` should be the file name of the `*.agda-lib` file, defaulting to `${libraryName}.agda-lib`.
72131
73−### Building Agda packages
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+
74149The default build phase for `agdaPackages.mkDerivation` simply runs `agda` on the `Everything.agda` file.
75150If something else is needed to build the package (e.g. `make`) then the `buildPhase` should be overridden.
76151Additionally, a `preBuild` or `configurePhase` can be used if there are steps that need to be done prior to checking the `Everything.agda` file.
77152`agda` and the Agda libraries contained in `buildInputs` are made available during the build phase.
78153
79−### Installing Agda packages
154+### Installing Agda packages {#installing-agda-packages}
155+
80156The default install phase copies Agda source files, Agda interface files (`*.agdai`) and `*.agda-lib` files to the output directory.
81157This can be overridden.
82158
83159By 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.
84160
85−## Adding Agda packages to Nixpkgs
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}
86178
87179To 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:
88−```
180+
181+```nix
89182{ mkDerivation, standard-library, fetchFromGitHub }:
90183```
91−and `mkDerivation` should be called instead of `agdaPackages.mkDerivation`. Here is an example skeleton derivation for iowa-stdlib:
92184
93−```
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
94192mkDerivation {
95193 version = "1.5.0";
96194 pname = "iowa-stdlib";
@@ -106,6 +204,53 @@ mkDerivation {
106204 '';
107205}
108206```
207+
109208This 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`.
110209
111210When 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.md+149−44
@@ -1,15 +1,10 @@
1−---
2−title: Android
3−author: Sander van der Burg
4−date: 2018-11-18
5−---
6−# Android
1+# Android {#android}
72
83The Android build environment provides three major features and a number of
94supporting features.
105
11−Deploying an Android SDK installation with plugins
12−--------------------------------------------------
6+## Deploying an Android SDK installation with plugins {#deploying-an-android-sdk-installation-with-plugins}
7+
138The first use case is deploying the SDK with a desired set of plugins or subsets
149of an SDK.
1510
@@ -18,21 +13,19 @@ with import <nixpkgs> {};
1813
1914let
2015 androidComposition = androidenv.composeAndroidPackages {
21− toolsVersion = "25.2.5";
22− platformToolsVersion = "27.0.1";
23− buildToolsVersions = [ "27.0.3" ];
16+ toolsVersion = "26.1.1";
17+ platformToolsVersion = "30.0.5";
18+ buildToolsVersions = [ "30.0.3" ];
2419 includeEmulator = false;
25− emulatorVersion = "27.2.0";
26− platformVersions = [ "24" ];
20+ emulatorVersion = "30.3.4";
21+ platformVersions = [ "28" "29" "30" ];
2722 includeSources = false;
28− includeDocs = false;
2923 includeSystemImages = false;
30− systemImageTypes = [ "default" ];
31− abiVersions = [ "armeabi-v7a" ];
32− lldbVersions = [ "2.0.2558144" ];
33− cmakeVersions = [ "3.6.4111459" ];
34− includeNDK = false;
35− ndkVersion = "16.1.4479499";
24+ systemImageTypes = [ "google_apis_playstore" ];
25+ abiVersions = [ "armeabi-v7a" "arm64-v8a" ];
26+ cmakeVersions = [ "3.10.2" ];
27+ includeNDK = true;
28+ ndkVersions = ["22.0.7026061"];
3629 useGoogleAPIs = false;
3730 useGoogleTVAddOns = false;
3831 includeExtras = [
@@ -51,17 +44,19 @@ The following parameters are supported:
5144
5245* `toolsVersion`, specifies the version of the tools package to use
5346* `platformsToolsVersion` specifies the version of the `platform-tools` plugin
54−* `buildToolsVersion` specifies the versions of the `build-tools` plugins to
47+* `buildToolsVersions` specifies the versions of the `build-tools` plugins to
5548 use.
5649* `includeEmulator` specifies whether to deploy the emulator package (`false`
5750 by default). When enabled, the version of the emulator to deploy can be
5851 specified by setting the `emulatorVersion` parameter.
59−* `includeDocs` specifies whether the documentation catalog should be included.
60−* `lldbVersions` specifies what LLDB versions should be deployed.
6152* `cmakeVersions` specifies which CMake versions should be deployed.
6253* `includeNDK` specifies that the Android NDK bundle should be included.
6354 Defaults to: `false`.
64−* `ndkVersion` specifies the NDK version that we want to use.
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.
6560* `includeExtras` is an array of identifier strings referring to arbitrary
6661 add-on packages that should be installed.
6762* `platformVersions` specifies which platform SDK versions should be included.
@@ -87,6 +82,38 @@ For each requested system image we can specify the following options:
8782
8883Most of the function arguments have reasonable default settings.
8984
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+
90117When building the above expression with:
91118
92119```bash
@@ -109,8 +136,8 @@ in
109136androidComposition.platform-tools
110137```
111138
112−Using predefine Android package compositions
113−--------------------------------------------
139+## Using predefined Android package compositions {#using-predefined-android-package-compositions}
140+
114141In addition to composing an Android package set manually, it is also possible
115142to use a predefined composition that contains all basic packages for a specific
116143Android version, such as version 9.0 (API-level 28).
@@ -132,12 +159,13 @@ with import <nixpkgs> {};
132159androidenv.androidPkgs_9_0.platform-tools
133160```
134161
135−Building an Android application
136−-------------------------------
162+## Building an Android application {#building-an-android-application}
163+
137164In addition to the SDK, it is also possible to build an Ant-based Android
138165project and automatically deploy all the Android plugins that a project
139166requires.
140167
168+
141169```nix
142170with import <nixpkgs> {};
143171
@@ -172,8 +200,8 @@ to build Android apps. An Android APK gets exposed as a build product and can be
172200installed on any Android device with a web browser by navigating to the build
173201result page.
174202
175−Spawning emulator instances
176−---------------------------
203+## Spawning emulator instances {#spawning-emulator-instances}
204+
177205For testing purposes, it can also be quite convenient to automatically generate
178206scripts that spawn emulator instances with all desired configuration settings.
179207
@@ -214,27 +242,104 @@ androidenv.emulateApp {
214242In addition to prebuilt APKs, you can also bind the APK parameter to a
215243`buildApp {}` function invocation shown in the previous example.
216244
217−Querying the available versions of each plugin
218−----------------------------------------------
219−When using any of the previously shown functions, it may be a bit inconvenient
220−to find out what options are supported, since the Android SDK provides many
221−plugins.
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.
222303
223−A shell script in the `pkgs/development/mobile/androidenv/` sub directory can be used to retrieve all
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
224330possible options:
225331
226332```bash
227−sh ./querypackages.sh packages build-tools
333+./querypackages.sh packages
228334```
229335
230−The above command-line instruction queries all build-tools versions in the
231−generated `packages.nix` expression.
336+The above command-line instruction queries all package versions in repo.json.
337+
338+## Updating the generated expressions {#updating-the-generated-expressions}
232339
233−Updating the generated expressions
234−----------------------------------
235−Most of the Nix expressions are generated from XML files that the Android
236−package manager uses. To update the expressions run the `generate.sh` script
237−that is stored in the `pkgs/development/mobile/androidenv/` sub directory:
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:
238343
239344```bash
240345./generate.sh
doc/languages-frameworks/beam.section.md+303−14
@@ -2,15 +2,21 @@
22
33## Introduction {#beam-introduction}
44
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.
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.
612
713## Structure {#beam-structure}
814
915All BEAM-related expressions are available via the top-level `beam` attribute, which includes:
1016
11− - `interpreters`: a set of compilers running on the BEAM, including multiple Erlang/OTP versions (`beam.interpreters.erlangR19`, etc), Elixir (`beam.interpreters.elixir`) and LFE (`beam.interpreters.lfe`).
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`).
1218
13− - `packages`: a set of package builders (Mix and rebar3), each compiled with a specific Erlang/OTP version, e.g. `beam.packages.erlangR19`.
19+- `packages`: a set of package builders (Mix and rebar3), each compiled with a specific Erlang/OTP version, e.g. `beam.packages.erlang22`.
1420
1521The 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`.
1622
@@ -24,9 +30,17 @@ Many Erlang/OTP distributions available in `beam.interpreters` have versions wit
2430
2531We provide a version of Rebar3, under `rebar3`. We also provide a helper to fetch Rebar3 dependencies from a lockfile under `fetchRebar3Deps`.
2632
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+
2737### Mix & Erlang.mk {#build-tools-other}
2838
29−Both Mix and Erlang.mk work exactly as expected. There is a bootstrap process that needs to be run for both, however, which is supported by the `buildMix` and `buildErlangMk` derivations, respectively.
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.
3044
3145## How to Install BEAM Packages {#how-to-install-beam-packages}
3246
@@ -52,33 +66,308 @@ Erlang.mk functions similarly to Rebar3, except we use `buildErlangMk` instead o
5266
5367#### Mix Packages {#mix-packages}
5468
55−Mix functions similarly to Rebar3, except we use `buildMix` instead of `buildRebar3`.
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:
5692
57−Alternatively, we can use `buildHex` as a shortcut:
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+```
58264
59265## How to Develop {#how-to-develop}
60266
61267### Creating a Shell {#creating-a-shell}
62268
63−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 other interpreter, and then user your normal build tools. As an example with elixir:
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:
64270
65271```nix
66−{ pkgs ? import "<nixpkgs"> {} }:
272+{ pkgs ? import <nixpkgs> {} }:
67273
68274with pkgs;
69−
70275let
276+ elixir = beam.packages.erlangR24.elixir_1_12;
277+in
278+mkShell {
279+ buildInputs = [ elixir ];
280+}
281+```
282+
283+### Using an overlay
71284
72− elixir = beam.packages.erlangR22.elixir_1_9;
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:
73286
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 ]; };
74298in
299+with pkgs;
75300mkShell {
76− buildInputs = [ elixir ];
301+ buildInputs = [
302+ elixir_1_13
303+ ];
304+}
305+```
306+
307+#### Elixir - Phoenix project {#elixir---phoenix-project}
77308
78− ERL_INCLUDE_PATH="${erlang}/lib/erlang/usr/include";
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;
79363}
80364```
81365
82−#### Building in a Shell (for Mix Projects) {#building-in-a-shell}
366+Initializing the project will require the following steps:
83367
84−Using a `shell.nix` as described (see <xref linkend="creating-a-shell"/>) should just work.
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.md+1−1
@@ -149,7 +149,7 @@ A few notes about [Full example — `default.nix`](#ex-buildBowerComponentsDefau
149149
150150## Troubleshooting {#ssec-bower2nix-troubleshooting}
151151
152−### ENOCACHE errors from buildBowerComponents
152+### ENOCACHE errors from buildBowerComponents {#enocache-errors-from-buildbowercomponents}
153153
154154This means that Bower was looking for a package version which doesn't exist in the generated `bower-packages.nix`.
155155
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.md+69−26
@@ -1,40 +1,83 @@
1−# Coq {#sec-language-coq}
1+# Coq and coq packages {#sec-language-coq}
22
3−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.
3+## Coq derivation: `coq` {#coq-derivation-coq}
44
5−Some extensions (plugins) might require OCaml and sometimes other OCaml packages. The `coq.ocamlPackages` attribute can be used to depend on the same package set Coq was built against.
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
66
7−Coq libraries may be compatible with some specific versions of Coq only. The `compatibleCoqVersions` attribute is used to precisely select those versions of Coq that are compatible with this derivation.
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"; }`.
810
9−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 `mathcomp` as `buildInputs`. Its `Makefile` has been generated using `coq_makefile` so we only have to set the `$COQLIB` variable at install time.
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`.
1047
1148```nix
12−{ stdenv, fetchFromGitHub, coq, mathcomp }:
13−
14−stdenv.mkDerivation rec {
15− name = "coq${coq.coq-version}-multinomials-${version}";
16− version = "1.0";
17− src = fetchFromGitHub {
18− owner = "math-comp";
19− repo = "multinomials";
20− rev = version;
21− sha256 = "1qmbxp1h81cy3imh627pznmng0kvv37k4hrwi2faa101s6bcx55m";
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";
2273 };
2374
24− buildInputs = [ coq ];
25− propagatedBuildInputs = [ mathcomp ];
26−
27− installFlags = "COQLIB=$(out)/lib/coq/${coq.coq-version}/";
75+ propagatedBuildInputs =
76+ [ mathcomp.ssreflect mathcomp.algebra mathcomp-finmap mathcomp-bigenough ];
2877
2978 meta = {
3079 description = "A Coq/SSReflect Library for Monoidal Rings and Multinomials";
31− inherit (src.meta) homepage;
32− license = stdenv.lib.licenses.cecill-b;
33− inherit (coq.meta) platforms;
34− };
35−
36− passthru = {
37− compatibleCoqVersions = v: builtins.elem v [ "8.5" "8.6" "8.7" ];
80+ license = licenses.cecill-c;
3881 };
3982}
4083```
doc/languages-frameworks/crystal.section.md+5−3
@@ -1,20 +1,22 @@
1−# Crystal
1+# Crystal {#crystal}
22
3−## Building a Crystal package
3+## Building a Crystal package {#building-a-crystal-package}
44
55This section uses [Mint](https://github.com/mint-lang/mint) as an example for how to build a Crystal package.
66
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, then run `crystal2nix` in it
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.
88```bash
99$ git clone https://github.com/mint-lang/mint
1010$ cd mint
1111$ git checkout 0.5.0
12+$ if [ ! -f shard.lock ]; then nix-shell -p shards --run "shards lock"; fi
1213$ nix-shell -p crystal2nix --run crystal2nix
1314```
1415
1516This should have generated a `shards.nix` file.
1617
1718Next create a Nix file for your derivation and use `pkgs.crystal.buildCrystalPackage` as follows:
19+
1820```nix
1921with import <nixpkgs> {};
2022crystal.buildCrystalPackage rec {
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.md+77−20
@@ -1,35 +1,34 @@
1−# Dotnet
1+# Dotnet {#dotnet}
22
3−## Local Development Workflow
3+## Local Development Workflow {#local-development-workflow}
44
55For local development, it's recommended to use nix-shell to create a dotnet environment:
66
7−```
7+```nix
88# shell.nix
99with import <nixpkgs> {};
1010
1111mkShell {
1212 name = "dotnet-env";
13− buildInputs = [
13+ packages = [
1414 dotnet-sdk_3
1515 ];
1616}
1717```
1818
19−### Using many sdks in a workflow
19+### Using many sdks in a workflow {#using-many-sdks-in-a-workflow}
2020
2121It'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`:
2222
23−```
23+```nix
2424with import <nixpkgs> {};
2525
2626mkShell {
2727 name = "dotnet-env";
28− buildInputs = [
28+ packages = [
2929 (with dotnetCorePackages; combinePackages [
3030 sdk_3_1
31− sdk_3_0
32− sdk_2_1
31+ sdk_5_0
3332 ])
3433 ];
3534}
@@ -37,7 +36,7 @@ mkShell {
3736
3837This 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:
3938
40−```
39+```ShellSession
4140$ dotnet --info
4241.NET Core SDK (reflecting any global.json):
4342 Version: 3.1.101
@@ -60,16 +59,74 @@ $ dotnet --info
6059 Microsoft.NETCore.App 3.1.1 [/nix/store/iiv98i2jdi226dgh4jzkkj2ww7f8jgpd-dotnet-core-combined/shared/Microsoft.NETCore.App]
6160```
6261
63−## dotnet-sdk vs dotnetCorePackages.sdk
62+## dotnet-sdk vs dotnetCorePackages.sdk {#dotnet-sdk-vs-dotnetcorepackages.sdk}
6463
6564The `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.
6665
67−## dotnetCorePackages.sdk vs vs dotnetCorePackages.net vs dotnetCorePackages.netcore vs dotnetCorePackages.aspnetcore
68−
69−The `dotnetCorePackages.sdk` contains both a runtime and the full sdk of a given version. The `net`, `netcore` and `aspnetcore` packages are meant to serve as minimal runtimes to deploy alongside already built applications. For runtime versions >= .NET 5 `net` is used while `netcore` is used for older .NET Core runtime version.
70−
71−## Packaging a Dotnet Application
72−
73−Ideally, we would like to build against the sdk, then only have the dotnet runtime available in the runtime closure.
74−
75−TODO: Create closure-friendly way to package dotnet applications
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.md+13−15
@@ -1,4 +1,4 @@
1−# Emscripten
1+# Emscripten {#emscripten}
22
33[Emscripten](https://github.com/kripken/emscripten): An LLVM-to-JavaScript Compiler
44
@@ -15,28 +15,26 @@ Modes of use of `emscripten`:
1515
1616 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:
1717
18− * `nix-env -i emscripten`
18+ * `nix-env -f "<nixpkgs>" -iA emscripten`
1919 * `nix-shell -p emscripten`
2020
2121* **Declarative usage**:
2222
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`.
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:
2424 * build and install all packages:
2525 * `nix-env -iA emscriptenPackages`
2626
2727 * dev-shell for zlib implementation hacking:
2828 * `nix-shell -A emscriptenPackages.zlib`
2929
30−
31−## Imperative usage
30+## Imperative usage {#imperative-usage}
3231
3332A few things to note:
3433
3534* `export EMCC_DEBUG=2` is nice for debugging
3635* `~/.emscripten`, the build artifact cache sometimes creates issues and needs to be removed from time to time
3736
38−
39−## Declarative usage
37+## Declarative usage {#declarative-usage}
4038
4139Let's see two different examples from `pkgs/top-level/emscripten-packages.nix`:
4240
@@ -50,7 +48,7 @@ A special requirement of the `pkgs.buildEmscriptenPackage` is the `doCheck = tru
5048* Use `export EMCC_DEBUG=2` from within a emscriptenPackage's `phase` to get more detailed debug output what is going wrong.
5149* ~/.emscripten cache is requiring us to set `HOME=$TMPDIR` in individual phases. This makes compilation slower but also makes it more deterministic.
5250
53−### Usage 1: pkgs.zlib.override
51+### Usage 1: pkgs.zlib.override {#usage-1-pkgs.zlib.override}
5452
5553This 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...
5654
@@ -60,7 +58,7 @@ See the `zlib` example:
6058 stdenv = pkgs.emscriptenStdenv;
6159 }).overrideDerivation
6260 (old: rec {
63− buildInputs = old.buildInputs ++ [ pkgconfig ];
61+ buildInputs = old.buildInputs ++ [ pkg-config ];
6462 # we need to reset this setting!
6563 NIX_CFLAGS_COMPILE="";
6664 configurePhase = ''
@@ -102,7 +100,7 @@ See the `zlib` example:
102100 echo "================= /testing zlib using node ================="
103101 '';
104102
105− postPatch = pkgs.stdenv.lib.optionalString pkgs.stdenv.isDarwin ''
103+ postPatch = pkgs.lib.optionalString pkgs.stdenv.isDarwin ''
106104 substituteInPlace configure \
107105 --replace '/usr/bin/libtool' 'ar' \
108106 --replace 'AR="libtool"' 'AR="ar"' \
@@ -110,15 +108,15 @@ See the `zlib` example:
110108 '';
111109 });
112110
113−### Usage 2: pkgs.buildEmscriptenPackage
111+### Usage 2: pkgs.buildEmscriptenPackage {#usage-2-pkgs.buildemscriptenpackage}
114112
115113This `xmlmirror` example features a emscriptenPackage which is defined completely from this context and no `pkgs.zlib.override` is used.
116114
117115 xmlmirror = pkgs.buildEmscriptenPackage rec {
118116 name = "xmlmirror";
119117
120− buildInputs = [ pkgconfig autoconf automake libtool gnumake libxml2 nodejs openjdk json_c ];
121− nativeBuildInputs = [ pkgconfig zlib ];
118+ buildInputs = [ pkg-config autoconf automake libtool gnumake libxml2 nodejs openjdk json_c ];
119+ nativeBuildInputs = [ pkg-config zlib ];
122120
123121 src = pkgs.fetchgit {
124122 url = "https://gitlab.com/odfplugfest/xmlmirror.git";
@@ -165,7 +163,7 @@ This `xmlmirror` example features a emscriptenPackage which is defined completel
165163 '';
166164 };
167165
168−### Declarative debugging
166+### Declarative debugging {#declarative-debugging}
169167
170168Use `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.
171169
@@ -177,7 +175,7 @@ Use `nix-shell -I nixpkgs=/some/dir/nixpkgs -A emscriptenPackages.libz` and from
1771756. `buildPhase`
1781767. ... happy hacking...
179177
180−## Summary
178+## Summary {#summary}
181179
182180Using 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.
183181
doc/languages-frameworks/gnome.section.md+40−8
@@ -8,12 +8,30 @@ Programs in the GNOME universe are written in various languages but they all use
88
99[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`.
1010
11−On Linux, GSettings API is implemented using [dconf](https://wiki.gnome.org/Projects/dconf) backend. You will need to add `dconf` GIO module to `GIO_EXTRA_MODULES` variable, otherwise the `memory` backend will be used and the saved settings will not be persistent.
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.
1212
1313Last you will need the dconf database D-Bus service itself. You can enable it using `programs.dconf.enable`.
1414
1515Some 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.
1616
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+
1735### GdkPixbuf loaders {#ssec-gnome-gdk-pixbuf-loaders}
1836
1937GTK 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`.
@@ -24,7 +42,21 @@ Unlike other libraries mentioned in this section, GdkPixbuf only supports a sing
2442
2543### Icons {#ssec-gnome-icons}
2644
27−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 pass it to our wrapper. 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.
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+```
2860
2961To 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.
3062
@@ -68,27 +100,27 @@ preFixup = ''
68100
69101Fortunately, 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.
70102
71−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. 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.
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.
72104
73105- `wrapGAppsHook` itself will add the package’s `share` directory to `XDG_DATA_DIRS`.
74106
75107- []{#ssec-gnome-hooks-glib} `glib` setup hook will populate `GSETTINGS_SCHEMAS_PATH` and then `wrapGAppsHook` will prepend it to `XDG_DATA_DIRS`.
76108
77−- []{#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.
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.
78110
79111- []{#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;`.
80112
81113- []{#ssec-gnome-hooks-dconf} `dconf.lib` is a dependency of `wrapGAppsHook`, which then also adds it to the `GIO_EXTRA_MODULES` variable.
82114
83−- []{#ssec-gnome-hooks-hicolor-icon-theme} `hicolor-icon-theme`’s setup hook will add icon themes to `XDG_ICON_DIRS` which is prepended to `XDG_DATA_DIRS` by `wrapGAppsHook`.
115+- []{#ssec-gnome-hooks-hicolor-icon-theme} `hicolor-icon-theme`’s setup hook will add icon themes to `XDG_ICON_DIRS`.
84116
85117- []{#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`.
86118
87− ::: warning
119+ ::: {.warning}
88120 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;`.
89121 :::
90122
91−- []{#ssec-gnome-hooks-gst-grl-plugins} Setup hooks of `gst_all_1.gstreamer` and `gnome3.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`.
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`.
92124
93125You can also pass additional arguments to `makeWrapper` using `gappsWrapperArgs` in `preFixup` hook:
94126
@@ -105,7 +137,7 @@ preFixup = ''
105137
106138## Updating GNOME packages {#ssec-gnome-updating}
107139
108−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 gnome3.nautilus` or even en masse with `nix-shell maintainers/scripts/update.nix --argstr path gnome3`. Read the package’s `NEWS` file to see what changed.
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.
109141
110142## Frequently encountered issues {#ssec-gnome-common-issues}
111143
doc/languages-frameworks/go.section.md+25−16
@@ -12,7 +12,7 @@ The function `buildGoModule` builds Go programs managed with Go modules. It buil
1212In the following is an example expression using `buildGoModule`, the following arguments are of special significance to the function:
1313
1414- `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−- `runVend`: runs the vend command to generate 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.
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.
1616
1717```nix
1818pet = buildGoModule rec {
@@ -28,14 +28,11 @@ pet = buildGoModule rec {
2828
2929 vendorSha256 = "1879j77k96684wi554rkjxydrj8g3hpp0kvxz03sd8dmwr3lh83j";
3030
31− runVend = true;
32−
3331 meta = with lib; {
3432 description = "Simple command-line snippet manager, written in Go";
3533 homepage = "https://github.com/knqyf263/pet";
3634 license = licenses.mit;
3735 maintainers = with maintainers; [ kalbasit ];
38− platforms = platforms.linux ++ platforms.darwin;
3936 };
4037}
4138```
@@ -44,7 +41,7 @@ pet = buildGoModule rec {
4441
4542The function `buildGoPackage` builds legacy Go programs, not supporting Go modules.
4643
47−### Example for `buildGoPackage`
44+### Example for `buildGoPackage` {#example-for-buildgopackage}
4845
4946In the following is an example expression using buildGoPackage, the following arguments are of special significance to the function:
5047
@@ -112,23 +109,31 @@ done
112109
113110Both `buildGoModule` and `buildGoPackage` can be tweaked to behave slightly differently, if the following attributes are used:
114111
115−### `buildFlagsArray` and `buildFlags`: {#ex-goBuildFlags-noarray}
112+### `ldflags` {#var-go-ldflags}
116113
117−These attributes set build flags supported by `go build`. We recommend using `buildFlagsArray`. The most common use case of these attributes is to make the resulting executable aware of its own version. For example:
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:
118115
119116```nix
120− buildFlagsArray = [
121− # Note: single quotes are not needed.
122− "-ldflags=-X main.Version=${version} -X main.Commit=${version}"
117+ ldflags = [
118+ "-s" "-w"
119+ "-X main.Version=${version}"
120+ "-X main.Commit=${version}"
123121 ];
124122```
125123
124+### `tags` {#var-go-tags}
125+
126+Arguments to pass to the Go via the `-tags` argument of `go build`. For example:
127+
126128```nix
127− buildFlagsArray = ''
128− -ldflags=
129− -X main.Version=${version}
130− -X main.Commit=${version}
131− '';
129+ tags = [
130+ "production"
131+ "sqlite"
132+ ];
133+```
134+
135+```nix
136+ tags = [ "production" ] ++ lib.optionals withSqlite [ "sqlite" ];
132137```
133138
134139### `deleteVendor` {#var-go-deleteVendor}
@@ -137,4 +142,8 @@ Removes the pre-existing vendor directory. This should only be used if the depen
137142
138143### `subPackages` {#var-go-subPackages}
139144
140−Limits the builder from building child packages that have not been listed. If <varname>subPackages</varname> is not specified, all child packages will be built.
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.md+1−7
@@ -1,10 +1,4 @@
1−---
2−title: User's Guide for Haskell in Nixpkgs
3−author: Peter Simons
4−date: 2015-06-01
5−---
6−
7−# Haskell
1+# Haskell {#haskell}
82
93The documentation for the Haskell infrastructure is published at
104<https://haskell4nix.readthedocs.io/>. The source code for that
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.md+22−23
@@ -1,14 +1,11 @@
1−# Idris
1+# Idris {#idris}
22
3−## Installing Idris
3+## Installing Idris {#installing-idris}
44
55The easiest way to get a working idris version is to install the `idris` attribute:
66
7−```
8−$ # On NixOS
9−$ nix-env -i nixos.idris
10−$ # On non-NixOS
11−$ nix-env -i nixpkgs.idris
7+```ShellSession
8+$ nix-env -f "<nixpkgs>" -iA idris
129```
1310
1411This 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`:
@@ -21,7 +18,7 @@ self: super: {
2118
2219And then:
2320
24−```
21+```ShellSession
2522$ # On NixOS
2623$ nix-env -iA nixos.myIdris
2724$ # On non-NixOS
@@ -29,7 +26,8 @@ $ nix-env -iA nixpkgs.myIdris
2926```
3027
3128To see all available Idris packages:
32−```
29+
30+```ShellSession
3331$ # On NixOS
3432$ nix-env -qaPA nixos.idrisPackages
3533$ # On non-NixOS
@@ -37,22 +35,23 @@ $ nix-env -qaPA nixpkgs.idrisPackages
3735```
3836
3937Similarly, entering a `nix-shell`:
40−```
38+
39+```ShellSession
4140$ nix-shell -p 'idrisPackages.with-packages (with idrisPackages; [ contrib pruviloj ])'
4241```
4342
44−## Starting Idris with library support
43+## Starting Idris with library support {#starting-idris-with-library-support}
4544
4645To have access to these libraries in idris, call it with an argument `-p <library name>` for each library:
4746
48−```
47+```ShellSession
4948$ nix-shell -p 'idrisPackages.with-packages (with idrisPackages; [ contrib pruviloj ])'
5049[nix-shell:~]$ idris -p contrib -p pruviloj
5150```
5251
5352A listing of all available packages the Idris binary has access to is available via `--listlibs`:
5453
55−```
54+```ShellSession
5655$ idris --listlibs
575600prelude-idx.ibc
5857pruviloj
@@ -64,16 +63,16 @@ prelude
646300contrib-idx.ibc
6564```
6665
67−## Building an Idris project with Nix
66+## Building an Idris project with Nix {#building-an-idris-project-with-nix}
6867
6968As an example of how a Nix expression for an Idris package can be created, here is the one for `idrisPackages.yaml`:
7069
7170```nix
72−{ build-idris-package
71+{ lib
72+, build-idris-package
7373, fetchFromGitHub
7474, contrib
7575, lightyear
76−, lib
7776}:
7877build-idris-package {
7978 name = "yaml";
@@ -94,18 +93,18 @@ build-idris-package {
9493 sha256 = "1g4pi0swmg214kndj85hj50ccmckni7piprsxfdzdfhg87s0avw7";
9594 };
9695
97− meta = {
96+ meta = with lib; {
9897 description = "Idris YAML lib";
9998 homepage = "https://github.com/Heather/Idris.Yaml";
100− license = lib.licenses.mit;
101− maintainers = [ lib.maintainers.brainrape ];
99+ license = licenses.mit;
100+ maintainers = [ maintainers.brainrape ];
102101 };
103102}
104103```
105104
106105Assuming this file is saved as `yaml.nix`, it's buildable using
107106
108−```
107+```ShellSession
109108$ nix-build -E '(import <nixpkgs> {}).idrisPackages.callPackage ./yaml.nix {}'
110109```
111110
@@ -121,11 +120,11 @@ with import <nixpkgs> {};
121120
122121in another file (say `default.nix`) to be able to build it with
123122
124−```
123+```ShellSession
125124$ nix-build -A yaml
126125```
127126
128−## Passing options to `idris` commands
127+## Passing options to `idris` commands {#passing-options-to-idris-commands}
129128
130129The `build-idris-package` function provides also optional input values to set additional options for the used `idris` commands.
131130
@@ -133,7 +132,7 @@ Specifically, you can set `idrisBuildOptions`, `idrisTestOptions`, `idrisInstall
133132
134133For example you could set
135134
136−```
135+```nix
137136build-idris-package {
138137 idrisBuildOptions = [ "--log" "1" "--verbose" ]
139138
doc/languages-frameworks/index.xml+8−1
@@ -9,19 +9,26 @@
99 <xi:include href="android.section.xml" />
1010 <xi:include href="beam.section.xml" />
1111 <xi:include href="bower.section.xml" />
12+ <xi:include href="chicken.section.xml" />
1213 <xi:include href="coq.section.xml" />
1314 <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" />
1418 <xi:include href="emscripten.section.xml" />
1519 <xi:include href="gnome.section.xml" />
1620 <xi:include href="go.section.xml" />
1721 <xi:include href="haskell.section.xml" />
22+ <xi:include href="hy.section.xml" />
1823 <xi:include href="idris.section.xml" />
1924 <xi:include href="ios.section.xml" />
2025 <xi:include href="java.section.xml" />
26+ <xi:include href="javascript.section.xml" />
2127 <xi:include href="lua.section.xml" />
2228 <xi:include href="maven.section.xml" />
23− <xi:include href="node.section.xml" />
29+ <xi:include href="nim.section.xml" />
2430 <xi:include href="ocaml.section.xml" />
31+ <xi:include href="octave.section.xml" />
2532 <xi:include href="perl.section.xml" />
2633 <xi:include href="php.section.xml" />
2734 <xi:include href="python.section.xml" />
doc/languages-frameworks/ios.section.md+10−14
@@ -1,9 +1,4 @@
1−---
2−title: iOS
3−author: Sander van der Burg
4−date: 2019-11-10
5−---
6−# iOS
1+# iOS {#ios}
72
83This component is basically a wrapper/workaround that makes it possible to
94expose an Xcode installation as a Nix package by means of symlinking to the
@@ -25,8 +20,8 @@ Hydra.
2520
2621The Xcode build environment implements a number of features.
2722
28−Deploying a proxy component wrapper exposing Xcode
29−--------------------------------------------------
23+## Deploying a proxy component wrapper exposing Xcode {#deploying-a-proxy-component-wrapper-exposing-xcode}
24+
3025The first use case is deploying a Nix package that provides symlinks to the Xcode
3126installation on the host system. This package can be used as a build input to
3227any build function implemented in the Nix expression language that requires
@@ -60,8 +55,8 @@ lrwxr-xr-x 1 sander staff 61 1 jan 1970 xcodebuild -> /Applications/Xcode.a
6055lrwxr-xr-x 1 sander staff 14 1 jan 1970 xcrun -> /usr/bin/xcrun
6156```
6257
63−Building an iOS application
64−---------------------------
58+## Building an iOS application {#building-an-ios-application}
59+
6560We can build an iOS app executable for the simulator, or an IPA/xcarchive file
6661for release purposes, e.g. ad-hoc, enterprise or store installations, by
6762executing the `xcodeenv.buildApp {}` function:
@@ -104,6 +99,7 @@ xcodeenv.buildApp {
10499```
105100
106101The above function takes a variety of parameters:
102+
107103* The `name` and `src` parameters are mandatory and specify the name of the app
108104 and the location where the source code resides
109105* `sdkVersion` specifies which version of the iOS SDK to use.
@@ -156,8 +152,8 @@ the `xcodeenv.composeXcodeWrapper {}` function takes. For example, the
156152`xcodeBaseDir` parameter can be overridden to refer to a different Xcode
157153version.
158154
159−Spawning simulator instances
160−----------------------------
155+## Spawning simulator instances {#spawning-simulator-instances}
156+
161157In addition to building iOS apps, we can also automatically spawn simulator
162158instances:
163159
@@ -218,8 +214,8 @@ xcode.simulateApp {
218214By providing the result of an `xcode.buildApp {}` function and configuring the
219215app bundle id, the app gets deployed automatically and started.
220216
221−Troubleshooting
222−---------------
217+## Troubleshooting {#troubleshooting}
218+
223219In some rare cases, it may happen that after a failure, changes are not picked
224220up. Most likely, this is caused by a derived data cache that Xcode maintains.
225221To wipe it you can run:
doc/languages-frameworks/java.section.md+9
@@ -72,6 +72,15 @@ in
7272 ...
7373```
7474
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+
7584Note all JDKs passthru `home`, so if your application requires
7685environment variables like `JAVA_HOME` being set, that can be done in a
7786generic fashion with the `--set` argument of `makeWrapper`:
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.md+39−38
@@ -1,14 +1,8 @@
1−---
2−title: Lua
3−author: Matthieu Coudron
4−date: 2019-02-05
5−---
1+# User’s Guide to Lua Infrastructure {#users-guide-to-lua-infrastructure}
62
7−# User's Guide to Lua Infrastructure
3+## Using Lua {#using-lua}
84
9−## Using Lua
10−
11−### Overview of Lua
5+### Overview of Lua {#overview-of-lua}
126
137Several versions of the Lua interpreter are available: luajit, lua 5.1, 5.2, 5.3.
148The 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.
@@ -23,27 +17,31 @@ The main package set contains aliases to these package sets, e.g.
2317`luaPackages` refers to `lua5_1.pkgs` and `lua52Packages` to
2418`lua5_2.pkgs`.
2519
26−### Installing Lua and packages
20+### Installing Lua and packages {#installing-lua-and-packages}
2721
28−#### Lua environment defined in separate `.nix` file
22+#### Lua environment defined in separate `.nix` file {#lua-environment-defined-in-separate-.nix-file}
2923
3024Create a file, e.g. `build.nix`, with the following expression
25+
3126```nix
3227with import <nixpkgs> {};
3328
3429lua5_2.withPackages (ps: with ps; [ busted luafilesystem ])
3530```
31+
3632and install it in your profile with
33+
3734```shell
3835nix-env -if build.nix
3936```
4037Now you can use the Lua interpreter, as well as the extra packages (`busted`,
4138`luafilesystem`) that you added to the environment.
4239
43−#### Lua environment defined in `~/.config/nixpkgs/config.nix`
40+#### Lua environment defined in `~/.config/nixpkgs/config.nix` {#lua-environment-defined-in-.confignixpkgsconfig.nix}
4441
4542If you prefer to, you could also add the environment as a package override to the Nixpkgs set, e.g.
4643using `config.nix`,
44+
4745```nix
4846{ # ...
4947
@@ -52,14 +50,16 @@ using `config.nix`,
5250 };
5351}
5452```
53+
5554and install it in your profile with
55+
5656```shell
5757nix-env -iA nixpkgs.myLuaEnv
5858```
59−The environment is is installed by referring to the attribute, and considering
59+The environment is installed by referring to the attribute, and considering
6060the `nixpkgs` channel was used.
6161
62−#### Lua environment defined in `/etc/nixos/configuration.nix`
62+#### Lua environment defined in `/etc/nixos/configuration.nix` {#lua-environment-defined-in-etcnixosconfiguration.nix}
6363
6464For the sake of completeness, here's another example how to install the environment system-wide.
6565
@@ -72,7 +72,7 @@ For the sake of completeness, here's another example how to install the environm
7272}
7373```
7474
75−### How to override a Lua package using overlays?
75+### How to override a Lua package using overlays? {#how-to-override-a-lua-package-using-overlays}
7676
7777Use the following overlay template:
7878
@@ -93,18 +93,22 @@ final: prev:
9393}
9494```
9595
96−### Temporary Lua environment with `nix-shell`
96+### Temporary Lua environment with `nix-shell` {#temporary-lua-environment-with-nix-shell}
9797
9898
9999There are two methods for loading a shell with Lua packages. The first and recommended method
100100is to create an environment with `lua.buildEnv` or `lua.withPackages` and load that. E.g.
101+
101102```sh
102103$ nix-shell -p 'lua.withPackages(ps: with ps; [ busted luafilesystem ])'
103104```
105+
104106opens a shell from which you can launch the interpreter
107+
105108```sh
106109[nix-shell:~] lua
107110```
111+
108112The other method, which is not recommended, does not create an environment and requires you to list the packages directly,
109113
110114```sh
@@ -114,7 +118,7 @@ Again, it is possible to launch the interpreter from the shell.
114118The Lua interpreter has the attribute `pkgs` which contains all Lua libraries for that specific interpreter.
115119
116120
117−## Developing with Lua
121+## Developing with Lua {#developing-with-lua}
118122
119123Now that you know how to get a working Lua environment with Nix, it is time
120124to go forward and start actually developing with Lua. There are two ways to
@@ -122,9 +126,9 @@ package lua software, either it is on luarocks and most of it can be taken care
122126of by the luarocks2nix converter or the packaging has to be done manually.
123127Let's present the luarocks way first and the manual one in a second time.
124128
125−### Packaging a library on luarocks
129+### Packaging a library on luarocks {#packaging-a-library-on-luarocks}
126130
127−[Luarocks.org](www.luarocks.org) is the main repository of lua packages.
131+[Luarocks.org](https://luarocks.org/) is the main repository of lua packages.
128132The site proposes two types of packages, the rockspec and the src.rock
129133(equivalent of a [rockspec](https://github.com/luarocks/luarocks/wiki/Rockspec-format) but with the source).
130134These packages can have different build types such as `cmake`, `builtin` etc .
@@ -135,16 +139,15 @@ the whitelist maintainers/scripts/luarocks-packages.csv and updated by running m
135139[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).
136140The automation only goes so far though and some packages need to be customized.
137141These customizations go in `pkgs/development/lua-modules/overrides.nix`.
138−For instance if the rockspec defines `external_dependencies`, these need to be manually added in in its rockspec file then it won't work.
142+For instance if the rockspec defines `external_dependencies`, these need to be manually added to the overrides.nix.
139143
140144You can try converting luarocks packages to nix packages with the command `nix-shell -p luarocks-nix` and then `luarocks nix PKG_NAME`.
141−Nix rely on luarocks to install lua packages, basically it runs:
142−`luarocks make --deps-mode=none --tree $out`
143145
144−#### Packaging a library manually
146+#### Packaging a library manually {#packaging-a-library-manually}
145147
146148You can develop your package as you usually would, just don't forget to wrap it
147149within a `toLuaModule` call, for instance
150+
148151```nix
149152mynewlib = toLuaModule ( stdenv.mkDerivation { ... });
150153```
@@ -152,16 +155,15 @@ mynewlib = toLuaModule ( stdenv.mkDerivation { ... });
152155There is also the `buildLuaPackage` function that can be used when lua modules
153156are not packaged for luarocks. You can see a few examples at `pkgs/top-level/lua-packages.nix`.
154157
155−## Lua Reference
158+## Lua Reference {#lua-reference}
156159
157−### Lua interpreters
160+### Lua interpreters {#lua-interpreters}
158161
159−Versions 5.1, 5.2 and 5.3 of the lua interpreter are available as
160−respectively `lua5_1`, `lua5_2` and `lua5_3`. Luajit is available too.
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.
161164The Nix expressions for the interpreters can be found in `pkgs/development/interpreters/lua-5`.
162165
163−
164−#### Attributes on lua interpreters packages
166+#### Attributes on lua interpreters packages {#attributes-on-lua-interpreters-packages}
165167
166168Each interpreter has the following attributes:
167169
@@ -170,8 +172,7 @@ Each interpreter has the following attributes:
170172- `withPackages`. Simpler interface to `buildEnv`.
171173- `pkgs`. Set of Lua packages for that specific interpreter. The package set can be modified by overriding the interpreter and passing `packageOverrides`.
172174
173−
174−#### `buildLuarocksPackage` function
175+#### `buildLuarocksPackage` function {#buildluarockspackage-function}
175176
176177The `buildLuarocksPackage` function is implemented in `pkgs/development/interpreters/lua-5/build-lua-package.nix`
177178The following is an example:
@@ -187,7 +188,7 @@ luaposix = buildLuarocksPackage {
187188 disabled = (luaOlder "5.1") || (luaAtLeast "5.4");
188189 propagatedBuildInputs = [ bit32 lua std_normalize ];
189190
190− meta = with stdenv.lib; {
191+ meta = with lib; {
191192 homepage = "https://github.com/luaposix/luaposix/";
192193 description = "Lua bindings for POSIX";
193194 maintainers = with maintainers; [ vyp lblasc ];
@@ -211,16 +212,17 @@ install the package
211212
212213By default `meta.platforms` is set to the same value as the interpreter unless overridden otherwise.
213214
214−#### `buildLuaApplication` function
215+#### `buildLuaApplication` function {#buildluaapplication-function}
215216
216217The `buildLuaApplication` function is practically the same as `buildLuaPackage`.
217218The difference is that `buildLuaPackage` by default prefixes the names of the packages with the version of the interpreter.
218219Because with an application we're not interested in multiple version the prefix is dropped.
219220
220−#### lua.withPackages function
221+#### lua.withPackages function {#lua.withpackages-function}
221222
222223The `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.
223224Using the `withPackages` function, the previous example for the luafilesystem environment can be written like this:
225+
224226```nix
225227with import <nixpkgs> {};
226228
@@ -229,6 +231,7 @@ lua.withPackages (ps: [ps.luafilesystem])
229231
230232`withPackages` passes the correct package set for the specific interpreter version as an argument to the function. In the above example, `ps` equals `luaPackages`.
231233But you can also easily switch to using `lua5_2`:
234+
232235```nix
233236with import <nixpkgs> {};
234237
@@ -237,16 +240,14 @@ lua5_2.withPackages (ps: [ps.lua])
237240
238241Now, `ps` is set to `lua52Packages`, matching the version of the interpreter.
239242
240−
241−### Possible Todos
243+### Possible Todos {#possible-todos}
242244
243245* export/use version specific variables such as `LUA_PATH_5_2`/`LUAROCKS_CONFIG_5_2`
244246* let luarocks check for dependencies via exporting the different rocktrees in temporary config
245247
246−### Lua Contributing guidelines
248+### Lua Contributing guidelines {#lua-contributing-guidelines}
247249
248250Following rules should be respected:
249251
250252* Make sure libraries build for all Lua interpreters.
251253* Commit names of Lua libraries should reflect that they are Lua libraries, so write for example `luaPackages.luafilesystem: 1.11 -> 1.12`.
252−
doc/languages-frameworks/maven.section.md+16−19
@@ -1,10 +1,4 @@
1−---
2−title: Maven
3−author: Farid Zakaria
4−date: 2020-10-15
5−---
6−
7−# Maven
1+# Maven {#maven}
82
93Maven is a well-known build tool for the Java ecosystem however it has some challenges when integrating into the Nix build system.
104
@@ -49,9 +43,9 @@ public class Main {
4943
5044You find this demo project at https://github.com/fzakaria/nixos-maven-example
5145
52−## Solving for dependencies
46+## Solving for dependencies {#solving-for-dependencies}
5347
54−### buildMaven with NixOS/mvn2nix-maven-plugin
48+### buildMaven with NixOS/mvn2nix-maven-plugin {#buildmaven-with-nixosmvn2nix-maven-plugin}
5549
5650> ⚠️ Although `buildMaven` is the "blessed" way within nixpkgs, as of 2020, it hasn't seen much activity in quite a while.
5751
@@ -88,6 +82,7 @@ This file is then given to the `buildMaven` function, and it returns 2 attribute
8882 A simple derivation that runs through `mvn compile` & `mvn package` to build the JAR. You may use this as inspiration for more complicated derivations.
8983
9084Here is an [example](https://github.com/fzakaria/nixos-maven-example/blob/main/build-maven-repository.nix) of building the Maven repository
85+
9186```nix
9287{ pkgs ? import <nixpkgs> { } }:
9388with pkgs;
@@ -109,7 +104,8 @@ The benefit over the _double invocation_ as we will see below, is that the _/nix
109104│ └── 4.1.3
110105│ ├── avalon-framework-4.1.3.jar -> /nix/store/iv5fp3955w3nq28ff9xfz86wvxbiw6n9-avalon-framework-4.1.3.jar
111106```
112−### Double Invocation
107+
108+### Double Invocation {#double-invocation}
113109
114110> ⚠️ This pattern is the simplest but may cause unnecessary rebuilds due to the output hash changing.
115111
@@ -122,7 +118,7 @@ The first step will be to build the Maven project as a fixed-output derivation i
122118> Traditionally the Maven repository is at `~/.m2/repository`. We will override this to be the `$out` directory.
123119
124120```nix
125−{ stdenv, maven }:
121+{ lib, stdenv, maven }:
126122stdenv.mkDerivation {
127123 name = "maven-repository";
128124 buildInputs = [ maven ];
@@ -145,7 +141,7 @@ stdenv.mkDerivation {
145141 outputHashAlgo = "sha256";
146142 outputHashMode = "recursive";
147143 # replace this with the correct SHA256
148− outputHash = stdenv.lib.fakeSha256;
144+ outputHash = lib.fakeSha256;
149145}
150146```
151147
@@ -169,12 +165,12 @@ The build will fail, and tell you the expected `outputHash` to place. When you'v
169165
170166If 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`.
171167
172−## Building a JAR
168+## Building a JAR {#building-a-jar}
173169
174170Regardless of which strategy is chosen above, the step to build the derivation is the same.
175171
176172```nix
177−{ stdenv, lib, maven, callPackage }:
173+{ stdenv, maven, callPackage }:
178174# pick a repository derivation, here we will use buildMaven
179175let repository = callPackage ./build-maven-repository.nix { };
180176in stdenv.mkDerivation rec {
@@ -207,7 +203,7 @@ in stdenv.mkDerivation rec {
2072032 directories, 1 file
208204```
209205
210−## Runnable JAR
206+## Runnable JAR {#runnable-jar}
211207
212208The previous example builds a `jar` file but that's not a file one can run.
213209
@@ -219,7 +215,7 @@ We will use the same repository we built above (either _double invocation_ or _b
219215
220216The following two methods are more suited to Nix then building an [UberJar](https://imagej.net/Uber-JAR) which may be the more traditional approach.
221217
222−### CLASSPATH
218+### CLASSPATH {#classpath}
223219
224220> This is ideal if you are providing a derivation for _nixpkgs_ and don't want to patch the project's `pom.xml`.
225221
@@ -228,7 +224,7 @@ We will read the Maven repository and flatten it to a single list. This list wil
228224We make sure to provide this classpath to the `makeWrapper`.
229225
230226```nix
231−{ stdenv, lib, maven, callPackage, makeWrapper, jre }:
227+{ stdenv, maven, callPackage, makeWrapper, jre }:
232228let
233229 repository = callPackage ./build-maven-repository.nix { };
234230in stdenv.mkDerivation rec {
@@ -258,11 +254,12 @@ in stdenv.mkDerivation rec {
258254}
259255```
260256
261−### MANIFEST file via Maven Plugin
257+### MANIFEST file via Maven Plugin {#manifest-file-via-maven-plugin}
262258
263259> This is ideal if you are the project owner and want to change your `pom.xml` to set the CLASSPATH within it.
264260
265261Augment the `pom.xml` to create a JAR with the following manifest:
262+
266263```xml
267264<build>
268265 <plugins>
@@ -304,7 +301,7 @@ Main-Class: Main
304301We will modify the derivation above to add a symlink to our repository so that it's accessible to our JAR during the `installPhase`.
305302
306303```nix
307−{ stdenv, lib, maven, callPackage, makeWrapper, jre }:
304+{ stdenv, maven, callPackage, makeWrapper, jre }:
308305# pick a repository derivation, here we will use buildMaven
309306let repository = callPackage ./build-maven-repository.nix { };
310307in stdenv.mkDerivation rec {
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/node.section.mddeleted−51
@@ -1,51 +0,0 @@
1−Node.js
2−=======
3−The `pkgs/development/node-packages` folder contains a generated collection of
4−[NPM packages](https://npmjs.com/) that can be installed with the Nix package
5−manager.
6−
7−As a rule of thumb, the package set should only provide *end user* software
8−packages, such as command-line utilities. Libraries should only be added to the
9−package set if there is a non-NPM package that requires it.
10−
11−When it is desired to use NPM libraries in a development project, use the
12−`node2nix` generator directly on the `package.json` configuration file of the
13−project.
14−
15−The package set provides support for the official stable Node.js versions.
16−The latest stable LTS release in `nodePackages`, as well as the latest stable
17−Current release in `nodePackages_latest`.
18−
19−If your package uses native addons, you need to examine what kind of native
20−build system it uses. Here are some examples:
21−
22−* `node-gyp`
23−* `node-gyp-builder`
24−* `node-pre-gyp`
25−
26−After you have identified the correct system, you need to override your package
27−expression while adding in build system as a build input. For example, `dat`
28−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):
29−
30−```nix
31− dat = super.dat.override {
32− buildInputs = [ self.node-gyp-build pkgs.libtool pkgs.autoconf pkgs.automake ];
33− meta.broken = since "12";
34− };
35−```
36−
37−To add a package from NPM to nixpkgs:
38−
39− 1. Modify `pkgs/development/node-packages/node-packages.json` to add, update
40− or remove package entries to have it included in `nodePackages` and
41− `nodePackages_latest`.
42− 2. Run the script: `(cd pkgs/development/node-packages && ./generate.sh)`.
43− 3. Build your new package to test your changes:
44− `cd /path/to/nixpkgs && nix-build -A nodePackages.<new-or-updated-package>`.
45− To build against the latest stable Current Node.js version (e.g. 14.x):
46− `nix-build -A nodePackages_latest.<new-or-updated-package>`
47− 4. Add and commit all modified and generated files.
48−
49−For more information about the generation process, consult the
50−[README.md](https://github.com/svanderburg/node2nix) file of the `node2nix`
51−tool.
doc/languages-frameworks/ocaml.section.md+86−25
@@ -1,66 +1,119 @@
11# OCaml {#sec-language-ocaml}
22
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+
329OCaml 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`.
430
531Given 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`.
632
7−Here is a simple package example. It defines an (optional) attribute `minimumOCamlVersion` that will be used to throw a descriptive evaluation error if building with an older OCaml is attempted. It uses the `fetchFromGitHub` fetcher to get its source. It sets the `doCheck` (optional) attribute to `true` which means that tests will be run with `dune runtest -p angstrom` after the build (`dune build -p angstrom`) is complete. It uses `alcotest` as a build input (because it is needed to run the tests) and `bigstringaf` and `result` as propagated build inputs (thus they will also be available to libraries depending on this library). The library will be installed using the `angstrom.install` file that dune generates.
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.
859
960```nix
10−{ stdenv
11−, fetchFromGitHub
12−, buildDunePackage
13−, alcotest
14−, result
15−, bigstringaf
16−}:
61+{ lib,
62+ fetchFromGitHub,
63+ buildDunePackage,
64+ ocaml,
65+ ocaml-syntax-shims,
66+ alcotest,
67+ result,
68+ bigstringaf,
69+ ppx_let }:
1770
1871buildDunePackage rec {
1972 pname = "angstrom";
20− version = "0.10.0";
73+ version = "0.15.0";
74+ duneVersion = "2";
2175
22− minimumOCamlVersion = "4.03";
76+ minimalOCamlVersion = "4.04";
2377
2478 src = fetchFromGitHub {
2579 owner = "inhabitedtype";
2680 repo = pname;
2781 rev = version;
28− sha256 = "0lh6024yf9ds0nh9i93r9m6p5psi8nvrqxl5x7jwl13zb0r9xfpw";
82+ sha256 = "1hmrkdcdlkwy7rxhngf3cv3sa61cznnd9p5lmqhx20664gx2ibrh";
2983 };
3084
31− buildInputs = [ alcotest ];
85+ checkInputs = [ alcotest ppx_let ];
86+ buildInputs = [ ocaml-syntax-shims ];
3287 propagatedBuildInputs = [ bigstringaf result ];
33− doCheck = true;
88+ doCheck = lib.versionAtLeast ocaml.version "4.05";
3489
3590 meta = {
3691 homepage = "https://github.com/inhabitedtype/angstrom";
3792 description = "OCaml parser combinators built for speed and memory efficiency";
38− license = stdenv.lib.licenses.bsd3;
39− maintainers = with stdenv.lib.maintainers; [ sternenseemann ];
93+ license = lib.licenses.bsd3;
94+ maintainers = with lib.maintainers; [ sternenseemann ];
4095 };
41−}
4296```
4397
4498Here 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.
4599
46100```nix
47−{ stdenv
48−, fetchurl
49−, buildDunePackage
50−}:
101+{ lib, fetchurl, buildDunePackage }:
51102
52103buildDunePackage rec {
53104 pname = "wtf8";
54− version = "1.0.1";
105+ version = "1.0.2";
55106
56− minimumOCamlVersion = "4.01";
107+ useDune2 = true;
108+
109+ minimalOCamlVersion = "4.02";
57110
58111 src = fetchurl {
59− url = "https://github.com/flowtype/ocaml-${pname}/releases/download/v${version}/${pname}-${version}.tbz";
60− sha256 = "1msg3vycd3k8qqj61sc23qks541cxpb97vrnrvrhjnqxsqnh6ygq";
112+ url = "https://github.com/flowtype/ocaml-${pname}/releases/download/v${version}/${pname}-v${version}.tbz";
113+ sha256 = "09ygcxxd5warkdzz17rgpidrd0pg14cy2svvnvy1hna080lzg7vp";
61114 };
62115
63− meta = with stdenv.lib; {
116+ meta = with lib; {
64117 homepage = "https://github.com/flowtype/ocaml-wtf8";
65118 description = "WTF-8 is a superset of UTF-8 that allows unpaired surrogates.";
66119 license = licenses.mit;
@@ -68,3 +121,11 @@ buildDunePackage rec {
68121 };
69122}
70123```
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.md+8−12
@@ -58,13 +58,7 @@ in `all-packages.nix`. You can test building a Perl package as follows:
5858$ nix-build -A perlPackages.ClassC3
5959```
6060
61−`buildPerlPackage` adds `perl-` to the start of the name attribute, so the package above is actually called `perl-Class-C3-0.21`. So to install it, you can say:
62−
63−```ShellSession
64−$ nix-env -i perl-Class-C3
65−```
66−
67−(Of course you can also install using the attribute name: `nix-env -i -A perlPackages.ClassC3`.)
61+To install it with `nix-env` instead: `nix-env -f. -iA perlPackages.ClassC3`.
6862
6963So what does `buildPerlPackage` do? It does the following:
7064
@@ -110,7 +104,7 @@ ClassC3Componentised = buildPerlPackage rec {
110104On 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:
111105
112106```nix
113−{ stdenv, buildPerlPackage, fetchurl, shortenPerlShebang }:
107+{ lib, stdenv, buildPerlPackage, fetchurl, shortenPerlShebang }:
114108
115109ImageExifTool = buildPerlPackage {
116110 pname = "Image-ExifTool";
@@ -121,8 +115,8 @@ ImageExifTool = buildPerlPackage {
121115 sha256 = "0d8v48y94z8maxkmw1rv7v9m0jg2dc8xbp581njb6yhr7abwqdv3";
122116 };
123117
124− buildInputs = stdenv.lib.optional stdenv.isDarwin shortenPerlShebang;
125− postInstall = stdenv.lib.optional stdenv.isDarwin ''
118+ buildInputs = lib.optional stdenv.isDarwin shortenPerlShebang;
119+ postInstall = lib.optionalString stdenv.isDarwin ''
126120 shortenPerlShebang $out/bin/exiftool
127121 '';
128122};
@@ -135,9 +129,11 @@ This will remove the `-I` flags from the shebang line, rewrite them in the `use
135129Nix 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:
136130
137131```ShellSession
138−$ nix-env -i nix-generate-from-cpan
132+$ nix-env -f "<nixpkgs>" -iA nix-generate-from-cpan
139133```
140134
135+Substitute `<nixpkgs>` by the path of a nixpkgs clone to use the latest version.
136+
141137This 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:
142138
143139```ShellSession
@@ -151,7 +147,7 @@ $ nix-generate-from-cpan XML::Simple
151147 propagatedBuildInputs = [ XMLNamespaceSupport XMLSAX XMLSAXExpat ];
152148 meta = {
153149 description = "An API for simple XML files";
154− license = with stdenv.lib.licenses; [ artistic1 gpl1Plus ];
150+ license = with lib.licenses; [ artistic1 gpl1Plus ];
155151 };
156152 };
157153```
doc/languages-frameworks/python.section.md+220−106
@@ -1,14 +1,15 @@
1−# Python
1+# Python {#python}
22
3−## User Guide
3+## User Guide {#user-guide}
44
5−### Using Python
5+### Using Python {#using-python}
66
7−#### Overview
7+#### Overview {#overview}
88
99Several versions of the Python interpreter are available on Nix, as well as a
10−high amount of packages. The attribute `python` refers to the default
11−interpreter, which is currently CPython 2.7. It is also possible to refer to
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
1213specific versions, e.g. `python38` refers to CPython 3.8, and `pypy` refers to
1314the default PyPy interpreter.
1415
@@ -30,7 +31,7 @@ The main package set contains aliases to these package sets, e.g.
3031`pythonPackages` refers to `python.pkgs` and `python38Packages` to
3132`python38.pkgs`.
3233
33−#### Installing Python and packages
34+#### Installing Python and packages {#installing-python-and-packages}
3435
3536The Nix and NixOS manuals explain how packages are generally installed. In the
3637case of Python and Nix, it is important to make a distinction between whether the
@@ -61,7 +62,7 @@ Philosphically, this should be familiar to users who are used to a `venv` style
6162of development: individual projects create their own Python environments without
6263impacting the global environment or each other.
6364
64−#### Ad-hoc temporary Python environment with `nix-shell`
65+#### Ad-hoc temporary Python environment with `nix-shell` {#ad-hoc-temporary-python-environment-with-nix-shell}
6566
6667The simplest way to start playing with the way nix wraps and sets up Python
6768environments is with `nix-shell` at the cmdline. These environments create a
@@ -78,7 +79,7 @@ $ nix-shell -p 'python38.withPackages(ps: with ps; [ numpy toolz ])'
7879By default `nix-shell` will start a `bash` session with this interpreter in our
7980`PATH`, so if we then run:
8081
81−```
82+```Python console
8283[nix-shell:~/src/nixpkgs]$ python3
8384Python 3.8.1 (default, Dec 18 2019, 19:06:26)
8485[GCC 9.2.0] on linux
@@ -89,7 +90,7 @@ Type "help", "copyright", "credits" or "license" for more information.
8990Note that no other modules are in scope, even if they were imperatively
9091installed into our user environment as a dependency of a Python application:
9192
92−```
93+```Python console
9394>>> import requests
9495Traceback (most recent call last):
9596 File "<stdin>", line 1, in <module>
@@ -130,7 +131,7 @@ arbitrary dependencies. This is a good way to get a feel for how the Python
130131interpreter and dependencies work in Nix and NixOS, but to do some actual
131132development, we'll want to make it a bit more persistent.
132133
133−##### Running Python scripts and using `nix-shell` as shebang
134+##### Running Python scripts and using `nix-shell` as shebang {#running-python-scripts-and-using-nix-shell-as-shebang}
134135
135136Sometimes, we have a script whose header looks like this:
136137
@@ -145,8 +146,8 @@ print(f"The dot product of {a} and {b} is: {np.dot(a, b)}")
145146Executing this script requires a `python3` that has `numpy`. Using what we learned
146147in the previous section, we could startup a shell and just run it like so:
147148
148−```
149−nix-shell -p 'python38.withPackages(ps: with ps; [ numpy ])' --run 'python3 foo.py'
149+```ShellSession
150+$ nix-shell -p 'python38.withPackages(ps: with ps; [ numpy ])' --run 'python3 foo.py'
150151The dot product of [1 2] and [3 4] is: 11
151152```
152153
@@ -202,7 +203,7 @@ of the package versions.
202203This is also a great way to ensure the script executes identically on different
203204servers.
204205
205−##### Load environment from `.nix` expression
206+##### Load environment from `.nix` expression {#load-environment-from-.nix-expression}
206207
207208We've now seen how to create an ad-hoc temporary shell session, and how to
208209create a single script with Python dependencies, but in the course of normal
@@ -244,7 +245,7 @@ let
244245 ps.toolz
245246 ]);
246247in mkShell {
247− buildInputs = [
248+ packages = [
248249 pythonEnv
249250
250251 black
@@ -261,7 +262,7 @@ and its Python dependencies, but also tools like `black` or `mypy` and libraries
261262like `libffi` the `openssl` in scope. This is generic and can span any number of
262263tools or languages across the Nixpkgs ecosystem.
263264
264−##### Installing environments globally on the system
265+##### Installing environments globally on the system {#installing-environments-globally-on-the-system}
265266
266267Up to now, we've been creating environments scoped to an ad-hoc shell session,
267268or a single script, or a single project. This is generally advisable, as it
@@ -314,7 +315,7 @@ If you get a conflict or prefer to keep the setup clean, you can have `nix-env`
314315atomically *uninstall* all other imperatively installed packages and replace
315316your profile with just `myEnv` by using the `--replace` flag.
316317
317−##### Environment defined in `/etc/nixos/configuration.nix`
318+##### Environment defined in `/etc/nixos/configuration.nix` {#environment-defined-in-etcnixosconfiguration.nix}
318319
319320For the sake of completeness, here's how to install the environment system-wide
320321on NixOS.
@@ -328,16 +329,16 @@ on NixOS.
328329}
329330```
330331
331−### Developing with Python
332+### Developing with Python {#developing-with-python}
332333
333334Above, we were mostly just focused on use cases and what to do to get started
334335creating working Python environments in nix.
335336
336337Now that you know the basics to be up and running, it is time to take a step
337−back and take a deeper look at at how Python packages are packaged on Nix. Then,
338+back and take a deeper look at how Python packages are packaged on Nix. Then,
338339we will look at how you can use development mode with your code.
339340
340−#### Python library packages in Nixpkgs
341+#### Python library packages in Nixpkgs {#python-library-packages-in-nixpkgs}
341342
342343With Nix all packages are built by functions. The main function in Nix for
343344building Python libraries is `buildPythonPackage`. Let's see how we can build the
@@ -424,7 +425,7 @@ of `withPackages` we used a `let` expression. You can see that we used
424425`toolz` from the Nixpkgs package set this time, but instead took our own version
425426that we introduced with the `let` expression.
426427
427−#### Handling dependencies
428+#### Handling dependencies {#handling-dependencies}
428429
429430Our example, `toolz`, does not have any dependencies on other Python packages or
430431system libraries. According to the manual, `buildPythonPackage` uses the
@@ -438,7 +439,7 @@ The following example shows which arguments are given to `buildPythonPackage` in
438439order to build [`datashape`](https://github.com/blaze/datashape).
439440
440441```nix
441−{ lib, buildPythonPackage, fetchPypi, numpy, multipledispatch, dateutil, pytest }:
442+{ lib, buildPythonPackage, fetchPypi, numpy, multipledispatch, python-dateutil, pytest }:
442443
443444buildPythonPackage rec {
444445 pname = "datashape";
@@ -450,7 +451,7 @@ buildPythonPackage rec {
450451 };
451452
452453 checkInputs = [ pytest ];
453− propagatedBuildInputs = [ numpy multipledispatch dateutil ];
454+ propagatedBuildInputs = [ numpy multipledispatch python-dateutil ];
454455
455456 meta = with lib; {
456457 homepage = "https://github.com/ContinuumIO/datashape";
@@ -462,7 +463,7 @@ buildPythonPackage rec {
462463```
463464
464465We can see several runtime dependencies, `numpy`, `multipledispatch`, and
465−`dateutil`. Furthermore, we have one `checkInputs`, i.e. `pytest`. `pytest` is a
466+`python-dateutil`. Furthermore, we have one `checkInputs`, i.e. `pytest`. `pytest` is a
466467test runner and is only used during the `checkPhase` and is therefore not added
467468to `propagatedBuildInputs`.
468469
@@ -536,9 +537,10 @@ buildPythonPackage rec {
536537 };
537538}
538539```
540+
539541Note also the line `doCheck = false;`, we explicitly disabled running the test-suite.
540542
541−#### Testing Python Packages
543+#### Testing Python Packages {#testing-python-packages}
542544
543545It is highly encouraged to have testing as part of the package build. This
544546helps to avoid situations where the package was able to build and install,
@@ -558,10 +560,11 @@ thus can cause issues when a test suite asserts on that behavior.
558560as many tests should be enabled as possible. Failing tests can still be
559561a good indication that the package is not in a valid state.
560562
561−#### Using pytest
563+#### Using pytest {#using-pytest}
562564
563565Pytest is the most common test runner for python repositories. A trivial
564566test run would be:
567+
565568```
566569 checkInputs = [ pytest ];
567570 checkPhase = "pytest";
@@ -571,6 +574,7 @@ However, many repositories' test suites do not translate well to nix's build
571574sandbox, and will generally need many tests to be disabled.
572575
573576To filter tests using pytest, one can do the following:
577+
574578```
575579 checkInputs = [ pytest ];
576580 # avoid tests which need additional data or touch network
@@ -586,19 +590,20 @@ easier than having to create a new package.
586590
587591`-k` is used to define a predicate for test names. In this example, we are
588592filtering out tests which contain `download` or `update` in their test case name.
589−Only one `-k` argument is allows, and thus a long predicate should be concatenated
590−with "\" and wrapped to the next line.
593+Only one `-k` argument is allowed, and thus a long predicate should be concatenated
594+with “\\” and wrapped to the next line.
591595
592−*NOTE:* In pytest==6.0.1, the use of "\" to continue a line (e.g. `-k 'not download \'`) has
596+*NOTE:* In pytest==6.0.1, the use of “\\” to continue a line (e.g. `-k 'not download \'`) has
593597been removed, in this case, it's recommended to use `pytestCheckHook`.
594598
595−#### Using pytestCheckHook
599+#### Using pytestCheckHook {#using-pytestcheckhook}
596600
597601`pytestCheckHook` is a convenient hook which will substitute the setuptools
598602`test` command for a checkPhase which runs `pytest`. This is also beneficial
599603when a package may need many items disabled to run the test suite.
600604
601605Using the example above, the analagous pytestCheckHook usage would be:
606+
602607```
603608 checkInputs = [ pytestCheckHook ];
604609
@@ -610,6 +615,10 @@ Using the example above, the analagous pytestCheckHook usage would be:
610615 "download"
611616 "update"
612617 ];
618+
619+ disabledTestPaths = [
620+ "tests/test_failing.py"
621+ ];
613622```
614623
615624This is expecially useful when tests need to be conditionallydisabled,
@@ -632,9 +641,9 @@ Trying to concatenate the related strings to disable tests in a regular checkPha
632641would be much harder to read. This also enables us to comment on why specific tests
633642are disabled.
634643
635−#### Using pythonImportsCheck
644+#### Using pythonImportsCheck {#using-pythonimportscheck}
636645
637−Although unit tests are highly prefered to valid correctness of a package. Not
646+Although unit tests are highly prefered to validate correctness of a package, not
638647all packages have test suites that can be ran easily, and some have none at all.
639648To help ensure the package still works, `pythonImportsCheck` can attempt to import
640649the listed modules.
@@ -654,7 +663,7 @@ However, this is done in it's own phase, and not dependent on whether `doCheck =
654663This can also be useful in verifying that the package doesn't assume commonly
655664present packages (e.g. `setuptools`)
656665
657−### Develop local package
666+### Develop local package {#develop-local-package}
658667
659668As a Python developer you're likely aware of [development mode](http://setuptools.readthedocs.io/en/latest/setuptools.html#development-mode)
660669(`python setup.py develop`); instead of installing the package this command
@@ -689,7 +698,7 @@ buildPythonPackage rec {
689698It is important to note that due to how development mode is implemented on Nix
690699it is not possible to have multiple packages simultaneously in development mode.
691700
692−### Organising your packages
701+### Organising your packages {#organising-your-packages}
693702
694703So far we discussed how you can use Python on Nix, and how you can develop with
695704it. We've looked at how you write expressions to package Python packages, and we
@@ -701,7 +710,7 @@ like to be able to use in different projects. In order to minimise unnecessary
701710duplication we now look at how you can maintain a repository with your
702711own packages. The important functions here are `import` and `callPackage`.
703712
704−### Including a derivation using `callPackage`
713+### Including a derivation using `callPackage` {#including-a-derivation-using-callpackage}
705714
706715Earlier we created a Python environment using `withPackages`, and included the
707716`toolz` package via a `let` expression.
@@ -751,28 +760,28 @@ don't explicitly define which `python` derivation should be used. In the above
751760example we use `buildPythonPackage` that is part of the set `python38Packages`,
752761and in this case the `python38` interpreter is automatically used.
753762
754−## Reference
763+## Reference {#reference}
755764
756−### Interpreters
765+### Interpreters {#interpreters}
757766
758−Versions 2.7, 3.6, 3.7, 3.8 and 3.9 of the CPython interpreter are available as
759−respectively `python27`, `python36`, `python37`, `python38` and `python39`. The
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
760769aliases `python2` and `python3` correspond to respectively `python27` and
761−`python38`. The default interpreter, `python`, maps to `python2`. The PyPy
762−interpreters compatible with Python 2.7 and 3 are available as `pypy27` and
763−`pypy3`, with aliases `pypy2` mapping to `pypy27` and `pypy` mapping to `pypy2`.
764−The Nix expressions for the interpreters can be found in
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
765774`pkgs/development/interpreters/python`.
766775
767776All packages depending on any Python interpreter get appended
768777`out/{python.sitePackages}` to `$PYTHONPATH` if such directory
769778exists.
770779
771−#### Missing `tkinter` module standard library
780+#### Missing `tkinter` module standard library {#missing-tkinter-module-standard-library}
772781
773782To reduce closure size the `Tkinter`/`tkinter` is available as a separate package, `pythonPackages.tkinter`.
774783
775−#### Attributes on interpreters packages
784+#### Attributes on interpreters packages {#attributes-on-interpreters-packages}
776785
777786Each interpreter has the following attributes:
778787
@@ -784,7 +793,24 @@ Each interpreter has the following attributes:
784793- `executable`. Name of the interpreter executable, e.g. `python3.8`.
785794- `pkgs`. Set of Python packages for that specific interpreter. The package set can be modified by overriding the interpreter and passing `packageOverrides`.
786795
787−### Building packages and applications
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}
788814
789815Python libraries and applications that use `setuptools` or
790816`distutils` are typically built with respectively the `buildPythonPackage` and
@@ -804,19 +830,20 @@ attribute set is created for each available Python interpreter. The available
804830sets are
805831
806832* `pkgs.python27Packages`
807−* `pkgs.python36Packages`
808833* `pkgs.python37Packages`
809834* `pkgs.python38Packages`
810835* `pkgs.python39Packages`
836+* `pkgs.python310Packages`
837+* `pkgs.python311Packages`
811838* `pkgs.pypyPackages`
812839
813840and the aliases
814841
815842* `pkgs.python2Packages` pointing to `pkgs.python27Packages`
816−* `pkgs.python3Packages` pointing to `pkgs.python38Packages`
843+* `pkgs.python3Packages` pointing to `pkgs.python39Packages`
817844* `pkgs.pythonPackages` pointing to `pkgs.python2Packages`
818845
819−#### `buildPythonPackage` function
846+#### `buildPythonPackage` function {#buildpythonpackage-function}
820847
821848The `buildPythonPackage` function is implemented in
822849`pkgs/development/interpreters/python/mk-python-derivation`
@@ -825,7 +852,7 @@ using setup hooks.
825852The following is an example:
826853
827854```nix
828−{ lib, buildPythonPackage, fetchPypi, hypothesis, setuptools_scm, attrs, py, setuptools, six, pluggy }:
855+{ lib, buildPythonPackage, fetchPypi, hypothesis, setuptools-scm, attrs, py, setuptools, six, pluggy }:
829856
830857buildPythonPackage rec {
831858 pname = "pytest";
@@ -842,7 +869,7 @@ buildPythonPackage rec {
842869 '';
843870
844871 checkInputs = [ hypothesis ];
845− nativeBuildInputs = [ setuptools_scm ];
872+ nativeBuildInputs = [ setuptools-scm ];
846873 propagatedBuildInputs = [ attrs py setuptools six pluggy ];
847874
848875 meta = with lib; {
@@ -868,7 +895,7 @@ e.g. the test runner, should be added to `checkInputs`.
868895By default `meta.platforms` is set to the same value
869896as the interpreter unless overridden otherwise.
870897
871−##### `buildPythonPackage` parameters
898+##### `buildPythonPackage` parameters {#buildpythonpackage-parameters}
872899
873900All parameters from `stdenv.mkDerivation` function are still supported. The
874901following are specific to `buildPythonPackage`:
@@ -914,7 +941,7 @@ because their behaviour is different:
914941
915942* `nativeBuildInputs ? []`: Build-time only dependencies. Typically executables
916943 as well as the items listed in `setup_requires`.
917−* `buildInputs ? []`: Build and/or run-time dependencies that need to be be
944+* `buildInputs ? []`: Build and/or run-time dependencies that need to be
918945 compiled for the host machine. Typically non-Python libraries which are being
919946 linked.
920947* `checkInputs ? []`: Dependencies needed for running the `checkPhase`. These
@@ -924,7 +951,7 @@ because their behaviour is different:
924951 `buildPythonPackage` also injects code into and wraps executables with the
925952 paths included in this list. Items listed in `install_requires` go here.
926953
927−##### Overriding Python packages
954+##### Overriding Python packages {#overriding-python-packages}
928955
929956The `buildPythonPackage` function has a `overridePythonAttrs` method that can be
930957used to override the package. In the following example we create an environment
@@ -952,7 +979,32 @@ with import <nixpkgs> {};
952979in python.withPackages(ps: [ps.blaze])).env
953980```
954981
955−#### `buildPythonApplication` function
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}
9561008
9571009The `buildPythonApplication` function is practically the same as
9581010`buildPythonPackage`. The main purpose of this function is to build a Python
@@ -969,18 +1021,18 @@ called with `callPackage` and passed `python` or `pythonPackages` (possibly
9691021specifying an interpreter version), like this:
9701022
9711023```nix
972−{ lib, python3Packages }:
1024+{ lib, python3 }:
9731025
974−python3Packages.buildPythonApplication rec {
1026+python3.pkgs.buildPythonApplication rec {
9751027 pname = "luigi";
9761028 version = "2.7.9";
9771029
978− src = python3Packages.fetchPypi {
1030+ src = python3.pkgs.fetchPypi {
9791031 inherit pname version;
9801032 sha256 = "035w8gqql36zlan0xjrzz9j4lh9hs0qrsgnbyw07qs7lnkvbdv9x";
9811033 };
9821034
983− propagatedBuildInputs = with python3Packages; [ tornado_4 python-daemon ];
1035+ propagatedBuildInputs = with python3.pkgs; [ tornado python-daemon ];
9841036
9851037 meta = with lib; {
9861038 ...
@@ -997,7 +1049,7 @@ luigi = callPackage ../applications/networking/cluster/luigi { };
9971049Since the package is an application, a consumer doesn't need to care about
9981050Python versions or modules, which is why they don't go in `pythonPackages`.
9991051
1000−#### `toPythonApplication` function
1052+#### `toPythonApplication` function {#topythonapplication-function}
10011053
10021054A distinction is made between applications and libraries, however, sometimes a
10031055package is used as both. In this case the package is added as a library to
@@ -1009,11 +1061,12 @@ The Nix expression shall use `buildPythonPackage` and be called from
10091061`python-packages.nix`. A reference shall be created from `all-packages.nix` to
10101062the attribute in `python-packages.nix`, and the `toPythonApplication` shall be
10111063applied to the reference:
1064+
10121065```nix
10131066youtube-dl = with pythonPackages; toPythonApplication youtube-dl;
10141067```
10151068
1016−#### `toPythonModule` function
1069+#### `toPythonModule` function {#topythonmodule-function}
10171070
10181071In some cases, such as bindings, a package is created using
10191072`stdenv.mkDerivation` and added as attribute in `all-packages.nix`. The Python
@@ -1030,7 +1083,7 @@ opencv = toPythonModule (pkgs.opencv.override {
10301083
10311084Do pay attention to passing in the right Python version!
10321085
1033−#### `python.buildEnv` function
1086+#### `python.buildEnv` function {#python.buildenv-function}
10341087
10351088Python environments can be created using the low-level `pkgs.buildEnv` function.
10361089This example shows how to create an environment that has the Pyramid Web Framework.
@@ -1068,8 +1121,8 @@ with import <nixpkgs> {};
10681121will drop you into a shell where Python will have the
10691122specified packages in its path.
10701123
1124+##### `python.buildEnv` arguments {#python.buildenv-arguments}
10711125
1072−##### `python.buildEnv` arguments
10731126
10741127* `extraLibs`: List of packages installed inside the environment.
10751128* `postBuild`: Shell command executed after the build of environment.
@@ -1077,7 +1130,7 @@ specified packages in its path.
10771130* `permitUserSite`: Skip setting the `PYTHONNOUSERSITE` environment variable in
10781131 wrapped binaries in the environment.
10791132
1080−#### `python.withPackages` function
1133+#### `python.withPackages` function {#python.withpackages-function}
10811134
10821135The `python.withPackages` function provides a simpler interface to the `python.buildEnv` functionality.
10831136It takes a function as an argument that is passed the set of python packages and returns the list
@@ -1119,7 +1172,7 @@ need them, you have to use `python.buildEnv`.
11191172Python 2 namespace packages may provide `__init__.py` that collide. In that case
11201173`python.buildEnv` should be used with `ignoreCollisions = true`.
11211174
1122−#### Setup hooks
1175+#### Setup hooks {#setup-hooks}
11231176
11241177The following are setup hooks specifically for Python packages. Most of these
11251178are used in `buildPythonPackage`.
@@ -1144,7 +1197,7 @@ are used in `buildPythonPackage`.
11441197- `wheelUnpackHook` to move a wheel to the correct folder so it can be installed
11451198 with the `pipInstallHook`.
11461199
1147−### Development mode
1200+### Development mode {#development-mode}
11481201
11491202Development or editable mode is supported. To develop Python packages
11501203`buildPythonPackage` has additional logic inside `shellPhase` to run `pip
@@ -1153,6 +1206,7 @@ install -e . --prefix $TMPDIR/`for the package.
11531206Warning: `shellPhase` is executed only if `setup.py` exists.
11541207
11551208Given a `default.nix`:
1209+
11561210```nix
11571211with import <nixpkgs> {};
11581212
@@ -1175,7 +1229,7 @@ nix-shell -p pythonPackages.pyramid zlib libjpeg git
11751229
11761230Note: There is a boolean value `lib.inNixShell` set to `true` if nix-shell is invoked.
11771231
1178−### Tools
1232+### Tools {#tools}
11791233
11801234Packages inside nixpkgs are written by hand. However many tools exist in
11811235community to help save time. No tool is preferred at the moment.
@@ -1184,9 +1238,10 @@ community to help save time. No tool is preferred at the moment.
11841238 expressions for your Python project. Note that [sharing derivations from
11851239 pypi2nix with nixpkgs is possible but not
11861240 encouraged](https://github.com/nix-community/pypi2nix/issues/222#issuecomment-443497376).
1187−- [python2nix](https://github.com/proger/python2nix) by Vladimir Kirillov.
1241+- [nixpkgs-pytools](https://github.com/nix-community/nixpkgs-pytools)
1242+- [poetry2nix](https://github.com/nix-community/poetry2nix)
11881243
1189−### Deterministic builds
1244+### Deterministic builds {#deterministic-builds}
11901245
11911246The Python interpreters are now built deterministically. Minor modifications had
11921247to be made to the interpreters in order to generate deterministic bytecode. This
@@ -1198,7 +1253,7 @@ have timestamp 1. The `buildPythonPackage` function sets `DETERMINISTIC_BUILD=1`
11981253and [PYTHONHASHSEED=0](https://docs.python.org/3.8/using/cmdline.html#envvar-PYTHONHASHSEED).
11991254Both are also exported in `nix-shell`.
12001255
1201−### Automatic tests
1256+### Automatic tests {#automatic-tests}
12021257
12031258It is recommended to test packages as part of the build process.
12041259Source distributions (`sdist`) often include test files, but not always.
@@ -1207,7 +1262,7 @@ By default the command `python setup.py test` is run as part of the
12071262`checkPhase`, but often it is necessary to pass a custom `checkPhase`. An
12081263example of such a situation is when `py.test` is used.
12091264
1210−#### Common issues
1265+#### Common issues {#common-issues}
12111266
12121267* Non-working tests can often be deselected. By default `buildPythonPackage`
12131268 runs `python setup.py test`. Most Python modules follows the standard test
@@ -1224,18 +1279,19 @@ example of such a situation is when `py.test` is used.
12241279 '';
12251280 }
12261281 ```
1282+
12271283* Tests that attempt to access `$HOME` can be fixed by using the following
12281284 work-around before running tests (e.g. `preCheck`): `export HOME=$(mktemp -d)`
12291285
1230−## FAQ
1286+## FAQ {#faq}
12311287
1232−### How to solve circular dependencies?
1288+### How to solve circular dependencies? {#how-to-solve-circular-dependencies}
12331289
12341290Consider the packages `A` and `B` that depend on each other. When packaging `B`,
12351291a solution is to override package `A` not to depend on `B` as an input. The same
12361292should also be done when packaging `A`.
12371293
1238−### How to override a Python package?
1294+### How to override a Python package? {#how-to-override-a-python-package}
12391295
12401296We can override the interpreter and pass `packageOverrides`. In the following
12411297example we rename the `pandas` package and build it.
@@ -1293,7 +1349,7 @@ let
12931349in newpkgs.inkscape
12941350```
12951351
1296−### `python setup.py bdist_wheel` cannot create .whl
1352+### `python setup.py bdist_wheel` cannot create .whl {#python-setup.py-bdist_wheel-cannot-create-.whl}
12971353
12981354Executing `python setup.py bdist_wheel` in a `nix-shell `fails with
12991355```
@@ -1326,7 +1382,7 @@ or unset `SOURCE_DATE_EPOCH`:
13261382nix-shell --run "unset SOURCE_DATE_EPOCH; python3 setup.py bdist_wheel"
13271383```
13281384
1329−### `install_data` / `data_files` problems
1385+### `install_data` / `data_files` problems {#install_data-data_files-problems}
13301386
13311387If you get the following error:
13321388
@@ -1346,7 +1402,7 @@ ${python.interpreter} setup.py install_data --install-dir=$out --root=$out
13461402sed -i '/ = data\_files/d' setup.py
13471403```
13481404
1349−### Rationale of non-existent global site-packages
1405+### Rationale of non-existent global site-packages {#rationale-of-non-existent-global-site-packages}
13501406
13511407On most operating systems a global `site-packages` is maintained. This however
13521408becomes problematic if you want to run multiple Python versions or have multiple
@@ -1361,7 +1417,7 @@ If you want to create a Python environment for development, then the recommended
13611417method is to use `nix-shell`, either with or without the `python.buildEnv`
13621418function.
13631419
1364−### How to consume Python modules using pip in a virtual environment like I am used to on other Operating Systems?
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}
13651421
13661422While this approach is not very idiomatic from Nix perspective, it can still be
13671423useful when dealing with pre-existing projects or in situations where it's not
@@ -1474,7 +1530,7 @@ is executed it will attempt to download the Python modules listed in
14741530requirements.txt. However these will be cached locally within the `virtualenv`
14751531folder and not downloaded again.
14761532
1477−### How to override a Python package from `configuration.nix`?
1533+### How to override a Python package from `configuration.nix`? {#how-to-override-a-python-package-from-configuration.nix}
14781534
14791535If you need to change a package's attribute(s) from `configuration.nix` you could do:
14801536
@@ -1482,11 +1538,12 @@ If you need to change a package's attribute(s) from `configuration.nix` you coul
14821538 nixpkgs.config.packageOverrides = super: {
14831539 python = super.python.override {
14841540 packageOverrides = python-self: python-super: {
1485− zerobin = python-super.zerobin.overrideAttrs (oldAttrs: {
1486− src = super.fetchgit {
1487− url = "https://github.com/sametmax/0bin";
1488− rev = "a344dbb18fe7a855d0742b9a1cede7ce423b34ec";
1489− sha256 = "16d769kmnrpbdr0ph0whyf4yff5df6zi4kmwx7sz1d3r6c8p6xji";
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";
14901547 };
14911548 });
14921549 };
@@ -1494,9 +1551,11 @@ If you need to change a package's attribute(s) from `configuration.nix` you coul
14941551 };
14951552```
14961553
1497−`pythonPackages.zerobin` is now globally overridden. All packages and also the
1498−`zerobin` NixOS service use the new definition. Note that `python-super` refers
1499−to the old package set and `python-self` to the new, overridden version.
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.
15001559
15011560To modify only a Python package set instead of a whole Python derivation, use
15021561this snippet:
@@ -1504,12 +1563,12 @@ this snippet:
15041563```nix
15051564 myPythonPackages = pythonPackages.override {
15061565 overrides = self: super: {
1507− zerobin = ...;
1566+ twisted = ...;
15081567 };
15091568 }
15101569```
15111570
1512−### How to override a Python package using overlays?
1571+### How to override a Python package using overlays? {#how-to-override-a-python-package-using-overlays}
15131572
15141573Use the following overlay template:
15151574
@@ -1517,11 +1576,12 @@ Use the following overlay template:
15171576self: super: {
15181577 python = super.python.override {
15191578 packageOverrides = python-self: python-super: {
1520− zerobin = python-super.zerobin.overrideAttrs (oldAttrs: {
1521− src = super.fetchgit {
1522− url = "https://github.com/sametmax/0bin";
1523− rev = "a344dbb18fe7a855d0742b9a1cede7ce423b34ec";
1524− sha256 = "16d769kmnrpbdr0ph0whyf4yff5df6zi4kmwx7sz1d3r6c8p6xji";
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";
15251585 };
15261586 });
15271587 };
@@ -1529,12 +1589,12 @@ self: super: {
15291589}
15301590```
15311591
1532−### How to use Intel's MKL with numpy and scipy?
1592+### How to use Intel’s MKL with numpy and scipy? {#how-to-use-intels-mkl-with-numpy-and-scipy}
15331593
15341594MKL can be configured using an overlay. See the section "[Using overlays to
15351595configure alternatives](#sec-overlays-alternatives-blas-lapack)".
15361596
1537−### What inputs do `setup_requires`, `install_requires` and `tests_require` map to?
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}
15381598
15391599In a `setup.py` or `setup.cfg` it is common to declare dependencies:
15401600
@@ -1542,17 +1602,15 @@ In a `setup.py` or `setup.cfg` it is common to declare dependencies:
15421602* `install_requires` corresponds to `propagatedBuildInputs`
15431603* `tests_require` corresponds to `checkInputs`
15441604
1545−## Contributing
1605+## Contributing {#contributing}
15461606
1547−### Contributing guidelines
1607+### Contributing guidelines {#contributing-guidelines}
15481608
1549−Following rules are desired to be respected:
1609+The following rules are desired to be respected:
15501610
15511611* Python libraries are called from `python-packages.nix` and packaged with
15521612 `buildPythonPackage`. The expression of a library should be in
1553− `pkgs/development/python-modules/<name>/default.nix`. Libraries in
1554− `pkgs/top-level/python-packages.nix` are sorted quasi-alphabetically to avoid
1555− merge conflicts.
1613+ `pkgs/development/python-modules/<name>/default.nix`.
15561614* Python applications live outside of `python-packages.nix` and are packaged
15571615 with `buildPythonApplication`.
15581616* Make sure libraries build for all Python interpreters.
@@ -1562,7 +1620,63 @@ Following rules are desired to be respected:
15621620 case, when you disable tests, leave a comment explaining why.
15631621* Commit names of Python libraries should reflect that they are Python
15641622 libraries, so write for example `pythonPackages.numpy: 1.11 -> 1.12`.
1565−* Attribute names in `python-packages.nix` should be normalized according to
1566− [PEP 0503](https://www.python.org/dev/peps/pep-0503/#normalized-names). This
1567− means that characters should be converted to lowercase and `.` and `_` should
1568− be replaced by a single `-` (foo-bar-baz instead of Foo__Bar.baz )
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.md+84−48
@@ -1,77 +1,88 @@
11# Qt {#sec-language-qt}
22
3−This section describes the differences between Nix expressions for Qt libraries and applications and Nix expressions for other C++ software. Some knowledge of the latter is assumed.
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:
47
5−There are primarily two problems which the Qt infrastructure is designed to address: ensuring consistent versioning of all dependencies and finding dependencies at runtime.
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.
613
714## Nix expression for a Qt package (default.nix) {#qt-default-nix}
815
916```{=docbook}
1017<programlisting>
11−{ mkDerivation, lib, qtbase }: <co xml:id='qt-default-nix-co-1' />
18+{ stdenv, lib, qtbase, wrapQtAppsHook }: <co xml:id='qt-default-nix-co-1' />
1219
13−mkDerivation { <co xml:id='qt-default-nix-co-2' />
20+stdenv.mkDerivation {
1421 pname = "myapp";
1522 version = "1.0";
1623
17− buildInputs = [ qtbase ]; <co xml:id='qt-default-nix-co-3' />
24+ buildInputs = [ qtbase ];
25+ nativeBuildInputs = [ wrapQtAppsHook ]; <co xml:id='qt-default-nix-co-2' />
1826}
1927</programlisting>
2028
2129 <calloutlist>
2230 <callout arearefs='qt-default-nix-co-1'>
2331 <para>
24− Import <literal>mkDerivation</literal> and Qt (such as <literal>qtbase</literal> modules directly. <emphasis>Do not</emphasis> import Qt package sets; the Qt versions of dependencies may not be coherent, causing build and runtime failures.
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.
2535 </para>
2636 </callout>
2737 <callout arearefs='qt-default-nix-co-2'>
28− <para>
29− Use <literal>mkDerivation</literal> instead of <literal>stdenv.mkDerivation</literal>. <literal>mkDerivation</literal> is a wrapper around <literal>stdenv.mkDerivation</literal> which applies some Qt-specific settings. This deriver accepts the same arguments as <literal>stdenv.mkDerivation</literal>; refer to <xref linkend='chap-stdenv' /> for details.
30− </para>
31− <para>
32− To use another deriver instead of <literal>stdenv.mkDerivation</literal>, use <literal>mkDerivationWith</literal>:
33−<programlisting>
34−mkDerivationWith myDeriver {
35− # ...
36−}
37−</programlisting>
38− If you cannot use <literal>mkDerivationWith</literal>, please refer to <xref linkend='qt-runtime-dependencies' />.
39− </para>
40− </callout>
41− <callout arearefs='qt-default-nix-co-3'>
42− <para>
43− <literal>mkDerivation</literal> accepts the same arguments as <literal>stdenv.mkDerivation</literal>, such as <literal>buildInputs</literal>.
44− </para>
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>
4543 </callout>
4644 </calloutlist>
4745```
4846
4947## Locating runtime dependencies {#qt-runtime-dependencies}
50−Qt applications need to be wrapped to find runtime dependencies. If you cannot use `mkDerivation` or `mkDerivationWith` above, include `wrapQtAppsHook` in `nativeBuildInputs`:
48+
49+Qt applications must be wrapped to find runtime dependencies.
50+Include `wrapQtAppsHook` in `nativeBuildInputs`:
5151
5252```nix
53+{ stdenv, wrapQtAppsHook }:
54+
5355stdenv.mkDerivation {
5456 # ...
55−
5657 nativeBuildInputs = [ wrapQtAppsHook ];
5758}
5859```
59−Entries added to `qtWrapperArgs` are used to modify the wrappers created by `wrapQtAppsHook`. The entries are passed as arguments to [wrapProgram executable makeWrapperArgs](#fun-wrapProgram).
60+
61+Add entries to `qtWrapperArgs` are to modify the wrappers created by
62+`wrapQtAppsHook`:
6063
6164```nix
62−mkDerivation {
63− # ...
65+{ stdenv, wrapQtAppsHook }:
6466
67+stdenv.mkDerivation {
68+ # ...
69+ nativeBuildInputs = [ wrapQtAppsHook ];
6570 qtWrapperArgs = [ ''--prefix PATH : /path/to/bin'' ];
6671}
6772```
6873
69−Set `dontWrapQtApps` to stop applications from being wrapped automatically. It is required to wrap applications manually with `wrapQtApp`, using the syntax of [wrapProgram executable makeWrapperArgs](#fun-wrapProgram):
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):
7079
7180```nix
72−mkDerivation {
73− # ...
81+{ stdenv, lib, wrapQtAppsHook }:
7482
83+stdenv.mkDerivation {
84+ # ...
85+ nativeBuildInputs = [ wrapQtAppsHook ];
7586 dontWrapQtApps = true;
7687 preFixup = ''
7788 wrapQtApp "$out/bin/myapp" --prefix PATH : /path/to/bin
@@ -79,45 +90,70 @@ mkDerivation {
7990}
8091```
8192
82−> Note: `wrapQtAppsHook` ignores files that are non-ELF executables. This means that scripts won't be automatically wrapped so you'll need to manually wrap them as previously mentioned. An example of when you'd always need to do this is with Python applications that use PyQT.
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}
83105
84−Libraries are built with every available version of Qt. Use the `meta.broken` attribute to disable the package for unsupported Qt versions:
106+The following represents the contents of `qt5-packages.nix`.
85107
86108```nix
87−mkDerivation {
109+{
88110 # ...
89111
90− # Disable this library with Qt < 5.9.0
91− meta.broken = builtins.compareVersions qtbase.version "5.9.0" < 0;
112+ mylib = callPackage ../path/to/mylib {};
113+
114+ # ...
92115}
93116```
94−## Adding a library to Nixpkgs
95− Add a Qt library to all-packages.nix by adding it to the collection inside `mkLibsForQt5`. This ensures that the library is built with every available version of Qt as needed.
96117
97−### Example Adding a Qt library to all-packages.nix {#qt-library-all-packages-nix}
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 }:
98123
124+stdenv.mkDerivation {
125+ # ...
126+ # Disable this library with Qt < 5.9.0
127+ meta.broken = lib.versionOlder qtbase.version "5.9.0";
128+}
99129```
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
100141{
101142 # ...
102143
103− mkLibsForQt5 = self: with self; {
104− # ...
105−
106− mylib = callPackage ../path/to/mylib {};
107− };
144+ myapp = callPackage ../path/to/myapp {};
108145
109146 # ...
110147}
111148```
112−## Adding an application to Nixpkgs
113−Add a Qt application to *all-packages.nix* using `libsForQt5.callPackage` instead of the usual `callPackage`. The former ensures that all dependencies are built with the same version of Qt.
114149
115−### Example Adding a QT application to all-packages.nix {#qt-application-all-packages-nix}
150+The following represents the contents of `all-packages.nix`.
151+
116152```nix
117153{
118154 # ...
119155
120− myapp = libsForQt5.callPackage ../path/to/myapp/ {};
156+ myapp = libsForQt5.myapp;
121157
122158 # ...
123159}
doc/languages-frameworks/r.section.md+25−18
@@ -1,7 +1,6 @@
1−R
2−=
1+# R {#r}
32
4−## Installation
3+## Installation {#installation}
54
65Define an environment for R that contains all the libraries that you'd like to
76use by adding the following snippet to your $HOME/.config/nixpkgs/config.nix file:
@@ -32,15 +31,14 @@ output is the name that has to be passed to rWrapper in the code snipped above.
3231However, if you'd like to add a file to your project source to make the
3332environment available for other contributors, you can create a `default.nix`
3433file like so:
34+
3535```nix
36−let
37− pkgs = import <nixpkgs> {};
38− stdenv = pkgs.stdenv;
39−in with pkgs; {
36+with import <nixpkgs> {};
37+{
4038 myProject = stdenv.mkDerivation {
4139 name = "myProject";
4240 version = "1";
43− src = if pkgs.lib.inNixShell then null else nix;
41+ src = if lib.inNixShell then null else nix;
4442
4543 buildInputs = with rPackages; [
4644 R
@@ -53,7 +51,7 @@ in with pkgs; {
5351and then run `nix-shell .` to be dropped into a shell with those packages
5452available.
5553
56−## RStudio
54+## RStudio {#rstudio}
5755
5856RStudio uses a standard set of packages and ignores any custom R
5957environments or installed packages you may have. To create a custom
@@ -96,7 +94,12 @@ Executing `nix-shell` will then drop you into an environment equivalent to the
9694one above. If you need additional packages just add them to the list and
9795re-enter the shell.
9896
99−## Updating the package set
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:
100103
101104```bash
102105nix-shell generate-shell.nix
@@ -106,15 +109,19 @@ mv cran-packages.nix.new cran-packages.nix
106109
107110Rscript generate-r-packages.R bioc > bioc-packages.nix.new
108111mv bioc-packages.nix.new bioc-packages.nix
109−```
110112
111−`generate-r-packages.R <repo>` reads `<repo>-packages.nix`, therefor the renaming.
113+Rscript generate-r-packages.R bioc-annotation > bioc-annotation-packages.nix.new
114+mv bioc-annotation-packages.nix.new bioc-annotation-packages.nix
112115
113−
114−## Testing if the Nix-expression could be evaluated
115−
116−```bash
117−nix-build test-evaluation.nix --dry-run
116+Rscript generate-r-packages.R bioc-experiment > bioc-experiment-packages.nix.new
117+mv bioc-experiment-packages.nix.new bioc-experiment-packages.nix
118118```
119119
120−If this exits fine, the expression is ok. If not, you have to edit `default.nix`
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.md+28−15
@@ -1,6 +1,6 @@
11# Ruby {#sec-language-ruby}
22
3−## Using Ruby
3+## Using Ruby {#using-ruby}
44
55Several 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`.
66
@@ -8,11 +8,11 @@ In the Nixpkgs tree, Ruby packages can be found throughout, depending on what th
88
99There 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.
1010
11−The interpreters have common attributes, namely `gems`, and `withPackages`. So you can refer to `ruby.gems.nokogiri`, or `ruby_2_6.gems.nokogiri` to get the Nokogiri gem already compiled and ready to use.
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.
1212
1313Since 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.
1414
15−### Temporary Ruby environment with `nix-shell`
15+### Temporary Ruby environment with `nix-shell` {#temporary-ruby-environment-with-nix-shell}
1616
1717Rather 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`.
1818
@@ -30,7 +30,7 @@ $ nix-shell -p ruby.gems.nokogiri ruby.gems.pry
3030
3131Again, 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.
3232
33−#### Load Ruby environment from `.nix` expression
33+#### Load Ruby environment from `.nix` expression {#load-ruby-environment-from-.nix-expression}
3434
3535As 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:
3636
@@ -45,7 +45,7 @@ What's happening here?
45452. Then we create a Ruby environment with the `withPackages` function.
46463. 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.
4747
48−#### Execute command with `--run`
48+#### Execute command with `--run` {#execute-command-with---run}
4949
5050A convenient flag for `nix-shell` is `--run`. It executes a command in the `nix-shell`. We can e.g. directly open a `pry` REPL:
5151
@@ -65,7 +65,7 @@ Or run a script using this environment:
6565$ nix-shell -p "ruby.withPackages (ps: with ps; [ nokogiri pry ])" --run "ruby example.rb"
6666```
6767
68−#### Using `nix-shell` as shebang
68+#### Using `nix-shell` as shebang {#using-nix-shell-as-shebang}
6969
7070In 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.
7171
@@ -80,9 +80,9 @@ body = RestClient.get('http://example.com').body
8080puts Nokogiri::HTML(body).at('h1').text
8181```
8282
83−## Developing with Ruby
83+## Developing with Ruby {#developing-with-ruby}
8484
85−### Using an existing Gemfile
85+### Using an existing Gemfile {#using-an-existing-gemfile}
8686
8787In 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.
8888
@@ -106,7 +106,7 @@ let
106106 name = "gems-for-some-project";
107107 gemdir = ./.;
108108 };
109−in mkShell { buildInputs = [ gems gems.wrappedRuby ]; }
109+in mkShell { packages = [ gems gems.wrappedRuby ]; }
110110```
111111
112112With this file in your directory, you can run `nix-shell` to build and use the gems. The important parts here are `bundlerEnv` and `wrappedRuby`.
@@ -120,7 +120,7 @@ One common issue that you might have is that you have Ruby 2.6, but also `bundle
120120mkShell { buildInputs = [ gems (lowPrio gems.wrappedRuby) ]; }
121121```
122122
123−### Gem-specific configurations and workarounds
123+### Gem-specific configurations and workarounds {#gem-specific-configurations-and-workarounds}
124124
125125In some cases, especially if the gem has native extensions, you might need to modify the way the gem is built.
126126
@@ -201,7 +201,20 @@ $ nix-shell --run 'ruby -rpg -e "puts PG.library_version"'
201201
202202Of 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.
203203
204−### Adding a gem to the default gemset
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}
205218
206219Now 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.
207220
@@ -215,7 +228,7 @@ To test that it works, you can then try using the gem with:
215228NIX_PATH=nixpkgs=$PWD nix-shell -p "ruby.withPackages (ps: with ps; [ name-of-your-gem ])"
216229```
217230
218−### Packaging applications
231+### Packaging applications {#packaging-applications}
219232
220233A 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.
221234
@@ -229,10 +242,10 @@ end
229242
230243If 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.
231244
232−Now you can also also make a `default.nix` that looks like this:
245+Now you can also make a `default.nix` that looks like this:
233246
234247```nix
235−{ lib, bundlerApp }:
248+{ bundlerApp }:
236249
237250bundlerApp {
238251 pname = "mdl";
@@ -243,7 +256,7 @@ bundlerApp {
243256
244257All 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.
245258
246−#### Packaging executables that require wrapping
259+#### Packaging executables that require wrapping {#packaging-executables-that-require-wrapping}
247260
248261Sometimes your app will depend on other executables at runtime, and tries to find it through the `PATH` environment variable.
249262
doc/languages-frameworks/rust.section.md+552−136
@@ -1,44 +1,41 @@
1−---
2−title: Rust
3−author: Matthias Beyer
4−date: 2017-03-05
5−---
6−
7−# Rust
1+# Rust {#rust}
82
93To install the rust compiler and cargo put
104
11−```
12−rustc
13−cargo
5+```nix
6+environment.systemPackages = [
7+ rustc
8+ cargo
9+];
1410```
1511
16−into the `environment.systemPackages` or bring them into
17−scope with `nix-shell -p rustc cargo`.
12+into your `configuration.nix` or bring them into scope with `nix-shell -p rustc cargo`.
1813
1914For other versions such as daily builds (beta and nightly),
2015use either `rustup` from nixpkgs (which will manage the rust installation in your home directory),
21−or use Mozilla's [Rust nightlies overlay](#using-the-rust-nightlies-overlay).
16+or use a community maintained [Rust overlay](#using-community-rust-overlays).
2217
23−## Compiling Rust applications with Cargo
18+## Compiling Rust applications with Cargo {#compiling-rust-applications-with-cargo}
2419
2520Rust applications are packaged by using the `buildRustPackage` helper from `rustPlatform`:
2621
27−```
22+```nix
23+{ lib, fetchFromGitHub, rustPlatform }:
24+
2825rustPlatform.buildRustPackage rec {
2926 pname = "ripgrep";
30− version = "11.0.2";
27+ version = "12.1.1";
3128
3229 src = fetchFromGitHub {
3330 owner = "BurntSushi";
3431 repo = pname;
3532 rev = version;
36− sha256 = "1iga3320mgi7m853la55xip514a3chqsdi1a1rwv25lr9b1p7vd3";
33+ sha256 = "1hqps7l5qrjh9f914r5i6kmcz6f1yb951nv4lby0cjnp5l253kps";
3734 };
3835
39− cargoSha256 = "17ldqr3asrdcsh4l29m3b5r37r5d0b3npq1lrgjmxb6vlx6a36qh";
36+ cargoSha256 = "03wf9r2csi6jpa7v5sw5lpxkrk4wfzwmzx7k3991q3bdjzcwnnwp";
4037
41− meta = with stdenv.lib; {
38+ meta = with lib; {
4239 description = "A fast line-oriented regex search tool, similar to ag and ack";
4340 homepage = "https://github.com/BurntSushi/ripgrep";
4441 license = licenses.unlicense;
@@ -47,23 +44,176 @@ rustPlatform.buildRustPackage rec {
4744}
4845```
4946
50−`buildRustPackage` requires a `cargoSha256` attribute which is computed over
51−all crate sources of this package. Currently it is obtained by inserting a
52−fake checksum into the expression and building the package once. The correct
53−checksum can then be taken from the failed build.
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+```
5472
5573Per the instructions in the [Cargo Book](https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html)
5674best practices guide, Rust applications should always commit the `Cargo.lock`
5775file in git to ensure a reproducible build. However, a few packages do not, and
58−Nix depends on this file, so if it missing you can use `cargoPatches` to apply
59−it in the `patchPhase`. Consider sending a PR upstream with a note to the
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
6078maintainer describing why it's important to include in the application.
6179
6280The fetcher will verify that the `Cargo.lock` file is in sync with the `src`
6381attribute, and fail the build if not. It will also will compress the vendor
6482directory into a tar.gz archive.
6583
66−### Cross compilation
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}
67217
68218By default, Rust packages are compiled for the host platform, just like any
69219other package is. The `--target` passed to rust tools is computed from this.
@@ -75,6 +225,7 @@ where they are known to differ. But there are ways to customize the argument:
75225 name will be used instead.
76226
77227 For example:
228+
78229 ```nix
79230 import <nixpkgs> {
80231 crossSystem = (import <nixpkgs/lib>).systems.examples.armhf-embedded // {
@@ -82,7 +233,9 @@ where they are known to differ. But there are ways to customize the argument:
82233 };
83234 }
84235 ```
236+
85237 will result in:
238+
86239 ```shell
87240 --target thumbv7em-none-eabi
88241 ```
@@ -95,6 +248,7 @@ where they are known to differ. But there are ways to customize the argument:
95248 will be used instead.
96249
97250 For example:
251+
98252 ```nix
99253 import <nixpkgs> {
100254 crossSystem = (import <nixpkgs/lib>).systems.examples.armhf-embedded // {
@@ -102,31 +256,18 @@ where they are known to differ. But there are ways to customize the argument:
102256 rustc.platform = { foo = ""; bar = ""; };
103257 };
104258 }
259+ ```
260+
105261 will result in:
262+
106263 ```shell
107264 --target /nix/store/asdfasdfsadf-thumb-crazy.json # contains {"foo":"","bar":""}
108265 ```
109266
110−Finally, as an ad-hoc escape hatch, a computed target (string or JSON file
111−path) can be passed directly to `buildRustPackage`:
112−
113−```nix
114−pkgs.rustPlatform.buildRustPackage {
115− (...)
116− target = "x86_64-fortanix-unknown-sgx";
117−}
118−```
119−
120−This is useful to avoid rebuilding Rust tools, since they are actually target
121−agnostic and don't need to be rebuilt. But in the future, we should always
122−build the Rust tools and standard library crates separately so there is no
123−reason not to take the `stdenv.hostPlatform.rustc`-modifying approach, and the
124−ad-hoc escape hatch to `buildRustPackage` can be removed.
125−
126267Note that currently custom targets aren't compiled with `std`, so `cargo test`
127268will fail. This can be ignored by adding `doCheck = false;` to your derivation.
128269
129−### Running package tests
270+### Running package tests {#running-package-tests}
130271
131272When using `buildRustPackage`, the `checkPhase` is enabled by default and runs
132273`cargo test` on the package to build. To make sure that we don't compile the
@@ -147,7 +288,14 @@ rustPlatform.buildRustPackage {
147288Please note that the code will be compiled twice here: once in `release` mode
148289for the `buildPhase`, and again in `debug` mode for the `checkPhase`.
149290
150−#### Tests relying on the structure of the `target/` directory
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}
151299
152300Some tests may rely on the structure of the `target/` directory. Those tests
153301are likely to fail because we use `cargo --target` during the build. This means that
@@ -157,7 +305,7 @@ rather than in `target/release/`.
157305
158306This can only be worked around by patching the affected tests accordingly.
159307
160−#### Disabling package-tests
308+#### Disabling package-tests {#disabling-package-tests}
161309
162310In some instances, it may be necessary to disable testing altogether (with `doCheck = false;`):
163311
@@ -171,7 +319,7 @@ The above are just guidelines, and exceptions may be granted on a case-by-case b
171319However, please check if it's possible to disable a problematic subset of the
172320test suite and leave a comment explaining your reasoning.
173321
174−#### Setting `test-threads`
322+#### Setting `test-threads` {#setting-test-threads}
175323
176324`buildRustPackage` will use parallel test threads by default,
177325sometimes it may be necessary to disable this so the tests run consecutively.
@@ -179,11 +327,11 @@ sometimes it may be necessary to disable this so the tests run consecutively.
179327```nix
180328rustPlatform.buildRustPackage {
181329 /* ... */
182− cargoParallelTestThreads = false;
330+ dontUseCargoParallelTests = true;
183331}
184332```
185333
186−### Building a package in `debug` mode
334+### Building a package in `debug` mode {#building-a-package-in-debug-mode}
187335
188336By default, `buildRustPackage` will use `release` mode for builds. If a package
189337should be built in `debug` mode, it can be configured like so:
@@ -197,22 +345,20 @@ rustPlatform.buildRustPackage {
197345
198346In this scenario, the `checkPhase` will be ran in `debug` mode as well.
199347
200−### Custom `build`/`install`-procedures
348+### Custom `build`/`install`-procedures {#custom-buildinstall-procedures}
201349
202350Some packages may use custom scripts for building/installing, e.g. with a `Makefile`.
203351In these cases, it's recommended to override the `buildPhase`/`installPhase`/`checkPhase`.
204352
205353Otherwise, some steps may fail because of the modified directory structure of `target/`.
206354
207−### Building a crate with an absent or out-of-date Cargo.lock file
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}
208356
209357`buildRustPackage` needs a `Cargo.lock` file to get all dependencies in the
210358source code in a reproducible way. If it is missing or out-of-date one can use
211359the `cargoPatches` attribute to update or add it.
212360
213−```
214−{ lib, rustPlatform, fetchFromGitHub }:
215−
361+```nix
216362rustPlatform.buildRustPackage rec {
217363 (...)
218364 cargoPatches = [
@@ -222,9 +368,237 @@ rustPlatform.buildRustPackage rec {
222368}
223369```
224370
225−## Compiling Rust crates using Nix instead of Cargo
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`.
226526
227−### Simple operation
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}
228602
229603When run, `cargo build` produces a file called `Cargo.lock`,
230604containing pinned versions of all dependencies. Nixpkgs contains a
@@ -235,20 +609,21 @@ That Nix expression calls `rustc` directly (hence bypassing Cargo),
235609and can be used to compile a crate and all its dependencies. Here is
236610an example for a minimal `hello` crate:
237611
238−
239− $ cargo new hello
240− $ cd hello
241− $ cargo build
612+```ShellSession
613+$ cargo new hello
614+$ cd hello
615+$ cargo build
242616 Compiling hello v0.1.0 (file:///tmp/hello)
243− Finished dev [unoptimized + debuginfo] target(s) in 0.20 secs
244− $ carnix -o hello.nix --src ./. Cargo.lock --standalone
245− $ nix-build hello.nix -A hello_0_1_0
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+```
246621
247622Now, the file produced by the call to `carnix`, called `hello.nix`, looks like:
248623
249−```
624+```nix
250625# Generated by carnix 0.6.5: carnix -o hello.nix --src ./. Cargo.lock --standalone
251−{ lib, stdenv, buildRustCrate, fetchgit }:
626+{ stdenv, buildRustCrate, fetchgit }:
252627let kernel = stdenv.buildPlatform.parsed.kernel.name;
253628 # ... (content skipped)
254629in
@@ -275,9 +650,9 @@ dependencies, for instance by adding a single line `libc="*"` to our
275650`Cargo.lock`. Then, `carnix` needs to be run again, and produces the
276651following nix file:
277652
278−```
653+```nix
279654# Generated by carnix 0.6.5: carnix -o hello.nix --src ./. Cargo.lock --standalone
280−{ lib, stdenv, buildRustCrate, fetchgit }:
655+{ stdenv, buildRustCrate, fetchgit }:
281656let kernel = stdenv.buildPlatform.parsed.kernel.name;
282657 # ... (content skipped)
283658in
@@ -321,16 +696,16 @@ Here, the `libc` crate has no `src` attribute, so `buildRustCrate`
321696will fetch it from [crates.io](https://crates.io). A `sha256`
322697attribute is still needed for Nix purity.
323698
324−### Handling external dependencies
699+### Handling external dependencies {#handling-external-dependencies}
325700
326701Some crates require external libraries. For crates from
327702[crates.io](https://crates.io), such libraries can be specified in
328703`defaultCrateOverrides` package in nixpkgs itself.
329704
330705Starting from that file, one can add more overrides, to add features
331−or build inputs by overriding the hello crate in a seperate file.
706+or build inputs by overriding the hello crate in a separate file.
332707
333−```
708+```nix
334709with import <nixpkgs> {};
335710((import ./hello.nix).hello {}).override {
336711 crateOverrides = defaultCrateOverrides // {
@@ -350,7 +725,7 @@ derivation depend on the crate's version, the `attrs` argument of
350725the override above can be read, as in the following example, which
351726patches the derivation:
352727
353−```
728+```nix
354729with import <nixpkgs> {};
355730((import ./hello.nix).hello {}).override {
356731 crateOverrides = defaultCrateOverrides // {
@@ -371,7 +746,7 @@ dependencies. For instance, to override the build inputs for crate
371746`libc` in the example above, where `libc` is a dependency of the main
372747crate, we could do:
373748
374−```
749+```nix
375750with import <nixpkgs> {};
376751((import hello.nix).hello {}).override {
377752 crateOverrides = defaultCrateOverrides // {
@@ -380,34 +755,34 @@ with import <nixpkgs> {};
380755}
381756```
382757
383−### Options and phases configuration
758+### Options and phases configuration {#options-and-phases-configuration}
384759
385760Actually, the overrides introduced in the previous section are more
386761general. A number of other parameters can be overridden:
387762
388−- The version of rustc used to compile the crate:
763+- The version of `rustc` used to compile the crate:
389764
390− ```
765+ ```nix
391766 (hello {}).override { rust = pkgs.rust; };
392767 ```
393768
394769- Whether to build in release mode or debug mode (release mode by
395770 default):
396771
397− ```
772+ ```nix
398773 (hello {}).override { release = false; };
399774 ```
400775
401−- Whether to print the commands sent to rustc when building
776+- Whether to print the commands sent to `rustc` when building
402777 (equivalent to `--verbose` in cargo:
403778
404− ```
779+ ```nix
405780 (hello {}).override { verbose = false; };
406781 ```
407782
408783- Extra arguments to be passed to `rustc`:
409784
410− ```
785+ ```nix
411786 (hello {}).override { extraRustcOpts = "-Z debuginfo=2"; };
412787 ```
413788
@@ -419,7 +794,7 @@ general. A number of other parameters can be overridden:
419794 `postInstall`. As an example, here is how to create a new module
420795 before running the build script:
421796
422− ```
797+ ```nix
423798 (hello {}).override {
424799 preConfigure = ''
425800 echo "pub const PATH=\"${hi.out}\";" >> src/path.rs"
@@ -427,13 +802,13 @@ general. A number of other parameters can be overridden:
427802 };
428803 ```
429804
430−### Features
805+### Features {#features}
431806
432807One can also supply features switches. For example, if we want to
433808compile `diesel_cli` only with the `postgres` feature, and no default
434809features, we would write:
435810
436−```
811+```nix
437812(callPackage ./diesel.nix {}).diesel {
438813 default = false;
439814 postgres = true;
@@ -442,21 +817,22 @@ features, we would write:
442817
443818Where `diesel.nix` is the file generated by Carnix, as explained above.
444819
820+## Setting Up `nix-shell` {#setting-up-nix-shell}
445821
446−## Setting Up `nix-shell`
447822Oftentimes you want to develop code from within `nix-shell`. Unfortunately
448823`buildRustCrate` does not support common `nix-shell` operations directly
449824(see [this issue](https://github.com/NixOS/nixpkgs/issues/37945))
450825so we will use `stdenv.mkDerivation` instead.
451826
452827Using the example `hello` project above, we want to do the following:
828+
453829- Have access to `cargo` and `rustc`
454830- Have the `openssl` library available to a crate through it's _normal_
455831 compilation mechanism (`pkg-config`).
456832
457833A typical `shell.nix` might look like:
458834
459−```
835+```nix
460836with import <nixpkgs> {};
461837
462838stdenv.mkDerivation {
@@ -465,7 +841,7 @@ stdenv.mkDerivation {
465841 rustc cargo
466842
467843 # Example Build-time Additional Dependencies
468− pkgconfig
844+ pkg-config
469845 ];
470846 buildInputs = [
471847 # Example Run-time Additional Dependencies
@@ -478,17 +854,19 @@ stdenv.mkDerivation {
478854```
479855
480856You should now be able to run the following:
481−```
857+
858+```ShellSession
482859$ nix-shell --pure
483860$ cargo build
484861$ cargo test
485862```
486863
487−### Controlling Rust Version Inside `nix-shell`
864+### Controlling Rust Version Inside `nix-shell` {#controlling-rust-version-inside-nix-shell}
865+
488866To control your rust version (i.e. use nightly) from within `shell.nix` (or
489867other nix expressions) you can use the following `shell.nix`
490868
491−```
869+```nix
492870# Latest Nightly
493871with import <nixpkgs> {};
494872let src = fetchFromGitHub {
@@ -503,11 +881,11 @@ with import "${src.out}/rust-overlay.nix" pkgs pkgs;
503881stdenv.mkDerivation {
504882 name = "rust-env";
505883 buildInputs = [
506− # Note: to use use stable, just replace `nightly` with `stable`
884+ # Note: to use stable, just replace `nightly` with `stable`
507885 latest.rustChannels.nightly.rust
508886
509887 # Add some extra dependencies from `pkgs`
510− pkgconfig openssl
888+ pkg-config openssl
511889 ];
512890
513891 # Set Environment Variables
@@ -516,77 +894,115 @@ stdenv.mkDerivation {
516894```
517895
518896Now run:
519−```
897+
898+```ShellSession
520899$ rustc --version
521900rustc 1.26.0-nightly (188e693b3 2018-03-26)
522901```
523902
524903To see that you are using nightly.
525904
905+## Using community Rust overlays {#using-community-rust-overlays}
526906
527−## Using the Rust nightlies overlay
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)
528910
529−Mozilla provides an overlay for nixpkgs to bring a nightly version of Rust into scope.
530−This overlay can _also_ be used to install recent unstable or stable versions
531−of Rust, if desired.
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.
532914
533−### Rust overlay installation
915+Fenix is an alternative to `rustup` and can also be used as an overlay.
534916
535−You can use this overlay by either changing your local nixpkgs configuration,
536−or by adding the overlay declaratively in a nix expression, e.g. in `configuration.nix`.
537−For more information see [#sec-overlays-install](the manual on installing overlays).
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`).
538920
539−#### Imperative rust overlay installation
921+### How to select a specific `rustc` and toolchain version {#how-to-select-a-specific-rustc-and-toolchain-version}
540922
541−Clone [nixpkgs-mozilla](https://github.com/mozilla/nixpkgs-mozilla),
542−and create a symbolic link to the file
543−[rust-overlay.nix](https://github.com/mozilla/nixpkgs-mozilla/blob/master/rust-overlay.nix)
544−in the `~/.config/nixpkgs/overlays` directory.
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+```
545939
546− $ git clone https://github.com/mozilla/nixpkgs-mozilla.git
547− $ mkdir -p ~/.config/nixpkgs/overlays
548− $ ln -s $(pwd)/nixpkgs-mozilla/rust-overlay.nix ~/.config/nixpkgs/overlays/rust-overlay.nix
940+You can try this out by:
941+1. Saving that to `shell.nix`
942+2. Executing `nix-shell --pure --command 'rustc --version'`
549943
550−### Declarative rust overlay installation
944+As of writing, this prints out `rustc 1.56.0 (09c42c458 2021-10-18)`.
551945
552−Add the following to your `configuration.nix`, `home-configuration.nix`, `shell.nix`, or similar:
946+### How to use an overlay toolchain in a derivation {#how-to-use-an-overlay-toolchain-in-a-derivation}
553947
554−```
555− nixpkgs = {
556− overlays = [
557− (import (builtins.fetchTarball https://github.com/mozilla/nixpkgs-mozilla/archive/master.tar.gz))
558− # Further overlays go here
559− ];
560− };
561−```
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+};
562956
563−Note that this will fetch the latest overlay version when rebuilding your system.
957+rustPlatform.buildRustPackage rec {
958+ pname = "ripgrep";
959+ version = "12.1.1";
960+ nativeBuildInputs = [
961+ rust-bin.stable.latest.minimal
962+ ];
564963
565−### Rust overlay usage
964+ src = fetchFromGitHub {
965+ owner = "BurntSushi";
966+ repo = "ripgrep";
967+ rev = version;
968+ sha256 = "1hqps7l5qrjh9f914r5i6kmcz6f1yb951nv4lby0cjnp5l253kps";
969+ };
566970
567−The overlay contains attribute sets corresponding to different versions of the rust toolchain, such as:
971+ cargoSha256 = "03wf9r2csi6jpa7v5sw5lpxkrk4wfzwmzx7k3991q3bdjzcwnnwp";
568972
569−* `latest.rustChannels.stable`
570−* `latest.rustChannels.nightly`
571−* a function `rustChannelOf`, called as `(rustChannelOf { date = "2018-04-11"; channel = "nightly"; })`, or...
572−* `(nixpkgs.rustChannelOf { rustToolchain = ./rust-toolchain; })` if you have a local `rust-toolchain` file (see https://github.com/mozilla/nixpkgs-mozilla#using-in-nix-expressions for an example)
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+```
573981
574−Each of these contain packages such as `rust`, which contains your usual rust development tools with the respective toolchain chosen.
575−For example, you might want to add `latest.rustChannels.stable.rust` to the list of packages in your configuration.
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`
576986
577−Imperatively, the latest stable version can be installed with the following command:
987+### Rust overlay installation {#rust-overlay-installation}
578988
579− $ nix-env -Ai nixpkgs.latest.rustChannels.stable.rust
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).
580992
581−Or using the attribute with nix-shell:
993+### Declarative Rust overlay installation {#declarative-rust-overlay-installation}
582994
583− $ nix-shell -p nixpkgs.latest.rustChannels.stable.rust
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:
584997
585−Substitute the `nixpkgs` prefix with `nixos` on NixOS.
586−To install the beta or nightly channel, "stable" should be substituted by
587−"nightly" or "beta", or
588−use the function provided by this overlay to pull a version based on a
589−build date.
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+```
5901007
591−The overlay automatically updates itself as it uses the same source as
592−[rustup](https://www.rustup.rs/).
1008+Note that this will fetch the latest overlay version when rebuilding your system.
doc/languages-frameworks/texlive.section.md+3−2
@@ -1,4 +1,3 @@
1−
21# TeX Live {#sec-language-texlive}
32
43Since release 15.09 there is a new TeX Live packaging that lives entirely under attribute `texlive`.
@@ -6,7 +5,8 @@ Since release 15.09 there is a new TeX Live packaging that lives entirely under
65## User's guide {#sec-language-texlive-user-guide}
76
87- For basic usage just pull `texlive.combined.scheme-basic` for an environment with basic LaTeX support.
9−- It typically won't work to use separately installed packages together. Instead, you can build a custom set of packages like this:
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:
1010
1111 ```nix
1212 texlive.combine {
@@ -15,6 +15,7 @@ Since release 15.09 there is a new TeX Live packaging that lives entirely under
1515 ```
1616
1717- There are all the schemes, collections and a few thousand packages, as defined upstream (perhaps with tiny differences).
18+
1819- 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`.
1920
2021 ```nix
doc/languages-frameworks/titanium.section.md+5−10
@@ -1,9 +1,4 @@
1−---
2−title: Titanium
3−author: Sander van der Burg
4−date: 2018-11-18
5−---
6−# Titanium
1+# Titanium {#titanium}
72
83The Nixpkgs repository contains facilities to deploy a variety of versions of
94the [Titanium SDK](https://www.appcelerator.com) versions, a cross-platform
@@ -14,8 +9,8 @@ applications for Android and iOS devices from source code.
149Not all Titanium features supported -- currently, it can only be used to build
1510Android and iOS apps.
1611
17−Building a Titanium app
18−-----------------------
12+## Building a Titanium app {#building-a-titanium-app}
13+
1914We can build a Titanium app from source for Android or iOS and for debugging or
2015release purposes by invoking the `titaniumenv.buildApp {}` function:
2116
@@ -108,8 +103,8 @@ When `enableWirelessDistribution` has been enabled, you must also provide the
108103path of the PHP script (`installURL`) (that is included with the iOS build
109104environment) to enable wireless ad-hoc installations.
110105
111−Emulating or simulating the app
112−-------------------------------
106+## Emulating or simulating the app {#emulating-or-simulating-the-app}
107+
113108It is also possible to simulate the correspond iOS simulator build by using
114109`xcodeenv.simulateApp {}` and emulate an Android APK by using
115110`androidenv.emulateApp {}`.
doc/languages-frameworks/vim.section.md+88−25
@@ -1,9 +1,4 @@
1−---
2−title: User's Guide for Vim in Nixpkgs
3−author: Marc Weber
4−date: 2016-06-25
5−---
6−# Vim
1+# Vim {#vim}
72
83Both Neovim and Vim can be configured to include your favorite plugins
94and additional libraries.
@@ -17,13 +12,13 @@ At the moment we support three different methods for managing plugins:
1712- Pathogen
1813- vim-plug
1914
20−## Custom configuration
15+## Custom configuration {#custom-configuration}
2116
2217Adding custom .vimrc lines can be done using the following code:
2318
2419```nix
2520vim_configurable.customize {
26− # `name` specifies the name of the executable and package
21+ # `name` optionally specifies the name of the executable and package
2722 name = "vim-with-plugins";
2823
2924 vimrcConfig.customRC = ''
@@ -33,6 +28,9 @@ vim_configurable.customize {
3328```
3429
3530This 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.
3634
3735For Neovim the `configure` argument can be overridden to achieve the same:
3836
@@ -61,7 +59,7 @@ neovim-qt.override {
6159}
6260```
6361
64−## Managing plugins with Vim packages
62+## Managing plugins with Vim packages {#managing-plugins-with-vim-packages}
6563
6664To store you plugins in Vim packages (the native Vim plugin manager, see `:help packages`) the following example can be used:
6765
@@ -121,7 +119,72 @@ The resulting package can be added to `packageOverrides` in `~/.nixpkgs/config.n
121119
122120After that you can install your special grafted `myVim` or `myNeovim` packages.
123121
124−## Managing plugins with vim-plug
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}
125188
126189To use [vim-plug](https://github.com/junegunn/vim-plug) to manage your Vim
127190plugins the following example can be used:
@@ -150,18 +213,18 @@ neovim.override {
150213}
151214```
152215
153−## Managing plugins with VAM
216+## Managing plugins with VAM {#managing-plugins-with-vam}
154217
155−### Handling dependencies of Vim plugins
218+### Handling dependencies of Vim plugins {#handling-dependencies-of-vim-plugins}
156219
157220VAM introduced .json files supporting dependencies without versioning
158221assuming that "using latest version" is ok most of the time.
159222
160−### Example
223+### Example {#example}
161224
162225First create a vim-scripts file having one plugin name per line. Example:
163226
164−```
227+```vim
165228"tlib"
166229{'name': 'vim-addon-sql'}
167230{'filetype_regex': '\%(vim)$', 'names': ['reload', 'vim-dev-plugin']}
@@ -202,7 +265,7 @@ nix-shell -p vimUtils.vim_with_vim2nix --command "vim -c 'source generate.vim'"
202265You should get a Vim buffer with the nix derivations (output1) and vam.pluginDictionaries (output2).
203266You can add your Vim to your system's configuration file like this and start it by "vim-my":
204267
205−```
268+```nix
206269my-vim =
207270 let plugins = let inherit (vimUtils) buildVimPluginFrom2Nix; in {
208271 copy paste output1 here
@@ -222,11 +285,11 @@ my-vim =
222285
223286Sample output1:
224287
225−```
288+```nix
226289"reload" = buildVimPluginFrom2Nix { # created by nix#NixDerivation
227290 name = "reload";
228291 src = fetchgit {
229− url = "git://github.com/xolox/vim-reload";
292+ url = "https://github.com/xolox/vim-reload";
230293 rev = "0a601a668727f5b675cb1ddc19f6861f3f7ab9e1";
231294 sha256 = "0vb832l9yxj919f5hfg6qj6bn9ni57gnjd3bj7zpq7d4iv2s4wdh";
232295 };
@@ -247,13 +310,13 @@ Sample output2:
247310]
248311```
249312
250−## Adding new plugins to nixpkgs
313+## Adding new plugins to nixpkgs {#adding-new-plugins-to-nixpkgs}
251314
252−Nix expressions for Vim plugins are stored in [pkgs/misc/vim-plugins](/pkgs/misc/vim-plugins). For the vast majority of plugins, Nix expressions are automatically generated by running [`./update.py`](/pkgs/misc/vim-plugins/update.py). This creates a [generated.nix](/pkgs/misc/vim-plugins/generated.nix) file based on the plugins listed in [vim-plugin-names](/pkgs/misc/vim-plugins/vim-plugin-names). Plugins are listed in alphabetical order in `vim-plugin-names` using the format `[github username]/[repository]`. For example https://github.com/scrooloose/nerdtree becomes `scrooloose/nerdtree`.
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`.
253316
254−Some plugins require overrides in order to function properly. Overrides are placed in [overrides.nix](/pkgs/misc/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:
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:
255318
256−```
319+```nix
257320deoplete-fish = super.deoplete-fish.overrideAttrs(old: {
258321 dependencies = with super; [ deoplete-nvim vim-fish ];
259322});
@@ -265,21 +328,21 @@ To add a new plugin, run `./update.py --add "[owner]/[name]"`. **NOTE**: This sc
265328
266329Finally, 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.
267330
268−## Updating plugins in nixpkgs
331+## Updating plugins in nixpkgs {#updating-plugins-in-nixpkgs}
269332
270333Run 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).
271334
272335```sh
273−GITHUB_API_TOKEN=my_token ./pkgs/misc/vim-plugins/update.py
336+GITHUB_API_TOKEN=my_token ./pkgs/applications/editors/vim/plugins/update.py
274337```
275338
276339Alternatively, set the number of processes to a lower count to avoid rate-limiting.
277340
278341```sh
279−./pkgs/misc/vim-plugins/update.py --proc 1
342+./pkgs/applications/editors/vim/plugins/update.py --proc 1
280343```
281344
282−## Important repositories
345+## Important repositories {#important-repositories}
283346
284347- [vim-pi](https://bitbucket.org/vimcommunity/vim-pi) is a plugin repository
285348 from VAM plugin manager meant to be used by others as well used by
doc/manual.xml+14−11
@@ -8,34 +8,37 @@
88 <xi:include href="preface.chapter.xml" />
99 <part>
1010 <title>Using Nixpkgs</title>
11− <xi:include href="using/configuration.xml" />
12− <xi:include href="using/overlays.xml" />
13− <xi:include href="using/overrides.xml" />
11+ <xi:include href="using/configuration.chapter.xml" />
12+ <xi:include href="using/overlays.chapter.xml" />
13+ <xi:include href="using/overrides.chapter.xml" />
1414 <xi:include href="functions.xml" />
1515 </part>
1616 <part>
1717 <title>Standard environment</title>
18− <xi:include href="stdenv/stdenv.xml" />
19− <xi:include href="stdenv/meta.xml" />
20− <xi:include href="stdenv/multiple-output.xml" />
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" />
2121 <xi:include href="stdenv/cross-compilation.chapter.xml" />
22− <xi:include href="stdenv/platform-notes.xml" />
22+ <xi:include href="stdenv/platform-notes.chapter.xml" />
2323 </part>
2424 <part>
2525 <title>Builders</title>
2626 <xi:include href="builders/fetchers.chapter.xml" />
2727 <xi:include href="builders/trivial-builders.chapter.xml" />
28+ <xi:include href="builders/testers.chapter.xml" />
2829 <xi:include href="builders/special.xml" />
2930 <xi:include href="builders/images.xml" />
31+ <xi:include href="hooks/index.xml" />
3032 <xi:include href="languages-frameworks/index.xml" />
3133 <xi:include href="builders/packages/index.xml" />
3234 </part>
3335 <part>
3436 <title>Contributing to Nixpkgs</title>
35− <xi:include href="contributing/quick-start.xml" />
36− <xi:include href="contributing/coding-conventions.xml" />
37+ <xi:include href="contributing/quick-start.chapter.xml" />
38+ <xi:include href="contributing/coding-conventions.chapter.xml" />
3739 <xi:include href="contributing/submitting-changes.chapter.xml" />
38− <xi:include href="contributing/reviewing-contributions.xml" />
39− <xi:include href="contributing/contributing-to-documentation.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" />
4043 </part>
4144</book>
doc/preface.chapter.md+2−8
@@ -1,10 +1,4 @@
1−---
2−title: Preface
3−author: Frederik Rietdijk
4−date: 2015-11-25
5−---
6−
7−# Preface
1+# Preface {#preface}
82
93The Nix Packages collection (Nixpkgs) is a set of thousands of packages for the
104[Nix package manager](https://nixos.org/nix/), released under a
@@ -18,7 +12,7 @@ Nixpkgs. If you like to learn more about the Nix package manager and the Nix
1812expression language, then you are kindly referred to the [Nix manual](https://nixos.org/nix/manual/).
1913The NixOS distribution is documented in the [NixOS manual](https://nixos.org/nixos/manual/).
2014
21−## Overview of Nixpkgs
15+## Overview of Nixpkgs {#overview-of-nixpkgs}
2216
2317Nix expressions describe how to build packages from source and are collected in
2418the [nixpkgs repository](https://github.com/NixOS/nixpkgs). Also included in the
doc/shell.nix+3−5
@@ -1,5 +1,3 @@
1−{ pkgs ? import ../. {} }:
2−(import ./default.nix {}).overrideAttrs (x: {
3− buildInputs = x.buildInputs ++ [ pkgs.xmloscopy pkgs.ruby ];
4−
5−})
1+{ pkgs ? import ../. { } }:
2+(import ./default.nix { }).overrideAttrs
3+(x: { buildInputs = (x.buildInputs or [ ]) ++ [ pkgs.xmloscopy pkgs.ruby ]; })
doc/stdenv/cross-compilation.chapter.md+70−31
@@ -6,7 +6,6 @@
66
77This 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.
88
9−
109## Packaging in a cross-friendly manner {#sec-cross-packaging}
1110
1211### Platform parameters {#ssec-cross-platform-parameters}
@@ -16,7 +15,7 @@ Nixpkgs follows the [conventions of GNU autoconf](https://gcc.gnu.org/onlinedocs
1615In 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:
1716
1817```nix
19−{ stdenv, fooDep, barDep, .. }: ...stdenv.buildPlatform...
18+{ stdenv, fooDep, barDep, ... }: ...stdenv.buildPlatform...
2019```
2120
2221`buildPlatform`
@@ -65,8 +64,8 @@ The exact schema these fields follow is a bit ill-defined due to a long and conv
6564
6665### Theory of dependency categorization {#ssec-cross-dependency-categorization}
6766
68−::: note
69−This is a rather philosophical description that isn't very Nixpkgs-specific. For an overview of all the relevant attributes given to `mkDerivation`, see <xref linkend="ssec-stdenv-dependencies"/>. For a description of how everything is implemented, see <xref linkend="ssec-cross-dependency-implementation"/>.
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).
7069:::
7170
7271In this section we explore the relationship between both runtime and build-time dependencies and the 3 Autoconf platforms.
@@ -79,40 +78,79 @@ If both the dependency and depending packages aren't compilers or other machine-
7978
8079Finally, 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.
8180
82−Putting this all together, that means we have dependencies in the form "host → target", in at most the following six combinations:
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.
83102
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".
84104
85−#### Possible dependency types
86−| Dependency's host platform | Dependency's target platform |
87−| -- | -- |
88−| build | build |
89−| build | host |
90−| build | target |
91−| host | host |
92−| host | target |
93−| target | target |
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.
94106
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".
95108
96−Some examples will make this table clearer. Suppose there's some package that is being built with a `(build, host, target)` platform triple of `(foo, bar, baz)`. If it has a build-time library dependency, that would be a "host → build" dependency with a triple of `(foo, foo, *)` (the target platform is irrelevant). If it needs a compiler to be built, that would be a "build → host" dependency with a triple of `(foo, foo, *)` (the target platform is irrelevant). That compiler, would be built with another compiler, also "build → host" dependency, with a triple of `(foo, foo, foo)`.
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`.
97121
98122### Cross packaging cookbook {#ssec-cross-cookbook}
99123
100124Some 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!
101125
102−#### 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}
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+
103142Add the following to your `mkDerivation` invocation.
143+
104144```nix
105145depsBuildBuild = [ buildPackages.stdenv.cc ];
106146```
107147
108−#### My package fails to find `ar`. {#cross-qa-fails-to-find-ar}
109−Many packages assume that an unprefixed `ar` 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 prefixed `ar`.
110−
111−#### My package's testsuite needs to run host platform code. {#cross-testsuite-runs-host-code}
148+#### My package’s testsuite needs to run host platform code. {#cross-testsuite-runs-host-code}
112149
113150Add the following to your `mkDerivation` invocation.
151+
114152```nix
115−doCheck = stdenv.hostPlatform == stdenv.buildPlatfrom;
153+doCheck = stdenv.hostPlatform == stdenv.buildPlatform;
116154```
117155
118156## Cross-building packages {#sec-cross-usage}
@@ -123,7 +161,7 @@ Nixpkgs can be instantiated with `localSystem` alone, in which case there is no
123161$ nix-build '<nixpkgs>' --arg crossSystem '(import <nixpkgs/lib>).systems.examples.fooBarBaz' -A whatever
124162```
125163
126−::: note
164+::: {.note}
127165Eventually we would like to make these platform examples an unnecessary convenience so that
128166
129167```ShellSession
@@ -135,7 +173,7 @@ works in the vast majority of cases. The problem today is dependencies on other
135173
136174While 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.
137175
138−::: note
176+::: {.note}
139177Many 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.
140178:::
141179
@@ -145,9 +183,9 @@ One would think that `localSystem` and `crossSystem` overlap horribly with the t
145183
146184### Implementation of dependencies {#ssec-cross-dependency-implementation}
147185
148−The categories of dependencies developed in <xref linkend="ssec-cross-dependency-categorization"/> are specified as lists of derivations given to `mkDerivation`, as documented in <xref linkend="ssec-stdenv-dependencies"/>. In short, each list of dependencies for "host → target" of "foo → bar" is called `depsFooBar`, with exceptions for backwards compatibility that `depsBuildHost` is instead called `nativeBuildInputs` and `depsHostTarget` is instead called `buildInputs`. Nixpkgs is now structured so that each `depsFooBar` is automatically taken from `pkgsFooBar`. (These `pkgsFooBar`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.
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.
149187
150−Now, for most of Nixpkgs's history, there were no `pkgsFooBar` 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.
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.
151189
152190But 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.
153191
@@ -167,7 +205,7 @@ While there are many package sets, and thus many edges, the stages can also be a
167205
168206In 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`.
169207
170−::: note
208+::: {.note}
171209The 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.
172210:::
173211
@@ -175,15 +213,16 @@ If one looks at the 3 platform triples, one can see that they overlap such that
175213```
176214(native, native, native, foreign, foreign)
177215```
216+
178217If 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:
179218```
180219(native..., native, native, native, foreign, foreign, foreign...)
181220```
182−On 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".
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".
183222
184223
185−::: note
186−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.
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.
187226
188227First, 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`
189228
@@ -192,6 +231,6 @@ Second, it is because this is a frequent source of hard-to-follow "infinite recu
192231Thirdly, 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.
193232:::
194233
195−::: note
196−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.
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.
197236:::
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/meta.xmldeleted−349
@@ -1,349 +0,0 @@
1−<chapter xmlns="http://docbook.org/ns/docbook"
2− xmlns:xlink="http://www.w3.org/1999/xlink"
3− xml:id="chap-meta">
4− <title>Meta-attributes</title>
5− <para>
6− Nix packages can declare <emphasis>meta-attributes</emphasis> 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 <varname>meta</varname> declaration like this:
7−<programlisting>
8−meta = with stdenv.lib; {
9− description = "A program that produces a familiar, friendly greeting";
10− longDescription = ''
11− GNU Hello is a program that prints "Hello, world!" when you run it.
12− It is fully customizable.
13− '';
14− homepage = "https://www.gnu.org/software/hello/manual/";
15− license = licenses.gpl3Plus;
16− maintainers = [ maintainers.eelco ];
17− platforms = platforms.all;
18−};
19−</programlisting>
20− </para>
21− <para>
22− 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.
23− </para>
24− <para>
25− The meta-attributes of a package can be queried from the command-line using <command>nix-env</command>:
26−<screen>
27−<prompt>$ </prompt>nix-env -qa hello --json
28−{
29− "hello": {
30− "meta": {
31− "description": "A program that produces a familiar, friendly greeting",
32− "homepage": "https://www.gnu.org/software/hello/manual/",
33− "license": {
34− "fullName": "GNU General Public License version 3 or later",
35− "shortName": "GPLv3+",
36− "url": "http://www.fsf.org/licensing/licenses/gpl.html"
37− },
38− "longDescription": "GNU Hello is a program that prints \"Hello, world!\" when you run it.\nIt is fully customizable.\n",
39− "maintainers": [
40− "Ludovic Court\u00e8s <ludo@gnu.org>"
41− ],
42− "platforms": [
43− "i686-linux",
44− "x86_64-linux",
45− "armv5tel-linux",
46− "armv7l-linux",
47− "mips32-linux",
48− "x86_64-darwin",
49− "i686-cygwin",
50− "i686-freebsd",
51− "x86_64-freebsd",
52− "i686-openbsd",
53− "x86_64-openbsd"
54− ],
55− "position": "/home/user/dev/nixpkgs/pkgs/applications/misc/hello/default.nix:14"
56− },
57− "name": "hello-2.9",
58− "system": "x86_64-linux"
59− }
60−}
61−
62−
63−</screen>
64− <command>nix-env</command> knows about the <varname>description</varname> field specifically:
65−<screen>
66−<prompt>$ </prompt>nix-env -qa hello --description
67−hello-2.3 A program that produces a familiar, friendly greeting
68−</screen>
69− </para>
70− <section xml:id="sec-standard-meta-attributes">
71− <title>Standard meta-attributes</title>
72−
73− <para>
74− It is expected that each meta-attribute is one of the following:
75− </para>
76−
77− <variablelist>
78− <varlistentry>
79− <term>
80− <varname>description</varname>
81− </term>
82− <listitem>
83− <para>
84− A short (one-line) description of the package. This is shown by <command>nix-env -q --description</command> and also on the Nixpkgs release pages.
85− </para>
86− <para>
87− 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.
88− </para>
89− <para>
90− Wrong: <literal>"libpng is a library that allows you to decode PNG images."</literal>
91− </para>
92− <para>
93− Right: <literal>"A library for decoding PNG images"</literal>
94− </para>
95− </listitem>
96− </varlistentry>
97− <varlistentry>
98− <term>
99− <varname>longDescription</varname>
100− </term>
101− <listitem>
102− <para>
103− An arbitrarily long description of the package.
104− </para>
105− </listitem>
106− </varlistentry>
107− <varlistentry>
108− <term>
109− <varname>branch</varname>
110− </term>
111− <listitem>
112− <para>
113− 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.
114− </para>
115− </listitem>
116− </varlistentry>
117− <varlistentry>
118− <term>
119− <varname>homepage</varname>
120− </term>
121− <listitem>
122− <para>
123− The package’s homepage. Example: <literal>https://www.gnu.org/software/hello/manual/</literal>
124− </para>
125− </listitem>
126− </varlistentry>
127− <varlistentry>
128− <term>
129− <varname>downloadPage</varname>
130− </term>
131− <listitem>
132− <para>
133− The page where a link to the current version can be found. Example: <literal>https://ftp.gnu.org/gnu/hello/</literal>
134− </para>
135− </listitem>
136− </varlistentry>
137− <varlistentry>
138− <term>
139− <varname>changelog</varname>
140− </term>
141− <listitem>
142− <para>
143− 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: <literal>"https://git.savannah.gnu.org/cgit/hello.git/plain/NEWS?h=v${version}"</literal>
144− </para>
145− </listitem>
146− </varlistentry>
147− <varlistentry>
148− <term>
149− <varname>license</varname>
150− </term>
151− <listitem>
152− <para>
153− The license, or licenses, for the package. One from the attribute set defined in <link
154− xlink:href="https://github.com/NixOS/nixpkgs/blob/master/lib/licenses.nix"> <filename>nixpkgs/lib/licenses.nix</filename></link>. 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:
155− <itemizedlist>
156− <listitem>
157− <para>
158− Single license referenced by attribute (preferred) <literal>stdenv.lib.licenses.gpl3Only</literal>.
159− </para>
160− </listitem>
161− <listitem>
162− <para>
163− Single license referenced by its attribute shortName (frowned upon) <literal>"gpl3Only"</literal>.
164− </para>
165− </listitem>
166− <listitem>
167− <para>
168− Single license referenced by its attribute spdxId (frowned upon) <literal>"GPL-3.0-only"</literal>.
169− </para>
170− </listitem>
171− <listitem>
172− <para>
173− Multiple licenses referenced by attribute (preferred) <literal>with stdenv.lib.licenses; [ asl20 free ofl ]</literal>.
174− </para>
175− </listitem>
176− <listitem>
177− <para>
178− Multiple licenses referenced as a space delimited string of attribute shortNames (frowned upon) <literal>"asl20 free ofl"</literal>.
179− </para>
180− </listitem>
181− </itemizedlist>
182− For details, see <xref linkend='sec-meta-license'/>.
183− </para>
184− </listitem>
185− </varlistentry>
186− <varlistentry>
187− <term>
188− <varname>maintainers</varname>
189− </term>
190− <listitem>
191− <para>
192− A list of the maintainers of this Nix expression. Maintainers are defined in <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/maintainers/maintainer-list.nix"><filename>nixpkgs/maintainers/maintainer-list.nix</filename></link>. 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 <literal>maintainers = with lib.maintainers; [ alice bob ]</literal>.
193− </para>
194− </listitem>
195− </varlistentry>
196− <varlistentry>
197− <term>
198− <varname>priority</varname>
199− </term>
200− <listitem>
201− <para>
202− The <emphasis>priority</emphasis> of the package, used by <command>nix-env</command> to resolve file name conflicts between packages. See the Nix manual page for <command>nix-env</command> for details. Example: <literal>"10"</literal> (a low-priority package).
203− </para>
204− </listitem>
205− </varlistentry>
206− <varlistentry>
207− <term>
208− <varname>platforms</varname>
209− </term>
210− <listitem>
211− <para>
212− 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:
213−<programlisting>
214−meta.platforms = stdenv.lib.platforms.linux;
215−</programlisting>
216− Attribute Set <varname>stdenv.lib.platforms</varname> defines <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/lib/systems/doubles.nix"> various common lists</link> of platforms types.
217− </para>
218− </listitem>
219− </varlistentry>
220− <varlistentry>
221− <term>
222− <varname>tests</varname>
223− </term>
224− <listitem>
225− <warning>
226− <para>
227− This attribute is special in that it is not actually under the <literal>meta</literal> attribute set but rather under the <literal>passthru</literal> attribute set. This is due to how <literal>meta</literal> attributes work, and the fact that they are supposed to contain only metadata, not derivations.
228− </para>
229− </warning>
230− <para>
231− An attribute set with as values tests. A test is a derivation, which builds successfully when the test passes, and fails to build otherwise. A derivation that is a test needs to have <literal>meta.timeout</literal> defined.
232− </para>
233− <para>
234− The NixOS tests are available as <literal>nixosTests</literal> in parameters of derivations. For instance, the OpenSMTPD derivation includes lines similar to:
235−<programlisting>
236−{ /* ... */, nixosTests }:
237−{
238− # ...
239− passthru.tests = {
240− basic-functionality-and-dovecot-integration = nixosTests.opensmtpd;
241− };
242−}
243−</programlisting>
244− </para>
245− </listitem>
246− </varlistentry>
247− <varlistentry>
248− <term>
249− <varname>timeout</varname>
250− </term>
251− <listitem>
252− <para>
253− 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 <literal>nixpkgs</literal>.
254− </para>
255− </listitem>
256− </varlistentry>
257− <varlistentry>
258− <term>
259− <varname>hydraPlatforms</varname>
260− </term>
261− <listitem>
262− <para>
263− The list of Nix platform types for which the Hydra instance at <literal>hydra.nixos.org</literal> will build the package. (Hydra is the Nix-based continuous build system.) It defaults to the value of <varname>meta.platforms</varname>. Thus, the only reason to set <varname>meta.hydraPlatforms</varname> is if you want <literal>hydra.nixos.org</literal> to build the package on a subset of <varname>meta.platforms</varname>, or not at all, e.g.
264−<programlisting>
265−meta.platforms = stdenv.lib.platforms.linux;
266−meta.hydraPlatforms = [];
267−</programlisting>
268− </para>
269− </listitem>
270− </varlistentry>
271− <varlistentry>
272− <term>
273− <varname>broken</varname>
274− </term>
275− <listitem>
276− <para>
277− If set to <literal>true</literal>, the package is marked as “broken”, meaning that it won’t show up in <literal>nix-env -qa</literal>, and cannot be built or installed. Such packages should be removed from Nixpkgs eventually unless they are fixed.
278− </para>
279− </listitem>
280− </varlistentry>
281− <varlistentry>
282− <term>
283− <varname>updateWalker</varname>
284− </term>
285− <listitem>
286− <para>
287− If set to <literal>true</literal>, the package is tested to be updated correctly by the <literal>update-walker.sh</literal> script without additional settings. Such packages have <varname>meta.version</varname> set and their homepage (or the page specified by <varname>meta.downloadPage</varname>) contains a direct link to the package tarball.
288− </para>
289− </listitem>
290− </varlistentry>
291− </variablelist>
292− </section>
293− <section xml:id="sec-meta-license">
294− <title>Licenses</title>
295−
296− <para>
297− The <varname>meta.license</varname> attribute should preferrably contain a value from <varname>stdenv.lib.licenses</varname> defined in <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/lib/licenses.nix"> <filename>nixpkgs/lib/licenses.nix</filename></link>, or in-place license description of the same format if the license is unlikely to be useful in another expression.
298− </para>
299−
300− <para>
301− Although it's typically better to indicate the specific license, a few generic options are available:
302− <variablelist>
303− <varlistentry>
304− <term>
305− <varname>stdenv.lib.licenses.free</varname>, <varname>"free"</varname>
306− </term>
307− <listitem>
308− <para>
309− Catch-all for free software licenses not listed above.
310− </para>
311− </listitem>
312− </varlistentry>
313− <varlistentry>
314− <term>
315− <varname>stdenv.lib.licenses.unfreeRedistributable</varname>, <varname>"unfree-redistributable"</varname>
316− </term>
317− <listitem>
318− <para>
319− Unfree package that can be redistributed in binary form. That is, it’s legal to redistribute the <emphasis>output</emphasis> of the derivation. This means that the package can be included in the Nixpkgs channel.
320− </para>
321− <para>
322− 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 <command>patchelf</command> to make them work. Thus, its license is <varname>"unfree"</varname> and it cannot be included in the Nixpkgs channel.
323− </para>
324− </listitem>
325− </varlistentry>
326− <varlistentry>
327− <term>
328− <varname>stdenv.lib.licenses.unfree</varname>, <varname>"unfree"</varname>
329− </term>
330− <listitem>
331− <para>
332− 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.
333− </para>
334− </listitem>
335− </varlistentry>
336− <varlistentry>
337− <term>
338− <varname>stdenv.lib.licenses.unfreeRedistributableFirmware</varname>, <varname>"unfree-redistributable-firmware"</varname>
339− </term>
340− <listitem>
341− <para>
342− This package supplies unfree, redistributable firmware. This is a separate value from <varname>unfree-redistributable</varname> because not everybody cares whether firmware is free.
343− </para>
344− </listitem>
345− </varlistentry>
346− </variablelist>
347− </para>
348− </section>
349−</chapter>
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/multiple-output.xmldeleted−262
@@ -1,262 +0,0 @@
1−<?xml version="1.0" encoding="UTF-8"?>
2−<!DOCTYPE chapter [
3− <!ENTITY ndash "–"> <!-- @vcunat likes to use this one ;-) -->
4−]>
5−<chapter xmlns="http://docbook.org/ns/docbook"
6− xmlns:xlink="http://www.w3.org/1999/xlink"
7− xml:id="chap-multiple-output">
8− <title>Multiple-output packages</title>
9− <section xml:id="sec-multiple-outputs-introduction">
10− <title>Introduction</title>
11−
12− <para>
13− 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.
14− </para>
15−
16− <para>
17− 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.
18− </para>
19−
20− <note>
21− <para>
22− 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.
23− </para>
24− </note>
25−
26− <para>
27− A number of attributes can be used to work with a derivation with multiple outputs. The attribute <varname>outputs</varname> 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 <varname>meta.outputsToInstall</varname> is used to determine the default set of outputs to install when using the derivation name unqualified.
28− </para>
29−
30− </section>
31− <section xml:id="sec-multiple-outputs-installing">
32− <title>Installing a split package</title>
33−
34− <para>
35− When installing a package with multiple outputs, the package's <varname>meta.outputsToInstall</varname> attribute determines which outputs are actually installed. <varname>meta.outputsToInstall</varname> is a list whose <link xlink:href="https://github.com/NixOS/nixpkgs/blob/f1680774340d5443a1409c3421ced84ac1163ba9/pkgs/stdenv/generic/make-derivation.nix#L310-L320">default installs binaries and the associated man pages</link>. The following sections describe ways to install different outputs.
36− </para>
37−
38− <section xml:id="sec-multiple-outputs-installing-nixos">
39− <title>Selecting outputs to install via NixOS</title>
40−
41− <para>
42− NixOS provides two ways to select the outputs to install for packages listed in <varname>environment.systemPackages</varname>:
43− </para>
44−
45− <itemizedlist>
46− <listitem>
47− <para>
48− The configuration option <varname>environment.extraOutputsToInstall</varname> is appended to each package's <varname>meta.outputsToInstall</varname> attribute to determine the outputs to install. It can for example be used to install <literal>info</literal> documentation or debug symbols for all packages.
49− </para>
50− </listitem>
51− <listitem>
52− <para>
53− The outputs can be listed as packages in <varname>environment.systemPackages</varname>. For example, the <literal>"out"</literal> and <literal>"info"</literal> outputs for the <varname>coreutils</varname> package can be installed by including <varname>coreutils</varname> and <varname>coreutils.info</varname> in <varname>environment.systemPackages</varname>.
54− </para>
55− </listitem>
56− </itemizedlist>
57− </section>
58−
59− <section xml:id="sec-multiple-outputs-installing-nix-env">
60− <title>Selecting outputs to install via <command>nix-env</command></title>
61−
62− <para>
63− <command>nix-env</command> lacks an easy way to select the outputs to install. When installing a package, <command>nix-env</command> always installs the outputs listed in <varname>meta.outputsToInstall</varname>, even when the user explicitly selects an output.
64− </para>
65−
66− <warning>
67− <para>
68− <command>nix-env</command> silenty disregards the outputs selected by the user, and instead installs the outputs from <varname>meta.outputsToInstall</varname>. For example,
69− </para>
70−<screen><prompt>$ </prompt>nix-env -iA nixpkgs.coreutils.info</screen>
71− <para>
72− installs the <literal>"out"</literal> output (<varname>coreutils.meta.outputsToInstall</varname> is <literal>[ "out" ]</literal>) instead of the requested <literal>"info"</literal>.
73− </para>
74− </warning>
75−
76− <para>
77− The only recourse to select an output with <command>nix-env</command> is to override the package's <varname>meta.outputsToInstall</varname>, using the functions described in <xref linkend="chap-overrides" />. For example, the following overlay adds the <literal>"info"</literal> output for the <varname>coreutils</varname> package:
78− </para>
79−
80−<programlisting>self: super:
81−{
82− coreutils = super.coreutils.overrideAttrs (oldAttrs: {
83− meta = oldAttrs.meta // { outputsToInstall = oldAttrs.meta.outputsToInstall or [ "out" ] ++ [ "info" ]; };
84− });
85−}
86−</programlisting>
87− </section>
88− </section>
89− <section xml:id="sec-multiple-outputs-using-split-packages">
90− <title>Using a split package</title>
91−
92− <para>
93− In the Nix language the individual outputs can be reached explicitly as attributes, e.g. <varname>coreutils.info</varname>, but the typical case is just using packages as build inputs.
94− </para>
95−
96− <para>
97− When a multiple-output derivation gets into a build input of another derivation, the <varname>dev</varname> output is added if it exists, otherwise the first output is added. In addition to that, <varname>propagatedBuildOutputs</varname> of that package which by default contain <varname>$outputBin</varname> and <varname>$outputLib</varname> are also added. (See <xref linkend="multiple-output-file-type-groups" />.)
98− </para>
99−
100− <para>
101− In some cases it may be desirable to combine different outputs under a single store path. A function <literal>symlinkJoin</literal> can be used to do this. (Note that it may negate some closure size benefits of using a multiple-output package.)
102− </para>
103− </section>
104− <section xml:id="sec-multiple-outputs-">
105− <title>Writing a split derivation</title>
106−
107− <para>
108− Here you find how to write a derivation that produces multiple outputs.
109− </para>
110−
111− <para>
112− 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 <<filename>nixpkgs/pkgs/build-support/setup-hooks/multiple-outputs.sh</filename>>; it's relatively well-readable. The whole machinery is triggered by defining the <varname>outputs</varname> attribute to contain the list of desired output names (strings).
113− </para>
114−
115−<programlisting>outputs = [ "bin" "dev" "out" "doc" ];</programlisting>
116−
117− <para>
118− 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 <varname>out</varname> output, as it catches any files that didn't get elsewhere.
119− </para>
120−
121− <note>
122− <para>
123− There is a special handling of the <varname>debug</varname> output, described at <xref linkend="stdenv-separateDebugInfo" />.
124− </para>
125− </note>
126−
127− <section xml:id="multiple-output-file-binaries-first-convention">
128− <title><quote>Binaries first</quote></title>
129−
130− <para>
131− A commonly adopted convention in <literal>nixpkgs</literal> 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 <literal>perl</literal> package contains a <literal>perl</literal> executable it can be referenced as <literal>${pkgs.perl}/bin/perl</literal> within a Nix derivation that needs to execute a Perl script.
132− </para>
133−
134− <para>
135− The <literal>glibc</literal> package is a deliberate single exception to the <quote>binaries first</quote> convention. The <literal>glibc</literal> has <literal>libs</literal> as its first output allowing the libraries provided by <literal>glibc</literal> to be referenced directly (e.g. <literal>${stdenv.glibc}/lib/ld-linux-x86-64.so.2</literal>). The executables provided by <literal>glibc</literal> can be accessed via its <literal>bin</literal> attribute (e.g. <literal>${stdenv.glibc.bin}/bin/ldd</literal>).
136− </para>
137−
138− <para>
139− The reason for why <literal>glibc</literal> deviates from the convention is because referencing a library provided by <literal>glibc</literal> 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 <literal>glibc</literal> libraries from Nix packages (please see the documentation on <link xlink:href="https://github.com/NixOS/patchelf/blob/master/README">patchelf</link> for more details).
140− </para>
141− </section>
142−
143− <section xml:id="multiple-output-file-type-groups">
144− <title>File type groups</title>
145−
146− <para>
147− 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 <varname>outputFoo</varname> 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.
148− </para>
149−
150− <variablelist>
151− <varlistentry>
152− <term>
153− <varname> $outputDev</varname>
154− </term>
155− <listitem>
156− <para>
157− is for development-only files. These include C(++) headers, pkg-config, cmake and aclocal files. They go to <varname>dev</varname> or <varname>out</varname> by default.
158− </para>
159− </listitem>
160− </varlistentry>
161− <varlistentry>
162− <term>
163− <varname> $outputBin</varname>
164− </term>
165− <listitem>
166− <para>
167− is meant for user-facing binaries, typically residing in bin/. They go to <varname>bin</varname> or <varname>out</varname> by default.
168− </para>
169− </listitem>
170− </varlistentry>
171− <varlistentry>
172− <term>
173− <varname> $outputLib</varname>
174− </term>
175− <listitem>
176− <para>
177− is meant for libraries, typically residing in <filename>lib/</filename> and <filename>libexec/</filename>. They go to <varname>lib</varname> or <varname>out</varname> by default.
178− </para>
179− </listitem>
180− </varlistentry>
181− <varlistentry>
182− <term>
183− <varname> $outputDoc</varname>
184− </term>
185− <listitem>
186− <para>
187− is for user documentation, typically residing in <filename>share/doc/</filename>. It goes to <varname>doc</varname> or <varname>out</varname> by default.
188− </para>
189− </listitem>
190− </varlistentry>
191− <varlistentry>
192− <term>
193− <varname> $outputDevdoc</varname>
194− </term>
195− <listitem>
196− <para>
197− is for <emphasis>developer</emphasis> documentation. Currently we count gtk-doc and devhelp books in there. It goes to <varname>devdoc</varname> or is removed (!) by default. This is because e.g. gtk-doc tends to be rather large and completely unused by nixpkgs users.
198− </para>
199− </listitem>
200− </varlistentry>
201− <varlistentry>
202− <term>
203− <varname> $outputMan</varname>
204− </term>
205− <listitem>
206− <para>
207− is for man pages (except for section 3). They go to <varname>man</varname> or <varname>$outputBin</varname> by default.
208− </para>
209− </listitem>
210− </varlistentry>
211− <varlistentry>
212− <term>
213− <varname> $outputDevman</varname>
214− </term>
215− <listitem>
216− <para>
217− is for section 3 man pages. They go to <varname>devman</varname> or <varname>$outputMan</varname> by default.
218− </para>
219− </listitem>
220− </varlistentry>
221− <varlistentry>
222− <term>
223− <varname> $outputInfo</varname>
224− </term>
225− <listitem>
226− <para>
227− is for info pages. They go to <varname>info</varname> or <varname>$outputBin</varname> by default.
228− </para>
229− </listitem>
230− </varlistentry>
231− </variablelist>
232− </section>
233−
234− <section xml:id="sec-multiple-outputs-caveats">
235− <title>Common caveats</title>
236−
237− <itemizedlist>
238− <listitem>
239− <para>
240− Some configure scripts don't like some of the parameters passed by default by the framework, e.g. <literal>--docdir=/foo/bar</literal>. You can disable this by setting <literal>setOutputFlags = false;</literal>.
241− </para>
242− </listitem>
243− <listitem>
244− <para>
245− 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.)
246− </para>
247− </listitem>
248− <listitem>
249− <para>
250− Most of split packages contain their core functionality in libraries. These libraries tend to refer to various kind of data that typically gets into <varname>out</varname>, e.g. locale strings, so there is often no advantage in separating the libraries into <varname>lib</varname>, as keeping them in <varname>out</varname> is easier.
251− </para>
252− </listitem>
253− <listitem>
254− <para>
255− Some packages have hidden assumptions on install paths, which complicates splitting.
256− </para>
257− </listitem>
258− </itemizedlist>
259− </section>
260− </section>
261−<!--Writing a split derivation-->
262−</chapter>
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/platform-notes.xmldeleted−83
@@ -1,83 +0,0 @@
1−<chapter xmlns="http://docbook.org/ns/docbook"
2− xmlns:xlink="http://www.w3.org/1999/xlink"
3− xml:id="chap-platform-notes">
4− <title>Platform Notes</title>
5− <section xml:id="sec-darwin">
6− <title>Darwin (macOS)</title>
7−
8− <para>
9− Some common issues when packaging software for Darwin:
10− </para>
11−
12− <itemizedlist>
13− <listitem>
14− <para>
15− The Darwin <literal>stdenv</literal> uses clang instead of gcc. When referring to the compiler <varname>$CC</varname> or <command>cc</command> will work in both cases. Some builds hardcode gcc/g++ in their build scripts, that can usually be fixed with using something like <literal>makeFlags = [ "CC=cc" ];</literal> or by patching the build scripts.
16− </para>
17−<programlisting>
18−stdenv.mkDerivation {
19− name = "libfoo-1.2.3";
20− # ...
21− buildPhase = ''
22− $CC -o hello hello.c
23− '';
24−}
25−</programlisting>
26− </listitem>
27− <listitem>
28− <para>
29− On Darwin, libraries are linked using absolute paths, libraries are resolved by their <literal>install_name</literal> 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 <command>install_name_tool -id</command> during the <function>fixupPhase</function>.
30− </para>
31−<programlisting>
32−stdenv.mkDerivation {
33− name = "libfoo-1.2.3";
34− # ...
35− makeFlags = stdenv.lib.optional stdenv.isDarwin "LDFLAGS=-Wl,-install_name,$(out)/lib/libfoo.dylib";
36−}
37−</programlisting>
38− </listitem>
39− <listitem>
40− <para>
41− Even if the libraries are linked using absolute paths and resolved via their <literal>install_name</literal> correctly, tests can sometimes fail to run binaries. This happens because the <varname>checkPhase</varname> runs before the libraries are installed.
42− </para>
43− <para>
44− This can usually be solved by running the tests after the <varname>installPhase</varname> or alternatively by using <varname>DYLD_LIBRARY_PATH</varname>. More information about this variable can be found in the <citerefentry>
45− <refentrytitle>dyld</refentrytitle>
46− <manvolnum>1</manvolnum></citerefentry> manpage.
47− </para>
48−<programlisting>
49−dyld: Library not loaded: /nix/store/7hnmbscpayxzxrixrgxvvlifzlxdsdir-jq-1.5-lib/lib/libjq.1.dylib
50−Referenced from: /private/tmp/nix-build-jq-1.5.drv-0/jq-1.5/tests/../jq
51−Reason: image not found
52−./tests/jqtest: line 5: 75779 Abort trap: 6
53−</programlisting>
54−<programlisting>
55−stdenv.mkDerivation {
56− name = "libfoo-1.2.3";
57− # ...
58− doInstallCheck = true;
59− installCheckTarget = "check";
60−}
61−</programlisting>
62− </listitem>
63− <listitem>
64− <para>
65− Some packages assume xcode is available and use <command>xcrun</command> to resolve build tools like <command>clang</command>, etc. This causes errors like <code>xcode-select: error: no developer tools were found at '/Applications/Xcode.app'</code> while the build doesn't actually depend on xcode.
66− </para>
67−<programlisting>
68−stdenv.mkDerivation {
69− name = "libfoo-1.2.3";
70− # ...
71− prePatch = ''
72− substituteInPlace Makefile \
73− --replace '/usr/bin/xcrun clang' clang
74− '';
75−}
76−</programlisting>
77− <para>
78− The package <literal>xcbuild</literal> 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.
79− </para>
80− </listitem>
81− </itemizedlist>
82− </section>
83−</chapter>
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/stdenv/stdenv.xmldeleted−2423
@@ -1,2423 +0,0 @@
1−<chapter xmlns="http://docbook.org/ns/docbook"
2− xmlns:xlink="http://www.w3.org/1999/xlink"
3− xml:id="chap-stdenv">
4− <title>The Standard Environment</title>
5− <para>
6− 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 <literal>./configure; make; make install</literal> build interface, you don’t need to write a build script at all; the standard environment does everything automatically. If <literal>stdenv</literal> doesn’t do what you need automatically, you can easily customise or override the various build phases.
7− </para>
8− <section xml:id="sec-using-stdenv">
9− <title>Using <literal>stdenv</literal></title>
10−
11− <para>
12− To build a package with the standard environment, you use the function <varname>stdenv.mkDerivation</varname>, instead of the primitive built-in function <varname>derivation</varname>, e.g.
13−<programlisting>
14−stdenv.mkDerivation {
15− name = "libfoo-1.2.3";
16− src = fetchurl {
17− url = "http://example.org/libfoo-1.2.3.tar.bz2";
18− sha256 = "0x2g1jqygyr5wiwg4ma1nd7w4ydpy82z9gkcv8vh2v8dn3y58v5m";
19− };
20−}</programlisting>
21− (<varname>stdenv</varname> needs to be in scope, so if you write this in a separate Nix expression from <filename>pkgs/all-packages.nix</filename>, you need to pass it as a function argument.) Specifying a <varname>name</varname> and a <varname>src</varname> is the absolute minimum Nix requires. For convenience, you can also use <varname>pname</varname> and <varname>version</varname> attributes and <literal>mkDerivation</literal> will automatically set <varname>name</varname> to <literal>"${pname}-${version}"</literal> by default. Since <link xlink:href="https://github.com/NixOS/rfcs/pull/35">RFC 0035</link>, this is preferred for packages in Nixpkgs, as it allows us to reuse the version easily:
22−<programlisting>
23−stdenv.mkDerivation rec {
24− pname = "libfoo";
25− version = "1.2.3";
26− src = fetchurl {
27− url = "http://example.org/libfoo-source-${version}.tar.bz2";
28− sha256 = "0x2g1jqygyr5wiwg4ma1nd7w4ydpy82z9gkcv8vh2v8dn3y58v5m";
29− };
30−}</programlisting>
31− </para>
32−
33− <para>
34− Many packages have dependencies that are not provided in the standard environment. It’s usually sufficient to specify those dependencies in the <varname>buildInputs</varname> attribute:
35−<programlisting>
36−stdenv.mkDerivation {
37− name = "libfoo-1.2.3";
38− ...
39− buildInputs = [libbar perl ncurses];
40−}</programlisting>
41− This attribute ensures that the <filename>bin</filename> subdirectories of these packages appear in the <envar>PATH</envar> environment variable during the build, that their <filename>include</filename> subdirectories are searched by the C compiler, and so on. (See <xref linkend="ssec-setup-hooks"/> for details.)
42− </para>
43−
44− <para>
45− 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 <emphasis>phases</emphasis>, all of which can be overridden or modified individually: unpacking the sources, applying patches, configuring, building, and installing. (There are some others; see <xref linkend="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:
46−<programlisting>
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−}</programlisting>
58− (Note the use of <literal>''</literal>-style string literals, which are very convenient for large multi-line script fragments because they don’t need escaping of <literal>"</literal> and <literal>\</literal>, and because indentation is intelligently removed.)
59− </para>
60−
61− <para>
62− There are many other attributes to customise the build. These are listed in <xref linkend="ssec-stdenv-attributes"/>.
63− </para>
64−
65− <para>
66− While the standard environment provides a generic builder, you can still supply your own build script:
67−<programlisting>
68−stdenv.mkDerivation {
69− name = "libfoo-1.2.3";
70− ...
71− builder = ./builder.sh;
72−}</programlisting>
73− where the builder can do anything it wants, but typically starts with
74−<programlisting>
75−source $stdenv/setup
76−</programlisting>
77− to let <literal>stdenv</literal> set up the environment (e.g., process the <varname>buildInputs</varname>). If you want, you can still use <literal>stdenv</literal>’s generic builder:
78−<programlisting>
79−source $stdenv/setup
80−
81−buildPhase() {
82− echo "... this is my custom build phase ..."
83− gcc foo.c -o foo
84−}
85−
86−installPhase() {
87− mkdir -p $out/bin
88− cp foo $out/bin
89−}
90−
91−genericBuild
92−</programlisting>
93− </para>
94− </section>
95− <section xml:id="sec-tools-of-stdenv">
96− <title>Tools provided by <literal>stdenv</literal></title>
97−
98− <para>
99− The standard environment provides the following packages:
100− <itemizedlist>
101− <listitem>
102− <para>
103− The GNU C Compiler, configured with C and C++ support.
104− </para>
105− </listitem>
106− <listitem>
107− <para>
108− GNU coreutils (contains a few dozen standard Unix commands).
109− </para>
110− </listitem>
111− <listitem>
112− <para>
113− GNU findutils (contains <command>find</command>).
114− </para>
115− </listitem>
116− <listitem>
117− <para>
118− GNU diffutils (contains <command>diff</command>, <command>cmp</command>).
119− </para>
120− </listitem>
121− <listitem>
122− <para>
123− GNU <command>sed</command>.
124− </para>
125− </listitem>
126− <listitem>
127− <para>
128− GNU <command>grep</command>.
129− </para>
130− </listitem>
131− <listitem>
132− <para>
133− GNU <command>awk</command>.
134− </para>
135− </listitem>
136− <listitem>
137− <para>
138− GNU <command>tar</command>.
139− </para>
140− </listitem>
141− <listitem>
142− <para>
143− <command>gzip</command>, <command>bzip2</command> and <command>xz</command>.
144− </para>
145− </listitem>
146− <listitem>
147− <para>
148− GNU Make.
149− </para>
150− </listitem>
151− <listitem>
152− <para>
153− Bash. This is the shell used for all builders in the Nix Packages collection. Not using <command>/bin/sh</command> removes a large source of portability problems.
154− </para>
155− </listitem>
156− <listitem>
157− <para>
158− The <command>patch</command> command.
159− </para>
160− </listitem>
161− </itemizedlist>
162− </para>
163−
164− <para>
165− On Linux, <literal>stdenv</literal> also includes the <command>patchelf</command> utility.
166− </para>
167− </section>
168− <section xml:id="ssec-stdenv-dependencies">
169− <title>Specifying dependencies</title>
170−
171− <para>
172− As described in the Nix manual, almost any <filename>*.drv</filename> store path in a derivation's attribute set will induce a dependency on that derivation. <varname>mkDerivation</varname>, however, takes a few attributes intended to, between them, 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 <envar>PATH</envar>. That is built-in, but other setup is done via a pluggable mechanism that works in conjunction with these dependency attributes. See <xref linkend="ssec-setup-hooks"/> for details.
173− </para>
174−
175− <para>
176− 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 <xref linkend="chap-cross"/> for exactly what each platform means.
177− <footnote xml:id="footnote-stdenv-ignored-build-platform">
178− <para>
179− 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 <emphasis>specified</emphasis> as interfaces, not concrete implementation.
180− </para>
181− </footnote>
182− 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 <varname>strictDeps</varname> set it is mostly enforced even in the native case.
183− </para>
184−
185− <para>
186− The extension of <envar>PATH</envar> 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.
187− <footnote xml:id="footnote-stdenv-native-dependencies-in-path">
188− <para>
189− Currently, this means for native builds all dependencies are put on the <envar>PATH</envar>. 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 <varname>depsBuild*</varname> and <varname>nativeBuildInputs</varname> would be added to the <envar>PATH</envar>.
190− </para>
191− </footnote>
192− For each dependency <replaceable>dep</replaceable> of those dependencies, <filename><replaceable>dep</replaceable>/bin</filename>, if present, is added to the <envar>PATH</envar> environment variable.
193− </para>
194−
195− <para>
196− The dependency is propagated when it forces some of its other-transitive (non-immediate) downstream dependencies to also take it on as an immediate dependency. 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.
197− </para>
198−
199− <para>
200− 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. The exact rules for dependency propagation can be given by assigning to each dependency two integers based one how its host and target platforms are offset from the depending derivation's platforms. Those offsets are given below in the descriptions of each dependency list attribute. 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 in sort 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.
201− </para>
202−
203− <para>
204− We can define the process precisely with <link xlink:href="https://en.wikipedia.org/wiki/Natural_deduction">Natural Deduction</link> using the inference rules. This probably seems a bit obtuse, but so is the bash code that actually implements it!
205− <footnote xml:id="footnote-stdenv-find-inputs-location">
206− <para>
207− The <function>findInputs</function> function, currently residing in <filename>pkgs/stdenv/generic/setup.sh</filename>, implements the propagation logic.
208− </para>
209− </footnote>
210− They're confusing in very different ways so... hopefully if something doesn't make sense in one presentation, it will in the other!
211−<programlisting>
212−let mapOffset(h, t, i) = i + (if i <= 0 then h else t - 1)
213−
214−propagated-dep(h0, t0, A, B)
215−propagated-dep(h1, t1, B, C)
216−h0 + h1 in {-1, 0, 1}
217−h0 + t1 in {-1, 0, 1}
218−-------------------------------------- Transitive property
219−propagated-dep(mapOffset(h0, t0, h1),
220− mapOffset(h0, t0, t1),
221− A, C)</programlisting>
222−<programlisting>
223−let mapOffset(h, t, i) = i + (if i <= 0 then h else t - 1)
224−
225−dep(h0, _, A, B)
226−propagated-dep(h1, t1, B, C)
227−h0 + h1 in {-1, 0, 1}
228−h0 + t1 in {-1, 0, -1}
229−----------------------------- Take immediate dependencies' propagated dependencies
230−propagated-dep(mapOffset(h0, t0, h1),
231− mapOffset(h0, t0, t1),
232− A, C)</programlisting>
233−<programlisting>
234−propagated-dep(h, t, A, B)
235−----------------------------- Propagated dependencies count as dependencies
236−dep(h, t, A, B)</programlisting>
237− 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: <literal>t = h + 1</literal>. That means that:
238−<programlisting>
239−let f(h, t, i) = i + (if i <= 0 then h else t - 1)
240−let f(h, h + 1, i) = i + (if i <= 0 then h else (h + 1) - 1)
241−let f(h, h + 1, i) = i + (if i <= 0 then h else h)
242−let f(h, h + 1, i) = i + h
243−</programlisting>
244− 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.
245− </para>
246−
247− <para>
248− Because of the bounds checks, the uncommon cases are <literal>h = t</literal> and <literal>h + 2 = t</literal>. In the former case, the motivation for <function>mapOffset</function> 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. <function>mapOffset</function> effectively "squashes" all its transitive dependencies' offsets so that none will ever be greater than the target offset of the original <literal>h = t</literal> package. In the other case, <literal>h + 1</literal> 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.
249− </para>
250−
251− <para>
252− 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 <function>mapOffset</function> 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.
253− </para>
254−
255− <variablelist>
256− <title>Variables specifying dependencies</title>
257− <varlistentry xml:id="var-stdenv-depsBuildBuild">
258− <term>
259− <varname>depsBuildBuild</varname>
260− </term>
261− <listitem>
262− <para>
263− A list of dependencies whose host and target platforms are the new derivation's build platform. This means a <literal>-1</literal> host and <literal>-1</literal> target offset from the new derivation's platforms. 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 <varname>nativeBuildInputs</varname> instead. The most common use of this <literal>buildPackages.stdenv.cc</literal>, the default C compiler for this role. That example crops up more than one might think in old commonly used C libraries.
264− </para>
265− <para>
266− Since these packages are able to be run at build-time, they are always added to the <envar>PATH</envar>, 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.
267− </para>
268− </listitem>
269− </varlistentry>
270− <varlistentry xml:id="var-stdenv-nativeBuildInputs">
271− <term>
272− <varname>nativeBuildInputs</varname>
273− </term>
274− <listitem>
275− <para>
276− A list of dependencies whose host platform is the new derivation's build platform, and target platform is the new derivation's host platform. This means a <literal>-1</literal> host offset and <literal>0</literal> target offset from the new derivation's platforms. 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 <varname>depsBuildBuild</varname> or <varname>depsBuildTarget</varname>. This could be called <varname>depsBuildHost</varname> but <varname>nativeBuildInputs</varname> is used for historical continuity.
277− </para>
278− <para>
279− Since these packages are able to be run at build-time, they are added to the <envar>PATH</envar>, 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.
280− </para>
281− </listitem>
282− </varlistentry>
283− <varlistentry xml:id="var-stdenv-depsBuildTarget">
284− <term>
285− <varname>depsBuildTarget</varname>
286− </term>
287− <listitem>
288− <para>
289− A list of dependencies whose host platform is the new derivation's build platform, and target platform is the new derivation's target platform. This means a <literal>-1</literal> host offset and <literal>1</literal> target offset from the new derivation's platforms. 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.
290− </para>
291− <para>
292− 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 are not adjacent integers, it requires thinking of a bootstrapping stage <emphasis>two</emphasis> 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.
293− </para>
294− <para>
295− Since these packages are able to run at build time, they are added to the <envar>PATH</envar>, 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.
296− </para>
297− </listitem>
298− </varlistentry>
299− <varlistentry xml:id="var-stdenv-depsHostHost">
300− <term>
301− <varname>depsHostHost</varname>
302− </term>
303− <listitem>
304− <para>
305− A list of dependencies whose host and target platforms match the new derivation's host platform. This means a <literal>0</literal> host offset and <literal>0</literal> target offset from the new derivation's host platform. These are packages used at run-time to generate code also used at run-time. 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 <varname>depsBuildBuild</varname> dependency in the derivation being built over a <varname>depsHostHost</varname> on the tool doing the building for this purpose.
306− </para>
307− </listitem>
308− </varlistentry>
309− <varlistentry xml:id="var-stdenv-buildInputs">
310− <term>
311− <varname>buildInputs</varname>
312− </term>
313− <listitem>
314− <para>
315− A list of dependencies whose host platform and target platform match the new derivation's. This means a <literal>0</literal> host offset and a <literal>1</literal> target offset from the new derivation's host platform. This would be called <varname>depsHostTarget</varname> 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 <varname>depsBuildBuild</varname>.
316− </para>
317− <para>
318− These are often programs and libraries used by the new derivation at <emphasis>run</emphasis>-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.
319− </para>
320− </listitem>
321− </varlistentry>
322− <varlistentry xml:id="var-stdenv-depsTargetTarget">
323− <term>
324− <varname>depsTargetTarget</varname>
325− </term>
326− <listitem>
327− <para>
328− A list of dependencies whose host platform matches the new derivation's target platform. This means a <literal>1</literal> offset from the new derivation's platforms. 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.
329− </para>
330− </listitem>
331− </varlistentry>
332− <varlistentry xml:id="var-stdenv-depsBuildBuildPropagated">
333− <term>
334− <varname>depsBuildBuildPropagated</varname>
335− </term>
336− <listitem>
337− <para>
338− The propagated equivalent of <varname>depsBuildBuild</varname>. This perhaps never ought to be used, but it is included for consistency [see below for the others].
339− </para>
340− </listitem>
341− </varlistentry>
342− <varlistentry xml:id="var-stdenv-propagatedNativeBuildInputs">
343− <term>
344− <varname>propagatedNativeBuildInputs</varname>
345− </term>
346− <listitem>
347− <para>
348− The propagated equivalent of <varname>nativeBuildInputs</varname>. This would be called <varname>depsBuildHostPropagated</varname> but for historical continuity. For example, if package <varname>Y</varname> has <literal>propagatedNativeBuildInputs = [X]</literal>, and package <varname>Z</varname> has <literal>buildInputs = [Y]</literal>, then package <varname>Z</varname> will be built as if it included package <varname>X</varname> in its <varname>nativeBuildInputs</varname>. If instead, package <varname>Z</varname> has <literal>nativeBuildInputs = [Y]</literal>, then <varname>Z</varname> will be built as if it included <varname>X</varname> in the <varname>depsBuildBuild</varname> of package <varname>Z</varname>, because of the sum of the two <literal>-1</literal> host offsets.
349− </para>
350− </listitem>
351− </varlistentry>
352− <varlistentry xml:id="var-stdenv-depsBuildTargetPropagated">
353− <term>
354− <varname>depsBuildTargetPropagated</varname>
355− </term>
356− <listitem>
357− <para>
358− The propagated equivalent of <varname>depsBuildTarget</varname>. This is prefixed for the same reason of alerting potential users.
359− </para>
360− </listitem>
361− </varlistentry>
362− <varlistentry xml:id="var-stdenv-depsHostHostPropagated">
363− <term>
364− <varname>depsHostHostPropagated</varname>
365− </term>
366− <listitem>
367− <para>
368− The propagated equivalent of <varname>depsHostHost</varname>.
369− </para>
370− </listitem>
371− </varlistentry>
372− <varlistentry xml:id="var-stdenv-propagatedBuildInputs">
373− <term>
374− <varname>propagatedBuildInputs</varname>
375− </term>
376− <listitem>
377− <para>
378− The propagated equivalent of <varname>buildInputs</varname>. This would be called <varname>depsHostTargetPropagated</varname> but for historical continuity.
379− </para>
380− </listitem>
381− </varlistentry>
382− <varlistentry xml:id="var-stdenv-depsTargetTargetPropagated">
383− <term>
384− <varname>depsTargetTargetPropagated</varname>
385− </term>
386− <listitem>
387− <para>
388− The propagated equivalent of <varname>depsTargetTarget</varname>. This is prefixed for the same reason of alerting potential users.
389− </para>
390− </listitem>
391− </varlistentry>
392− </variablelist>
393− </section>
394− <section xml:id="ssec-stdenv-attributes">
395− <title>Attributes</title>
396−
397− <variablelist>
398− <title>Variables affecting <literal>stdenv</literal> initialisation</title>
399− <varlistentry xml:id="var-stdenv-NIX_DEBUG">
400− <term>
401− <varname>NIX_DEBUG</varname>
402− </term>
403− <listitem>
404− <para>
405− A natural number indicating how much information to log. If set to 1 or higher, <literal>stdenv</literal> will print moderate debugging information during the build. In particular, the <command>gcc</command> and <command>ld</command> wrapper scripts will print out the complete command line passed to the wrapped tools. If set to 6 or higher, the <literal>stdenv</literal> setup script will be run with <literal>set -x</literal> tracing. If set to 7 or higher, the <command>gcc</command> and <command>ld</command> wrapper scripts will also be run with <literal>set -x</literal> tracing.
406− </para>
407− </listitem>
408− </varlistentry>
409− </variablelist>
410−
411− <variablelist>
412− <title>Attributes affecting build properties</title>
413− <varlistentry xml:id="var-stdenv-enableParallelBuilding">
414− <term>
415− <varname>enableParallelBuilding</varname>
416− </term>
417− <listitem>
418− <para>
419− If set to <literal>true</literal>, <literal>stdenv</literal> will pass specific flags to <literal>make</literal> and other build tools to enable parallel building with up to <literal>build-cores</literal> workers.
420− </para>
421− <para>
422− Unless set to <literal>false</literal>, some build systems with good support for parallel building including <literal>cmake</literal>, <literal>meson</literal>, and <literal>qmake</literal> will set it to <literal>true</literal>.
423− </para>
424− </listitem>
425− </varlistentry>
426− </variablelist>
427−
428− <variablelist>
429− <title>Special variables</title>
430− <varlistentry xml:id="var-stdenv-passthru">
431− <term>
432− <varname>passthru</varname>
433− </term>
434− <listitem>
435− <para>
436− This is an attribute set which can be filled with arbitrary values. For example:
437−<programlisting>
438−passthru = {
439− foo = "bar";
440− baz = {
441− value1 = 4;
442− value2 = 5;
443− };
444−}
445−</programlisting>
446− </para>
447− <para>
448− 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. <literal>hello.baz.value1</literal>. We don't specify any usage or schema of <literal>passthru</literal> - 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.
449− </para>
450− </listitem>
451− </varlistentry>
452− <varlistentry xml:id="var-passthru-updateScript">
453− <term>
454− <varname>passthru.updateScript</varname>
455− </term>
456− <listitem>
457− <para>
458− A script to be run by <filename>maintainers/scripts/update.nix</filename> when the package is matched. It needs to be an executable file, either on the file system:
459−<programlisting>
460−passthru.updateScript = ./update.sh;
461−</programlisting>
462− or inside the expression itself:
463−<programlisting>
464−passthru.updateScript = writeScript "update-zoom-us" ''
465− #!/usr/bin/env nix-shell
466− #!nix-shell -i bash -p curl pcre common-updater-scripts
467−
468− set -eu -o pipefail
469−
470− version="$(curl -sI https://zoom.us/client/latest/zoom_x86_64.tar.xz | grep -Fi 'Location:' | pcregrep -o1 '/(([0-9]\.?)+)/')"
471− update-source-version zoom-us "$version"
472−'';
473−</programlisting>
474− The attribute can also contain a list, a script followed by arguments to be passed to it:
475−<programlisting>
476−passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ];
477−</programlisting>
478− The script will be run with <varname>UPDATE_NIX_ATTR_PATH</varname> environment variable set to the attribute path it is supposed to update.
479− <note>
480− <para>
481− 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 <command>git commit</command> or any other commands that cannot handle that.
482− </para>
483− </note>
484− </para>
485− <para>
486− For information about how to run the updates, execute <command>nix-shell maintainers/scripts/update.nix</command>.
487− </para>
488− </listitem>
489− </varlistentry>
490− </variablelist>
491− </section>
492− <section xml:id="sec-stdenv-phases">
493− <title>Phases</title>
494−
495− <para>
496− The generic builder has a number of <emphasis>phases</emphasis>. 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). Furthermore, it allows a nicer presentation of build logs in the Nix build farm.
497− </para>
498−
499− <para>
500− Each phase can be overridden in its entirety either by setting the environment variable <varname><replaceable>name</replaceable>Phase</varname> to a string containing some shell commands to be executed, or by redefining the shell function <varname><replaceable>name</replaceable>Phase</varname>. 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 <emphasis>add</emphasis> some commands to a phase, e.g. by defining <literal>postInstall</literal> or <literal>preFixup</literal>, as skipping some of the default actions may have unexpected consequences. The default script for each phase is defined in the file <filename>pkgs/stdenv/generic/setup.sh</filename>.
501− </para>
502−
503− <section xml:id="ssec-controlling-phases">
504− <title>Controlling phases</title>
505−
506− <para>
507− There are a number of variables that control what phases are executed and in what order:
508− <variablelist>
509− <title>Variables affecting phase control</title>
510− <varlistentry xml:id="var-stdenv-phases">
511− <term>
512− <varname>phases</varname>
513− </term>
514− <listitem>
515− <para>
516− 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 <literal>$prePhases unpackPhase patchPhase $preConfigurePhases configurePhase $preBuildPhases buildPhase checkPhase $preInstallPhases installPhase fixupPhase installCheckPhase $preDistPhases distPhase $postPhases</literal>.
517− </para>
518− <para>
519− Usually, if you just want to add a few phases, it’s more convenient to set one of the variables below (such as <varname>preInstallPhases</varname>), as you then don’t specify all the normal phases.
520− </para>
521− </listitem>
522− </varlistentry>
523− <varlistentry xml:id="var-stdenv-prePhases">
524− <term>
525− <varname>prePhases</varname>
526− </term>
527− <listitem>
528− <para>
529− Additional phases executed before any of the default phases.
530− </para>
531− </listitem>
532− </varlistentry>
533− <varlistentry xml:id="var-stdenv-preConfigurePhases">
534− <term>
535− <varname>preConfigurePhases</varname>
536− </term>
537− <listitem>
538− <para>
539− Additional phases executed just before the configure phase.
540− </para>
541− </listitem>
542− </varlistentry>
543− <varlistentry xml:id="var-stdenv-preBuildPhases">
544− <term>
545− <varname>preBuildPhases</varname>
546− </term>
547− <listitem>
548− <para>
549− Additional phases executed just before the build phase.
550− </para>
551− </listitem>
552− </varlistentry>
553− <varlistentry xml:id="var-stdenv-preInstallPhases">
554− <term>
555− <varname>preInstallPhases</varname>
556− </term>
557− <listitem>
558− <para>
559− Additional phases executed just before the install phase.
560− </para>
561− </listitem>
562− </varlistentry>
563− <varlistentry xml:id="var-stdenv-preFixupPhases">
564− <term>
565− <varname>preFixupPhases</varname>
566− </term>
567− <listitem>
568− <para>
569− Additional phases executed just before the fixup phase.
570− </para>
571− </listitem>
572− </varlistentry>
573− <varlistentry xml:id="var-stdenv-preDistPhases">
574− <term>
575− <varname>preDistPhases</varname>
576− </term>
577− <listitem>
578− <para>
579− Additional phases executed just before the distribution phase.
580− </para>
581− </listitem>
582− </varlistentry>
583− <varlistentry xml:id="var-stdenv-postPhases">
584− <term>
585− <varname>postPhases</varname>
586− </term>
587− <listitem>
588− <para>
589− Additional phases executed after any of the default phases.
590− </para>
591− </listitem>
592− </varlistentry>
593− </variablelist>
594− </para>
595− </section>
596−
597− <section xml:id="ssec-unpack-phase">
598− <title>The unpack phase</title>
599−
600− <para>
601− The unpack phase is responsible for unpacking the source code of the package. The default implementation of <function>unpackPhase</function> unpacks the source files listed in the <envar>src</envar> environment variable to the current directory. It supports the following files by default:
602− <variablelist>
603− <varlistentry>
604− <term>
605− Tar files
606− </term>
607− <listitem>
608− <para>
609− These can optionally be compressed using <command>gzip</command> (<filename>.tar.gz</filename>, <filename>.tgz</filename> or <filename>.tar.Z</filename>), <command>bzip2</command> (<filename>.tar.bz2</filename>, <filename>.tbz2</filename> or <filename>.tbz</filename>) or <command>xz</command> (<filename>.tar.xz</filename>, <filename>.tar.lzma</filename> or <filename>.txz</filename>).
610− </para>
611− </listitem>
612− </varlistentry>
613− <varlistentry>
614− <term>
615− Zip files
616− </term>
617− <listitem>
618− <para>
619− Zip files are unpacked using <command>unzip</command>. However, <command>unzip</command> is not in the standard environment, so you should add it to <varname>nativeBuildInputs</varname> yourself.
620− </para>
621− </listitem>
622− </varlistentry>
623− <varlistentry>
624− <term>
625− Directories in the Nix store
626− </term>
627− <listitem>
628− <para>
629− These are simply copied to the current directory. The hash part of the file name is stripped, e.g. <filename>/nix/store/1wydxgby13cz...-my-sources</filename> would be copied to <filename>my-sources</filename>.
630− </para>
631− </listitem>
632− </varlistentry>
633− </variablelist>
634− Additional file types can be supported by setting the <varname>unpackCmd</varname> variable (see below).
635− </para>
636−
637− <para></para>
638−
639− <variablelist>
640− <title>Variables controlling the unpack phase</title>
641− <varlistentry xml:id="var-stdenv-src">
642− <term>
643− <varname>srcs</varname> / <varname>src</varname>
644− </term>
645− <listitem>
646− <para>
647− The list of source files or directories to be unpacked or copied. One of these must be set.
648− </para>
649− </listitem>
650− </varlistentry>
651− <varlistentry xml:id="var-stdenv-sourceRoot">
652− <term>
653− <varname>sourceRoot</varname>
654− </term>
655− <listitem>
656− <para>
657− After running <function>unpackPhase</function>, the generic builder changes the current directory to the directory created by unpacking the sources. If there are multiple source directories, you should set <varname>sourceRoot</varname> to the name of the intended directory.
658− </para>
659− </listitem>
660− </varlistentry>
661− <varlistentry xml:id="var-stdenv-setSourceRoot">
662− <term>
663− <varname>setSourceRoot</varname>
664− </term>
665− <listitem>
666− <para>
667− Alternatively to setting <varname>sourceRoot</varname>, you can set <varname>setSourceRoot</varname> to a shell command to be evaluated by the unpack phase after the sources have been unpacked. This command must set <varname>sourceRoot</varname>.
668− </para>
669− </listitem>
670− </varlistentry>
671− <varlistentry xml:id="var-stdenv-preUnpack">
672− <term>
673− <varname>preUnpack</varname>
674− </term>
675− <listitem>
676− <para>
677− Hook executed at the start of the unpack phase.
678− </para>
679− </listitem>
680− </varlistentry>
681− <varlistentry xml:id="var-stdenv-postUnpack">
682− <term>
683− <varname>postUnpack</varname>
684− </term>
685− <listitem>
686− <para>
687− Hook executed at the end of the unpack phase.
688− </para>
689− </listitem>
690− </varlistentry>
691− <varlistentry xml:id="var-stdenv-dontUnpack">
692− <term>
693− <varname>dontUnpack</varname>
694− </term>
695− <listitem>
696− <para>
697− Set to true to skip the unpack phase.
698− </para>
699− </listitem>
700− </varlistentry>
701− <varlistentry xml:id="var-stdenv-dontMakeSourcesWritable">
702− <term>
703− <varname>dontMakeSourcesWritable</varname>
704− </term>
705− <listitem>
706− <para>
707− If set to <literal>1</literal>, the unpacked sources are <emphasis>not</emphasis> 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.
708− </para>
709− </listitem>
710− </varlistentry>
711− <varlistentry xml:id="var-stdenv-unpackCmd">
712− <term>
713− <varname>unpackCmd</varname>
714− </term>
715− <listitem>
716− <para>
717− The unpack phase evaluates the string <literal>$unpackCmd</literal> for any unrecognised file. The path to the current source file is contained in the <varname>curSrc</varname> variable.
718− </para>
719− </listitem>
720− </varlistentry>
721− </variablelist>
722− </section>
723−
724− <section xml:id="ssec-patch-phase">
725− <title>The patch phase</title>
726−
727− <para>
728− The patch phase applies the list of patches defined in the <varname>patches</varname> variable.
729− </para>
730−
731− <variablelist>
732− <title>Variables controlling the patch phase</title>
733− <varlistentry xml:id="var-stdenv-dontPatch">
734− <term>
735− <varname>dontPatch</varname>
736− </term>
737− <listitem>
738− <para>
739− Set to true to skip the patch phase.
740− </para>
741− </listitem>
742− </varlistentry>
743− <varlistentry xml:id="var-stdenv-patches">
744− <term>
745− <varname>patches</varname>
746− </term>
747− <listitem>
748− <para>
749− The list of patches. They must be in the format accepted by the <command>patch</command> command, and may optionally be compressed using <command>gzip</command> (<filename>.gz</filename>), <command>bzip2</command> (<filename>.bz2</filename>) or <command>xz</command> (<filename>.xz</filename>).
750− </para>
751− </listitem>
752− </varlistentry>
753− <varlistentry xml:id="var-stdenv-patchFlags">
754− <term>
755− <varname>patchFlags</varname>
756− </term>
757− <listitem>
758− <para>
759− Flags to be passed to <command>patch</command>. If not set, the argument <option>-p1</option> is used, which causes the leading directory component to be stripped from the file names in each patch.
760− </para>
761− </listitem>
762− </varlistentry>
763− <varlistentry xml:id="var-stdenv-prePatch">
764− <term>
765− <varname>prePatch</varname>
766− </term>
767− <listitem>
768− <para>
769− Hook executed at the start of the patch phase.
770− </para>
771− </listitem>
772− </varlistentry>
773− <varlistentry xml:id="var-stdenv-postPatch">
774− <term>
775− <varname>postPatch</varname>
776− </term>
777− <listitem>
778− <para>
779− Hook executed at the end of the patch phase.
780− </para>
781− </listitem>
782− </varlistentry>
783− </variablelist>
784− </section>
785−
786− <section xml:id="ssec-configure-phase">
787− <title>The configure phase</title>
788−
789− <para>
790− The configure phase prepares the source tree for building. The default <function>configurePhase</function> runs <filename>./configure</filename> (typically an Autoconf-generated script) if it exists.
791− </para>
792−
793− <variablelist>
794− <title>Variables controlling the configure phase</title>
795− <varlistentry xml:id="var-stdenv-configureScript">
796− <term>
797− <varname>configureScript</varname>
798− </term>
799− <listitem>
800− <para>
801− The name of the configure script. It defaults to <filename>./configure</filename> if it exists; otherwise, the configure phase is skipped. This can actually be a command (like <literal>perl ./Configure.pl</literal>).
802− </para>
803− </listitem>
804− </varlistentry>
805− <varlistentry xml:id="var-stdenv-configureFlags">
806− <term>
807− <varname>configureFlags</varname>
808− </term>
809− <listitem>
810− <para>
811− A list of strings passed as additional arguments to the configure script.
812− </para>
813− </listitem>
814− </varlistentry>
815− <varlistentry xml:id="var-stdenv-dontConfigure">
816− <term>
817− <varname>dontConfigure</varname>
818− </term>
819− <listitem>
820− <para>
821− Set to true to skip the configure phase.
822− </para>
823− </listitem>
824− </varlistentry>
825− <varlistentry xml:id="var-stdenv-configureFlagsArray">
826− <term>
827− <varname>configureFlagsArray</varname>
828− </term>
829− <listitem>
830− <para>
831− A shell array containing additional arguments passed to the configure script. You must use this instead of <varname>configureFlags</varname> if the arguments contain spaces.
832− </para>
833− </listitem>
834− </varlistentry>
835− <varlistentry xml:id="var-stdenv-dontAddPrefix">
836− <term>
837− <varname>dontAddPrefix</varname>
838− </term>
839− <listitem>
840− <para>
841− By default, the flag <literal>--prefix=$prefix</literal> is added to the configure flags. If this is undesirable, set this variable to true.
842− </para>
843− </listitem>
844− </varlistentry>
845− <varlistentry xml:id="var-stdenv-prefix">
846− <term>
847− <varname>prefix</varname>
848− </term>
849− <listitem>
850− <para>
851− The prefix under which the package must be installed, passed via the <option>--prefix</option> option to the configure script. It defaults to <option>$out</option>.
852− </para>
853− </listitem>
854− </varlistentry>
855− <varlistentry xml:id="var-stdenv-prefixKey">
856− <term>
857− <varname>prefixKey</varname>
858− </term>
859− <listitem>
860− <para>
861− The key to use when specifying the prefix. By default, this is set to <option>--prefix=</option> as that is used by the majority of packages.
862− </para>
863− </listitem>
864− </varlistentry>
865− <varlistentry xml:id="var-stdenv-dontAddDisableDepTrack">
866− <term>
867− <varname>dontAddDisableDepTrack</varname>
868− </term>
869− <listitem>
870− <para>
871− By default, the flag <literal>--disable-dependency-tracking</literal> is added to the configure flags to speed up Automake-based builds. If this is undesirable, set this variable to true.
872− </para>
873− </listitem>
874− </varlistentry>
875− <varlistentry xml:id="var-stdenv-dontFixLibtool">
876− <term>
877− <varname>dontFixLibtool</varname>
878− </term>
879− <listitem>
880− <para>
881− By default, the configure phase applies some special hackery to all files called <filename>ltmain.sh</filename> before running the configure script in order to improve the purity of Libtool-based packages
882− <footnote xml:id="footnote-stdenv-sys-lib-search-path">
883− <para>
884− It clears the <varname>sys_lib_<replaceable>*</replaceable>search_path</varname> variables in the Libtool script to prevent Libtool from using libraries in <filename>/usr/lib</filename> and such.
885− </para>
886− </footnote>
887− . If this is undesirable, set this variable to true.
888− </para>
889− </listitem>
890− </varlistentry>
891− <varlistentry xml:id="var-stdenv-dontDisableStatic">
892− <term>
893− <varname>dontDisableStatic</varname>
894− </term>
895− <listitem>
896− <para>
897− By default, when the configure script has <option>--enable-static</option>, the option <option>--disable-static</option> is added to the configure flags.
898− </para>
899− <para>
900− If this is undesirable, set this variable to true.
901− </para>
902− </listitem>
903− </varlistentry>
904− <varlistentry xml:id="var-stdenv-configurePlatforms">
905− <term>
906− <varname>configurePlatforms</varname>
907− </term>
908− <listitem>
909− <para>
910− By default, when cross compiling, the configure script has <option>--build=...</option> and <option>--host=...</option> passed. Packages can instead pass <literal>[ "build" "host" "target" ]</literal> or a subset to control exactly which platform flags are passed. Compilers and other tools can use this to also pass the target platform.
911− <footnote xml:id="footnote-stdenv-build-time-guessing-impurity">
912− <para>
913− Eventually these will be passed building natively as well, to improve determinism: build-time guessing, as is done today, is a risk of impurity.
914− </para>
915− </footnote>
916− </para>
917− </listitem>
918− </varlistentry>
919− <varlistentry xml:id="var-stdenv-preConfigure">
920− <term>
921− <varname>preConfigure</varname>
922− </term>
923− <listitem>
924− <para>
925− Hook executed at the start of the configure phase.
926− </para>
927− </listitem>
928− </varlistentry>
929− <varlistentry xml:id="var-stdenv-postConfigure">
930− <term>
931− <varname>postConfigure</varname>
932− </term>
933− <listitem>
934− <para>
935− Hook executed at the end of the configure phase.
936− </para>
937− </listitem>
938− </varlistentry>
939− </variablelist>
940− </section>
941−
942− <section xml:id="build-phase">
943− <title>The build phase</title>
944−
945− <para>
946− The build phase is responsible for actually building the package (e.g. compiling it). The default <function>buildPhase</function> simply calls <command>make</command> if a file named <filename>Makefile</filename>, <filename>makefile</filename> or <filename>GNUmakefile</filename> exists in the current directory (or the <varname>makefile</varname> is explicitly set); otherwise it does nothing.
947− </para>
948−
949− <variablelist>
950− <title>Variables controlling the build phase</title>
951− <varlistentry xml:id="var-stdenv-dontBuild">
952− <term>
953− <varname>dontBuild</varname>
954− </term>
955− <listitem>
956− <para>
957− Set to true to skip the build phase.
958− </para>
959− </listitem>
960− </varlistentry>
961− <varlistentry xml:id="var-stdenv-makefile">
962− <term>
963− <varname>makefile</varname>
964− </term>
965− <listitem>
966− <para>
967− The file name of the Makefile.
968− </para>
969− </listitem>
970− </varlistentry>
971− <varlistentry xml:id="var-stdenv-makeFlags">
972− <term>
973− <varname>makeFlags</varname>
974− </term>
975− <listitem>
976− <para>
977− A list of strings passed as additional flags to <command>make</command>. These flags are also used by the default install and check phase. For setting make flags specific to the build phase, use <varname>buildFlags</varname> (see below).
978−<programlisting>
979−makeFlags = [ "PREFIX=$(out)" ];
980−</programlisting>
981− <note>
982− <para>
983− The flags are quoted in bash, but environment variables can be specified by using the make syntax.
984− </para>
985− </note>
986− </para>
987− </listitem>
988− </varlistentry>
989− <varlistentry xml:id="var-stdenv-makeFlagsArray">
990− <term>
991− <varname>makeFlagsArray</varname>
992− </term>
993− <listitem>
994− <para>
995− A shell array containing additional arguments passed to <command>make</command>. You must use this instead of <varname>makeFlags</varname> if the arguments contain spaces, e.g.
996−<programlisting>
997−preBuild = ''
998− makeFlagsArray+=(CFLAGS="-O0 -g" LDFLAGS="-lfoo -lbar")
999−'';
1000−</programlisting>
1001− Note that shell arrays cannot be passed through environment variables, so you cannot set <varname>makeFlagsArray</varname> in a derivation attribute (because those are passed through environment variables): you have to define them in shell code.
1002− </para>
1003− </listitem>
1004− </varlistentry>
1005− <varlistentry xml:id="var-stdenv-buildFlags">
1006− <term>
1007− <varname>buildFlags</varname> / <varname>buildFlagsArray</varname>
1008− </term>
1009− <listitem>
1010− <para>
1011− A list of strings passed as additional flags to <command>make</command>. Like <varname>makeFlags</varname> and <varname>makeFlagsArray</varname>, but only used by the build phase.
1012− </para>
1013− </listitem>
1014− </varlistentry>
1015− <varlistentry xml:id="var-stdenv-preBuild">
1016− <term>
1017− <varname>preBuild</varname>
1018− </term>
1019− <listitem>
1020− <para>
1021− Hook executed at the start of the build phase.
1022− </para>
1023− </listitem>
1024− </varlistentry>
1025− <varlistentry xml:id="var-stdenv-postBuild">
1026− <term>
1027− <varname>postBuild</varname>
1028− </term>
1029− <listitem>
1030− <para>
1031− Hook executed at the end of the build phase.
1032− </para>
1033− </listitem>
1034− </varlistentry>
1035− </variablelist>
1036−
1037− <para>
1038− You can set flags for <command>make</command> through the <varname>makeFlags</varname> variable.
1039− </para>
1040−
1041− <para>
1042− Before and after running <command>make</command>, the hooks <varname>preBuild</varname> and <varname>postBuild</varname> are called, respectively.
1043− </para>
1044− </section>
1045−
1046− <section xml:id="ssec-check-phase">
1047− <title>The check phase</title>
1048−
1049− <para>
1050− The check phase checks whether the package was built correctly by running its test suite. The default <function>checkPhase</function> calls <command>make check</command>, but only if the <varname>doCheck</varname> variable is enabled.
1051− </para>
1052−
1053− <variablelist>
1054− <title>Variables controlling the check phase</title>
1055− <varlistentry xml:id="var-stdenv-doCheck">
1056− <term>
1057− <varname>doCheck</varname>
1058− </term>
1059− <listitem>
1060− <para>
1061− Controls whether the check phase is executed. By default it is skipped, but if <varname>doCheck</varname> is set to true, the check phase is usually executed. Thus you should set
1062−<programlisting>doCheck = true;</programlisting>
1063− in the derivation to enable checks. The exception is cross compilation. Cross compiled builds never run tests, no matter how <varname>doCheck</varname> is set, as the newly-built program won't run on the platform used to build it.
1064− </para>
1065− </listitem>
1066− </varlistentry>
1067− <varlistentry>
1068− <term>
1069− <varname>makeFlags</varname> / <varname>makeFlagsArray</varname> / <varname>makefile</varname>
1070− </term>
1071− <listitem>
1072− <para>
1073− See the <link xlink:href="#var-stdenv-makeFlags">build phase</link> for details.
1074− </para>
1075− </listitem>
1076− </varlistentry>
1077− <varlistentry xml:id="var-stdenv-checkTarget">
1078− <term>
1079− <varname>checkTarget</varname>
1080− </term>
1081− <listitem>
1082− <para>
1083− The make target that runs the tests. Defaults to <literal>check</literal>.
1084− </para>
1085− </listitem>
1086− </varlistentry>
1087− <varlistentry xml:id="var-stdenv-checkFlags">
1088− <term>
1089− <varname>checkFlags</varname> / <varname>checkFlagsArray</varname>
1090− </term>
1091− <listitem>
1092− <para>
1093− A list of strings passed as additional flags to <command>make</command>. Like <varname>makeFlags</varname> and <varname>makeFlagsArray</varname>, but only used by the check phase.
1094− </para>
1095− </listitem>
1096− </varlistentry>
1097− <varlistentry xml:id="var-stdenv-checkInputs">
1098− <term>
1099− <varname>checkInputs</varname>
1100− </term>
1101− <listitem>
1102− <para>
1103− A list of dependencies used by the phase. This gets included in <varname>nativeBuildInputs</varname> when <varname>doCheck</varname> is set.
1104− </para>
1105− </listitem>
1106− </varlistentry>
1107− <varlistentry xml:id="var-stdenv-preCheck">
1108− <term>
1109− <varname>preCheck</varname>
1110− </term>
1111− <listitem>
1112− <para>
1113− Hook executed at the start of the check phase.
1114− </para>
1115− </listitem>
1116− </varlistentry>
1117− <varlistentry xml:id="var-stdenv-postCheck">
1118− <term>
1119− <varname>postCheck</varname>
1120− </term>
1121− <listitem>
1122− <para>
1123− Hook executed at the end of the check phase.
1124− </para>
1125− </listitem>
1126− </varlistentry>
1127− </variablelist>
1128− </section>
1129−
1130− <section xml:id="ssec-install-phase">
1131− <title>The install phase</title>
1132−
1133− <para>
1134− The install phase is responsible for installing the package in the Nix store under <envar>out</envar>. The default <function>installPhase</function> creates the directory <literal>$out</literal> and calls <command>make install</command>.
1135− </para>
1136−
1137− <variablelist>
1138− <title>Variables controlling the install phase</title>
1139− <varlistentry xml:id="var-stdenv-dontInstall">
1140− <term>
1141− <varname>dontInstall</varname>
1142− </term>
1143− <listitem>
1144− <para>
1145− Set to true to skip the install phase.
1146− </para>
1147− </listitem>
1148− </varlistentry>
1149− <varlistentry>
1150− <term>
1151− <varname>makeFlags</varname> / <varname>makeFlagsArray</varname> / <varname>makefile</varname>
1152− </term>
1153− <listitem>
1154− <para>
1155− See the <link xlink:href="#var-stdenv-makeFlags">build phase</link> for details.
1156− </para>
1157− </listitem>
1158− </varlistentry>
1159− <varlistentry xml:id="var-stdenv-installTargets">
1160− <term>
1161− <varname>installTargets</varname>
1162− </term>
1163− <listitem>
1164− <para>
1165− The make targets that perform the installation. Defaults to <literal>install</literal>. Example:
1166−<programlisting>
1167−installTargets = "install-bin install-doc";</programlisting>
1168− </para>
1169− </listitem>
1170− </varlistentry>
1171− <varlistentry xml:id="var-stdenv-installFlags">
1172− <term>
1173− <varname>installFlags</varname> / <varname>installFlagsArray</varname>
1174− </term>
1175− <listitem>
1176− <para>
1177− A list of strings passed as additional flags to <command>make</command>. Like <varname>makeFlags</varname> and <varname>makeFlagsArray</varname>, but only used by the install phase.
1178− </para>
1179− </listitem>
1180− </varlistentry>
1181− <varlistentry xml:id="var-stdenv-preInstall">
1182− <term>
1183− <varname>preInstall</varname>
1184− </term>
1185− <listitem>
1186− <para>
1187− Hook executed at the start of the install phase.
1188− </para>
1189− </listitem>
1190− </varlistentry>
1191− <varlistentry xml:id="var-stdenv-postInstall">
1192− <term>
1193− <varname>postInstall</varname>
1194− </term>
1195− <listitem>
1196− <para>
1197− Hook executed at the end of the install phase.
1198− </para>
1199− </listitem>
1200− </varlistentry>
1201− </variablelist>
1202− </section>
1203−
1204− <section xml:id="ssec-fixup-phase">
1205− <title>The fixup phase</title>
1206−
1207− <para>
1208− The fixup phase performs some (Nix-specific) post-processing actions on the files installed under <filename>$out</filename> by the install phase. The default <function>fixupPhase</function> does the following:
1209− <itemizedlist>
1210− <listitem>
1211− <para>
1212− It moves the <filename>man/</filename>, <filename>doc/</filename> and <filename>info/</filename> subdirectories of <envar>$out</envar> to <filename>share/</filename>.
1213− </para>
1214− </listitem>
1215− <listitem>
1216− <para>
1217− It strips libraries and executables of debug information.
1218− </para>
1219− </listitem>
1220− <listitem>
1221− <para>
1222− On Linux, it applies the <command>patchelf</command> command to ELF executables and libraries to remove unused directories from the <literal>RPATH</literal> in order to prevent unnecessary runtime dependencies.
1223− </para>
1224− </listitem>
1225− <listitem>
1226− <para>
1227− It rewrites the interpreter paths of shell scripts to paths found in <envar>PATH</envar>. E.g., <filename>/usr/bin/perl</filename> will be rewritten to <filename>/nix/store/<replaceable>some-perl</replaceable>/bin/perl</filename> found in <envar>PATH</envar>.
1228− </para>
1229− </listitem>
1230− </itemizedlist>
1231− </para>
1232−
1233− <variablelist>
1234− <title>Variables controlling the fixup phase</title>
1235− <varlistentry xml:id="var-stdenv-dontFixup">
1236− <term>
1237− <varname>dontFixup</varname>
1238− </term>
1239− <listitem>
1240− <para>
1241− Set to true to skip the fixup phase.
1242− </para>
1243− </listitem>
1244− </varlistentry>
1245− <varlistentry xml:id="var-stdenv-dontStrip">
1246− <term>
1247− <varname>dontStrip</varname>
1248− </term>
1249− <listitem>
1250− <para>
1251− If set, libraries and executables are not stripped. By default, they are.
1252− </para>
1253− </listitem>
1254− </varlistentry>
1255− <varlistentry xml:id="var-stdenv-dontStripHost">
1256− <term>
1257− <varname>dontStripHost</varname>
1258− </term>
1259− <listitem>
1260− <para>
1261− Like <varname>dontStrip</varname>, but only affects the <command>strip</command> command targetting the package's host platform. Useful when supporting cross compilation, but otherwise feel free to ignore.
1262− </para>
1263− </listitem>
1264− </varlistentry>
1265− <varlistentry xml:id="var-stdenv-dontStripTarget">
1266− <term>
1267− <varname>dontStripTarget</varname>
1268− </term>
1269− <listitem>
1270− <para>
1271− Like <varname>dontStrip</varname>, but only affects the <command>strip</command> command targetting the packages' target platform. Useful when supporting cross compilation, but otherwise feel free to ignore.
1272− </para>
1273− </listitem>
1274− </varlistentry>
1275− <varlistentry xml:id="var-stdenv-dontMoveSbin">
1276− <term>
1277− <varname>dontMoveSbin</varname>
1278− </term>
1279− <listitem>
1280− <para>
1281− If set, files in <filename>$out/sbin</filename> are not moved to <filename>$out/bin</filename>. By default, they are.
1282− </para>
1283− </listitem>
1284− </varlistentry>
1285− <varlistentry xml:id="var-stdenv-stripAllList">
1286− <term>
1287− <varname>stripAllList</varname>
1288− </term>
1289− <listitem>
1290− <para>
1291− List of directories to search for libraries and executables from which <emphasis>all</emphasis> 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.
1292− </para>
1293− </listitem>
1294− </varlistentry>
1295− <varlistentry xml:id="var-stdenv-stripAllFlags">
1296− <term>
1297− <varname>stripAllFlags</varname>
1298− </term>
1299− <listitem>
1300− <para>
1301− Flags passed to the <command>strip</command> command applied to the files in the directories listed in <varname>stripAllList</varname>. Defaults to <option>-s</option> (i.e. <option>--strip-all</option>).
1302− </para>
1303− </listitem>
1304− </varlistentry>
1305− <varlistentry xml:id="var-stdenv-stripDebugList">
1306− <term>
1307− <varname>stripDebugList</varname>
1308− </term>
1309− <listitem>
1310− <para>
1311− List of directories to search for libraries and executables from which only debugging-related symbols should be stripped. It defaults to <literal>lib lib32 lib64 libexec bin sbin</literal>.
1312− </para>
1313− </listitem>
1314− </varlistentry>
1315− <varlistentry xml:id="var-stdenv-stripDebugFlags">
1316− <term>
1317− <varname>stripDebugFlags</varname>
1318− </term>
1319− <listitem>
1320− <para>
1321− Flags passed to the <command>strip</command> command applied to the files in the directories listed in <varname>stripDebugList</varname>. Defaults to <option>-S</option> (i.e. <option>--strip-debug</option>).
1322− </para>
1323− </listitem>
1324− </varlistentry>
1325− <varlistentry xml:id="var-stdenv-dontPatchELF">
1326− <term>
1327− <varname>dontPatchELF</varname>
1328− </term>
1329− <listitem>
1330− <para>
1331− If set, the <command>patchelf</command> command is not used to remove unnecessary <literal>RPATH</literal> entries. Only applies to Linux.
1332− </para>
1333− </listitem>
1334− </varlistentry>
1335− <varlistentry xml:id="var-stdenv-dontPatchShebangs">
1336− <term>
1337− <varname>dontPatchShebangs</varname>
1338− </term>
1339− <listitem>
1340− <para>
1341− If set, scripts starting with <literal>#!</literal> do not have their interpreter paths rewritten to paths in the Nix store.
1342− </para>
1343− </listitem>
1344− </varlistentry>
1345− <varlistentry xml:id="var-stdenv-dontPruneLibtoolFiles">
1346− <term>
1347− <varname>dontPruneLibtoolFiles</varname>
1348− </term>
1349− <listitem>
1350− <para>
1351− If set, libtool <literal>.la</literal> files associated with shared libraries won't have their <literal>dependency_libs</literal> field cleared.
1352− </para>
1353− </listitem>
1354− </varlistentry>
1355− <varlistentry xml:id="var-stdenv-forceShare">
1356− <term>
1357− <varname>forceShare</varname>
1358− </term>
1359− <listitem>
1360− <para>
1361− The list of directories that must be moved from <filename>$out</filename> to <filename>$out/share</filename>. Defaults to <literal>man doc info</literal>.
1362− </para>
1363− </listitem>
1364− </varlistentry>
1365− <varlistentry xml:id="var-stdenv-setupHook">
1366− <term>
1367− <varname>setupHook</varname>
1368− </term>
1369− <listitem>
1370− <para>
1371− A package can export a <link linkend="ssec-setup-hooks">setup hook</link> by setting this variable. The setup hook, if defined, is copied to <filename>$out/nix-support/setup-hook</filename>. Environment variables are then substituted in it using <function
1372− linkend="fun-substituteAll">substituteAll</function>.
1373− </para>
1374− </listitem>
1375− </varlistentry>
1376− <varlistentry xml:id="var-stdenv-preFixup">
1377− <term>
1378− <varname>preFixup</varname>
1379− </term>
1380− <listitem>
1381− <para>
1382− Hook executed at the start of the fixup phase.
1383− </para>
1384− </listitem>
1385− </varlistentry>
1386− <varlistentry xml:id="var-stdenv-postFixup">
1387− <term>
1388− <varname>postFixup</varname>
1389− </term>
1390− <listitem>
1391− <para>
1392− Hook executed at the end of the fixup phase.
1393− </para>
1394− </listitem>
1395− </varlistentry>
1396− <varlistentry xml:id="stdenv-separateDebugInfo">
1397− <term>
1398− <varname>separateDebugInfo</varname>
1399− </term>
1400− <listitem>
1401− <para>
1402− If set to <literal>true</literal>, 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 <literal>debug</literal>. (This output is enabled automatically; you don’t need to set the <varname>outputs</varname> attribute explicitly.) To be precise, the debug information is stored in <filename><replaceable>debug</replaceable>/lib/debug/.build-id/<replaceable>XX</replaceable>/<replaceable>YYYY…</replaceable></filename>, where <replaceable>XXYYYY…</replaceable> is the <replaceable>build ID</replaceable> 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.
1403− </para>
1404− <para>
1405− For example, with GDB, you can add
1406−<programlisting>
1407−set debug-file-directory ~/.nix-profile/lib/debug
1408−</programlisting>
1409− to <filename>~/.gdbinit</filename>. GDB will then be able to find debug information installed via <literal>nix-env -i</literal>.
1410− </para>
1411− </listitem>
1412− </varlistentry>
1413− </variablelist>
1414− </section>
1415−
1416− <section xml:id="ssec-installCheck-phase">
1417− <title>The installCheck phase</title>
1418−
1419− <para>
1420− The installCheck phase checks whether the package was installed correctly by running its test suite against the installed directories. The default <function>installCheck</function> calls <command>make installcheck</command>.
1421− </para>
1422−
1423− <variablelist>
1424− <title>Variables controlling the installCheck phase</title>
1425− <varlistentry xml:id="var-stdenv-doInstallCheck">
1426− <term>
1427− <varname>doInstallCheck</varname>
1428− </term>
1429− <listitem>
1430− <para>
1431− Controls whether the installCheck phase is executed. By default it is skipped, but if <varname>doInstallCheck</varname> is set to true, the installCheck phase is usually executed. Thus you should set
1432−<programlisting>doInstallCheck = true;</programlisting>
1433− in the derivation to enable install checks. The exception is cross compilation. Cross compiled builds never run tests, no matter how <varname>doInstallCheck</varname> is set, as the newly-built program won't run on the platform used to build it.
1434− </para>
1435− </listitem>
1436− </varlistentry>
1437− <varlistentry xml:id="var-stdenv-installCheckTarget">
1438− <term>
1439− <varname>installCheckTarget</varname>
1440− </term>
1441− <listitem>
1442− <para>
1443− The make target that runs the install tests. Defaults to <literal>installcheck</literal>.
1444− </para>
1445− </listitem>
1446− </varlistentry>
1447− <varlistentry xml:id="var-stdenv-installCheckFlags">
1448− <term>
1449− <varname>installCheckFlags</varname> / <varname>installCheckFlagsArray</varname>
1450− </term>
1451− <listitem>
1452− <para>
1453− A list of strings passed as additional flags to <command>make</command>. Like <varname>makeFlags</varname> and <varname>makeFlagsArray</varname>, but only used by the installCheck phase.
1454− </para>
1455− </listitem>
1456− </varlistentry>
1457− <varlistentry xml:id="var-stdenv-installCheckInputs">
1458− <term>
1459− <varname>installCheckInputs</varname>
1460− </term>
1461− <listitem>
1462− <para>
1463− A list of dependencies used by the phase. This gets included in <varname>nativeBuildInputs</varname> when <varname>doInstallCheck</varname> is set.
1464− </para>
1465− </listitem>
1466− </varlistentry>
1467− <varlistentry xml:id="var-stdenv-preInstallCheck">
1468− <term>
1469− <varname>preInstallCheck</varname>
1470− </term>
1471− <listitem>
1472− <para>
1473− Hook executed at the start of the installCheck phase.
1474− </para>
1475− </listitem>
1476− </varlistentry>
1477− <varlistentry xml:id="var-stdenv-postInstallCheck">
1478− <term>
1479− <varname>postInstallCheck</varname>
1480− </term>
1481− <listitem>
1482− <para>
1483− Hook executed at the end of the installCheck phase.
1484− </para>
1485− </listitem>
1486− </varlistentry>
1487− </variablelist>
1488− </section>
1489−
1490− <section xml:id="ssec-distribution-phase">
1491− <title>The distribution phase</title>
1492−
1493− <para>
1494− The distribution phase is intended to produce a source distribution of the package. The default <function>distPhase</function> first calls <command>make dist</command>, then it copies the resulting source tarballs to <filename>$out/tarballs/</filename>. This phase is only executed if the attribute <varname>doDist</varname> is set.
1495− </para>
1496−
1497− <variablelist>
1498− <title>Variables controlling the distribution phase</title>
1499− <varlistentry xml:id="var-stdenv-distTarget">
1500− <term>
1501− <varname>distTarget</varname>
1502− </term>
1503− <listitem>
1504− <para>
1505− The make target that produces the distribution. Defaults to <literal>dist</literal>.
1506− </para>
1507− </listitem>
1508− </varlistentry>
1509− <varlistentry xml:id="var-stdenv-distFlags">
1510− <term>
1511− <varname>distFlags</varname> / <varname>distFlagsArray</varname>
1512− </term>
1513− <listitem>
1514− <para>
1515− Additional flags passed to <command>make</command>.
1516− </para>
1517− </listitem>
1518− </varlistentry>
1519− <varlistentry xml:id="var-stdenv-tarballs">
1520− <term>
1521− <varname>tarballs</varname>
1522− </term>
1523− <listitem>
1524− <para>
1525− The names of the source distribution files to be copied to <filename>$out/tarballs/</filename>. It can contain shell wildcards. The default is <filename>*.tar.gz</filename>.
1526− </para>
1527− </listitem>
1528− </varlistentry>
1529− <varlistentry xml:id="var-stdenv-dontCopyDist">
1530− <term>
1531− <varname>dontCopyDist</varname>
1532− </term>
1533− <listitem>
1534− <para>
1535− If set, no files are copied to <filename>$out/tarballs/</filename>.
1536− </para>
1537− </listitem>
1538− </varlistentry>
1539− <varlistentry xml:id="var-stdenv-preDist">
1540− <term>
1541− <varname>preDist</varname>
1542− </term>
1543− <listitem>
1544− <para>
1545− Hook executed at the start of the distribution phase.
1546− </para>
1547− </listitem>
1548− </varlistentry>
1549− <varlistentry xml:id="var-stdenv-postDist">
1550− <term>
1551− <varname>postDist</varname>
1552− </term>
1553− <listitem>
1554− <para>
1555− Hook executed at the end of the distribution phase.
1556− </para>
1557− </listitem>
1558− </varlistentry>
1559− </variablelist>
1560− </section>
1561− </section>
1562− <section xml:id="ssec-stdenv-functions">
1563− <title>Shell functions</title>
1564−
1565− <para>
1566− The standard environment provides a number of useful functions.
1567− </para>
1568−
1569− <variablelist>
1570− <varlistentry xml:id='fun-makeWrapper'>
1571− <term>
1572− <function>makeWrapper</function> <replaceable>executable</replaceable> <replaceable>wrapperfile</replaceable> <replaceable>args</replaceable>
1573− </term>
1574− <listitem>
1575− <para>
1576− Constructs a wrapper for a program with various possible arguments. For example:
1577−<programlisting>
1578−# adds `FOOBAR=baz` to `$out/bin/foo`’s environment
1579−makeWrapper $out/bin/foo $wrapperfile --set FOOBAR baz
1580−
1581−# prefixes the binary paths of `hello` and `git`
1582−# Be advised that paths often should be patched in directly
1583−# (via string replacements or in `configurePhase`).
1584−makeWrapper $out/bin/foo $wrapperfile --prefix PATH : ${lib.makeBinPath [ hello git ]}
1585−</programlisting>
1586− There’s many more kinds of arguments, they are documented in <literal>nixpkgs/pkgs/build-support/setup-hooks/make-wrapper.sh</literal>.
1587− </para>
1588− <para>
1589− <literal>wrapProgram</literal> is a convenience function you probably want to use most of the time.
1590− </para>
1591− </listitem>
1592− </varlistentry>
1593− <varlistentry xml:id='fun-substitute'>
1594− <term>
1595− <function>substitute</function> <replaceable>infile</replaceable> <replaceable>outfile</replaceable> <replaceable>subs</replaceable>
1596− </term>
1597− <listitem>
1598− <para>
1599− Performs string substitution on the contents of <replaceable>infile</replaceable>, writing the result to <replaceable>outfile</replaceable>. The substitutions in <replaceable>subs</replaceable> are of the following form:
1600− <variablelist>
1601− <varlistentry>
1602− <term>
1603− <option>--replace</option> <replaceable>s1</replaceable> <replaceable>s2</replaceable>
1604− </term>
1605− <listitem>
1606− <para>
1607− Replace every occurrence of the string <replaceable>s1</replaceable> by <replaceable>s2</replaceable>.
1608− </para>
1609− </listitem>
1610− </varlistentry>
1611− <varlistentry>
1612− <term>
1613− <option>--subst-var</option> <replaceable>varName</replaceable>
1614− </term>
1615− <listitem>
1616− <para>
1617− Replace every occurrence of <literal>@<replaceable>varName</replaceable>@</literal> by the contents of the environment variable <replaceable>varName</replaceable>. This is useful for generating files from templates, using <literal>@<replaceable>...</replaceable>@</literal> in the template as placeholders.
1618− </para>
1619− </listitem>
1620− </varlistentry>
1621− <varlistentry>
1622− <term>
1623− <option>--subst-var-by</option> <replaceable>varName</replaceable> <replaceable>s</replaceable>
1624− </term>
1625− <listitem>
1626− <para>
1627− Replace every occurrence of <literal>@<replaceable>varName</replaceable>@</literal> by the string <replaceable>s</replaceable>.
1628− </para>
1629− </listitem>
1630− </varlistentry>
1631− </variablelist>
1632− </para>
1633− <para>
1634− Example:
1635−<programlisting>
1636−substitute ./foo.in ./foo.out \
1637− --replace /usr/bin/bar $bar/bin/bar \
1638− --replace "a string containing spaces" "some other text" \
1639− --subst-var someVar
1640−</programlisting>
1641− </para>
1642− </listitem>
1643− </varlistentry>
1644− <varlistentry xml:id='fun-substituteInPlace'>
1645− <term>
1646− <function>substituteInPlace</function> <replaceable>file</replaceable> <replaceable>subs</replaceable>
1647− </term>
1648− <listitem>
1649− <para>
1650− Like <function>substitute</function>, but performs the substitutions in place on the file <replaceable>file</replaceable>.
1651− </para>
1652− </listitem>
1653− </varlistentry>
1654− <varlistentry xml:id='fun-substituteAll'>
1655− <term>
1656− <function>substituteAll</function> <replaceable>infile</replaceable> <replaceable>outfile</replaceable>
1657− </term>
1658− <listitem>
1659− <para>
1660− Replaces every occurrence of <literal>@<replaceable>varName</replaceable>@</literal>, where <replaceable>varName</replaceable> is any environment variable, in <replaceable>infile</replaceable>, writing the result to <replaceable>outfile</replaceable>. For instance, if <replaceable>infile</replaceable> has the contents
1661−<programlisting>
1662−#! @bash@/bin/sh
1663−PATH=@coreutils@/bin
1664−echo @foo@
1665−</programlisting>
1666− and the environment contains <literal>bash=/nix/store/bmwp0q28cf21...-bash-3.2-p39</literal> and <literal>coreutils=/nix/store/68afga4khv0w...-coreutils-6.12</literal>, but does not contain the variable <varname>foo</varname>, then the output will be
1667−<programlisting>
1668−#! /nix/store/bmwp0q28cf21...-bash-3.2-p39/bin/sh
1669−PATH=/nix/store/68afga4khv0w...-coreutils-6.12/bin
1670−echo @foo@
1671−</programlisting>
1672− That is, no substitution is performed for undefined variables.
1673− </para>
1674− <para>
1675− Environment variables that start with an uppercase letter or an underscore are filtered out, to prevent global variables (like <literal>HOME</literal>) or private variables (like <literal>__ETC_PROFILE_DONE</literal>) from accidentally getting substituted. The variables also have to be valid bash “names”, as defined in the bash manpage (alphanumeric or <literal>_</literal>, must not start with a number).
1676− </para>
1677− </listitem>
1678− </varlistentry>
1679− <varlistentry xml:id='fun-substituteAllInPlace'>
1680− <term>
1681− <function>substituteAllInPlace</function> <replaceable>file</replaceable>
1682− </term>
1683− <listitem>
1684− <para>
1685− Like <function>substituteAll</function>, but performs the substitutions in place on the file <replaceable>file</replaceable>.
1686− </para>
1687− </listitem>
1688− </varlistentry>
1689− <varlistentry xml:id='fun-stripHash'>
1690− <term>
1691− <function>stripHash</function> <replaceable>path</replaceable>
1692− </term>
1693− <listitem>
1694− <para>
1695− Strips the directory and hash part of a store path, outputting the name part to <literal>stdout</literal>. For example:
1696−<programlisting>
1697−# prints coreutils-8.24
1698−stripHash "/nix/store/9s9r019176g7cvn2nvcw41gsp862y6b4-coreutils-8.24"
1699−</programlisting>
1700− If you wish to store the result in another variable, then the following idiom may be useful:
1701−<programlisting>
1702−name="/nix/store/9s9r019176g7cvn2nvcw41gsp862y6b4-coreutils-8.24"
1703−someVar=$(stripHash $name)
1704−</programlisting>
1705− </para>
1706− </listitem>
1707− </varlistentry>
1708− <varlistentry xml:id='fun-wrapProgram'>
1709− <term>
1710− <function>wrapProgram</function> <replaceable>executable</replaceable> <replaceable>makeWrapperArgs</replaceable>
1711− </term>
1712− <listitem>
1713− <para>
1714− Convenience function for <literal>makeWrapper</literal> that automatically creates a sane wrapper file. It takes all the same arguments as <literal>makeWrapper</literal>, except for <literal>--argv0</literal>.
1715− </para>
1716− <para>
1717− It cannot be applied multiple times, since it will overwrite the wrapper file.
1718− </para>
1719− </listitem>
1720− </varlistentry>
1721− </variablelist>
1722− </section>
1723− <section xml:id="ssec-setup-hooks">
1724− <title>Package setup hooks</title>
1725−
1726− <para>
1727− 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.
1728− </para>
1729−
1730− <para>
1731− In order to alleviate this burden, the <firstterm>setup hook</firstterm> 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.
1732− </para>
1733−
1734− <para>
1735− 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.
1736− </para>
1737−
1738− <para>
1739− 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 <envar>envBuildBuildHooks</envar>, <envar>envBuildHostHooks</envar>, <envar>envBuildTargetHooks</envar>, <envar>envHostHostHooks</envar>, <envar>envHostTargetHooks</envar>, or <envar>envTargetTargetHooks</envar>. 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).
1740− </para>
1741−
1742− <para>
1743− Packages adding a hook should not hard code a specific hook, but rather choose a variable <emphasis>relative</emphasis> to how they are included. Returning to the C compiler wrapper example, if the wrapper itself is an <literal>n</literal> dependency, then it only wants to accumulate flags from <literal>n + 1</literal> dependencies, as only those ones match the compiler's target platform. The <envar>hostOffset</envar> variable is defined with the current dependency's host offset <envar>targetOffset</envar> 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
1744−<programlisting language="bash">
1745−addEnvHooks "$hostOffset" myBashFunction
1746−</programlisting>
1747− </para>
1748−
1749− <para>
1750− The <emphasis>existence</emphasis> 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.
1751− </para>
1752−
1753− <para>
1754− 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 <function>stdenv.mkDerivation</function>. Some of these are platform specific, so they may run on Linux but not Darwin or vice-versa.
1755− <variablelist>
1756− <varlistentry>
1757− <term>
1758− <literal>move-docs.sh</literal>
1759− </term>
1760− <listitem>
1761− <para>
1762− This setup hook moves any installed documentation to the <literal>/share</literal> subdirectory directory. This includes the man, doc and info directories. This is needed for legacy programs that do not know how to use the <literal>share</literal> subdirectory.
1763− </para>
1764− </listitem>
1765− </varlistentry>
1766− <varlistentry>
1767− <term>
1768− <literal>compress-man-pages.sh</literal>
1769− </term>
1770− <listitem>
1771− <para>
1772− 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.
1773− </para>
1774− </listitem>
1775− </varlistentry>
1776− <varlistentry>
1777− <term>
1778− <literal>strip.sh</literal>
1779− </term>
1780− <listitem>
1781− <para>
1782− 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.
1783− </para>
1784− </listitem>
1785− </varlistentry>
1786− <varlistentry>
1787− <term>
1788− <literal>patch-shebangs.sh</literal>
1789− </term>
1790− <listitem>
1791− <para>
1792− 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 <literal>#!/bin/bash</literal>). In Nix, we want an exact path to that interpreter to be used. This often replaces <literal>/bin/sh</literal> with a path in the Nix store.
1793− </para>
1794− </listitem>
1795− </varlistentry>
1796− <varlistentry>
1797− <term>
1798− <literal>audit-tmpdir.sh</literal>
1799− </term>
1800− <listitem>
1801− <para>
1802− 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.
1803− </para>
1804− </listitem>
1805− </varlistentry>
1806− <varlistentry>
1807− <term>
1808− <literal>multiple-outputs.sh</literal>
1809− </term>
1810− <listitem>
1811− <para>
1812− This setup hook adds configure flags that tell packages to install files into any one of the proper outputs listed in <literal>outputs</literal>. This behavior can be turned off by setting <literal>setOutputFlags</literal> to false in the derivation environment. See <xref linkend="chap-multiple-output"/> for more information.
1813− </para>
1814− </listitem>
1815− </varlistentry>
1816− <varlistentry>
1817− <term>
1818− <literal>move-sbin.sh</literal>
1819− </term>
1820− <listitem>
1821− <para>
1822− 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.
1823− </para>
1824− </listitem>
1825− </varlistentry>
1826− <varlistentry>
1827− <term>
1828− <literal>move-lib64.sh</literal>
1829− </term>
1830− <listitem>
1831− <para>
1832− 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.
1833− </para>
1834− </listitem>
1835− </varlistentry>
1836− <varlistentry>
1837− <term>
1838− <literal>move-systemd-user-units.sh</literal>
1839− </term>
1840− <listitem>
1841− <para>
1842− This setup hook moves any systemd user units installed in the lib
1843− subdirectory into share. In addition, a link is provided from share to
1844− lib for compatibility. This is needed for systemd to find user services
1845− when installed into the user profile.
1846− </para>
1847− </listitem>
1848− </varlistentry>
1849− <varlistentry>
1850− <term>
1851− <literal>set-source-date-epoch-to-latest.sh</literal>
1852− </term>
1853− <listitem>
1854− <para>
1855− This sets <literal>SOURCE_DATE_EPOCH</literal> to the modification time of the most recent file.
1856− </para>
1857− </listitem>
1858− </varlistentry>
1859− <varlistentry>
1860− <term>
1861− Bintools Wrapper
1862− </term>
1863− <listitem>
1864− <para>
1865− 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.
1866− </para>
1867− <para>
1868− 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. <varname>buildInputs</varname> and <varname>nativeBuildInputs</varname>) in environment variables. The Bintools Wrapper's setup hook causes any <filename>lib</filename> and <filename>lib64</filename> subdirectories to be added to <envar>NIX_LDFLAGS</envar>. 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.
1869− </para>
1870− <para>
1871− 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 <command>gcc</command> when <envar>CC</envar> isn't defined yet <command>clang</command> 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.
1872− <footnote xml:id="footnote-stdenv-per-platform-wrapper">
1873− <para>
1874− 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.
1875− </para>
1876− </footnote>
1877− <envar>BUILD_</envar>- and <envar>TARGET_</envar>-prefixed versions of the normal environment variable are defined for additional Bintools Wrappers, properly disambiguating them.
1878− </para>
1879− <para>
1880− A problem with this final task is that the Bintools Wrapper is honest and defines <envar>LD</envar> as <command>ld</command>. Most packages, however, firstly use the C compiler for linking, secondly use <envar>LD</envar> anyways, defining it as the C compiler, and thirdly, only so define <envar>LD</envar> 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, <envar>LD</envar> as the C compiler. A good way to do this would be <command>preConfigure = "LD=$CC"</command>.
1881− </para>
1882− </listitem>
1883− </varlistentry>
1884− <varlistentry>
1885− <term>
1886− CC Wrapper
1887− </term>
1888− <listitem>
1889− <para>
1890− 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.
1891− </para>
1892− <para>
1893− Dependency finding is undoubtedly the main task of the CC Wrapper. This works just like the Bintools Wrapper, except that any <filename>include</filename> subdirectory of any relevant dependency is added to <envar>NIX_CFLAGS_COMPILE</envar>. The setup hook itself contains some lengthy comments describing the exact convoluted mechanism by which this is accomplished.
1894− </para>
1895− <para>
1896− 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 <command>cc</command> symlink to the c compiler for portability, the <envar>CC</envar> will be defined using the compiler's "real name" (i.e. <command>gcc</command> or <command>clang</command>). This helps lousy build systems that inspect on the name of the compiler rather than run it.
1897− </para>
1898− </listitem>
1899− </varlistentry>
1900− </variablelist>
1901− </para>
1902−
1903− <para>
1904− 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.
1905− <variablelist>
1906− <varlistentry>
1907− <term>
1908− Perl
1909− </term>
1910− <listitem>
1911− <para>
1912− Adds the <filename>lib/site_perl</filename> subdirectory of each build input to the <envar>PERL5LIB</envar> environment variable. For instance, if <varname>buildInputs</varname> contains Perl, then the <filename>lib/site_perl</filename> subdirectory of each input is added to the <envar>PERL5LIB</envar> environment variable.
1913− </para>
1914− </listitem>
1915− </varlistentry>
1916− <varlistentry>
1917− <term>
1918− Python
1919− </term>
1920− <listitem>
1921− <para>
1922− Adds the <filename>lib/${python.libPrefix}/site-packages</filename> subdirectory of each build input to the <envar>PYTHONPATH</envar> environment variable.
1923− </para>
1924− </listitem>
1925− </varlistentry>
1926− <varlistentry>
1927− <term>
1928− pkg-config
1929− </term>
1930− <listitem>
1931− <para>
1932− Adds the <filename>lib/pkgconfig</filename> and <filename>share/pkgconfig</filename> subdirectories of each build input to the <envar>PKG_CONFIG_PATH</envar> environment variable.
1933− </para>
1934− </listitem>
1935− </varlistentry>
1936− <varlistentry>
1937− <term>
1938− Automake
1939− </term>
1940− <listitem>
1941− <para>
1942− Adds the <filename>share/aclocal</filename> subdirectory of each build input to the <envar>ACLOCAL_PATH</envar> environment variable.
1943− </para>
1944− </listitem>
1945− </varlistentry>
1946− <varlistentry>
1947− <term>
1948− Autoconf
1949− </term>
1950− <listitem>
1951− <para>
1952− The <varname>autoreconfHook</varname> derivation adds <varname>autoreconfPhase</varname>, 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.
1953− </para>
1954− </listitem>
1955− </varlistentry>
1956− <varlistentry>
1957− <term>
1958− libxml2
1959− </term>
1960− <listitem>
1961− <para>
1962− Adds every file named <filename>catalog.xml</filename> found under the <filename>xml/dtd</filename> and <filename>xml/xsl</filename> subdirectories of each build input to the <envar>XML_CATALOG_FILES</envar> environment variable.
1963− </para>
1964− </listitem>
1965− </varlistentry>
1966− <varlistentry>
1967− <term>
1968− teTeX / TeX Live
1969− </term>
1970− <listitem>
1971− <para>
1972− Adds the <filename>share/texmf-nix</filename> subdirectory of each build input to the <envar>TEXINPUTS</envar> environment variable.
1973− </para>
1974− </listitem>
1975− </varlistentry>
1976− <varlistentry>
1977− <term>
1978− Qt 4
1979− </term>
1980− <listitem>
1981− <para>
1982− Sets the <envar>QTDIR</envar> environment variable to Qt’s path.
1983− </para>
1984− </listitem>
1985− </varlistentry>
1986− <varlistentry>
1987− <term>
1988− gdk-pixbuf
1989− </term>
1990− <listitem>
1991− <para>
1992− Exports <envar>GDK_PIXBUF_MODULE_FILE</envar> environment variable to the builder. Add librsvg package to <varname>buildInputs</varname> to get svg support. See also the <link linkend="ssec-gnome-hooks-gdk-pixbuf">setup hook description in GNOME platform docs</link>.
1993− </para>
1994− </listitem>
1995− </varlistentry>
1996− <varlistentry>
1997− <term>
1998− GHC
1999− </term>
2000− <listitem>
2001− <para>
2002− Creates a temporary package database and registers every Haskell build input in it (TODO: how?).
2003− </para>
2004− </listitem>
2005− </varlistentry>
2006− <varlistentry>
2007− <term>
2008− GNOME platform
2009− </term>
2010− <listitem>
2011− <para>
2012− Hooks related to GNOME platform and related libraries like GLib, GTK and GStreamer are described in <xref linkend="sec-language-gnome" />.
2013− </para>
2014− </listitem>
2015− </varlistentry>
2016− <varlistentry xml:id="setup-hook-autopatchelfhook">
2017− <term>
2018− autoPatchelfHook
2019− </term>
2020− <listitem>
2021− <para>
2022− 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 <varname>buildInputs</varname> and <varname>nativeBuildInputs</varname>.
2023− </para>
2024− <para>
2025− You can also specify a <varname>runtimeDependencies</varname> variable which lists dependencies to be unconditionally added to <glossterm>rpath</glossterm> of all executables.
2026− This is useful for programs that use <citerefentry>
2027− <refentrytitle>dlopen</refentrytitle>
2028− <manvolnum>3</manvolnum> </citerefentry> to load libraries at runtime.
2029− </para>
2030− <para>
2031− In certain situations you may want to run the main command (<command>autoPatchelf</command>) 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 <varname>dontAutoPatchelf</varname> environment variable to a non-empty value.
2032− </para>
2033− <para>
2034− By default <command>autoPatchelf</command> 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 <envar>autoPatchelfIgnoreMissingDeps</envar> environment variable to a non-empty value.
2035− </para>
2036− <para>
2037− The <command>autoPatchelf</command> command also recognizes a <parameter class="command">--no-recurse</parameter> command line flag, which prevents it from recursing into subdirectories.
2038− </para>
2039− </listitem>
2040− </varlistentry>
2041− <varlistentry>
2042− <term>
2043− breakpointHook
2044− </term>
2045− <listitem>
2046− <para>
2047− 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 <command>cntr</command> command. Upon build error it will print instructions on how to use <command>cntr</command>, 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 <filename>/var/lib/cntr</filename> 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. <command>cntr</command> is only supported on Linux-based platforms. To use it first add <literal>cntr</literal> to your <literal>environment.systemPackages</literal> on NixOS or alternatively to the root user on non-NixOS systems. Then in the package that is supposed to be inspected, add <literal>breakpointHook</literal> to <literal>nativeBuildInputs</literal>.
2048−<programlisting>
2049−nativeBuildInputs = [ breakpointHook ];
2050−</programlisting>
2051− When a build failure happens there will be an instruction printed that shows how to attach with <literal>cntr</literal> to the build sandbox.
2052− </para>
2053− <note>
2054− <title>Caution with remote builds</title>
2055− <para>
2056− This won't work with remote builds as the build environment is on a different machine and can't be accessed by <command>cntr</command>. Remote builds can be turned off by setting <literal>--option builders ''</literal> for <command>nix-build</command> or <literal>--builders ''</literal> for <command>nix build</command>.
2057− </para>
2058− </note>
2059− </listitem>
2060− </varlistentry>
2061− <varlistentry>
2062− <term>
2063− installShellFiles
2064− </term>
2065− <listitem>
2066− <para>
2067− This hook helps with installing manpages and shell completion files. It exposes 2 shell functions <literal>installManPage</literal> and <literal>installShellCompletion</literal> that can be used from your <literal>postInstall</literal> hook.
2068− </para>
2069− <para>
2070− The <literal>installManPage</literal> function takes one or more paths to manpages to install. The manpages must have a section suffix, and may optionally be compressed (with <literal>.gz</literal> suffix). This function will place them into the correct directory.
2071− </para>
2072− <para>
2073− The <literal>installShellCompletion</literal> 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 <literal>--bash</literal>, <literal>--fish</literal>, or <literal>--zsh</literal>. 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 <literal>--name NAME</literal> before the path. If this flag is not provided, zsh completions will be renamed automatically such that <literal>foobar.zsh</literal> becomes <literal>_foobar</literal>. A root name may be provided for all paths using the flag <literal>--cmd NAME</literal>; this synthesizes the appropriate name depending on the shell (e.g. <literal>--cmd foo</literal> will synthesize the name <literal>foo.bash</literal> for bash and <literal>_foo</literal> for zsh). The path may also be a fifo or named fd (such as produced by <literal><(cmd)</literal>), in which case the shell and name must be provided.
2074−<programlisting>
2075−nativeBuildInputs = [ installShellFiles ];
2076−postInstall = ''
2077− installManPage doc/foobar.1 doc/barfoo.3
2078− # explicit behavior
2079− installShellCompletion --bash --name foobar.bash share/completions.bash
2080− installShellCompletion --fish --name foobar.fish share/completions.fish
2081− installShellCompletion --zsh --name _foobar share/completions.zsh
2082− # implicit behavior
2083− installShellCompletion share/completions/foobar.{bash,fish,zsh}
2084− # using named fd
2085− installShellCompletion --cmd foobar \
2086− --bash <($out/bin/foobar --bash-completion) \
2087− --fish <($out/bin/foobar --fish-completion) \
2088− --zsh <($out/bin/foobar --zsh-completion)
2089−'';
2090−</programlisting>
2091− </para>
2092− </listitem>
2093− </varlistentry>
2094− <varlistentry>
2095− <term>
2096− libiconv, libintl
2097− </term>
2098− <listitem>
2099− <para>
2100− A few libraries automatically add to <literal>NIX_LDFLAGS</literal> 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 <literal>dontAddExtraLibs</literal>.
2101− </para>
2102− </listitem>
2103− </varlistentry>
2104− <varlistentry>
2105− <term>
2106− validatePkgConfig
2107− </term>
2108− <listitem>
2109− <para>
2110− The <literal>validatePkgConfig</literal> hook validates all pkg-config (<filename>.pc</filename>) files in a package. This helps catching some common errors in pkg-config files, such as undefined variables.
2111− </para>
2112− </listitem>
2113− </varlistentry>
2114− <varlistentry>
2115− <term>
2116− cmake
2117− </term>
2118− <listitem>
2119− <para>
2120− 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.
2121− </para>
2122− </listitem>
2123− </varlistentry>
2124− <varlistentry>
2125− <term>
2126− xcbuildHook
2127− </term>
2128− <listitem>
2129− <para>
2130− 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.
2131− </para>
2132− </listitem>
2133− </varlistentry>
2134− <varlistentry>
2135− <term>
2136− Meson
2137− </term>
2138− <listitem>
2139− <para>
2140− Overrides the configure phase to run meson to generate Ninja files. To run these files, you should accompany Meson with ninja. By default, <varname>enableParallelBuilding</varname> is enabled as Meson supports parallel building almost everywhere.
2141− </para>
2142− <variablelist>
2143− <title>Variables controlling Meson</title>
2144− <varlistentry>
2145− <term>
2146− <varname>mesonFlags</varname>
2147− </term>
2148− <listitem>
2149− <para>
2150− Controls the flags passed to meson.
2151− </para>
2152− </listitem>
2153− </varlistentry>
2154− <varlistentry>
2155− <term>
2156− <varname>mesonBuildType</varname>
2157− </term>
2158− <listitem>
2159− <para>
2160− Which <link
2161− xlink:href="https://mesonbuild.com/Builtin-options.html#core-options"><command>--buildtype</command></link> to pass to Meson. We default to <literal>plain</literal>.
2162− </para>
2163− </listitem>
2164− </varlistentry>
2165− <varlistentry>
2166− <term>
2167− <varname>mesonAutoFeatures</varname>
2168− </term>
2169− <listitem>
2170− <para>
2171− What value to set <link
2172− xlink:href="https://mesonbuild.com/Builtin-options.html#core-options"><command>-Dauto_features=</command></link> to. We default to <command>enabled</command>.
2173− </para>
2174− </listitem>
2175− </varlistentry>
2176− <varlistentry>
2177− <term>
2178− <varname>mesonWrapMode</varname>
2179− </term>
2180− <listitem>
2181− <para>
2182− What value to set <link
2183− xlink:href="https://mesonbuild.com/Builtin-options.html#core-options"><command>-Dwrap_mode=</command></link> to. We default to <command>nodownload</command> as we disallow network access.
2184− </para>
2185− </listitem>
2186− </varlistentry>
2187− <varlistentry>
2188− <term>
2189− <varname>dontUseMesonConfigure</varname>
2190− </term>
2191− <listitem>
2192− <para>
2193− Disables using Meson's <varname>configurePhase</varname>.
2194− </para>
2195− </listitem>
2196− </varlistentry>
2197− </variablelist>
2198− </listitem>
2199− </varlistentry>
2200− <varlistentry>
2201− <term>
2202− ninja
2203− </term>
2204− <listitem>
2205− <para>
2206− 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.
2207− </para>
2208− </listitem>
2209− </varlistentry>
2210− <varlistentry>
2211− <term>
2212− unzip
2213− </term>
2214− <listitem>
2215− <para>
2216− This setup hook will allow you to unzip .zip files specified in $src. There are many similar packages like unrar, undmg, etc.
2217− </para>
2218− </listitem>
2219− </varlistentry>
2220− <varlistentry>
2221− <term>
2222− wafHook
2223− </term>
2224− <listitem>
2225− <para>
2226− 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.
2227− </para>
2228− </listitem>
2229− </varlistentry>
2230− <varlistentry>
2231− <term>
2232− scons
2233− </term>
2234− <listitem>
2235− <para>
2236− 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.
2237− </para>
2238− </listitem>
2239− </varlistentry>
2240− </variablelist>
2241− </para>
2242− </section>
2243− <section xml:id="sec-purity-in-nixpkgs">
2244− <title>Purity in Nixpkgs</title>
2245−
2246− <para>
2247− [measures taken to prevent dependencies on packages outside the store, and what you can do to prevent them]
2248− </para>
2249−
2250− <para>
2251− GCC doesn't search in locations such as <filename>/usr/include</filename>. In fact, attempts to add such directories through the <option>-I</option> flag are filtered out. Likewise, the linker (from GNU binutils) doesn't search in standard locations such as <filename>/usr/lib</filename>. Programs built on Linux are linked against a GNU C Library that likewise doesn't search in the default system locations.
2252− </para>
2253− </section>
2254− <section xml:id="sec-hardening-in-nixpkgs">
2255− <title>Hardening in Nixpkgs</title>
2256−
2257− <para>
2258− There are flags available to harden packages at compile or link-time. These can be toggled using the <varname>stdenv.mkDerivation</varname> parameters <varname>hardeningDisable</varname> and <varname>hardeningEnable</varname>.
2259− </para>
2260−
2261− <para>
2262− Both parameters take a list of flags as strings. The special <varname>"all"</varname> flag can be passed to <varname>hardeningDisable</varname> to turn off all hardening. These flags can also be used as environment variables for testing or development purposes.
2263− </para>
2264−
2265− <para>
2266− The following flags are enabled by default and might require disabling with <varname>hardeningDisable</varname> if the program to package is incompatible.
2267− </para>
2268−
2269− <variablelist>
2270− <varlistentry>
2271− <term>
2272− <varname>format</varname>
2273− </term>
2274− <listitem>
2275− <para>
2276− Adds the <option>-Wformat -Wformat-security -Werror=format-security</option> compiler options. At present, this warns about calls to <varname>printf</varname> and <varname>scanf</varname> functions where the format string is not a string literal and there are no format arguments, as in <literal>printf(foo);</literal>. This may be a security hole if the format string came from untrusted input and contains <literal>%n</literal>.
2277− </para>
2278− <para>
2279− This needs to be turned off or fixed for errors similar to:
2280− </para>
2281−<programlisting>
2282−/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]
2283− printf(help_message);
2284− ^
2285−cc1plus: some warnings being treated as errors
2286−</programlisting>
2287− </listitem>
2288− </varlistentry>
2289− <varlistentry>
2290− <term>
2291− <varname>stackprotector</varname>
2292− </term>
2293− <listitem>
2294− <para>
2295− Adds the <option>-fstack-protector-strong --param ssp-buffer-size=4</option> 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).
2296− </para>
2297− <para>
2298− This needs to be turned off or fixed for errors similar to:
2299− </para>
2300−<programlisting>
2301−bin/blib.a(bios_console.o): In function `bios_handle_cup':
2302−/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'
2303−</programlisting>
2304− </listitem>
2305− </varlistentry>
2306− <varlistentry>
2307− <term>
2308− <varname>fortify</varname>
2309− </term>
2310− <listitem>
2311− <para>
2312− Adds the <option>-O2 -D_FORTIFY_SOURCE=2</option> 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.
2313− </para>
2314− <para>
2315− 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 <option>NIX_CFLAGS_COMPILE</option> to <option>-Wno-error=warning-type</option>.
2316− </para>
2317− <para>
2318− This needs to be turned off or fixed for errors similar to:
2319− </para>
2320−<programlisting>
2321−malloc.c:404:15: error: return type is an incomplete type
2322−malloc.c:410:19: error: storage size of 'ms' isn't known
2323−</programlisting>
2324−<programlisting>
2325−strdup.h:22:1: error: expected identifier or '(' before '__extension__'
2326−</programlisting>
2327−<programlisting>
2328−strsep.c:65:23: error: register name not specified for 'delim'
2329−</programlisting>
2330−<programlisting>
2331−installwatch.c:3751:5: error: conflicting types for '__open_2'
2332−</programlisting>
2333−<programlisting>
2334−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
2335−</programlisting>
2336− </listitem>
2337− </varlistentry>
2338− <varlistentry>
2339− <term>
2340− <varname>pic</varname>
2341− </term>
2342− <listitem>
2343− <para>
2344− Adds the <option>-fPIC</option> compiler options. This options adds support for position independent code in shared libraries and thus making ASLR possible.
2345− </para>
2346− <para>
2347− 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.
2348− </para>
2349− <para>
2350− This needs to be turned off or fixed for assembler errors similar to:
2351− </para>
2352−<programlisting>
2353−ccbLfRgg.s: Assembler messages:
2354−ccbLfRgg.s:33: Error: missing or invalid displacement expression `private_key_len@GOTOFF'
2355−</programlisting>
2356− </listitem>
2357− </varlistentry>
2358− <varlistentry>
2359− <term>
2360− <varname>strictoverflow</varname>
2361− </term>
2362− <listitem>
2363− <para>
2364− 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 <option>-fno-strict-overflow</option> makes gcc behave as if signed integer overflows were defined.
2365− </para>
2366− <para>
2367− This flag should not trigger any build or runtime errors.
2368− </para>
2369− </listitem>
2370− </varlistentry>
2371− <varlistentry>
2372− <term>
2373− <varname>relro</varname>
2374− </term>
2375− <listitem>
2376− <para>
2377− Adds the <option>-z relro</option> 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.
2378− </para>
2379− <para>
2380− 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 <varname>bindnow</varname> flag must also be disabled and incompatible programs typically fail with similar errors at runtime.
2381− </para>
2382− </listitem>
2383− </varlistentry>
2384− <varlistentry>
2385− <term>
2386− <varname>bindnow</varname>
2387− </term>
2388− <listitem>
2389− <para>
2390− Adds the <option>-z bindnow</option> linker option. During program load, all dynamic symbols are resolved, allowing for the complete GOT to be marked read-only (due to <varname>relro</varname>). 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.
2391− </para>
2392− <para>
2393− 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:
2394− </para>
2395−<programlisting>
2396−intel_drv.so: undefined symbol: vgaHWFreeHWRec
2397−</programlisting>
2398− </listitem>
2399− </varlistentry>
2400− </variablelist>
2401−
2402− <para>
2403− The following flags are disabled by default and should be enabled with <varname>hardeningEnable</varname> for packages that take untrusted input like network services.
2404− </para>
2405−
2406− <variablelist>
2407− <varlistentry>
2408− <term>
2409− <varname>pie</varname>
2410− </term>
2411− <listitem>
2412− <para>
2413− Adds the <option>-fPIE</option> compiler and <option>-pie</option> 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 <varname>pic</varname> flag, so they gain ASLR automatically, but binary .text regions need to be build with <varname>pie</varname> 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.
2414− </para>
2415− </listitem>
2416− </varlistentry>
2417− </variablelist>
2418−
2419− <para>
2420− For more in-depth information on these hardening flags and hardening in general, refer to the <link xlink:href="https://wiki.debian.org/Hardening">Debian Wiki</link>, <link xlink:href="https://wiki.ubuntu.com/Security/Features">Ubuntu Wiki</link>, <link xlink:href="https://wiki.gentoo.org/wiki/Project:Hardened">Gentoo Wiki</link>, and the <link xlink:href="https://wiki.archlinux.org/index.php/DeveloperWiki:Security"> Arch Wiki</link>.
2421− </para>
2422− </section>
2423−</chapter>
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/configuration.xmldeleted−451
@@ -1,451 +0,0 @@
1−<chapter xmlns="http://docbook.org/ns/docbook"
2− xmlns:xlink="http://www.w3.org/1999/xlink"
3− xml:id="chap-packageconfig">
4− <title>Global configuration</title>
5− <para>
6− 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:
7− </para>
8− <itemizedlist>
9− <listitem>
10− <para>
11− The package is thought to be broken, and has had its <literal>meta.broken</literal> set to <literal>true</literal>.
12− </para>
13− </listitem>
14− <listitem>
15− <para>
16− The package isn't intended to run on the given system, as none of its <literal>meta.platforms</literal> match the given system.
17− </para>
18− </listitem>
19− <listitem>
20− <para>
21− The package's <literal>meta.license</literal> is set to a license which is considered to be unfree.
22− </para>
23− </listitem>
24− <listitem>
25− <para>
26− 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 <literal>meta.knownVulnerabilities</literal>.
27− </para>
28− </listitem>
29− </itemizedlist>
30− <para>
31− 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. <literal>nix-env -qa</literal> will (attempt to) hide any packages that would be refused.
32− </para>
33− <para>
34− Each of these criteria can be altered in the nixpkgs configuration.
35− </para>
36− <para>
37− The nixpkgs configuration for a NixOS system is set in the <literal>configuration.nix</literal>, as in the following example:
38−<programlisting>
39−{
40− nixpkgs.config = {
41− allowUnfree = true;
42− };
43−}
44−</programlisting>
45− However, this does not allow unfree software for individual users. Their configurations are managed separately.
46− </para>
47− <para>
48− A user's nixpkgs configuration is stored in a user-specific configuration file located at <filename>~/.config/nixpkgs/config.nix</filename>. For example:
49−<programlisting>
50−{
51− allowUnfree = true;
52−}
53−</programlisting>
54− </para>
55− <para>
56− 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.
57− </para>
58− <section xml:id="sec-allow-broken">
59− <title>Installing broken packages</title>
60−
61− <para>
62− There are two ways to try compiling a package which has been marked as broken.
63− </para>
64−
65− <itemizedlist>
66− <listitem>
67− <para>
68− For allowing the build of a broken package once, you can use an environment variable for a single invocation of the nix tools:
69−<screen><prompt>$ </prompt>export NIXPKGS_ALLOW_BROKEN=1</screen>
70− </para>
71− </listitem>
72− <listitem>
73− <para>
74− For permanently allowing broken packages to be built, you may add <literal>allowBroken = true;</literal> to your user's configuration file, like this:
75−<programlisting>
76−{
77− allowBroken = true;
78−}
79−</programlisting>
80− </para>
81− </listitem>
82− </itemizedlist>
83− </section>
84− <section xml:id="sec-allow-unsupported-system">
85− <title>Installing packages on unsupported systems</title>
86−
87− <para>
88− There are also two ways to try compiling a package which has been marked as unsupported for the given system.
89− </para>
90−
91− <itemizedlist>
92− <listitem>
93− <para>
94− For allowing the build of an unsupported package once, you can use an environment variable for a single invocation of the nix tools:
95−<screen><prompt>$ </prompt>export NIXPKGS_ALLOW_UNSUPPORTED_SYSTEM=1</screen>
96− </para>
97− </listitem>
98− <listitem>
99− <para>
100− For permanently allowing unsupported packages to be built, you may add <literal>allowUnsupportedSystem = true;</literal> to your user's configuration file, like this:
101−<programlisting>
102−{
103− allowUnsupportedSystem = true;
104−}
105−</programlisting>
106− </para>
107− </listitem>
108− </itemizedlist>
109−
110− <para>
111− The difference between a package being unsupported on some system and being broken is admittedly a bit fuzzy. If a program <emphasis>ought</emphasis> to work on a certain platform, but doesn't, the platform should be included in <literal>meta.platforms</literal>, but marked as broken with e.g. <literal>meta.broken = !hostPlatform.isWindows</literal>. Of course, this begs the question of what "ought" means exactly. That is left to the package maintainer.
112− </para>
113− </section>
114− <section xml:id="sec-allow-unfree">
115− <title>Installing unfree packages</title>
116−
117− <para>
118− There are several ways to tweak how Nix handles a package which has been marked as unfree.
119− </para>
120−
121− <itemizedlist>
122− <listitem>
123− <para>
124− To temporarily allow all unfree packages, you can use an environment variable for a single invocation of the nix tools:
125−<screen><prompt>$ </prompt>export NIXPKGS_ALLOW_UNFREE=1</screen>
126− </para>
127− </listitem>
128− <listitem>
129− <para>
130− It is possible to permanently allow individual unfree packages, while still blocking unfree packages by default using the <literal>allowUnfreePredicate</literal> configuration option in the user configuration file.
131− </para>
132− <para>
133− 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:
134−<programlisting>
135−{
136− allowUnfreePredicate = (pkg: false);
137−}
138−</programlisting>
139− </para>
140− <para>
141− For a more useful example, try the following. This configuration only allows unfree packages named flash player and visual studio code:
142−<programlisting>
143−{
144− allowUnfreePredicate = pkg: builtins.elem (lib.getName pkg) [
145− "flashplayer"
146− "vscode"
147− ];
148−}
149−</programlisting>
150− </para>
151− </listitem>
152− <listitem>
153− <para>
154− It is also possible to whitelist and blacklist licenses that are specifically acceptable or not acceptable, using <literal>whitelistedLicenses</literal> and <literal>blacklistedLicenses</literal>, respectively.
155− </para>
156− <para>
157− The following example configuration whitelists the licenses <literal>amd</literal> and <literal>wtfpl</literal>:
158−<programlisting>
159−{
160− whitelistedLicenses = with stdenv.lib.licenses; [ amd wtfpl ];
161−}
162−</programlisting>
163− </para>
164− <para>
165− The following example configuration blacklists the <literal>gpl3Only</literal> and <literal>agpl3Only</literal> licenses:
166−<programlisting>
167−{
168− blacklistedLicenses = with stdenv.lib.licenses; [ agpl3Only gpl3Only ];
169−}
170−</programlisting>
171− </para>
172− <para>
173− Note that <literal>whitelistedLicenses</literal> only applies to unfree licenses unless <literal>allowUnfree</literal> is enabled. It is not a generic whitelist for all types of licenses. <literal>blacklistedLicenses</literal> applies to all licenses.
174− </para>
175− </listitem>
176− </itemizedlist>
177−
178− <para>
179− A complete list of licenses can be found in the file <filename>lib/licenses.nix</filename> of the nixpkgs tree.
180− </para>
181− </section>
182− <section xml:id="sec-allow-insecure">
183− <title>Installing insecure packages</title>
184−
185− <para>
186− There are several ways to tweak how Nix handles a package which has been marked as insecure.
187− </para>
188−
189− <itemizedlist>
190− <listitem>
191− <para>
192− To temporarily allow all insecure packages, you can use an environment variable for a single invocation of the nix tools:
193−<screen><prompt>$ </prompt>export NIXPKGS_ALLOW_INSECURE=1</screen>
194− </para>
195− </listitem>
196− <listitem>
197− <para>
198− It is possible to permanently allow individual insecure packages, while still blocking other insecure packages by default using the <literal>permittedInsecurePackages</literal> configuration option in the user configuration file.
199− </para>
200− <para>
201− The following example configuration permits the installation of the hypothetically insecure package <literal>hello</literal>, version <literal>1.2.3</literal>:
202−<programlisting>
203−{
204− permittedInsecurePackages = [
205− "hello-1.2.3"
206− ];
207−}
208−</programlisting>
209− </para>
210− </listitem>
211− <listitem>
212− <para>
213− It is also possible to create a custom policy around which insecure packages to allow and deny, by overriding the <literal>allowInsecurePredicate</literal> configuration option.
214− </para>
215− <para>
216− The <literal>allowInsecurePredicate</literal> option is a function which accepts a package and returns a boolean, much like <literal>allowUnfreePredicate</literal>.
217− </para>
218− <para>
219− The following configuration example only allows insecure packages with very short names:
220−<programlisting>
221−{
222− allowInsecurePredicate = pkg: builtins.stringLength (lib.getName pkg) <= 5;
223−}
224−</programlisting>
225− </para>
226− <para>
227− Note that <literal>permittedInsecurePackages</literal> is only checked if <literal>allowInsecurePredicate</literal> is not specified.
228− </para>
229− </listitem>
230− </itemizedlist>
231− </section>
232−<!--============================================================-->
233− <section xml:id="sec-modify-via-packageOverrides">
234− <title>Modify packages via <literal>packageOverrides</literal></title>
235−
236− <para>
237− You can define a function called <varname>packageOverrides</varname> in your local <filename>~/.config/nixpkgs/config.nix</filename> to override Nix packages. It must be a function that takes pkgs as an argument and returns a modified set of packages.
238−<programlisting>
239−{
240− packageOverrides = pkgs: rec {
241− foo = pkgs.foo.override { ... };
242− };
243−}
244−</programlisting>
245− </para>
246− </section>
247− <section xml:id="sec-declarative-package-management">
248− <title>Declarative Package Management</title>
249−
250− <section xml:id="sec-building-environment">
251− <title>Build an environment</title>
252−
253− <para>
254− Using <literal>packageOverrides</literal>, 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 <literal>aspell</literal>, <literal>bc</literal>, <literal>ffmpeg</literal>, <literal>coreutils</literal>, <literal>gdb</literal>, <literal>nixUnstable</literal>, <literal>emscripten</literal>, <literal>jq</literal>, <literal>nox</literal>, and <literal>silver-searcher</literal>, we could use the following in <filename>~/.config/nixpkgs/config.nix</filename>:
255− </para>
256−
257−<screen>
258−{
259− packageOverrides = pkgs: with pkgs; {
260− myPackages = pkgs.buildEnv {
261− name = "my-packages";
262− paths = [
263− aspell
264− bc
265− coreutils
266− gdb
267− ffmpeg
268− nixUnstable
269− emscripten
270− jq
271− nox
272− silver-searcher
273− ];
274− };
275− };
276−}
277−</screen>
278−
279− <para>
280− To install it into our environment, you can just run <literal>nix-env -iA nixpkgs.myPackages</literal>. If you want to load the packages to be built from a working copy of <literal>nixpkgs</literal> you just run <literal>nix-env -f. -iA myPackages</literal>. To explore what's been installed, just look through <filename>~/.nix-profile/</filename>. 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:
281− </para>
282−
283−<screen>
284−{
285− packageOverrides = pkgs: with pkgs; {
286− myPackages = pkgs.buildEnv {
287− name = "my-packages";
288− paths = [
289− aspell
290− bc
291− coreutils
292− gdb
293− ffmpeg
294− nixUnstable
295− emscripten
296− jq
297− nox
298− silver-searcher
299− ];
300− pathsToLink = [ "/share" "/bin" ];
301− };
302− };
303−}
304−</screen>
305−
306− <para>
307− <literal>pathsToLink</literal> tells Nixpkgs to only link the paths listed which gets rid of the extra stuff in the profile. <filename>/bin</filename> and <filename>/share</filename> 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, <filename>/Applications</filename>, that makes GUI apps available.
308− </para>
309− </section>
310−
311− <section xml:id="sec-getting-documentation">
312− <title>Getting documentation</title>
313−
314− <para>
315− After building that new environment, look through <filename>~/.nix-profile</filename> to make sure everything is there that we wanted. Discerning readers will note that some files are missing. Look inside <filename>~/.nix-profile/share/man/man1/</filename> 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.
316− </para>
317−
318−<screen>
319−{
320− packageOverrides = pkgs: with pkgs; {
321− myPackages = pkgs.buildEnv {
322− name = "my-packages";
323− paths = [
324− aspell
325− bc
326− coreutils
327− ffmpeg
328− nixUnstable
329− emscripten
330− jq
331− nox
332− silver-searcher
333− ];
334− pathsToLink = [ "/share/man" "/share/doc" "/bin" ];
335− extraOutputsToInstall = [ "man" "doc" ];
336− };
337− };
338−}
339−</screen>
340−
341− <para>
342− 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.
343− </para>
344−
345−<screen>
346−{
347− packageOverrides = pkgs: with pkgs; rec {
348− myProfile = writeText "my-profile" ''
349− export PATH=$HOME/.nix-profile/bin:/nix/var/nix/profiles/default/bin:/sbin:/bin:/usr/sbin:/usr/bin
350− export MANPATH=$HOME/.nix-profile/share/man:/nix/var/nix/profiles/default/share/man:/usr/share/man
351− '';
352− myPackages = pkgs.buildEnv {
353− name = "my-packages";
354− paths = [
355− (runCommand "profile" {} ''
356− mkdir -p $out/etc/profile.d
357− cp ${myProfile} $out/etc/profile.d/my-profile.sh
358− '')
359− aspell
360− bc
361− coreutils
362− ffmpeg
363− man
364− nixUnstable
365− emscripten
366− jq
367− nox
368− silver-searcher
369− ];
370− pathsToLink = [ "/share/man" "/share/doc" "/bin" "/etc" ];
371− extraOutputsToInstall = [ "man" "doc" ];
372− };
373− };
374−}
375−</screen>
376−
377− <para>
378− For this to work fully, you must also have this script sourced when you are logged in. Try adding something like this to your <filename>~/.profile</filename> file:
379− </para>
380−
381−<screen>
382−#!/bin/sh
383−if [ -d $HOME/.nix-profile/etc/profile.d ]; then
384− for i in $HOME/.nix-profile/etc/profile.d/*.sh; do
385− if [ -r $i ]; then
386− . $i
387− fi
388− done
389−fi
390−</screen>
391−
392− <para>
393− Now just run <literal>source $HOME/.profile</literal> and you can starting loading man pages from your environment.
394− </para>
395− </section>
396−
397− <section xml:id="sec-gnu-info-setup">
398− <title>GNU info setup</title>
399−
400− <para>
401− 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.
402− </para>
403−
404−<screen>
405−{
406− packageOverrides = pkgs: with pkgs; rec {
407− myProfile = writeText "my-profile" ''
408− export PATH=$HOME/.nix-profile/bin:/nix/var/nix/profiles/default/bin:/sbin:/bin:/usr/sbin:/usr/bin
409− export MANPATH=$HOME/.nix-profile/share/man:/nix/var/nix/profiles/default/share/man:/usr/share/man
410− export INFOPATH=$HOME/.nix-profile/share/info:/nix/var/nix/profiles/default/share/info:/usr/share/info
411− '';
412− myPackages = pkgs.buildEnv {
413− name = "my-packages";
414− paths = [
415− (runCommand "profile" {} ''
416− mkdir -p $out/etc/profile.d
417− cp ${myProfile} $out/etc/profile.d/my-profile.sh
418− '')
419− aspell
420− bc
421− coreutils
422− ffmpeg
423− man
424− nixUnstable
425− emscripten
426− jq
427− nox
428− silver-searcher
429− texinfoInteractive
430− ];
431− pathsToLink = [ "/share/man" "/share/doc" "/share/info" "/bin" "/etc" ];
432− extraOutputsToInstall = [ "man" "doc" "info" ];
433− postBuild = ''
434− if [ -x $out/bin/install-info -a -w $out/share/info ]; then
435− shopt -s nullglob
436− for i in $out/share/info/*.info $out/share/info/*.info.gz; do
437− $out/bin/install-info $i $out/share/info/dir
438− done
439− fi
440− '';
441− };
442− };
443−}
444−</screen>
445−
446− <para>
447− <literal>postBuild</literal> tells Nixpkgs to run a command after building the environment. In this case, <literal>install-info</literal> adds the installed info pages to <literal>dir</literal> which is GNU info's default root node. Note that <literal>texinfoInteractive</literal> is added to the environment to give the <literal>install-info</literal> command.
448− </para>
449− </section>
450− </section>
451−</chapter>
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/overlays.xmldeleted−295
@@ -1,295 +0,0 @@
1−<chapter xmlns="http://docbook.org/ns/docbook"
2− xmlns:xlink="http://www.w3.org/1999/xlink"
3− xml:id="chap-overlays">
4− <title>Overlays</title>
5− <para>
6− 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.
7− </para>
8− <para>
9− 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.
10− </para>
11−<!--============================================================-->
12− <section xml:id="sec-overlays-install">
13− <title>Installing overlays</title>
14−
15− <para>
16− The list of overlays can be set either explicitly in a Nix expression, or through <literal><nixpkgs-overlays></literal> or user configuration files.
17− </para>
18−
19− <section xml:id="sec-overlays-argument">
20− <title>Set overlays in NixOS or Nix expressions</title>
21−
22− <para>
23− On a NixOS system the value of the <literal>nixpkgs.overlays</literal> 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. <literal>nix-env</literal>), which are <link xlink:href="#sec-overlays-lookup">looked</link> up independently.
24− </para>
25−
26− <para>
27− The list of overlays can be passed explicitly when importing nixpkgs, for example <literal>import <nixpkgs> { overlays = [ overlay1 overlay2 ]; }</literal>.
28− </para>
29−
30− <para>
31− NOTE: DO NOT USE THIS in nixpkgs.
32− Further overlays can be added by calling the <literal>pkgs.extend</literal> or <literal>pkgs.appendOverlays</literal>, although it is often preferable to avoid these functions, because they recompute the Nixpkgs fixpoint, which is somewhat expensive to do.
33− </para>
34− </section>
35−
36− <section xml:id="sec-overlays-lookup">
37− <title>Install overlays via configuration lookup</title>
38−
39− <para>
40− The list of overlays is determined as follows.
41− </para>
42−
43− <para>
44− <orderedlist>
45− <listitem>
46− <para>
47− First, if an <link xlink:href="#sec-overlays-argument"><varname>overlays</varname> argument</link> to the Nixpkgs function itself is given, then that is used and no path lookup will be performed.
48− </para>
49− </listitem>
50− <listitem>
51− <para>
52− Otherwise, if the Nix path entry <literal><nixpkgs-overlays></literal> exists, we look for overlays at that path, as described below.
53− </para>
54− <para>
55− See the section on <literal>NIX_PATH</literal> in the Nix manual for more details on how to set a value for <literal><nixpkgs-overlays>.</literal>
56− </para>
57− </listitem>
58− <listitem>
59− <para>
60− If one of <filename>~/.config/nixpkgs/overlays.nix</filename> and <filename>~/.config/nixpkgs/overlays/</filename> exists, then we look for overlays at that path, as described below. It is an error if both exist.
61− </para>
62− </listitem>
63− </orderedlist>
64− </para>
65−
66− <para>
67− If we are looking for overlays at a path, then there are two cases:
68− <itemizedlist>
69− <listitem>
70− <para>
71− If the path is a file, then the file is imported as a Nix expression and used as the list of overlays.
72− </para>
73− </listitem>
74− <listitem>
75− <para>
76− 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:
77− <itemizedlist>
78− <listitem>
79− <para>
80− Importing the file, if it is a <literal>.nix</literal> file.
81− </para>
82− </listitem>
83− <listitem>
84− <para>
85− Importing a top-level <filename>default.nix</filename> file, if it is a directory.
86− </para>
87− </listitem>
88− </itemizedlist>
89− </para>
90− </listitem>
91− </itemizedlist>
92− </para>
93−
94− <para>
95− Because overlays that are set in NixOS configuration do not affect non-NixOS operations such as <literal>nix-env</literal>, the <filename>overlays.nix</filename> 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 <filename>overlays.nix</filename> and imported as the value of <literal>nixpkgs.overlays</literal>.
96− </para>
97−
98−<!-- TODO: Example of sharing overlays between NixOS configuration
99− and configuration lookup. Also reference the example
100− from the sec-overlays-argument paragraph about NixOS.
101− -->
102− </section>
103− </section>
104−<!--============================================================-->
105− <section xml:id="sec-overlays-definition">
106− <title>Defining overlays</title>
107−
108− <para>
109− Overlays are Nix functions which accept two arguments, conventionally called <varname>self</varname> and <varname>super</varname>, and return a set of packages. For example, the following is a valid overlay.
110− </para>
111−
112−<programlisting>
113−self: super:
114−
115−{
116− boost = super.boost.override {
117− python = self.python3;
118− };
119− rr = super.callPackage ./pkgs/rr {
120− stdenv = self.stdenv_32bit;
121− };
122−}
123−</programlisting>
124−
125− <para>
126− The first argument (<varname>self</varname>) 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 <varname>rr</varname> in the example above come from <varname>self</varname>, as well as the overridden dependencies used in the <varname>boost</varname> override.
127− </para>
128−
129− <para>
130− The second argument (<varname>super</varname>) 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 <varname>boost</varname> in the above example, comes from <varname>super</varname>, as well as the <varname>callPackage</varname> function.
131− </para>
132−
133− <para>
134− The value returned by this function should be a set similar to <filename>pkgs/top-level/all-packages.nix</filename>, containing overridden and/or new packages.
135− </para>
136−
137− <para>
138− Overlays are similar to other methods for customizing Nixpkgs, in particular the <literal>packageOverrides</literal> attribute described in <xref linkend="sec-modify-via-packageOverrides"/>. Indeed, <literal>packageOverrides</literal> acts as an overlay with only the <varname>super</varname> argument. It is therefore appropriate for basic use, but overlays are more powerful and easier to distribute.
139− </para>
140− </section>
141− <section xml:id="sec-overlays-alternatives">
142− <title>Using overlays to configure alternatives</title>
143− <para>
144− Certain software packages have different implementations of the
145− same interface. Other distributions have functionality to switch
146− between these. For example, Debian provides <link
147− xlink:href="https://wiki.debian.org/DebianAlternatives">DebianAlternatives</link>.
148− Nixpkgs has what we call <literal>alternatives</literal>, which
149− are configured through overlays.
150− </para>
151− <section xml:id="sec-overlays-alternatives-blas-lapack">
152− <title>BLAS/LAPACK</title>
153− <para>
154− In Nixpkgs, we have multiple implementations of the BLAS/LAPACK
155− numerical linear algebra interfaces. They are:
156− </para>
157− <itemizedlist>
158− <listitem>
159− <para>
160− <link xlink:href="https://www.openblas.net/">OpenBLAS</link>
161− </para>
162− <para>
163− The Nixpkgs attribute is <literal>openblas</literal> for
164− ILP64 (integer width = 64 bits) and
165− <literal>openblasCompat</literal> for LP64 (integer width =
166− 32 bits). <literal>openblasCompat</literal> is the default.
167− </para>
168− </listitem>
169− <listitem>
170− <para>
171− <link xlink:href="http://www.netlib.org/lapack/">LAPACK
172− reference</link> (also provides BLAS)
173− </para>
174− <para>
175− The Nixpkgs attribute is <literal>lapack-reference</literal>.
176− </para>
177− </listitem>
178− <listitem>
179− <para>
180− <link
181− xlink:href="https://software.intel.com/en-us/mkl">Intel
182− MKL</link> (only works on the x86_64 architecture, unfree)
183− </para>
184− <para>
185− The Nixpkgs attribute is <literal>mkl</literal>.
186− </para>
187− </listitem>
188− <listitem>
189− <para>
190− <link
191− xlink:href="https://github.com/flame/blis">BLIS</link>
192− </para>
193− <para>
194− BLIS, available through the attribute
195− <literal>blis</literal>, is a framework for linear algebra kernels. In
196− addition, it implements the BLAS interface.
197− </para>
198− </listitem>
199− <listitem>
200− <para>
201− <link
202− xlink:href="https://developer.amd.com/amd-aocl/blas-library/">AMD
203− BLIS/LIBFLAME</link> (optimized for modern AMD x86_64 CPUs)
204− </para>
205− <para>
206− The AMD fork of the BLIS library, with attribute
207− <literal>amd-blis</literal>, extends BLIS with optimizations for
208− modern AMD CPUs. The changes are usually submitted to
209− the upstream BLIS project after some time. However, AMD BLIS
210− typically provides some performance improvements on AMD Zen CPUs.
211− The complementary AMD LIBFLAME library, with attribute
212− <literal>amd-libflame</literal>, provides a LAPACK implementation.
213− </para>
214− </listitem>
215− </itemizedlist>
216− <para>
217− Introduced in <link
218− xlink:href="https://github.com/NixOS/nixpkgs/pull/83888">PR
219− #83888</link>, we are able to override the <literal>blas</literal>
220− and <literal>lapack</literal> packages to use different implementations,
221− through the <literal>blasProvider</literal> and
222− <literal>lapackProvider</literal> argument. This can be used
223− to select a different provider. BLAS providers will have
224− symlinks in <literal>$out/lib/libblas.so.3</literal> and
225− <literal>$out/lib/libcblas.so.3</literal> to their respective
226− BLAS libraries. Likewise, LAPACK providers will have symlinks
227− in <literal>$out/lib/liblapack.so.3</literal> and
228− <literal>$out/lib/liblapacke.so.3</literal> to their respective
229− LAPACK libraries. For example, Intel MKL is both a BLAS and
230− LAPACK provider. An overlay can be created to use Intel MKL
231− that looks like:
232− </para>
233− <programlisting>
234−self: super:
235−
236−{
237− blas = super.blas.override {
238− blasProvider = self.mkl;
239− }
240− lapack = super.lapack.override {
241− lapackProvider = self.mkl;
242− }
243−}
244−</programlisting>
245− <para>
246− This overlay uses Intel’s MKL library for both BLAS and LAPACK
247− interfaces. Note that the same can be accomplished at runtime
248− using <literal>LD_LIBRARY_PATH</literal> of
249− <literal>libblas.so.3</literal> and
250− <literal>liblapack.so.3</literal>. For instance:
251− </para>
252−<screen>
253−<prompt>$ </prompt>LD_LIBRARY_PATH=$(nix-build -A mkl)/lib:$LD_LIBRARY_PATH nix-shell -p octave --run octave
254−</screen>
255− <para>
256− Intel MKL requires an <literal>openmp</literal> implementation
257− when running with multiple processors. By default,
258− <literal>mkl</literal> will use Intel’s <literal>iomp</literal>
259− implementation if no other is specified, but this is a
260− runtime-only dependency and binary compatible with the LLVM
261− implementation. To use that one instead, Intel recommends users
262− set it with <literal>LD_PRELOAD</literal>. Note that
263− <literal>mkl</literal> is only available on
264− <literal>x86_64-linux</literal> and
265− <literal>x86_64-darwin</literal>. Moreover, Hydra is not
266− building and distributing pre-compiled binaries using it.
267− </para>
268− <para>
269− For BLAS/LAPACK switching to work correctly, all packages must
270− depend on <literal>blas</literal> or <literal>lapack</literal>.
271− This ensures that only one BLAS/LAPACK library is used at one
272− time. There are two versions versions of BLAS/LAPACK currently
273− in the wild, <literal>LP64</literal> (integer size = 32 bits)
274− and <literal>ILP64</literal> (integer size = 64 bits). Some
275− software needs special flags or patches to work with
276− <literal>ILP64</literal>. You can check if
277− <literal>ILP64</literal> is used in Nixpkgs with
278− <varname>blas.isILP64</varname> and
279− <varname>lapack.isILP64</varname>. Some software does NOT work
280− with <literal>ILP64</literal>, and derivations need to specify
281− an assertion to prevent this. You can prevent
282− <literal>ILP64</literal> from being used with the following:
283− </para>
284− <programlisting>
285−{ stdenv, blas, lapack, ... }:
286−
287−assert (!blas.isILP64) && (!lapack.isILP64);
288−
289−stdenv.mkDerivation {
290− ...
291−}
292−</programlisting>
293− </section>
294− </section>
295−</chapter>
doc/using/overrides.chapter.mdnew file+108
This diff is too big to show here.
doc/using/overrides.xmldeleted−145
This diff is too big to show here.
flake.nix+9−35
This diff is too big to show here.
lib/asserts.nix+10−12
This diff is too big to show here.
lib/attrsets.nix+162−29
This diff is too big to show here.
lib/customisation.nix+55−6
This diff is too big to show here.
lib/debug.nix+22
This diff is too big to show here.
lib/default.nix+27−16
This diff is too big to show here.
lib/deprecated.nix+5−5
This diff is too big to show here.
lib/fixed-points.nix+5−5
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.nix+101−5
This diff is too big to show here.
lib/licenses.nix+273−139
This diff is too big to show here.
lib/lists.nix+15−15
This diff is too big to show here.
lib/meta.nix+54−1
This diff is too big to show here.
lib/modules.nix+363−101
This diff is too big to show here.
lib/options.nix+84−19
This diff is too big to show here.
lib/sources.nix+177−72
This diff is too big to show here.
lib/strings.nix+217−13
This diff is too big to show here.
lib/systems/architectures.nix+1−1
This diff is too big to show here.
lib/systems/default.nix+52−7
This diff is too big to show here.
lib/systems/doubles.nix+46−25
This diff is too big to show here.
lib/systems/examples.nix+98−45
This diff is too big to show here.
lib/systems/inspect.nix+11−1
This diff is too big to show here.
lib/systems/parse.nix+43−13
This diff is too big to show here.
lib/systems/platforms.nix+406−338
This diff is too big to show here.
lib/systems/supported.nixnew file+26
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.nix+6−2
This diff is too big to show here.
lib/tests/misc.nix+531−2
This diff is too big to show here.
lib/tests/modules.sh+184−115
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/declare-attrsOf.nix+8−1
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-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.nix+1−3
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/define-bare-submodule-values.nixnew file+4
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-variant.nixnew file+22
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-nested.nix+8−1
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/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/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/functions.nix+9−3
This diff is too big to show here.
lib/tests/release.nix+9−1
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.nix+7−4
This diff is too big to show here.
lib/trivial.nix+131−10
This diff is too big to show here.
lib/types.nix+186−57
This diff is too big to show here.
maintainers/maintainer-list.nix+4475−255
This diff is too big to show here.
maintainers/scripts/build.nix+10−2
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.sh+9−9
This diff is too big to show here.
maintainers/scripts/copy-tarballs.pl+15−1
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/dep-licenses.sh+1−1
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/feature-freeze-teams.plnew file+98
This diff is too big to show here.
maintainers/scripts/fetch-kde-qt.sh+4−5
This diff is too big to show here.
maintainers/scripts/find-tarballs.nix+1−1
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/luarocks-packages.csv+87−86
This diff is too big to show here.
maintainers/scripts/nix-generate-from-cpan.nix+3−3
This diff is too big to show here.
maintainers/scripts/nix-generate-from-cpan.pl+3−3
This diff is too big to show here.
maintainers/scripts/nixpkgs-lint.nix+6−5
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.sh+86−79
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-luarocks-packages+207−125
This diff is too big to show here.
maintainers/scripts/update-luarocks-shell.nix+7−3
This diff is too big to show here.
maintainers/scripts/update-ruby-packages+4−1
This diff is too big to show here.
maintainers/scripts/update.nix+17−5
This diff is too big to show here.
maintainers/scripts/update.py+8−1
This diff is too big to show here.
maintainers/scripts/vanity.sh+19−19
This diff is too big to show here.
maintainers/team-list.nix+555−6
This diff is too big to show here.
nixos/default.nix+1−19
This diff is too big to show here.
nixos/doc/manual/Makefile+1−1
This diff is too big to show here.
nixos/doc/manual/READMEdeleted−3
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/boot-problems.xmldeleted−126
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/cleaning-store.xmldeleted−63
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/container-networking.xmldeleted−59
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/containers.xmldeleted−34
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/control-groups.xmldeleted−65
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/declarative-containers.xmldeleted−60
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/imperative-containers.xmldeleted−123
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/logging.xmldeleted−43
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/maintenance-mode.xmldeleted−16
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/network-problems.xmldeleted−27
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/rebooting.xmldeleted−35
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/rollback.xmldeleted−41
This diff is too big to show here.
nixos/doc/manual/administration/running.xml+8−8
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/service-mgmt.xmldeleted−140
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/store-corruption.xmldeleted−36
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/troubleshooting.xmldeleted−16
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/administration/user-sessions.xmldeleted−45
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/abstractions.xmldeleted−101
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-network-config.xmldeleted−20
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/ad-hoc-packages.xmldeleted−61
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/adding-custom-packages.xmldeleted−73
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-file.xmldeleted−215
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/config-syntax.xmldeleted−25
This diff is too big to show here.
nixos/doc/manual/configuration/configuration.xml+13−13
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/customizing-packages.xmldeleted−86
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/declarative-packages.xmldeleted−54
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/file-systems.xmldeleted−57
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/firewall.xmldeleted−37
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/gpu-accel.xmldeleted−263
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/ipv4-config.xmldeleted−43
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/ipv6-config.xmldeleted−50
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/kubernetes.xmldeleted−112
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/linux-kernel.xmldeleted−138
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/luks-file-systems.xmldeleted−74
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/modularity.xmldeleted−146
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/network-manager.xmldeleted−48
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/networking.xmldeleted−19
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/package-mgmt.xmldeleted−31
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.xmldeleted−39
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/all-hardware.xmldeleted−21
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/base.xmldeleted−15
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/clone-config.xmldeleted−21
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/demo.xmldeleted−14
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/docker-container.xmldeleted−16
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/graphical.xmldeleted−20
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/hardened.xmldeleted−24
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/headless.xmldeleted−19
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/installation-device.xmldeleted−36
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/minimal.xmldeleted−17
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/profiles/qemu-guest.xmldeleted−18
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/ssh.xmldeleted−27
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/subversion.xmldeleted−140
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/summary.xmldeleted−227
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/user-mgmt.xmldeleted−88
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/wayland.xmldeleted−23
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/wireless.xmldeleted−70
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/x-windows.xmldeleted−341
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/configuration/xfce.xmldeleted−59
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/contributing-to-this-manual.xmldeleted−22
This diff is too big to show here.
nixos/doc/manual/default.nix+19−6
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/assertions.xmldeleted−74
This diff is too big to show here.
nixos/doc/manual/development/building-nixos.xmldeleted−33
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/building-parts.xmldeleted−121
This diff is too big to show here.
nixos/doc/manual/development/development.xml+7−8
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/freeform-modules.xmldeleted−68
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/importing-modules.xmldeleted−56
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/meta-attributes.xmldeleted−63
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/nixos-tests.xmldeleted−19
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-declarations.xmldeleted−199
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-def.xmldeleted−99
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/option-types.xmldeleted−914
This diff is too big to show here.
nixos/doc/manual/development/releases.xmldeleted−366
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/replace-modules.xmldeleted−79
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-interactively.xmldeleted−49
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/running-nixos-tests.xmldeleted−36
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/settings-options.xmldeleted−216
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/sources.xmldeleted−85
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/testing-installer.xmldeleted−22
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-documentation.xmldeleted−149
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-modules.xmldeleted−188
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/development/writing-nixos-tests.xmldeleted−453
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/changing-config.xmldeleted−97
This diff is too big to show here.
nixos/doc/manual/installation/installation.xml+5−4
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-behind-a-proxy.xmldeleted−48
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-from-other-distro.xmldeleted−364
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-pxe.xmldeleted−50
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-usb.xmldeleted−40
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-virtualbox-guest.xmldeleted−108
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/installing.xmldeleted−573
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/obtaining.xmldeleted−54
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/installation/upgrading.xmldeleted−139
This diff is too big to show here.
nixos/doc/manual/man-nixos-install.xml+9−4
This diff is too big to show here.
nixos/doc/manual/man-nixos-rebuild.xml+68−11
This diff is too big to show here.
nixos/doc/manual/man-pages.xml+7−2
This diff is too big to show here.
nixos/doc/manual/manual.xml+1−1
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.xml+9−4
This diff is too big to show here.
nixos/doc/manual/release-notes/release-notes.xml+17−15
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-1310.xmldeleted−11
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-1404.xmldeleted−179
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-1412.xmldeleted−467
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-1509.xmldeleted−750
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-1603.xmldeleted−671
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-1609.xmldeleted−277
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-1703.xmldeleted−817
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-1709.xmldeleted−899
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-1803.xmldeleted−855
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-1809.xmldeleted−933
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-1903.xmldeleted−768
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-1909.xmldeleted−902
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-2003.xmldeleted−1243
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-2009.xmldeleted−1820
This diff is too big to show here.
nixos/doc/manual/release-notes/rl-2103.xmldeleted−451
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.nix+1−1
This diff is too big to show here.
nixos/lib/build-vms.nix+23−9
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.nix+54−16
This diff is too big to show here.
nixos/lib/make-disk-image.nix+139−29
This diff is too big to show here.
nixos/lib/make-ext4-fs.nix+3−5
This diff is too big to show here.
nixos/lib/make-iso9660-image.sh+1
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.nix+79−78
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.xsl+30−20
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/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.nix+8−1
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/qemu-flags.nixdeleted−30
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.pydeleted−966
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.nix+186−237
This diff is too big to show here.
nixos/lib/utils.nix+78−6
This diff is too big to show here.
nixos/maintainers/scripts/azure-new/examples/basic/image.nix+1−1
This diff is too big to show here.
nixos/maintainers/scripts/azure-new/examples/basic/system.nix+1−1
This diff is too big to show here.
nixos/maintainers/scripts/cloudstack/cloudstack-image.nix−1
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.nix+100−29
This diff is too big to show here.
nixos/maintainers/scripts/ec2/create-amis.sh+84−46
This diff is too big to show here.
nixos/maintainers/scripts/gce/create-gce.sh+12
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.nix+10−9
This diff is too big to show here.
nixos/modules/config/console.nix+40−16
This diff is too big to show here.
nixos/modules/config/fonts/fontconfig.nix+36−18
This diff is too big to show here.
nixos/modules/config/fonts/fontdir.nix+2−2
This diff is too big to show here.
nixos/modules/config/fonts/fonts.nix+46−21
This diff is too big to show here.
nixos/modules/config/gnu.nix+4−6
This diff is too big to show here.
nixos/modules/config/gtk/gtk-icon-cache.nix+1
This diff is too big to show here.
nixos/modules/config/i18n.nix+8−2
This diff is too big to show here.
nixos/modules/config/iproute2.nix+9−9
This diff is too big to show here.
nixos/modules/config/krb5/default.nix+8−8
This diff is too big to show here.
nixos/modules/config/ldap.nix+1−1
This diff is too big to show here.
nixos/modules/config/malloc.nix+28−2
This diff is too big to show here.
nixos/modules/config/networking.nix+15−7
This diff is too big to show here.
nixos/modules/config/no-x-libs.nix+1
This diff is too big to show here.
nixos/modules/config/nsswitch.nix+9−6
This diff is too big to show here.
nixos/modules/config/power-management.nix+2−2
This diff is too big to show here.
nixos/modules/config/pulseaudio.nix+13−12
This diff is too big to show here.
nixos/modules/config/resolvconf.nix+2−4
This diff is too big to show here.
nixos/modules/config/shells-environment.nix+15−5
This diff is too big to show here.
nixos/modules/config/swap.nix+34−9
This diff is too big to show here.
nixos/modules/config/sysctl.nix+1−1
This diff is too big to show here.
nixos/modules/config/system-environment.nix+34−36
This diff is too big to show here.
nixos/modules/config/system-path.nix+31−12
This diff is too big to show here.
nixos/modules/config/terminfo.nix+25−1
This diff is too big to show here.
nixos/modules/config/unix-odbc-drivers.nix+1−1
This diff is too big to show here.
nixos/modules/config/update-users-groups.pl+39−17
This diff is too big to show here.
nixos/modules/config/users-groups.nix+110−53
This diff is too big to show here.
nixos/modules/config/xdg/mime.nix+64−2
This diff is too big to show here.
nixos/modules/config/xdg/portal.nix+23−12
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/hardware/all-firmware.nix+25−7
This diff is too big to show here.
nixos/modules/hardware/ckb-next.nix+1−1
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/intel-sgx.nixnew file+69
This diff is too big to show here.
nixos/modules/hardware/device-tree.nix+9−9
This diff is too big to show here.
nixos/modules/hardware/digitalbitbox.nix+1−1
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.nix−3
This diff is too big to show here.
nixos/modules/hardware/ksm.nix+6−6
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.nix−4
This diff is too big to show here.
nixos/modules/hardware/nitrokey.nix+1−15
This diff is too big to show here.
nixos/modules/hardware/onlykey.udevdeleted−4
This diff is too big to show here.
nixos/modules/hardware/onlykey.nix → nixos/modules/hardware/onlykey/default.nixrenamed
The content is the same.
nixos/modules/hardware/onlykey/onlykey.udevnew file+18
This diff is too big to show here.
nixos/modules/hardware/opengl.nix+3−4
This diff is too big to show here.
nixos/modules/hardware/openrazer.nix+18−5
This diff is too big to show here.
nixos/modules/hardware/opentabletdriver.nix+14−3
This diff is too big to show here.
nixos/modules/hardware/pcmcia.nix+1
This diff is too big to show here.
nixos/modules/hardware/printers.nix+7−12
This diff is too big to show here.
nixos/modules/hardware/raid/hpsa.nix+4−1
This diff is too big to show here.
nixos/modules/hardware/rtl-sdr.nix+9−6
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.nix+1−1
This diff is too big to show here.
nixos/modules/hardware/system-76.nix+36−3
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/video/amdgpu-pro.nix+25−22
This diff is too big to show here.
nixos/modules/hardware/video/amdgpu.nixdeleted−9
This diff is too big to show here.
nixos/modules/hardware/video/ati.nixdeleted−40
This diff is too big to show here.
nixos/modules/hardware/video/bumblebee.nix+1−1
This diff is too big to show here.
nixos/modules/hardware/video/capture/mwprocapture.nix−5
This diff is too big to show here.
nixos/modules/hardware/video/nvidia.nix+140−52
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.nix+1−1
This diff is too big to show here.
nixos/modules/hardware/video/webcam/facetimehd.nix+14−6
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.nix+1−1
This diff is too big to show here.
nixos/modules/i18n/input-method/default.nix+3−1
This diff is too big to show here.
nixos/modules/i18n/input-method/default.xml+22
This diff is too big to show here.
nixos/modules/i18n/input-method/fcitx.nix+4−1
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/ibus.nix+5−2
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/installer/cd-dvd/channel.nix+2−1
This diff is too big to show here.
nixos/modules/installer/cd-dvd/installation-cd-base.nix+16
This diff is too big to show here.
nixos/modules/installer/cd-dvd/installation-cd-graphical-base.nix+14−8
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.nix+4−6
This diff is too big to show here.
nixos/modules/installer/cd-dvd/installation-cd-graphical-plasma5.nix+1−3
This diff is too big to show here.
nixos/modules/installer/cd-dvd/iso-image.nix+188−89
This diff is too big to show here.
nixos/modules/installer/cd-dvd/sd-image-aarch64-new-kernel.nix+12−5
This diff is too big to show here.
nixos/modules/installer/cd-dvd/sd-image-aarch64.nix+9−55
This diff is too big to show here.
nixos/modules/installer/cd-dvd/sd-image-armv7l-multiplatform.nix+9−52
This diff is too big to show here.
nixos/modules/installer/cd-dvd/sd-image-raspberrypi.nix+9−41
This diff is too big to show here.
nixos/modules/installer/cd-dvd/sd-image-raspberrypi4.nixdeleted−38
This diff is too big to show here.
nixos/modules/installer/cd-dvd/sd-image.nix+8−239
This diff is too big to show here.
nixos/modules/installer/cd-dvd/system-tarball-fuloong2f.nix+3−3
This diff is too big to show here.
nixos/modules/installer/cd-dvd/system-tarball-pc.nix+3−3
This diff is too big to show here.
nixos/modules/installer/cd-dvd/system-tarball-sheevaplug.nix+5−5
This diff is too big to show here.
nixos/modules/installer/cd-dvd/system-tarball.nix+2−2
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.nix+14−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/nix-fallback-paths.nix+5−4
This diff is too big to show here.
nixos/modules/installer/tools/nixos-build-vms/build-vms.nix+18−5
This diff is too big to show here.
nixos/modules/installer/tools/nixos-build-vms/nixos-build-vms.sh+4−3
This diff is too big to show here.
nixos/modules/installer/tools/nixos-enter.sh+36−1
This diff is too big to show here.
nixos/modules/installer/tools/nixos-generate-config.pl+42−6
This diff is too big to show here.
nixos/modules/installer/tools/nixos-install.sh+20−19
This diff is too big to show here.
nixos/modules/installer/tools/nixos-option/default.nix+1−11
This diff is too big to show here.
nixos/modules/installer/tools/nixos-rebuild.shdeleted−506
This diff is too big to show here.
nixos/modules/installer/tools/nixos-version.sh+1
This diff is too big to show here.
nixos/modules/installer/tools/tools.nix+39−21
This diff is too big to show here.
nixos/modules/installer/virtualbox-demo.nix+2−2
This diff is too big to show here.
nixos/modules/misc/crashdump.nix+3−2
This diff is too big to show here.
nixos/modules/misc/documentation.nix+131−55
This diff is too big to show here.
nixos/modules/misc/extra-arguments.nix+2−2
This diff is too big to show here.
nixos/modules/misc/ids.nix+75−62
This diff is too big to show here.
nixos/modules/misc/locate.nix+134−69
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.nix+18−3
This diff is too big to show here.
nixos/modules/misc/nixpkgs.nix+18−10
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/version.nix+52−18
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.nix+265−56
This diff is too big to show here.
nixos/modules/profiles/all-hardware.nix+70−4
This diff is too big to show here.
nixos/modules/profiles/base.nix+1
This diff is too big to show here.
nixos/modules/profiles/hardened.nix+8−4
This diff is too big to show here.
nixos/modules/profiles/headless.nix+1−1
This diff is too big to show here.
nixos/modules/profiles/installation-device.nix+20−2
This diff is too big to show here.
nixos/modules/profiles/minimal.nix+2
This diff is too big to show here.
nixos/modules/profiles/qemu-guest.nix+2−4
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.nix+1−2
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.nix+127−8
This diff is too big to show here.
nixos/modules/programs/bandwhich.nix+3−1
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.nix+10−43
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.nix+3−3
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.nix+75−45
This diff is too big to show here.
nixos/modules/programs/ccache.nix+3−1
This diff is too big to show here.
nixos/modules/programs/cdemu.nix+3
This diff is too big to show here.
nixos/modules/programs/chromium.nix+13−2
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.nix+9−9
This diff is too big to show here.
nixos/modules/programs/command-not-found/command-not-found.pl+43−17
This diff is too big to show here.
nixos/modules/programs/dconf.nix+3−1
This diff is too big to show here.
nixos/modules/programs/digitalbitbox/default.nix+1−1
This diff is too big to show here.
nixos/modules/programs/dmrconfig.nix+1−1
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.nix+9−2
This diff is too big to show here.
nixos/modules/programs/evince.nix+13−4
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.nix+13−4
This diff is too big to show here.
nixos/modules/programs/firejail.nix+15−8
This diff is too big to show here.
nixos/modules/programs/fish.nix+194−121
This diff is too big to show here.
nixos/modules/programs/fish_completion-generator.patch+10−9
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.nix+1−1
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.nix+3−3
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.nix+2−2
This diff is too big to show here.
nixos/modules/programs/gnome-documents.nix+5−5
This diff is too big to show here.
nixos/modules/programs/gnome-terminal.nix+3−3
This diff is too big to show here.
nixos/modules/programs/gnupg.nix+4−1
This diff is too big to show here.
nixos/modules/programs/gpaste.nix+4−4
This diff is too big to show here.
nixos/modules/programs/hamster.nix+1−1
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.nix+3−1
This diff is too big to show here.
nixos/modules/programs/iotop.nix+3−1
This diff is too big to show here.
nixos/modules/programs/java.nix+1−1
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.nix+6−1
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.nix+9−6
This diff is too big to show here.
nixos/modules/programs/liboping.nix+3−1
This diff is too big to show here.
nixos/modules/programs/mininet.nix+3−3
This diff is too big to show here.
nixos/modules/programs/mosh.nix+1−1
This diff is too big to show here.
nixos/modules/programs/msmtp.nix+2
This diff is too big to show here.
nixos/modules/programs/mtr.nix+4−1
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.nix+29−28
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/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.nix+3−2
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.nix+1−1
This diff is too big to show here.
nixos/modules/programs/proxychains.nix+1−1
This diff is too big to show here.
nixos/modules/programs/qt5ct.nix+1−1
This diff is too big to show here.
nixos/modules/programs/seahorse.nix+3−3
This diff is too big to show here.
nixos/modules/programs/shadow.nix+15−8
This diff is too big to show here.
nixos/modules/programs/singularity.nix+6−1
This diff is too big to show here.
nixos/modules/programs/slock.nix+6−1
This diff is too big to show here.
nixos/modules/programs/spacefm.nix+6−6
This diff is too big to show here.
nixos/modules/programs/ssh.nix+73−19
This diff is too big to show here.
nixos/modules/programs/ssmtp.nixdeleted−187
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.nix+40−2
This diff is too big to show here.
nixos/modules/programs/sway.nix+29−16
This diff is too big to show here.
nixos/modules/programs/thefuck.nix+7−6
This diff is too big to show here.
nixos/modules/programs/tmux.nix+14−1
This diff is too big to show here.
nixos/modules/programs/traceroute.nix+3−1
This diff is too big to show here.
nixos/modules/programs/tsm-client.nix+8−8
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.nix+6−1
This diff is too big to show here.
nixos/modules/programs/venus.nixdeleted−173
This diff is too big to show here.
nixos/modules/programs/vim.nix+2−2
This diff is too big to show here.
nixos/modules/programs/wavemon.nix+3−1
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.nix+1−1
This diff is too big to show here.
nixos/modules/programs/wshowkeys.nix+6−1
This diff is too big to show here.
nixos/modules/programs/xonsh.nix+2−1
This diff is too big to show here.
nixos/modules/programs/xss-lock.nix+2−1
This diff is too big to show here.
nixos/modules/programs/xwayland.nix+13−8
This diff is too big to show here.
nixos/modules/programs/yabar.nix+2−1
This diff is too big to show here.
nixos/modules/programs/zsh/oh-my-zsh.nix+1−1
This diff is too big to show here.
nixos/modules/programs/zsh/zsh-autoenv.nix+1−1
This diff is too big to show here.
nixos/modules/programs/zsh/zsh-autosuggestions.nix+20−11
This diff is too big to show here.
nixos/modules/programs/zsh/zsh-syntax-highlighting.nix+2−2
This diff is too big to show here.
nixos/modules/programs/zsh/zsh.nix+14−6
This diff is too big to show here.
nixos/modules/rename.nix+63−36
This diff is too big to show here.
nixos/modules/security/acme.nixdeleted−689
This diff is too big to show here.
nixos/modules/security/acme.xmldeleted−290
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-suid.nixdeleted−49
This diff is too big to show here.
nixos/modules/security/apparmor.nix+208−51
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/ca.nix+11−17
This diff is too big to show here.
nixos/modules/security/chromium-suid-sandbox.nix+6−1
This diff is too big to show here.
nixos/modules/security/dhparams.nix+5−3
This diff is too big to show here.
nixos/modules/security/doas.nix+8−5
This diff is too big to show here.
nixos/modules/security/duosec.nix+6−1
This diff is too big to show here.
nixos/modules/security/google_oslogin.nix+6−3
This diff is too big to show here.
nixos/modules/security/hidepid.nixdeleted−31
This diff is too big to show here.
nixos/modules/security/hidepid.xmldeleted−28
This diff is too big to show here.
nixos/modules/security/lock-kernel-modules.nix+19−9
This diff is too big to show here.
nixos/modules/security/misc.nix+6−2
This diff is too big to show here.
nixos/modules/security/pam.nix+504−145
This diff is too big to show here.
nixos/modules/security/pam_mount.nix+102−7
This diff is too big to show here.
nixos/modules/security/pam_usb.nix+12−2
This diff is too big to show here.
nixos/modules/security/polkit.nix+15−7
This diff is too big to show here.
nixos/modules/security/rngd.nix+12−52
This diff is too big to show here.
nixos/modules/security/rtkit.nix+4−1
This diff is too big to show here.
nixos/modules/security/sudo.nix+28−6
This diff is too big to show here.
nixos/modules/security/systemd-confinement.nix+7−9
This diff is too big to show here.
nixos/modules/security/tpm2.nix+5−5
This diff is too big to show here.
nixos/modules/security/wrappers/default.nix+197−106
This diff is too big to show here.
nixos/modules/security/wrappers/wrapper.c+162−168
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.nix+2−2
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/amqp/activemq/default.nix+3−1
This diff is too big to show here.
nixos/modules/services/amqp/rabbitmq.nix+26−9
This diff is too big to show here.
nixos/modules/services/audio/alsa.nix+9−9
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.nix+1
This diff is too big to show here.
nixos/modules/services/audio/jack.nix+8−8
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.nix+3−3
This diff is too big to show here.
nixos/modules/services/audio/mopidy.nix+1−1
This diff is too big to show here.
nixos/modules/services/audio/mpd.nix+65−57
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.nix+9−4
This diff is too big to show here.
nixos/modules/services/audio/slimserver.nix+2−1
This diff is too big to show here.
nixos/modules/services/audio/snapserver.nix+55−24
This diff is too big to show here.
nixos/modules/services/audio/spotifyd.nix+27−1
This diff is too big to show here.
nixos/modules/services/audio/squeezelite.nix+17−21
This diff is too big to show here.
nixos/modules/services/audio/ympd.nix+1−1
This diff is too big to show here.
nixos/modules/services/backup/automysqlbackup.nix+3−2
This diff is too big to show here.
nixos/modules/services/backup/bacula.nix+24−2
This diff is too big to show here.
nixos/modules/services/backup/borgbackup.nix+78−23
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.nix+31−12
This diff is too big to show here.
nixos/modules/services/backup/duplicity.nix+73−18
This diff is too big to show here.
nixos/modules/services/backup/mysql-backup.nix+8−3
This diff is too big to show here.
nixos/modules/services/backup/postgresql-backup.nix+47−9
This diff is too big to show here.
nixos/modules/services/backup/postgresql-wal-receiver.nix+5−5
This diff is too big to show here.
nixos/modules/services/backup/restic-rest-server.nix+5−1
This diff is too big to show here.
nixos/modules/services/backup/restic.nix+27−10
This diff is too big to show here.
nixos/modules/services/backup/sanoid.nix+143−152
This diff is too big to show here.
nixos/modules/services/backup/syncoid.nix+390−185
This diff is too big to show here.
nixos/modules/services/backup/tarsnap.nix+29−27
This diff is too big to show here.
nixos/modules/services/backup/tsm.nix+33−14
This diff is too big to show here.
nixos/modules/services/backup/znapzend.nix+8−8
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.nix+25−12
This diff is too big to show here.
nixos/modules/services/cluster/hadoop/default.nix+180−25
This diff is too big to show here.
nixos/modules/services/cluster/hadoop/hdfs.nix+175−44
This diff is too big to show here.
nixos/modules/services/cluster/hadoop/yarn.nix+155−29
This diff is too big to show here.
nixos/modules/services/cluster/k3s/default.nix+36−13
This diff is too big to show here.
nixos/modules/services/cluster/kubernetes/addon-manager.nix+8−4
This diff is too big to show here.
nixos/modules/services/cluster/kubernetes/addons/dashboard.nixdeleted−332
This diff is too big to show here.
nixos/modules/services/cluster/kubernetes/addons/dns.nix+53−19
This diff is too big to show here.
nixos/modules/services/cluster/kubernetes/apiserver.nix+47−16
This diff is too big to show here.
nixos/modules/services/cluster/kubernetes/controller-manager.nix+11−2
This diff is too big to show here.
nixos/modules/services/cluster/kubernetes/default.nix+39−11
This diff is too big to show here.
nixos/modules/services/cluster/kubernetes/flannel.nix+6−40
This diff is too big to show here.
nixos/modules/services/cluster/kubernetes/kubelet.nix+58−10
This diff is too big to show here.
nixos/modules/services/cluster/kubernetes/pki.nix+6−1
This diff is too big to show here.
nixos/modules/services/cluster/kubernetes/proxy.nix+11−3
This diff is too big to show here.
nixos/modules/services/cluster/kubernetes/scheduler.nix+11−4
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.nix+2−2
This diff is too big to show here.
nixos/modules/services/computing/foldingathome/client.nix+11−1
This diff is too big to show here.
nixos/modules/services/computing/slurm/slurm.nix+32−16
This diff is too big to show here.
nixos/modules/services/continuous-integration/buildbot/master.nix+13−9
This diff is too big to show here.
nixos/modules/services/continuous-integration/buildbot/worker.nix+7−5
This diff is too big to show here.
nixos/modules/services/continuous-integration/buildkite-agents.nix+12−8
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.nix+24−11
This diff is too big to show here.
nixos/modules/services/continuous-integration/gocd-agent/default.nix+14−2
This diff is too big to show here.
nixos/modules/services/continuous-integration/gocd-server/default.nix+20−2
This diff is too big to show here.
nixos/modules/services/continuous-integration/hail.nix+1−1
This diff is too big to show here.
nixos/modules/services/continuous-integration/hercules-ci-agent/common.nix+137−84
This diff is too big to show here.
nixos/modules/services/continuous-integration/hercules-ci-agent/default.nix+25−9
This diff is too big to show here.
nixos/modules/services/continuous-integration/hydra/default.nix+41−18
This diff is too big to show here.
nixos/modules/services/continuous-integration/jenkins/default.nix+30−9
This diff is too big to show here.
nixos/modules/services/continuous-integration/jenkins/job-builder.nix+52−16
This diff is too big to show here.
nixos/modules/services/continuous-integration/jenkins/slave.nix+15−1
This diff is too big to show here.
nixos/modules/services/databases/aerospike.nix+1−1
This diff is too big to show here.
nixos/modules/services/databases/cassandra.nix+245−174
This diff is too big to show here.
nixos/modules/services/databases/clickhouse.nix+14−4
This diff is too big to show here.
nixos/modules/services/databases/cockroachdb.nix+38−30
This diff is too big to show here.
nixos/modules/services/databases/couchdb.nix+27−20
This diff is too big to show here.
nixos/modules/services/databases/firebird.nix+19−12
This diff is too big to show here.
nixos/modules/services/databases/hbase.nix+39−17
This diff is too big to show here.
nixos/modules/services/databases/influxdb.nix+4−4
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.nix+12−5
This diff is too big to show here.
nixos/modules/services/databases/monetdb.nix+1−1
This diff is too big to show here.
nixos/modules/services/databases/mongodb.nix+11−2
This diff is too big to show here.
nixos/modules/services/databases/mysql.nix+192−191
This diff is too big to show here.
nixos/modules/services/databases/neo4j.nix+16−6
This diff is too big to show here.
nixos/modules/services/databases/openldap.nix+8−7
This diff is too big to show here.
nixos/modules/services/databases/opentsdb.nix+1−2
This diff is too big to show here.
nixos/modules/services/databases/pgmanage.nix+2−1
This diff is too big to show here.
nixos/modules/services/databases/postgresql.nix+30−15
This diff is too big to show here.
nixos/modules/services/databases/postgresql.xml+54−32
This diff is too big to show here.
nixos/modules/services/databases/redis.nix+342−202
This diff is too big to show here.
nixos/modules/services/databases/riak.nix+1−2
This diff is too big to show here.
nixos/modules/services/databases/victoriametrics.nix+9−1
This diff is too big to show here.
nixos/modules/services/databases/virtuoso.nixdeleted−94
This diff is too big to show here.
nixos/modules/services/desktops/bamf.nix+2−2
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/espanso.nix−1
This diff is too big to show here.
nixos/modules/services/desktops/flatpak.nix+3−13
This diff is too big to show here.
nixos/modules/services/desktops/geoclue2.nix+7−5
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/gnome3/gnome-initial-setup.nix → nixos/modules/services/desktops/gnome/gnome-initial-setup.nixrenamed+12−4
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/gnome3/at-spi2-core.nixdeleted−49
This diff is too big to show here.
nixos/modules/services/desktops/gnome3/chrome-gnome-shell.nixdeleted−33
This diff is too big to show here.
nixos/modules/services/desktops/gnome3/evolution-data-server.nixdeleted−45
This diff is too big to show here.
nixos/modules/services/desktops/gnome3/glib-networking.nixdeleted−37
This diff is too big to show here.
nixos/modules/services/desktops/gnome3/gnome-keyring.nixdeleted−53
This diff is too big to show here.
nixos/modules/services/desktops/gnome3/gnome-online-accounts.nixdeleted−43
This diff is too big to show here.
nixos/modules/services/desktops/gnome3/gnome-online-miners.nixdeleted−43
This diff is too big to show here.
nixos/modules/services/desktops/gnome3/gnome-remote-desktop.nixdeleted−24
This diff is too big to show here.
nixos/modules/services/desktops/gnome3/gnome-settings-daemon.nixdeleted−78
This diff is too big to show here.
nixos/modules/services/desktops/gnome3/gnome-user-share.nixdeleted−40
This diff is too big to show here.
nixos/modules/services/desktops/gnome3/rygel.nixdeleted−36
This diff is too big to show here.
nixos/modules/services/desktops/gnome3/sushi.nixdeleted−42
This diff is too big to show here.
nixos/modules/services/desktops/gnome3/tracker-miners.nixdeleted−44
This diff is too big to show here.
nixos/modules/services/desktops/gnome3/tracker.nixdeleted−45
This diff is too big to show here.
nixos/modules/services/desktops/gsignond.nix+1−1
This diff is too big to show here.
nixos/modules/services/desktops/gvfs.nix+4−3
This diff is too big to show here.
nixos/modules/services/desktops/pantheon/files.nixdeleted−13
This diff is too big to show here.
nixos/modules/services/desktops/pipewire.nixdeleted−183
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/telepathy.nix+1−1
This diff is too big to show here.
nixos/modules/services/desktops/tumbler.nix+2−2
This diff is too big to show here.
nixos/modules/services/desktops/zeitgeist.nix+2−2
This diff is too big to show here.
nixos/modules/services/development/blackfire.nix+4−9
This diff is too big to show here.
nixos/modules/services/development/blackfire.xml+2−1
This diff is too big to show here.
nixos/modules/services/development/bloop.nix+1−1
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.nix+12−5
This diff is too big to show here.
nixos/modules/services/development/jupyter/default.nix+5−6
This diff is too big to show here.
nixos/modules/services/development/jupyter/kernel-options.nix+4−4
This diff is too big to show here.
nixos/modules/services/development/jupyterhub/default.nix+21−9
This diff is too big to show here.
nixos/modules/services/development/lorri.nix+1−2
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.nix+1−1
This diff is too big to show here.
nixos/modules/services/editors/emacs.xml+5−5
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.nix+6−6
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.nix+36−6
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.nix+29−6
This diff is too big to show here.
nixos/modules/services/games/minetest-server.nix+1−1
This diff is too big to show here.
nixos/modules/services/games/openarena.nix+1−1
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/terraria.nix+18−4
This diff is too big to show here.
nixos/modules/services/hardware/acpid.nix+16−17
This diff is too big to show here.
nixos/modules/services/hardware/actkbd.nix+2−2
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.nix+84−68
This diff is too big to show here.
nixos/modules/services/hardware/brltty.nix+32−25
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.nix+10−7
This diff is too big to show here.
nixos/modules/services/hardware/freefall.nix+1−1
This diff is too big to show here.
nixos/modules/services/hardware/fwupd.nix+2−1
This diff is too big to show here.
nixos/modules/services/hardware/interception-tools.nix+1
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/lirc.nix+1−1
This diff is too big to show here.
nixos/modules/services/hardware/pcscd.nix+45−41
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/sane.nix+40−5
This diff is too big to show here.
nixos/modules/services/hardware/sane_extra_backends/brscan4.nix+4−4
This diff is too big to show here.
nixos/modules/services/hardware/sane_extra_backends/brscan4_etc_files.nix+7−10
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/spacenavd.nixnew file+24
This diff is too big to show here.
nixos/modules/services/hardware/tcsd.nix+29−18
This diff is too big to show here.
nixos/modules/services/hardware/thermald.nix+4−2
This diff is too big to show here.
nixos/modules/services/hardware/thinkfan.nix+166−94
This diff is too big to show here.
nixos/modules/services/hardware/trezord.nix+1−1
This diff is too big to show here.
nixos/modules/services/hardware/triggerhappy.nix+2−2
This diff is too big to show here.
nixos/modules/services/hardware/udev.nix+133−9
This diff is too big to show here.
nixos/modules/services/hardware/udisks2.nix+41
This diff is too big to show here.
nixos/modules/services/hardware/undervolt.nix+2−4
This diff is too big to show here.
nixos/modules/services/hardware/upower.nix+7−8
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.nix+2−2
This diff is too big to show here.
nixos/modules/services/hardware/xow.nix+3
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.nix+1
This diff is too big to show here.
nixos/modules/services/logging/awstats.nix+4−4
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.nix+1−1
This diff is too big to show here.
nixos/modules/services/logging/graylog.nix+7−8
This diff is too big to show here.
nixos/modules/services/logging/journalbeat.nix+4−17
This diff is too big to show here.
nixos/modules/services/logging/journalwatch.nix+1
This diff is too big to show here.
nixos/modules/services/logging/klogd.nix+6−34
This diff is too big to show here.
nixos/modules/services/logging/logcheck.nix+6−2
This diff is too big to show here.
nixos/modules/services/logging/logrotate.nix+267−33
This diff is too big to show here.
nixos/modules/services/logging/logstash.nix+26−13
This diff is too big to show here.
nixos/modules/services/logging/promtail.nix+6−1
This diff is too big to show here.
nixos/modules/services/logging/syslog-ng.nix+2−2
This diff is too big to show here.
nixos/modules/services/logging/vector.nix+23−20
This diff is too big to show here.
nixos/modules/services/mail/davmail.nix+1−1
This diff is too big to show here.
nixos/modules/services/mail/dovecot.nix+21−50
This diff is too big to show here.
nixos/modules/services/mail/exim.nix+16−4
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.nix+2−1
This diff is too big to show here.
nixos/modules/services/mail/mailman.nix+23−13
This diff is too big to show here.
nixos/modules/services/mail/mailman.xml+3−3
This diff is too big to show here.
nixos/modules/services/mail/mlmmj.nix+30−13
This diff is too big to show here.
nixos/modules/services/mail/nullmailer.nix+2−1
This diff is too big to show here.
nixos/modules/services/mail/offlineimap.nix+2−2
This diff is too big to show here.
nixos/modules/services/mail/opendkim.nix+2−1
This diff is too big to show here.
nixos/modules/services/mail/opensmtpd.nix+5−2
This diff is too big to show here.
nixos/modules/services/mail/postfix.nix+55−35
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.nix+1−1
This diff is too big to show here.
nixos/modules/services/mail/roundcube.nix+5−4
This diff is too big to show here.
nixos/modules/services/mail/rspamd.nix+10−12
This diff is too big to show here.
nixos/modules/services/mail/spamassassin.nix+36−29
This diff is too big to show here.
nixos/modules/services/mail/sympa.nix+4−4
This diff is too big to show here.
nixos/modules/services/misc/matrix-synapse-log_config.yaml → nixos/modules/services/matrix/matrix-synapse-log_config.yamlrenamed
The content is the same.
nixos/modules/services/matrix/matrix-synapse.nixnew file+773
This diff is too big to show here.
nixos/modules/services/misc/matrix-synapse.xml → nixos/modules/services/matrix/matrix-synapse.xmlrenamed+25−21
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.nix+32−8
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.nix+1−1
This diff is too big to show here.
nixos/modules/services/misc/apache-kafka.nix+13−16
This diff is too big to show here.
nixos/modules/services/misc/autofs.nix+2−1
This diff is too big to show here.
nixos/modules/services/misc/autorandr.nix+309−2
This diff is too big to show here.
nixos/modules/services/misc/bazarr.nix+1
This diff is too big to show here.
nixos/modules/services/misc/bees.nix+44−35
This diff is too big to show here.
nixos/modules/services/misc/cfdyndns.nix+1−1
This diff is too big to show here.
nixos/modules/services/misc/cgminer.nix+11−3
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.nix+1−1
This diff is too big to show here.
nixos/modules/services/misc/confd.nix+1−1
This diff is too big to show here.
nixos/modules/services/misc/couchpotato.nixdeleted−42
This diff is too big to show here.
nixos/modules/services/misc/defaultUnicornConfig.rbdeleted−69
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/dictd.nix+3−3
This diff is too big to show here.
nixos/modules/services/misc/disnix.nix+3−3
This diff is too big to show here.
nixos/modules/services/misc/docker-registry.nix+3−1
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.nix+2−2
This diff is too big to show here.
nixos/modules/services/misc/dysnomia.nix+8
This diff is too big to show here.
nixos/modules/services/misc/etcd.nix+14−4
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.nix+4−4
This diff is too big to show here.
nixos/modules/services/misc/exhibitor.nix+5−2
This diff is too big to show here.
nixos/modules/services/misc/felix.nix+3−1
This diff is too big to show here.
nixos/modules/services/misc/freeswitch.nix+4−5
This diff is too big to show here.
nixos/modules/services/misc/fstrim.nix+1−1
This diff is too big to show here.
nixos/modules/services/misc/gammu-smsd.nix+2−2
This diff is too big to show here.
nixos/modules/services/misc/geoip-updater.nixdeleted−306
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.nix+100−51
This diff is too big to show here.
nixos/modules/services/misc/gitit.nix+28−27
This diff is too big to show here.
nixos/modules/services/misc/gitlab.nix+650−163
This diff is too big to show here.
nixos/modules/services/misc/gitlab.xml+38−19
This diff is too big to show here.
nixos/modules/services/misc/gitolite.nix+8−6
This diff is too big to show here.
nixos/modules/services/misc/gitweb.nix+2−1
This diff is too big to show here.
nixos/modules/services/misc/gogs.nix+4−1
This diff is too big to show here.
nixos/modules/services/misc/gollum.nix+3
This diff is too big to show here.
nixos/modules/services/misc/gpsd.nix+2−1
This diff is too big to show here.
nixos/modules/services/misc/greenclip.nix+1−1
This diff is too big to show here.
nixos/modules/services/misc/headphones.nix+3−1
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/home-assistant.nixdeleted−280
This diff is too big to show here.
nixos/modules/services/misc/ihaskell.nix+5−3
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/jackett.nix+1−1
This diff is too big to show here.
nixos/modules/services/misc/jellyfin.nix+24−12
This diff is too big to show here.
nixos/modules/services/misc/klipper.nix+70−12
This diff is too big to show here.
nixos/modules/services/misc/leaps.nix+1−1
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.nix+1−1
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/mame.nix+5−3
This diff is too big to show here.
nixos/modules/services/misc/matrix-appservice-discord.nix+7−2
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/matrix-synapse.nixdeleted−737
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.nix+21−6
This diff is too big to show here.
nixos/modules/services/misc/mbpfan.nix+59−61
This diff is too big to show here.
nixos/modules/services/misc/mediatomb.nix+10−7
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/mwlib.nixdeleted−258
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.nix+2−1
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.nix+510−283
This diff is too big to show here.
nixos/modules/services/misc/nix-gc.nix+52−7
This diff is too big to show here.
nixos/modules/services/misc/nix-optimise.nix+8−2
This diff is too big to show here.
nixos/modules/services/misc/nix-ssh-serve.nix+10−2
This diff is too big to show here.
nixos/modules/services/misc/nzbget.nix+36−18
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.nix+7−3
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/owncast.nixnew file+98
This diff is too big to show here.
nixos/modules/services/misc/packagekit.nix+51−42
This diff is too big to show here.
nixos/modules/services/misc/paperless.nix+204−67
This diff is too big to show here.
nixos/modules/services/misc/pinnwand.nix+47−22
This diff is too big to show here.
nixos/modules/services/misc/plex.nix+43−14
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.nix+7−6
This diff is too big to show here.
nixos/modules/services/misc/redmine.nix+13−12
This diff is too big to show here.
nixos/modules/services/misc/ripple-data-api.nix+3−1
This diff is too big to show here.
nixos/modules/services/misc/rippled.nix+12−5
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.nix+4
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/sickbeard.nix+6−3
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/snapper.nix+42−17
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/ssm-agent.nix+11−4
This diff is too big to show here.
nixos/modules/services/misc/subsonic.nix+10−6
This diff is too big to show here.
nixos/modules/services/misc/svnserve.nix+1
This diff is too big to show here.
nixos/modules/services/misc/synergy.nix+26−1
This diff is too big to show here.
nixos/modules/services/misc/taskserver/default.nix+15−10
This diff is too big to show here.
nixos/modules/services/misc/taskserver/doc.xml+1−1
This diff is too big to show here.
nixos/modules/services/misc/taskserver/helper-tool.py+5−5
This diff is too big to show here.
nixos/modules/services/misc/tautulli.nix+1−1
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/uhub.nix+85−153
This diff is too big to show here.
nixos/modules/services/misc/weechat.nix+10−5
This diff is too big to show here.
nixos/modules/services/misc/xmr-stak.nix+1−1
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/zigbee2mqtt.nixdeleted−99
This diff is too big to show here.
nixos/modules/services/misc/zoneminder.nix+4−4
This diff is too big to show here.
nixos/modules/services/misc/zookeeper.nix+12−3
This diff is too big to show here.
nixos/modules/services/monitoring/alerta.nix+2−6
This diff is too big to show here.
nixos/modules/services/monitoring/apcupsd.nix+1−1
This diff is too big to show here.
nixos/modules/services/monitoring/arbtt.nix+1−2
This diff is too big to show here.
nixos/modules/services/monitoring/bosun.nix+1−2
This diff is too big to show here.
nixos/modules/services/monitoring/cadvisor.nix+2
This diff is too big to show here.
nixos/modules/services/monitoring/collectd.nix+56−28
This diff is too big to show here.
nixos/modules/services/monitoring/datadog-agent.nix+11−9
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.nix+3−2
This diff is too big to show here.
nixos/modules/services/monitoring/grafana.nix+224−55
This diff is too big to show here.
nixos/modules/services/monitoring/graphite.nix+19−7
This diff is too big to show here.
nixos/modules/services/monitoring/heapster.nix+4−2
This diff is too big to show here.
nixos/modules/services/monitoring/incron.nix+8−3
This diff is too big to show here.
nixos/modules/services/monitoring/kapacitor.nix+1−4
This diff is too big to show here.
nixos/modules/services/monitoring/loki.nix+2−2
This diff is too big to show here.
nixos/modules/services/monitoring/mackerel-agent.nix−1
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/munin.nix+7−5
This diff is too big to show here.
nixos/modules/services/monitoring/nagios.nix+8−7
This diff is too big to show here.
nixos/modules/services/monitoring/netdata.nix+110−38
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.nix+1−1
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/default.nix+1307−341
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters.nix+62−17
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters.xml+21
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.nix+6−6
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/buildkite-agent.nixnew file+64
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/collectd.nix+10−10
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/domain.nixnew file+19
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/dovecot.nix+20−1
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/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.nix+18−10
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/knot.nixnew file+54
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/mail.nix+19−1
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/mikrotik.nix+2−2
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/modemmanager.nix+4
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/nextcloud.nix+5−5
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/nginx.nix+10−7
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/node.nix+11−2
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/pihole.nixnew file+74
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/postfix.nix+3
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/postgres.nix+41
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/rspamd.nix+68−63
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/rtl_433.nix+5
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.nix+7−9
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/sql.nix+4
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/unbound.nixnew file+63
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/varnish.nix+3−2
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/exporters/wireguard.nix+5
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/pushgateway.nix+1−1
This diff is too big to show here.
nixos/modules/services/monitoring/prometheus/xmpp-alerts.nix+17−9
This diff is too big to show here.
nixos/modules/services/monitoring/scollector.nix+3−4
This diff is too big to show here.
nixos/modules/services/monitoring/smartd.nix+6−1
This diff is too big to show here.
nixos/modules/services/monitoring/teamviewer.nix+6−3
This diff is too big to show here.
nixos/modules/services/monitoring/telegraf.nix+10−7
This diff is too big to show here.
nixos/modules/services/monitoring/thanos.nix+10−7
This diff is too big to show here.
nixos/modules/services/monitoring/tuptime.nix+5−1
This diff is too big to show here.
nixos/modules/services/monitoring/unifi-poller.nix+80−4
This diff is too big to show here.
nixos/modules/services/monitoring/ups.nix+1−1
This diff is too big to show here.
nixos/modules/services/monitoring/uptime.nix+7−3
This diff is too big to show here.
nixos/modules/services/monitoring/vnstat.nix+15−13
This diff is too big to show here.
nixos/modules/services/monitoring/zabbix-agent.nix+17−9
This diff is too big to show here.
nixos/modules/services/monitoring/zabbix-proxy.nix+18−7
This diff is too big to show here.
nixos/modules/services/monitoring/zabbix-server.nix+17−6
This diff is too big to show here.
nixos/modules/services/network-filesystems/ceph.nix+15−25
This diff is too big to show here.
nixos/modules/services/network-filesystems/davfs2.nix+18
This diff is too big to show here.
nixos/modules/services/network-filesystems/drbd.nix+5−7
This diff is too big to show here.
nixos/modules/services/network-filesystems/glusterfs.nix+1−4
This diff is too big to show here.
nixos/modules/services/network-filesystems/ipfs.nix+104−88
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.nix+41−93
This diff is too big to show here.
nixos/modules/services/network-filesystems/openafs/client.nix+7−8
This diff is too big to show here.
nixos/modules/services/network-filesystems/openafs/server.nix+4−3
This diff is too big to show here.
nixos/modules/services/network-filesystems/orangefs/client.nix−1
This diff is too big to show here.
nixos/modules/services/network-filesystems/orangefs/server.nix+9−9
This diff is too big to show here.
nixos/modules/services/network-filesystems/rsyncd.nix+55−5
This diff is too big to show here.
nixos/modules/services/network-filesystems/samba-wsdd.nix+1−1
This diff is too big to show here.
nixos/modules/services/network-filesystems/samba.nix+17−7
This diff is too big to show here.
nixos/modules/services/network-filesystems/tahoe.nix+2−4
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.nix+15
This diff is too big to show here.
nixos/modules/services/network-filesystems/yandex-disk.nix+2
This diff is too big to show here.
nixos/modules/services/networking/3proxy.nix+3−16
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.nix+9−3
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/asterisk.nix+13−45
This diff is too big to show here.
nixos/modules/services/networking/atftpd.nix+1−1
This diff is too big to show here.
nixos/modules/services/networking/autossh.nix+1−1
This diff is too big to show here.
nixos/modules/services/networking/avahi-daemon.nix+5−5
This diff is too big to show here.
nixos/modules/services/networking/babeld.nix+25−4
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.nix+1
This diff is too big to show here.
nixos/modules/services/networking/bind.nix+93−24
This diff is too big to show here.
nixos/modules/services/networking/bird.nix+91−67
This diff is too big to show here.
nixos/modules/services/networking/bitcoind.nix+2−2
This diff is too big to show here.
nixos/modules/services/networking/bitlbee.nix+12−16
This diff is too big to show here.
nixos/modules/services/networking/blockbook-frontend.nix+6−9
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+8−1
This diff is too big to show here.
nixos/modules/services/networking/cjdns.nix+16−6
This diff is too big to show here.
nixos/modules/services/networking/cloudflare-dyndns.nixnew file+93
This diff is too big to show here.
nixos/modules/services/networking/cntlm.nix+7−2
This diff is too big to show here.
nixos/modules/services/networking/connman.nix+7−6
This diff is too big to show here.
nixos/modules/services/networking/consul.nix+42−11
This diff is too big to show here.
nixos/modules/services/networking/coredns.nix+1−1
This diff is too big to show here.
nixos/modules/services/networking/corerad.nix+4−4
This diff is too big to show here.
nixos/modules/services/networking/coturn.nix+68−37
This diff is too big to show here.
nixos/modules/services/networking/create_ap.nixnew file+50
This diff is too big to show here.
nixos/modules/services/networking/croc.nixnew file+86
This diff is too big to show here.
nixos/modules/services/networking/ddclient.nix+54−24
This diff is too big to show here.
nixos/modules/services/networking/dhcpcd.nix+23−3
This diff is too big to show here.
nixos/modules/services/networking/dhcpd.nix+49−50
This diff is too big to show here.
nixos/modules/services/networking/dnscache.nix+1−1
This diff is too big to show here.
nixos/modules/services/networking/dnscrypt-proxy2.nix+12−4
This diff is too big to show here.
nixos/modules/services/networking/dnscrypt-wrapper.nix+4−2
This diff is too big to show here.
nixos/modules/services/networking/dnsdist.nix+2−3
This diff is too big to show here.
nixos/modules/services/networking/dnsmasq.nix+3−1
This diff is too big to show here.
nixos/modules/services/networking/doh-proxy-rust.nixnew file+60
This diff is too big to show here.
nixos/modules/services/networking/ejabberd.nix+2−2
This diff is too big to show here.
nixos/modules/services/networking/envoy.nixnew file+84
This diff is too big to show here.
nixos/modules/services/networking/epmd.nix+19−3
This diff is too big to show here.
nixos/modules/services/networking/ergo.nix+4−2
This diff is too big to show here.
nixos/modules/services/networking/ergochat.nixnew file+155
This diff is too big to show here.
nixos/modules/services/networking/eternal-terminal.nix+2−2
This diff is too big to show here.
nixos/modules/services/networking/ferm.nix+2−2
This diff is too big to show here.
nixos/modules/services/networking/firefox/sync-server.nixdeleted−183
This diff is too big to show here.
nixos/modules/services/networking/firewall.nix+8−9
This diff is too big to show here.
nixos/modules/services/networking/flannel.nix+7−6
This diff is too big to show here.
nixos/modules/services/networking/flashpolicyd.nixdeleted−85
This diff is too big to show here.
nixos/modules/services/networking/freeradius.nix+2
This diff is too big to show here.
nixos/modules/services/networking/frr.nixnew file+211
This diff is too big to show here.
nixos/modules/services/networking/gale.nixdeleted−181
This diff is too big to show here.
nixos/modules/services/networking/gateone.nix+2−2
This diff is too big to show here.
nixos/modules/services/networking/ghostunnel.nixnew file+242
This diff is too big to show here.
nixos/modules/services/networking/git-daemon.nix+2−1
This diff is too big to show here.
nixos/modules/services/networking/globalprotect-vpn.nixnew file+43
This diff is too big to show here.
nixos/modules/services/networking/gnunet.nix+15−11
This diff is too big to show here.
nixos/modules/services/networking/go-neb.nix+30−4
This diff is too big to show here.
nixos/modules/services/networking/gobgpd.nixnew file+64
This diff is too big to show here.
nixos/modules/services/networking/gogoclient.nixdeleted−85
This diff is too big to show here.
nixos/modules/services/networking/gvpe.nix+8−2
This diff is too big to show here.
nixos/modules/services/networking/hans.nix+2−2
This diff is too big to show here.
nixos/modules/services/networking/headscale.nixnew file+490
This diff is too big to show here.
nixos/modules/services/networking/hostapd.nix+3−2
This diff is too big to show here.
nixos/modules/services/networking/https-dns-proxy.nixnew file+128
This diff is too big to show here.
nixos/modules/services/networking/hylafax/faxq-wait.sh+1−1
This diff is too big to show here.
nixos/modules/services/networking/hylafax/modem-default.nix+3−3
This diff is too big to show here.
nixos/modules/services/networking/hylafax/options.nix+25−28
This diff is too big to show here.
nixos/modules/services/networking/hylafax/spool.sh+3−3
This diff is too big to show here.
nixos/modules/services/networking/hylafax/systemd.nix+21−21
This diff is too big to show here.
nixos/modules/services/networking/i2pd.nix+19−12
This diff is too big to show here.
nixos/modules/services/networking/icecream/daemon.nix+1−1
This diff is too big to show here.
nixos/modules/services/networking/icecream/scheduler.nix+1−1
This diff is too big to show here.
nixos/modules/services/networking/inspircd.nixnew file+62
This diff is too big to show here.
nixos/modules/services/networking/iodine.nix+2−1
This diff is too big to show here.
nixos/modules/services/networking/ircd-hybrid/default.nix+11−3
This diff is too big to show here.
nixos/modules/services/networking/iscsi/initiator.nixnew file+84
This diff is too big to show here.
nixos/modules/services/networking/iscsi/root-initiator.nixnew file+190
This diff is too big to show here.
nixos/modules/services/networking/iscsi/target.nixnew file+53
This diff is too big to show here.
nixos/modules/services/networking/iwd.nix+48−6
This diff is too big to show here.
nixos/modules/services/networking/jibri/default.nixnew file+417
This diff is too big to show here.
nixos/modules/services/networking/jibri/logging.properties-journalnew file+32
This diff is too big to show here.
nixos/modules/services/networking/jicofo.nix+1−1
This diff is too big to show here.
nixos/modules/services/networking/jitsi-videobridge.nix+15−3
This diff is too big to show here.
nixos/modules/services/networking/kea.nixnew file+449
This diff is too big to show here.
nixos/modules/services/networking/keepalived/vrrp-instance-options.nix+1−3
This diff is too big to show here.
nixos/modules/services/networking/keepalived/vrrp-script-options.nix+1−1
This diff is too big to show here.
nixos/modules/services/networking/kippo.nixdeleted−117
This diff is too big to show here.
nixos/modules/services/networking/knot.nix+43−8
This diff is too big to show here.
nixos/modules/services/networking/kresd.nix+20−15
This diff is too big to show here.
nixos/modules/services/networking/lambdabot.nix+1−1
This diff is too big to show here.
nixos/modules/services/networking/libreswan.nix+89−58
This diff is too big to show here.
nixos/modules/services/networking/lxd-image-server.nixnew file+133
This diff is too big to show here.
nixos/modules/services/networking/mailpile.nixdeleted−72
This diff is too big to show here.
nixos/modules/services/networking/matterbridge.nix+3−3
This diff is too big to show here.
nixos/modules/services/networking/minidlna.nix+1−1
This diff is too big to show here.
nixos/modules/services/networking/miredo.nix+1−1
This diff is too big to show here.
nixos/modules/services/networking/monero.nix+15−9
This diff is too big to show here.
nixos/modules/services/networking/morty.nix+4−5
This diff is too big to show here.
nixos/modules/services/networking/mosquitto.mdnew file+102
This diff is too big to show here.
nixos/modules/services/networking/mosquitto.nix+574−174
This diff is too big to show here.
nixos/modules/services/networking/mosquitto.xmlnew file+147
This diff is too big to show here.
nixos/modules/services/networking/mozillavpn.nixnew file+19
This diff is too big to show here.
nixos/modules/services/networking/mtr-exporter.nixnew file+87
This diff is too big to show here.
nixos/modules/services/networking/mullvad-vpn.nix+6−2
This diff is too big to show here.
nixos/modules/services/networking/multipath.nixnew file+557
This diff is too big to show here.
nixos/modules/services/networking/murmur.nix+10−3
This diff is too big to show here.
nixos/modules/services/networking/mxisd.nix+2−2
This diff is too big to show here.
nixos/modules/services/networking/namecoind.nix+1−1
This diff is too big to show here.
nixos/modules/services/networking/nar-serve.nix+1−1
This diff is too big to show here.
nixos/modules/services/networking/nat.nix+1−1
This diff is too big to show here.
nixos/modules/services/networking/nats.nixnew file+158
This diff is too big to show here.
nixos/modules/services/networking/nbd.nixnew file+159
This diff is too big to show here.
nixos/modules/services/networking/ncdns.nix+10−5
This diff is too big to show here.
nixos/modules/services/networking/ndppd.nix+1−1
This diff is too big to show here.
nixos/modules/services/networking/nebula.nixnew file+217
This diff is too big to show here.
nixos/modules/services/networking/networkmanager.nix+165−89
This diff is too big to show here.
nixos/modules/services/networking/nftables.nix+7−12
This diff is too big to show here.
nixos/modules/services/networking/ngircd.nix+5−2
This diff is too big to show here.
nixos/modules/services/networking/nix-serve.nix+20−10
This diff is too big to show here.
nixos/modules/services/networking/nixops-dns.nix−1
This diff is too big to show here.
nixos/modules/services/networking/nntp-proxy.nix+18−18
This diff is too big to show here.
nixos/modules/services/networking/nomad.nixnew file+178
This diff is too big to show here.
nixos/modules/services/networking/nsd.nix+30−19
This diff is too big to show here.
nixos/modules/services/networking/ntopng.nix+57−13
This diff is too big to show here.
nixos/modules/services/networking/ntp/chrony.nix+66−14
This diff is too big to show here.
nixos/modules/services/networking/ntp/ntpd.nix+9−7
This diff is too big to show here.
nixos/modules/services/networking/ntp/openntpd.nix+4−1
This diff is too big to show here.
nixos/modules/services/networking/nylon.nix+1−1
This diff is too big to show here.
nixos/modules/services/networking/ofono.nix+1−1
This diff is too big to show here.
nixos/modules/services/networking/onedrive.nix+1−2
This diff is too big to show here.
nixos/modules/services/networking/openconnect.nixnew file+137
This diff is too big to show here.
nixos/modules/services/networking/openfire.nixdeleted−56
This diff is too big to show here.
nixos/modules/services/networking/openvpn.nix+2−2
This diff is too big to show here.
nixos/modules/services/networking/ostinato.nix+2−2
This diff is too big to show here.
nixos/modules/services/networking/owamp.nix+1−1
This diff is too big to show here.
nixos/modules/services/networking/pdns-recursor.nix+13−8
This diff is too big to show here.
nixos/modules/services/networking/pixiecore.nix+1
This diff is too big to show here.
nixos/modules/services/networking/pleroma.nixnew file+149
This diff is too big to show here.
nixos/modules/services/networking/pleroma.xmlnew file+188
This diff is too big to show here.
nixos/modules/services/networking/powerdns.nix+2−2
This diff is too big to show here.
nixos/modules/services/networking/pppd.nix+23−5
This diff is too big to show here.
nixos/modules/services/networking/prayer.nix+2−1
This diff is too big to show here.
nixos/modules/services/networking/privoxy.nix+229−80
This diff is too big to show here.
nixos/modules/services/networking/prosody.nix+3−2
This diff is too big to show here.
nixos/modules/services/networking/prosody.xml+1−1
This diff is too big to show here.
nixos/modules/services/networking/quagga.nixdeleted−185
This diff is too big to show here.
nixos/modules/services/networking/quassel.nix+11−4
This diff is too big to show here.
nixos/modules/services/networking/quicktun.nix+1−1
This diff is too big to show here.
nixos/modules/services/networking/quorum.nix+5−3
This diff is too big to show here.
nixos/modules/services/networking/racoon.nixdeleted−45
This diff is too big to show here.
nixos/modules/services/networking/radicale.nix+156−44
This diff is too big to show here.
nixos/modules/services/networking/radvd.nix+5−1
This diff is too big to show here.
nixos/modules/services/networking/rdnssd.nix+3−1
This diff is too big to show here.
nixos/modules/services/networking/resilio.nix+2
This diff is too big to show here.
nixos/modules/services/networking/rxe.nix+2−2
This diff is too big to show here.
nixos/modules/services/networking/sabnzbd.nix+11−1
This diff is too big to show here.
nixos/modules/services/networking/seafile.nixnew file+287
This diff is too big to show here.
nixos/modules/services/networking/searx.nix+184−33
This diff is too big to show here.
nixos/modules/services/networking/shadowsocks.nix+4−6
This diff is too big to show here.
nixos/modules/services/networking/shairport-sync.nix+31−2
This diff is too big to show here.
nixos/modules/services/networking/shellhub-agent.nixnew file+100
This diff is too big to show here.
nixos/modules/services/networking/shorewall.nix+1−1
This diff is too big to show here.
nixos/modules/services/networking/shorewall6.nix+1−1
This diff is too big to show here.
nixos/modules/services/networking/shout.nix+4−2
This diff is too big to show here.
nixos/modules/services/networking/skydns.nix+2−1
This diff is too big to show here.
nixos/modules/services/networking/smartdns.nix+2−1
This diff is too big to show here.
nixos/modules/services/networking/smokeping.nix+74−32
This diff is too big to show here.
nixos/modules/services/networking/sniproxy.nix+6−17
This diff is too big to show here.
nixos/modules/services/networking/snowflake-proxy.nixnew file+81
This diff is too big to show here.
nixos/modules/services/networking/softether.nix+1−1
This diff is too big to show here.
nixos/modules/services/networking/soju.nixnew file+114
This diff is too big to show here.
nixos/modules/services/networking/solanum.nixnew file+109
This diff is too big to show here.
nixos/modules/services/networking/spacecookie.nix+147−14
This diff is too big to show here.
nixos/modules/services/networking/spiped.nix+1−1
This diff is too big to show here.
nixos/modules/services/networking/squid.nix+23−4
This diff is too big to show here.
nixos/modules/services/networking/ssh/lshd.nix+12−6
This diff is too big to show here.
nixos/modules/services/networking/ssh/sshd.nix+44−23
This diff is too big to show here.
nixos/modules/services/networking/sslh.nix+1−1
This diff is too big to show here.
nixos/modules/services/networking/strongswan-swanctl/module.nix+2−2
This diff is too big to show here.
nixos/modules/services/networking/strongswan-swanctl/swanctl-params.nix+11−1
This diff is too big to show here.
nixos/modules/services/networking/strongswan.nix+3−3
This diff is too big to show here.
nixos/modules/services/networking/stubby.nix+46−174
This diff is too big to show here.
nixos/modules/services/networking/stunnel.nix+3−2
This diff is too big to show here.
nixos/modules/services/networking/supplicant.nix+5−14
This diff is too big to show here.
nixos/modules/services/networking/supybot.nix+5−3
This diff is too big to show here.
nixos/modules/services/networking/syncplay.nix+19−3
This diff is too big to show here.
nixos/modules/services/networking/syncthing.nix+372−308
This diff is too big to show here.
nixos/modules/services/networking/tailscale.nix+20−2
This diff is too big to show here.
nixos/modules/services/networking/teamspeak3.nix+20−2
This diff is too big to show here.
nixos/modules/services/networking/tedicross.nix+1−1
This diff is too big to show here.
nixos/modules/services/networking/teleport.nixnew file+99
This diff is too big to show here.
nixos/modules/services/networking/tetrd.nixnew file+96
This diff is too big to show here.
nixos/modules/services/networking/thelounge.nix+39−8
This diff is too big to show here.
nixos/modules/services/networking/tinc.nix+11−8
This diff is too big to show here.
nixos/modules/services/networking/tinydns.nix+5−1
This diff is too big to show here.
nixos/modules/services/networking/tox-bootstrapd.nix+8−13
This diff is too big to show here.
nixos/modules/services/networking/tox-node.nix+1−6
This diff is too big to show here.
nixos/modules/services/networking/toxvpn.nix+4−2
This diff is too big to show here.
nixos/modules/services/networking/trickster.nix+1−1
This diff is too big to show here.
nixos/modules/services/networking/tvheadend.nix+3−1
This diff is too big to show here.
nixos/modules/services/networking/ucarp.nixnew file+183
This diff is too big to show here.
nixos/modules/services/networking/unbound.nix+176−81
This diff is too big to show here.
nixos/modules/services/networking/unifi.nix+80−60
This diff is too big to show here.
nixos/modules/services/networking/v2ray.nix+15−7
This diff is too big to show here.
nixos/modules/services/networking/vsftpd.nix+5−2
This diff is too big to show here.
nixos/modules/services/networking/wakeonlan.nixdeleted−56
This diff is too big to show here.
nixos/modules/services/networking/wasabibackend.nix+4−2
This diff is too big to show here.
nixos/modules/services/networking/websockify.nix+1−1
This diff is too big to show here.
nixos/modules/services/networking/wg-netmanager.nixnew file+42
This diff is too big to show here.
nixos/modules/services/networking/wg-quick.nix+12−13
This diff is too big to show here.
nixos/modules/services/networking/wicd.nixdeleted−40
This diff is too big to show here.
nixos/modules/services/networking/wireguard.nix+104−54
This diff is too big to show here.
nixos/modules/services/networking/wpa_supplicant.nix+355−83
This diff is too big to show here.
nixos/modules/programs/x2goserver.nix → nixos/modules/services/networking/x2goserver.nixrenamed+24−9
This diff is too big to show here.
nixos/modules/services/networking/xandikos.nix+2−2
This diff is too big to show here.
nixos/modules/services/networking/xrdp.nix+17−3
This diff is too big to show here.
nixos/modules/services/networking/yggdrasil.nix+3−4
This diff is too big to show here.
nixos/modules/services/networking/yggdrasil.xml−1
This diff is too big to show here.
nixos/modules/services/networking/zerobin.nix+1−1
This diff is too big to show here.
nixos/modules/services/networking/zeronet.nix+5−7
This diff is too big to show here.
nixos/modules/services/networking/zerotierone.nix+1−2
This diff is too big to show here.
nixos/modules/services/networking/znc/default.nix+36−9
This diff is too big to show here.
nixos/modules/services/networking/znc/options.nix+6−6
This diff is too big to show here.
nixos/modules/services/printing/cupsd.nix+2−2
This diff is too big to show here.
nixos/modules/services/scheduling/atd.nix+6−9
This diff is too big to show here.
nixos/modules/services/scheduling/cron.nix+7−2
This diff is too big to show here.
nixos/modules/services/scheduling/fcron.nix+3
This diff is too big to show here.
nixos/modules/services/search/elasticsearch-curator.nix+1
This diff is too big to show here.
nixos/modules/services/search/elasticsearch.nix+43−12
This diff is too big to show here.
nixos/modules/services/search/hound.nix+13−11
This diff is too big to show here.
nixos/modules/services/search/kibana.nix+9−4
This diff is too big to show here.
nixos/modules/services/search/meilisearch.mdnew file+39
This diff is too big to show here.
nixos/modules/services/search/meilisearch.nixnew file+132
This diff is too big to show here.
nixos/modules/services/search/meilisearch.xmlnew file+85
This diff is too big to show here.
nixos/modules/services/search/solr.nix+1−1
This diff is too big to show here.
nixos/modules/services/security/aesmd.nixnew file+236
This diff is too big to show here.
nixos/modules/services/security/bitwarden_rs/default.nixdeleted−162
This diff is too big to show here.
nixos/modules/services/security/certmgr.nix+2−2
This diff is too big to show here.
nixos/modules/services/security/cfssl.nix+56−43
This diff is too big to show here.
nixos/modules/services/security/clamav.nix+37−33
This diff is too big to show here.
nixos/modules/services/security/fail2ban.nix+41−7
This diff is too big to show here.
nixos/modules/services/security/fprintd.nix+22−12
This diff is too big to show here.
nixos/modules/services/security/fprot.nixdeleted−79
This diff is too big to show here.
nixos/modules/services/security/haka.nix+1−1
This diff is too big to show here.
nixos/modules/services/security/haveged.nix+39−29
This diff is too big to show here.
nixos/modules/services/security/hockeypuck.nixnew file+106
This diff is too big to show here.
nixos/modules/services/security/hologram-agent.nix+1−1
This diff is too big to show here.
nixos/modules/services/security/nginx-sso.nix+2−2
This diff is too big to show here.
nixos/modules/services/security/oauth2_proxy.nix+13−7
This diff is too big to show here.
nixos/modules/services/security/oauth2_proxy_nginx.nix+5−3
This diff is too big to show here.
nixos/modules/services/security/opensnitch.nixnew file+125
This diff is too big to show here.
nixos/modules/services/security/physlock.nix+6−4
This diff is too big to show here.
nixos/modules/services/security/privacyidea.nix+40−9
This diff is too big to show here.
nixos/modules/services/security/shibboleth-sp.nix+1−1
This diff is too big to show here.
nixos/modules/services/security/sks.nix+2−2
This diff is too big to show here.
nixos/modules/services/security/sshguard.nix+20−16
This diff is too big to show here.
nixos/modules/services/security/sslmate-agent.nixnew file+32
This diff is too big to show here.
nixos/modules/services/security/step-ca.nixnew file+146
This diff is too big to show here.
nixos/modules/services/security/tor.nix+858−565
This diff is too big to show here.
nixos/modules/services/security/torsocks.nix+1
This diff is too big to show here.
nixos/modules/services/security/usbguard.nix+2−2
This diff is too big to show here.
nixos/modules/services/security/vault.nix+52−4
This diff is too big to show here.
nixos/modules/services/security/bitwarden_rs/backup.sh → nixos/modules/services/security/vaultwarden/backup.shrenamed+1−1
This diff is too big to show here.
nixos/modules/services/security/vaultwarden/default.nixnew file+185
This diff is too big to show here.
nixos/modules/services/security/yubikey-agent.nix+8−2
This diff is too big to show here.
nixos/modules/services/system/cachix-agent/default.nixnew file+57
This diff is too big to show here.
nixos/modules/services/system/cloud-init.nix+17−3
This diff is too big to show here.
nixos/modules/services/system/earlyoom.nix+134−97
This diff is too big to show here.
nixos/modules/services/system/kerberos/heimdal.nix+1−1
This diff is too big to show here.
nixos/modules/services/system/localtime.nix+6−5
This diff is too big to show here.
nixos/modules/services/system/nscd.nix+20−9
This diff is too big to show here.
nixos/modules/services/system/saslauthd.nix+1−1
This diff is too big to show here.
nixos/modules/services/system/self-deploy.nixnew file+173
This diff is too big to show here.
nixos/modules/services/system/systembus-notify.nixnew file+27
This diff is too big to show here.
nixos/modules/services/system/uptimed.nix+7−3
This diff is too big to show here.
nixos/modules/services/torrent/deluge.nix+10−2
This diff is too big to show here.
nixos/modules/services/torrent/flexget.nix+1−1
This diff is too big to show here.
nixos/modules/services/torrent/magnetico.nix+3−1
This diff is too big to show here.
nixos/modules/services/torrent/opentracker.nix+1−1
This diff is too big to show here.
nixos/modules/services/torrent/peerflix.nix+8−2
This diff is too big to show here.
nixos/modules/services/torrent/rtorrent.nix+4−2
This diff is too big to show here.
nixos/modules/services/torrent/transmission.nix+257−223
This diff is too big to show here.
nixos/modules/services/ttys/agetty.nixdeleted−117
This diff is too big to show here.
nixos/modules/services/ttys/getty.nixnew file+162
This diff is too big to show here.
nixos/modules/services/ttys/kmscon.nix+26−10
This diff is too big to show here.
nixos/modules/services/video/epgstation/default.nix+193−154
This diff is too big to show here.
nixos/modules/services/video/epgstation/streaming.json+129−108
This diff is too big to show here.
nixos/modules/services/video/mirakurun.nix+27−6
This diff is too big to show here.
nixos/modules/services/video/replay-sorcery.nixnew file+72
This diff is too big to show here.
nixos/modules/services/video/rtsp-simple-server.nixnew file+80
This diff is too big to show here.
nixos/modules/services/video/unifi-video.nixnew file+271
This diff is too big to show here.
nixos/modules/services/wayland/cage.nix+8−3
This diff is too big to show here.
nixos/modules/services/web-apps/atlassian/confluence.nix+2−2
This diff is too big to show here.
nixos/modules/services/web-apps/atlassian/crowd.nix+2−2
This diff is too big to show here.
nixos/modules/services/web-apps/atlassian/jira.nix+3−2
This diff is too big to show here.
nixos/modules/services/web-apps/baget.nixnew file+170
This diff is too big to show here.
nixos/modules/services/web-apps/bookstack.nixnew file+449
This diff is too big to show here.
nixos/modules/services/web-apps/calibre-web.nixnew file+165
This diff is too big to show here.
nixos/modules/services/web-apps/code-server.nixnew file+139
This diff is too big to show here.
nixos/modules/services/web-apps/cryptpad.nix+2−2
This diff is too big to show here.
nixos/modules/services/web-apps/dex.nixnew file+118
This diff is too big to show here.
nixos/modules/services/web-apps/discourse.nixnew file+1093
This diff is too big to show here.
nixos/modules/services/web-apps/discourse.xmlnew file+355
This diff is too big to show here.
nixos/modules/services/web-apps/documize.nix+1
This diff is too big to show here.
nixos/modules/services/web-apps/dokuwiki.nix+325−274
This diff is too big to show here.
nixos/modules/services/web-apps/engelsystem.nix+3−3
This diff is too big to show here.
nixos/modules/services/web-apps/ethercalc.nixnew file+62
This diff is too big to show here.
nixos/modules/services/web-apps/fluidd.nixnew file+66
This diff is too big to show here.
nixos/modules/services/web-apps/galene.nixnew file+214
This diff is too big to show here.
nixos/modules/services/web-apps/gerrit.nix+4−1
This diff is too big to show here.
nixos/modules/services/web-apps/hedgedoc.nix+76−8
This diff is too big to show here.
nixos/modules/services/web-apps/hledger-web.nixnew file+142
This diff is too big to show here.
nixos/modules/services/web-apps/icingaweb2/icingaweb2.nix+19−1
This diff is too big to show here.
nixos/modules/services/web-apps/ihatemoney/default.nix+20−8
This diff is too big to show here.
nixos/modules/services/web-apps/invidious.nixnew file+264
This diff is too big to show here.
nixos/modules/services/web-apps/invoiceplane.nixnew file+305
This diff is too big to show here.
nixos/modules/services/web-apps/isso.nixnew file+69
This diff is too big to show here.
nixos/modules/services/web-apps/jirafeau.nix+10−6
This diff is too big to show here.
nixos/modules/services/web-apps/jitsi-meet.nix+130−12
This diff is too big to show here.
nixos/modules/services/web-apps/jitsi-meet.xml+2−2
This diff is too big to show here.
nixos/modules/services/web-apps/keycloak.nix+575−584
This diff is too big to show here.
nixos/modules/services/web-apps/keycloak.xml+82−85
This diff is too big to show here.
nixos/modules/services/web-apps/lemmy.mdnew file+34
This diff is too big to show here.
nixos/modules/services/web-apps/lemmy.nixnew file+236
This diff is too big to show here.
nixos/modules/services/web-apps/lemmy.xmlnew file+56
This diff is too big to show here.
nixos/modules/services/web-apps/limesurvey.nix+5−5
This diff is too big to show here.
nixos/modules/services/web-apps/mastodon.nixnew file+638
This diff is too big to show here.
nixos/modules/services/web-apps/matomo.nix+44−15
This diff is too big to show here.
nixos/modules/services/web-apps/mattermost.nix+145−37
This diff is too big to show here.
nixos/modules/services/web-apps/mediawiki.nix+7−5
This diff is too big to show here.
nixos/modules/services/web-apps/miniflux.nix+62−32
This diff is too big to show here.
nixos/modules/services/web-apps/moinmoin.nixdeleted−304
This diff is too big to show here.
nixos/modules/services/web-apps/moodle.nix+8−8
This diff is too big to show here.
nixos/modules/services/web-apps/netbox.nixnew file+265
This diff is too big to show here.
nixos/modules/services/web-apps/nextcloud.nix+464−97
This diff is too big to show here.
nixos/modules/services/web-apps/nextcloud.xml+107−40
This diff is too big to show here.
nixos/modules/services/web-apps/nexus.nix+22
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+5−2
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+21−4
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+1−4
This diff is too big to show here.
nixos/modules/services/web-apps/rss-bridge.nix+2−4
This diff is too big to show here.
nixos/modules/services/web-apps/selfoss.nix−1
This diff is too big to show here.
nixos/modules/services/web-apps/shiori.nix+2−5
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/trac.nix−79
This diff is too big to show here.
nixos/modules/services/web-apps/trilium.nix+11−2
This diff is too big to show here.
nixos/modules/services/web-apps/tt-rss.nix+97−88
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/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+175−61
This diff is too big to show here.
nixos/modules/services/web-apps/youtrack.nix+3−2
This diff is too big to show here.
nixos/modules/services/web-apps/zabbix.nix+12−5
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+67−43
This diff is too big to show here.
nixos/modules/services/web-servers/apache-httpd/vhost-options.nix+27−7
This diff is too big to show here.
nixos/modules/services/web-servers/caddy.nix−138
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+1−1
This diff is too big to show here.
nixos/modules/services/web-servers/hydron.nix+1−1
This diff is too big to show here.
nixos/modules/services/web-servers/jboss/default.nix+6
This diff is too big to show here.
nixos/modules/services/web-servers/lighttpd/cgit.nix+7−5
This diff is too big to show here.
nixos/modules/services/web-servers/lighttpd/collectd.nix+5−1
This diff is too big to show here.
nixos/modules/services/web-servers/lighttpd/default.nix+15−3
This diff is too big to show here.
nixos/modules/services/web-servers/minio.nix+34−12
This diff is too big to show here.
nixos/modules/services/web-servers/molly-brown.nix+1−2
This diff is too big to show here.
nixos/modules/services/web-servers/nginx/default.nix+229−33
This diff is too big to show here.
nixos/modules/services/web-servers/nginx/gitweb.nix+2−2
This diff is too big to show here.
nixos/modules/services/web-servers/nginx/location-options.nix+12−2
This diff is too big to show here.
nixos/modules/services/web-servers/nginx/vhost-options.nix+74−9
This diff is too big to show here.
nixos/modules/services/web-servers/phpfpm/default.nix+5−5
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/shellinabox.nix−122
This diff is too big to show here.
nixos/modules/services/web-servers/tomcat.nix+7−5
This diff is too big to show here.
nixos/modules/services/web-servers/traefik.nix+3−3
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+2−2
This diff is too big to show here.
nixos/modules/services/web-servers/unit/default.nix+4−2
This diff is too big to show here.
nixos/modules/services/web-servers/uwsgi.nix+69−23
This diff is too big to show here.
nixos/modules/services/web-servers/varnish/default.nix+9−7
This diff is too big to show here.
nixos/modules/services/web-servers/zope2.nix+6−2
This diff is too big to show here.
nixos/modules/services/x11/clight.nix+27−11
This diff is too big to show here.
nixos/modules/services/x11/desktop-managers/cde.nix+5−4
This diff is too big to show here.
nixos/modules/services/x11/desktop-managers/cinnamon.nix+25−12
This diff is too big to show here.
nixos/modules/services/x11/desktop-managers/default.nix+1−1
This diff is too big to show here.
nixos/modules/services/x11/desktop-managers/enlightenment.nix+24−3
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/gnome3.nix−501
This diff is too big to show here.
nixos/modules/services/x11/desktop-managers/kodi.nix+12−2
This diff is too big to show here.
nixos/modules/services/x11/desktop-managers/lumina.nix+4
This diff is too big to show here.
nixos/modules/services/x11/desktop-managers/lxqt.nix+13−4
This diff is too big to show here.
nixos/modules/services/x11/desktop-managers/mate.nix+12−40
This diff is too big to show here.
nixos/modules/services/x11/desktop-managers/none.nix+44−5
This diff is too big to show here.
nixos/modules/services/x11/desktop-managers/pantheon.nix+45−29
This diff is too big to show here.
nixos/modules/services/x11/desktop-managers/pantheon.xml+11−5
This diff is too big to show here.
nixos/modules/services/x11/desktop-managers/plasma5.nix+335−136
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+2−1
This diff is too big to show here.
nixos/modules/services/x11/desktop-managers/xfce.nix+17−10
This diff is too big to show here.
nixos/modules/services/x11/desktop-managers/xterm.nix+2−2
This diff is too big to show here.
nixos/modules/services/x11/display-managers/account-service-util.nix+1−1
This diff is too big to show here.
nixos/modules/services/x11/display-managers/default.nix+33−23
This diff is too big to show here.
nixos/modules/services/x11/display-managers/gdm.nix+59−64
This diff is too big to show here.
nixos/modules/services/x11/display-managers/lightdm-greeters/enso-os.nix+4−4
This diff is too big to show here.
nixos/modules/services/x11/display-managers/lightdm-greeters/gtk.nix+7−6
This diff is too big to show here.
nixos/modules/services/x11/display-managers/lightdm-greeters/pantheon.nix+2−2
This diff is too big to show here.
nixos/modules/services/x11/display-managers/lightdm.nix+8−6
This diff is too big to show here.
nixos/modules/services/x11/display-managers/sddm.nix+10−9
This diff is too big to show here.
nixos/modules/services/x11/display-managers/set-session.py+3
This diff is too big to show here.
nixos/modules/services/x11/display-managers/startx.nix−3
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/extra-layouts.nix+9−48
This diff is too big to show here.
nixos/modules/services/x11/hardware/libinput.nix+79−40
This diff is too big to show here.
nixos/modules/services/x11/hardware/synaptics.nix+6−1
This diff is too big to show here.
nixos/modules/services/x11/imwheel.nix+11−9
This diff is too big to show here.
nixos/modules/services/x11/picom.nix+13−3
This diff is too big to show here.
nixos/modules/services/x11/redshift.nix+1−1
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+1−1
This diff is too big to show here.
nixos/modules/services/x11/unclutter.nix+1−1
This diff is too big to show here.
nixos/modules/services/x11/urxvtd.nix+1−1
This diff is too big to show here.
nixos/modules/services/x11/window-managers/awesome.nix+1−1
This diff is too big to show here.
nixos/modules/services/x11/window-managers/bspwm.nix+6−6
This diff is too big to show here.
nixos/modules/services/x11/window-managers/clfswm.nix+13−3
This diff is too big to show here.
nixos/modules/services/x11/window-managers/default.nix+4
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/exwm.nix+7−4
This diff is too big to show here.
nixos/modules/services/x11/window-managers/fvwm.nix+1−1
This diff is too big to show here.
nixos/modules/services/x11/window-managers/herbstluftwm.nix+11−2
This diff is too big to show here.
nixos/modules/services/x11/window-managers/i3.nix+3−3
This diff is too big to show here.
nixos/modules/services/x11/window-managers/metacity.nix+3−3
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/qtile.nix+11−4
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/xmonad.nix+52−15
This diff is too big to show here.
nixos/modules/services/x11/xautolock.nix+4−3
This diff is too big to show here.
nixos/modules/services/x11/xserver.nix+83−45
This diff is too big to show here.
nixos/modules/system/activation/activation-script.nix+77−46
This diff is too big to show here.
nixos/modules/system/activation/switch-to-configuration.pl+698−255
This diff is too big to show here.
nixos/modules/system/activation/top-level.nix+101−37
This diff is too big to show here.
nixos/modules/system/boot/binfmt.nix+59−11
This diff is too big to show here.
nixos/modules/system/boot/initrd-openvpn.nix+2−2
This diff is too big to show here.
nixos/modules/system/boot/initrd-ssh.nix+1−1
This diff is too big to show here.
nixos/modules/system/boot/kernel.nix+31−16
This diff is too big to show here.
nixos/modules/system/boot/kernel_config.nix+2−22
This diff is too big to show here.
nixos/modules/system/boot/kexec.nix+3−3
This diff is too big to show here.
nixos/modules/system/boot/loader/generations-dir/generations-dir.nix+1−4
This diff is too big to show here.
nixos/modules/system/boot/loader/generic-extlinux-compatible/default.nix+18−1
This diff is too big to show here.
nixos/modules/system/boot/loader/generic-extlinux-compatible/extlinux-conf-builder.sh+9−3
This diff is too big to show here.
nixos/modules/system/boot/loader/grub/grub.nix+62−9
This diff is too big to show here.
nixos/modules/system/boot/loader/grub/install-grub.pl+71−43
This diff is too big to show here.
nixos/modules/system/boot/loader/grub/ipxe.nix+1−1
This diff is too big to show here.
nixos/modules/system/boot/loader/init-script/init-script-builder.sh−1
This diff is too big to show here.
nixos/modules/system/boot/loader/raspberrypi/raspberrypi-builder.nix+2−3
This diff is too big to show here.
nixos/modules/system/boot/loader/raspberrypi/raspberrypi.nix+3−6
This diff is too big to show here.
nixos/modules/system/boot/loader/systemd-boot/systemd-boot-builder.py+130−70
This diff is too big to show here.
nixos/modules/system/boot/loader/systemd-boot/systemd-boot.nix+165−5
This diff is too big to show here.
nixos/modules/system/boot/luksroot.nix+180−69
This diff is too big to show here.
nixos/modules/system/boot/modprobe.nix+2
This diff is too big to show here.
nixos/modules/system/boot/networkd.nix+434−28
This diff is too big to show here.
nixos/modules/system/boot/plymouth.nix+83−19
This diff is too big to show here.
nixos/modules/system/boot/resolved.nix+4−5
This diff is too big to show here.
nixos/modules/system/boot/stage-1-init.sh+66−54
This diff is too big to show here.
nixos/modules/system/boot/stage-1.nix+126−26
This diff is too big to show here.
nixos/modules/system/boot/stage-2-init.sh+71−99
This diff is too big to show here.
nixos/modules/system/boot/stage-2.nix+9−33
This diff is too big to show here.
nixos/modules/system/boot/systemd-lib.nix−235
This diff is too big to show here.
nixos/modules/system/boot/systemd-nspawn.nix−133
This diff is too big to show here.
nixos/modules/system/boot/systemd-unit-options.nix−536
This diff is too big to show here.
nixos/modules/system/boot/systemd.nix+94−670
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+20−5
This diff is too big to show here.
nixos/modules/system/boot/tmp.nix+26−1
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+61−22
This diff is too big to show here.
nixos/modules/system/etc/make-etc.sh−45
This diff is too big to show here.
nixos/modules/system/etc/setup-etc.pl+6
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+105−20
This diff is too big to show here.
nixos/modules/tasks/bcache.nix+16−6
This diff is too big to show here.
nixos/modules/tasks/cpu-freq.nix+1−1
This diff is too big to show here.
nixos/modules/tasks/encrypted-devices.nix+1−1
This diff is too big to show here.
nixos/modules/tasks/filesystems.nix+96−13
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/btrfs.nix+14−5
This diff is too big to show here.
nixos/modules/tasks/filesystems/cifs.nix+1−1
This diff is too big to show here.
nixos/modules/tasks/filesystems/ecryptfs.nix+12−2
This diff is too big to show here.
nixos/modules/tasks/filesystems/exfat.nix+5−3
This diff is too big to show here.
nixos/modules/tasks/filesystems/ext.nix+10−4
This diff is too big to show here.
nixos/modules/tasks/filesystems/f2fs.nix+1−1
This diff is too big to show here.
nixos/modules/tasks/filesystems/jfs.nix+1−1
This diff is too big to show here.
nixos/modules/tasks/filesystems/nfs.nix+1−1
This diff is too big to show here.
nixos/modules/tasks/filesystems/reiserfs.nix+1−1
This diff is too big to show here.
nixos/modules/tasks/filesystems/unionfs-fuse.nix+13−2
This diff is too big to show here.
nixos/modules/tasks/filesystems/vfat.nix+1−1
This diff is too big to show here.
nixos/modules/tasks/filesystems/xfs.nix+2−2
This diff is too big to show here.
nixos/modules/tasks/filesystems/zfs.nix+169−67
This diff is too big to show here.
nixos/modules/tasks/lvm.nix+73−14
This diff is too big to show here.
nixos/modules/tasks/network-interfaces-scripted.nix+80−9
This diff is too big to show here.
nixos/modules/tasks/network-interfaces-systemd.nix+117−17
This diff is too big to show here.
nixos/modules/tasks/network-interfaces.nix+346−68
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+35−9
This diff is too big to show here.
nixos/modules/tasks/trackpoint.nix+5−4
This diff is too big to show here.
nixos/modules/testing/service-runner.nix+3−3
This diff is too big to show here.
nixos/modules/testing/test-instrumentation.nix+32−32
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+33−10
This diff is too big to show here.
nixos/modules/virtualisation/amazon-init.nix+40−13
This diff is too big to show here.
nixos/modules/virtualisation/amazon-options.nix+54−1
This diff is too big to show here.
nixos/modules/virtualisation/anbox.nix+1−2
This diff is too big to show here.
nixos/modules/virtualisation/azure-agent.nix+6−10
This diff is too big to show here.
nixos/modules/virtualisation/azure-common.nix+5−1
This diff is too big to show here.
nixos/modules/virtualisation/azure-image.nix+3−2
This diff is too big to show here.
nixos/modules/virtualisation/brightbox-image.nix+1−1
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/container-config.nix+1−1
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+52−34
This diff is too big to show here.
nixos/modules/virtualisation/cri-o.nix+49−27
This diff is too big to show here.
nixos/modules/virtualisation/digital-ocean-image.nix+3−2
This diff is too big to show here.
nixos/modules/virtualisation/digital-ocean-init.nix+1−1
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+40−15
This diff is too big to show here.
nixos/modules/virtualisation/ec2-amis.nix+9−352
This diff is too big to show here.
nixos/modules/virtualisation/ec2-data.nix+1−1
This diff is too big to show here.
nixos/modules/virtualisation/ec2-metadata-fetcher.nix+1−1
This diff is too big to show here.
nixos/modules/virtualisation/ecs-agent.nix+1−1
This diff is too big to show here.
nixos/modules/virtualisation/gce-images.nix+9−1
This diff is too big to show here.
nixos/modules/virtualisation/google-compute-config.nix+33−79
This diff is too big to show here.
nixos/modules/virtualisation/google-compute-image.nix+14−4
This diff is too big to show here.
nixos/modules/virtualisation/hyperv-guest.nix+5−3
This diff is too big to show here.
nixos/modules/virtualisation/hyperv-image.nix+3−2
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+1−1
This diff is too big to show here.
nixos/modules/virtualisation/libvirtd.nix+184−68
This diff is too big to show here.
nixos/modules/virtualisation/lxc-container.nix+161−13
This diff is too big to show here.
nixos/modules/virtualisation/lxc.nix+8−4
This diff is too big to show here.
nixos/modules/virtualisation/lxd.nix+65−33
This diff is too big to show here.
nixos/modules/virtualisation/nixos-containers.nix+99−62
This diff is too big to show here.
nixos/modules/virtualisation/oci-containers.nix+82−40
This diff is too big to show here.
nixos/modules/virtualisation/openstack-config.nix+39−7
This diff is too big to show here.
nixos/modules/virtualisation/openstack-metadata-fetcher.nix+5−4
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+10−55
This diff is too big to show here.
nixos/modules/virtualisation/parallels-guest.nix+1−2
This diff is too big to show here.
nixos/modules/virtualisation/podman.nix−98
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+6−2
This diff is too big to show here.
nixos/modules/virtualisation/qemu-vm.nix+377−88
This diff is too big to show here.
nixos/modules/virtualisation/railcar.nix+4−5
This diff is too big to show here.
nixos/modules/virtualisation/spice-usb-redirection.nix+4−2
This diff is too big to show here.
nixos/modules/virtualisation/virtualbox-guest.nix+2−2
This diff is too big to show here.
nixos/modules/virtualisation/virtualbox-host.nix+10−2
This diff is too big to show here.
nixos/modules/virtualisation/virtualbox-image.nix+25−4
This diff is too big to show here.
nixos/modules/virtualisation/vmware-guest.nix+27−1
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+3−2
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+1−1
This diff is too big to show here.
nixos/modules/virtualisation/xen-dom0.nix+9−10
This diff is too big to show here.
nixos/release-combined.nix+8−5
This diff is too big to show here.
nixos/release-small.nix+4−2
This diff is too big to show here.
nixos/release.nix+75−16
This diff is too big to show here.
nixos/tests/3proxy.nix+1−1
This diff is too big to show here.
nixos/tests/acme.nix+404−177
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+16−7
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+236−44
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/ammonite.nix−20
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+2−2
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+2−2
This diff is too big to show here.
nixos/tests/awscli.nix−17
This diff is too big to show here.
nixos/tests/babeld.nix+1−7
This diff is too big to show here.
nixos/tests/bat.nix−12
This diff is too big to show here.
nixos/tests/bazarr.nix+1−1
This diff is too big to show here.
nixos/tests/bcachefs.nix+8−9
This diff is too big to show here.
nixos/tests/beanstalkd.nix+1−1
This diff is too big to show here.
nixos/tests/bees.nix+2−2
This diff is too big to show here.
nixos/tests/bind.nix+2−1
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+2−2
This diff is too big to show here.
nixos/tests/bittorrent.nix+2−2
This diff is too big to show here.
nixos/tests/bitwarden.nix−188
This diff is too big to show here.
nixos/tests/blockbook-frontend.nix+2−2
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+4−2
This diff is too big to show here.
nixos/tests/boot.nix+61−18
This diff is too big to show here.
nixos/tests/borgbackup.nix+35−2
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+1−1
This diff is too big to show here.
nixos/tests/buildkite-agents.nix+2−2
This diff is too big to show here.
nixos/tests/caddy.nix+57−41
This diff is too big to show here.
nixos/tests/cadvisor.nix+1−1
This diff is too big to show here.
nixos/tests/cage.nix+7−14
This diff is too big to show here.
nixos/tests/cagebreak.nix+26−55
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−1
This diff is too big to show here.
nixos/tests/ceph-multi-node.nix+3−3
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+2−2
This diff is too big to show here.
nixos/tests/cfssl.nix+1−1
This diff is too big to show here.
nixos/tests/charliecloud.nix+1−1
This diff is too big to show here.
nixos/tests/chromium.nix+132−138
This diff is too big to show here.
nixos/tests/cjdns.nix+1−1
This diff is too big to show here.
nixos/tests/clickhouse.nix+3−2
This diff is too big to show here.
nixos/tests/cloud-init.nix+28−3
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+1−1
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+4−2
This diff is too big to show here.
nixos/tests/common/acme/server/default.nix+5
This diff is too big to show here.
nixos/tests/common/ec2.nix+1
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/wayland-cage.nix+13
This diff is too big to show here.
nixos/tests/containers-bridge.nix+5−8
This diff is too big to show here.
nixos/tests/containers-custom-pkgs.nix+23−31
This diff is too big to show here.
nixos/tests/containers-ephemeral.nix+8−8
This diff is too big to show here.
nixos/tests/containers-extra_veth.nix+5−8
This diff is too big to show here.
nixos/tests/containers-hosts.nix+4−7
This diff is too big to show here.
nixos/tests/containers-imperative.nix+33−16
This diff is too big to show here.
nixos/tests/containers-ip.nix+5−8
This diff is too big to show here.
nixos/tests/containers-macvlans.nix+3−7
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+3−8
This diff is too big to show here.
nixos/tests/containers-portforward.nix+5−8
This diff is too big to show here.
nixos/tests/containers-reloadable.nix+3−4
This diff is too big to show here.
nixos/tests/containers-restart_networking.nix+3−5
This diff is too big to show here.
nixos/tests/containers-tmpfs.nix+10−13
This diff is too big to show here.
nixos/tests/convos.nix+1−1
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+4−39
This diff is too big to show here.
nixos/tests/cri-o.nix+1−1
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+12−58
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/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+1−1
This diff is too big to show here.
nixos/tests/dnscrypt-wrapper/default.nix+2−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+16−1
This diff is too big to show here.
nixos/tests/docker-edge.nix+1−1
This diff is too big to show here.
nixos/tests/docker-registry.nix+1−1
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+3−3
This diff is too big to show here.
nixos/tests/docker-tools-overlay.nix+2−2
This diff is too big to show here.
nixos/tests/docker-tools.nix+181−9
This diff is too big to show here.
nixos/tests/docker.nix+4−1
This diff is too big to show here.
nixos/tests/documize.nix+2−2
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+63−28
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+8−3
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+5
This diff is too big to show here.
nixos/tests/ecryptfs.nix+1−1
This diff is too big to show here.
nixos/tests/elk.nix+133−41
This diff is too big to show here.
nixos/tests/emacs-daemon.nix+3−3
This diff is too big to show here.
nixos/tests/empty-file
This diff is too big to show here.
nixos/tests/engelsystem.nix+1−1
This diff is too big to show here.
nixos/tests/enlightenment.nix+5−6
This diff is too big to show here.
nixos/tests/env.nix+2−2
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+1−1
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+1−1
This diff is too big to show here.
nixos/tests/etcd.nix+1−1
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+3−3
This diff is too big to show here.
nixos/tests/fancontrol.nix+23−17
This diff is too big to show here.
nixos/tests/fcitx/default.nix+1−2
This diff is too big to show here.
nixos/tests/fenics.nix+2−3
This diff is too big to show here.
nixos/tests/ferm.nix+1−1
This diff is too big to show here.
nixos/tests/firefox.nix+10−12
This diff is too big to show here.
nixos/tests/firejail.nix+1−1
This diff is too big to show here.
nixos/tests/firewall.nix+1−1
This diff is too big to show here.
nixos/tests/fish.nix+1−1
This diff is too big to show here.
nixos/tests/fluentd.nix+1−1
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+1−2
This diff is too big to show here.
nixos/tests/freeswitch.nix+1−1
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+2−2
This diff is too big to show here.
nixos/tests/ft2-clone.nix+2−2
This diff is too big to show here.
nixos/tests/gerrit.nix+1−2
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+6−2
This diff is too big to show here.
nixos/tests/gitea.nix+1−1
This diff is too big to show here.
nixos/tests/gitlab.nix+401−60
This diff is too big to show here.
nixos/tests/gitolite-fcgiwrap.nix+3−3
This diff is too big to show here.
nixos/tests/gitolite.nix+1−1
This diff is too big to show here.
nixos/tests/glusterfs.nix+2−2
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/gnome3-xorg.nix−81
This diff is too big to show here.
nixos/tests/gnome3.nix−82
This diff is too big to show here.
nixos/tests/go-neb.nix+7−7
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+2−2
This diff is too big to show here.
nixos/tests/gocd-server.nix+1−1
This diff is too big to show here.
nixos/tests/google-oslogin/default.nix+3−3
This diff is too big to show here.
nixos/tests/google-oslogin/server.nix+2−4
This diff is too big to show here.
nixos/tests/google-oslogin/server.py
This diff is too big to show here.
nixos/tests/gotify-server.nix+2−2
This diff is too big to show here.
nixos/tests/grafana.nix+16−4
This diff is too big to show here.
nixos/tests/graphite.nix−1
This diff is too big to show here.
nixos/tests/graylog.nix+2−2
This diff is too big to show here.
nixos/tests/grocy.nix+3−3
This diff is too big to show here.
nixos/tests/grub.nix+1−1
This diff is too big to show here.
nixos/tests/gvisor.nix+1−1
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+57−27
This diff is too big to show here.
nixos/tests/hadoop/yarn.nix+22−23
This diff is too big to show here.
nixos/tests/haka.nix+1−1
This diff is too big to show here.
nixos/tests/handbrake.nix−31
This diff is too big to show here.
nixos/tests/haproxy.nix−1
This diff is too big to show here.
nixos/tests/hardened.nix+8−44
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/herbstluftwm.nix+37
This diff is too big to show here.
nixos/tests/hibernate.nix+113−24
This diff is too big to show here.
nixos/tests/hitch/default.nix+2−2
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+2−2
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+95−36
This diff is too big to show here.
nixos/tests/hostname.nix+12−6
This diff is too big to show here.
nixos/tests/hound.nix+2−2
This diff is too big to show here.
nixos/tests/hydra/common.nix+2−2
This diff is too big to show here.
nixos/tests/hydra/default.nix+3−3
This diff is too big to show here.
nixos/tests/i3wm.nix+2−2
This diff is too big to show here.
nixos/tests/icingaweb2.nix+1−1
This diff is too big to show here.
nixos/tests/iftop.nix+1−1
This diff is too big to show here.
nixos/tests/ihatemoney.nix−62
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/incron.nix+1−1
This diff is too big to show here.
nixos/tests/influxdb.nix+1−1
This diff is too big to show here.
nixos/tests/initrd-network.nix+2−2
This diff is too big to show here.
nixos/tests/initrd-secrets.nix+9−3
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/default.nix+5−1
This diff is too big to show here.
nixos/tests/installed-tests/flatpak.nix+1
This diff is too big to show here.
nixos/tests/installed-tests/fwupd.nix−1
This diff is too big to show here.
nixos/tests/installed-tests/gjs.nix+6
This diff is too big to show here.
nixos/tests/installed-tests/gnome-photos.nix+1−1
This diff is too big to show here.
nixos/tests/installed-tests/libgdata.nix+1−1
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/pipewire.nix+10
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/installer-systemd-stage-1.nix+33
This diff is too big to show here.
nixos/tests/installer.nix+67−54
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/ipfs.nix+6−1
This diff is too big to show here.
nixos/tests/ipv6.nix+63−24
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/jellyfin.nix+155−16
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+86−3
This diff is too big to show here.
nixos/tests/jibri.nix+69
This diff is too big to show here.
nixos/tests/jitsi-meet.nix+3−9
This diff is too big to show here.
nixos/tests/jq.nix−10
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/k3s.nix−78
This diff is too big to show here.
nixos/tests/kafka.nix+3−9
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/keepassxc.nix+68
This diff is too big to show here.
nixos/tests/kerberos/heimdal.nix+2−2
This diff is too big to show here.
nixos/tests/kerberos/mit.nix+1−1
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/kernel-latest.nix−17
This diff is too big to show here.
nixos/tests/kernel-lts.nix−17
This diff is too big to show here.
nixos/tests/kernel-testing.nix−17
This diff is too big to show here.
nixos/tests/kexec.nix+44−19
This diff is too big to show here.
nixos/tests/keycloak.nix+47−11
This diff is too big to show here.
nixos/tests/keymap.nix+25−4
This diff is too big to show here.
nixos/tests/knot.nix+7−1
This diff is too big to show here.
nixos/tests/krb5/deprecated-config.nix+2−2
This diff is too big to show here.
nixos/tests/krb5/example-config.nix+2−2
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+3−4
This diff is too big to show here.
nixos/tests/kubernetes/default.nix+13−5
This diff is too big to show here.
nixos/tests/kubernetes/dns.nix+10−11
This diff is too big to show here.
nixos/tests/kubernetes/e2e.nix+1−1
This diff is too big to show here.
nixos/tests/kubernetes/rbac.nix+12−12
This diff is too big to show here.
nixos/tests/leaps.nix+1−1
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/lightdm.nix+3−3
This diff is too big to show here.
nixos/tests/limesurvey.nix+2−2
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+2−2
This diff is too big to show here.
nixos/tests/login.nix+3−3
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+1−1
This diff is too big to show here.
nixos/tests/lorri/default.nix+1−1
This diff is too big to show here.
nixos/tests/lsd.nix−12
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+2−2
This diff is too big to show here.
nixos/tests/lxd.nix+42−65
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+2−2
This diff is too big to show here.
nixos/tests/magnetico.nix+2−2
This diff is too big to show here.
nixos/tests/mailcatcher.nix+8−3
This diff is too big to show here.
nixos/tests/mailhog.nix+1−1
This diff is too big to show here.
nixos/tests/make-test-python.nix+1−1
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+2−2
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+141−10
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/mediawiki.nix+1−1
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+1−1
This diff is too big to show here.
nixos/tests/metabase.nix+1−2
This diff is too big to show here.
nixos/tests/minecraft-server.nix+2−2
This diff is too big to show here.
nixos/tests/minecraft.nix+1−1
This diff is too big to show here.
nixos/tests/minidlna.nix+4−2
This diff is too big to show here.
nixos/tests/miniflux.nix+36−10
This diff is too big to show here.
nixos/tests/minio.nix+5−2
This diff is too big to show here.
nixos/tests/misc.nix+9−8
This diff is too big to show here.
nixos/tests/mod_perl.nix+53
This diff is too big to show here.
nixos/tests/moinmoin.nix−28
This diff is too big to show here.
nixos/tests/molly-brown.nix+1−1
This diff is too big to show here.
nixos/tests/mongodb.nix+5−1
This diff is too big to show here.
nixos/tests/moodle.nix+1−1
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+1−1
This diff is too big to show here.
nixos/tests/mosquitto.nix+168−50
This diff is too big to show here.
nixos/tests/mpd.nix+3−3
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+3−3
This diff is too big to show here.
nixos/tests/munin.nix+2−2
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+29−1
This diff is too big to show here.
nixos/tests/mxisd.nix+5−14
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-mariabackup.nix−223
This diff is too big to show here.
nixos/tests/mysql/mariadb-galera-rsync.nix−216
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+48−33
This diff is too big to show here.
nixos/tests/mysql/mysql-backup.nix+60−44
This diff is too big to show here.
nixos/tests/mysql/mysql-replication.nix+84−74
This diff is too big to show here.
nixos/tests/mysql/mysql.nix+134−188
This diff is too big to show here.
nixos/tests/nagios.nix+2−2
This diff is too big to show here.
nixos/tests/nano.nix−44
This diff is too big to show here.
nixos/tests/nar-serve.nix+1−1
This diff is too big to show here.
nixos/tests/nat.nix+1−1
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+7−10
This diff is too big to show here.
nixos/tests/ndppd.nix+1−1
This diff is too big to show here.
nixos/tests/nebula.nix+223
This diff is too big to show here.
nixos/tests/netdata.nix+1−1
This diff is too big to show here.
nixos/tests/networking-proxy.nix+1−2
This diff is too big to show here.
nixos/tests/networking.nix+249−16
This diff is too big to show here.
nixos/tests/nextcloud/basic.nix+35−8
This diff is too big to show here.
nixos/tests/nextcloud/default.nix+20−8
This diff is too big to show here.
nixos/tests/nextcloud/with-mysql-and-memcached.nix+9−19
This diff is too big to show here.
nixos/tests/nextcloud/with-postgresql-and-redis.nix+6−3
This diff is too big to show here.
nixos/tests/nexus.nix+2−2
This diff is too big to show here.
nixos/tests/nfs/kerberos.nix+5−5
This diff is too big to show here.
nixos/tests/nfs/simple.nix+3−3
This diff is too big to show here.
nixos/tests/nginx-etag.nix+1−2
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+1−1
This diff is too big to show here.
nixos/tests/nginx-sandbox.nix+2−2
This diff is too big to show here.
nixos/tests/nginx-sso.nix+2−2
This diff is too big to show here.
nixos/tests/nginx-variants.nix+2−2
This diff is too big to show here.
nixos/tests/nginx.nix+3−3
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/nix-ssh-serve.nix−45
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+6−7
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+2−2
This diff is too big to show here.
nixos/tests/nsd.nix+11−1
This diff is too big to show here.
nixos/tests/nzbget.nix+19−3
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+1−1
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+1−1
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+3−3
This diff is too big to show here.
nixos/tests/openldap.nix+15−10
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/openssh.nix+13−7
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+1−1
This diff is too big to show here.
nixos/tests/os-prober.nix+13−15
This diff is too big to show here.
nixos/tests/osrm-backend.nix+1−1
This diff is too big to show here.
nixos/tests/overlayfs.nix+29−32
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+2−3
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+3−3
This diff is too big to show here.
nixos/tests/pam/pam-u2f.nix+2−2
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+7−8
This diff is too big to show here.
nixos/tests/paperless.nix+25−17
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+4−1
This diff is too big to show here.
nixos/tests/peerflix.nix+1−1
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/pgmanage.nix+1−1
This diff is too big to show here.
nixos/tests/php/default.nix+15−7
This diff is too big to show here.
nixos/tests/php/fpm.nix+25−19
This diff is too big to show here.
nixos/tests/php/httpd.nix+14−11
This diff is too big to show here.
nixos/tests/php/pcre.nix+14−11
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+10−2
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+6−7
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+3−3
This diff is too big to show here.
nixos/tests/podgrab.nix+34
This diff is too big to show here.
nixos/tests/podman.nix−88
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+1−1
This diff is too big to show here.
nixos/tests/postfix.nix+1−1
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+1−1
This diff is too big to show here.
nixos/tests/postgresql-wal-receiver.nix+13−5
This diff is too big to show here.
nixos/tests/postgresql.nix+51−4
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+1
This diff is too big to show here.
nixos/tests/predictable-interface-names.nix+7−3
This diff is too big to show here.
nixos/tests/printing.nix+3−12
This diff is too big to show here.
nixos/tests/privacyidea.nix+12−5
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+681−205
This diff is too big to show here.
nixos/tests/prometheus.nix+91−1
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+1−1
This diff is too big to show here.
nixos/tests/pt2-clone.nix+3−3
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+1−1
This diff is too big to show here.
nixos/tests/quagga.nix−96
This diff is too big to show here.
nixos/tests/quorum.nix+33−10
This diff is too big to show here.
nixos/tests/rabbitmq.nix+9−3
This diff is too big to show here.
nixos/tests/radicale.nix+82−127
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+29−7
This diff is too big to show here.
nixos/tests/redmine.nix+1−1
This diff is too big to show here.
nixos/tests/resolv.nix+1−1
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+7−1
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+1−1
This diff is too big to show here.
nixos/tests/ripgrep.nix−13
This diff is too big to show here.
nixos/tests/robustirc-bridge.nix+1−1
This diff is too big to show here.
nixos/tests/roundcube.nix+1−1
This diff is too big to show here.
nixos/tests/rspamd.nix+9−6
This diff is too big to show here.
nixos/tests/rss2email.nix+1−1
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+25−14
This diff is too big to show here.
nixos/tests/rsyslogd.nix+4−4
This diff is too big to show here.
nixos/tests/run-in-machine.nix−23
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+2−2
This diff is too big to show here.
nixos/tests/samba.nix+2−3
This diff is too big to show here.
nixos/tests/sanoid.nix+38−17
This diff is too big to show here.
nixos/tests/sbt-extras.nix−16
This diff is too big to show here.
nixos/tests/sbt.nix−18
This diff is too big to show here.
nixos/tests/scala.nix−33
This diff is too big to show here.
nixos/tests/sddm.nix+3−3
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+2−2
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+30−13
This diff is too big to show here.
nixos/tests/shattered-pixel-dungeon.nix+3−2
This diff is too big to show here.
nixos/tests/shiori.nix+2−3
This diff is too big to show here.
nixos/tests/signal-desktop.nix+33−7
This diff is too big to show here.
nixos/tests/simple.nix+2−2
This diff is too big to show here.
nixos/tests/slurm.nix+6−6
This diff is too big to show here.
nixos/tests/smokeping.nix+2−1
This diff is too big to show here.
nixos/tests/snapcast.nix+33−1
This diff is too big to show here.
nixos/tests/snapper.nix+2−2
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+2−2
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+2−2
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+19−14
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/spike.nix−22
This diff is too big to show here.
nixos/tests/ssh-keys.nix+1−1
This diff is too big to show here.
nixos/tests/sssd-ldap.nix+79−81
This diff is too big to show here.
nixos/tests/sssd.nix+2−2
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+1−1
This diff is too big to show here.
nixos/tests/sudo.nix+26−3
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+1017−7
This diff is too big to show here.
nixos/tests/sympa.nix+1−2
This diff is too big to show here.
nixos/tests/syncthing-init.nix+10−10
This diff is too big to show here.
nixos/tests/syncthing-relay.nix+2−2
This diff is too big to show here.
nixos/tests/syncthing.nix+3−3
This diff is too big to show here.
nixos/tests/systemd-analyze.nix+2−2
This diff is too big to show here.
nixos/tests/systemd-binfmt.nix+86−20
This diff is too big to show here.
nixos/tests/systemd-boot.nix+172−8
This diff is too big to show here.
nixos/tests/systemd-confinement.nix+46−23
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+4−2
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+1−1
This diff is too big to show here.
nixos/tests/systemd-networkd-ipv6-prefix-delegation.nix+14−25
This diff is too big to show here.
nixos/tests/systemd-networkd-vrf.nix+2
This diff is too big to show here.
nixos/tests/systemd-networkd.nix+11−2
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.nix+18−3
This diff is too big to show here.
nixos/tests/taskserver.nix+1
This diff is too big to show here.
nixos/tests/teeworlds.nix+3−3
This diff is too big to show here.
nixos/tests/telegraf.nix+2−2
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/tigervnc.nix+53
This diff is too big to show here.
nixos/tests/tinydns.nix+15−1
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+10−15
This diff is too big to show here.
nixos/tests/trac.nix−19
This diff is too big to show here.
nixos/tests/traefik.nix+5−3
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+2−2
This diff is too big to show here.
nixos/tests/trezord.nix+1−1
This diff is too big to show here.
nixos/tests/trickster.nix+1−1
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+2−2
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/ucg.nix−18
This diff is too big to show here.
nixos/tests/udisks2.nix+3−3
This diff is too big to show here.
nixos/tests/unbound.nix+69−32
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+1−1
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+47−18
This diff is too big to show here.
nixos/tests/v2ray.nix+2−2
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+5−3
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+2−2
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+1−1
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+10−16
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+2−2
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+21−31
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+4−4
This diff is too big to show here.
nixos/tests/wireguard/generated.nix+1−1
This diff is too big to show here.
nixos/tests/wireguard/namespaces.nix+1−1
This diff is too big to show here.
nixos/tests/wireguard/wg-quick.nix+2−2
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+57−24
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+4−4
This diff is too big to show here.
nixos/tests/xautolock.nix+1−1
This diff is too big to show here.
nixos/tests/xfce.nix+2−3
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+85−18
This diff is too big to show here.
nixos/tests/xmpp/ejabberd.nix+1−1
This diff is too big to show here.
nixos/tests/xmpp/prosody-mysql.nix+65−33
This diff is too big to show here.
nixos/tests/xmpp/prosody.nix+4−3
This diff is too big to show here.
nixos/tests/xmpp/xmpp-sendmessage.nix+25−6
This diff is too big to show here.
nixos/tests/xrdp.nix+3−3
This diff is too big to show here.
nixos/tests/xss-lock.nix+1−1
This diff is too big to show here.
nixos/tests/xterm.nix+3−3
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+3−3
This diff is too big to show here.
nixos/tests/yggdrasil.nix+9−13
This diff is too big to show here.
nixos/tests/yq.nix−12
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+77−4
This diff is too big to show here.
nixos/tests/zigbee2mqtt.nix+6−2
This diff is too big to show here.
nixos/tests/zoneminder.nix+1−1
This diff is too big to show here.
nixos/tests/zookeeper.nix+1−1
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+3−3
This diff is too big to show here.
pkgs/applications/accessibility/contrast/default.nix+26−23
This diff is too big to show here.
pkgs/applications/accessibility/dasher/default.nix+34−19
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+6−6
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+5−5
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+5−5
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+10−9
This diff is too big to show here.
pkgs/applications/audio/a2jmidid/default.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/aacgain/default.nix+9−4
This diff is too big to show here.
pkgs/applications/audio/abcde/default.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/adlplug/default.nix+77−15
This diff is too big to show here.
pkgs/applications/audio/aeolus/default.nix+5−5
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+5−5
This diff is too big to show here.
pkgs/applications/audio/aj-snapshot/default.nix+9−10
This diff is too big to show here.
pkgs/applications/audio/amarok/default.nix+11−14
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+4−4
This diff is too big to show here.
pkgs/applications/audio/ams/default.nix+5−5
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/5.nix−162
This diff is too big to show here.
pkgs/applications/audio/ardour/default.nix+22−13
This diff is too big to show here.
pkgs/applications/audio/ario/default.nix+30−11
This diff is too big to show here.
pkgs/applications/audio/artyFX/default.nix+5−5
This diff is too big to show here.
pkgs/applications/audio/ashuffle/default.nix+13−5
This diff is too big to show here.
pkgs/applications/audio/asunder/default.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/aucatctl/default.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/audacious/default.nix+12−10
This diff is too big to show here.
pkgs/applications/audio/audacity/default.nix+186−46
This diff is too big to show here.
pkgs/applications/audio/audio-recorder/default.nix+6−6
This diff is too big to show here.
pkgs/applications/audio/aumix/default.nix+28−13
This diff is too big to show here.
pkgs/applications/audio/autotalent/default.nix+2−2
This diff is too big to show here.
pkgs/applications/audio/axoloti/default.nix+2−2
This diff is too big to show here.
pkgs/applications/audio/axoloti/dfu-util.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/axoloti/libusb1.nix+11−10
This diff is too big to show here.
pkgs/applications/audio/bambootracker/default.nix+22−26
This diff is too big to show here.
pkgs/applications/audio/baudline/default.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/bchoppr/default.nix+5−5
This diff is too big to show here.
pkgs/applications/audio/bespokesynth/default.nix+148
This diff is too big to show here.
pkgs/applications/audio/bitmeter/default.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/bitwig-studio/bitwig-studio1.nix+6−6
This diff is too big to show here.
pkgs/applications/audio/bitwig-studio/bitwig-studio2.nix+1−1
This diff is too big to show here.
pkgs/applications/audio/bitwig-studio/bitwig-studio3.nix+71−13
This diff is too big to show here.
pkgs/applications/audio/bitwig-studio/bitwig-studio4.nix+80
This diff is too big to show here.
pkgs/applications/audio/bjumblr/default.nix+7−7
This diff is too big to show here.
pkgs/applications/audio/blanket/default.nix+69
This diff is too big to show here.
pkgs/applications/audio/boops/default.nix+28
This diff is too big to show here.
pkgs/applications/audio/bristol/default.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/bs1770gain/default.nix−22
This diff is too big to show here.
pkgs/applications/audio/bschaffl/default.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/bsequencer/default.nix+7−7
This diff is too big to show here.
pkgs/applications/audio/bshapr/default.nix+7−7
This diff is too big to show here.
pkgs/applications/audio/bslizr/default.nix+7−7
This diff is too big to show here.
pkgs/applications/audio/bucklespring/default.nix+63
This diff is too big to show here.
pkgs/applications/audio/cadence/default.nix+53−44
This diff is too big to show here.
pkgs/applications/audio/calf/default.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/callaudiod/default.nix+45
This diff is too big to show here.
pkgs/applications/audio/cantata/default.nix+74−61
This diff is too big to show here.
pkgs/applications/audio/caps/default.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/cardinal/default.nix+67
This diff is too big to show here.
pkgs/applications/audio/carla/default.nix+21−11
This diff is too big to show here.
pkgs/applications/audio/caudec/default.nix+9−13
This diff is too big to show here.
pkgs/applications/audio/cava/default.nix+5−5
This diff is too big to show here.
pkgs/applications/audio/cd-discid/default.nix+3−4
This diff is too big to show here.
pkgs/applications/audio/cdparanoia/default.nix+20−10
This diff is too big to show here.
pkgs/applications/audio/cheesecutter/default.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/chuck/default.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/cider/default.nix+30
This diff is too big to show here.
pkgs/applications/audio/clementine/default.nix+75−22
This diff is too big to show here.
pkgs/applications/audio/clerk/default.nix+38−12
This diff is too big to show here.
pkgs/applications/audio/cmt/default.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/cmus/default.nix+13−13
This diff is too big to show here.
pkgs/applications/audio/cmusfm/default.nix+19−13
This diff is too big to show here.
pkgs/applications/audio/cozy-audiobooks/default.nix−87
This diff is too big to show here.
pkgs/applications/audio/cozy/default.nix+92
This diff is too big to show here.
pkgs/applications/audio/crip/default.nix+7−6
This diff is too big to show here.
pkgs/applications/audio/csa/default.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/csound/csound-manual/default.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/csound/csound-qt/default.nix+4−2
This diff is too big to show here.
pkgs/applications/audio/csound/default.nix+9−14
This diff is too big to show here.
pkgs/applications/audio/curseradio/default.nix+2−2
This diff is too big to show here.
pkgs/applications/audio/cyanrip/default.nix+34
This diff is too big to show here.
pkgs/applications/audio/deadbeef/default.nix+12−13
This diff is too big to show here.
pkgs/applications/audio/deadbeef/plugins/headerbar-gtk3.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/deadbeef/plugins/infobar.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/deadbeef/plugins/lyricbar.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/deadbeef/plugins/mpris2.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/deadbeef/plugins/statusnotifier.nix+39
This diff is too big to show here.
pkgs/applications/audio/deadbeef/wrapper.nix+1−1
This diff is too big to show here.
pkgs/applications/audio/denemo/default.nix+5−5
This diff is too big to show here.
pkgs/applications/audio/dfasma/default.nix+5−7
This diff is too big to show here.
pkgs/applications/audio/diopser/default.nix+76
This diff is too big to show here.
pkgs/applications/audio/dirt/default.nix+4−3
This diff is too big to show here.
pkgs/applications/audio/distrho/default.nix+26−8
This diff is too big to show here.
pkgs/applications/audio/dr14_tmeter/default.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/dragonfly-reverb/default.nix+9−7
This diff is too big to show here.
pkgs/applications/audio/drumgizmo/default.nix+10−18
This diff is too big to show here.
pkgs/applications/audio/drumkv1/default.nix+5−5
This diff is too big to show here.
pkgs/applications/audio/dsf2flac/default.nix+2−2
This diff is too big to show here.
pkgs/applications/audio/easyeffects/default.nix+113
This diff is too big to show here.
pkgs/applications/audio/easytag/default.nix+7−7
This diff is too big to show here.
pkgs/applications/audio/ebumeter/default.nix+33
This diff is too big to show here.
pkgs/applications/audio/ecasound/default.nix+50−5
This diff is too big to show here.
pkgs/applications/audio/eflite/default.nix+6−6
This diff is too big to show here.
pkgs/applications/audio/ekho/default.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/ensemble-chorus/default.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/eq10q/default.nix+6−6
This diff is too big to show here.
pkgs/applications/audio/espeak-ng/default.nix+30−6
This diff is too big to show here.
pkgs/applications/audio/espeak-ng/mbrola.patch+22
This diff is too big to show here.
pkgs/applications/audio/espeak/default.nix+7−5
This diff is too big to show here.
pkgs/applications/audio/espeak/edit.nix+8−7
This diff is too big to show here.
pkgs/applications/audio/eteroj.lv2/default.nix−23
This diff is too big to show here.
pkgs/applications/audio/exaile/default.nix+107
This diff is too big to show here.
pkgs/applications/audio/faust/faust1.nix+7−8
This diff is too big to show here.
pkgs/applications/audio/faust/faust2.nix+20−13
This diff is too big to show here.
pkgs/applications/audio/faust/faust2alqt.nix+2−2
This diff is too big to show here.
pkgs/applications/audio/faust/faust2alsa.nix+2−2
This diff is too big to show here.
pkgs/applications/audio/faust/faust2firefox.nix+2−2
This diff is too big to show here.
pkgs/applications/audio/faust/faust2jack.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/faust/faust2jackrust.nix+3−4
This diff is too big to show here.
pkgs/applications/audio/faust/faust2jaqt.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/faust/faustlive.nix+15−15
This diff is too big to show here.
pkgs/applications/audio/faustPhysicalModeling/default.nix+39
This diff is too big to show here.
pkgs/applications/audio/faustStk/default.nix+39
This diff is too big to show here.
pkgs/applications/audio/fdkaac/default.nix+5−5
This diff is too big to show here.
pkgs/applications/audio/flac/default.nix+6−5
This diff is too big to show here.
pkgs/applications/audio/flac123/default.nix+2−2
This diff is too big to show here.
pkgs/applications/audio/flacon/default.nix+5−5
This diff is too big to show here.
pkgs/applications/audio/fluidsynth/default.nix+10−26
This diff is too big to show here.
pkgs/applications/audio/fmit/default.nix+5−7
This diff is too big to show here.
pkgs/applications/audio/fmsynth/default.nix+5−5
This diff is too big to show here.
pkgs/applications/audio/fomp/default.nix+8−8
This diff is too big to show here.
pkgs/applications/audio/foo-yc20/default.nix−29
This diff is too big to show here.
pkgs/applications/audio/freac/default.nix+38
This diff is too big to show here.
pkgs/applications/audio/freewheeling/default.nix+8−8
This diff is too big to show here.
pkgs/applications/audio/freqtweak/default.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/friture/default.nix+21−8
This diff is too big to show here.
pkgs/applications/audio/friture/factorial.patch−13
This diff is too big to show here.
pkgs/applications/audio/friture/unlock_constraints.patch−34
This diff is too big to show here.
pkgs/applications/audio/ft2-clone/default.nix+29−7
This diff is too big to show here.
pkgs/applications/audio/furnace/default.nix+100
This diff is too big to show here.
pkgs/applications/audio/fverb/default.nix+2−2
This diff is too big to show here.
pkgs/applications/audio/game-music-emu/default.nix+8−8
This diff is too big to show here.
pkgs/applications/audio/gbsplay/default.nix+18−14
This diff is too big to show here.
pkgs/applications/audio/geonkick/default.nix+5−6
This diff is too big to show here.
pkgs/applications/audio/giada/default.nix+41−27
This diff is too big to show here.
pkgs/applications/audio/gigedit/default.nix+22−5
This diff is too big to show here.
pkgs/applications/audio/gjay/default.nix+26−9
This diff is too big to show here.
pkgs/applications/audio/gmpc/default.nix+34−8
This diff is too big to show here.
pkgs/applications/audio/gmu/default.nix+23−4
This diff is too big to show here.
pkgs/applications/audio/gnaural/default.nix+33
This diff is too big to show here.
pkgs/applications/audio/gnome-podcasts/default.nix+33−20
This diff is too big to show here.
pkgs/applications/audio/goattracker/default.nix+9−10
This diff is too big to show here.
pkgs/applications/audio/google-musicmanager/default.nix−77
This diff is too big to show here.
pkgs/applications/audio/google-play-music-desktop-player/default.nix+7−7
This diff is too big to show here.
pkgs/applications/audio/gpodder/default.nix+20−10
This diff is too big to show here.
pkgs/applications/audio/gpodder/disable-autoupdate.patch+8−29
This diff is too big to show here.
pkgs/applications/audio/gradio/default.nix+3−4
This diff is too big to show here.
pkgs/applications/audio/grandorgue/default.nix+5−5
This diff is too big to show here.
pkgs/applications/audio/greg/default.nix+5−5
This diff is too big to show here.
pkgs/applications/audio/gspeech/default.nix+2−2
This diff is too big to show here.
pkgs/applications/audio/gtklick/default.nix−34
This diff is too big to show here.
pkgs/applications/audio/gtkpod/default.nix+8−7
This diff is too big to show here.
pkgs/applications/audio/guitarix/default.nix+23−13
This diff is too big to show here.
pkgs/applications/audio/gwc/default.nix+6−6
This diff is too big to show here.
pkgs/applications/audio/gxmatcheq-lv2/default.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/gxplugins-lv2/default.nix+6−6
This diff is too big to show here.
pkgs/applications/audio/helio-workstation/default.nix+12−12
This diff is too big to show here.
pkgs/applications/audio/helm/default.nix+10−15
This diff is too big to show here.
pkgs/applications/audio/helvum/default.nix+60
This diff is too big to show here.
pkgs/applications/audio/hivelytracker/default.nix+89
This diff is too big to show here.
pkgs/applications/audio/hqplayer-desktop/default.nix+92
This diff is too big to show here.
pkgs/applications/audio/hushboard/default.nix+73
This diff is too big to show here.
pkgs/applications/audio/hybridreverb2/default.nix+47−12
This diff is too big to show here.
pkgs/applications/audio/hydrogen/0.nix+30−8
This diff is too big to show here.
pkgs/applications/audio/hydrogen/default.nix+8−8
This diff is too big to show here.
pkgs/applications/audio/i-score/default.nix−85
This diff is too big to show here.
pkgs/applications/audio/iannix/default.nix+6−8
This diff is too big to show here.
pkgs/applications/audio/id3v2/default.nix+2−2
This diff is too big to show here.
pkgs/applications/audio/in-formant/default.nix+45
This diff is too big to show here.
pkgs/applications/audio/indicator-sound-switcher/default.nix+62
This diff is too big to show here.
pkgs/applications/audio/industrializer/default.nix+7−9
This diff is too big to show here.
pkgs/applications/audio/infamousPlugins/default.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/ingen/default.nix+12−15
This diff is too big to show here.
pkgs/applications/audio/ir.lv2/default.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/jaaa/default.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/jack-capture/default.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/jack-oscrolloscope/default.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/jack-rack/default.nix+9−8
This diff is too big to show here.
pkgs/applications/audio/jackmeter/default.nix+9−8
This diff is too big to show here.
pkgs/applications/audio/jackmix/default.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/jacktrip/default.nix+61
This diff is too big to show here.
pkgs/applications/audio/jalv/default.nix+6−6
This diff is too big to show here.
pkgs/applications/audio/jamesdsp/default.nix+95
This diff is too big to show here.
pkgs/applications/audio/jamin/default.nix+6−6
This diff is too big to show here.
pkgs/applications/audio/jamulus/default.nix+8−8
This diff is too big to show here.
pkgs/applications/audio/japa/default.nix+7−7
This diff is too big to show here.
pkgs/applications/audio/jconvolver/default.nix+114
This diff is too big to show here.
pkgs/applications/audio/jellycli/default.nix+33
This diff is too big to show here.
pkgs/applications/audio/jellycli/fix-test-dir.patch+13
This diff is too big to show here.
pkgs/applications/audio/jmusicbot/default.nix+31
This diff is too big to show here.
pkgs/applications/audio/kapitonov-plugins-pack/default.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/keyfinder-cli/default.nix+6−6
This diff is too big to show here.
pkgs/applications/audio/keyfinder/default.nix+7−8
This diff is too big to show here.
pkgs/applications/audio/kid3/default.nix+56−17
This diff is too big to show here.
pkgs/applications/audio/klick/default.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/klystrack/default.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/kmetronome/default.nix+8−6
This diff is too big to show here.
pkgs/applications/audio/ladspa-plugins/default.nix+19−9
This diff is too big to show here.
pkgs/applications/audio/ladspa-sdk/default.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/ladspa-sdk/ladspah.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/lash/default.nix+5−5
This diff is too big to show here.
pkgs/applications/audio/lastfmsubmitd/default.nix−21
This diff is too big to show here.
pkgs/applications/audio/librespot/cargo-lock.patch−137
This diff is too big to show here.
pkgs/applications/audio/librespot/default.nix+16−23
This diff is too big to show here.
pkgs/applications/audio/lingot/default.nix+8−8
This diff is too big to show here.
pkgs/applications/audio/linuxband/default.nix−37
This diff is too big to show here.
pkgs/applications/audio/linuxsampler/default.nix+7−7
This diff is too big to show here.
pkgs/applications/audio/littlegptracker/default.nix+11−9
This diff is too big to show here.
pkgs/applications/audio/lmms/default.nix+7−8
This diff is too big to show here.
pkgs/applications/audio/lollypop/default.nix+5−5
This diff is too big to show here.
pkgs/applications/audio/losslessaudiochecker/default.nix+29
This diff is too big to show here.
pkgs/applications/audio/lsp-plugins/default.nix+16−9
This diff is too big to show here.
pkgs/applications/audio/ltc-tools/default.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/luppp/default.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/lv2-cpp-tools/default.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/lv2bm/default.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/lv2lint/default.nix+22
This diff is too big to show here.
pkgs/applications/audio/lyrebird/default.nix+2−2
This diff is too big to show here.
pkgs/applications/audio/m4acut/default.nix+24
This diff is too big to show here.
pkgs/applications/audio/magnetophonDSP/CharacterCompressor/default.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/magnetophonDSP/CompBus/default.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/magnetophonDSP/ConstantDetuneChorus/default.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/magnetophonDSP/LazyLimiter/default.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/magnetophonDSP/MBdistortion/default.nix+10−3
This diff is too big to show here.
pkgs/applications/audio/magnetophonDSP/RhythmDelay/default.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/magnetophonDSP/VoiceOfFaust/default.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/magnetophonDSP/faustCompressors/default.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/magnetophonDSP/pluginUtils/default.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/magnetophonDSP/shelfMultiBand/default.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/mamba/default.nix+8−7
This diff is too big to show here.
pkgs/applications/audio/mbrola/default.nix+42
This diff is too big to show here.
pkgs/applications/audio/mda-lv2/default.nix+5−5
This diff is too big to show here.
pkgs/applications/audio/mellowplayer/default.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/melmatcheq.lv2/default.nix+2−2
This diff is too big to show here.
pkgs/applications/audio/meterbridge/default.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/meters_lv2/default.nix+43−36
This diff is too big to show here.
pkgs/applications/audio/mhwaveedit/default.nix+5−5
This diff is too big to show here.
pkgs/applications/audio/mi2ly/default.nix+17−26
This diff is too big to show here.
pkgs/applications/audio/mi2ly/default.upstream−3
This diff is too big to show here.
pkgs/applications/audio/mid2key/default.nix+9−6
This diff is too big to show here.
pkgs/applications/audio/midas/generic.nix+7−8
This diff is too big to show here.
pkgs/applications/audio/midi-visualizer/default.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/midisheetmusic/default.nix+5−5
This diff is too big to show here.
pkgs/applications/audio/mikmod/default.nix+7−6
This diff is too big to show here.
pkgs/applications/audio/milkytracker/default.nix+15−9
This diff is too big to show here.
pkgs/applications/audio/mimic/default.nix+20−12
This diff is too big to show here.
pkgs/applications/audio/mimms/default.nix−31
This diff is too big to show here.
pkgs/applications/audio/miniaudicle/default.nix+59
This diff is too big to show here.
pkgs/applications/audio/mixxx/default.nix+119−35
This diff is too big to show here.
pkgs/applications/audio/mmtc/default.nix+32
This diff is too big to show here.
pkgs/applications/audio/moc/default.nix+14−14
This diff is too big to show here.
pkgs/applications/audio/mod-arpeggiator-lv2/default.nix+26
This diff is too big to show here.
pkgs/applications/audio/mod-distortion/default.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/molot-lite/default.nix+16−19
This diff is too big to show here.
pkgs/applications/audio/monkeys-audio/default.nix+2−2
This diff is too big to show here.
pkgs/applications/audio/mooSpace/default.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/mopidy/default.nix+25−23
This diff is too big to show here.
pkgs/applications/audio/mopidy/gmusic.nix−29
This diff is too big to show here.
pkgs/applications/audio/mopidy/iris.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/mopidy/jellyfin.nix+25
This diff is too big to show here.
pkgs/applications/audio/mopidy/local.nix+2−2
This diff is too big to show here.
pkgs/applications/audio/mopidy/moped.nix+2−2
This diff is too big to show here.
pkgs/applications/audio/mopidy/mopidy.nix+7−11
This diff is too big to show here.
pkgs/applications/audio/mopidy/mopify.nix+2−2
This diff is too big to show here.
pkgs/applications/audio/mopidy/mpd.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/mopidy/mpris.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/mopidy/muse.nix+29
This diff is too big to show here.
pkgs/applications/audio/mopidy/musicbox-webclient.nix+2−2
This diff is too big to show here.
pkgs/applications/audio/mopidy/podcast.nix+31
This diff is too big to show here.
pkgs/applications/audio/mopidy/scrobbler.nix+24
This diff is too big to show here.
pkgs/applications/audio/mopidy/somafm.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/mopidy/soundcloud.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/mopidy/spotify-tunigo.nix+2−2
This diff is too big to show here.
pkgs/applications/audio/mopidy/spotify.nix+10−8
This diff is too big to show here.
pkgs/applications/audio/mopidy/subidy.nix+24
This diff is too big to show here.
pkgs/applications/audio/mopidy/tunein.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/mopidy/youtube.nix+44−16
This diff is too big to show here.
pkgs/applications/audio/mopidy/ytmusic.nix+35
This diff is too big to show here.
pkgs/applications/audio/mousai/default.nix+79
This diff is too big to show here.
pkgs/applications/audio/mousai/paths.patch+13
This diff is too big to show here.
pkgs/applications/audio/mp3blaster/default.nix+14−4
This diff is too big to show here.
pkgs/applications/audio/mp3gain/default.nix+9−7
This diff is too big to show here.
pkgs/applications/audio/mp3info/default.nix+7−6
This diff is too big to show here.
pkgs/applications/audio/mp3splt/default.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/mp3val/default.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/mpc/default.nix+50−13
This diff is too big to show here.
pkgs/applications/audio/mpc123/default.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/mpdevil/default.nix+53
This diff is too big to show here.
pkgs/applications/audio/mpg123/default.nix+44−20
This diff is too big to show here.
pkgs/applications/audio/mpg321/default.nix+4−5
This diff is too big to show here.
pkgs/applications/audio/munt/default.nix−38
This diff is too big to show here.
pkgs/applications/audio/munt/libmt32emu.nix+38
This diff is too big to show here.
pkgs/applications/audio/munt/mt32emu-qt.nix+75
This diff is too big to show here.
pkgs/applications/audio/munt/mt32emu-smf2wav.nix+50
This diff is too big to show here.
pkgs/applications/audio/mup/default.nix+2−2
This diff is too big to show here.
pkgs/applications/audio/muse/default.nix+5−5
This diff is too big to show here.
pkgs/applications/audio/musescore/darwin.nix+2−3
This diff is too big to show here.
pkgs/applications/audio/musescore/default.nix+16−12
This diff is too big to show here.
pkgs/applications/audio/musikcube/default.nix+24−9
This diff is too big to show here.
pkgs/applications/audio/musly/default.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/muso/default.nix+37
This diff is too big to show here.
pkgs/applications/audio/mympd/default.nix+12−13
This diff is too big to show here.
pkgs/applications/audio/myxer/default.nix+38
This diff is too big to show here.
pkgs/applications/audio/ncmpc/default.nix+18−10
This diff is too big to show here.
pkgs/applications/audio/ncmpcpp/default.nix+17−7
This diff is too big to show here.
pkgs/applications/audio/ncpamixer/default.nix+6−10
This diff is too big to show here.
pkgs/applications/audio/ncspot/default.nix+17−18
This diff is too big to show here.
pkgs/applications/audio/netease-cloud-music-gtk/cargo-lock.patch+2007
This diff is too big to show here.
pkgs/applications/audio/netease-cloud-music-gtk/default.nix+60
This diff is too big to show here.
pkgs/applications/audio/netease-cloud-music-gtk/update-cargo-lock.sh+20
This diff is too big to show here.
pkgs/applications/audio/netease-music-tui/cargo-lock.patch+644−298
This diff is too big to show here.
pkgs/applications/audio/netease-music-tui/default.nix+6−7
This diff is too big to show here.
pkgs/applications/audio/netease-music-tui/update-cargo-lock.sh+20
This diff is too big to show here.
pkgs/applications/audio/new-session-manager/default.nix+27
This diff is too big to show here.
pkgs/applications/audio/ninjas2/default.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/noise-repellent/default.nix+12−10
This diff is too big to show here.
pkgs/applications/audio/noisetorch/default.nix+12−16
This diff is too big to show here.
pkgs/applications/audio/noisetorch/version.patch−37
This diff is too big to show here.
pkgs/applications/audio/non/default.nix+11−11
This diff is too big to show here.
pkgs/applications/audio/nootka/default.nix+9−6
This diff is too big to show here.
pkgs/applications/audio/nootka/unstable.nix+28−8
This diff is too big to show here.
pkgs/applications/audio/normalize/default.nix+2−2
This diff is too big to show here.
pkgs/applications/audio/nova-filters/default.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/nuclear/default.nix+1−1
This diff is too big to show here.
pkgs/applications/audio/ocenaudio/default.nix+7−7
This diff is too big to show here.
pkgs/applications/audio/odin2/default.nix+79
This diff is too big to show here.
pkgs/applications/audio/open-music-kontrollers/eteroj.nix+10
This diff is too big to show here.
pkgs/applications/audio/open-music-kontrollers/generic.nix+37
This diff is too big to show here.
pkgs/applications/audio/open-music-kontrollers/jit.nix+12
This diff is too big to show here.
pkgs/applications/audio/open-music-kontrollers/mephisto.nix+17
This diff is too big to show here.
pkgs/applications/audio/open-music-kontrollers/midi_matrix.nix+10
This diff is too big to show here.
pkgs/applications/audio/open-music-kontrollers/moony.nix+13
This diff is too big to show here.
pkgs/applications/audio/open-music-kontrollers/orbit.nix+12
This diff is too big to show here.
pkgs/applications/audio/open-music-kontrollers/patchmatrix.nix+13
This diff is too big to show here.
pkgs/applications/audio/open-music-kontrollers/router.nix+11
This diff is too big to show here.
pkgs/applications/audio/open-music-kontrollers/sherlock.nix+12
This diff is too big to show here.
pkgs/applications/audio/open-music-kontrollers/synthpod.nix+13
This diff is too big to show here.
pkgs/applications/audio/open-music-kontrollers/vm.nix+10
This diff is too big to show here.
pkgs/applications/audio/openmpt123/default.nix−31
This diff is too big to show here.
pkgs/applications/audio/opus-tools/default.nix+9−7
This diff is too big to show here.
pkgs/applications/audio/opusfile/default.nix+12−8
This diff is too big to show here.
pkgs/applications/audio/opusfile/disable-cert-store.patch+35
This diff is too big to show here.
pkgs/applications/audio/opustags/default.nix+18−5
This diff is too big to show here.
pkgs/applications/audio/orca-c/default.nix+18−11
This diff is too big to show here.
pkgs/applications/audio/osdlyrics/default.nix+87
This diff is too big to show here.
pkgs/applications/audio/osmid/default.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/oxefmsynth/default.nix+43
This diff is too big to show here.
pkgs/applications/audio/padthv1/default.nix+6−6
This diff is too big to show here.
pkgs/applications/audio/pamix/default.nix+18−4
This diff is too big to show here.
pkgs/applications/audio/pamixer/default.nix+7−7
This diff is too big to show here.
pkgs/applications/audio/paprefs/default.nix+8−6
This diff is too big to show here.
pkgs/applications/audio/parlatype/default.nix−69
This diff is too big to show here.
pkgs/applications/audio/patchage/default.nix+36−14
This diff is too big to show here.
pkgs/applications/audio/paulstretch/default.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/pavucontrol/default.nix+27−18
This diff is too big to show here.
pkgs/applications/audio/pd-plugins/cyclone/default.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/pd-plugins/gem/default.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/pd-plugins/helmholtz/default.nix+6−5
This diff is too big to show here.
pkgs/applications/audio/pd-plugins/maxlib/default.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/pd-plugins/mrpeach/default.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/pd-plugins/puremapping/default.nix+6−5
This diff is too big to show here.
pkgs/applications/audio/pd-plugins/timbreid/default.nix+6−5
This diff is too big to show here.
pkgs/applications/audio/pd-plugins/zexy/default.nix+6−5
This diff is too big to show here.
pkgs/applications/audio/petrifoo/default.nix+7−7
This diff is too big to show here.
pkgs/applications/audio/pianobar/default.nix+8−7
This diff is too big to show here.
pkgs/applications/audio/pianobooster/default.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/pianoteq/default.nix+200
This diff is too big to show here.
pkgs/applications/audio/picard/default.nix+29−24
This diff is too big to show here.
pkgs/applications/audio/picoloop/default.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/pipecontrol/default.nix+50
This diff is too big to show here.
pkgs/applications/audio/pithos/default.nix+7−7
This diff is too big to show here.
pkgs/applications/audio/playbar2/default.nix+4−2
This diff is too big to show here.
pkgs/applications/audio/plexamp/default.nix+10−8
This diff is too big to show here.
pkgs/applications/audio/plexamp/update-plexamp.sh+54
This diff is too big to show here.
pkgs/applications/audio/plugin-torture/default.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/plujain-ramp/default.nix+27
This diff is too big to show here.
pkgs/applications/audio/pmidi/default.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/pocket-casts/default.nix+55
This diff is too big to show here.
pkgs/applications/audio/polyphone/default.nix+4−4
This diff is too big to show here.
pkgs/applications/audio/ponymix/default.nix+3−3
This diff is too big to show here.
pkgs/applications/audio/praat/default.nix+17−13
This diff is too big to show here.