JakeHillion/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: re-format

Browse Source
This commit is contained in:
Jan Tojnar 2019-09-18 22:12:54 +02:00
parent 641f6356d3
commit 83c2ad80ca
No known key found for this signature in database
GPG Key ID: 7FAB2A15F7A607A4
45 changed files with 1095 additions and 4339 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

306
doc/coding-conventions.xml
View File

@ -8,24 +8,17 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
Use 2 spaces of indentation per indentation level in Nix expressions, 4 Use 2 spaces of indentation per indentation level in Nix expressions, 4 spaces in shell scripts.
spaces in shell scripts.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Do not use tab characters, i.e. configure your editor to use soft tabs. 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.
For instance, use <literal>(setq-default indent-tabs-mode nil)</literal>
in Emacs. Everybody has different tab settings so it’s asking for
trouble.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Use <literal>lowerCamelCase</literal> for variable names, not 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"/>.
<literal>UpperCamelCase</literal>. Note, this rule does not apply to
package attribute names, which instead follow the rules in
<xref linkend="sec-package-naming"/>.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -52,8 +45,7 @@ foo { arg = ...; }
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
In attribute sets or lists that span multiple lines, the attribute names In attribute sets or lists that span multiple lines, the attribute names or list elements should be aligned:
or list elements should be aligned:
<programlisting> <programlisting>
# A long list. # A long list.
list = [ list = [
@ -97,8 +89,7 @@ attrs = { x = 1280; y = 1024; };
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Breaking in the middle of a function argument can give hard-to-read code, Breaking in the middle of a function argument can give hard-to-read code, like
like
<programlisting> <programlisting>
someFunction { x = 1280; someFunction { x = 1280;
y = 1024; } otherArg y = 1024; } otherArg
@ -123,8 +114,7 @@ in someFunction res otherArg yetAnotherArg
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
The bodies of functions, asserts, and withs are not indented to prevent a The bodies of functions, asserts, and withs are not indented to prevent a lot of superfluous indentation levels, i.e.
lot of superfluous indentation levels, i.e.
<programlisting> <programlisting>
{ arg1, arg2 }: { arg1, arg2 }:
assert system == "i686-linux"; assert system == "i686-linux";
@ -156,8 +146,7 @@ stdenv.mkDerivation { ...
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Functions should list their expected arguments as precisely as possible. Functions should list their expected arguments as precisely as possible. That is, write
That is, write
<programlisting> <programlisting>
{ stdenv, fetchurl, perl }: <replaceable>...</replaceable> { stdenv, fetchurl, perl }: <replaceable>...</replaceable>
</programlisting> </programlisting>
@ -171,9 +160,7 @@ args: with args; <replaceable>...</replaceable>
</programlisting> </programlisting>
</para> </para>
<para> <para>
For functions that are truly generic in the number of arguments (such as 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:
wrappers around <varname>mkDerivation</varname>) that have some required
arguments, you should write them using an <literal>@</literal>-pattern:
<programlisting> <programlisting>
{ stdenv, doCoverageAnalysis ? false, ... } @ args: { stdenv, doCoverageAnalysis ? false, ... } @ args:
@ -197,35 +184,20 @@ args.stdenv.mkDerivation (args // {
<title>Package naming</title> <title>Package naming</title>
<para> <para>
The key words <emphasis>must</emphasis>, <emphasis>must not</emphasis>, 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.
<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.
</para> </para>
<para> <para>
In Nixpkgs, there are generally three different names associated with a In Nixpkgs, there are generally three different names associated with a package:
package:
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
The <varname>name</varname> attribute of the derivation (excluding the 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>.
version part). This is what most users see, in particular when using
<command>nix-env</command>.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
The variable name used for the instantiated package in 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>.
<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>.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -234,12 +206,7 @@ args.stdenv.mkDerivation (args // {
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
Most of the time, these are the same. For instance, the package 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>.
<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>.
</para> </para>
<para> <para>
@ -247,51 +214,32 @@ args.stdenv.mkDerivation (args // {
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
The <literal>name</literal> attribute <emphasis>should</emphasis> be The <literal>name</literal> attribute <emphasis>should</emphasis> be identical to the upstream package name.
identical to the upstream package name.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
The <literal>name</literal> attribute <emphasis>must not</emphasis> 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>.
contain uppercase letters — e.g., <literal>"mplayer-1.0rc2"</literal>
instead of <literal>"MPlayer-1.0rc2"</literal>.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
The version part of the <literal>name</literal> attribute 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>.
<emphasis>must</emphasis> start with a digit (following a dash) — e.g.,
<literal>"hello-0.3.1rc2"</literal>.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
If a package is not a release but a commit from a repository, then the 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>.
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>.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Dashes in the package name <emphasis>should</emphasis> be preserved in 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.
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.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
If there are multiple versions of a package, this 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" />
<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" />
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -301,31 +249,18 @@ args.stdenv.mkDerivation (args // {
<title>File naming and organisation</title> <title>File naming and organisation</title>
<para> <para>
Names of files and directories should be in lowercase, with dashes between 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>.
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>.
</para> </para>
<section xml:id="sec-hierarchy"> <section xml:id="sec-hierarchy">
<title>Hierarchy</title> <title>Hierarchy</title>
<para> <para>
Each package should be stored in its own directory somewhere in the 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>.
<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>.
</para> </para>
<para> <para>
When in doubt, consider refactoring the <filename>pkgs/</filename> tree, When in doubt, consider refactoring the <filename>pkgs/</filename> tree, e.g. creating new categories or splitting up an existing category.
e.g. creating new categories or splitting up an existing category.
</para> </para>
<variablelist> <variablelist>
@ -341,8 +276,7 @@ args.stdenv.mkDerivation (args // {
</term> </term>
<listitem> <listitem>
<para> <para>
<filename>development/libraries</filename> (e.g. <filename>development/libraries</filename> (e.g. <filename>libxml2</filename>)
<filename>libxml2</filename>)
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -352,8 +286,7 @@ args.stdenv.mkDerivation (args // {
</term> </term>
<listitem> <listitem>
<para> <para>
<filename>development/compilers</filename> (e.g. <filename>development/compilers</filename> (e.g. <filename>gcc</filename>)
<filename>gcc</filename>)
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -363,8 +296,7 @@ args.stdenv.mkDerivation (args // {
</term> </term>
<listitem> <listitem>
<para> <para>
<filename>development/interpreters</filename> (e.g. <filename>development/interpreters</filename> (e.g. <filename>guile</filename>)
<filename>guile</filename>)
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -380,8 +312,7 @@ args.stdenv.mkDerivation (args // {
</term> </term>
<listitem> <listitem>
<para> <para>
<filename>development/tools/parsing</filename> (e.g. <filename>development/tools/parsing</filename> (e.g. <filename>bison</filename>, <filename>flex</filename>)
<filename>bison</filename>, <filename>flex</filename>)
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -391,8 +322,7 @@ args.stdenv.mkDerivation (args // {
</term> </term>
<listitem> <listitem>
<para> <para>
<filename>development/tools/build-managers</filename> (e.g. <filename>development/tools/build-managers</filename> (e.g. <filename>gnumake</filename>)
<filename>gnumake</filename>)
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -402,8 +332,7 @@ args.stdenv.mkDerivation (args // {
</term> </term>
<listitem> <listitem>
<para> <para>
<filename>development/tools/misc</filename> (e.g. <filename>development/tools/misc</filename> (e.g. <filename>binutils</filename>)
<filename>binutils</filename>)
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -429,8 +358,7 @@ args.stdenv.mkDerivation (args // {
</term> </term>
<listitem> <listitem>
<para> <para>
(A tool is a relatively small program, especially one intended to be (A tool is a relatively small program, especially one intended to be used non-interactively.)
used non-interactively.)
</para> </para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
@ -439,8 +367,7 @@ args.stdenv.mkDerivation (args // {
</term> </term>
<listitem> <listitem>
<para> <para>
<filename>tools/networking</filename> (e.g. <filename>tools/networking</filename> (e.g. <filename>wget</filename>)
<filename>wget</filename>)
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -470,8 +397,7 @@ args.stdenv.mkDerivation (args // {
</term> </term>
<listitem> <listitem>
<para> <para>
<filename>tools/archivers</filename> (e.g. <filename>zip</filename>, <filename>tools/archivers</filename> (e.g. <filename>zip</filename>, <filename>tar</filename>)
<filename>tar</filename>)
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -481,8 +407,7 @@ args.stdenv.mkDerivation (args // {
</term> </term>
<listitem> <listitem>
<para> <para>
<filename>tools/compression</filename> (e.g. <filename>tools/compression</filename> (e.g. <filename>gzip</filename>, <filename>bzip2</filename>)
<filename>gzip</filename>, <filename>bzip2</filename>)
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -492,8 +417,7 @@ args.stdenv.mkDerivation (args // {
</term> </term>
<listitem> <listitem>
<para> <para>
<filename>tools/security</filename> (e.g. <filename>nmap</filename>, <filename>tools/security</filename> (e.g. <filename>nmap</filename>, <filename>gnupg</filename>)
<filename>gnupg</filename>)
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -532,8 +456,7 @@ args.stdenv.mkDerivation (args // {
</term> </term>
<listitem> <listitem>
<para> <para>
<filename>servers/http</filename> (e.g. <filename>servers/http</filename> (e.g. <filename>apache-httpd</filename>)
<filename>apache-httpd</filename>)
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -543,8 +466,7 @@ args.stdenv.mkDerivation (args // {
</term> </term>
<listitem> <listitem>
<para> <para>
<filename>servers/x11</filename> (e.g. <filename>xorg</filename> — <filename>servers/x11</filename> (e.g. <filename>xorg</filename> — this includes the client libraries and programs)
this includes the client libraries and programs)
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -567,8 +489,7 @@ args.stdenv.mkDerivation (args // {
</term> </term>
<listitem> <listitem>
<para> <para>
<filename>desktops</filename> (e.g. <filename>kde</filename>, <filename>desktops</filename> (e.g. <filename>kde</filename>, <filename>gnome</filename>, <filename>enlightenment</filename>)
<filename>gnome</filename>, <filename>enlightenment</filename>)
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -578,8 +499,7 @@ args.stdenv.mkDerivation (args // {
</term> </term>
<listitem> <listitem>
<para> <para>
<filename>applications/window-managers</filename> (e.g. <filename>applications/window-managers</filename> (e.g. <filename>awesome</filename>, <filename>stumpwm</filename>)
<filename>awesome</filename>, <filename>stumpwm</filename>)
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -589,8 +509,7 @@ args.stdenv.mkDerivation (args // {
</term> </term>
<listitem> <listitem>
<para> <para>
A (typically large) program with a distinct user interface, primarily A (typically large) program with a distinct user interface, primarily used interactively.
used interactively.
</para> </para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
@ -599,8 +518,7 @@ args.stdenv.mkDerivation (args // {
</term> </term>
<listitem> <listitem>
<para> <para>
<filename>applications/version-management</filename> (e.g. <filename>applications/version-management</filename> (e.g. <filename>subversion</filename>)
<filename>subversion</filename>)
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -610,8 +528,7 @@ args.stdenv.mkDerivation (args // {
</term> </term>
<listitem> <listitem>
<para> <para>
<filename>applications/video</filename> (e.g. <filename>applications/video</filename> (e.g. <filename>vlc</filename>)
<filename>vlc</filename>)
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -621,8 +538,7 @@ args.stdenv.mkDerivation (args // {
</term> </term>
<listitem> <listitem>
<para> <para>
<filename>applications/graphics</filename> (e.g. <filename>applications/graphics</filename> (e.g. <filename>gimp</filename>)
<filename>gimp</filename>)
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -638,8 +554,7 @@ args.stdenv.mkDerivation (args // {
</term> </term>
<listitem> <listitem>
<para> <para>
<filename>applications/networking/mailreaders</filename> (e.g. <filename>applications/networking/mailreaders</filename> (e.g. <filename>thunderbird</filename>)
<filename>thunderbird</filename>)
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -649,8 +564,7 @@ args.stdenv.mkDerivation (args // {
</term> </term>
<listitem> <listitem>
<para> <para>
<filename>applications/networking/newsreaders</filename> (e.g. <filename>applications/networking/newsreaders</filename> (e.g. <filename>pan</filename>)
<filename>pan</filename>)
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -660,8 +574,7 @@ args.stdenv.mkDerivation (args // {
</term> </term>
<listitem> <listitem>
<para> <para>
<filename>applications/networking/browsers</filename> (e.g. <filename>applications/networking/browsers</filename> (e.g. <filename>firefox</filename>)
<filename>firefox</filename>)
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -719,8 +632,7 @@ args.stdenv.mkDerivation (args // {
</term> </term>
<listitem> <listitem>
<para> <para>
<filename>data/sgml+xml/schemas/xml-dtd</filename> (e.g. <filename>data/sgml+xml/schemas/xml-dtd</filename> (e.g. <filename>docbook</filename>)
<filename>docbook</filename>)
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -733,8 +645,7 @@ args.stdenv.mkDerivation (args // {
(Okay, these are executable...) (Okay, these are executable...)
</para> </para>
<para> <para>
<filename>data/sgml+xml/stylesheets/xslt</filename> (e.g. <filename>data/sgml+xml/stylesheets/xslt</filename> (e.g. <filename>docbook-xsl</filename>)
<filename>docbook-xsl</filename>)
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -771,36 +682,15 @@ args.stdenv.mkDerivation (args // {
<title>Versioning</title> <title>Versioning</title>
<para> <para>
Because every version of a package in Nixpkgs creates a potential 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.
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.
</para> </para>
<para> <para>
If there is only one version of a package, its Nix expression should be 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>.
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>.
</para> </para>
<para> <para>
All versions of a package <emphasis>must</emphasis> be included in All versions of a package <emphasis>must</emphasis> be included in <filename>all-packages.nix</filename> to make sure that they evaluate correctly.
<filename>all-packages.nix</filename> to make sure that they evaluate
correctly.
</para> </para>
</section> </section>
</section> </section>
@ -808,25 +698,15 @@ args.stdenv.mkDerivation (args // {
<title>Fetching Sources</title> <title>Fetching Sources</title>
<para> <para>
There are multiple ways to fetch a package source in nixpkgs. The general 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.
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.
</para> </para>
<para> <para>
You can find many source fetch helpers in You can find many source fetch helpers in <literal>pkgs/build-support/fetch*</literal>.
<literal>pkgs/build-support/fetch*</literal>.
</para> </para>
<para> <para>
In the file <literal>pkgs/top-level/all-packages.nix</literal> you can find 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:
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:
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
@ -863,11 +743,7 @@ src = fetchFromGitHub {
sha256 = "1i2yxndxb6yc9l6c99pypbd92lfq5aac4klq7y2v93c9qvx2cgpc"; sha256 = "1i2yxndxb6yc9l6c99pypbd92lfq5aac4klq7y2v93c9qvx2cgpc";
} }
</programlisting> </programlisting>
Find the value to put as <literal>sha256</literal> by running Find the value to put as <literal>sha256</literal> by running <literal>nix run -f '&lt;nixpkgs&gt;' 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>.
<literal>nix run -f '&lt;nixpkgs&gt;' 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>.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -883,40 +759,23 @@ src = fetchFromGitHub {
<orderedlist> <orderedlist>
<listitem> <listitem>
<para> <para>
Prefetch URL (with <literal>nix-prefetch-<replaceable>XXX</replaceable> 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.
<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.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Prefetch by package source (with <literal>nix-prefetch-url Prefetch by package source (with <literal>nix-prefetch-url '&lt;nixpkgs&gt;' -A <replaceable>PACKAGE</replaceable>.src</literal>, where <replaceable>PACKAGE</replaceable> is package attribute name). Hash is printed to stdout.
'&lt;nixpkgs&gt;' -A <replaceable>PACKAGE</replaceable>.src</literal>,
where <replaceable>PACKAGE</replaceable> is package attribute name). Hash
is printed to stdout.
</para> </para>
<para> <para>
This works well when you've upgraded existing package version and want to 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).
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).
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Upstream provided hash: use it when upstream provides 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).
<literal>sha256</literal> or <literal>sha512</literal> (when upstream
provides <literal>md5</literal>, don't use it, compute
<literal>sha256</literal> instead).
</para> </para>
<para> <para>
A little nuance is that <literal>nix-prefetch-*</literal> tools produce 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.
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.
</para> </para>
<para> <para>
You can convert between formats with nix-hash, for example: You can convert between formats with nix-hash, for example:
@ -927,28 +786,18 @@ src = fetchFromGitHub {
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Extracting hash from local source tarball can be done with 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.
<literal>sha256sum</literal>. Use <literal>nix-prefetch-url
file:///path/to/tarball </literal> if you want base32 hash.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Fake hash: set fake hash in package expression, perform build and extract Fake hash: set fake hash in package expression, perform build and extract correct hash from error Nix prints.
correct hash from error Nix prints.
</para> </para>
<para> <para>
For package updates it is enough to change one symbol to make hash fake. 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.
For new packages, you can use <literal>lib.fakeSha256</literal>,
<literal>lib.fakeSha512</literal> or any other fake hash.
</para> </para>
<para> <para>
This is last resort method when reconstructing source URL is non-trivial 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.
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.
</para> </para>
<warning> <warning>
<para> <para>
@ -962,9 +811,7 @@ src = fetchFromGitHub {
<title>Obtaining hashes securely</title> <title>Obtaining hashes securely</title>
<para> <para>
Let's say Man-in-the-Middle (MITM) sits close to your network. Then instead 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:
of fetching source you can fetch malware, and instead of source hash you
get hash of malware. Here are security considerations for this scenario:
</para> </para>
<itemizedlist> <itemizedlist>
@ -975,8 +822,7 @@ src = fetchFromGitHub {
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
hashes from upstream (in method 3) should be obtained via secure hashes from upstream (in method 3) should be obtained via secure protocol;
protocol;
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -986,12 +832,7 @@ src = fetchFromGitHub {
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<literal>https://</literal> URLs are not secure in method 5. When <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.
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.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -1001,8 +842,7 @@ src = fetchFromGitHub {
<title>Patches</title> <title>Patches</title>
<para> <para>
Patches available online should be retrieved using Patches available online should be retrieved using <literal>fetchpatch</literal>.
<literal>fetchpatch</literal>.
</para> </para>
<para> <para>
@ -1018,10 +858,7 @@ patches = [
</para> </para>
<para> <para>
Otherwise, you can add a <literal>.patch</literal> file to the 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.
<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.
</para> </para>
<para> <para>
@ -1031,8 +868,7 @@ patches = [ ./0001-changes.patch ];
</para> </para>
<para> <para>
If you do need to do create this sort of patch file, one way to do so is If you do need to do create this sort of patch file, one way to do so is with git:
with git:
<orderedlist> <orderedlist>
<listitem> <listitem>
<para> <para>
@ -1043,8 +879,7 @@ patches = [ ./0001-changes.patch ];
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
If a git repository is not already present, create one and stage all of If a git repository is not already present, create one and stage all of the source files.
the source files.
<screen> <screen>
<prompt>$ </prompt>git init <prompt>$ </prompt>git init
<prompt>$ </prompt>git add .</screen> <prompt>$ </prompt>git add .</screen>
@ -1052,8 +887,7 @@ patches = [ ./0001-changes.patch ];
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Edit some files to make whatever changes need to be included in the Edit some files to make whatever changes need to be included in the patch.
patch.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>

184
doc/configuration.xml
View File

@ -3,49 +3,38 @@
xml:id="chap-packageconfig"> xml:id="chap-packageconfig">
<title>Global configuration</title> <title>Global configuration</title>
<para> <para>
Nix comes with certain defaults about what packages can and cannot be 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:
installed, based on a package's metadata. By default, Nix will prevent
installation if any of the following criteria are true:
</para> </para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
The package is thought to be broken, and has had its The package is thought to be broken, and has had its <literal>meta.broken</literal> set to <literal>true</literal>.
<literal>meta.broken</literal> set to <literal>true</literal>.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
The package isn't intended to run on the given system, as none of its The package isn't intended to run on the given system, as none of its <literal>meta.platforms</literal> match the given system.
<literal>meta.platforms</literal> match the given system.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
The package's <literal>meta.license</literal> is set to a license which is The package's <literal>meta.license</literal> is set to a license which is considered to be unfree.
considered to be unfree.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
The package has known security vulnerabilities but has not or can not be 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>.
updated for some reason, and a list of issues has been entered in to the
package's <literal>meta.knownVulnerabilities</literal>.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<para> <para>
Note that all this is checked during evaluation already, and the check 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.
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.
</para> </para>
<para> <para>
Each of these criteria can be altered in the nixpkgs configuration. Each of these criteria can be altered in the nixpkgs configuration.
</para> </para>
<para> <para>
The nixpkgs configuration for a NixOS system is set in the The nixpkgs configuration for a NixOS system is set in the <literal>configuration.nix</literal>, as in the following example:
<literal>configuration.nix</literal>, as in the following example:
<programlisting> <programlisting>
{ {
nixpkgs.config = { nixpkgs.config = {
@ -53,13 +42,10 @@
}; };
} }
</programlisting> </programlisting>
However, this does not allow unfree software for individual users. Their However, this does not allow unfree software for individual users. Their configurations are managed separately.
configurations are managed separately.
</para> </para>
<para> <para>
A user's of nixpkgs configuration is stored in a user-specific configuration A user's of nixpkgs configuration is stored in a user-specific configuration file located at <filename>~/.config/nixpkgs/config.nix</filename>. For example:
file located at <filename>~/.config/nixpkgs/config.nix</filename>. For
example:
<programlisting> <programlisting>
{ {
allowUnfree = true; allowUnfree = true;
@ -67,31 +53,25 @@
</programlisting> </programlisting>
</para> </para>
<para> <para>
Note that we are not able to test or build unfree software on Hydra due to 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.
policy. Most unfree licenses prohibit us from either executing or
distributing the software.
</para> </para>
<section xml:id="sec-allow-broken"> <section xml:id="sec-allow-broken">
<title>Installing broken packages</title> <title>Installing broken packages</title>
<para> <para>
There are two ways to try compiling a package which has been marked as There are two ways to try compiling a package which has been marked as broken.
broken.
</para> </para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
For allowing the build of a broken package once, you can use an For allowing the build of a broken package once, you can use an environment variable for a single invocation of the nix tools:
environment variable for a single invocation of the nix tools:
<programlisting>$ export NIXPKGS_ALLOW_BROKEN=1</programlisting> <programlisting>$ export NIXPKGS_ALLOW_BROKEN=1</programlisting>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
For permanently allowing broken packages to be built, you may add For permanently allowing broken packages to be built, you may add <literal>allowBroken = true;</literal> to your user's configuration file, like this:
<literal>allowBroken = true;</literal> to your user's configuration file,
like this:
<programlisting> <programlisting>
{ {
allowBroken = true; allowBroken = true;
@ -105,23 +85,19 @@
<title>Installing packages on unsupported systems</title> <title>Installing packages on unsupported systems</title>
<para> <para>
There are also two ways to try compiling a package which has been marked as There are also two ways to try compiling a package which has been marked as unsuported for the given system.
unsuported for the given system.
</para> </para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
For allowing the build of a broken package once, you can use an For allowing the build of a broken package once, you can use an environment variable for a single invocation of the nix tools:
environment variable for a single invocation of the nix tools:
<programlisting>$ export NIXPKGS_ALLOW_UNSUPPORTED_SYSTEM=1</programlisting> <programlisting>$ export NIXPKGS_ALLOW_UNSUPPORTED_SYSTEM=1</programlisting>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
For permanently allowing broken packages to be built, you may add For permanently allowing broken packages to be built, you may add <literal>allowUnsupportedSystem = true;</literal> to your user's configuration file, like this:
<literal>allowUnsupportedSystem = true;</literal> to your user's
configuration file, like this:
<programlisting> <programlisting>
{ {
allowUnsupportedSystem = true; allowUnsupportedSystem = true;
@ -132,42 +108,29 @@
</itemizedlist> </itemizedlist>
<para> <para>
The difference between a package being unsupported on some system and being 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.
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.
</para> </para>
</section> </section>
<section xml:id="sec-allow-unfree"> <section xml:id="sec-allow-unfree">
<title>Installing unfree packages</title> <title>Installing unfree packages</title>
<para> <para>
There are several ways to tweak how Nix handles a package which has been There are several ways to tweak how Nix handles a package which has been marked as unfree.
marked as unfree.
</para> </para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
To temporarily allow all unfree packages, you can use an environment To temporarily allow all unfree packages, you can use an environment variable for a single invocation of the nix tools:
variable for a single invocation of the nix tools:
<programlisting>$ export NIXPKGS_ALLOW_UNFREE=1</programlisting> <programlisting>$ export NIXPKGS_ALLOW_UNFREE=1</programlisting>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
It is possible to permanently allow individual unfree packages, while 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.
still blocking unfree packages by default using the
<literal>allowUnfreePredicate</literal> configuration option in the user
configuration file.
</para> </para>
<para> <para>
This option is a function which accepts a package as a parameter, and 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:
returns a boolean. The following example configuration accepts a package
and always returns false:
<programlisting> <programlisting>
{ {
allowUnfreePredicate = (pkg: false); allowUnfreePredicate = (pkg: false);
@ -175,8 +138,7 @@
</programlisting> </programlisting>
</para> </para>
<para> <para>
For a more useful example, try the following. This configuration only For a more useful example, try the following. This configuration only allows unfree packages named flash player and visual studio code:
allows unfree packages named flash player and visual studio code:
<programlisting> <programlisting>
{ {
allowUnfreePredicate = (pkg: builtins.elem allowUnfreePredicate = (pkg: builtins.elem
@ -190,14 +152,10 @@
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
It is also possible to whitelist and blacklist licenses that are 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.
specifically acceptable or not acceptable, using
<literal>whitelistedLicenses</literal> and
<literal>blacklistedLicenses</literal>, respectively.
</para> </para>
<para> <para>
The following example configuration whitelists the licenses The following example configuration whitelists the licenses <literal>amd</literal> and <literal>wtfpl</literal>:
<literal>amd</literal> and <literal>wtfpl</literal>:
<programlisting> <programlisting>
{ {
whitelistedLicenses = with stdenv.lib.licenses; [ amd wtfpl ]; whitelistedLicenses = with stdenv.lib.licenses; [ amd wtfpl ];
@ -205,8 +163,7 @@
</programlisting> </programlisting>
</para> </para>
<para> <para>
The following example configuration blacklists the <literal>gpl3</literal> The following example configuration blacklists the <literal>gpl3</literal> and <literal>agpl3</literal> licenses:
and <literal>agpl3</literal> licenses:
<programlisting> <programlisting>
{ {
blacklistedLicenses = with stdenv.lib.licenses; [ agpl3 gpl3 ]; blacklistedLicenses = with stdenv.lib.licenses; [ agpl3 gpl3 ];
@ -217,37 +174,29 @@
</itemizedlist> </itemizedlist>
<para> <para>
A complete list of licenses can be found in the file A complete list of licenses can be found in the file <filename>lib/licenses.nix</filename> of the nixpkgs tree.
<filename>lib/licenses.nix</filename> of the nixpkgs tree.
</para> </para>
</section> </section>
<section xml:id="sec-allow-insecure"> <section xml:id="sec-allow-insecure">
<title>Installing insecure packages</title> <title>Installing insecure packages</title>
<para> <para>
There are several ways to tweak how Nix handles a package which has been There are several ways to tweak how Nix handles a package which has been marked as insecure.
marked as insecure.
</para> </para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
To temporarily allow all insecure packages, you can use an environment To temporarily allow all insecure packages, you can use an environment variable for a single invocation of the nix tools:
variable for a single invocation of the nix tools:
<programlisting>$ export NIXPKGS_ALLOW_INSECURE=1</programlisting> <programlisting>$ export NIXPKGS_ALLOW_INSECURE=1</programlisting>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
It is possible to permanently allow individual insecure packages, while 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.
still blocking other insecure packages by default using the
<literal>permittedInsecurePackages</literal> configuration option in the
user configuration file.
</para> </para>
<para> <para>
The following example configuration permits the installation of the The following example configuration permits the installation of the hypothetically insecure package <literal>hello</literal>, version <literal>1.2.3</literal>:
hypothetically insecure package <literal>hello</literal>, version
<literal>1.2.3</literal>:
<programlisting> <programlisting>
{ {
permittedInsecurePackages = [ permittedInsecurePackages = [
@ -259,18 +208,13 @@
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
It is also possible to create a custom policy around which insecure 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.
packages to allow and deny, by overriding the
<literal>allowInsecurePredicate</literal> configuration option.
</para> </para>
<para> <para>
The <literal>allowInsecurePredicate</literal> option is a function which The <literal>allowInsecurePredicate</literal> option is a function which accepts a package and returns a boolean, much like <literal>allowUnfreePredicate</literal>.
accepts a package and returns a boolean, much like
<literal>allowUnfreePredicate</literal>.
</para> </para>
<para> <para>
The following configuration example only allows insecure packages with The following configuration example only allows insecure packages with very short names:
very short names:
<programlisting> <programlisting>
{ {
allowInsecurePredicate = (pkg: (builtins.stringLength (builtins.parseDrvName pkg.name).name) &lt;= 5); allowInsecurePredicate = (pkg: (builtins.stringLength (builtins.parseDrvName pkg.name).name) &lt;= 5);
@ -278,8 +222,7 @@
</programlisting> </programlisting>
</para> </para>
<para> <para>
Note that <literal>permittedInsecurePackages</literal> is only checked if Note that <literal>permittedInsecurePackages</literal> is only checked if <literal>allowInsecurePredicate</literal> is not specified.
<literal>allowInsecurePredicate</literal> is not specified.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -289,10 +232,7 @@
<title>Modify packages via <literal>packageOverrides</literal></title> <title>Modify packages via <literal>packageOverrides</literal></title>
<para> <para>
You can define a function called <varname>packageOverrides</varname> in your 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.
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.
<programlisting> <programlisting>
{ {
packageOverrides = pkgs: rec { packageOverrides = pkgs: rec {
@ -309,15 +249,7 @@
<title>Build an environment</title> <title>Build an environment</title>
<para> <para>
Using <literal>packageOverrides</literal>, it is possible to manage 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>:
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>:
</para> </para>
<screen> <screen>
@ -343,13 +275,7 @@
</screen> </screen>
<para> <para>
To install it into our environment, you can just run <literal>nix-env -iA 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:
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:
</para> </para>
<screen> <screen>
@ -376,12 +302,7 @@
</screen> </screen>
<para> <para>
<literal>pathsToLink</literal> tells Nixpkgs to only link the paths listed <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.
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.
</para> </para>
</section> </section>
@ -389,13 +310,7 @@
<title>Getting documentation</title> <title>Getting documentation</title>
<para> <para>
After building that new environment, look through 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.
<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.
</para> </para>
<screen> <screen>
@ -422,9 +337,7 @@
</screen> </screen>
<para> <para>
This provides us with some useful documentation for using our packages. 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.
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.
</para> </para>
<screen> <screen>
@ -460,9 +373,7 @@
</screen> </screen>
<para> <para>
For this to work fully, you must also have this script sourced when you are 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:
logged in. Try adding something like this to your
<filename>~/.profile</filename> file:
</para> </para>
<screen> <screen>
@ -477,8 +388,7 @@ fi
</screen> </screen>
<para> <para>
Now just run <literal>source $HOME/.profile</literal> and you can starting Now just run <literal>source $HOME/.profile</literal> and you can starting loading man pages from your environent.
loading man pages from your environent.
</para> </para>
</section> </section>
@ -486,9 +396,7 @@ fi
<title>GNU info setup</title> <title>GNU info setup</title>
<para> <para>
Configuring GNU info is a little bit trickier than man pages. To work 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.
correctly, info needs a database to be generated. This can be done with
some small modifications to our environment scripts.
</para> </para>
<screen> <screen>
@ -534,11 +442,7 @@ fi
</screen> </screen>
<para> <para>
<literal>postBuild</literal> tells Nixpkgs to run a command after building <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.
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.
</para> </para>
</section> </section>
</section> </section>

15
doc/contributing.xml
View File

@ -3,10 +3,8 @@
xml:id="chap-contributing"> xml:id="chap-contributing">
<title>Contributing to this documentation</title> <title>Contributing to this documentation</title>
<para> <para>
The DocBook sources of the Nixpkgs manual are in the The DocBook sources of the Nixpkgs manual are in the <filename
<filename xlink:href="https://github.com/NixOS/nixpkgs/tree/master/doc">doc</filename> subdirectory of the Nixpkgs repository.
xlink:href="https://github.com/NixOS/nixpkgs/tree/master/doc">doc</filename>
subdirectory of the Nixpkgs repository.
</para> </para>
<para> <para>
You can quickly check your edits with <command>make</command>: You can quickly check your edits with <command>make</command>:
@ -17,19 +15,16 @@ xlink:href="https://github.com/NixOS/nixpkgs/tree/master/doc">doc</filename>
<prompt>[nix-shell]$ </prompt>make <prompt>[nix-shell]$ </prompt>make
</screen> </screen>
<para> <para>
If you experience problems, run <command>make debug</command> to help If you experience problems, run <command>make debug</command> to help understand the docbook errors.
understand the docbook errors.
</para> </para>
<para> <para>
After making modifications to the manual, it's important to build it before After making modifications to the manual, it's important to build it before committing. You can do that as follows:
committing. You can do that as follows:
<screen> <screen>
<prompt>$ </prompt>cd /path/to/nixpkgs/doc <prompt>$ </prompt>cd /path/to/nixpkgs/doc
<prompt>$ </prompt>nix-shell <prompt>$ </prompt>nix-shell
<prompt>[nix-shell]$ </prompt>make clean <prompt>[nix-shell]$ </prompt>make clean
<prompt>[nix-shell]$ </prompt>nix-build . <prompt>[nix-shell]$ </prompt>nix-build .
</screen> </screen>
If the build succeeds, the manual will be in If the build succeeds, the manual will be in <filename>./result/share/doc/nixpkgs/manual.html</filename>.
<filename>./result/share/doc/nixpkgs/manual.html</filename>.
</para> </para>
</chapter> </chapter>

390
doc/cross-compilation.xml
View File

@ -6,25 +6,11 @@
<title>Introduction</title> <title>Introduction</title>
<para> <para>
"Cross-compilation" means compiling a program on one machine for another "Cross-compilation" means compiling a program on one machine for another type of machine. For example, a typical use of cross-compilation is to compile programs for embedded devices. These devices often don't have the computing power and memory to compile their own programs. One might think that cross-compilation is a fairly niche concern. However, there are significant advantages to rigorously distinguishing between build-time and run-time environments! Significant, because the benefits apply even when one is developing and deploying on the same machine. Nixpkgs is increasingly adopting the opinion that packages should be written with cross-compilation in mind, and nixpkgs should evaluate in a similar way (by minimizing cross-compilation-specific special cases) whether or not one is cross-compiling.
type of machine. For example, a typical use of cross-compilation is to
compile programs for embedded devices. These devices often don't have the
computing power and memory to compile their own programs. One might think
that cross-compilation is a fairly niche concern. However, there are
significant advantages to rigorously distinguishing between build-time and
run-time environments! Significant, because the benefits apply even when one
is developing and deploying on the same machine. Nixpkgs is increasingly
adopting the opinion that packages should be written with cross-compilation
in mind, and nixpkgs should evaluate in a similar way (by minimizing
cross-compilation-specific special cases) whether or not one is
cross-compiling.
</para> </para>
<para> <para>
This chapter will be organized in three parts. First, it will describe the This chapter will be organized in three parts. First, it will describe the basics of how to package software in a way that supports cross-compilation. Second, it will describe how to use Nixpkgs when cross-compiling. Third, it will describe the internal infrastructure supporting cross-compilation.
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.
</para> </para>
</section> </section>
<!--============================================================--> <!--============================================================-->
@ -35,24 +21,12 @@
<title>Platform parameters</title> <title>Platform parameters</title>
<para> <para>
Nixpkgs follows the Nixpkgs follows the <link
<link xlink:href="https://gcc.gnu.org/onlinedocs/gccint/Configure-Terms.html">conventions of GNU autoconf</link>. We distinguish between 3 types of platforms when building a derivation: <wordasword>build</wordasword>, <wordasword>host</wordasword>, and <wordasword>target</wordasword>. In summary, <wordasword>build</wordasword> is the platform on which a package is being built, <wordasword>host</wordasword> is the platform on which it will run. The third attribute, <wordasword>target</wordasword>, is relevant only for certain specific compilers and build tools.
xlink:href="https://gcc.gnu.org/onlinedocs/gccint/Configure-Terms.html">conventions
of GNU autoconf</link>. We distinguish between 3 types of platforms when
building a derivation: <wordasword>build</wordasword>,
<wordasword>host</wordasword>, and <wordasword>target</wordasword>. In
summary, <wordasword>build</wordasword> is the platform on which a package
is being built, <wordasword>host</wordasword> is the platform on which it
will run. The third attribute, <wordasword>target</wordasword>, is relevant
only for certain specific compilers and build tools.
</para> </para>
<para> <para>
In Nixpkgs, these three platforms are defined as attribute sets under the In Nixpkgs, these three platforms are defined as attribute sets under the names <literal>buildPlatform</literal>, <literal>hostPlatform</literal>, and <literal>targetPlatform</literal>. They are always defined as attributes in the standard environment. That means one can access them like:
names <literal>buildPlatform</literal>, <literal>hostPlatform</literal>,
and <literal>targetPlatform</literal>. They are always defined as
attributes in the standard environment. That means one can access them
like:
<programlisting>{ stdenv, fooDep, barDep, .. }: ...stdenv.buildPlatform...</programlisting> <programlisting>{ stdenv, fooDep, barDep, .. }: ...stdenv.buildPlatform...</programlisting>
. .
</para> </para>
@ -64,9 +38,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
The "build platform" is the platform on which a package is built. Once The "build platform" is the platform on which a package is built. Once someone has a built package, or pre-built binary package, the build platform should not matter and can be ignored.
someone has a built package, or pre-built binary package, the build
platform should not matter and can be ignored.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -76,9 +48,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
The "host platform" is the platform on which a package will be run. This The "host platform" is the platform on which a package will be run. This is the simplest platform to understand, but also the one with the worst name.
is the simplest platform to understand, but also the one with the worst
name.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -88,44 +58,23 @@
</term> </term>
<listitem> <listitem>
<para> <para>
The "target platform" attribute is, unlike the other two attributes, not The "target platform" attribute is, unlike the other two attributes, not actually fundamental to the process of building software. Instead, it is only relevant for compatibility with building certain specific compilers and build tools. It can be safely ignored for all other packages.
actually fundamental to the process of building software. Instead, it is
only relevant for compatibility with building certain specific compilers
and build tools. It can be safely ignored for all other packages.
</para> </para>
<para> <para>
The build process of certain compilers is written in such a way that the The build process of certain compilers is written in such a way that the compiler resulting from a single build can itself only produce binaries for a single platform. The task of specifying this single "target platform" is thus pushed to build time of the compiler. The root cause of this is that the compiler (which will be run on the host) and the standard library/runtime (which will be run on the target) are built by a single build process.
compiler resulting from a single build can itself only produce binaries
for a single platform. The task of specifying this single "target
platform" is thus pushed to build time of the compiler. The root cause
of this is that the compiler (which will be run on the host) and the
standard library/runtime (which will be run on the target) are built by
a single build process.
</para> </para>
<para> <para>
There is no fundamental need to think about a single target ahead of There is no fundamental need to think about a single target ahead of time like this. If the tool supports modular or pluggable backends, both the need to specify the target at build time and the constraint of having only a single target disappear. An example of such a tool is LLVM.
time like this. If the tool supports modular or pluggable backends, both
the need to specify the target at build time and the constraint of
having only a single target disappear. An example of such a tool is
LLVM.
</para> </para>
<para> <para>
Although the existence of a "target platfom" is arguably a historical Although the existence of a "target platfom" is arguably a historical mistake, it is a common one: examples of tools that suffer from it are GCC, Binutils, GHC and Autoconf. Nixpkgs tries to avoid sharing in the mistake where possible. Still, because the concept of a target platform is so ingrained, it is best to support it as is.
mistake, it is a common one: examples of tools that suffer from it are
GCC, Binutils, GHC and Autoconf. Nixpkgs tries to avoid sharing in the
mistake where possible. Still, because the concept of a target platform
is so ingrained, it is best to support it as is.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
<para> <para>
The exact schema these fields follow is a bit ill-defined due to a long and The exact schema these fields follow is a bit ill-defined due to a long and convoluted evolution, but this is slowly being cleaned up. You can see examples of ones used in practice in <literal>lib.systems.examples</literal>; note how they are not all very consistent. For now, here are few fields can count on them containing:
convoluted evolution, but this is slowly being cleaned up. You can see
examples of ones used in practice in
<literal>lib.systems.examples</literal>; note how they are not all very
consistent. For now, here are few fields can count on them containing:
</para> </para>
<variablelist> <variablelist>
@ -135,13 +84,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
This is a two-component shorthand for the platform. Examples of this This is a two-component shorthand for the platform. Examples of this would be "x86_64-darwin" and "i686-linux"; see <literal>lib.systems.doubles</literal> for more. The first component corresponds to the CPU architecture of the platform and the second to the operating system of the platform (<literal>[cpu]-[os]</literal>). This format has built-in support in Nix, such as the <varname>builtins.currentSystem</varname> impure string.
would be "x86_64-darwin" and "i686-linux"; see
<literal>lib.systems.doubles</literal> for more. The first component
corresponds to the CPU architecture of the platform and the second to
the operating system of the platform (<literal>[cpu]-[os]</literal>).
This format has built-in support in Nix, such as the
<varname>builtins.currentSystem</varname> impure string.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -151,15 +94,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
This is a 3- or 4- component shorthand for the platform. Examples of This is a 3- or 4- component shorthand for the platform. Examples of this would be <literal>x86_64-unknown-linux-gnu</literal> and <literal>aarch64-apple-darwin14</literal>. This is a standard format called the "LLVM target triple", as they are pioneered by LLVM. In the 4-part form, this corresponds to <literal>[cpu]-[vendor]-[os]-[abi]</literal>. This format is strictly more informative than the "Nix host double", as the previous format could analogously be termed. This needs a better name than <varname>config</varname>!
this would be <literal>x86_64-unknown-linux-gnu</literal> and
<literal>aarch64-apple-darwin14</literal>. This is a standard format
called the "LLVM target triple", as they are pioneered by LLVM. In the
4-part form, this corresponds to
<literal>[cpu]-[vendor]-[os]-[abi]</literal>. This format is strictly
more informative than the "Nix host double", as the previous format
could analogously be termed. This needs a better name than
<varname>config</varname>!
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -169,10 +104,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
This is a Nix representation of a parsed LLVM target triple with This is a Nix representation of a parsed LLVM target triple with white-listed components. This can be specified directly, or actually parsed from the <varname>config</varname>. See <literal>lib.systems.parse</literal> for the exact representation.
white-listed components. This can be specified directly, or actually
parsed from the <varname>config</varname>. See
<literal>lib.systems.parse</literal> for the exact representation.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -182,10 +114,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
This is a string identifying the standard C library used. Valid This is a string identifying the standard C library used. Valid identifiers include "glibc" for GNU libc, "libSystem" for Darwin's Libsystem, and "uclibc" for µClibc. It should probably be refactored to use the module system, like <varname>parse</varname>.
identifiers include "glibc" for GNU libc, "libSystem" for Darwin's
Libsystem, and "uclibc" for µClibc. It should probably be refactored to
use the module system, like <varname>parse</varname>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -195,10 +124,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
These predicates are defined in <literal>lib.systems.inspect</literal>, These predicates are defined in <literal>lib.systems.inspect</literal>, and slapped onto every platform. They are superior to the ones in <varname>stdenv</varname> as they force the user to be explicit about which platform they are inspecting. Please use these instead of those.
and slapped onto every platform. They are superior to the ones in
<varname>stdenv</varname> as they force the user to be explicit about
which platform they are inspecting. Please use these instead of those.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -208,11 +134,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
This is, quite frankly, a dumping ground of ad-hoc settings (it's an This is, quite frankly, a dumping ground of ad-hoc settings (it's an attribute set). See <literal>lib.systems.platforms</literal> for examples—there's hopefully one in there that will work verbatim for each platform that is working. Please help us triage these flags and give them better homes!
attribute set). See <literal>lib.systems.platforms</literal> for
examples—there's hopefully one in there that will work verbatim for
each platform that is working. Please help us triage these flags and
give them better homes!
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -224,62 +146,33 @@
<note> <note>
<para> <para>
This is a rather philosophical description that isn't very This is a rather philosophical description that isn't very Nixpkgs-specific. For an overview of all the relevant attributes given to <varname>mkDerivation</varname>, see <xref
Nixpkgs-specific. For an overview of all the relevant attributes given to linkend="ssec-stdenv-dependencies"/>. For a description of how everything is implemented, see <xref linkend="ssec-cross-dependency-implementation" />.
<varname>mkDerivation</varname>, see
<xref
linkend="ssec-stdenv-dependencies"/>. For a description of how
everything is implemented, see
<xref linkend="ssec-cross-dependency-implementation" />.
</para> </para>
</note> </note>
<para> <para>
In this section we explore the relationship between both runtime and In this section we explore the relationship between both runtime and build-time dependencies and the 3 Autoconf platforms.
build-time dependencies and the 3 Autoconf platforms.
</para> </para>
<para> <para>
A run time dependency between two packages requires that their host A run time dependency between two packages requires that their host platforms match. This is directly implied by the meaning of "host platform" and "runtime dependency": The package dependency exists while both packages are running on a single host platform.
platforms match. This is directly implied by the meaning of "host platform"
and "runtime dependency": The package dependency exists while both packages
are running on a single host platform.
</para> </para>
<para> <para>
A build time dependency, however, has a shift in platforms between the A build time dependency, however, has a shift in platforms between the depending package and the depended-on package. "build time dependency" means that to build the depending package we need to be able to run the depended-on's package. The depending package's build platform is therefore equal to the depended-on package's host platform.
depending package and the depended-on package. "build time dependency"
means that to build the depending package we need to be able to run the
depended-on's package. The depending package's build platform is therefore
equal to the depended-on package's host platform.
</para> </para>
<para> <para>
If both the dependency and depending packages aren't compilers or other If both the dependency and depending packages aren't compilers or other machine-code-producing tools, we're done. And indeed <varname>buildInputs</varname> and <varname>nativeBuildInputs</varname> have covered these simpler build-time and run-time (respectively) changes for many years. But if the dependency does produce machine code, we might need to worry about its target platform too. In principle, that target platform might be any of the depending package's build, host, or target platforms, but we prohibit dependencies from a "later" platform to an earlier platform to limit confusion because we've never seen a legitimate use for them.
machine-code-producing tools, we're done. And indeed
<varname>buildInputs</varname> and <varname>nativeBuildInputs</varname>
have covered these simpler build-time and run-time (respectively) changes
for many years. But if the dependency does produce machine code, we might
need to worry about its target platform too. In principle, that target
platform might be any of the depending package's build, host, or target
platforms, but we prohibit dependencies from a "later" platform to an
earlier platform to limit confusion because we've never seen a legitimate
use for them.
</para> </para>
<para> <para>
Finally, if the depending package is a compiler or other Finally, if the depending package is a compiler or other machine-code-producing tool, it might need dependencies that run at "emit time". This is for compilers that (regrettably) insist on being built together with their source langauges' 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.
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 langauges' 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.
</para> </para>
<para> <para>
Putting this all together, that means we have dependencies in the form Putting this all together, that means we have dependencies in the form "host → target", in at most the following six combinations:
"host → target", in at most the following six combinations:
<table> <table>
<caption>Possible dependency types</caption> <caption>Possible dependency types</caption>
<thead> <thead>
@ -318,16 +211,7 @@
</para> </para>
<para> <para>
Some examples will make this table clearer. Suppose there's some package Some examples will make this table clearer. Suppose there's some package that is being built with a <literal>(build, host, target)</literal> platform triple of <literal>(foo, bar, baz)</literal>. If it has a build-time library dependency, that would be a "host → build" dependency with a triple of <literal>(foo, foo, *)</literal> (the target platform is irrelevant). If it needs a compiler to be built, that would be a "build → host" dependency with a triple of <literal>(foo, foo, *)</literal> (the target platform is irrelevant). That compiler, would be built with another compiler, also "build → host" dependency, with a triple of <literal>(foo, foo, foo)</literal>.
that is being built with a <literal>(build, host, target)</literal>
platform triple of <literal>(foo, bar, baz)</literal>. If it has a
build-time library dependency, that would be a "host → build" dependency
with a triple of <literal>(foo, foo, *)</literal> (the target platform is
irrelevant). If it needs a compiler to be built, that would be a "build →
host" dependency with a triple of <literal>(foo, foo, *)</literal> (the
target platform is irrelevant). That compiler, would be built with another
compiler, also "build → host" dependency, with a triple of <literal>(foo,
foo, foo)</literal>.
</para> </para>
</section> </section>
@ -335,20 +219,14 @@
<title>Cross packaging cookbook</title> <title>Cross packaging cookbook</title>
<para> <para>
Some frequently encountered problems when packaging for cross-compilation Some frequently encountered problems when packaging for cross-compilation should be answered here. Ideally, the information above is exhaustive, so this section cannot provide any new information, but it is ludicrous and cruel to expect everyone to spend effort working through the interaction of many features just to figure out the same answer to the same common problem. Feel free to add to this list!
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!
</para> </para>
<qandaset> <qandaset>
<qandaentry xml:id="cross-qa-build-c-program-in-build-environment"> <qandaentry xml:id="cross-qa-build-c-program-in-build-environment">
<question> <question>
<para> <para>
What if my package's build system needs to build a C program to be run What if my package's build system needs to build a C program to be run under the build environment?
under the build environment?
</para> </para>
</question> </question>
<answer> <answer>
@ -366,11 +244,7 @@
</question> </question>
<answer> <answer>
<para> <para>
Many packages assume that an unprefixed <command>ar</command> is Many packages assume that an unprefixed <command>ar</command> 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`.
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`.
</para> </para>
</answer> </answer>
</qandaentry> </qandaentry>
@ -395,82 +269,32 @@
<title>Cross-building packages</title> <title>Cross-building packages</title>
<para> <para>
Nixpkgs can be instantiated with <varname>localSystem</varname> alone, in Nixpkgs can be instantiated with <varname>localSystem</varname> alone, in which case there is no cross-compiling and everything is built by and for that system, or also with <varname>crossSystem</varname>, in which case packages run on the latter, but all building happens on the former. Both parameters take the same schema as the 3 (build, host, and target) platforms defined in the previous section. As mentioned above, <literal>lib.systems.examples</literal> has some platforms which are used as arguments for these parameters in practice. You can use them programmatically, or on the command line:
which case there is no cross-compiling and everything is built by and for
that system, or also with <varname>crossSystem</varname>, in which case
packages run on the latter, but all building happens on the former. Both
parameters take the same schema as the 3 (build, host, and target) platforms
defined in the previous section. As mentioned above,
<literal>lib.systems.examples</literal> has some platforms which are used as
arguments for these parameters in practice. You can use them
programmatically, or on the command line:
<programlisting> <programlisting>
nix-build &lt;nixpkgs&gt; --arg crossSystem '(import &lt;nixpkgs/lib&gt;).systems.examples.fooBarBaz' -A whatever</programlisting> nix-build &lt;nixpkgs&gt; --arg crossSystem '(import &lt;nixpkgs/lib&gt;).systems.examples.fooBarBaz' -A whatever</programlisting>
</para> </para>
<note> <note>
<para> <para>
Eventually we would like to make these platform examples an unnecessary Eventually we would like to make these platform examples an unnecessary convenience so that
convenience so that
<programlisting> <programlisting>
nix-build &lt;nixpkgs&gt; --arg crossSystem '{ config = "&lt;arch&gt;-&lt;os&gt;-&lt;vendor&gt;-&lt;abi&gt;"; }' -A whatever</programlisting> nix-build &lt;nixpkgs&gt; --arg crossSystem '{ config = "&lt;arch&gt;-&lt;os&gt;-&lt;vendor&gt;-&lt;abi&gt;"; }' -A whatever</programlisting>
works in the vast majority of cases. The problem today is dependencies on works in the vast majority of cases. The problem today is dependencies on other sorts of configuration which aren't given proper defaults. We rely on the examples to crudely to set those configuration parameters in some vaguely sane manner on the users behalf. Issue <link xlink:href="https://github.com/NixOS/nixpkgs/issues/34274">#34274</link> tracks this inconvenience along with its root cause in crufty configuration options.
other sorts of configuration which aren't given proper defaults. We rely on
the examples to crudely to set those configuration parameters in some
vaguely sane manner on the users behalf. Issue
<link xlink:href="https://github.com/NixOS/nixpkgs/issues/34274">#34274</link>
tracks this inconvenience along with its root cause in crufty configuration
options.
</para> </para>
</note> </note>
<para> <para>
While one is free to pass both parameters in full, there's a lot of logic to While one is free to pass both parameters in full, there's a lot of logic to fill in missing fields. As discussed in the previous section, only one of <varname>system</varname>, <varname>config</varname>, and <varname>parsed</varname> is needed to infer the other two. Additionally, <varname>libc</varname> will be inferred from <varname>parse</varname>. Finally, <literal>localSystem.system</literal> is also <emphasis>impurely</emphasis> inferred based on the platform evaluation occurs. This means it is often not necessary to pass <varname>localSystem</varname> at all, as in the command-line example in the previous paragraph.
fill in missing fields. As discussed in the previous section, only one of
<varname>system</varname>, <varname>config</varname>, and
<varname>parsed</varname> is needed to infer the other two. Additionally,
<varname>libc</varname> will be inferred from <varname>parse</varname>.
Finally, <literal>localSystem.system</literal> is also
<emphasis>impurely</emphasis> inferred based on the platform evaluation
occurs. This means it is often not necessary to pass
<varname>localSystem</varname> at all, as in the command-line example in the
previous paragraph.
</para> </para>
<note> <note>
<para> <para>
Many sources (manual, wiki, etc) probably mention passing Many sources (manual, wiki, etc) probably mention passing <varname>system</varname>, <varname>platform</varname>, along with the optional <varname>crossSystem</varname> to nixpkgs: <literal>import &lt;nixpkgs&gt; { system = ..; platform = ..; crossSystem = ..; }</literal>. Passing those two instead of <varname>localSystem</varname> 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.
<varname>system</varname>, <varname>platform</varname>, along with the
optional <varname>crossSystem</varname> to nixpkgs: <literal>import
&lt;nixpkgs&gt; { system = ..; platform = ..; crossSystem = ..;
}</literal>. Passing those two instead of <varname>localSystem</varname> 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.
</para> </para>
</note> </note>
<para> <para>
One would think that <varname>localSystem</varname> and One would think that <varname>localSystem</varname> and <varname>crossSystem</varname> overlap horribly with the three <varname>*Platforms</varname> (<varname>buildPlatform</varname>, <varname>hostPlatform,</varname> and <varname>targetPlatform</varname>; see <varname>stage.nix</varname> or the manual). Actually, those identifiers are purposefully not used here to draw a subtle but important distinction: While the granularity of having 3 platforms is necessary to properly *build* packages, it is overkill for specifying the user's *intent* when making a build plan or package set. A simple "build vs deploy" dichotomy is adequate: the sliding window principle described in the previous section shows how to interpolate between the these two "end points" to get the 3 platform triple for each bootstrapping stage. That means for any package a given package set, even those not bound on the top level but only reachable via dependencies or <varname>buildPackages</varname>, the three platforms will be defined as one of <varname>localSystem</varname> or <varname>crossSystem</varname>, with the former replacing the latter as one traverses build-time dependencies. A last simple difference is that <varname>crossSystem</varname> should be null when one doesn't want to cross-compile, while the <varname>*Platform</varname>s are always non-null. <varname>localSystem</varname> is always non-null.
<varname>crossSystem</varname> overlap horribly with the three
<varname>*Platforms</varname> (<varname>buildPlatform</varname>,
<varname>hostPlatform,</varname> and <varname>targetPlatform</varname>; see
<varname>stage.nix</varname> or the manual). Actually, those identifiers are
purposefully not used here to draw a subtle but important distinction: While
the granularity of having 3 platforms is necessary to properly *build*
packages, it is overkill for specifying the user's *intent* when making a
build plan or package set. A simple "build vs deploy" dichotomy is adequate:
the sliding window principle described in the previous section shows how to
interpolate between the these two "end points" to get the 3 platform triple
for each bootstrapping stage. That means for any package a given package
set, even those not bound on the top level but only reachable via
dependencies or <varname>buildPackages</varname>, the three platforms will
be defined as one of <varname>localSystem</varname> or
<varname>crossSystem</varname>, with the former replacing the latter as one
traverses build-time dependencies. A last simple difference is that
<varname>crossSystem</varname> should be null when one doesn't want to
cross-compile, while the <varname>*Platform</varname>s are always non-null.
<varname>localSystem</varname> is always non-null.
</para> </para>
</section> </section>
<!--============================================================--> <!--============================================================-->
@ -481,61 +305,20 @@ nix-build &lt;nixpkgs&gt; --arg crossSystem '{ config = "&lt;arch&gt;-&lt;os&gt;
<title>Implementation of dependencies</title> <title>Implementation of dependencies</title>
<para> <para>
The categorizes of dependencies developed in The categorizes of dependencies developed in <xref
<xref linkend="ssec-cross-dependency-categorization"/> are specified as lists of derivations given to <varname>mkDerivation</varname>, as documented in <xref linkend="ssec-stdenv-dependencies"/>. In short, each list of dependencies for "host → target" of "foo → bar" is called <varname>depsFooBar</varname>, with exceptions for backwards compatibility that <varname>depsBuildHost</varname> is instead called <varname>nativeBuildInputs</varname> and <varname>depsHostTarget</varname> is instead called <varname>buildInputs</varname>. Nixpkgs is now structured so that each <varname>depsFooBar</varname> is automatically taken from <varname>pkgsFooBar</varname>. (These <varname>pkgsFooBar</varname>s are quite new, so there is no special case for <varname>nativeBuildInputs</varname> and <varname>buildInputs</varname>.) For example, <varname>pkgsBuildHost.gcc</varname> should be used at build-time, while <varname>pkgsHostTarget.gcc</varname> should be used at run-time.
linkend="ssec-cross-dependency-categorization"/> are specified as
lists of derivations given to <varname>mkDerivation</varname>, as
documented in <xref linkend="ssec-stdenv-dependencies"/>. In short, each
list of dependencies for "host → target" of "foo → bar" is called
<varname>depsFooBar</varname>, with exceptions for backwards compatibility
that <varname>depsBuildHost</varname> is instead called
<varname>nativeBuildInputs</varname> and <varname>depsHostTarget</varname>
is instead called <varname>buildInputs</varname>. Nixpkgs is now structured
so that each <varname>depsFooBar</varname> is automatically taken from
<varname>pkgsFooBar</varname>. (These <varname>pkgsFooBar</varname>s are
quite new, so there is no special case for
<varname>nativeBuildInputs</varname> and <varname>buildInputs</varname>.)
For example, <varname>pkgsBuildHost.gcc</varname> should be used at
build-time, while <varname>pkgsHostTarget.gcc</varname> should be used at
run-time.
</para> </para>
<para> <para>
Now, for most of Nixpkgs's history, there were no Now, for most of Nixpkgs's history, there were no <varname>pkgsFooBar</varname> attributes, and most packages have not been refactored to use it explicitly. Prior to those, there were just <varname>buildPackages</varname>, <varname>pkgs</varname>, and <varname>targetPackages</varname>. Those are now redefined as aliases to <varname>pkgsBuildHost</varname>, <varname>pkgsHostTarget</varname>, and <varname>pkgsTargetTarget</varname>. It is acceptable, even recommended, to use them for libraries to show that the host platform is irrelevant.
<varname>pkgsFooBar</varname> attributes, and most packages have not been
refactored to use it explicitly. Prior to those, there were just
<varname>buildPackages</varname>, <varname>pkgs</varname>, and
<varname>targetPackages</varname>. Those are now redefined as aliases to
<varname>pkgsBuildHost</varname>, <varname>pkgsHostTarget</varname>, and
<varname>pkgsTargetTarget</varname>. It is acceptable, even recommended, to
use them for libraries to show that the host platform is irrelevant.
</para> </para>
<para> <para>
But before that, there was just <varname>pkgs</varname>, even though both But before that, there was just <varname>pkgs</varname>, even though both <varname>buildInputs</varname> and <varname>nativeBuildInputs</varname> existed. [Cross barely worked, and those were implemented with some hacks on <varname>mkDerivation</varname> 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 <varname>callPackage</varname> 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, <emphasis>and</emphasis> 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.
<varname>buildInputs</varname> and <varname>nativeBuildInputs</varname>
existed. [Cross barely worked, and those were implemented with some hacks
on <varname>mkDerivation</varname> 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
<varname>callPackage</varname> 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, <emphasis>and</emphasis>
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.
</para> </para>
<para> <para>
To make this work, we "splice" together the six To make this work, we "splice" together the six <varname>pkgsFooBar</varname> package sets and have <varname>callPackage</varname> actually take its arguments from that. This is currently implemented in <filename>pkgs/top-level/splice.nix</filename>. <varname>mkDerivation</varname> then, for each dependency attribute, pulls the right derivation out from the splice. This splicing can be skipped when not cross-compiling as the package sets are the same, but still is a bit slow for cross-compiling. We'd like to do something better, but haven't come up with anything yet.
<varname>pkgsFooBar</varname> package sets and have
<varname>callPackage</varname> actually take its arguments from that. This
is currently implemented in <filename>pkgs/top-level/splice.nix</filename>.
<varname>mkDerivation</varname> then, for each dependency attribute, pulls
the right derivation out from the splice. This splicing can be skipped when
not cross-compiling as the package sets are the same, but still is a bit
slow for cross-compiling. We'd like to do something better, but haven't
come up with anything yet.
</para> </para>
</section> </section>
@ -543,21 +326,11 @@ nix-build &lt;nixpkgs&gt; --arg crossSystem '{ config = "&lt;arch&gt;-&lt;os&gt;
<title>Bootstrapping</title> <title>Bootstrapping</title>
<para> <para>
Each of the package sets described above come from a single bootstrapping Each of the package sets described above come from a single bootstrapping stage. While <filename>pkgs/top-level/default.nix</filename>, coordinates the composition of stages at a high level, <filename>pkgs/top-level/stage.nix</filename> "ties the knot" (creates the fixed point) of each stage. The package sets are defined per-stage however, so they can be thought of as edges between stages (the nodes) in a graph. Compositions like <literal>pkgsBuildTarget.targetPackages</literal> can be thought of as paths to this graph.
stage. While <filename>pkgs/top-level/default.nix</filename>, coordinates
the composition of stages at a high level,
<filename>pkgs/top-level/stage.nix</filename> "ties the knot" (creates the
fixed point) of each stage. The package sets are defined per-stage however,
so they can be thought of as edges between stages (the nodes) in a graph.
Compositions like <literal>pkgsBuildTarget.targetPackages</literal> can be
thought of as paths to this graph.
</para> </para>
<para> <para>
While there are many package sets, and thus many edges, the stages can also While there are many package sets, and thus many edges, the stages can also be arranged in a linear chain. In other words, many of the edges are redundant as far as connectivity is concerned. This hinges on the type of bootstrapping we do. Currently for cross it is:
be arranged in a linear chain. In other words, many of the edges are
redundant as far as connectivity is concerned. This hinges on the type of
bootstrapping we do. Currently for cross it is:
<orderedlist> <orderedlist>
<listitem> <listitem>
<para> <para>
@ -575,102 +348,45 @@ nix-build &lt;nixpkgs&gt; --arg crossSystem '{ config = "&lt;arch&gt;-&lt;os&gt;
</para> </para>
</listitem> </listitem>
</orderedlist> </orderedlist>
In each stage, <varname>pkgsBuildHost</varname> refers the the previous In each stage, <varname>pkgsBuildHost</varname> refers the the previous stage, <varname>pkgsBuildBuild</varname> refers to the one before that, and <varname>pkgsHostTarget</varname> refers to the current one, and <varname>pkgsTargetTarget</varname> 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. <varname>pkgsBuildTarget</varname> and <varname>pkgsHostHost</varname> 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 <filename>pkgs/stdenv/booter.nix</filename>, and secondarily aliases in <filename>pkgs/top-level/stage.nix</filename>.
stage, <varname>pkgsBuildBuild</varname> refers to the one before that, and
<varname>pkgsHostTarget</varname> refers to the current one, and
<varname>pkgsTargetTarget</varname> 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.
<varname>pkgsBuildTarget</varname> and <varname>pkgsHostHost</varname> 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
<filename>pkgs/stdenv/booter.nix</filename>, and secondarily aliases in
<filename>pkgs/top-level/stage.nix</filename>.
</para> </para>
<note> <note>
<para> <para>
Note the native stages are bootstrapped in legacy ways that predate the Note the native stages are bootstrapped in legacy ways that predate the current cross implementation. This is why the the bootstrapping stages leading up to the final stages are ignored inthe previous paragraph.
current cross implementation. This is why the the bootstrapping stages
leading up to the final stages are ignored inthe previous paragraph.
</para> </para>
</note> </note>
<para> <para>
If one looks at the 3 platform triples, one can see that they overlap such If one looks at the 3 platform triples, one can see that they overlap such that one could put them together into a chain like:
that one could put them together into a chain like:
<programlisting> <programlisting>
(native, native, native, foreign, foreign) (native, native, native, foreign, foreign)
</programlisting> </programlisting>
If one imagines the saturating self references at the end being replaced If one imagines the saturating self references at the end being replaced with infinite stages, and then overlays those platform triples, one ends up with the infinite tuple:
with infinite stages, and then overlays those platform triples, one ends up
with the infinite tuple:
<programlisting> <programlisting>
(native..., native, native, native, foreign, foreign, foreign...) (native..., native, native, native, foreign, foreign, foreign...)
</programlisting> </programlisting>
On can then imagine any sequence of platforms such that there are bootstrap 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" bootstraping stage where <literal>build != host != target</literal>, more bootstrapping stages are needed since no sliding window providess the pesky <varname>pkgsBuildTarget</varname> package set since it skips the Canadian cross stage's "host".
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" bootstraping stage where
<literal>build != host != target</literal>, more bootstrapping stages are
needed since no sliding window providess the pesky
<varname>pkgsBuildTarget</varname> package set since it skips the Canadian
cross stage's "host".
</para> </para>
<note> <note>
<para> <para>
It is much better to refer to <varname>buildPackages</varname> than It is much better to refer to <varname>buildPackages</varname> than <varname>targetPackages</varname>, or more broadly package sets that do not mention "target". There are three reasons for this.
<varname>targetPackages</varname>, or more broadly package sets that do
not mention "target". There are three reasons for this.
</para> </para>
<para> <para>
First, it is because bootstrapping stages do not have a unique First, it is because bootstrapping stages do not have a unique <varname>targetPackages</varname>. For example a <literal>(x86-linux, x86-linux, arm-linux)</literal> and <literal>(x86-linux, x86-linux, x86-windows)</literal> package set both have a <literal>(x86-linux, x86-linux, x86-linux)</literal> package set. Because there is no canonical <varname>targetPackages</varname> for such a native (<literal>build == host == target</literal>) package set, we set their <varname>targetPackages</varname>
<varname>targetPackages</varname>. For example a <literal>(x86-linux,
x86-linux, arm-linux)</literal> and <literal>(x86-linux, x86-linux,
x86-windows)</literal> package set both have a <literal>(x86-linux,
x86-linux, x86-linux)</literal> package set. Because there is no canonical
<varname>targetPackages</varname> for such a native (<literal>build ==
host == target</literal>) package set, we set their
<varname>targetPackages</varname>
</para> </para>
<para> <para>
Second, it is because this is a frequent source of hard-to-follow Second, it is because this is a frequent source of hard-to-follow "infinite recursions" / cycles. When only package sets that don't mention target are used, the package set forms a directed acyclic graph. This means that all cycles that exist are confined to one stage. This means they are a lot smaller, and easier to follow in the code or a backtrace. It also means they are present in native and cross builds alike, and so more likely to be caught by CI and other users.
"infinite recursions" / cycles. When only package sets that don't mention
target are used, the package set forms a directed acyclic graph. This
means that all cycles that exist are confined to one stage. This means
they are a lot smaller, and easier to follow in the code or a backtrace.
It also means they are present in native and cross builds alike, and so
more likely to be caught by CI and other users.
</para> </para>
<para> <para>
Thirdly, it is because everything target-mentioning only exists to Thirdly, it is because everything target-mentioning only exists to accommodate compilers with lousy build systems that insist on the compiler itself and standard library being built together. Of course that is bad because bigger derivations means longer rebuilds. It is also problematic because it tends to make the standard libraries less like other libraries than they could be, complicating code and build systems alike. Because of the other problems, and because of these innate disadvantages, compilers ought to be packaged another way where possible.
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.
</para> </para>
</note> </note>
<note> <note>
<para> <para>
If one explores Nixpkgs, they will see derivations with names like If one explores Nixpkgs, they will see derivations with names like <literal>gccCross</literal>. Such <literal>*Cross</literal> derivations is a holdover from before we properly distinguished between the host and target platforms—the derivation with "Cross" in the name covered the <literal>build = host != target</literal> case, while the other covered the <literal>host = target</literal>, with build platform the same or not based on whether one was using its <literal>.nativeDrv</literal> or <literal>.crossDrv</literal>. This ugliness will disappear soon.
<literal>gccCross</literal>. Such <literal>*Cross</literal> derivations is
a holdover from before we properly distinguished between the host and
target platforms—the derivation with "Cross" in the name covered the
<literal>build = host != target</literal> case, while the other covered
the <literal>host = target</literal>, with build platform the same or not
based on whether one was using its <literal>.nativeDrv</literal> or
<literal>.crossDrv</literal>. This ugliness will disappear soon.
</para> </para>
</note> </note>
</section> </section>

3
doc/functions.xml
View File

@ -4,8 +4,7 @@
xml:id="chap-functions"> xml:id="chap-functions">
<title>Functions reference</title> <title>Functions reference</title>
<para> <para>
The nixpkgs repository has several utility functions to manipulate Nix The nixpkgs repository has several utility functions to manipulate Nix expressions.
expressions.
</para> </para>
<xi:include href="functions/library.xml" /> <xi:include href="functions/library.xml" />
<xi:include href="functions/overrides.xml" /> <xi:include href="functions/overrides.xml" />

32
doc/functions/appimagetools.xml
View File

@ -5,17 +5,12 @@
<title>pkgs.appimageTools</title> <title>pkgs.appimageTools</title>
<para> <para>
<varname>pkgs.appimageTools</varname> is a set of functions for extracting <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.
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.
</para> </para>
<warning> <warning>
<para> <para>
The <varname>appimageTools</varname> API is unstable and may be subject to The <varname>appimageTools</varname> API is unstable and may be subject to backwards-incompatible changes in the future.
backwards-incompatible changes in the future.
</para> </para>
</warning> </warning>
@ -23,9 +18,7 @@
<title>AppImage formats</title> <title>AppImage formats</title>
<para> <para>
There are different formats for AppImages, see 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.
<link xlink:href="https://github.com/AppImage/AppImageSpec/blob/74ad9ca2f94bf864a4a0dac1f369dd4f00bd1c28/draft.md#image-format">the
specification</link> for details.
</para> </para>
<itemizedlist> <itemizedlist>
@ -55,8 +48,7 @@ type2.AppImage: ELF 64-bit LSB executable, x86-64, version 1 (SYSV) (Lepton 3.x)
</screen> </screen>
<para> <para>
Note how the type 1 AppImage is described as an <literal>ISO 9660 CD-ROM Note how the type 1 AppImage is described as an <literal>ISO 9660 CD-ROM filesystem</literal>, and the type 2 AppImage is not.
filesystem</literal>, and the type 2 AppImage is not.
</para> </para>
</section> </section>
@ -64,8 +56,7 @@ type2.AppImage: ELF 64-bit LSB executable, x86-64, version 1 (SYSV) (Lepton 3.x)
<title>Wrapping</title> <title>Wrapping</title>
<para> <para>
Depending on the type of AppImage you're wrapping, you'll have to use Depending on the type of AppImage you're wrapping, you'll have to use <varname>wrapType1</varname> or <varname>wrapType2</varname>.
<varname>wrapType1</varname> or <varname>wrapType2</varname>.
</para> </para>
<programlisting> <programlisting>
@ -91,23 +82,16 @@ appimageTools.wrapType2 { # or wrapType1
</callout> </callout>
<callout arearefs='ex-appimageTools-wrapping-2'> <callout arearefs='ex-appimageTools-wrapping-2'>
<para> <para>
<varname>extraPkgs</varname> allows you to pass a function to include <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:
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:
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
Looking through the extracted AppImage files, reading its scripts and 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>.
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>.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Running <command>strace -vfefile</command> on the wrapped executable, Running <command>strace -vfefile</command> on the wrapped executable, looking for libraries that can't be found.
looking for libraries that can't be found.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>

11
doc/functions/debug.xml
View File

@ -5,17 +5,10 @@
<title>Debugging Nix Expressions</title> <title>Debugging Nix Expressions</title>
<para> <para>
Nix is a unityped, dynamic language, this means every value can potentially 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.
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.
</para> </para>
<para> <para>
In the <literal>lib/debug.nix</literal> file you will find a number of 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.
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.
</para> </para>
</section> </section>

224
doc/functions/dockertools.xml
View File

@ -5,17 +5,12 @@
<title>pkgs.dockerTools</title> <title>pkgs.dockerTools</title>
<para> <para>
<varname>pkgs.dockerTools</varname> is a set of functions for creating and <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.
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.
</para> </para>
<warning> <warning>
<para> <para>
The <varname>dockerTools</varname> API is unstable and may be subject to The <varname>dockerTools</varname> API is unstable and may be subject to backwards-incompatible changes in the future.
backwards-incompatible changes in the future.
</para> </para>
</warning> </warning>
@ -23,15 +18,11 @@
<title>buildImage</title> <title>buildImage</title>
<para> <para>
This function is analogous to the <command>docker build</command> command, 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>.
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>.
</para> </para>
<para> <para>
The parameters of <varname>buildImage</varname> with relative example values The parameters of <varname>buildImage</varname> with relative example values are described below:
are described below:
</para> </para>
<example xml:id='ex-dockerTools-buildImage'> <example xml:id='ex-dockerTools-buildImage'>
@ -63,135 +54,89 @@ buildImage {
</example> </example>
<para> <para>
The above example will build a Docker image <literal>redis/latest</literal> 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.
from the given base image. Loading and running this image in Docker results
in <literal>redis-server</literal> being started automatically.
</para> </para>
<calloutlist> <calloutlist>
<callout arearefs='ex-dockerTools-buildImage-1'> <callout arearefs='ex-dockerTools-buildImage-1'>
<para> <para>
<varname>name</varname> specifies the name of the resulting image. This is <varname>name</varname> specifies the name of the resulting image. This is the only required argument for <varname>buildImage</varname>.
the only required argument for <varname>buildImage</varname>.
</para> </para>
</callout> </callout>
<callout arearefs='ex-dockerTools-buildImage-2'> <callout arearefs='ex-dockerTools-buildImage-2'>
<para> <para>
<varname>tag</varname> specifies the tag of the resulting image. By <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.
default it's <literal>null</literal>, which indicates that the nix output
hash will be used as tag.
</para> </para>
</callout> </callout>
<callout arearefs='ex-dockerTools-buildImage-3'> <callout arearefs='ex-dockerTools-buildImage-3'>
<para> <para>
<varname>fromImage</varname> is the repository tarball containing the base <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>.
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>.
</para> </para>
</callout> </callout>
<callout arearefs='ex-dockerTools-buildImage-4'> <callout arearefs='ex-dockerTools-buildImage-4'>
<para> <para>
<varname>fromImageName</varname> can be used to further specify the base <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.
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.
</para> </para>
</callout> </callout>
<callout arearefs='ex-dockerTools-buildImage-5'> <callout arearefs='ex-dockerTools-buildImage-5'>
<para> <para>
<varname>fromImageTag</varname> can be used to further specify the tag of <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.
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.
</para> </para>
</callout> </callout>
<callout arearefs='ex-dockerTools-buildImage-6'> <callout arearefs='ex-dockerTools-buildImage-6'>
<para> <para>
<varname>contents</varname> is a derivation that will be copied in the new <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>.
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>.
</para> </para>
</callout> </callout>
<callout arearefs='ex-dockerTools-buildImage-runAsRoot'> <callout arearefs='ex-dockerTools-buildImage-runAsRoot'>
<para> <para>
<varname>runAsRoot</varname> is a bash script that will run as root in an <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>.
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>.
<note> <note>
<para> <para>
Using this parameter requires the <literal>kvm</literal> device to be Using this parameter requires the <literal>kvm</literal> device to be available.
available.
</para> </para>
</note> </note>
</para> </para>
</callout> </callout>
<callout arearefs='ex-dockerTools-buildImage-8'> <callout arearefs='ex-dockerTools-buildImage-8'>
<para> <para>
<varname>config</varname> is used to specify the configuration of the <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>.
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>.
</para> </para>
</callout> </callout>
</calloutlist> </calloutlist>
<para> <para>
After the new layer has been created, its closure (to which 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.
<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.
</para> </para>
<para> <para>
At the end of the process, only one new single layer will be produced and At the end of the process, only one new single layer will be produced and added to the resulting image.
added to the resulting image.
</para> </para>
<para> <para>
The resulting repository will only list the single image 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>.
<varname>image/tag</varname>. In the case of
<xref linkend='ex-dockerTools-buildImage'/> it would be
<varname>redis/latest</varname>.
</para> </para>
<para> <para>
It is possible to inspect the arguments with which an image was built using It is possible to inspect the arguments with which an image was built using its <varname>buildArgs</varname> attribute.
its <varname>buildArgs</varname> attribute.
</para> </para>
<note> <note>
<para> <para>
If you see errors similar to <literal>getProtocolByName: does not exist (no 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>.
such protocol name: tcp)</literal> you may need to add
<literal>pkgs.iana-etc</literal> to <varname>contents</varname>.
</para> </para>
</note> </note>
<note> <note>
<para> <para>
If you see errors similar to <literal>Error_Protocol ("certificate has 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>.
unknown CA",True,UnknownCa)</literal> you may need to add
<literal>pkgs.cacert</literal> to <varname>contents</varname>.
</para> </para>
</note> </note>
<example xml:id="example-pkgs-dockerTools-buildImage-creation-date"> <example xml:id="example-pkgs-dockerTools-buildImage-creation-date">
<title>Impurely Defining a Docker Layer's Creation Date</title> <title>Impurely Defining a Docker Layer's Creation Date</title>
<para> <para>
By default <function>buildImage</function> will use a static date of one 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:
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:
</para> </para>
<screen><![CDATA[ <screen><![CDATA[
$ docker images $ docker images
@ -199,9 +144,7 @@ REPOSITORY TAG IMAGE ID CREATED SIZE
hello latest 08c791c7846e 48 years ago 25.2MB hello latest 08c791c7846e 48 years ago 25.2MB
]]></screen> ]]></screen>
<para> <para>
You can break binary reproducibility but have a sorted, meaningful You can break binary reproducibility but have a sorted, meaningful <literal>CREATED</literal> column by setting <literal>created</literal> to <literal>now</literal>.
<literal>CREATED</literal> column by setting <literal>created</literal> to
<literal>now</literal>.
</para> </para>
<programlisting><![CDATA[ <programlisting><![CDATA[
pkgs.dockerTools.buildImage { pkgs.dockerTools.buildImage {
@ -214,8 +157,7 @@ pkgs.dockerTools.buildImage {
} }
]]></programlisting> ]]></programlisting>
<para> <para>
and now the Docker CLI will display a reasonable date and sort the images and now the Docker CLI will display a reasonable date and sort the images as expected:
as expected:
<screen><![CDATA[ <screen><![CDATA[
$ docker images $ docker images
REPOSITORY TAG IMAGE ID CREATED SIZE REPOSITORY TAG IMAGE ID CREATED SIZE
@ -230,8 +172,7 @@ hello latest de2bf4786de6 About a minute ago 25.2MB
<title>buildLayeredImage</title> <title>buildLayeredImage</title>
<para> <para>
Create a Docker image with many of the store paths being on their own layer Create a Docker image with many of the store paths being on their own layer to improve sharing between images.
to improve sharing between images.
</para> </para>
<variablelist> <variablelist>
@ -264,8 +205,7 @@ hello latest de2bf4786de6 About a minute ago 25.2MB
</term> </term>
<listitem> <listitem>
<para> <para>
Top level paths in the container. Either a single derivation, or a list Top level paths in the container. Either a single derivation, or a list of derivations.
of derivations.
</para> </para>
<para> <para>
<emphasis>Default:</emphasis> <literal>[]</literal> <emphasis>Default:</emphasis> <literal>[]</literal>
@ -278,10 +218,7 @@ hello latest de2bf4786de6 About a minute ago 25.2MB
</term> </term>
<listitem> <listitem>
<para> <para>
Run-time configuration of the container. A full list of the options are 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>.
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>.
</para> </para>
<para> <para>
<emphasis>Default:</emphasis> <literal>{}</literal> <emphasis>Default:</emphasis> <literal>{}</literal>
@ -294,9 +231,7 @@ hello latest de2bf4786de6 About a minute ago 25.2MB
</term> </term>
<listitem> <listitem>
<para> <para>
Date and time the layers were created. Follows the same Date and time the layers were created. Follows the same <literal>now</literal> exception supported by <literal>buildImage</literal>.
<literal>now</literal> exception supported by
<literal>buildImage</literal>.
</para> </para>
<para> <para>
<emphasis>Default:</emphasis> <literal>1970-01-01T00:00:01Z</literal> <emphasis>Default:</emphasis> <literal>1970-01-01T00:00:01Z</literal>
@ -325,9 +260,7 @@ hello latest de2bf4786de6 About a minute ago 25.2MB
</term> </term>
<listitem> <listitem>
<para> <para>
Shell commands to run while building the final layer, without access to 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.
most of the layer contents. Changes to this layer are "on top" of all the
other layers, so can create additional directories and files.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -337,8 +270,7 @@ hello latest de2bf4786de6 About a minute ago 25.2MB
<title>Behavior of <varname>contents</varname> in the final image</title> <title>Behavior of <varname>contents</varname> in the final image</title>
<para> <para>
Each path directly listed in <varname>contents</varname> will have a Each path directly listed in <varname>contents</varname> will have a symlink in the root of the image.
symlink in the root of the image.
</para> </para>
<para> <para>
@ -349,8 +281,7 @@ pkgs.dockerTools.buildLayeredImage {
contents = [ pkgs.hello ]; contents = [ pkgs.hello ];
} }
]]></programlisting> ]]></programlisting>
will create symlinks for all the paths in the <literal>hello</literal> will create symlinks for all the paths in the <literal>hello</literal> package:
package:
<screen><![CDATA[ <screen><![CDATA[
/bin/hello -> /nix/store/h1zb1padqbbb7jicsvkmrym3r6snphxg-hello-2.10/bin/hello /bin/hello -> /nix/store/h1zb1padqbbb7jicsvkmrym3r6snphxg-hello-2.10/bin/hello
/share/info/hello.info -> /nix/store/h1zb1padqbbb7jicsvkmrym3r6snphxg-hello-2.10/share/info/hello.info /share/info/hello.info -> /nix/store/h1zb1padqbbb7jicsvkmrym3r6snphxg-hello-2.10/share/info/hello.info
@ -363,13 +294,11 @@ pkgs.dockerTools.buildLayeredImage {
<title>Automatic inclusion of <varname>config</varname> references</title> <title>Automatic inclusion of <varname>config</varname> references</title>
<para> <para>
The closure of <varname>config</varname> is automatically included in the The closure of <varname>config</varname> is automatically included in the closure of the final image.
closure of the final image.
</para> </para>
<para> <para>
This allows you to make very simple Docker images with very little code. This allows you to make very simple Docker images with very little code. This container will start up and run <command>hello</command>:
This container will start up and run <command>hello</command>:
<programlisting><![CDATA[ <programlisting><![CDATA[
pkgs.dockerTools.buildLayeredImage { pkgs.dockerTools.buildLayeredImage {
name = "hello"; name = "hello";
@ -383,31 +312,23 @@ pkgs.dockerTools.buildLayeredImage {
<title>Adjusting <varname>maxLayers</varname></title> <title>Adjusting <varname>maxLayers</varname></title>
<para> <para>
Increasing the <varname>maxLayers</varname> increases the number of layers Increasing the <varname>maxLayers</varname> increases the number of layers which have a chance to be shared between different images.
which have a chance to be shared between different images.
</para> </para>
<para> <para>
Modern Docker installations support up to 128 layers, however older Modern Docker installations support up to 128 layers, however older versions support as few as 42.
versions support as few as 42.
</para> </para>
<para> <para>
If the produced image will not be extended by other Docker builds, it is 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.
safe to set <varname>maxLayers</varname> to <literal>128</literal>. However
it will be impossible to extend the image further.
</para> </para>
<para> <para>
The first (<literal>maxLayers-2</literal>) most "popular" paths will have 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.
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.
</para> </para>
<para> <para>
Docker's Layers are not inherently ordered, they are content-addressable Docker's Layers are not inherently ordered, they are content-addressable and are not explicitly layered until they are composed in to an Image.
and are not explicitly layered until they are composed in to an Image.
</para> </para>
</section> </section>
</section> </section>
@ -416,10 +337,7 @@ pkgs.dockerTools.buildLayeredImage {
<title>pullImage</title> <title>pullImage</title>
<para> <para>
This function is analogous to the <command>docker pull</command> command, in 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.
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.
</para> </para>
<para> <para>
@ -444,71 +362,51 @@ pullImage {
<calloutlist> <calloutlist>
<callout arearefs='ex-dockerTools-pullImage-1'> <callout arearefs='ex-dockerTools-pullImage-1'>
<para> <para>
<varname>imageName</varname> specifies the name of the image to be <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.
downloaded, which can also include the registry namespace (e.g.
<literal>nixos</literal>). This argument is required.
</para> </para>
</callout> </callout>
<callout arearefs='ex-dockerTools-pullImage-2'> <callout arearefs='ex-dockerTools-pullImage-2'>
<para> <para>
<varname>imageDigest</varname> specifies the digest of the image to be <varname>imageDigest</varname> specifies the digest of the image to be downloaded. This argument is required.
downloaded. This argument is required.
</para> </para>
</callout> </callout>
<callout arearefs='ex-dockerTools-pullImage-3'> <callout arearefs='ex-dockerTools-pullImage-3'>
<para> <para>
<varname>finalImageName</varname>, if specified, this is the name of the <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>.
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>.
</para> </para>
</callout> </callout>
<callout arearefs='ex-dockerTools-pullImage-4'> <callout arearefs='ex-dockerTools-pullImage-4'>
<para> <para>
<varname>finalImageTag</varname>, if specified, this is the tag of the <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>.
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>.
</para> </para>
</callout> </callout>
<callout arearefs='ex-dockerTools-pullImage-5'> <callout arearefs='ex-dockerTools-pullImage-5'>
<para> <para>
<varname>sha256</varname> is the checksum of the whole fetched image. This <varname>sha256</varname> is the checksum of the whole fetched image. This argument is required.
argument is required.
</para> </para>
</callout> </callout>
<callout arearefs='ex-dockerTools-pullImage-6'> <callout arearefs='ex-dockerTools-pullImage-6'>
<para> <para>
<varname>os</varname>, if specified, is the operating system of the <varname>os</varname>, if specified, is the operating system of the fetched image. By default it's <literal>linux</literal>.
fetched image. By default it's <literal>linux</literal>.
</para> </para>
</callout> </callout>
<callout arearefs='ex-dockerTools-pullImage-7'> <callout arearefs='ex-dockerTools-pullImage-7'>
<para> <para>
<varname>arch</varname>, if specified, is the cpu architecture of the <varname>arch</varname>, if specified, is the cpu architecture of the fetched image. By default it's <literal>x86_64</literal>.
fetched image. By default it's <literal>x86_64</literal>.
</para> </para>
</callout> </callout>
</calloutlist> </calloutlist>
<para> <para>
<literal>nix-prefetch-docker</literal> command can be used to get required <literal>nix-prefetch-docker</literal> command can be used to get required image parameters:
image parameters:
<screen> <screen>
<prompt>$ </prompt>nix run nixpkgs.nix-prefetch-docker -c nix-prefetch-docker --image-name mysql --image-tag 5 <prompt>$ </prompt>nix run nixpkgs.nix-prefetch-docker -c nix-prefetch-docker --image-name mysql --image-tag 5
</screen> </screen>
Since a given <varname>imageName</varname> may transparently refer to a 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.
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.
<screen> <screen>
<prompt>$ </prompt>nix-prefetch-docker --image-name mysql --image-tag 5 --arch x86_64 --os linux <prompt>$ </prompt>nix-prefetch-docker --image-name mysql --image-tag 5 --arch x86_64 --os linux
</screen> </screen>
Desired image name and tag can be set using Desired image name and tag can be set using <option>--final-image-name</option> and <option>--final-image-tag</option> arguments:
<option>--final-image-name</option> and <option>--final-image-tag</option>
arguments:
<screen> <screen>
<prompt>$ </prompt>nix-prefetch-docker --image-name mysql --image-tag 5 --final-image-name eu.gcr.io/my-project/mysql --final-image-tag prod <prompt>$ </prompt>nix-prefetch-docker --image-name mysql --image-tag 5 --final-image-name eu.gcr.io/my-project/mysql --final-image-tag prod
</screen> </screen>
@ -519,17 +417,12 @@ pullImage {
<title>exportImage</title> <title>exportImage</title>
<para> <para>
This function is analogous to the <command>docker export</command> command, 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>.
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>.
</para> </para>
<note> <note>
<para> <para>
Using this function requires the <literal>kvm</literal> device to be Using this function requires the <literal>kvm</literal> device to be available.
available.
</para> </para>
</note> </note>
@ -551,14 +444,11 @@ exportImage {
</example> </example>
<para> <para>
The parameters relative to the base image have the same synopsis as 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.
described in <xref linkend='ssec-pkgs-dockerTools-buildImage'/>, except that
<varname>fromImage</varname> is the only required argument in this case.
</para> </para>
<para> <para>
The <varname>name</varname> argument is the name of the derivation output, The <varname>name</varname> argument is the name of the derivation output, which defaults to <varname>fromImage.name</varname>.
which defaults to <varname>fromImage.name</varname>.
</para> </para>
</section> </section>
@ -566,11 +456,7 @@ exportImage {
<title>shadowSetup</title> <title>shadowSetup</title>
<para> <para>
This constant string is a helper for setting up the base files for managing 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:
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:
</para> </para>
<example xml:id='ex-dockerTools-shadowSetup'> <example xml:id='ex-dockerTools-shadowSetup'>
@ -592,9 +478,7 @@ buildImage {
</example> </example>
<para> <para>
Creating base files like <literal>/etc/passwd</literal> or Creating base files like <literal>/etc/passwd</literal> or <literal>/etc/login.defs</literal> is necessary for shadow-utils to manipulate users and groups.
<literal>/etc/login.defs</literal> is necessary for shadow-utils to
manipulate users and groups.
</para> </para>
</section> </section>
</section> </section>

78
doc/functions/fetchers.xml
View File

@ -5,18 +5,11 @@
<title>Fetcher functions</title> <title>Fetcher functions</title>
<para> <para>
When using Nix, you will frequently need to download source code and other 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.
files from the internet. Nixpkgs comes with a few helper functions that allow
you to fetch fixed-output derivations in a structured way.
</para> </para>
<para> <para>
The two fetcher primitives are <function>fetchurl</function> and The two fetcher primitives are <function>fetchurl</function> and <function>fetchzip</function>. Both of these have two required arguments, a URL and a hash. The hash is typically <literal>sha256</literal>, although many more hash algorithms are supported. Nixpkgs contributors are currently recommended to use <literal>sha256</literal>. This hash will be used by Nix to identify your source. A typical usage of fetchurl is provided below.
<function>fetchzip</function>. Both of these have two required arguments, a
URL and a hash. The hash is typically <literal>sha256</literal>, although
many more hash algorithms are supported. Nixpkgs contributors are currently
recommended to use <literal>sha256</literal>. This hash will be used by Nix
to identify your source. A typical usage of fetchurl is provided below.
</para> </para>
<programlisting><![CDATA[ <programlisting><![CDATA[
@ -32,30 +25,15 @@ stdenv.mkDerivation {
]]></programlisting> ]]></programlisting>
<para> <para>
The main difference between <function>fetchurl</function> and The main difference between <function>fetchurl</function> and <function>fetchzip</function> is in how they store the contents. <function>fetchurl</function> will store the unaltered contents of the URL within the Nix store. <function>fetchzip</function> on the other hand will decompress the archive for you, making files and directories directly accessible in the future. <function>fetchzip</function> can only be used with archives. Despite the name, <function>fetchzip</function> is not limited to .zip files and can also be used with any tarball.
<function>fetchzip</function> is in how they store the contents.
<function>fetchurl</function> will store the unaltered contents of the URL
within the Nix store. <function>fetchzip</function> on the other hand will
decompress the archive for you, making files and directories directly
accessible in the future. <function>fetchzip</function> can only be used with
archives. Despite the name, <function>fetchzip</function> is not limited to
.zip files and can also be used with any tarball.
</para> </para>
<para> <para>
<function>fetchpatch</function> works very similarly to <function>fetchpatch</function> works very similarly to <function>fetchurl</function> 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.
<function>fetchurl</function> 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.
</para> </para>
<para> <para>
Other fetcher functions allow you to add source code directly from a VCS such Other fetcher functions allow you to add source code directly from a VCS such as subversion or git. These are mostly straightforward names based on the name of the command used with the VCS system. Because they give you a working repository, they act most like <function>fetchzip</function>.
as subversion or git. These are mostly straightforward names based on the
name of the command used with the VCS system. Because they give you a working
repository, they act most like <function>fetchzip</function>.
</para> </para>
<variablelist> <variablelist>
@ -65,8 +43,7 @@ stdenv.mkDerivation {
</term> </term>
<listitem> <listitem>
<para> <para>
Used with Subversion. Expects <literal>url</literal> to a Subversion Used with Subversion. Expects <literal>url</literal> to a Subversion directory, <literal>rev</literal>, and <literal>sha256</literal>.
directory, <literal>rev</literal>, and <literal>sha256</literal>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -76,10 +53,7 @@ stdenv.mkDerivation {
</term> </term>
<listitem> <listitem>
<para> <para>
Used with Git. Expects <literal>url</literal> to a Git repo, Used with Git. Expects <literal>url</literal> to a Git repo, <literal>rev</literal>, and <literal>sha256</literal>. <literal>rev</literal> in this case can be full the git commit id (SHA1 hash) or a tag name like <literal>refs/tags/v1.0</literal>.
<literal>rev</literal>, and <literal>sha256</literal>.
<literal>rev</literal> in this case can be full the git commit id (SHA1
hash) or a tag name like <literal>refs/tags/v1.0</literal>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -89,8 +63,7 @@ stdenv.mkDerivation {
</term> </term>
<listitem> <listitem>
<para> <para>
Used with Fossil. Expects <literal>url</literal> to a Fossil archive, Used with Fossil. Expects <literal>url</literal> to a Fossil archive, <literal>rev</literal>, and <literal>sha256</literal>.
<literal>rev</literal>, and <literal>sha256</literal>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -100,8 +73,7 @@ stdenv.mkDerivation {
</term> </term>
<listitem> <listitem>
<para> <para>
Used with CVS. Expects <literal>cvsRoot</literal>, <literal>tag</literal>, Used with CVS. Expects <literal>cvsRoot</literal>, <literal>tag</literal>, and <literal>sha256</literal>.
and <literal>sha256</literal>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -111,18 +83,14 @@ stdenv.mkDerivation {
</term> </term>
<listitem> <listitem>
<para> <para>
Used with Mercurial. Expects <literal>url</literal>, Used with Mercurial. Expects <literal>url</literal>, <literal>rev</literal>, and <literal>sha256</literal>.
<literal>rev</literal>, and <literal>sha256</literal>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
<para> <para>
A number of fetcher functions wrap part of <function>fetchurl</function> and A number of fetcher functions wrap part of <function>fetchurl</function> and <function>fetchzip</function>. They are mainly convenience functions intended for commonly used destinations of source code in Nixpkgs. These wrapper fetchers are listed below.
<function>fetchzip</function>. They are mainly convenience functions intended
for commonly used destinations of source code in Nixpkgs. These wrapper
fetchers are listed below.
</para> </para>
<variablelist> <variablelist>
@ -132,17 +100,7 @@ stdenv.mkDerivation {
</term> </term>
<listitem> <listitem>
<para> <para>
<function>fetchFromGitHub</function> expects four arguments. <function>fetchFromGitHub</function> expects four arguments. <literal>owner</literal> is a string corresponding to the GitHub user or organization that controls this repository. <literal>repo</literal> corresponds to the name of the software repository. These are located at the top of every GitHub HTML page as <literal>owner</literal>/<literal>repo</literal>. <literal>rev</literal> corresponds to the Git commit hash or tag (e.g <literal>v1.0</literal>) that will be downloaded from Git. Finally, <literal>sha256</literal> corresponds to the hash of the extracted directory. Again, other hash algorithms are also available but <literal>sha256</literal> is currently preferred.
<literal>owner</literal> is a string corresponding to the GitHub user or
organization that controls this repository. <literal>repo</literal>
corresponds to the name of the software repository. These are located at
the top of every GitHub HTML page as
<literal>owner</literal>/<literal>repo</literal>. <literal>rev</literal>
corresponds to the Git commit hash or tag (e.g <literal>v1.0</literal>)
that will be downloaded from Git. Finally, <literal>sha256</literal>
corresponds to the hash of the extracted directory. Again, other hash
algorithms are also available but <literal>sha256</literal> is currently
preferred.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -152,8 +110,7 @@ stdenv.mkDerivation {
</term> </term>
<listitem> <listitem>
<para> <para>
This is used with GitLab repositories. The arguments expected are very This is used with GitLab repositories. The arguments expected are very similar to fetchFromGitHub above.
similar to fetchFromGitHub above.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -163,8 +120,7 @@ stdenv.mkDerivation {
</term> </term>
<listitem> <listitem>
<para> <para>
This is used with BitBucket repositories. The arguments expected are very This is used with BitBucket repositories. The arguments expected are very similar to fetchFromGitHub above.
similar to fetchFromGitHub above.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -174,8 +130,7 @@ stdenv.mkDerivation {
</term> </term>
<listitem> <listitem>
<para> <para>
This is used with Savannah repositories. The arguments expected are very This is used with Savannah repositories. The arguments expected are very similar to fetchFromGitHub above.
similar to fetchFromGitHub above.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -185,8 +140,7 @@ stdenv.mkDerivation {
</term> </term>
<listitem> <listitem>
<para> <para>
This is used with repo.or.cz repositories. The arguments expected are very This is used with repo.or.cz repositories. The arguments expected are very similar to fetchFromGitHub above.
similar to fetchFromGitHub above.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>

38
doc/functions/fhs-environments.xml
View File

@ -5,15 +5,7 @@
<title>buildFHSUserEnv</title> <title>buildFHSUserEnv</title>
<para> <para>
<function>buildFHSUserEnv</function> provides a way to build and run <function>buildFHSUserEnv</function> provides a way to build and run FHS-compatible lightweight sandboxes. It creates an isolated root with bound <filename>/nix/store</filename>, so its footprint in terms of disk space needed is quite small. This allows one to run software which is hard or unfeasible to patch for NixOS -- 3rd-party source trees with FHS assumptions, games distributed as tarballs, software with integrity checking and/or external self-updated binaries. It uses Linux namespaces feature to create temporary lightweight environments which are destroyed after all child processes exit, without root user rights requirement. Accepted arguments are:
FHS-compatible lightweight sandboxes. It creates an isolated root with bound
<filename>/nix/store</filename>, so its footprint in terms of disk space
needed is quite small. This allows one to run software which is hard or
unfeasible to patch for NixOS -- 3rd-party source trees with FHS assumptions,
games distributed as tarballs, software with integrity checking and/or
external self-updated binaries. It uses Linux namespaces feature to create
temporary lightweight environments which are destroyed after all child
processes exit, without root user rights requirement. Accepted arguments are:
</para> </para>
<variablelist> <variablelist>
@ -33,8 +25,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
Packages to be installed for the main host's architecture (i.e. x86_64 on Packages to be installed for the main host's architecture (i.e. x86_64 on x86_64 installations). Along with libraries binaries are also installed.
x86_64 installations). Along with libraries binaries are also installed.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -44,9 +35,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
Packages to be installed for all architectures supported by a host (i.e. Packages to be installed for all architectures supported by a host (i.e. i686 and x86_64 on x86_64 installations). Only libraries are installed by default.
i686 and x86_64 on x86_64 installations). Only libraries are installed by
default.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -66,8 +55,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
Like <literal>extraBuildCommands</literal>, but executed only on multilib Like <literal>extraBuildCommands</literal>, but executed only on multilib architectures.
architectures.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -77,8 +65,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
Additional derivation outputs to be linked for both target and Additional derivation outputs to be linked for both target and multi-architecture packages.
multi-architecture packages.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -88,8 +75,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
Additional commands to be executed for finalizing the derivation with Additional commands to be executed for finalizing the derivation with runner script.
runner script.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -99,16 +85,14 @@
</term> </term>
<listitem> <listitem>
<para> <para>
A command that would be executed inside the sandbox and passed all the A command that would be executed inside the sandbox and passed all the command line arguments. It defaults to <literal>bash</literal>.
command line arguments. It defaults to <literal>bash</literal>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
<para> <para>
One can create a simple environment using a <literal>shell.nix</literal> like One can create a simple environment using a <literal>shell.nix</literal> like that:
that:
</para> </para>
<programlisting><![CDATA[ <programlisting><![CDATA[
@ -133,10 +117,6 @@
]]></programlisting> ]]></programlisting>
<para> <para>
Running <literal>nix-shell</literal> would then drop you into a shell with Running <literal>nix-shell</literal> 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 <literal>runScript</literal> to the application path, e.g. <filename>./bin/start.sh</filename> -- relative paths are supported.
these libraries and binaries available. You can use this to run closed-source
applications which expect FHS structure without hassles: simply change
<literal>runScript</literal> to the application path, e.g.
<filename>./bin/start.sh</filename> -- relative paths are supported.
</para> </para>
</section> </section>

25
doc/functions/generators.xml
View File

@ -5,28 +5,15 @@
<title>Generators</title> <title>Generators</title>
<para> <para>
Generators are functions that create file formats from nix data structures, 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>
e. g. for configuration files. There are generators available for:
<literal>INI</literal>, <literal>JSON</literal> and <literal>YAML</literal>
</para> </para>
<para> <para>
All generators follow a similar call interface: <code>generatorName 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.
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.
</para> </para>
<para> <para>
Generators can be fine-tuned to produce exactly the file format required by 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:
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:
</para> </para>
<programlisting> <programlisting>
@ -77,13 +64,11 @@ merge:"diff3"
<note> <note>
<para> <para>
Nix store paths can be converted to strings by enclosing a derivation Nix store paths can be converted to strings by enclosing a derivation attribute like so: <code>"${drv}"</code>.
attribute like so: <code>"${drv}"</code>.
</para> </para>
</note> </note>
<para> <para>
Detailed documentation for each generator can be found in Detailed documentation for each generator can be found in <literal>lib/generators.nix</literal>.
<literal>lib/generators.nix</literal>.
</para> </para>
</section> </section>

3
doc/functions/library.xml
View File

@ -5,8 +5,7 @@
<title>Nixpkgs Library Functions</title> <title>Nixpkgs Library Functions</title>
<para> <para>
Nixpkgs provides a standard library at <varname>pkgs.lib</varname>, or Nixpkgs provides a standard library at <varname>pkgs.lib</varname>, or through <code>import &lt;nixpkgs/lib&gt;</code>.
through <code>import &lt;nixpkgs/lib&gt;</code>.
</para> </para>
<xi:include href="./library/asserts.xml" /> <xi:include href="./library/asserts.xml" />

13
doc/functions/library/asserts.xml
View File

@ -27,8 +27,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
Condition under which the <varname>msg</varname> should Condition under which the <varname>msg</varname> should <emphasis>not</emphasis> be printed.
<emphasis>not</emphasis> be printed.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -64,9 +63,7 @@ stderr> assert failed
<xi:include href="./locations.xml" xpointer="lib.asserts.assertOneOf" /> <xi:include href="./locations.xml" xpointer="lib.asserts.assertOneOf" />
<para> <para>
Specialized <function>asserts.assertMsg</function> for checking if Specialized <function>asserts.assertMsg</function> for checking if <varname>val</varname> is one of the elements of <varname>xs</varname>. Useful for checking enums.
<varname>val</varname> is one of the elements of <varname>xs</varname>.
Useful for checking enums.
</para> </para>
<variablelist> <variablelist>
@ -76,8 +73,7 @@ stderr> assert failed
</term> </term>
<listitem> <listitem>
<para> <para>
The name of the variable the user entered <varname>val</varname> into, The name of the variable the user entered <varname>val</varname> into, for inclusion in the error message.
for inclusion in the error message.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -87,8 +83,7 @@ stderr> assert failed
</term> </term>
<listitem> <listitem>
<para> <para>
The value of what the user provided, to be compared against the values in The value of what the user provided, to be compared against the values in <varname>xs</varname>.
<varname>xs</varname>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>

145
doc/functions/library/attrsets.xml
View File

@ -23,8 +23,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
A list of strings representing the path through the nested attribute set A list of strings representing the path through the nested attribute set <varname>set</varname>.
<varname>set</varname>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -34,8 +33,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
Default value if <varname>attrPath</varname> does not resolve to an Default value if <varname>attrPath</varname> does not resolve to an existing value.
existing value.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -88,8 +86,7 @@ lib.attrsets.attrByPath [ "a" "b" ] 0 {}
</term> </term>
<listitem> <listitem>
<para> <para>
A list of strings representing the path through the nested attribute set A list of strings representing the path through the nested attribute set <varname>set</varname>.
<varname>set</varname>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -125,8 +122,7 @@ lib.attrsets.hasAttrByPath
<xi:include href="./locations.xml" xpointer="lib.attrsets.setAttrByPath" /> <xi:include href="./locations.xml" xpointer="lib.attrsets.setAttrByPath" />
<para> <para>
Create a new attribute set with <varname>value</varname> set at the nested Create a new attribute set with <varname>value</varname> set at the nested attribute location specified in <varname>attrPath</varname>.
attribute location specified in <varname>attrPath</varname>.
</para> </para>
<variablelist> <variablelist>
@ -146,8 +142,7 @@ lib.attrsets.hasAttrByPath
</term> </term>
<listitem> <listitem>
<para> <para>
The value to set at the location described by The value to set at the location described by <varname>attrPath</varname>.
<varname>attrPath</varname>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -171,8 +166,7 @@ lib.attrsets.setAttrByPath [ "a" "b" ] 3
<xi:include href="./locations.xml" xpointer="lib.attrsets.getAttrFromPath" /> <xi:include href="./locations.xml" xpointer="lib.attrsets.getAttrFromPath" />
<para> <para>
Like <xref linkend="function-library-lib.attrsets.attrByPath" /> except Like <xref linkend="function-library-lib.attrsets.attrByPath" /> except without a default, and it will throw if the value doesn't exist.
without a default, and it will throw if the value doesn't exist.
</para> </para>
<variablelist> <variablelist>
@ -182,8 +176,7 @@ lib.attrsets.setAttrByPath [ "a" "b" ] 3
</term> </term>
<listitem> <listitem>
<para> <para>
A list of strings representing the path through the nested attribute set A list of strings representing the path through the nested attribute set <varname>set</varname>.
<varname>set</varname>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -235,8 +228,7 @@ lib.attrsets.getAttrFromPath [ "x" "y" ] { }
</term> </term>
<listitem> <listitem>
<para> <para>
The list of attributes to fetch from <varname>set</varname>. Each The list of attributes to fetch from <varname>set</varname>. Each attribute name must exist on the attrbitue set.
attribute name must exist on the attrbitue set.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -282,8 +274,7 @@ error: attribute 'd' missing
</para> </para>
<para> <para>
Provides a backwards-compatible interface of Provides a backwards-compatible interface of <function>builtins.attrValues</function> for Nix version older than 1.8.
<function>builtins.attrValues</function> for Nix version older than 1.8.
</para> </para>
<variablelist> <variablelist>
@ -317,14 +308,11 @@ lib.attrsets.attrValues { a = 1; b = 2; c = 3; }
<xi:include href="./locations.xml" xpointer="lib.attrsets.catAttrs" /> <xi:include href="./locations.xml" xpointer="lib.attrsets.catAttrs" />
<para> <para>
Collect each attribute named `attr' from the list of attribute sets, Collect each attribute named `attr' from the list of attribute sets, <varname>sets</varname>. Sets that don't contain the named attribute are ignored.
<varname>sets</varname>. Sets that don't contain the named attribute are
ignored.
</para> </para>
<para> <para>
Provides a backwards-compatible interface of Provides a backwards-compatible interface of <function>builtins.catAttrs</function> for Nix version older than 1.9.
<function>builtins.catAttrs</function> for Nix version older than 1.9.
</para> </para>
<variablelist> <variablelist>
@ -334,8 +322,7 @@ lib.attrsets.attrValues { a = 1; b = 2; c = 3; }
</term> </term>
<listitem> <listitem>
<para> <para>
Attribute name to select from each attribute set in Attribute name to select from each attribute set in <varname>sets</varname>.
<varname>sets</varname>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -372,8 +359,7 @@ catAttrs "a" [{a = 1;} {b = 0;} {a = 2;}]
<xi:include href="./locations.xml" xpointer="lib.attrsets.filterAttrs" /> <xi:include href="./locations.xml" xpointer="lib.attrsets.filterAttrs" />
<para> <para>
Filter an attribute set by removing all attributes for which the given Filter an attribute set by removing all attributes for which the given predicate return false.
predicate return false.
</para> </para>
<variablelist> <variablelist>
@ -386,8 +372,7 @@ catAttrs "a" [{a = 1;} {b = 0;} {a = 2;}]
<literal>String -> Any -> Bool</literal> <literal>String -> Any -> Bool</literal>
</para> </para>
<para> <para>
Predicate which returns true to include an attribute, or returns false to Predicate which returns true to include an attribute, or returns false to exclude it.
exclude it.
</para> </para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
@ -412,8 +397,7 @@ catAttrs "a" [{a = 1;} {b = 0;} {a = 2;}]
</varlistentry> </varlistentry>
</variablelist> </variablelist>
<para> <para>
Returns <literal>true</literal> to include the attribute, Returns <literal>true</literal> to include the attribute, <literal>false</literal> to exclude the attribute.
<literal>false</literal> to exclude the attribute.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -447,8 +431,7 @@ filterAttrs (n: v: n == "foo") { foo = 1; bar = 2; }
<xi:include href="./locations.xml" xpointer="lib.attrsets.filterAttrsRecursive" /> <xi:include href="./locations.xml" xpointer="lib.attrsets.filterAttrsRecursive" />
<para> <para>
Filter an attribute set recursively by removing all attributes for which the Filter an attribute set recursively by removing all attributes for which the given predicate return false.
given predicate return false.
</para> </para>
<variablelist> <variablelist>
@ -461,8 +444,7 @@ filterAttrs (n: v: n == "foo") { foo = 1; bar = 2; }
<literal>String -> Any -> Bool</literal> <literal>String -> Any -> Bool</literal>
</para> </para>
<para> <para>
Predicate which returns true to include an attribute, or returns false to Predicate which returns true to include an attribute, or returns false to exclude it.
exclude it.
</para> </para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
@ -487,8 +469,7 @@ filterAttrs (n: v: n == "foo") { foo = 1; bar = 2; }
</varlistentry> </varlistentry>
</variablelist> </variablelist>
<para> <para>
Returns <literal>true</literal> to include the attribute, Returns <literal>true</literal> to include the attribute, <literal>false</literal> to exclude the attribute.
<literal>false</literal> to exclude the attribute.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -557,8 +538,7 @@ lib.attrsets.filterAttrsRecursive
<literal>Any -> Any -> Any</literal> <literal>Any -> Any -> Any</literal>
</para> </para>
<para> <para>
Given a value <varname>val</varname> and a collector Given a value <varname>val</varname> and a collector <varname>col</varname>, combine the two.
<varname>col</varname>, combine the two.
</para> </para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
@ -578,8 +558,7 @@ lib.attrsets.filterAttrsRecursive
<listitem> <listitem>
<!-- TODO: make this not bad, use more fold-ey terms --> <!-- TODO: make this not bad, use more fold-ey terms -->
<para> <para>
The result of previous <function>op</function> calls with other values The result of previous <function>op</function> calls with other values and <function>nul</function>.
and <function>nul</function>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -632,9 +611,7 @@ lib.attrsets.foldAttrs
<xi:include href="./locations.xml" xpointer="lib.attrsets.collect" /> <xi:include href="./locations.xml" xpointer="lib.attrsets.collect" />
<para> <para>
Recursively collect sets that verify a given predicate named Recursively collect sets that verify a given predicate named <varname>pred</varname> from the set <varname>attrs</varname>. The recursion stops when <varname>pred</varname> returns <literal>true</literal>.
<varname>pred</varname> from the set <varname>attrs</varname>. The recursion
stops when <varname>pred</varname> returns <literal>true</literal>.
</para> </para>
<variablelist> <variablelist>
@ -702,8 +679,7 @@ collect (x: x ? outPath)
<xi:include href="./locations.xml" xpointer="lib.attrsets.nameValuePair" /> <xi:include href="./locations.xml" xpointer="lib.attrsets.nameValuePair" />
<para> <para>
Utility function that creates a <literal>{name, value}</literal> pair as Utility function that creates a <literal>{name, value}</literal> pair as expected by <function>builtins.listToAttrs</function>.
expected by <function>builtins.listToAttrs</function>.
</para> </para>
<variablelist> <variablelist>
@ -747,13 +723,11 @@ nameValuePair "some" 6
<xi:include href="./locations.xml" xpointer="lib.attrsets.mapAttrs" /> <xi:include href="./locations.xml" xpointer="lib.attrsets.mapAttrs" />
<para> <para>
Apply a function to each element in an attribute set, creating a new Apply a function to each element in an attribute set, creating a new attribute set.
attribute set.
</para> </para>
<para> <para>
Provides a backwards-compatible interface of Provides a backwards-compatible interface of <function>builtins.mapAttrs</function> for Nix version older than 2.1.
<function>builtins.mapAttrs</function> for Nix version older than 2.1.
</para> </para>
<variablelist> <variablelist>
@ -814,9 +788,7 @@ lib.attrsets.mapAttrs
<xi:include href="./locations.xml" xpointer="lib.attrsets.mapAttrs-prime" /> <xi:include href="./locations.xml" xpointer="lib.attrsets.mapAttrs-prime" />
<para> <para>
Like <function>mapAttrs</function>, but allows the name of each attribute to Like <function>mapAttrs</function>, but allows the name of each attribute to be changed in addition to the value. The applied function should return both the new name and value as a <function>nameValuePair</function>.
be changed in addition to the value. The applied function should return both
the new name and value as a <function>nameValuePair</function>.
</para> </para>
<variablelist> <variablelist>
@ -829,10 +801,8 @@ lib.attrsets.mapAttrs
<literal>String -> Any -> { name = String; value = Any }</literal> <literal>String -> Any -> { name = String; value = Any }</literal>
</para> </para>
<para> <para>
Given an attribute's name and value, return a new Given an attribute's name and value, return a new <link
<link linkend="function-library-lib.attrsets.nameValuePair">name value pair</link>.
linkend="function-library-lib.attrsets.nameValuePair">name
value pair</link>.
</para> </para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
@ -891,8 +861,7 @@ lib.attrsets.mapAttrs' (name: value: lib.attrsets.nameValuePair ("foo_" + name)
<xi:include href="./locations.xml" xpointer="lib.attrsets.mapAttrsToList" /> <xi:include href="./locations.xml" xpointer="lib.attrsets.mapAttrsToList" />
<para> <para>
Call <varname>fn</varname> for each attribute in the given Call <varname>fn</varname> for each attribute in the given <varname>set</varname> and return the result in a list.
<varname>set</varname> and return the result in a list.
</para> </para>
<variablelist> <variablelist>
@ -962,9 +931,7 @@ lib.attrsets.mapAttrsToList (name: value: "${name}=${value}")
<xi:include href="./locations.xml" xpointer="lib.attrsets.mapAttrsRecursive" /> <xi:include href="./locations.xml" xpointer="lib.attrsets.mapAttrsRecursive" />
<para> <para>
Like <function>mapAttrs</function>, except that it recursively applies Like <function>mapAttrs</function>, except that it recursively applies itself to attribute sets. Also, the first argument of the argument function is a <emphasis>list</emphasis> of the names of the containing attributes.
itself to attribute sets. Also, the first argument of the argument function
is a <emphasis>list</emphasis> of the names of the containing attributes.
</para> </para>
<variablelist> <variablelist>
@ -989,10 +956,7 @@ lib.attrsets.mapAttrsToList (name: value: "${name}=${value}")
The list of attribute names to this value. The list of attribute names to this value.
</para> </para>
<para> <para>
For example, the <varname>name_path</varname> for the For example, the <varname>name_path</varname> for the <literal>example</literal> string in the attribute set <literal>{ foo = { bar = "example"; }; }</literal> is <literal>[ "foo" "bar" ]</literal>.
<literal>example</literal> string in the attribute set <literal>{ foo
= { bar = "example"; }; }</literal> is <literal>[ "foo" "bar"
]</literal>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -1059,11 +1023,7 @@ mapAttrsRecursive
<xi:include href="./locations.xml" xpointer="lib.attrsets.mapAttrsRecursiveCond" /> <xi:include href="./locations.xml" xpointer="lib.attrsets.mapAttrsRecursiveCond" />
<para> <para>
Like <function>mapAttrsRecursive</function>, but it takes an additional Like <function>mapAttrsRecursive</function>, but it takes an additional predicate function that tells it whether to recursive into an attribute set. If it returns false, <function>mapAttrsRecursiveCond</function> does not recurse, but does apply the map function. It is returns true, it does recurse, and does not apply the map function.
predicate function that tells it whether to recursive into an attribute set.
If it returns false, <function>mapAttrsRecursiveCond</function> does not
recurse, but does apply the map function. It is returns true, it does
recurse, and does not apply the map function.
</para> </para>
<variablelist> <variablelist>
@ -1076,8 +1036,7 @@ mapAttrsRecursive
<literal>(AttrSet -> Bool)</literal> <literal>(AttrSet -> Bool)</literal>
</para> </para>
<para> <para>
Determine if <function>mapAttrsRecursive</function> should recurse deeper Determine if <function>mapAttrsRecursive</function> should recurse deeper in to the attribute set.
in to the attribute set.
</para> </para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
@ -1114,10 +1073,7 @@ mapAttrsRecursive
The list of attribute names to this value. The list of attribute names to this value.
</para> </para>
<para> <para>
For example, the <varname>name_path</varname> for the For example, the <varname>name_path</varname> for the <literal>example</literal> string in the attribute set <literal>{ foo = { bar = "example"; }; }</literal> is <literal>[ "foo" "bar" ]</literal>.
<literal>example</literal> string in the attribute set <literal>{ foo
= { bar = "example"; }; }</literal> is <literal>[ "foo" "bar"
]</literal>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -1181,8 +1137,7 @@ lib.attrsets.mapAttrsRecursiveCond
<xi:include href="./locations.xml" xpointer="lib.attrsets.genAttrs" /> <xi:include href="./locations.xml" xpointer="lib.attrsets.genAttrs" />
<para> <para>
Generate an attribute set by mapping a function over a list of attribute Generate an attribute set by mapping a function over a list of attribute names.
names.
</para> </para>
<variablelist> <variablelist>
@ -1241,8 +1196,7 @@ lib.attrsets.genAttrs [ "foo" "bar" ] (name: "x_${name}")
<xi:include href="./locations.xml" xpointer="lib.attrsets.isDerivation" /> <xi:include href="./locations.xml" xpointer="lib.attrsets.isDerivation" />
<para> <para>
Check whether the argument is a derivation. Any set with <code>{ type = Check whether the argument is a derivation. Any set with <code>{ type = "derivation"; }</code> counts as a derivation.
"derivation"; }</code> counts as a derivation.
</para> </para>
<variablelist> <variablelist>
@ -1320,8 +1274,7 @@ lib.attrsets.isDerivation "foobar"
</term> </term>
<listitem> <listitem>
<para> <para>
Condition under which the <varname>as</varname> attribute set is Condition under which the <varname>as</varname> attribute set is returned.
returned.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -1363,8 +1316,7 @@ lib.attrsets.optionalAttrs false { my = "set"; }
<xi:include href="./locations.xml" xpointer="lib.attrsets.zipAttrsWithNames" /> <xi:include href="./locations.xml" xpointer="lib.attrsets.zipAttrsWithNames" />
<para> <para>
Merge sets of attributes and use the function <varname>f</varname> to merge Merge sets of attributes and use the function <varname>f</varname> to merge attribute values where the attribute name is in <varname>names</varname>.
attribute values where the attribute name is in <varname>names</varname>.
</para> </para>
<variablelist> <variablelist>
@ -1451,11 +1403,8 @@ lib.attrsets.zipAttrsWithNames
<xi:include href="./locations.xml" xpointer="lib.attrsets.zipAttrsWith" /> <xi:include href="./locations.xml" xpointer="lib.attrsets.zipAttrsWith" />
<para> <para>
Merge sets of attributes and use the function <varname>f</varname> to merge Merge sets of attributes and use the function <varname>f</varname> to merge attribute values. Similar to <xref
attribute values. Similar to linkend="function-library-lib.attrsets.zipAttrsWithNames" /> where all key names are passed for <varname>names</varname>.
<xref
linkend="function-library-lib.attrsets.zipAttrsWithNames" /> where
all key names are passed for <varname>names</varname>.
</para> </para>
<variablelist> <variablelist>
@ -1531,9 +1480,7 @@ lib.attrsets.zipAttrsWith
<xi:include href="./locations.xml" xpointer="lib.attrsets.zipAttrs" /> <xi:include href="./locations.xml" xpointer="lib.attrsets.zipAttrs" />
<para> <para>
Merge sets of attributes and combine each attribute value in to a list. Merge sets of attributes and combine each attribute value in to a list. Similar to <xref linkend="function-library-lib.attrsets.zipAttrsWith" /> where the merge function returns a list of all values.
Similar to <xref linkend="function-library-lib.attrsets.zipAttrsWith" />
where the merge function returns a list of all values.
</para> </para>
<variablelist> <variablelist>
@ -1573,12 +1520,7 @@ lib.attrsets.zipAttrs
<xi:include href="./locations.xml" xpointer="lib.attrsets.recursiveUpdateUntil" /> <xi:include href="./locations.xml" xpointer="lib.attrsets.recursiveUpdateUntil" />
<para> <para>
Does the same as the update operator <literal>//</literal> except that Does the same as the update operator <literal>//</literal> except that attributes are merged until the given predicate is verified. The predicate should accept 3 arguments which are the path to reach the attribute, a part of the first attribute set and a part of the second attribute set. When the predicate is verified, the value of the first attribute set is replaced by the value of the second attribute set.
attributes are merged until the given predicate is verified. The predicate
should accept 3 arguments which are the path to reach the attribute, a part
of the first attribute set and a part of the second attribute set. When the
predicate is verified, the value of the first attribute set is replaced by
the value of the second attribute set.
</para> </para>
<variablelist> <variablelist>
@ -1681,10 +1623,7 @@ lib.attrsets.recursiveUpdateUntil (path: l: r: path == ["foo"])
<xi:include href="./locations.xml" xpointer="lib.attrsets.recursiveUpdate" /> <xi:include href="./locations.xml" xpointer="lib.attrsets.recursiveUpdate" />
<para> <para>
A recursive variant of the update operator <literal>//</literal>. The A recursive variant of the update operator <literal>//</literal>. The recursion stops when one of the attribute values is not an attribute set, in which case the right hand side value takes precedence over the left hand side value.
recursion stops when one of the attribute values is not an attribute set, in
which case the right hand side value takes precedence over the left hand
side value.
</para> </para>
<variablelist> <variablelist>

24
doc/functions/nix-gitignore.xml
View File

@ -5,21 +5,14 @@
<title>pkgs.nix-gitignore</title> <title>pkgs.nix-gitignore</title>
<para> <para>
<function>pkgs.nix-gitignore</function> is a function that acts similarly to <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.
<literal>builtins.filterSource</literal> but also allows filtering with the
help of the gitignore format.
</para> </para>
<section xml:id="sec-pkgs-nix-gitignore-usage"> <section xml:id="sec-pkgs-nix-gitignore-usage">
<title>Usage</title> <title>Usage</title>
<para> <para>
<literal>pkgs.nix-gitignore</literal> exports a number of functions, but <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.
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.
</para> </para>
<programlisting><![CDATA[ <programlisting><![CDATA[
@ -40,8 +33,7 @@
]]></programlisting> ]]></programlisting>
<para> <para>
These functions are derived from the <literal>Filter</literal> functions by These functions are derived from the <literal>Filter</literal> functions by setting the first filter argument to <literal>(_: _: true)</literal>:
setting the first filter argument to <literal>(_: _: true)</literal>:
</para> </para>
<programlisting><![CDATA[ <programlisting><![CDATA[
@ -50,12 +42,7 @@ gitignoreSource = gitignoreFilterSource (_: _: true);
]]></programlisting> ]]></programlisting>
<para> <para>
Those filter functions accept the same arguments the 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.
<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.
</para> </para>
<para> <para>
@ -71,8 +58,7 @@ gitignoreFilter = ign: root: filterPattern (gitignoreToPatterns ign) root;
<title>gitignore files in subdirectories</title> <title>gitignore files in subdirectories</title>
<para> <para>
If you wish to use a filter that would search for .gitignore files in If you wish to use a filter that would search for .gitignore files in subdirectories, just like git does by default, use this function:
subdirectories, just like git does by default, use this function:
</para> </para>
<programlisting><![CDATA[ <programlisting><![CDATA[

26
doc/functions/ocitools.xml
View File

@ -5,26 +5,18 @@
<title>pkgs.ociTools</title> <title>pkgs.ociTools</title>
<para> <para>
<varname>pkgs.ociTools</varname> is a set of functions for creating <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.
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.
</para> </para>
<section xml:id="ssec-pkgs-ociTools-buildContainer"> <section xml:id="ssec-pkgs-ociTools-buildContainer">
<title>buildContainer</title> <title>buildContainer</title>
<para> <para>
This function creates a simple OCI container that runs a single command 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.
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.
</para> </para>
<para> <para>
The parameters of <varname>buildContainer</varname> with an example value The parameters of <varname>buildContainer</varname> with an example value are described below:
are described below:
</para> </para>
<example xml:id='ex-ociTools-buildContainer'> <example xml:id='ex-ociTools-buildContainer'>
@ -51,23 +43,17 @@ buildContainer {
<calloutlist> <calloutlist>
<callout arearefs='ex-ociTools-buildContainer-1'> <callout arearefs='ex-ociTools-buildContainer-1'>
<para> <para>
<varname>args</varname> specifies a set of arguments to run inside the <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
container. This is the only required argument for
<varname>buildContainer</varname>. All referenced packages inside the
derivation will be made available inside the container
</para> </para>
</callout> </callout>
<callout arearefs='ex-ociTools-buildContainer-2'> <callout arearefs='ex-ociTools-buildContainer-2'>
<para> <para>
<varname>mounts</varname> specifies additional mount points chosen by the <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)
user. By default only a minimal set of necessary filesystems are mounted
into the container (e.g procfs, cgroupfs)
</para> </para>
</callout> </callout>
<callout arearefs='ex-ociTools-buildContainer-3'> <callout arearefs='ex-ociTools-buildContainer-3'>
<para> <para>
<varname>readonly</varname> makes the container's rootfs read-only if it <varname>readonly</varname> makes the container's rootfs read-only if it is set to true. The default value is false <literal>false</literal>.
is set to true. The default value is false <literal>false</literal>.
</para> </para>
</callout> </callout>
</calloutlist> </calloutlist>

95
doc/functions/overrides.xml
View File

@ -5,23 +5,18 @@
<title>Overriding</title> <title>Overriding</title>
<para> <para>
Sometimes one wants to override parts of <literal>nixpkgs</literal>, e.g. Sometimes one wants to override parts of <literal>nixpkgs</literal>, e.g. derivation attributes, the results of derivations.
derivation attributes, the results of derivations.
</para> </para>
<para> <para>
These functions are used to make changes to packages, returning only single These functions are used to make changes to packages, returning only single packages. <link xlink:href="#chap-overlays">Overlays</link>, on the other hand, can be used to combine the overridden packages across the entire package set of Nixpkgs.
packages. <link xlink:href="#chap-overlays">Overlays</link>, on the other
hand, can be used to combine the overridden packages across the entire
package set of Nixpkgs.
</para> </para>
<section xml:id="sec-pkg-override"> <section xml:id="sec-pkg-override">
<title>&lt;pkg&gt;.override</title> <title>&lt;pkg&gt;.override</title>
<para> <para>
The function <varname>override</varname> is usually available for all the The function <varname>override</varname> is usually available for all the derivations in the nixpkgs expression (<varname>pkgs</varname>).
derivations in the nixpkgs expression (<varname>pkgs</varname>).
</para> </para>
<para> <para>
@ -47,10 +42,7 @@ mypkg = pkgs.callPackage ./mypkg.nix {
</para> </para>
<para> <para>
In the first example, <varname>pkgs.foo</varname> is the result of a In the first example, <varname>pkgs.foo</varname> is the result of a function call with some default arguments, usually a derivation. Using <varname>pkgs.foo.override</varname> will call the same function with the given new arguments.
function call with some default arguments, usually a derivation. Using
<varname>pkgs.foo.override</varname> will call the same function with the
given new arguments.
</para> </para>
</section> </section>
@ -58,12 +50,7 @@ mypkg = pkgs.callPackage ./mypkg.nix {
<title>&lt;pkg&gt;.overrideAttrs</title> <title>&lt;pkg&gt;.overrideAttrs</title>
<para> <para>
The function <varname>overrideAttrs</varname> allows overriding the The function <varname>overrideAttrs</varname> allows overriding the attribute set passed to a <varname>stdenv.mkDerivation</varname> call, producing a new derivation based on the original one. This function is available on all derivations produced by the <varname>stdenv.mkDerivation</varname> function, which is most packages in the nixpkgs expression <varname>pkgs</varname>.
attribute set passed to a <varname>stdenv.mkDerivation</varname> call,
producing a new derivation based on the original one. This function is
available on all derivations produced by the
<varname>stdenv.mkDerivation</varname> function, which is most packages in
the nixpkgs expression <varname>pkgs</varname>.
</para> </para>
<para> <para>
@ -76,30 +63,16 @@ helloWithDebug = pkgs.hello.overrideAttrs (oldAttrs: rec {
</para> </para>
<para> <para>
In the above example, the <varname>separateDebugInfo</varname> attribute is In the above example, the <varname>separateDebugInfo</varname> attribute is overridden to be true, thus building debug info for <varname>helloWithDebug</varname>, while all other attributes will be retained from the original <varname>hello</varname> package.
overridden to be true, thus building debug info for
<varname>helloWithDebug</varname>, while all other attributes will be
retained from the original <varname>hello</varname> package.
</para> </para>
<para> <para>
The argument <varname>oldAttrs</varname> is conventionally used to refer to The argument <varname>oldAttrs</varname> is conventionally used to refer to the attr set originally passed to <varname>stdenv.mkDerivation</varname>.
the attr set originally passed to <varname>stdenv.mkDerivation</varname>.
</para> </para>
<note> <note>
<para> <para>
Note that <varname>separateDebugInfo</varname> is processed only by the Note that <varname>separateDebugInfo</varname> is processed only by the <varname>stdenv.mkDerivation</varname> function, not the generated, raw Nix derivation. Thus, using <varname>overrideDerivation</varname> will not work in this case, as it overrides only the attributes of the final derivation. It is for this reason that <varname>overrideAttrs</varname> should be preferred in (almost) all cases to <varname>overrideDerivation</varname>, i.e. to allow using <varname>stdenv.mkDerivation</varname> to process input arguments, as well as the fact that it is easier to use (you can use the same attribute names you see in your Nix code, instead of the ones generated (e.g. <varname>buildInputs</varname> vs <varname>nativeBuildInputs</varname>), and it involves less typing).
<varname>stdenv.mkDerivation</varname> function, not the generated, raw Nix
derivation. Thus, using <varname>overrideDerivation</varname> will not work
in this case, as it overrides only the attributes of the final derivation.
It is for this reason that <varname>overrideAttrs</varname> should be
preferred in (almost) all cases to <varname>overrideDerivation</varname>,
i.e. to allow using <varname>stdenv.mkDerivation</varname> to process input
arguments, as well as the fact that it is easier to use (you can use the
same attribute names you see in your Nix code, instead of the ones
generated (e.g. <varname>buildInputs</varname> vs
<varname>nativeBuildInputs</varname>), and it involves less typing).
</para> </para>
</note> </note>
</section> </section>
@ -109,34 +82,18 @@ helloWithDebug = pkgs.hello.overrideAttrs (oldAttrs: rec {
<warning> <warning>
<para> <para>
You should prefer <varname>overrideAttrs</varname> in almost all cases, see You should prefer <varname>overrideAttrs</varname> in almost all cases, see its documentation for the reasons why. <varname>overrideDerivation</varname> is not deprecated and will continue to work, but is less nice to use and does not have as many abilities as <varname>overrideAttrs</varname>.
its documentation for the reasons why.
<varname>overrideDerivation</varname> is not deprecated and will continue
to work, but is less nice to use and does not have as many abilities as
<varname>overrideAttrs</varname>.
</para> </para>
</warning> </warning>
<warning> <warning>
<para> <para>
Do not use this function in Nixpkgs as it evaluates a Derivation before Do not use this function in Nixpkgs as it evaluates a Derivation before modifying it, which breaks package abstraction and removes error-checking of function arguments. In addition, this evaluation-per-function application incurs a performance penalty, which can become a problem if many overrides are used. It is only intended for ad-hoc customisation, such as in <filename>~/.config/nixpkgs/config.nix</filename>.
modifying it, which breaks package abstraction and removes error-checking
of function arguments. In addition, this evaluation-per-function
application incurs a performance penalty, which can become a problem if
many overrides are used. It is only intended for ad-hoc customisation, such
as in <filename>~/.config/nixpkgs/config.nix</filename>.
</para> </para>
</warning> </warning>
<para> <para>
The function <varname>overrideDerivation</varname> creates a new derivation The function <varname>overrideDerivation</varname> creates a new derivation based on an existing one by overriding the original's attributes with the attribute set produced by the specified function. This function is available on all derivations defined using the <varname>makeOverridable</varname> function. Most standard derivation-producing functions, such as <varname>stdenv.mkDerivation</varname>, are defined using this function, which means most packages in the nixpkgs expression, <varname>pkgs</varname>, have this function.
based on an existing one by overriding the original's attributes with the
attribute set produced by the specified function. This function is available
on all derivations defined using the <varname>makeOverridable</varname>
function. Most standard derivation-producing functions, such as
<varname>stdenv.mkDerivation</varname>, are defined using this function,
which means most packages in the nixpkgs expression,
<varname>pkgs</varname>, have this function.
</para> </para>
<para> <para>
@ -154,27 +111,16 @@ mySed = pkgs.gnused.overrideDerivation (oldAttrs: {
</para> </para>
<para> <para>
In the above example, the <varname>name</varname>, <varname>src</varname>, In the above example, the <varname>name</varname>, <varname>src</varname>, and <varname>patches</varname> of the derivation will be overridden, while all other attributes will be retained from the original derivation.
and <varname>patches</varname> of the derivation will be overridden, while
all other attributes will be retained from the original derivation.
</para> </para>
<para> <para>
The argument <varname>oldAttrs</varname> is used to refer to the attribute The argument <varname>oldAttrs</varname> is used to refer to the attribute set of the original derivation.
set of the original derivation.
</para> </para>
<note> <note>
<para> <para>
A package's attributes are evaluated *before* being modified by the A package's attributes are evaluated *before* being modified by the <varname>overrideDerivation</varname> function. For example, the <varname>name</varname> attribute reference in <varname>url = "mirror://gnu/hello/${name}.tar.gz";</varname> is filled-in *before* the <varname>overrideDerivation</varname> function modifies the attribute set. This means that overriding the <varname>name</varname> attribute, in this example, *will not* change the value of the <varname>url</varname> attribute. Instead, we need to override both the <varname>name</varname> *and* <varname>url</varname> attributes.
<varname>overrideDerivation</varname> function. For example, the
<varname>name</varname> attribute reference in <varname>url =
"mirror://gnu/hello/${name}.tar.gz";</varname> is filled-in *before* the
<varname>overrideDerivation</varname> function modifies the attribute set.
This means that overriding the <varname>name</varname> attribute, in this
example, *will not* change the value of the <varname>url</varname>
attribute. Instead, we need to override both the <varname>name</varname>
*and* <varname>url</varname> attributes.
</para> </para>
</note> </note>
</section> </section>
@ -183,9 +129,7 @@ mySed = pkgs.gnused.overrideDerivation (oldAttrs: {
<title>lib.makeOverridable</title> <title>lib.makeOverridable</title>
<para> <para>
The function <varname>lib.makeOverridable</varname> is used to make the The function <varname>lib.makeOverridable</varname> is used to make the result of a function easily customizable. This utility only makes sense for functions that accept an argument set and return an attribute set.
result of a function easily customizable. This utility only makes sense for
functions that accept an argument set and return an attribute set.
</para> </para>
<para> <para>
@ -197,16 +141,11 @@ c = lib.makeOverridable f { a = 1; b = 2; };
</para> </para>
<para> <para>
The variable <varname>c</varname> is the value of the <varname>f</varname> The variable <varname>c</varname> is the value of the <varname>f</varname> function applied with some default arguments. Hence the value of <varname>c.result</varname> is <literal>3</literal>, in this example.
function applied with some default arguments. Hence the value of
<varname>c.result</varname> is <literal>3</literal>, in this example.
</para> </para>
<para> <para>
The variable <varname>c</varname> however also has some additional The variable <varname>c</varname> however also has some additional functions, like <link linkend="sec-pkg-override">c.override</link> which can be used to override the default arguments. In this example the value of <varname>(c.override { a = 4; }).result</varname> is 6.
functions, like <link linkend="sec-pkg-override">c.override</link> which can
be used to override the default arguments. In this example the value of
<varname>(c.override { a = 4; }).result</varname> is 6.
</para> </para>
</section> </section>
</section> </section>

8
doc/functions/prefer-remote-fetch.xml
View File

@ -5,16 +5,12 @@
<title>prefer-remote-fetch overlay</title> <title>prefer-remote-fetch overlay</title>
<para> <para>
<function>prefer-remote-fetch</function> is an overlay that download sources <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:
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:
<programlisting> <programlisting>
self: super: self: super:
(super.prefer-remote-fetch self super) (super.prefer-remote-fetch self super)
</programlisting> </programlisting>
A full configuration example for that sets the overlay up for your own A full configuration example for that sets the overlay up for your own account, could look like this
account, could look like this
<screen> <screen>
<prompt>$ </prompt>mkdir ~/.config/nixpkgs/overlays/ <prompt>$ </prompt>mkdir ~/.config/nixpkgs/overlays/
<prompt>$ </prompt>cat &gt; ~/.config/nixpkgs/overlays/prefer-remote-fetch.nix &lt;&lt;EOF <prompt>$ </prompt>cat &gt; ~/.config/nixpkgs/overlays/prefer-remote-fetch.nix &lt;&lt;EOF

4
doc/functions/shell.xml
View File

@ -5,9 +5,7 @@
<title>pkgs.mkShell</title> <title>pkgs.mkShell</title>
<para> <para>
<function>pkgs.mkShell</function> is a special kind of derivation that is <function>pkgs.mkShell</function> is a special kind of derivation that is only useful when using it combined with <command>nix-shell</command>. It will in fact fail to instantiate when invoked with <command>nix-build</command>.
only useful when using it combined with <command>nix-shell</command>. It will
in fact fail to instantiate when invoked with <command>nix-build</command>.
</para> </para>
<section xml:id="sec-pkgs-mkShell-usage"> <section xml:id="sec-pkgs-mkShell-usage">

31
doc/functions/snaptools.xml
View File

@ -5,28 +5,22 @@
<title>pkgs.snapTools</title> <title>pkgs.snapTools</title>
<para> <para>
<varname>pkgs.snapTools</varname> is a set of functions for creating <varname>pkgs.snapTools</varname> is a set of functions for creating Snapcraft images. Snap and Snapcraft is not used to perform these operations.
Snapcraft images. Snap and Snapcraft is not used to perform these operations.
</para> </para>
<section xml:id="ssec-pkgs-snapTools-makeSnap-signature"> <section xml:id="ssec-pkgs-snapTools-makeSnap-signature">
<title>The makeSnap Function</title> <title>The makeSnap Function</title>
<para> <para>
<function>makeSnap</function> takes a single named argument, <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.
<parameter>meta</parameter>. This argument mirrors
<link xlink:href="https://docs.snapcraft.io/snap-format">the upstream
<filename>snap.yaml</filename> format</link> exactly.
</para> </para>
<para> <para>
The <parameter>base</parameter> should not be be specified, as The <parameter>base</parameter> should not be be specified, as <function>makeSnap</function> will force set it.
<function>makeSnap</function> will force set it.
</para> </para>
<para> <para>
Currently, <function>makeSnap</function> does not support creating GUI Currently, <function>makeSnap</function> does not support creating GUI stubs.
stubs.
</para> </para>
</section> </section>
@ -40,9 +34,7 @@
</para> </para>
<programlisting><xi:include href="./snap/example-hello.nix" parse="text" /></programlisting> <programlisting><xi:include href="./snap/example-hello.nix" parse="text" /></programlisting>
<para> <para>
<command>nix-build</command> this expression and install it with <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.
<command>snap install ./result --dangerous</command>.
<command>hello</command> will now be the Snapcraft version of the package.
</para> </para>
</example> </example>
</section> </section>
@ -53,21 +45,14 @@
<example xml:id="ex-snapTools-buildSnap-firefox"> <example xml:id="ex-snapTools-buildSnap-firefox">
<title>Making a Graphical Snap</title> <title>Making a Graphical Snap</title>
<para> <para>
Graphical programs require many more integrations with the host. This 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.
example uses Firefox as an example, because it is one of the most
complicated programs we could package.
</para> </para>
<programlisting><xi:include href="./snap/example-firefox.nix" parse="text" /></programlisting> <programlisting><xi:include href="./snap/example-firefox.nix" parse="text" /></programlisting>
<para> <para>
<command>nix-build</command> this expression and install it with <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.
<command>snap install ./result --dangerous</command>.
<command>nix-example-firefox</command> will now be the Snapcraft version of
the Firefox package.
</para> </para>
<para> <para>
The specific meaning behind plugs can be looked up in the The specific meaning behind plugs can be looked up in the <link xlink:href="https://docs.snapcraft.io/supported-interfaces">Snapcraft interface documentation</link>.
<link xlink:href="https://docs.snapcraft.io/supported-interfaces">Snapcraft
interface documentation</link>.
</para> </para>
</example> </example>
</section> </section>

46
doc/functions/trivial-builders.xml
View File

@ -5,11 +5,7 @@
<title>Trivial builders</title> <title>Trivial builders</title>
<para> <para>
Nixpkgs provides a couple of functions that help with building derivations. Nixpkgs provides a couple of functions that help with building derivations. The most important one, <function>stdenv.mkDerivation</function>, has already been documented above. The following functions wrap <function>stdenv.mkDerivation</function>, making it easier to use in certain cases.
The most important one, <function>stdenv.mkDerivation</function>, has already
been documented above. The following functions wrap
<function>stdenv.mkDerivation</function>, making it easier to use in certain
cases.
</para> </para>
<variablelist> <variablelist>
@ -19,17 +15,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
This takes three arguments, <literal>name</literal>, This takes three arguments, <literal>name</literal>, <literal>env</literal>, and <literal>buildCommand</literal>. <literal>name</literal> is just the name that Nix will append to the store path in the same way that <literal>stdenv.mkDerivation</literal> uses its <literal>name</literal> attribute. <literal>env</literal> is an attribute set specifying environment variables that will be set for this derivation. These attributes are then passed to the wrapped <literal>stdenv.mkDerivation</literal>. <literal>buildCommand</literal> specifies the commands that will be run to create this derivation. Note that you will need to create <literal>$out</literal> for Nix to register the command as successful.
<literal>env</literal>, and <literal>buildCommand</literal>.
<literal>name</literal> is just the name that Nix will append to the store
path in the same way that <literal>stdenv.mkDerivation</literal> uses its
<literal>name</literal> attribute. <literal>env</literal> is an attribute
set specifying environment variables that will be set for this derivation.
These attributes are then passed to the wrapped
<literal>stdenv.mkDerivation</literal>. <literal>buildCommand</literal>
specifies the commands that will be run to create this derivation. Note
that you will need to create <literal>$out</literal> for Nix to register
the command as successful.
</para> </para>
<para> <para>
An example of using <literal>runCommand</literal> is provided below. An example of using <literal>runCommand</literal> is provided below.
@ -62,10 +48,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
This works just like <literal>runCommand</literal>. The only difference is This works just like <literal>runCommand</literal>. The only difference is that it also provides a C compiler in <literal>buildCommand</literal>’s environment. To minimize your dependencies, you should only use this if you are sure you will need a C compiler as part of running your command.
that it also provides a C compiler in <literal>buildCommand</literal>’s
environment. To minimize your dependencies, you should only use this if
you are sure you will need a C compiler as part of running your command.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -75,20 +58,10 @@
</term> </term>
<listitem> <listitem>
<para> <para>
These functions write <literal>text</literal> to the Nix store. This is These functions write <literal>text</literal> to the Nix store. This is useful for creating scripts from Nix expressions. <literal>writeTextFile</literal> takes an attribute set and expects two arguments, <literal>name</literal> and <literal>text</literal>. <literal>name</literal> corresponds to the name used in the Nix store path. <literal>text</literal> will be the contents of the file. You can also set <literal>executable</literal> to true to make this file have the executable bit set.
useful for creating scripts from Nix expressions.
<literal>writeTextFile</literal> takes an attribute set and expects two
arguments, <literal>name</literal> and <literal>text</literal>.
<literal>name</literal> corresponds to the name used in the Nix store
path. <literal>text</literal> will be the contents of the file. You can
also set <literal>executable</literal> to true to make this file have the
executable bit set.
</para> </para>
<para> <para>
Many more commands wrap <literal>writeTextFile</literal> including Many more commands wrap <literal>writeTextFile</literal> including <literal>writeText</literal>, <literal>writeTextDir</literal>, <literal>writeScript</literal>, and <literal>writeScriptBin</literal>. These are convenience functions over <literal>writeTextFile</literal>.
<literal>writeText</literal>, <literal>writeTextDir</literal>,
<literal>writeScript</literal>, and <literal>writeScriptBin</literal>.
These are convenience functions over <literal>writeTextFile</literal>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -98,14 +71,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
This can be used to put many derivations into the same directory This can be used to put many derivations into the same directory structure. It works by creating a new derivation and adding symlinks to each of the paths listed. It expects two arguments, <literal>name</literal>, and <literal>paths</literal>. <literal>name</literal> is the name used in the Nix store path for the created derivation. <literal>paths</literal> is a list of paths that will be symlinked. These paths can be to Nix store derivations or any other subdirectory contained within.
structure. It works by creating a new derivation and adding symlinks to
each of the paths listed. It expects two arguments,
<literal>name</literal>, and <literal>paths</literal>.
<literal>name</literal> is the name used in the Nix store path for the
created derivation. <literal>paths</literal> is a list of paths that will
be symlinked. These paths can be to Nix store derivations or any other
subdirectory contained within.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>

163
doc/languages-frameworks/beam.xml
View File

@ -7,12 +7,7 @@
<title>Introduction</title> <title>Introduction</title>
<para> <para>
In this document and related Nix expressions, we use the term, In this document and related Nix expressions, we use the term, <emphasis>BEAM</emphasis>, 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.
<emphasis>BEAM</emphasis>, 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.
</para> </para>
</section> </section>
@ -20,57 +15,36 @@
<title>Structure</title> <title>Structure</title>
<para> <para>
All BEAM-related expressions are available via the top-level All BEAM-related expressions are available via the top-level <literal>beam</literal> attribute, which includes:
<literal>beam</literal> attribute, which includes:
</para> </para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
<literal>interpreters</literal>: a set of compilers running on the BEAM, <literal>interpreters</literal>: a set of compilers running on the BEAM, including multiple Erlang/OTP versions (<literal>beam.interpreters.erlangR19</literal>, etc), Elixir (<literal>beam.interpreters.elixir</literal>) and LFE (<literal>beam.interpreters.lfe</literal>).
including multiple Erlang/OTP versions
(<literal>beam.interpreters.erlangR19</literal>, etc), Elixir
(<literal>beam.interpreters.elixir</literal>) and LFE
(<literal>beam.interpreters.lfe</literal>).
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<literal>packages</literal>: a set of package sets, each compiled with a <literal>packages</literal>: a set of package sets, each compiled with a specific Erlang/OTP version, e.g. <literal>beam.packages.erlangR19</literal>.
specific Erlang/OTP version, e.g.
<literal>beam.packages.erlangR19</literal>.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<para> <para>
The default Erlang compiler, defined by The default Erlang compiler, defined by <literal>beam.interpreters.erlang</literal>, is aliased as <literal>erlang</literal>. The default BEAM package set is defined by <literal>beam.packages.erlang</literal> and aliased at the top level as <literal>beamPackages</literal>.
<literal>beam.interpreters.erlang</literal>, is aliased as
<literal>erlang</literal>. The default BEAM package set is defined by
<literal>beam.packages.erlang</literal> and aliased at the top level as
<literal>beamPackages</literal>.
</para> </para>
<para> <para>
To create a package set built with a custom Erlang version, use the lambda, To create a package set built with a custom Erlang version, use the lambda, <literal>beam.packagesWith</literal>, which accepts an Erlang/OTP derivation and produces a package set similar to <literal>beam.packages.erlang</literal>.
<literal>beam.packagesWith</literal>, which accepts an Erlang/OTP derivation
and produces a package set similar to
<literal>beam.packages.erlang</literal>.
</para> </para>
<para> <para>
Many Erlang/OTP distributions available in Many Erlang/OTP distributions available in <literal>beam.interpreters</literal> have versions with ODBC and/or Java enabled. For example, there's <literal>beam.interpreters.erlangR19_odbc_javac</literal>, which corresponds to <literal>beam.interpreters.erlangR19</literal>.
<literal>beam.interpreters</literal> have versions with ODBC and/or Java
enabled. For example, there's
<literal>beam.interpreters.erlangR19_odbc_javac</literal>, which corresponds
to <literal>beam.interpreters.erlangR19</literal>.
</para> </para>
<para xml:id="erlang-call-package"> <para xml:id="erlang-call-package">
We also provide the lambda, We also provide the lambda, <literal>beam.packages.erlang.callPackage</literal>, which simplifies writing BEAM package definitions by injecting all packages from <literal>beam.packages.erlang</literal> into the top-level context.
<literal>beam.packages.erlang.callPackage</literal>, which simplifies
writing BEAM package definitions by injecting all packages from
<literal>beam.packages.erlang</literal> into the top-level context.
</para> </para>
</section> </section>
@ -81,24 +55,16 @@
<title>Rebar3</title> <title>Rebar3</title>
<para> <para>
By default, Rebar3 wants to manage its own dependencies. This is perfectly By default, Rebar3 wants to manage its own dependencies. This is perfectly acceptable in the normal, non-Nix setup, but in the Nix world, it is not. To rectify this, we provide two versions of Rebar3:
acceptable in the normal, non-Nix setup, but in the Nix world, it is not.
To rectify this, we provide two versions of Rebar3:
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
<literal>rebar3</literal>: patched to remove the ability to download <literal>rebar3</literal>: patched to remove the ability to download anything. When not running it via <literal>nix-shell</literal> or <literal>nix-build</literal>, it's probably not going to work as desired.
anything. When not running it via <literal>nix-shell</literal> or
<literal>nix-build</literal>, it's probably not going to work as
desired.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<literal>rebar3-open</literal>: the normal, unmodified Rebar3. It should <literal>rebar3-open</literal>: the normal, unmodified Rebar3. It should work exactly as would any other version of Rebar3. Any Erlang package should rely on <literal>rebar3</literal> instead. See <xref
work exactly as would any other version of Rebar3. Any Erlang package
should rely on <literal>rebar3</literal> instead. See
<xref
linkend="rebar3-packages"/>. linkend="rebar3-packages"/>.
</para> </para>
</listitem> </listitem>
@ -110,10 +76,7 @@
<title>Mix &amp; Erlang.mk</title> <title>Mix &amp; Erlang.mk</title>
<para> <para>
Both Mix and Erlang.mk work exactly as expected. There is a bootstrap 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 <literal>buildMix</literal> and <literal>buildErlangMk</literal> derivations, respectively.
process that needs to be run for both, however, which is supported by the
<literal>buildMix</literal> and <literal>buildErlangMk</literal>
derivations, respectively.
</para> </para>
</section> </section>
</section> </section>
@ -122,13 +85,7 @@
<title>How to Install BEAM Packages</title> <title>How to Install BEAM Packages</title>
<para> <para>
BEAM packages are not registered at the top level, simply because they are BEAM packages are not registered at the top level, simply because they are not relevant to the vast majority of Nix users. They are installable using the <literal>beam.packages.erlang</literal> attribute set (aliased as <literal>beamPackages</literal>), which points to packages built by the default Erlang/OTP version in Nixpkgs, as defined by <literal>beam.interpreters.erlang</literal>. To list the available packages in <literal>beamPackages</literal>, use the following command:
not relevant to the vast majority of Nix users. They are installable using
the <literal>beam.packages.erlang</literal> attribute set (aliased as
<literal>beamPackages</literal>), which points to packages built by the
default Erlang/OTP version in Nixpkgs, as defined by
<literal>beam.interpreters.erlang</literal>. To list the available packages
in <literal>beamPackages</literal>, use the following command:
</para> </para>
<screen> <screen>
@ -143,8 +100,7 @@ beamPackages.rebar3-pc pc-1.1.0
</screen> </screen>
<para> <para>
To install any of those packages into your profile, refer to them by their To install any of those packages into your profile, refer to them by their attribute path (first column):
attribute path (first column):
</para> </para>
<screen> <screen>
@ -152,9 +108,7 @@ beamPackages.rebar3-pc pc-1.1.0
</screen> </screen>
<para> <para>
The attribute path of any BEAM package corresponds to the name of that The attribute path of any BEAM package corresponds to the name of that particular package in <link xlink:href="https://hex.pm">Hex</link> or its OTP Application/Release name.
particular package in <link xlink:href="https://hex.pm">Hex</link> or its
OTP Application/Release name.
</para> </para>
</section> </section>
@ -168,13 +122,8 @@ beamPackages.rebar3-pc pc-1.1.0
<title>Rebar3 Packages</title> <title>Rebar3 Packages</title>
<para> <para>
The Nix function, <literal>buildRebar3</literal>, defined in The Nix function, <literal>buildRebar3</literal>, defined in <literal>beam.packages.erlang.buildRebar3</literal> and aliased at the top level, can be used to build a derivation that understands how to build a Rebar3 project. For example, we can build <link
<literal>beam.packages.erlang.buildRebar3</literal> and aliased at the top xlink:href="https://github.com/erlang-nix/hex2nix">hex2nix</link> as follows:
level, can be used to build a derivation that understands how to build a
Rebar3 project. For example, we can build
<link
xlink:href="https://github.com/erlang-nix/hex2nix">hex2nix</link>
as follows:
</para> </para>
<programlisting> <programlisting>
@ -196,25 +145,16 @@ buildRebar3 rec {
</programlisting> </programlisting>
<para> <para>
Such derivations are callable with Such derivations are callable with <literal>beam.packages.erlang.callPackage</literal> (see <xref
<literal>beam.packages.erlang.callPackage</literal> (see linkend="erlang-call-package"/>). To call this package using the normal <literal>callPackage</literal>, refer to dependency packages via <literal>beamPackages</literal>, e.g. <literal>beamPackages.ibrowse</literal>.
<xref
linkend="erlang-call-package"/>). To call this package using
the normal <literal>callPackage</literal>, refer to dependency packages
via <literal>beamPackages</literal>, e.g.
<literal>beamPackages.ibrowse</literal>.
</para> </para>
<para> <para>
Notably, <literal>buildRebar3</literal> includes Notably, <literal>buildRebar3</literal> includes <literal>beamDeps</literal>, while <literal>stdenv.mkDerivation</literal> does not. BEAM dependencies added there will be correctly handled by the system.
<literal>beamDeps</literal>, while <literal>stdenv.mkDerivation</literal>
does not. BEAM dependencies added there will be correctly handled by the
system.
</para> </para>
<para> <para>
If a package needs to compile native code via Rebar3's port compilation If a package needs to compile native code via Rebar3's port compilation mechanism, add <literal>compilePort = true;</literal> to the derivation.
mechanism, add <literal>compilePort = true;</literal> to the derivation.
</para> </para>
</section> </section>
@ -222,9 +162,7 @@ buildRebar3 rec {
<title>Erlang.mk Packages</title> <title>Erlang.mk Packages</title>
<para> <para>
Erlang.mk functions similarly to Rebar3, except we use Erlang.mk functions similarly to Rebar3, except we use <literal>buildErlangMk</literal> instead of <literal>buildRebar3</literal>.
<literal>buildErlangMk</literal> instead of
<literal>buildRebar3</literal>.
</para> </para>
<programlisting> <programlisting>
@ -257,8 +195,7 @@ buildErlangMk {
<title>Mix Packages</title> <title>Mix Packages</title>
<para> <para>
Mix functions similarly to Rebar3, except we use Mix functions similarly to Rebar3, except we use <literal>buildMix</literal> instead of <literal>buildRebar3</literal>.
<literal>buildMix</literal> instead of <literal>buildRebar3</literal>.
</para> </para>
<programlisting> <programlisting>
@ -323,11 +260,7 @@ buildHex {
<title>Accessing an Environment</title> <title>Accessing an Environment</title>
<para> <para>
Often, we simply want to access a valid environment that contains a Often, we simply want to access a valid environment that contains a specific package and its dependencies. We can accomplish that with the <literal>env</literal> attribute of a derivation. For example, let's say we want to access an Erlang REPL with <literal>ibrowse</literal> loaded up. We could do the following:
specific package and its dependencies. We can accomplish that with the
<literal>env</literal> attribute of a derivation. For example, let's say we
want to access an Erlang REPL with <literal>ibrowse</literal> loaded up. We
could do the following:
</para> </para>
<screen> <screen>
@ -373,8 +306,7 @@ ok</computeroutput>
</screen> </screen>
<para> <para>
Notice the <literal>-A beamPackages.ibrowse.env</literal>. That is the key Notice the <literal>-A beamPackages.ibrowse.env</literal>. That is the key to this functionality.
to this functionality.
</para> </para>
</section> </section>
@ -382,11 +314,7 @@ ok</computeroutput>
<title>Creating a Shell</title> <title>Creating a Shell</title>
<para> <para>
Getting access to an environment often isn't enough to do real development. Getting access to an environment often isn't enough to do real development. Usually, we need to create a <literal>shell.nix</literal> file and do our development inside of the environment specified therein. This file looks a lot like the packaging described above, except that <literal>src</literal> points to the project root and we call the package directly.
Usually, we need to create a <literal>shell.nix</literal> file and do our
development inside of the environment specified therein. This file looks a
lot like the packaging described above, except that <literal>src</literal>
points to the project root and we call the package directly.
</para> </para>
<programlisting> <programlisting>
@ -414,8 +342,7 @@ in
<title>Building in a Shell (for Mix Projects)</title> <title>Building in a Shell (for Mix Projects)</title>
<para> <para>
We can leverage the support of the derivation, irrespective of the build We can leverage the support of the derivation, irrespective of the build derivation, by calling the commands themselves.
derivation, by calling the commands themselves.
</para> </para>
<programlisting> <programlisting>
@ -477,12 +404,8 @@ analyze: build plt
</programlisting> </programlisting>
<para> <para>
Using a <literal>shell.nix</literal> as described (see Using a <literal>shell.nix</literal> as described (see <xref
<xref linkend="creating-a-shell"/>) should just work. Aside from <literal>test</literal>, <literal>plt</literal>, and <literal>analyze</literal>, the Make targets work just fine for all of the build derivations.
linkend="creating-a-shell"/>) should just work. Aside from
<literal>test</literal>, <literal>plt</literal>, and
<literal>analyze</literal>, the Make targets work just fine for all of the
build derivations.
</para> </para>
</section> </section>
</section> </section>
@ -492,25 +415,14 @@ analyze: build plt
<title>Generating Packages from Hex with <literal>hex2nix</literal></title> <title>Generating Packages from Hex with <literal>hex2nix</literal></title>
<para> <para>
Updating the <link xlink:href="https://hex.pm">Hex</link> package set Updating the <link xlink:href="https://hex.pm">Hex</link> package set requires <link
requires xlink:href="https://github.com/erlang-nix/hex2nix">hex2nix</link>. Given the path to the Erlang modules (usually <literal>pkgs/development/erlang-modules</literal>), it will dump a file called <literal>hex-packages.nix</literal>, containing all the packages that use a recognized build system in <link
<link xlink:href="https://hex.pm">Hex</link>. It can't be determined, however, whether every package is buildable.
xlink:href="https://github.com/erlang-nix/hex2nix">hex2nix</link>.
Given the path to the Erlang modules (usually
<literal>pkgs/development/erlang-modules</literal>), it will dump a file
called <literal>hex-packages.nix</literal>, containing all the packages that
use a recognized build system in
<link
xlink:href="https://hex.pm">Hex</link>. It can't be determined,
however, whether every package is buildable.
</para> </para>
<para> <para>
To make life easier for our users, try to build every To make life easier for our users, try to build every <link
<link xlink:href="https://hex.pm">Hex</link> package and remove those that fail. To do that, simply run the following command in the root of your <literal>nixpkgs</literal> repository:
xlink:href="https://hex.pm">Hex</link> package and remove those
that fail. To do that, simply run the following command in the root of your
<literal>nixpkgs</literal> repository:
</para> </para>
<screen> <screen>
@ -518,11 +430,8 @@ analyze: build plt
</screen> </screen>
<para> <para>
That will attempt to build every package in <literal>beamPackages</literal>. That will attempt to build every package in <literal>beamPackages</literal>. Then manually remove those that fail. Hopefully, someone will improve <link
Then manually remove those that fail. Hopefully, someone will improve xlink:href="https://github.com/erlang-nix/hex2nix">hex2nix</link> in the future to automate the process.
<link
xlink:href="https://github.com/erlang-nix/hex2nix">hex2nix</link>
in the future to automate the process.
</para> </para>
</section> </section>
</section> </section>

71
doc/languages-frameworks/bower.xml
View File

@ -4,32 +4,22 @@
<title>Bower</title> <title>Bower</title>
<para> <para>
<link xlink:href="http://bower.io">Bower</link> is a package manager for web <link xlink:href="http://bower.io">Bower</link> is a package manager for web site front-end components. Bower packages (comprising of build artefacts and sometimes sources) are stored in <command>git</command> repositories, typically on Github. The package registry is run by the Bower team with package metadata coming from the <filename>bower.json</filename> file within each package.
site front-end components. Bower packages (comprising of build artefacts and
sometimes sources) are stored in <command>git</command> repositories,
typically on Github. The package registry is run by the Bower team with
package metadata coming from the <filename>bower.json</filename> file within
each package.
</para> </para>
<para> <para>
The end result of running Bower is a <filename>bower_components</filename> The end result of running Bower is a <filename>bower_components</filename> directory which can be included in the web app's build process.
directory which can be included in the web app's build process.
</para> </para>
<para> <para>
Bower can be run interactively, by installing Bower can be run interactively, by installing <varname>nodePackages.bower</varname>. More interestingly, the Bower components can be declared in a Nix derivation, with the help of <varname>nodePackages.bower2nix</varname>.
<varname>nodePackages.bower</varname>. More interestingly, the Bower
components can be declared in a Nix derivation, with the help of
<varname>nodePackages.bower2nix</varname>.
</para> </para>
<section xml:id="ssec-bower2nix-usage"> <section xml:id="ssec-bower2nix-usage">
<title><command>bower2nix</command> usage</title> <title><command>bower2nix</command> usage</title>
<para> <para>
Suppose you have a <filename>bower.json</filename> with the following Suppose you have a <filename>bower.json</filename> with the following contents:
contents:
<example xml:id="ex-bowerJson"> <example xml:id="ex-bowerJson">
<title><filename>bower.json</filename></title> <title><filename>bower.json</filename></title>
<programlisting language="json"> <programlisting language="json">
@ -45,8 +35,7 @@
</para> </para>
<para> <para>
Running <command>bower2nix</command> will produce something like the Running <command>bower2nix</command> will produce something like the following output:
following output:
<programlisting language="nix"> <programlisting language="nix">
<![CDATA[{ fetchbower, buildEnv }: <![CDATA[{ fetchbower, buildEnv }:
buildEnv { name = "bower-env"; ignoreCollisions = true; paths = [ buildEnv { name = "bower-env"; ignoreCollisions = true; paths = [
@ -58,15 +47,11 @@ buildEnv { name = "bower-env"; ignoreCollisions = true; paths = [
</para> </para>
<para> <para>
Using the <command>bower2nix</command> command line arguments, the output Using the <command>bower2nix</command> command line arguments, the output can be redirected to a file. A name like <filename>bower-packages.nix</filename> would be fine.
can be redirected to a file. A name like
<filename>bower-packages.nix</filename> would be fine.
</para> </para>
<para> <para>
The resulting derivation is a union of all the downloaded Bower packages The resulting derivation is a union of all the downloaded Bower packages (and their dependencies). To use it, they still need to be linked together by Bower, which is where <varname>buildBowerComponents</varname> is useful.
(and their dependencies). To use it, they still need to be linked together
by Bower, which is where <varname>buildBowerComponents</varname> is useful.
</para> </para>
</section> </section>
@ -74,10 +59,7 @@ buildEnv { name = "bower-env"; ignoreCollisions = true; paths = [
<title><varname>buildBowerComponents</varname> function</title> <title><varname>buildBowerComponents</varname> function</title>
<para> <para>
The function is implemented in The function is implemented in <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/bower-modules/generic/default.nix"> <filename>pkgs/development/bower-modules/generic/default.nix</filename></link>. Example usage:
<link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/bower-modules/generic/default.nix">
<filename>pkgs/development/bower-modules/generic/default.nix</filename></link>.
Example usage:
<example xml:id="ex-buildBowerComponents"> <example xml:id="ex-buildBowerComponents">
<title>buildBowerComponents</title> <title>buildBowerComponents</title>
<programlisting language="nix"> <programlisting language="nix">
@ -91,34 +73,27 @@ bowerComponents = buildBowerComponents {
</para> </para>
<para> <para>
In <xref linkend="ex-buildBowerComponents" />, the following arguments are In <xref linkend="ex-buildBowerComponents" />, the following arguments are of special significance to the function:
of special significance to the function:
<calloutlist> <calloutlist>
<callout arearefs="ex-buildBowerComponents-1"> <callout arearefs="ex-buildBowerComponents-1">
<para> <para>
<varname>generated</varname> specifies the file which was created by <varname>generated</varname> specifies the file which was created by <command>bower2nix</command>.
<command>bower2nix</command>.
</para> </para>
</callout> </callout>
<callout arearefs="ex-buildBowerComponents-2"> <callout arearefs="ex-buildBowerComponents-2">
<para> <para>
<varname>src</varname> is your project's sources. It needs to contain a <varname>src</varname> is your project's sources. It needs to contain a <filename>bower.json</filename> file.
<filename>bower.json</filename> file.
</para> </para>
</callout> </callout>
</calloutlist> </calloutlist>
</para> </para>
<para> <para>
<varname>buildBowerComponents</varname> will run Bower to link together the <varname>buildBowerComponents</varname> will run Bower to link together the output of <command>bower2nix</command>, resulting in a <filename>bower_components</filename> directory which can be used.
output of <command>bower2nix</command>, resulting in a
<filename>bower_components</filename> directory which can be used.
</para> </para>
<para> <para>
Here is an example of a web frontend build process using Here is an example of a web frontend build process using <command>gulp</command>. You might use <command>grunt</command>, or anything else.
<command>gulp</command>. You might use <command>grunt</command>, or anything
else.
</para> </para>
<example xml:id="ex-bowerGulpFile"> <example xml:id="ex-bowerGulpFile">
@ -174,21 +149,17 @@ pkgs.stdenv.mkDerivation {
<calloutlist> <calloutlist>
<callout arearefs="ex-buildBowerComponentsDefault-1"> <callout arearefs="ex-buildBowerComponentsDefault-1">
<para> <para>
The result of <varname>buildBowerComponents</varname> is an input to the The result of <varname>buildBowerComponents</varname> is an input to the frontend build.
frontend build.
</para> </para>
</callout> </callout>
<callout arearefs="ex-buildBowerComponentsDefault-2"> <callout arearefs="ex-buildBowerComponentsDefault-2">
<para> <para>
Whether to symlink or copy the <filename>bower_components</filename> Whether to symlink or copy the <filename>bower_components</filename> directory depends on the build tool in use. In this case a copy is used to avoid <command>gulp</command> silliness with permissions.
directory depends on the build tool in use. In this case a copy is used
to avoid <command>gulp</command> silliness with permissions.
</para> </para>
</callout> </callout>
<callout arearefs="ex-buildBowerComponentsDefault-3"> <callout arearefs="ex-buildBowerComponentsDefault-3">
<para> <para>
<command>gulp</command> requires <varname>HOME</varname> to refer to a <command>gulp</command> requires <varname>HOME</varname> to refer to a writeable directory.
writeable directory.
</para> </para>
</callout> </callout>
<callout arearefs="ex-buildBowerComponentsDefault-4"> <callout arearefs="ex-buildBowerComponentsDefault-4">
@ -210,17 +181,13 @@ pkgs.stdenv.mkDerivation {
</term> </term>
<listitem> <listitem>
<para> <para>
This means that Bower was looking for a package version which doesn't This means that Bower was looking for a package version which doesn't exist in the generated <filename>bower-packages.nix</filename>.
exist in the generated <filename>bower-packages.nix</filename>.
</para> </para>
<para> <para>
If <filename>bower.json</filename> has been updated, then run If <filename>bower.json</filename> has been updated, then run <command>bower2nix</command> again.
<command>bower2nix</command> again.
</para> </para>
<para> <para>
It could also be a bug in <command>bower2nix</command> or It could also be a bug in <command>bower2nix</command> or <command>fetchbower</command>. If possible, try reformulating the version specification in <filename>bower.json</filename>.
<command>fetchbower</command>. If possible, try reformulating the version
specification in <filename>bower.json</filename>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>

20
doc/languages-frameworks/coq.xml
View File

@ -4,31 +4,19 @@
<title>Coq</title> <title>Coq</title>
<para> <para>
Coq libraries should be installed in Coq libraries should be installed in <literal>$(out)/lib/coq/${coq.coq-version}/user-contrib/</literal>. Such directories are automatically added to the <literal>$COQPATH</literal> environment variable by the hook defined in the Coq derivation.
<literal>$(out)/lib/coq/${coq.coq-version}/user-contrib/</literal>. Such
directories are automatically added to the <literal>$COQPATH</literal>
environment variable by the hook defined in the Coq derivation.
</para> </para>
<para> <para>
Some extensions (plugins) might require OCaml and sometimes other OCaml Some extensions (plugins) might require OCaml and sometimes other OCaml packages. The <literal>coq.ocamlPackages</literal> attribute can be used to depend on the same package set Coq was built against.
packages. The <literal>coq.ocamlPackages</literal> attribute can be used to
depend on the same package set Coq was built against.
</para> </para>
<para> <para>
Coq libraries may be compatible with some specific versions of Coq only. The Coq libraries may be compatible with some specific versions of Coq only. The <literal>compatibleCoqVersions</literal> attribute is used to precisely select those versions of Coq that are compatible with this derivation.
<literal>compatibleCoqVersions</literal> attribute is used to precisely
select those versions of Coq that are compatible with this derivation.
</para> </para>
<para> <para>
Here is a simple package example. It is a pure Coq library, thus it depends 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 <literal>mathcomp</literal> as <literal>buildInputs</literal>. Its <literal>Makefile</literal> has been generated using <literal>coq_makefile</literal> so we only have to set the <literal>$COQLIB</literal> variable at install time.
on Coq. It builds on the Mathematical Components library, thus it also takes
<literal>mathcomp</literal> as <literal>buildInputs</literal>. Its
<literal>Makefile</literal> has been generated using
<literal>coq_makefile</literal> so we only have to set the
<literal>$COQLIB</literal> variable at install time.
</para> </para>
<programlisting> <programlisting>

185
doc/languages-frameworks/gnome.xml
View File

@ -5,53 +5,26 @@
<title>Packaging GNOME applications</title> <title>Packaging GNOME applications</title>
<para> <para>
Programs in the GNOME universe are written in various languages but they all Programs in the GNOME universe are written in various languages but they all use GObject-based libraries like GLib, GTK or GStreamer. These libraries are often modular, relying on looking into certain directories to find their modules. However, due to Nix’s specific file system organization, this will fail without our intervention. Fortunately, the libraries usually allow overriding the directories through environment variables, either natively or thanks to a patch in nixpkgs. <link xlink:href="#fun-wrapProgram">Wrapping</link> the executables to ensure correct paths are available to the application constitutes a significant part of packaging a modern desktop application. In this section, we will describe various modules needed by such applications, environment variables needed to make the modules load, and finally a script that will do the work for us.
use GObject-based libraries like GLib, GTK or GStreamer. These libraries are
often modular, relying on looking into certain directories to find their
modules. However, due to Nix’s specific file system organization, this
will fail without our intervention. Fortunately, the libraries usually allow
overriding the directories through environment variables, either natively or
thanks to a patch in nixpkgs.
<link xlink:href="#fun-wrapProgram">Wrapping</link> the executables to
ensure correct paths are available to the application constitutes a
significant part of packaging a modern desktop application. In this section,
we will describe various modules needed by such applications, environment
variables needed to make the modules load, and finally a script that will do
the work for us.
</para> </para>
<section xml:id="ssec-gnome-settings"> <section xml:id="ssec-gnome-settings">
<title>Settings</title> <title>Settings</title>
<para> <para>
<link xlink:href="https://developer.gnome.org/gio/stable/GSettings.html">GSettings</link> <link xlink:href="https://developer.gnome.org/gio/stable/GSettings.html">GSettings</link> 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 <filename>glib-2.0/schemas/gschemas.compiled</filename> files inside the directories of <envar>XDG_DATA_DIRS</envar>.
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
<filename>glib-2.0/schemas/gschemas.compiled</filename> files inside the
directories of <envar>XDG_DATA_DIRS</envar>.
</para> </para>
<para> <para>
On Linux, GSettings API is implemented using On Linux, GSettings API is implemented using <link xlink:href="https://wiki.gnome.org/Projects/dconf">dconf</link> backend. You will need to add <literal>dconf</literal> GIO module to <envar>GIO_EXTRA_MODULES</envar> variable, otherwise the <literal>memory</literal> backend will be used and the saved settings will not be persistent.
<link xlink:href="https://wiki.gnome.org/Projects/dconf">dconf</link>
backend. You will need to add <literal>dconf</literal> GIO module to
<envar>GIO_EXTRA_MODULES</envar> variable, otherwise the
<literal>memory</literal> backend will be used and the saved settings will
not be persistent.
</para> </para>
<para> <para>
Last you will need the dconf database D-Bus service itself. You can enable Last you will need the dconf database D-Bus service itself. You can enable it using <option>programs.dconf.enable</option>.
it using <option>programs.dconf.enable</option>.
</para> </para>
<para> <para>
Some applications will also require Some applications will also require <package>gsettings-desktop-schemas</package> for things like reading proxy configuration or user interface customization. This dependency is often not mentioned by upstream, you should grep for <literal>org.gnome.desktop</literal> and <literal>org.gnome.system</literal> to see if the schemas are needed.
<package>gsettings-desktop-schemas</package> for things like reading proxy
configuration or user interface customization. This dependency is often not
mentioned by upstream, you should grep for
<literal>org.gnome.desktop</literal> and
<literal>org.gnome.system</literal> to see if the schemas are needed.
</para> </para>
</section> </section>
@ -59,16 +32,7 @@
<title>Icons</title> <title>Icons</title>
<para> <para>
When an application uses icons, an icon theme should be available in When an application uses icons, an icon theme should be available in <envar>XDG_DATA_DIRS</envar>. The package for the default, icon-less <link xlink:href="https://www.freedesktop.org/wiki/Software/icon-theme/">hicolor-icon-theme</link> contains <link linkend="ssec-gnome-hooks-hicolor-icon-theme">a setup hook</link> that will pick up icon themes from <literal>buildInputs</literal> 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.
<envar>XDG_DATA_DIRS</envar>. The package for the default, icon-less
<link xlink:href="https://www.freedesktop.org/wiki/Software/icon-theme/">hicolor-icon-theme</link>
contains <link linkend="ssec-gnome-hooks-hicolor-icon-theme">a setup
hook</link> that will pick up icon themes from
<literal>buildInputs</literal> 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.
</para> </para>
</section> </section>
@ -76,12 +40,7 @@
<title>GTK Themes</title> <title>GTK Themes</title>
<para> <para>
Previously, a GTK theme needed to be in <envar>XDG_DATA_DIRS</envar>. This Previously, a GTK theme needed to be in <envar>XDG_DATA_DIRS</envar>. This is no longer necessary for most programs since GTK incorporated Adwaita theme. Some programs (for example, those designed for <link xlink:href="https://elementary.io/docs/human-interface-guidelines#human-interface-guidelines">elementary HIG</link>) might require a special theme like <package>pantheon.elementary-gtk-theme</package>.
is no longer necessary for most programs since GTK incorporated Adwaita
theme. Some programs (for example, those designed for
<link xlink:href="https://elementary.io/docs/human-interface-guidelines#human-interface-guidelines">elementary
HIG</link>) might require a special theme like
<package>pantheon.elementary-gtk-theme</package>.
</para> </para>
</section> </section>
@ -89,10 +48,7 @@
<title>GObject introspection typelibs</title> <title>GObject introspection typelibs</title>
<para> <para>
<link xlink:href="https://wiki.gnome.org/Projects/GObjectIntrospection">GObject <link xlink:href="https://wiki.gnome.org/Projects/GObjectIntrospection">GObject introspection</link> allows applications to use C libraries in other languages easily. It does this through <literal>typelib</literal> files searched in <envar>GI_TYPELIB_PATH</envar>.
introspection</link> allows applications to use C libraries in other
languages easily. It does this through <literal>typelib</literal> files
searched in <envar>GI_TYPELIB_PATH</envar>.
</para> </para>
</section> </section>
@ -100,11 +56,7 @@
<title>Various plug-ins</title> <title>Various plug-ins</title>
<para> <para>
If your application uses If your application uses <link xlink:href="https://gstreamer.freedesktop.org/">GStreamer</link> or <link xlink:href="https://wiki.gnome.org/Projects/Grilo">Grilo</link>, you should set <envar>GST_PLUGIN_SYSTEM_PATH_1_0</envar> and <envar>GRL_PLUGIN_PATH</envar>, respectively.
<link xlink:href="https://gstreamer.freedesktop.org/">GStreamer</link> or
<link xlink:href="https://wiki.gnome.org/Projects/Grilo">Grilo</link>, you
should set <envar>GST_PLUGIN_SYSTEM_PATH_1_0</envar> and
<envar>GRL_PLUGIN_PATH</envar>, respectively.
</para> </para>
</section> </section>
</section> </section>
@ -113,8 +65,7 @@
<title>Onto <package>wrapGAppsHook</package></title> <title>Onto <package>wrapGAppsHook</package></title>
<para> <para>
Given the requirements above, the package expression would become messy Given the requirements above, the package expression would become messy quickly:
quickly:
<programlisting> <programlisting>
preFixup = '' preFixup = ''
for f in $(find $out/bin/ $out/libexec/ -type f -executable); do for f in $(find $out/bin/ $out/libexec/ -type f -executable); do
@ -128,76 +79,48 @@ preFixup = ''
done done
''; '';
</programlisting> </programlisting>
Fortunately, there is <package>wrapGAppsHook</package>, that does the Fortunately, there is <package>wrapGAppsHook</package>, that does the wrapping for us. In particular, it works in conjunction with other setup hooks that will populate the variable:
wrapping for us. In particular, it works in conjunction with other setup
hooks that will populate the variable:
<itemizedlist> <itemizedlist>
<listitem xml:id="ssec-gnome-hooks-wrapgappshook"> <listitem xml:id="ssec-gnome-hooks-wrapgappshook">
<para> <para>
<package>wrapGAppsHook</package> itself will add the package’s <package>wrapGAppsHook</package> itself will add the package’s <filename>share</filename> directory to <envar>XDG_DATA_DIRS</envar>.
<filename>share</filename> directory to <envar>XDG_DATA_DIRS</envar>.
</para> </para>
</listitem> </listitem>
<listitem xml:id="ssec-gnome-hooks-glib"> <listitem xml:id="ssec-gnome-hooks-glib">
<para> <para>
<package>glib</package> setup hook will populate <package>glib</package> setup hook will populate <envar>GSETTINGS_SCHEMAS_PATH</envar> and then <package>wrapGAppsHook</package> will prepend it to <envar>XDG_DATA_DIRS</envar>.
<envar>GSETTINGS_SCHEMAS_PATH</envar> and then
<package>wrapGAppsHook</package> will prepend it to
<envar>XDG_DATA_DIRS</envar>.
</para> </para>
</listitem> </listitem>
<listitem xml:id="ssec-gnome-hooks-dconf"> <listitem xml:id="ssec-gnome-hooks-dconf">
<para> <para>
<package>gnome3.dconf.lib</package> is a dependency of <package>gnome3.dconf.lib</package> is a dependency of <package>wrapGAppsHook</package>, which then also adds it to the <envar>GIO_EXTRA_MODULES</envar> variable.
<package>wrapGAppsHook</package>, which then also adds it to the
<envar>GIO_EXTRA_MODULES</envar> variable.
</para> </para>
</listitem> </listitem>
<listitem xml:id="ssec-gnome-hooks-hicolor-icon-theme"> <listitem xml:id="ssec-gnome-hooks-hicolor-icon-theme">
<para> <para>
<package>hicolor-icon-theme</package>’s setup hook will add icon themes <package>hicolor-icon-theme</package>’s setup hook will add icon themes to <envar>XDG_ICON_DIRS</envar> which is prepended to <envar>XDG_DATA_DIRS</envar> by <package>wrapGAppsHook</package>.
to <envar>XDG_ICON_DIRS</envar> which is prepended to
<envar>XDG_DATA_DIRS</envar> by <package>wrapGAppsHook</package>.
</para> </para>
</listitem> </listitem>
<listitem xml:id="ssec-gnome-hooks-gobject-introspection"> <listitem xml:id="ssec-gnome-hooks-gobject-introspection">
<para> <para>
<package>gobject-introspection</package> setup hook populates <package>gobject-introspection</package> setup hook populates <envar>GI_TYPELIB_PATH</envar> variable with <filename>lib/girepository-1.0</filename> directories of dependencies, which is then added to wrapper by <package>wrapGAppsHook</package>. It also adds <filename>share</filename> directories of dependencies to <envar>XDG_DATA_DIRS</envar>, which is intended to promote GIR files but it also <link xlink:href="https://github.com/NixOS/nixpkgs/issues/32790">pollutes the closures</link> of packages using <package>wrapGAppsHook</package>.
<envar>GI_TYPELIB_PATH</envar> variable with
<filename>lib/girepository-1.0</filename> directories of dependencies,
which is then added to wrapper by <package>wrapGAppsHook</package>. It
also adds <filename>share</filename> directories of dependencies to
<envar>XDG_DATA_DIRS</envar>, which is intended to promote GIR files but
it also
<link xlink:href="https://github.com/NixOS/nixpkgs/issues/32790">pollutes
the closures</link> of packages using <package>wrapGAppsHook</package>.
</para> </para>
<warning> <warning>
<para> <para>
The setup hook The setup hook <link xlink:href="https://github.com/NixOS/nixpkgs/issues/56943">currently</link> does not work in expressions with <literal>strictDeps</literal> enabled, like Python packages. In those cases, you will need to disable it with <code>strictDeps = false;</code>.
<link xlink:href="https://github.com/NixOS/nixpkgs/issues/56943">currently</link>
does not work in expressions with <literal>strictDeps</literal> enabled,
like Python packages. In those cases, you will need to disable it with
<code>strictDeps = false;</code>.
</para> </para>
</warning> </warning>
</listitem> </listitem>
<listitem xml:id="ssec-gnome-hooks-gst-grl-plugins"> <listitem xml:id="ssec-gnome-hooks-gst-grl-plugins">
<para> <para>
Setup hooks of <package>gst_all_1.gstreamer</package> and Setup hooks of <package>gst_all_1.gstreamer</package> and <package>gnome3.grilo</package> will populate the <envar>GST_PLUGIN_SYSTEM_PATH_1_0</envar> and <envar>GRL_PLUGIN_PATH</envar> variables, respectively, which will then be added to the wrapper by <literal>wrapGAppsHook</literal>.
<package>gnome3.grilo</package> will populate the
<envar>GST_PLUGIN_SYSTEM_PATH_1_0</envar> and
<envar>GRL_PLUGIN_PATH</envar> variables, respectively, which will then
be added to the wrapper by <literal>wrapGAppsHook</literal>.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</para> </para>
<para> <para>
You can also pass additional arguments to <literal>makeWrapper</literal> You can also pass additional arguments to <literal>makeWrapper</literal> using <literal>gappsWrapperArgs</literal> in <literal>preFixup</literal> hook:
using <literal>gappsWrapperArgs</literal> in <literal>preFixup</literal>
hook:
<programlisting> <programlisting>
preFixup = '' preFixup = ''
gappsWrapperArgs+=( gappsWrapperArgs+=(
@ -215,13 +138,7 @@ preFixup = ''
<title>Updating GNOME packages</title> <title>Updating GNOME packages</title>
<para> <para>
Most GNOME package offer Most GNOME package offer <link linkend="var-passthru-updateScript"><literal>updateScript</literal></link>, it is therefore possible to update to latest source tarball by running <command>nix-shell maintainers/scripts/update.nix --argstr package gnome3.nautilus</command> or even en masse with <command>nix-shell maintainers/scripts/update.nix --argstr path gnome3</command>. Read the package’s <filename>NEWS</filename> file to see what changed.
<link linkend="var-passthru-updateScript"><literal>updateScript</literal></link>,
it is therefore possible to update to latest source tarball by running
<command>nix-shell maintainers/scripts/update.nix --argstr package
gnome3.nautilus</command> or even en masse with <command>nix-shell
maintainers/scripts/update.nix --argstr path gnome3</command>. Read the
package’s <filename>NEWS</filename> file to see what changed.
</para> </para>
</section> </section>
@ -235,17 +152,7 @@ preFixup = ''
</term> </term>
<listitem> <listitem>
<para> <para>
There are no schemas avalable in <envar>XDG_DATA_DIRS</envar>. There are no schemas avalable in <envar>XDG_DATA_DIRS</envar>. Temporarily add a random package containing schemas like <package>gsettings-desktop-schemas</package> to <literal>buildInputs</literal>. <link linkend="ssec-gnome-hooks-glib"><package>glib</package></link> and <link linkend="ssec-gnome-hooks-wrapgappshook"><package>wrapGAppsHook</package></link> setup hooks will take care of making the schemas available to application and you will see the actual missing schemas with the <link linkend="ssec-gnome-common-issues-missing-schema">next error</link>. Or you can try looking through the source code for the actual schemas used.
Temporarily add a random package containing schemas like
<package>gsettings-desktop-schemas</package> to
<literal>buildInputs</literal>.
<link linkend="ssec-gnome-hooks-glib"><package>glib</package></link> and
<link linkend="ssec-gnome-hooks-wrapgappshook"><package>wrapGAppsHook</package></link>
setup hooks will take care of making the schemas available to application
and you will see the actual missing schemas with the
<link linkend="ssec-gnome-common-issues-missing-schema">next
error</link>. Or you can try looking through the source code for the
actual schemas used.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -255,11 +162,7 @@ preFixup = ''
</term> </term>
<listitem> <listitem>
<para> <para>
Package is missing some GSettings schemas. You can find out the package Package is missing some GSettings schemas. You can find out the package containing the schema with <command>nix-locate <replaceable>org.gnome.foo</replaceable>.gschema.xml</command> and let the hooks handle the wrapping as <link linkend="ssec-gnome-common-issues-no-schemas">above</link>.
containing the schema with <command>nix-locate
<replaceable>org.gnome.foo</replaceable>.gschema.xml</command> and let
the hooks handle the wrapping as
<link linkend="ssec-gnome-common-issues-no-schemas">above</link>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -269,14 +172,7 @@ preFixup = ''
</term> </term>
<listitem> <listitem>
<para> <para>
This is because derivers like This is because derivers like <function>python.pkgs.buildPythonApplication</function> or <function>qt5.mkDerivation</function> have setup-hooks automatically added that produce wrappers with <package>makeWrapper</package>. The simplest way to workaround that is to disable the <package>wrapGAppsHook</package> automatic wrapping with <code>dontWrapGApps = true;</code> and pass the arguments it intended to pass to <package>makeWrapper</package> to another.
<function>python.pkgs.buildPythonApplication</function> or
<function>qt5.mkDerivation</function> have setup-hooks automatically
added that produce wrappers with <package>makeWrapper</package>. The
simplest way to workaround that is to disable the
<package>wrapGAppsHook</package> automatic wrapping with
<code>dontWrapGApps = true;</code> and pass the arguments it intended to
pass to <package>makeWrapper</package> to another.
</para> </para>
<para> <para>
In the case of a Python application it could look like: In the case of a Python application it could look like:
@ -328,55 +224,34 @@ mkDerivation {
</term> </term>
<listitem> <listitem>
<para> <para>
You can rely on applications depending on the library set the necessary You can rely on applications depending on the library set the necessary environment variables but that it often easy to miss. Instead we recommend to patch the paths in the source code whenever possible. Here are some examples:
environment variables but that it often easy to miss. Instead we
recommend to patch the paths in the source code whenever possible. Here
are some examples:
<itemizedlist> <itemizedlist>
<listitem xml:id="ssec-gnome-common-issues-unwrappable-package-gnome-shell-ext"> <listitem xml:id="ssec-gnome-common-issues-unwrappable-package-gnome-shell-ext">
<para> <para>
<link xlink:href="https://github.com/NixOS/nixpkgs/blob/7bb8f05f12ca3cff9da72b56caa2f7472d5732bc/pkgs/desktops/gnome-3/core/gnome-shell-extensions/default.nix#L21-L24">Replacing <link xlink:href="https://github.com/NixOS/nixpkgs/blob/7bb8f05f12ca3cff9da72b56caa2f7472d5732bc/pkgs/desktops/gnome-3/core/gnome-shell-extensions/default.nix#L21-L24">Replacing a <envar>GI_TYPELIB_PATH</envar> in GNOME Shell extension</link> – we are using <function>substituteAll</function> to include the path to a typelib into a patch.
a <envar>GI_TYPELIB_PATH</envar> in GNOME Shell extension</link> –
we are using <function>substituteAll</function> to include the path to
a typelib into a patch.
</para> </para>
</listitem> </listitem>
<listitem xml:id="ssec-gnome-common-issues-unwrappable-package-gsettings"> <listitem xml:id="ssec-gnome-common-issues-unwrappable-package-gsettings">
<para> <para>
The following examples are hardcoding GSettings schema paths. To get The following examples are hardcoding GSettings schema paths. To get the schema paths we use the functions
the schema paths we use the functions
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
<function>glib.getSchemaPath</function> Takes a nix package <function>glib.getSchemaPath</function> Takes a nix package attribute as an argument.
attribute as an argument.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<function>glib.makeSchemaPath</function> Takes a package output <function>glib.makeSchemaPath</function> Takes a package output like <literal>$out</literal> and a derivation name. You should use this if the schemas you need to hardcode are in the same derivation.
like <literal>$out</literal> and a derivation name. You should use
this if the schemas you need to hardcode are in the same
derivation.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</para> </para>
<para xml:id="ssec-gnome-common-issues-unwrappable-package-gsettings-vala"> <para xml:id="ssec-gnome-common-issues-unwrappable-package-gsettings-vala">
<link xlink:href="https://github.com/NixOS/nixpkgs/blob/7bb8f05f12ca3cff9da72b56caa2f7472d5732bc/pkgs/desktops/pantheon/apps/elementary-files/default.nix#L78-L86">Hard-coding <link xlink:href="https://github.com/NixOS/nixpkgs/blob/7bb8f05f12ca3cff9da72b56caa2f7472d5732bc/pkgs/desktops/pantheon/apps/elementary-files/default.nix#L78-L86">Hard-coding GSettings schema path in Vala plug-in (dynamically loaded library)</link> – here, <function>substituteAll</function> cannot be used since the schema comes from the same package preventing us from pass its path to the function, probably due to a <link xlink:href="https://github.com/NixOS/nix/issues/1846">Nix bug</link>.
GSettings schema path in Vala plug-in (dynamically loaded
library)</link> – here, <function>substituteAll</function> cannot be
used since the schema comes from the same package preventing us from
pass its path to the function, probably due to a
<link xlink:href="https://github.com/NixOS/nix/issues/1846">Nix
bug</link>.
</para> </para>
<para xml:id="ssec-gnome-common-issues-unwrappable-package-gsettings-c"> <para xml:id="ssec-gnome-common-issues-unwrappable-package-gsettings-c">
<link xlink:href="https://github.com/NixOS/nixpkgs/blob/29c120c065d03b000224872251bed93932d42412/pkgs/development/libraries/glib-networking/default.nix#L31-L34">Hard-coding <link xlink:href="https://github.com/NixOS/nixpkgs/blob/29c120c065d03b000224872251bed93932d42412/pkgs/development/libraries/glib-networking/default.nix#L31-L34">Hard-coding GSettings schema path in C library</link> – nothing special other than using <link xlink:href="https://github.com/NixOS/nixpkgs/pull/67957#issuecomment-527717467">Coccinelle patch</link> to generate the patch itself.
GSettings schema path in C library</link> – nothing special other
than using
<link xlink:href="https://github.com/NixOS/nixpkgs/pull/67957#issuecomment-527717467">Coccinelle
patch</link> to generate the patch itself.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>

73
doc/languages-frameworks/go.xml
View File

@ -7,21 +7,16 @@
<title>Go modules</title> <title>Go modules</title>
<para> <para>
The function <varname> buildGoModule </varname> builds Go programs managed The function <varname> buildGoModule </varname> builds Go programs managed with Go modules. It builds a <link xlink:href="https://github.com/golang/go/wiki/Modules">Go modules</link> through a two phase build:
with Go modules. It builds a
<link xlink:href="https://github.com/golang/go/wiki/Modules">Go
modules</link> through a two phase build:
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
An intermediate fetcher derivation. This derivation will be used to fetch An intermediate fetcher derivation. This derivation will be used to fetch all of the dependencies of the Go module.
all of the dependencies of the Go module.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
A final derivation will use the output of the intermediate derivation to A final derivation will use the output of the intermediate derivation to build the binaries and produce the final output.
build the binaries and produce the final output.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -57,21 +52,16 @@ pet = buildGoModule rec {
</example> </example>
<para> <para>
<xref linkend='ex-buildGoModule'/> is an example expression using <xref linkend='ex-buildGoModule'/> is an example expression using buildGoModule, the following arguments are of special significance to the function:
buildGoModule, the following arguments are of special significance to the
function:
<calloutlist> <calloutlist>
<callout arearefs='ex-buildGoModule-1'> <callout arearefs='ex-buildGoModule-1'>
<para> <para>
<varname>modSha256</varname> is the hash of the output of the <varname>modSha256</varname> is the hash of the output of the intermediate fetcher derivation.
intermediate fetcher derivation.
</para> </para>
</callout> </callout>
<callout arearefs='ex-buildGoModule-2'> <callout arearefs='ex-buildGoModule-2'>
<para> <para>
<varname>subPackages</varname> limits the builder from building child <varname>subPackages</varname> 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.
packages that have not been listed. If <varname>subPackages</varname> is
not specified, all child packages will be built.
</para> </para>
</callout> </callout>
</calloutlist> </calloutlist>
@ -82,8 +72,7 @@ pet = buildGoModule rec {
<title>Go legacy</title> <title>Go legacy</title>
<para> <para>
The function <varname> buildGoPackage </varname> builds legacy Go programs, The function <varname> buildGoPackage </varname> builds legacy Go programs, not supporting Go modules.
not supporting Go modules.
</para> </para>
<example xml:id='ex-buildGoPackage'> <example xml:id='ex-buildGoPackage'>
@ -111,49 +100,36 @@ deis = buildGoPackage rec {
</example> </example>
<para> <para>
<xref linkend='ex-buildGoPackage'/> is an example expression using <xref linkend='ex-buildGoPackage'/> is an example expression using buildGoPackage, the following arguments are of special significance to the function:
buildGoPackage, the following arguments are of special significance to the
function:
<calloutlist> <calloutlist>
<callout arearefs='ex-buildGoPackage-1'> <callout arearefs='ex-buildGoPackage-1'>
<para> <para>
<varname>goPackagePath</varname> specifies the package's canonical Go <varname>goPackagePath</varname> specifies the package's canonical Go import path.
import path.
</para> </para>
</callout> </callout>
<callout arearefs='ex-buildGoPackage-2'> <callout arearefs='ex-buildGoPackage-2'>
<para> <para>
<varname>subPackages</varname> limits the builder from building child <varname>subPackages</varname> 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.
packages that have not been listed. If <varname>subPackages</varname> is
not specified, all child packages will be built.
</para> </para>
<para> <para>
In this example only <literal>github.com/deis/deis/client</literal> will In this example only <literal>github.com/deis/deis/client</literal> will be built.
be built.
</para> </para>
</callout> </callout>
<callout arearefs='ex-buildGoPackage-3'> <callout arearefs='ex-buildGoPackage-3'>
<para> <para>
<varname>goDeps</varname> is where the Go dependencies of a Go program <varname>goDeps</varname> is where the Go dependencies of a Go program are listed as a list of package source identified by Go import path. It could be imported as a separate <varname>deps.nix</varname> file for readability. The dependency data structure is described below.
are listed as a list of package source identified by Go import path. It
could be imported as a separate <varname>deps.nix</varname> file for
readability. The dependency data structure is described below.
</para> </para>
</callout> </callout>
<callout arearefs='ex-buildGoPackage-4'> <callout arearefs='ex-buildGoPackage-4'>
<para> <para>
<varname>buildFlags</varname> is a list of flags passed to the go build <varname>buildFlags</varname> is a list of flags passed to the go build command.
command.
</para> </para>
</callout> </callout>
</calloutlist> </calloutlist>
</para> </para>
<para> <para>
The <varname>goDeps</varname> attribute can be imported from a separate The <varname>goDeps</varname> attribute can be imported from a separate <varname>nix</varname> file that defines which Go libraries are needed and should be included in <varname>GOPATH</varname> for <varname>buildPhase</varname>.
<varname>nix</varname> file that defines which Go libraries are needed and
should be included in <varname>GOPATH</varname> for
<varname>buildPhase</varname>.
</para> </para>
<example xml:id='ex-goDeps'> <example xml:id='ex-goDeps'>
@ -196,27 +172,18 @@ deis = buildGoPackage rec {
</callout> </callout>
<callout arearefs='ex-goDeps-3'> <callout arearefs='ex-goDeps-3'>
<para> <para>
<varname>fetch type</varname> that needs to be used to get package <varname>fetch type</varname> that needs to be used to get package source. If <varname>git</varname> is used there should be <varname>url</varname>, <varname>rev</varname> and <varname>sha256</varname> defined next to it.
source. If <varname>git</varname> is used there should be
<varname>url</varname>, <varname>rev</varname> and
<varname>sha256</varname> defined next to it.
</para> </para>
</callout> </callout>
</calloutlist> </calloutlist>
</para> </para>
<para> <para>
To extract dependency information from a Go package in automated way use To extract dependency information from a Go package in automated way use <link xlink:href="https://github.com/kamilchm/go2nix">go2nix</link>. It can produce complete derivation and <varname>goDeps</varname> file for Go programs.
<link xlink:href="https://github.com/kamilchm/go2nix">go2nix</link>. It can
produce complete derivation and <varname>goDeps</varname> file for Go
programs.
</para> </para>
<para> <para>
<varname>buildGoPackage</varname> produces <varname>buildGoPackage</varname> produces <xref linkend='chap-multiple-output' xrefstyle="select: title" /> where <varname>bin</varname> includes program binaries. You can test build a Go binary as follows:
<xref linkend='chap-multiple-output' xrefstyle="select: title" /> where
<varname>bin</varname> includes program binaries. You can test build a Go
binary as follows:
<screen> <screen>
<prompt>$ </prompt>nix-build -A deis.bin <prompt>$ </prompt>nix-build -A deis.bin
</screen> </screen>
@ -224,13 +191,11 @@ deis = buildGoPackage rec {
<screen> <screen>
<prompt>$ </prompt>nix-build -A deis.all <prompt>$ </prompt>nix-build -A deis.all
</screen> </screen>
<varname>bin</varname> output will be installed by default with <varname>bin</varname> output will be installed by default with <varname>nix-env -i</varname> or <varname>systemPackages</varname>.
<varname>nix-env -i</varname> or <varname>systemPackages</varname>.
</para> </para>
<para> <para>
You may use Go packages installed into the active Nix profiles by adding the You may use Go packages installed into the active Nix profiles by adding the following to your ~/.bashrc:
following to your ~/.bashrc:
<screen> <screen>
for p in $NIX_PROFILES; do for p in $NIX_PROFILES; do
GOPATH="$p/share/go:$GOPATH" GOPATH="$p/share/go:$GOPATH"

7
doc/languages-frameworks/index.xml
View File

@ -3,12 +3,7 @@
xml:id="chap-language-support"> xml:id="chap-language-support">
<title>Support for specific programming languages and frameworks</title> <title>Support for specific programming languages and frameworks</title>
<para> <para>
The <link linkend="chap-stdenv">standard build environment</link> makes it The <link linkend="chap-stdenv">standard build environment</link> makes it easy to build typical Autotools-based packages with very little code. Any other kind of package can be accomodated by overriding the appropriate phases of <literal>stdenv</literal>. However, there are specialised functions in Nixpkgs to easily build packages for other programming languages, such as Perl or Haskell. These are described in this chapter.
easy to build typical Autotools-based packages with very little code. Any
other kind of package can be accomodated by overriding the appropriate phases
of <literal>stdenv</literal>. However, there are specialised functions in
Nixpkgs to easily build packages for other programming languages, such as
Perl or Haskell. These are described in this chapter.
</para> </para>
<xi:include href="android.section.xml" /> <xi:include href="android.section.xml" />
<xi:include href="beam.xml" /> <xi:include href="beam.xml" />

40
doc/languages-frameworks/java.xml
View File

@ -15,37 +15,24 @@ stdenv.mkDerivation {
buildPhase = "ant"; buildPhase = "ant";
} }
</programlisting> </programlisting>
Note that <varname>jdk</varname> is an alias for the OpenJDK (self-built Note that <varname>jdk</varname> is an alias for the OpenJDK (self-built where available, or pre-built via Zulu). Platforms with OpenJDK not (yet) in Nixpkgs (<literal>Aarch32</literal>, <literal>Aarch64</literal>) point to the (unfree) <literal>oraclejdk</literal>.
where available, or pre-built via Zulu). Platforms with OpenJDK not (yet) in
Nixpkgs (<literal>Aarch32</literal>, <literal>Aarch64</literal>) point to the
(unfree) <literal>oraclejdk</literal>.
</para> </para>
<para> <para>
JAR files that are intended to be used by other packages should be installed JAR files that are intended to be used by other packages should be installed in <filename>$out/share/java</filename>. JDKs have a stdenv setup hook that add any JARs in the <filename>share/java</filename> directories of the build inputs to the <envar>CLASSPATH</envar> environment variable. For instance, if the package <literal>libfoo</literal> installs a JAR named <filename>foo.jar</filename> in its <filename>share/java</filename> directory, and another package declares the attribute
in <filename>$out/share/java</filename>. JDKs have a stdenv setup hook that
add any JARs in the <filename>share/java</filename> directories of the build
inputs to the <envar>CLASSPATH</envar> environment variable. For instance, if
the package <literal>libfoo</literal> installs a JAR named
<filename>foo.jar</filename> in its <filename>share/java</filename>
directory, and another package declares the attribute
<programlisting> <programlisting>
buildInputs = [ libfoo ]; buildInputs = [ libfoo ];
nativeBuildInputs = [ jdk ]; nativeBuildInputs = [ jdk ];
</programlisting> </programlisting>
then <envar>CLASSPATH</envar> will be set to then <envar>CLASSPATH</envar> will be set to <filename>/nix/store/...-libfoo/share/java/foo.jar</filename>.
<filename>/nix/store/...-libfoo/share/java/foo.jar</filename>.
</para> </para>
<para> <para>
Private JARs should be installed in a location like Private JARs should be installed in a location like <filename>$out/share/<replaceable>package-name</replaceable></filename>.
<filename>$out/share/<replaceable>package-name</replaceable></filename>.
</para> </para>
<para> <para>
If your Java package provides a program, you need to generate a wrapper If your Java package provides a program, you need to generate a wrapper script to run it using the OpenJRE. You can use <literal>makeWrapper</literal> for this:
script to run it using the OpenJRE. You can use
<literal>makeWrapper</literal> for this:
<programlisting> <programlisting>
nativeBuildInputs = [ makeWrapper ]; nativeBuildInputs = [ makeWrapper ];
@ -56,30 +43,21 @@ installPhase =
--add-flags "-cp $out/share/java/foo.jar org.foo.Main" --add-flags "-cp $out/share/java/foo.jar org.foo.Main"
''; '';
</programlisting> </programlisting>
Note the use of <literal>jre</literal>, which is the part of the OpenJDK Note the use of <literal>jre</literal>, which is the part of the OpenJDK package that contains the Java Runtime Environment. By using <literal>${jre}/bin/java</literal> instead of <literal>${jdk}/bin/java</literal>, you prevent your package from depending on the JDK at runtime.
package that contains the Java Runtime Environment. By using
<literal>${jre}/bin/java</literal> instead of
<literal>${jdk}/bin/java</literal>, you prevent your package from depending
on the JDK at runtime.
</para> </para>
<para> <para>
Note all JDKs passthru <literal>home</literal>, so if your application Note all JDKs passthru <literal>home</literal>, so if your application requires environment variables like <envar>JAVA_HOME</envar> being set, that can be done in a generic fashion with the <literal>--set</literal> argument of <literal>makeWrapper</literal>:
requires environment variables like <envar>JAVA_HOME</envar> being set, that
can be done in a generic fashion with the <literal>--set</literal> argument
of <literal>makeWrapper</literal>:
<programlisting> <programlisting>
--set JAVA_HOME ${jdk.home} --set JAVA_HOME ${jdk.home}
</programlisting> </programlisting>
</para> </para>
<para> <para>
It is possible to use a different Java compiler than <command>javac</command> It is possible to use a different Java compiler than <command>javac</command> from the OpenJDK. For instance, to use the GNU Java Compiler:
from the OpenJDK. For instance, to use the GNU Java Compiler:
<programlisting> <programlisting>
nativeBuildInputs = [ gcj ant ]; nativeBuildInputs = [ gcj ant ];
</programlisting> </programlisting>
Here, Ant will automatically use <command>gij</command> (the GNU Java Here, Ant will automatically use <command>gij</command> (the GNU Java Runtime) instead of the OpenJRE.
Runtime) instead of the OpenJRE.
</para> </para>
</section> </section>

20
doc/languages-frameworks/lua.xml
View File

@ -4,18 +4,11 @@
<title>Lua</title> <title>Lua</title>
<para> <para>
Lua packages are built by the <varname>buildLuaPackage</varname> function. Lua packages are built by the <varname>buildLuaPackage</varname> function. This function is implemented in <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/lua-modules/generic/default.nix"> <filename>pkgs/development/lua-modules/generic/default.nix</filename></link> and works similarly to <varname>buildPerlPackage</varname>. (See <xref linkend="sec-language-perl"/> for details.)
This function is implemented in
<link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/lua-modules/generic/default.nix">
<filename>pkgs/development/lua-modules/generic/default.nix</filename></link>
and works similarly to <varname>buildPerlPackage</varname>. (See
<xref linkend="sec-language-perl"/> for details.)
</para> </para>
<para> <para>
Lua packages are defined in Lua packages are defined in <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/top-level/lua-packages.nix"><filename>pkgs/top-level/lua-packages.nix</filename></link>. Most of them are simple. For example:
<link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/top-level/lua-packages.nix"><filename>pkgs/top-level/lua-packages.nix</filename></link>.
Most of them are simple. For example:
<programlisting> <programlisting>
fileSystem = buildLuaPackage { fileSystem = buildLuaPackage {
name = "filesystem-1.6.2"; name = "filesystem-1.6.2";
@ -33,16 +26,11 @@ fileSystem = buildLuaPackage {
</para> </para>
<para> <para>
Though, more complicated package should be placed in a seperate file in Though, more complicated package should be placed in a seperate file in <link
<link
xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/lua-modules"><filename>pkgs/development/lua-modules</filename></link>. xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/lua-modules"><filename>pkgs/development/lua-modules</filename></link>.
</para> </para>
<para> <para>
Lua packages accept additional parameter <varname>disabled</varname>, which Lua packages accept additional parameter <varname>disabled</varname>, which defines the condition of disabling package from luaPackages. For example, if package has <varname>disabled</varname> assigned to <literal>lua.luaversion != "5.1"</literal>, it will not be included in any luaPackages except lua51Packages, making it only be built for lua 5.1.
defines the condition of disabling package from luaPackages. For example, if
package has <varname>disabled</varname> assigned to <literal>lua.luaversion
!= "5.1"</literal>, it will not be included in any luaPackages except
lua51Packages, making it only be built for lua 5.1.
</para> </para>
</section> </section>

32
doc/languages-frameworks/ocaml.xml
View File

@ -4,35 +4,15 @@
<title>OCaml</title> <title>OCaml</title>
<para> <para>
OCaml libraries should be installed in OCaml libraries should be installed in <literal>$(out)/lib/ocaml/${ocaml.version}/site-lib/</literal>. Such directories are automatically added to the <literal>$OCAMLPATH</literal> environment variable when building another package that depends on them or when opening a <literal>nix-shell</literal>.
<literal>$(out)/lib/ocaml/${ocaml.version}/site-lib/</literal>. Such
directories are automatically added to the <literal>$OCAMLPATH</literal>
environment variable when building another package that depends on them or
when opening a <literal>nix-shell</literal>.
</para> </para>
<para> <para>
Given that most of the OCaml ecosystem is now built with dune, nixpkgs Given that most of the OCaml ecosystem is now built with dune, nixpkgs includes a convenience build support function called <literal>buildDunePackage</literal> that will build an OCaml package using dune, OCaml and findlib and any additional dependencies provided as <literal>buildInputs</literal> or <literal>propagatedBuildInputs</literal>.
includes a convenience build support function called
<literal>buildDunePackage</literal> that will build an OCaml package using
dune, OCaml and findlib and any additional dependencies provided as
<literal>buildInputs</literal> or <literal>propagatedBuildInputs</literal>.
</para> </para>
<para> <para>
Here is a simple package example. It defines an (optional) attribute Here is a simple package example. It defines an (optional) attribute <literal>minimumOCamlVersion</literal> that will be used to throw a descriptive evaluation error if building with an older OCaml is attempted. It uses the <literal>fetchFromGitHub</literal> fetcher to get its source. It sets the <literal>doCheck</literal> (optional) attribute to <literal>true</literal> which means that tests will be run with <literal>dune runtest -p angstrom</literal> after the build (<literal>dune build -p angstrom</literal>) is complete. It uses <literal>alcotest</literal> as a build input (because it is needed to run the tests) and <literal>bigstringaf</literal> and <literal>result</literal> as propagated build inputs (thus they will also be available to libraries depending on this library). The library will be installed using the <literal>angstrom.install</literal> file that dune generates.
<literal>minimumOCamlVersion</literal> that will be used to throw a
descriptive evaluation error if building with an older OCaml is attempted. It
uses the <literal>fetchFromGitHub</literal> fetcher to get its source. It
sets the <literal>doCheck</literal> (optional) attribute to
<literal>true</literal> which means that tests will be run with <literal>dune
runtest -p angstrom</literal> after the build (<literal>dune build -p
angstrom</literal>) is complete. It uses <literal>alcotest</literal> as a
build input (because it is needed to run the tests) and
<literal>bigstringaf</literal> and <literal>result</literal> as propagated
build inputs (thus they will also be available to libraries depending on this
library). The library will be installed using the
<literal>angstrom.install</literal> file that dune generates.
</para> </para>
<programlisting> <programlisting>
@ -65,11 +45,7 @@ buildDunePackage rec {
</programlisting> </programlisting>
<para> <para>
Here is a second example, this time using a source archive generated with Here is a second example, this time using a source archive generated with <literal>dune-release</literal>. It is a good idea to use this archive when it is available as it will usually contain substituted variables such as a <literal>%%VERSION%%</literal> field. This library does not depend on any other OCaml library and no tests are run after building it.
<literal>dune-release</literal>. It is a good idea to use this archive when
it is available as it will usually contain substituted variables such as a
<literal>%%VERSION%%</literal> field. This library does not depend on any
other OCaml library and no tests are run after building it.
</para> </para>
<programlisting> <programlisting>

98
doc/languages-frameworks/perl.xml
View File

@ -4,24 +4,13 @@
<title>Perl</title> <title>Perl</title>
<para> <para>
Nixpkgs provides a function <varname>buildPerlPackage</varname>, a generic Nixpkgs provides a function <varname>buildPerlPackage</varname>, a generic package builder function for any Perl package that has a standard <varname>Makefile.PL</varname>. It’s implemented in <link
package builder function for any Perl package that has a standard
<varname>Makefile.PL</varname>. It’s implemented in
<link
xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/perl-modules/generic"><filename>pkgs/development/perl-modules/generic</filename></link>. xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/perl-modules/generic"><filename>pkgs/development/perl-modules/generic</filename></link>.
</para> </para>
<para> <para>
Perl packages from CPAN are defined in Perl packages from CPAN are defined in <link
<link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/top-level/perl-packages.nix"><filename>pkgs/top-level/perl-packages.nix</filename></link>, rather than <filename>pkgs/all-packages.nix</filename>. Most Perl packages are so straight-forward to build that they are defined here directly, rather than having a separate function for each package called from <filename>perl-packages.nix</filename>. However, more complicated packages should be put in a separate file, typically in <filename>pkgs/development/perl-modules</filename>. Here is an example of the former:
xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/top-level/perl-packages.nix"><filename>pkgs/top-level/perl-packages.nix</filename></link>,
rather than <filename>pkgs/all-packages.nix</filename>. Most Perl packages
are so straight-forward to build that they are defined here directly, rather
than having a separate function for each package called from
<filename>perl-packages.nix</filename>. However, more complicated packages
should be put in a separate file, typically in
<filename>pkgs/development/perl-modules</filename>. Here is an example of the
former:
<programlisting> <programlisting>
ClassC3 = buildPerlPackage rec { ClassC3 = buildPerlPackage rec {
name = "Class-C3-0.21"; name = "Class-C3-0.21";
@ -31,32 +20,22 @@ ClassC3 = buildPerlPackage rec {
}; };
}; };
</programlisting> </programlisting>
Note the use of <literal>mirror://cpan/</literal>, and the Note the use of <literal>mirror://cpan/</literal>, and the <literal>${name}</literal> in the URL definition to ensure that the name attribute is consistent with the source that we’re actually downloading. Perl packages are made available in <filename>all-packages.nix</filename> through the variable <varname>perlPackages</varname>. For instance, if you have a package that needs <varname>ClassC3</varname>, you would typically write
<literal>${name}</literal> in the URL definition to ensure that the name
attribute is consistent with the source that we’re actually downloading.
Perl packages are made available in <filename>all-packages.nix</filename>
through the variable <varname>perlPackages</varname>. For instance, if you
have a package that needs <varname>ClassC3</varname>, you would typically
write
<programlisting> <programlisting>
foo = import ../path/to/foo.nix { foo = import ../path/to/foo.nix {
inherit stdenv fetchurl ...; inherit stdenv fetchurl ...;
inherit (perlPackages) ClassC3; inherit (perlPackages) ClassC3;
}; };
</programlisting> </programlisting>
in <filename>all-packages.nix</filename>. You can test building a Perl in <filename>all-packages.nix</filename>. You can test building a Perl package as follows:
package as follows:
<screen> <screen>
<prompt>$ </prompt>nix-build -A perlPackages.ClassC3 <prompt>$ </prompt>nix-build -A perlPackages.ClassC3
</screen> </screen>
<varname>buildPerlPackage</varname> adds <literal>perl-</literal> to the <varname>buildPerlPackage</varname> adds <literal>perl-</literal> to the start of the name attribute, so the package above is actually called <literal>perl-Class-C3-0.21</literal>. So to install it, you can say:
start of the name attribute, so the package above is actually called
<literal>perl-Class-C3-0.21</literal>. So to install it, you can say:
<screen> <screen>
<prompt>$ </prompt>nix-env -i perl-Class-C3 <prompt>$ </prompt>nix-env -i perl-Class-C3
</screen> </screen>
(Of course you can also install using the attribute name: <literal>nix-env -i (Of course you can also install using the attribute name: <literal>nix-env -i -A perlPackages.ClassC3</literal>.)
-A perlPackages.ClassC3</literal>.)
</para> </para>
<para> <para>
@ -64,40 +43,24 @@ foo = import ../path/to/foo.nix {
<orderedlist> <orderedlist>
<listitem> <listitem>
<para> <para>
In the configure phase, it calls <literal>perl Makefile.PL</literal> to In the configure phase, it calls <literal>perl Makefile.PL</literal> to generate a Makefile. You can set the variable <varname>makeMakerFlags</varname> to pass flags to <filename>Makefile.PL</filename>
generate a Makefile. You can set the variable
<varname>makeMakerFlags</varname> to pass flags to
<filename>Makefile.PL</filename>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
It adds the contents of the <envar>PERL5LIB</envar> environment variable It adds the contents of the <envar>PERL5LIB</envar> environment variable to <literal>#! .../bin/perl</literal> line of Perl scripts as <literal>-I<replaceable>dir</replaceable></literal> flags. This ensures that a script can find its dependencies. (This can cause this shebang line to become too long for Darwin to handle; see the note below.)
to <literal>#! .../bin/perl</literal> line of Perl scripts as
<literal>-I<replaceable>dir</replaceable></literal> flags. This ensures
that a script can find its dependencies. (This can cause this shebang line
to become too long for Darwin to handle; see the note below.)
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
In the fixup phase, it writes the propagated build inputs In the fixup phase, it writes the propagated build inputs (<varname>propagatedBuildInputs</varname>) to the file <filename>$out/nix-support/propagated-user-env-packages</filename>. <command>nix-env</command> recursively installs all packages listed in this file when you install a package that has it. This ensures that a Perl package can find its dependencies.
(<varname>propagatedBuildInputs</varname>) to the file
<filename>$out/nix-support/propagated-user-env-packages</filename>.
<command>nix-env</command> recursively installs all packages listed in
this file when you install a package that has it. This ensures that a Perl
package can find its dependencies.
</para> </para>
</listitem> </listitem>
</orderedlist> </orderedlist>
</para> </para>
<para> <para>
<varname>buildPerlPackage</varname> is built on top of <varname>buildPerlPackage</varname> is built on top of <varname>stdenv</varname>, so everything can be customised in the usual way. For instance, the <literal>BerkeleyDB</literal> module has a <varname>preConfigure</varname> hook to generate a configuration file used by <filename>Makefile.PL</filename>:
<varname>stdenv</varname>, so everything can be customised in the usual way.
For instance, the <literal>BerkeleyDB</literal> module has a
<varname>preConfigure</varname> hook to generate a configuration file used by
<filename>Makefile.PL</filename>:
<programlisting> <programlisting>
{ buildPerlPackage, fetchurl, db }: { buildPerlPackage, fetchurl, db }:
@ -118,12 +81,7 @@ buildPerlPackage rec {
</para> </para>
<para> <para>
Dependencies on other Perl packages can be specified in the Dependencies on other Perl packages can be specified in the <varname>buildInputs</varname> and <varname>propagatedBuildInputs</varname> attributes. If something is exclusively a build-time dependency, use <varname>buildInputs</varname>; if it’s (also) a runtime dependency, use <varname>propagatedBuildInputs</varname>. For instance, this builds a Perl module that has runtime dependencies on a bunch of other modules:
<varname>buildInputs</varname> and <varname>propagatedBuildInputs</varname>
attributes. If something is exclusively a build-time dependency, use
<varname>buildInputs</varname>; if it’s (also) a runtime dependency, use
<varname>propagatedBuildInputs</varname>. For instance, this builds a Perl
module that has runtime dependencies on a bunch of other modules:
<programlisting> <programlisting>
ClassC3Componentised = buildPerlPackage rec { ClassC3Componentised = buildPerlPackage rec {
name = "Class-C3-Componentised-1.0004"; name = "Class-C3-Componentised-1.0004";
@ -139,11 +97,7 @@ ClassC3Componentised = buildPerlPackage rec {
</para> </para>
<para> <para>
On Darwin, if a script has too many On Darwin, if a script has too many <literal>-I<replaceable>dir</replaceable></literal> flags in its first line (its “shebang line”), it will not run. This can be worked around by calling the <literal>shortenPerlShebang</literal> function from the <literal>postInstall</literal> phase:
<literal>-I<replaceable>dir</replaceable></literal> flags in its first line
(its “shebang line”), it will not run. This can be worked around by
calling the <literal>shortenPerlShebang</literal> function from the
<literal>postInstall</literal> phase:
<programlisting> <programlisting>
{ stdenv, buildPerlPackage, fetchurl, shortenPerlShebang }: { stdenv, buildPerlPackage, fetchurl, shortenPerlShebang }:
@ -162,20 +116,14 @@ ImageExifTool = buildPerlPackage {
''; '';
}; };
</programlisting> </programlisting>
This will remove the <literal>-I</literal> flags from the shebang line, This will remove the <literal>-I</literal> flags from the shebang line, rewrite them in the <literal>use lib</literal> form, and put them on the next line instead. This function can be given any number of Perl scripts as arguments; it will modify them in-place.
rewrite them in the <literal>use lib</literal> form, and put them on the next
line instead. This function can be given any number of Perl scripts as
arguments; it will modify them in-place.
</para> </para>
<section xml:id="ssec-generation-from-CPAN"> <section xml:id="ssec-generation-from-CPAN">
<title>Generation from CPAN</title> <title>Generation from CPAN</title>
<para> <para>
Nix expressions for Perl packages can be generated (almost) automatically Nix expressions for Perl packages can be generated (almost) automatically from CPAN. This is done by the program <command>nix-generate-from-cpan</command>, which can be installed as follows:
from CPAN. This is done by the program
<command>nix-generate-from-cpan</command>, which can be installed as
follows:
</para> </para>
<screen> <screen>
@ -183,9 +131,7 @@ ImageExifTool = buildPerlPackage {
</screen> </screen>
<para> <para>
This program takes a Perl module name, looks it up on CPAN, fetches and This program takes a Perl module name, looks it up on CPAN, fetches and unpacks the corresponding package, and prints a Nix expression on standard output. For example:
unpacks the corresponding package, and prints a Nix expression on standard
output. For example:
<screen> <screen>
<prompt>$ </prompt>nix-generate-from-cpan XML::Simple <prompt>$ </prompt>nix-generate-from-cpan XML::Simple
XMLSimple = buildPerlPackage rec { XMLSimple = buildPerlPackage rec {
@ -201,9 +147,7 @@ ImageExifTool = buildPerlPackage {
}; };
}; };
</screen> </screen>
The output can be pasted into The output can be pasted into <filename>pkgs/top-level/perl-packages.nix</filename> or wherever else you need it.
<filename>pkgs/top-level/perl-packages.nix</filename> or wherever else you
need it.
</para> </para>
</section> </section>
@ -211,13 +155,7 @@ ImageExifTool = buildPerlPackage {
<title>Cross-compiling modules</title> <title>Cross-compiling modules</title>
<para> <para>
Nixpkgs has experimental support for cross-compiling Perl modules. In many Nixpkgs has experimental support for cross-compiling Perl modules. In many cases, it will just work out of the box, even for modules with native extensions. Sometimes, however, the Makefile.PL for a module may (indirectly) import a native module. In that case, you will need to make a stub for that module that will satisfy the Makefile.PL and install it into <filename>lib/perl5/site_perl/cross_perl/${perl.version}</filename>. See the <varname>postInstall</varname> for <varname>DBI</varname> for an example.
cases, it will just work out of the box, even for modules with native
extensions. Sometimes, however, the Makefile.PL for a module may
(indirectly) import a native module. In that case, you will need to make a
stub for that module that will satisfy the Makefile.PL and install it into
<filename>lib/perl5/site_perl/cross_perl/${perl.version}</filename>. See the
<varname>postInstall</varname> for <varname>DBI</varname> for an example.
</para> </para>
</section> </section>
</section> </section>

60
doc/languages-frameworks/qt.xml
View File

@ -4,11 +4,7 @@
<title>Qt</title> <title>Qt</title>
<para> <para>
This section describes the differences between Nix expressions for Qt 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. There are primarily two problems which the Qt infrastructure is designed to address: ensuring consistent versioning of all dependencies and finding dependencies at runtime.
libraries and applications and Nix expressions for other C++ software. Some
knowledge of the latter is assumed. There are primarily two problems which
the Qt infrastructure is designed to address: ensuring consistent versioning
of all dependencies and finding dependencies at runtime.
</para> </para>
<example xml:id='qt-default-nix'> <example xml:id='qt-default-nix'>
@ -28,38 +24,26 @@ mkDerivation { <co xml:id='qt-default-nix-co-2' />
<calloutlist> <calloutlist>
<callout arearefs='qt-default-nix-co-1'> <callout arearefs='qt-default-nix-co-1'>
<para> <para>
Import <literal>mkDerivation</literal> and Qt (such as 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.
<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.
</para> </para>
</callout> </callout>
<callout arearefs='qt-default-nix-co-2'> <callout arearefs='qt-default-nix-co-2'>
<para> <para>
Use <literal>mkDerivation</literal> instead of 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.
<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.
</para> </para>
<para> <para>
To use another deriver instead of <literal>stdenv.mkDerivation</literal>, To use another deriver instead of <literal>stdenv.mkDerivation</literal>, use <literal>mkDerivationWith</literal>:
use <literal>mkDerivationWith</literal>:
<programlisting> <programlisting>
mkDerivationWith myDeriver { mkDerivationWith myDeriver {
# ... # ...
} }
</programlisting> </programlisting>
If you cannot use <literal>mkDerivationWith</literal>, please refer to If you cannot use <literal>mkDerivationWith</literal>, please refer to <xref linkend='qt-runtime-dependencies' />.
<xref linkend='qt-runtime-dependencies' />.
</para> </para>
</callout> </callout>
<callout arearefs='qt-default-nix-co-3'> <callout arearefs='qt-default-nix-co-3'>
<para> <para>
<literal>mkDerivation</literal> accepts the same arguments as <literal>mkDerivation</literal> accepts the same arguments as <literal>stdenv.mkDerivation</literal>, such as <literal>buildInputs</literal>.
<literal>stdenv.mkDerivation</literal>, such as
<literal>buildInputs</literal>.
</para> </para>
</callout> </callout>
</calloutlist> </calloutlist>
@ -67,10 +51,7 @@ mkDerivationWith myDeriver {
<formalpara xml:id='qt-runtime-dependencies'> <formalpara xml:id='qt-runtime-dependencies'>
<title>Locating runtime dependencies</title> <title>Locating runtime dependencies</title>
<para> <para>
Qt applications need to be wrapped to find runtime dependencies. If you Qt applications need to be wrapped to find runtime dependencies. If you cannot use <literal>mkDerivation</literal> or <literal>mkDerivationWith</literal> above, include <literal>wrapQtAppsHook</literal> in <literal>nativeBuildInputs</literal>:
cannot use <literal>mkDerivation</literal> or
<literal>mkDerivationWith</literal> above, include
<literal>wrapQtAppsHook</literal> in <literal>nativeBuildInputs</literal>:
<programlisting> <programlisting>
stdenv.mkDerivation { stdenv.mkDerivation {
# ... # ...
@ -82,9 +63,7 @@ stdenv.mkDerivation {
</formalpara> </formalpara>
<para> <para>
Entries added to <literal>qtWrapperArgs</literal> are used to modify the Entries added to <literal>qtWrapperArgs</literal> are used to modify the wrappers created by <literal>wrapQtAppsHook</literal>. The entries are passed as arguments to <xref linkend='fun-wrapProgram' />.
wrappers created by <literal>wrapQtAppsHook</literal>. The entries are passed
as arguments to <xref linkend='fun-wrapProgram' />.
<programlisting> <programlisting>
mkDerivation { mkDerivation {
# ... # ...
@ -95,10 +74,7 @@ mkDerivation {
</para> </para>
<para> <para>
Set <literal>dontWrapQtApps</literal> to stop applications from being wrapped Set <literal>dontWrapQtApps</literal> to stop applications from being wrapped automatically. It is required to wrap applications manually with <literal>wrapQtApp</literal>, using the syntax of <xref linkend='fun-wrapProgram' />:
automatically. It is required to wrap applications manually with
<literal>wrapQtApp</literal>, using the syntax of
<xref linkend='fun-wrapProgram' />:
<programlisting> <programlisting>
mkDerivation { mkDerivation {
# ... # ...
@ -113,17 +89,12 @@ mkDerivation {
<note> <note>
<para> <para>
<literal>wrapQtAppsHook</literal> ignores files that are non-ELF <literal>wrapQtAppsHook</literal> 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.
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.
</para> </para>
</note> </note>
<para> <para>
Libraries are built with every available version of Qt. Use the Libraries are built with every available version of Qt. Use the <literal>meta.broken</literal> attribute to disable the package for unsupported Qt versions:
<literal>meta.broken</literal> attribute to disable the package for
unsupported Qt versions:
<programlisting> <programlisting>
mkDerivation { mkDerivation {
# ... # ...
@ -137,9 +108,7 @@ mkDerivation {
<formalpara> <formalpara>
<title>Adding a library to Nixpkgs</title> <title>Adding a library to Nixpkgs</title>
<para> <para>
Add a Qt library to <filename>all-packages.nix</filename> by adding it to Add a Qt library to <filename>all-packages.nix</filename> by adding it to the collection inside <literal>mkLibsForQt5</literal>. This ensures that the library is built with every available version of Qt as needed.
the collection inside <literal>mkLibsForQt5</literal>. This ensures that the
library is built with every available version of Qt as needed.
<example xml:id='qt-library-all-packages-nix'> <example xml:id='qt-library-all-packages-nix'>
<title>Adding a Qt library to <filename>all-packages.nix</filename></title> <title>Adding a Qt library to <filename>all-packages.nix</filename></title>
<programlisting> <programlisting>
@ -162,10 +131,7 @@ mkDerivation {
<formalpara> <formalpara>
<title>Adding an application to Nixpkgs</title> <title>Adding an application to Nixpkgs</title>
<para> <para>
Add a Qt application to <filename>all-packages.nix</filename> using Add a Qt application to <filename>all-packages.nix</filename> using <literal>libsForQt5.callPackage</literal> instead of the usual <literal>callPackage</literal>. The former ensures that all dependencies are built with the same version of Qt.
<literal>libsForQt5.callPackage</literal> instead of the usual
<literal>callPackage</literal>. The former ensures that all dependencies are
built with the same version of Qt.
<example xml:id='qt-application-all-packages-nix'> <example xml:id='qt-application-all-packages-nix'>
<title>Adding a Qt application to <filename>all-packages.nix</filename></title> <title>Adding a Qt application to <filename>all-packages.nix</filename></title>
<programlisting> <programlisting>

37
doc/languages-frameworks/ruby.xml
View File

@ -4,11 +4,7 @@
<title>Ruby</title> <title>Ruby</title>
<para> <para>
There currently is support to bundle applications that are packaged as Ruby There currently is support to bundle applications that are packaged as Ruby gems. The utility "bundix" allows you to write a <filename>Gemfile</filename>, let bundler create a <filename>Gemfile.lock</filename>, and then convert this into a nix expression that contains all Gem dependencies automatically.
gems. The utility "bundix" allows you to write a
<filename>Gemfile</filename>, let bundler create a
<filename>Gemfile.lock</filename>, and then convert this into a nix
expression that contains all Gem dependencies automatically.
</para> </para>
<para> <para>
@ -45,9 +41,7 @@ bundlerEnv rec {
</screen> </screen>
<para> <para>
Please check in the <filename>Gemfile</filename>, Please check in the <filename>Gemfile</filename>, <filename>Gemfile.lock</filename> and the <filename>gemset.nix</filename> so future updates can be run easily.
<filename>Gemfile.lock</filename> and the <filename>gemset.nix</filename> so
future updates can be run easily.
</para> </para>
<para> <para>
@ -62,10 +56,7 @@ $ nix-shell -p bundix --run 'bundix'
</screen> </screen>
<para> <para>
For tools written in Ruby - i.e. where the desire is to install a package and For tools written in Ruby - i.e. where the desire is to install a package and then execute e.g. <command>rake</command> at the command line, there is an alternative builder called <literal>bundlerApp</literal>. Set up the <filename>gemset.nix</filename> the same way, and then, for example:
then execute e.g. <command>rake</command> at the command line, there is an
alternative builder called <literal>bundlerApp</literal>. Set up the
<filename>gemset.nix</filename> the same way, and then, for example:
</para> </para>
<screen> <screen>
@ -87,29 +78,11 @@ bundlerApp {
</screen> </screen>
<para> <para>
The chief advantage of <literal>bundlerApp</literal> over The chief advantage of <literal>bundlerApp</literal> over <literal>bundlerEnv</literal> is the executables introduced in the environment are precisely those selected in the <literal>exes</literal> list, as opposed to <literal>bundlerEnv</literal> which adds all the executables made available by gems in the gemset, which can mean e.g. <command>rspec</command> or <command>rake</command> in unpredictable versions available from various packages.
<literal>bundlerEnv</literal> is the executables introduced in the
environment are precisely those selected in the <literal>exes</literal> list,
as opposed to <literal>bundlerEnv</literal> which adds all the executables
made available by gems in the gemset, which can mean e.g.
<command>rspec</command> or <command>rake</command> in unpredictable versions
available from various packages.
</para> </para>
<para> <para>
Resulting derivations for both builders also have two helpful attributes, Resulting derivations for both builders also have two helpful attributes, <literal>env</literal> and <literal>wrappedRuby</literal>. The first one allows one to quickly drop into <command>nix-shell</command> with the specified environment present. E.g. <command>nix-shell -A sensu.env</command> would give you an environment with Ruby preset so it has all the libraries necessary for <literal>sensu</literal> in its paths. The second one can be used to make derivations from custom Ruby scripts which have <filename>Gemfile</filename>s with their dependencies specified. It is a derivation with <command>ruby</command> wrapped so it can find all the needed dependencies. For example, to make a derivation <literal>my-script</literal> for a <filename>my-script.rb</filename> (which should be placed in <filename>bin</filename>) you should run <command>bundix</command> as specified above and then use <literal>bundlerEnv</literal> like this:
<literal>env</literal> and <literal>wrappedRuby</literal>. The first one
allows one to quickly drop into <command>nix-shell</command> with the
specified environment present. E.g. <command>nix-shell -A sensu.env</command>
would give you an environment with Ruby preset so it has all the libraries
necessary for <literal>sensu</literal> in its paths. The second one can be
used to make derivations from custom Ruby scripts which have
<filename>Gemfile</filename>s with their dependencies specified. It is a
derivation with <command>ruby</command> wrapped so it can find all the needed
dependencies. For example, to make a derivation <literal>my-script</literal>
for a <filename>my-script.rb</filename> (which should be placed in
<filename>bin</filename>) you should run <command>bundix</command> as
specified above and then use <literal>bundlerEnv</literal> like this:
</para> </para>
<programlisting> <programlisting>

27
doc/languages-frameworks/texlive.xml
View File

@ -4,8 +4,7 @@
<title>TeX Live</title> <title>TeX Live</title>
<para> <para>
Since release 15.09 there is a new TeX Live packaging that lives entirely Since release 15.09 there is a new TeX Live packaging that lives entirely under attribute <varname>texlive</varname>.
under attribute <varname>texlive</varname>.
</para> </para>
<section xml:id="sec-language-texlive-users-guide"> <section xml:id="sec-language-texlive-users-guide">
@ -14,28 +13,23 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
For basic usage just pull <varname>texlive.combined.scheme-basic</varname> For basic usage just pull <varname>texlive.combined.scheme-basic</varname> for an environment with basic LaTeX support.
for an environment with basic LaTeX support.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
It typically won't work to use separately installed packages together. It typically won't work to use separately installed packages together. Instead, you can build a custom set of packages like this:
Instead, you can build a custom set of packages like this:
<programlisting> <programlisting>
texlive.combine { texlive.combine {
inherit (texlive) scheme-small collection-langkorean algorithms cm-super; inherit (texlive) scheme-small collection-langkorean algorithms cm-super;
} }
</programlisting> </programlisting>
There are all the schemes, collections and a few thousand packages, as There are all the schemes, collections and a few thousand packages, as defined upstream (perhaps with tiny differences).
defined upstream (perhaps with tiny differences).
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
By default you only get executables and files needed during runtime, and a 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 <varname>pkgFilter</varname> function to <varname>combine</varname>.
little documentation for the core packages. To change that, you need to
add <varname>pkgFilter</varname> function to <varname>combine</varname>.
<programlisting> <programlisting>
texlive.combine { texlive.combine {
# inherit (texlive) whatever-you-want; # inherit (texlive) whatever-you-want;
@ -59,10 +53,7 @@ nix-repl> texlive.collection-<TAB>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Note that the wrapper assumes that the result has a chance to be useful. Note that the wrapper assumes that the result has a chance to be useful. For example, the core executables should be present, as well as some core data files. The supported way of ensuring this is by including some scheme, for example <varname>scheme-basic</varname>, into the combination.
For example, the core executables should be present, as well as some core
data files. The supported way of ensuring this is by including some
scheme, for example <varname>scheme-basic</varname>, into the combination.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -84,14 +75,12 @@ nix-repl> texlive.collection-<TAB>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
feature/bug: when a package is rejected by <varname>pkgFilter</varname>, feature/bug: when a package is rejected by <varname>pkgFilter</varname>, its dependencies are still propagated;
its dependencies are still propagated;
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
in case of any bugs or feature requests, file a github issue or better a in case of any bugs or feature requests, file a github issue or better a pull request and /cc @vcunat.
pull request and /cc @vcunat.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>

164
doc/meta.xml
View File

@ -3,10 +3,7 @@
xml:id="chap-meta"> xml:id="chap-meta">
<title>Meta-attributes</title> <title>Meta-attributes</title>
<para> <para>
Nix packages can declare <emphasis>meta-attributes</emphasis> that contain 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:
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:
<programlisting> <programlisting>
meta = with stdenv.lib; { meta = with stdenv.lib; {
description = "A program that produces a familiar, friendly greeting"; description = "A program that produces a familiar, friendly greeting";
@ -22,13 +19,10 @@ meta = with stdenv.lib; {
</programlisting> </programlisting>
</para> </para>
<para> <para>
Meta-attributes are not passed to the builder of the package. Thus, a change 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.
to a meta-attribute doesn’t trigger a recompilation of the package. The
value of a meta-attribute must be a string.
</para> </para>
<para> <para>
The meta-attributes of a package can be queried from the command-line using The meta-attributes of a package can be queried from the command-line using <command>nix-env</command>:
<command>nix-env</command>:
<screen> <screen>
<prompt>$ </prompt>nix-env -qa hello --json <prompt>$ </prompt>nix-env -qa hello --json
{ {
@ -67,8 +61,7 @@ meta = with stdenv.lib; {
</screen> </screen>
<command>nix-env</command> knows about the <varname>description</varname> <command>nix-env</command> knows about the <varname>description</varname> field specifically:
field specifically:
<screen> <screen>
<prompt>$ </prompt>nix-env -qa hello --description <prompt>$ </prompt>nix-env -qa hello --description
hello-2.3 A program that produces a familiar, friendly greeting hello-2.3 A program that produces a familiar, friendly greeting
@ -88,18 +81,13 @@ hello-2.3 A program that produces a familiar, friendly greeting
</term> </term>
<listitem> <listitem>
<para> <para>
A short (one-line) description of the package. This is shown by 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.
<command>nix-env -q --description</command> and also on the Nixpkgs
release pages.
</para> </para>
<para> <para>
Don’t include a period at the end. Don’t include newline characters. 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.
Capitalise the first character. For brevity, don’t repeat the name of
package — just describe what it does.
</para> </para>
<para> <para>
Wrong: <literal>"libpng is a library that allows you to decode PNG Wrong: <literal>"libpng is a library that allows you to decode PNG images."</literal>
images."</literal>
</para> </para>
<para> <para>
Right: <literal>"A library for decoding PNG images"</literal> Right: <literal>"A library for decoding PNG images"</literal>
@ -122,9 +110,7 @@ hello-2.3 A program that produces a familiar, friendly greeting
</term> </term>
<listitem> <listitem>
<para> <para>
Release branch. Used to specify that a package is not going to receive 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.
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.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -134,8 +120,7 @@ hello-2.3 A program that produces a familiar, friendly greeting
</term> </term>
<listitem> <listitem>
<para> <para>
The package’s homepage. Example: The package’s homepage. Example: <literal>https://www.gnu.org/software/hello/manual/</literal>
<literal>https://www.gnu.org/software/hello/manual/</literal>
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -145,8 +130,7 @@ hello-2.3 A program that produces a familiar, friendly greeting
</term> </term>
<listitem> <listitem>
<para> <para>
The page where a link to the current version can be found. Example: The page where a link to the current version can be found. Example: <literal>https://ftp.gnu.org/gnu/hello/</literal>
<literal>https://ftp.gnu.org/gnu/hello/</literal>
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -156,10 +140,7 @@ hello-2.3 A program that produces a familiar, friendly greeting
</term> </term>
<listitem> <listitem>
<para> <para>
A link or a list of links to the location of Changelog for a package. A 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>
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>
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -169,46 +150,32 @@ hello-2.3 A program that produces a familiar, friendly greeting
</term> </term>
<listitem> <listitem>
<para> <para>
The license, or licenses, for the package. One from the attribute set The license, or licenses, for the package. One from the attribute set defined in <link
defined in 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:
<link
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:
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
Single license referenced by attribute (preferred) Single license referenced by attribute (preferred) <literal>stdenv.lib.licenses.gpl3</literal>.
<literal>stdenv.lib.licenses.gpl3</literal>.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Single license referenced by its attribute shortName (frowned upon) Single license referenced by its attribute shortName (frowned upon) <literal>"gpl3"</literal>.
<literal>"gpl3"</literal>.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Single license referenced by its attribute spdxId (frowned upon) Single license referenced by its attribute spdxId (frowned upon) <literal>"GPL-3.0"</literal>.
<literal>"GPL-3.0"</literal>.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Multiple licenses referenced by attribute (preferred) <literal>with Multiple licenses referenced by attribute (preferred) <literal>with stdenv.lib.licenses; [ asl20 free ofl ]</literal>.
stdenv.lib.licenses; [ asl20 free ofl ]</literal>.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Multiple licenses referenced as a space delimited string of attribute Multiple licenses referenced as a space delimited string of attribute shortNames (frowned upon) <literal>"asl20 free ofl"</literal>.
shortNames (frowned upon) <literal>"asl20 free ofl"</literal>.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -222,13 +189,8 @@ hello-2.3 A program that produces a familiar, friendly greeting
</term> </term>
<listitem> <listitem>
<para> <para>
A list of names and e-mail addresses of the maintainers of this Nix A list of names and e-mail addresses of the maintainers of this Nix expression. If you would like to be a maintainer of a package, you may want to add yourself to <link
expression. If you would like to be a maintainer of a package, you may xlink:href="https://github.com/NixOS/nixpkgs/blob/master/maintainers/maintainer-list.nix"><filename>nixpkgs/maintainers/maintainer-list.nix</filename></link> and write something like <literal>[ stdenv.lib.maintainers.alice stdenv.lib.maintainers.bob ]</literal>.
want to add yourself to
<link
xlink:href="https://github.com/NixOS/nixpkgs/blob/master/maintainers/maintainer-list.nix"><filename>nixpkgs/maintainers/maintainer-list.nix</filename></link>
and write something like <literal>[ stdenv.lib.maintainers.alice
stdenv.lib.maintainers.bob ]</literal>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -238,10 +200,7 @@ hello-2.3 A program that produces a familiar, friendly greeting
</term> </term>
<listitem> <listitem>
<para> <para>
The <emphasis>priority</emphasis> of the package, used by 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).
<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).
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -251,15 +210,11 @@ hello-2.3 A program that produces a familiar, friendly greeting
</term> </term>
<listitem> <listitem>
<para> <para>
The list of Nix platform types on which the package is supported. Hydra 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:
builds packages according to the platform specified. If no platform is
specified, the package does not have prebuilt binaries. An example is:
<programlisting> <programlisting>
meta.platforms = stdenv.lib.platforms.linux; meta.platforms = stdenv.lib.platforms.linux;
</programlisting> </programlisting>
Attribute Set <varname>stdenv.lib.platforms</varname> defines 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.
<link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/lib/systems/doubles.nix">
various common lists</link> of platforms types.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -270,23 +225,14 @@ meta.platforms = stdenv.lib.platforms.linux;
<listitem> <listitem>
<warning> <warning>
<para> <para>
This attribute is special in that it is not actually under the 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.
<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.
</para> </para>
</warning> </warning>
<para> <para>
An attribute set with as values tests. A test is a derivation, which 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.
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.
</para> </para>
<para> <para>
The NixOS tests are available as <literal>nixosTests</literal> in The NixOS tests are available as <literal>nixosTests</literal> in parameters of derivations. For instance, the OpenSMTPD derivation includes lines similar to:
parameters of derivations. For instance, the OpenSMTPD derivation
includes lines similar to:
<programlisting> <programlisting>
{ /* ... */, nixosTests }: { /* ... */, nixosTests }:
{ {
@ -305,13 +251,7 @@ meta.platforms = stdenv.lib.platforms.linux;
</term> </term>
<listitem> <listitem>
<para> <para>
A timeout (in seconds) for building the derivation. If the derivation 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>.
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>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -321,13 +261,7 @@ meta.platforms = stdenv.lib.platforms.linux;
</term> </term>
<listitem> <listitem>
<para> <para>
The list of Nix platform types for which the Hydra instance at 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.
<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.
<programlisting> <programlisting>
meta.platforms = stdenv.lib.platforms.linux; meta.platforms = stdenv.lib.platforms.linux;
meta.hydraPlatforms = []; meta.hydraPlatforms = [];
@ -341,10 +275,7 @@ meta.hydraPlatforms = [];
</term> </term>
<listitem> <listitem>
<para> <para>
If set to <literal>true</literal>, the package is marked as “broken”, 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.
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.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -354,12 +285,7 @@ meta.hydraPlatforms = [];
</term> </term>
<listitem> <listitem>
<para> <para>
If set to <literal>true</literal>, the package is tested to be updated 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.
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.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -369,17 +295,11 @@ meta.hydraPlatforms = [];
<title>Licenses</title> <title>Licenses</title>
<para> <para>
The <varname>meta.license</varname> attribute should preferrably contain a 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.
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.
</para> </para>
<para> <para>
Although it's typically better to indicate the specific license, a few Although it's typically better to indicate the specific license, a few generic options are available:
generic options are available:
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>
@ -397,18 +317,10 @@ meta.hydraPlatforms = [];
</term> </term>
<listitem> <listitem>
<para> <para>
Unfree package that can be redistributed in binary form. That is, it’s 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.
legal to redistribute the <emphasis>output</emphasis> of the derivation.
This means that the package can be included in the Nixpkgs channel.
</para> </para>
<para> <para>
Sometimes proprietary software can only be redistributed unmodified. 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.
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.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -418,9 +330,7 @@ meta.hydraPlatforms = [];
</term> </term>
<listitem> <listitem>
<para> <para>
Unfree package that cannot be redistributed. You can build it yourself, 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.
but you cannot redistribute the output of the derivation. Thus it cannot
be included in the Nixpkgs channel.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -430,9 +340,7 @@ meta.hydraPlatforms = [];
</term> </term>
<listitem> <listitem>
<para> <para>
This package supplies unfree, redistributable firmware. This is a This package supplies unfree, redistributable firmware. This is a separate value from <varname>unfree-redistributable</varname> because not everybody cares whether firmware is free.
separate value from <varname>unfree-redistributable</varname> because
not everybody cares whether firmware is free.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>

158
doc/multiple-output.xml
View File

@ -10,31 +10,16 @@
<title>Introduction</title> <title>Introduction</title>
<para> <para>
The Nix language allows a derivation to produce multiple outputs, which is 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.
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.
</para> </para>
<para> <para>
The main motivation is to save disk space by reducing runtime closure sizes; 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.
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.
</para> </para>
<note> <note>
<para> <para>
The reduction effects could be instead achieved by building the parts in 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.
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.
</para> </para>
</note> </note>
</section> </section>
@ -42,23 +27,18 @@
<title>Installing a split package</title> <title>Installing a split package</title>
<para> <para>
When installing a package via <varname>systemPackages</varname> or When installing a package via <varname>systemPackages</varname> or <command>nix-env</command> you have several options:
<command>nix-env</command> you have several options:
</para> </para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
You can install particular outputs explicitly, as each is available in the You can install particular outputs explicitly, as each is available in the Nix language as an attribute of the package. The <varname>outputs</varname> attribute contains a list of output names.
Nix language as an attribute of the package. The
<varname>outputs</varname> attribute contains a list of output names.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
You can let it use the default outputs. These are handled by You can let it use the default outputs. These are handled by <varname>meta.outputsToInstall</varname> attribute that contains a list of output names.
<varname>meta.outputsToInstall</varname> attribute that contains a list of
output names.
</para> </para>
<para> <para>
TODO: more about tweaking the attribute, etc. TODO: more about tweaking the attribute, etc.
@ -66,19 +46,11 @@
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
NixOS provides configuration option NixOS provides configuration option <varname>environment.extraOutputsToInstall</varname> that allows adding extra outputs of <varname>environment.systemPackages</varname> atop the default ones. It's mainly meant for documentation and debug symbols, and it's also modified by specific options.
<varname>environment.extraOutputsToInstall</varname> that allows adding
extra outputs of <varname>environment.systemPackages</varname> atop the
default ones. It's mainly meant for documentation and debug symbols, and
it's also modified by specific options.
</para> </para>
<note> <note>
<para> <para>
At this moment there is no similar configurability for packages installed At this moment there is no similar configurability for packages installed by <command>nix-env</command>. You can still use approach from <xref linkend="sec-modify-via-packageOverrides" /> to override <varname>meta.outputsToInstall</varname> attributes, but that's a rather inconvenient way.
by <command>nix-env</command>. You can still use approach from
<xref linkend="sec-modify-via-packageOverrides" /> to override
<varname>meta.outputsToInstall</varname> attributes, but that's a rather
inconvenient way.
</para> </para>
</note> </note>
</listitem> </listitem>
@ -88,25 +60,15 @@
<title>Using a split package</title> <title>Using a split package</title>
<para> <para>
In the Nix language the individual outputs can be reached explicitly as 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.
attributes, e.g. <varname>coreutils.info</varname>, but the typical case is
just using packages as build inputs.
</para> </para>
<para> <para>
When a multiple-output derivation gets into a build input of another 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" />.)
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" />.)
</para> </para>
<para> <para>
In some cases it may be desirable to combine different outputs under a 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.)
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.)
</para> </para>
</section> </section>
<section xml:id="sec-multiple-outputs-"> <section xml:id="sec-multiple-outputs-">
@ -117,29 +79,18 @@
</para> </para>
<para> <para>
In nixpkgs there is a framework supporting multiple-output derivations. It 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 &lt;<filename>nixpkgs/pkgs/build-support/setup-hooks/multiple-outputs.sh</filename>&gt;; 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).
tries to cover most cases by default behavior. You can find the source
separated in
&lt;<filename>nixpkgs/pkgs/build-support/setup-hooks/multiple-outputs.sh</filename>&gt;;
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).
</para> </para>
<programlisting>outputs = [ "bin" "dev" "out" "doc" ];</programlisting> <programlisting>outputs = [ "bin" "dev" "out" "doc" ];</programlisting>
<para> <para>
Often such a single line is enough. For each output an equally named 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.
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.
</para> </para>
<note> <note>
<para> <para>
There is a special handling of the <varname>debug</varname> output, There is a special handling of the <varname>debug</varname> output, described at <xref linkend="stdenv-separateDebugInfo" />.
described at <xref linkend="stdenv-separateDebugInfo" />.
</para> </para>
</note> </note>
@ -147,36 +98,15 @@
<title><quote>Binaries first</quote></title> <title><quote>Binaries first</quote></title>
<para> <para>
A commonly adopted convention in <literal>nixpkgs</literal> is that 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.
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.
</para> </para>
<para> <para>
The <literal>glibc</literal> package is a deliberate single exception to 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>).
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>).
</para> </para>
<para> <para>
The reason for why <literal>glibc</literal> deviates from the convention is 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://nixos.org/patchelf.html">patchelf</link> for more details).
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://nixos.org/patchelf.html">patchelf</link> for more
details).
</para> </para>
</section> </section>
@ -184,13 +114,7 @@
<title>File type groups</title> <title>File type groups</title>
<para> <para>
The support code currently recognizes some particular kinds of outputs and 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 &ndash; a default output name is defined, falling back to other possibilities if the output isn't defined.
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 &ndash; a default output name is defined,
falling back to other possibilities if the output isn't defined.
</para> </para>
<variablelist> <variablelist>
@ -200,9 +124,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
is for development-only files. These include C(++) headers, pkg-config, 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.
cmake and aclocal files. They go to <varname>dev</varname> or
<varname>out</varname> by default.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -212,8 +134,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
is meant for user-facing binaries, typically residing in bin/. They go is meant for user-facing binaries, typically residing in bin/. They go to <varname>bin</varname> or <varname>out</varname> by default.
to <varname>bin</varname> or <varname>out</varname> by default.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -223,9 +144,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
is meant for libraries, typically residing in <filename>lib/</filename> 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.
and <filename>libexec/</filename>. They go to <varname>lib</varname> or
<varname>out</varname> by default.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -235,9 +154,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
is for user documentation, typically residing in is for user documentation, typically residing in <filename>share/doc/</filename>. It goes to <varname>doc</varname> or <varname>out</varname> by default.
<filename>share/doc/</filename>. It goes to <varname>doc</varname> or
<varname>out</varname> by default.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -247,10 +164,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
is for <emphasis>developer</emphasis> documentation. Currently we count 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.
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.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -260,8 +174,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
is for man pages (except for section 3). They go to is for man pages (except for section 3). They go to <varname>man</varname> or <varname>$outputBin</varname> by default.
<varname>man</varname> or <varname>$outputBin</varname> by default.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -271,8 +184,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
is for section 3 man pages. They go to <varname>devman</varname> or is for section 3 man pages. They go to <varname>devman</varname> or <varname>$outputMan</varname> by default.
<varname>$outputMan</varname> by default.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -282,8 +194,7 @@
</term> </term>
<listitem> <listitem>
<para> <para>
is for info pages. They go to <varname>info</varname> or is for info pages. They go to <varname>info</varname> or <varname>$outputBin</varname> by default.
<varname>$outputBin</varname> by default.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -296,31 +207,22 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
Some configure scripts don't like some of the parameters passed by 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>.
default by the framework, e.g. <literal>--docdir=/foo/bar</literal>. You
can disable this by setting <literal>setOutputFlags = false;</literal>.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
The outputs of a single derivation can retain references to each other, 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.)
but note that circular references are not allowed. (And each
strongly-connected component would act as a single output anyway.)
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Most of split packages contain their core functionality in libraries. 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.
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.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Some packages have hidden assumptions on install paths, which complicates Some packages have hidden assumptions on install paths, which complicates splitting.
splitting.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>

93
doc/overlays.xml
View File

@ -3,47 +3,32 @@
xml:id="chap-overlays"> xml:id="chap-overlays">
<title>Overlays</title> <title>Overlays</title>
<para> <para>
This chapter describes how to extend and change Nixpkgs using overlays. 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.
Overlays are used to add layers in the fixed-point used by Nixpkgs to compose
the set of all packages.
</para> </para>
<para> <para>
Nixpkgs can be configured with a list of overlays, which are applied in 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.
order. This means that the order of the overlays can be significant if
multiple layers override the same package.
</para> </para>
<!--============================================================--> <!--============================================================-->
<section xml:id="sec-overlays-install"> <section xml:id="sec-overlays-install">
<title>Installing overlays</title> <title>Installing overlays</title>
<para> <para>
The list of overlays can be set either explicitly in a Nix expression, or The list of overlays can be set either explicitly in a Nix expression, or through <literal>&lt;nixpkgs-overlays></literal> or user configuration files.
through <literal>&lt;nixpkgs-overlays></literal> or user configuration
files.
</para> </para>
<section xml:id="sec-overlays-argument"> <section xml:id="sec-overlays-argument">
<title>Set overlays in NixOS or Nix expressions</title> <title>Set overlays in NixOS or Nix expressions</title>
<para> <para>
On a NixOS system the value of the <literal>nixpkgs.overlays</literal> 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.
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.
</para> </para>
<para> <para>
The list of overlays can be passed explicitly when importing nixpkgs, for The list of overlays can be passed explicitly when importing nixpkgs, for example <literal>import &lt;nixpkgs> { overlays = [ overlay1 overlay2 ]; }</literal>.
example <literal>import &lt;nixpkgs> { overlays = [ overlay1 overlay2 ];
}</literal>.
</para> </para>
<para> <para>
Further overlays can be added by calling the <literal>pkgs.extend</literal> 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.
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.
</para> </para>
</section> </section>
@ -58,30 +43,20 @@
<orderedlist> <orderedlist>
<listitem> <listitem>
<para> <para>
First, if an 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.
<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.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Otherwise, if the Nix path entry Otherwise, if the Nix path entry <literal>&lt;nixpkgs-overlays></literal> exists, we look for overlays at that path, as described below.
<literal>&lt;nixpkgs-overlays></literal> exists, we look for overlays at
that path, as described below.
</para> </para>
<para> <para>
See the section on <literal>NIX_PATH</literal> in the Nix manual for See the section on <literal>NIX_PATH</literal> in the Nix manual for more details on how to set a value for <literal>&lt;nixpkgs-overlays>.</literal>
more details on how to set a value for
<literal>&lt;nixpkgs-overlays>.</literal>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
If one of <filename>~/.config/nixpkgs/overlays.nix</filename> and 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.
<filename>~/.config/nixpkgs/overlays/</filename> exists, then we look
for overlays at that path, as described below. It is an error if both
exist.
</para> </para>
</listitem> </listitem>
</orderedlist> </orderedlist>
@ -92,15 +67,12 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
If the path is a file, then the file is imported as a Nix expression and If the path is a file, then the file is imported as a Nix expression and used as the list of overlays.
used as the list of overlays.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
If the path is a directory, then we take the content of the directory, 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:
order it lexicographically, and attempt to interpret each as an overlay
by:
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
@ -109,8 +81,7 @@
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Importing a top-level <filename>default.nix</filename> file, if it is Importing a top-level <filename>default.nix</filename> file, if it is a directory.
a directory.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -120,12 +91,7 @@
</para> </para>
<para> <para>
Because overlays that are set in NixOS configuration do not affect 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>.
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>.
</para> </para>
<!-- TODO: Example of sharing overlays between NixOS configuration <!-- TODO: Example of sharing overlays between NixOS configuration
@ -139,9 +105,7 @@
<title>Defining overlays</title> <title>Defining overlays</title>
<para> <para>
Overlays are Nix functions which accept two arguments, conventionally called 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.
<varname>self</varname> and <varname>super</varname>, and return a set of
packages. For example, the following is a valid overlay.
</para> </para>
<programlisting> <programlisting>
@ -158,38 +122,19 @@ self: super:
</programlisting> </programlisting>
<para> <para>
The first argument (<varname>self</varname>) corresponds to the final 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.
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.
</para> </para>
<para> <para>
The second argument (<varname>super</varname>) corresponds to the result of 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.
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.
</para> </para>
<para> <para>
The value returned by this function should be a set similar to 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.
<filename>pkgs/top-level/all-packages.nix</filename>, containing overridden
and/or new packages.
</para> </para>
<para> <para>
Overlays are similar to other methods for customizing Nixpkgs, in particular 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.
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.
</para> </para>
</section> </section>
</chapter> </chapter>

262
doc/package-notes.xml
View File

@ -3,38 +3,23 @@
xml:id="chap-package-notes"> xml:id="chap-package-notes">
<title>Package Notes</title> <title>Package Notes</title>
<para> <para>
This chapter contains information about how to use and maintain the Nix 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.
expressions for a number of specific packages, such as the Linux kernel or
X.org.
</para> </para>
<!--============================================================--> <!--============================================================-->
<section xml:id="sec-linux-kernel"> <section xml:id="sec-linux-kernel">
<title>Linux kernel</title> <title>Linux kernel</title>
<para> <para>
The Nix expressions to build the Linux kernel are in The Nix expressions to build the Linux kernel are in <link
<link
xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/os-specific/linux/kernel"><filename>pkgs/os-specific/linux/kernel</filename></link>. xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/os-specific/linux/kernel"><filename>pkgs/os-specific/linux/kernel</filename></link>.
</para> </para>
<para> <para>
The function that builds the kernel has an argument The function that builds the kernel has an argument <varname>kernelPatches</varname> which should be a list of <literal>{name, patch, extraConfig}</literal> attribute sets, where <varname>name</varname> is the name of the patch (which is included in the kernel’s <varname>meta.description</varname> attribute), <varname>patch</varname> is the patch itself (possibly compressed), and <varname>extraConfig</varname> (optional) is a string specifying extra options to be concatenated to the kernel configuration file (<filename>.config</filename>).
<varname>kernelPatches</varname> which should be a list of <literal>{name,
patch, extraConfig}</literal> attribute sets, where <varname>name</varname>
is the name of the patch (which is included in the kernel’s
<varname>meta.description</varname> attribute), <varname>patch</varname> is
the patch itself (possibly compressed), and <varname>extraConfig</varname>
(optional) is a string specifying extra options to be concatenated to the
kernel configuration file (<filename>.config</filename>).
</para> </para>
<para> <para>
The kernel derivation exports an attribute <varname>features</varname> The kernel derivation exports an attribute <varname>features</varname> 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 <varname>iwlwifi</varname> feature (i.e. has built-in support for Intel wireless chipsets), then NixOS doesn’t have to build the external <varname>iwlwifi</varname> package:
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 <varname>iwlwifi</varname> feature (i.e. has built-in support
for Intel wireless chipsets), then NixOS doesn’t have to build the
external <varname>iwlwifi</varname> package:
<programlisting> <programlisting>
modulesTree = [kernel] modulesTree = [kernel]
++ pkgs.lib.optional (!kernel.features ? iwlwifi) kernelPackages.iwlwifi ++ pkgs.lib.optional (!kernel.features ? iwlwifi) kernelPackages.iwlwifi
@ -47,45 +32,31 @@ modulesTree = [kernel]
<orderedlist> <orderedlist>
<listitem> <listitem>
<para> <para>
Copy the old Nix expression (e.g. <filename>linux-2.6.21.nix</filename>) Copy the old Nix expression (e.g. <filename>linux-2.6.21.nix</filename>) to the new one (e.g. <filename>linux-2.6.22.nix</filename>) and update it.
to the new one (e.g. <filename>linux-2.6.22.nix</filename>) and update
it.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Add the new kernel to <filename>all-packages.nix</filename> (e.g., create Add the new kernel to <filename>all-packages.nix</filename> (e.g., create an attribute <varname>kernel_2_6_22</varname>).
an attribute <varname>kernel_2_6_22</varname>).
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Now we’re going to update the kernel configuration. First unpack the Now we’re going to update the kernel configuration. First unpack the kernel. Then for each supported platform (<literal>i686</literal>, <literal>x86_64</literal>, <literal>uml</literal>) do the following:
kernel. Then for each supported platform (<literal>i686</literal>,
<literal>x86_64</literal>, <literal>uml</literal>) do the following:
<orderedlist> <orderedlist>
<listitem> <listitem>
<para> <para>
Make an copy from the old config (e.g. Make an copy from the old config (e.g. <filename>config-2.6.21-i686-smp</filename>) to the new one (e.g. <filename>config-2.6.22-i686-smp</filename>).
<filename>config-2.6.21-i686-smp</filename>) to the new one (e.g.
<filename>config-2.6.22-i686-smp</filename>).
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Copy the config file for this platform (e.g. Copy the config file for this platform (e.g. <filename>config-2.6.22-i686-smp</filename>) to <filename>.config</filename> in the kernel source tree.
<filename>config-2.6.22-i686-smp</filename>) to
<filename>.config</filename> in the kernel source tree.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Run <literal>make oldconfig Run <literal>make oldconfig ARCH=<replaceable>{i386,x86_64,um}</replaceable></literal> and answer all questions. (For the uml configuration, also add <literal>SHELL=bash</literal>.) Make sure to keep the configuration consistent between platforms (i.e. don’t enable some feature on <literal>i686</literal> and disable it on <literal>x86_64</literal>).
ARCH=<replaceable>{i386,x86_64,um}</replaceable></literal> and answer
all questions. (For the uml configuration, also add
<literal>SHELL=bash</literal>.) Make sure to keep the configuration
consistent between platforms (i.e. don’t enable some feature on
<literal>i686</literal> and disable it on <literal>x86_64</literal>).
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -99,8 +70,7 @@ modulesTree = [kernel]
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Copy <filename>.config</filename> over the new config file (e.g. Copy <filename>.config</filename> over the new config file (e.g. <filename>config-2.6.22-i686-smp</filename>).
<filename>config-2.6.22-i686-smp</filename>).
</para> </para>
</listitem> </listitem>
</orderedlist> </orderedlist>
@ -108,18 +78,12 @@ modulesTree = [kernel]
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Test building the kernel: <literal>nix-build -A kernel_2_6_22</literal>. Test building the kernel: <literal>nix-build -A kernel_2_6_22</literal>. If it compiles, ship it! For extra credit, try booting NixOS with it.
If it compiles, ship it! For extra credit, try booting NixOS with it.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
It may be that the new kernel requires updating the external kernel It may be that the new kernel requires updating the external kernel modules and kernel-dependent packages listed in the <varname>linuxPackagesFor</varname> function in <filename>all-packages.nix</filename> (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.
modules and kernel-dependent packages listed in the
<varname>linuxPackagesFor</varname> function in
<filename>all-packages.nix</filename> (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.
</para> </para>
</listitem> </listitem>
</orderedlist> </orderedlist>
@ -130,13 +94,7 @@ modulesTree = [kernel]
<title>X.org</title> <title>X.org</title>
<para> <para>
The Nix expressions for the X.org packages reside in The Nix expressions for the X.org packages reside in <filename>pkgs/servers/x11/xorg/default.nix</filename>. 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 <filename>pkgs/servers/x11/xorg/overrides.nix</filename>, in which you can override or add to the derivations produced by the generator.
<filename>pkgs/servers/x11/xorg/default.nix</filename>. 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
<filename>pkgs/servers/x11/xorg/overrides.nix</filename>, in which you can
override or add to the derivations produced by the generator.
</para> </para>
<para> <para>
@ -146,37 +104,22 @@ modulesTree = [kernel]
<prompt>$ </prompt>cat tarballs-7.5.list extra.list old.list \ <prompt>$ </prompt>cat tarballs-7.5.list extra.list old.list \
| perl ./generate-expr-from-tarballs.pl | perl ./generate-expr-from-tarballs.pl
</screen> </screen>
For each of the tarballs in the <filename>.list</filename> files, the script For each of the tarballs in the <filename>.list</filename> files, the script downloads it, unpacks it, and searches its <filename>configure.ac</filename> and <filename>*.pc.in</filename> files for dependencies. This information is used to generate <filename>default.nix</filename>. The generator caches downloaded tarballs between runs. Pay close attention to the <literal>NOT FOUND: <replaceable>name</replaceable></literal> messages at the end of the run, since they may indicate missing dependencies. (Some might be optional dependencies, however.)
downloads it, unpacks it, and searches its <filename>configure.ac</filename>
and <filename>*.pc.in</filename> files for dependencies. This information is
used to generate <filename>default.nix</filename>. The generator caches
downloaded tarballs between runs. Pay close attention to the <literal>NOT
FOUND: <replaceable>name</replaceable></literal> messages at the end of the
run, since they may indicate missing dependencies. (Some might be optional
dependencies, however.)
</para> </para>
<para> <para>
A file like <filename>tarballs-7.5.list</filename> contains all tarballs in A file like <filename>tarballs-7.5.list</filename> contains all tarballs in a X.org release. It can be generated like this:
a X.org release. It can be generated like this:
<screen> <screen>
<prompt>$ </prompt>export i="mirror://xorg/X11R7.4/src/everything/" <prompt>$ </prompt>export i="mirror://xorg/X11R7.4/src/everything/"
<prompt>$ </prompt>cat $(PRINT_PATH=1 nix-prefetch-url $i | tail -n 1) \ <prompt>$ </prompt>cat $(PRINT_PATH=1 nix-prefetch-url $i | tail -n 1) \
| perl -e 'while (&lt;>) { if (/(href|HREF)="([^"]*.bz2)"/) { print "$ENV{'i'}$2\n"; }; }' \ | perl -e 'while (&lt;>) { if (/(href|HREF)="([^"]*.bz2)"/) { print "$ENV{'i'}$2\n"; }; }' \
| sort > tarballs-7.4.list | sort > tarballs-7.4.list
</screen> </screen>
<filename>extra.list</filename> contains libraries that aren’t part of <filename>extra.list</filename> contains libraries that aren’t part of X.org proper, but are closely related to it, such as <literal>libxcb</literal>. <filename>old.list</filename> contains some packages that were removed from X.org, but are still needed by some people or by other packages (such as <varname>imake</varname>).
X.org proper, but are closely related to it, such as
<literal>libxcb</literal>. <filename>old.list</filename> contains some
packages that were removed from X.org, but are still needed by some people
or by other packages (such as <varname>imake</varname>).
</para> </para>
<para> <para>
If the expression for a package requires derivation attributes that the If the expression for a package requires derivation attributes that the generator cannot figure out automatically (say, <varname>patches</varname> or a <varname>postInstall</varname> hook), you should modify <filename>pkgs/servers/x11/xorg/overrides.nix</filename>.
generator cannot figure out automatically (say, <varname>patches</varname>
or a <varname>postInstall</varname> hook), you should modify
<filename>pkgs/servers/x11/xorg/overrides.nix</filename>.
</para> </para>
</section> </section>
<!--============================================================--> <!--============================================================-->
@ -199,41 +142,19 @@ modulesTree = [kernel]
<title>Eclipse</title> <title>Eclipse</title>
<para> <para>
The Nix expressions related to the Eclipse platform and IDE are in 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>.
<link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/editors/eclipse"><filename>pkgs/applications/editors/eclipse</filename></link>.
</para> </para>
<para> <para>
Nixpkgs provides a number of packages that will install Eclipse in its 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:
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:
<screen> <screen>
<prompt>$ </prompt>nix-env -f '&lt;nixpkgs&gt;' -qaP -A eclipses --description <prompt>$ </prompt>nix-env -f '&lt;nixpkgs&gt;' -qaP -A eclipses --description
</screen> </screen>
Once an Eclipse variant is installed it can be run using the 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.
<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.
</para> </para>
<para> <para>
If you prefer to install plugins in a more declarative manner then Nixpkgs 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
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
<screen> <screen>
packageOverrides = pkgs: { packageOverrides = pkgs: {
myEclipse = with pkgs.eclipses; eclipseWithPlugins { myEclipse = with pkgs.eclipses; eclipseWithPlugins {
@ -243,38 +164,18 @@ packageOverrides = pkgs: {
}; };
} }
</screen> </screen>
to your Nixpkgs configuration to your Nixpkgs configuration (<filename>~/.config/nixpkgs/config.nix</filename>) and install it by running <command>nix-env -f '&lt;nixpkgs&gt;' -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
(<filename>~/.config/nixpkgs/config.nix</filename>) and install it by
running <command>nix-env -f '&lt;nixpkgs&gt;' -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
<screen> <screen>
<prompt>$ </prompt>nix-env -f '&lt;nixpkgs&gt;' -qaP -A eclipses.plugins --description <prompt>$ </prompt>nix-env -f '&lt;nixpkgs&gt;' -qaP -A eclipses.plugins --description
</screen> </screen>
</para> </para>
<para> <para>
If there is a need to install plugins that are not available in Nixpkgs then 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.
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.
</para> </para>
<para> <para>
Expanding the previous example with two plugins using the above functions we Expanding the previous example with two plugins using the above functions we have
have
<screen> <screen>
packageOverrides = pkgs: { packageOverrides = pkgs: {
myEclipse = with pkgs.eclipses; eclipseWithPlugins { myEclipse = with pkgs.eclipses; eclipseWithPlugins {
@ -311,19 +212,15 @@ packageOverrides = pkgs: {
<title>Elm</title> <title>Elm</title>
<para> <para>
To start a development environment do <command>nix-shell -p elmPackages.elm To start a development environment do <command>nix-shell -p elmPackages.elm elmPackages.elm-format</command>
elmPackages.elm-format</command>
</para> </para>
<para> <para>
To update Elm compiler, see To update Elm compiler, see <filename>nixpkgs/pkgs/development/compilers/elm/README.md</filename>.
<filename>nixpkgs/pkgs/development/compilers/elm/README.md</filename>.
</para> </para>
<para> <para>
To package Elm applications, To package Elm applications, <link xlink:href="https://github.com/hercules-ci/elm2nix#elm2nix">read about elm2nix</link>.
<link xlink:href="https://github.com/hercules-ci/elm2nix#elm2nix">read about
elm2nix</link>.
</para> </para>
</section> </section>
<section xml:id="sec-kakoune"> <section xml:id="sec-kakoune">
@ -342,11 +239,7 @@ packageOverrides = pkgs: {
<title>Interactive shell helpers</title> <title>Interactive shell helpers</title>
<para> <para>
Some packages provide the shell integration to be more useful. But unlike Some packages provide the shell integration to be more useful. But unlike other systems, nix doesn't have a standard share directory location. This is why a bunch <command>PACKAGE-share</command> scripts are shipped that print the location of the corresponding shared folder. Current list of such packages is as following:
other systems, nix doesn't have a standard share directory location. This is
why a bunch <command>PACKAGE-share</command> scripts are shipped that print
the location of the corresponding shared folder. Current list of such
packages is as following:
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
@ -369,31 +262,20 @@ packageOverrides = pkgs: {
<title>Weechat</title> <title>Weechat</title>
<para> <para>
Weechat can be configured to include your choice of plugins, reducing its 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
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
<programlisting>weechat.override {configure = {availablePlugins, ...}: { <programlisting>weechat.override {configure = {availablePlugins, ...}: {
plugins = with availablePlugins; [ python perl ]; plugins = with availablePlugins; [ python perl ];
} }
}</programlisting> }</programlisting>
If the <literal>configure</literal> function returns an attrset without the If the <literal>configure</literal> function returns an attrset without the <literal>plugins</literal> attribute, <literal>availablePlugins</literal> will be used automatically.
<literal>plugins</literal> attribute, <literal>availablePlugins</literal>
will be used automatically.
</para> </para>
<para> <para>
The plugins currently available are <literal>python</literal>, The plugins currently available are <literal>python</literal>, <literal>perl</literal>, <literal>ruby</literal>, <literal>guile</literal>, <literal>tcl</literal> and <literal>lua</literal>.
<literal>perl</literal>, <literal>ruby</literal>, <literal>guile</literal>,
<literal>tcl</literal> and <literal>lua</literal>.
</para> </para>
<para> <para>
The python and perl plugins allows the addition of extra libraries. For The python and perl plugins allows the addition of extra libraries. For instance, the <literal>inotify.py</literal> script in weechat-scripts requires D-Bus or libnotify, and the <literal>fish.py</literal> script requires pycrypto. To use these scripts, use the plugin's <literal>withPackages</literal> attribute:
instance, the <literal>inotify.py</literal> script in weechat-scripts
requires D-Bus or libnotify, and the <literal>fish.py</literal> script
requires pycrypto. To use these scripts, use the plugin's
<literal>withPackages</literal> attribute:
<programlisting>weechat.override { configure = {availablePlugins, ...}: { <programlisting>weechat.override { configure = {availablePlugins, ...}: {
plugins = with availablePlugins; [ plugins = with availablePlugins; [
(python.withPackages (ps: with ps; [ pycrypto python-dbus ])) (python.withPackages (ps: with ps; [ pycrypto python-dbus ]))
@ -404,8 +286,7 @@ packageOverrides = pkgs: {
</para> </para>
<para> <para>
In order to also keep all default plugins installed, it is possible to use In order to also keep all default plugins installed, it is possible to use the following method:
the following method:
<programlisting>weechat.override { configure = { availablePlugins, ... }: { <programlisting>weechat.override { configure = { availablePlugins, ... }: {
plugins = builtins.attrValues (availablePlugins // { plugins = builtins.attrValues (availablePlugins // {
python = availablePlugins.python.withPackages (ps: with ps; [ pycrypto python-dbus ]); python = availablePlugins.python.withPackages (ps: with ps; [ pycrypto python-dbus ]);
@ -415,9 +296,7 @@ packageOverrides = pkgs: {
</para> </para>
<para> <para>
WeeChat allows to set defaults on startup using the WeeChat allows to set defaults on startup using the <literal>--run-command</literal>. The <literal>configure</literal> method can be used to pass commands to the program:
<literal>--run-command</literal>. The <literal>configure</literal> method
can be used to pass commands to the program:
<programlisting>weechat.override { <programlisting>weechat.override {
configure = { availablePlugins, ... }: { configure = { availablePlugins, ... }: {
init = '' init = ''
@ -426,14 +305,11 @@ packageOverrides = pkgs: {
''; '';
}; };
}</programlisting> }</programlisting>
Further values can be added to the list of commands when running Further values can be added to the list of commands when running <literal>weechat --run-command "your-commands"</literal>.
<literal>weechat --run-command "your-commands"</literal>.
</para> </para>
<para> <para>
Additionally it's possible to specify scripts to be loaded when starting Additionally it's possible to specify scripts to be loaded when starting <literal>weechat</literal>. These will be loaded before the commands from <literal>init</literal>:
<literal>weechat</literal>. These will be loaded before the commands from
<literal>init</literal>:
<programlisting>weechat.override { <programlisting>weechat.override {
configure = { availablePlugins, ... }: { configure = { availablePlugins, ... }: {
scripts = with pkgs.weechatScripts; [ scripts = with pkgs.weechatScripts; [
@ -447,11 +323,7 @@ packageOverrides = pkgs: {
</para> </para>
<para> <para>
In <literal>nixpkgs</literal> there's a subpackage which contains In <literal>nixpkgs</literal> there's a subpackage which contains derivations for WeeChat scripts. Such derivations expect a <literal>passthru.scripts</literal> attribute which contains a list of all scripts inside the store path. Furthermore all scripts have to live in <literal>$out/share</literal>. An exemplary derivation looks like this:
derivations for WeeChat scripts. Such derivations expect a
<literal>passthru.scripts</literal> attribute which contains a list of all
scripts inside the store path. Furthermore all scripts have to live in
<literal>$out/share</literal>. An exemplary derivation looks like this:
<programlisting>{ stdenv, fetchurl }: <programlisting>{ stdenv, fetchurl }:
stdenv.mkDerivation { stdenv.mkDerivation {
@ -480,18 +352,11 @@ stdenv.mkDerivation {
<title>Activating the engine</title> <title>Activating the engine</title>
<para> <para>
IBus needs to be configured accordingly to activate 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>.
<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>.
</para> </para>
<para> <para>
On NixOS you need to explicitly enable <literal>ibus</literal> with given 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:
engines before customizing your desktop to use
<literal>typing-booster</literal>. This can be achieved using the
<literal>ibus</literal> module:
<programlisting>{ pkgs, ... }: { <programlisting>{ pkgs, ... }: {
i18n.inputMethod = { i18n.inputMethod = {
enabled = "ibus"; enabled = "ibus";
@ -505,21 +370,14 @@ stdenv.mkDerivation {
<title>Using custom hunspell dictionaries</title> <title>Using custom hunspell dictionaries</title>
<para> <para>
The IBus engine is based on <literal>hunspell</literal> to support 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:
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:
<programlisting>ibus-engines.typing-booster.override { <programlisting>ibus-engines.typing-booster.override {
langs = [ "de-at" "en-gb" ]; langs = [ "de-at" "en-gb" ];
}</programlisting> }</programlisting>
</para> </para>
<para> <para>
<emphasis>Note: each language passed to <literal>langs</literal> must be an <emphasis>Note: each language passed to <literal>langs</literal> must be an attribute name in <literal>pkgs.hunspellDicts</literal>.</emphasis>
attribute name in <literal>pkgs.hunspellDicts</literal>.</emphasis>
</para> </para>
</section> </section>
@ -527,10 +385,7 @@ stdenv.mkDerivation {
<title>Built-in emoji picker</title> <title>Built-in emoji picker</title>
<para> <para>
The <literal>ibus-engines.typing-booster</literal> package contains a 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:
program named <literal>emoji-picker</literal>. To display all emojis
correctly, a special font such as <literal>noto-fonts-emoji</literal> is
needed:
</para> </para>
<para> <para>
@ -545,45 +400,22 @@ stdenv.mkDerivation {
<title>Nginx</title> <title>Nginx</title>
<para> <para>
<link xlink:href="https://nginx.org/">Nginx</link> is a reverse proxy and <link xlink:href="https://nginx.org/">Nginx</link> is a reverse proxy and lightweight webserver.
lightweight webserver.
</para> </para>
<section xml:id="sec-nginx-etag"> <section xml:id="sec-nginx-etag">
<title>ETags on static files served from the Nix store</title> <title>ETags on static files served from the Nix store</title>
<para> <para>
HTTP has a couple different mechanisms for caching to prevent clients from 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 <link xlink:href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Last-Modified"><literal>Last-Modified</literal></link> response header automatically; unfortunately, it works by using filesystem timestamps to determine the value of the <literal>Last-Modified</literal> 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).
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
<link xlink:href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Last-Modified"><literal>Last-Modified</literal></link>
response header automatically; unfortunately, it works by using filesystem
timestamps to determine the value of the <literal>Last-Modified</literal>
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).
</para> </para>
<para> <para>
Fortunately, HTTP supports an alternative (and more effective) caching Fortunately, HTTP supports an alternative (and more effective) caching mechanism: the <link xlink:href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag"><literal>ETag</literal></link> response header. The value of the <literal>ETag</literal> 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 <literal>If-None-Match</literal> header. If the ETag value is unchanged, then the server does not need to resend the content.
mechanism: the
<link xlink:href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag"><literal>ETag</literal></link>
response header. The value of the <literal>ETag</literal> 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 <literal>If-None-Match</literal> header. If the
ETag value is unchanged, then the server does not need to resend the
content.
</para> </para>
<para> <para>
As of NixOS 19.09, the nginx package in Nixpkgs is patched such that when As of NixOS 19.09, the nginx package in Nixpkgs is patched such that when nginx serves a file out of <filename>/nix/store</filename>, the hash in the store path is used as the <literal>ETag</literal> 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.
nginx serves a file out of <filename>/nix/store</filename>, the hash in the
store path is used as the <literal>ETag</literal> 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.
</para> </para>
</section> </section>
</section> </section>

175
doc/package-specific-user-notes.xml
View File

@ -1,46 +1,24 @@
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="package-specific-user-notes"> <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="package-specific-user-notes">
<title>Package-specific usage notes</title> <title>Package-specific usage notes</title>
<para> <para>
These chapters includes some notes that apply to specific packages and should These chapters includes some notes that apply to specific packages and should answer some of the frequently asked questions related to Nixpkgs use. Some useful information related to package use can be found in <link linkend="chap-package-notes">package-specific development notes</link>.
answer some of the frequently asked questions related to Nixpkgs use. Some
useful information related to package use can be found in
<link linkend="chap-package-notes">package-specific development notes</link>.
</para> </para>
<section xml:id="opengl"> <section xml:id="opengl">
<title>OpenGL</title> <title>OpenGL</title>
<para> <para>
Packages that use OpenGL have NixOS desktop as their primary target. The Packages that use OpenGL have NixOS desktop as their primary target. The current solution for loading the GPU-specific drivers is based on <literal>libglvnd</literal> and looks for the driver implementation in <literal>LD_LIBRARY_PATH</literal>. If you are using a non-NixOS GNU/Linux/X11 desktop with free software video drivers, consider launching OpenGL-dependent programs from Nixpkgs with Nixpkgs versions of <literal>libglvnd</literal> and <literal>mesa_drivers</literal> in <literal>LD_LIBRARY_PATH</literal>. For proprietary video drivers you might have luck with also adding the corresponding video driver package.
current solution for loading the GPU-specific drivers is based on
<literal>libglvnd</literal> and looks for the driver implementation in
<literal>LD_LIBRARY_PATH</literal>. If you are using a non-NixOS
GNU/Linux/X11 desktop with free software video drivers, consider launching
OpenGL-dependent programs from Nixpkgs with Nixpkgs versions of
<literal>libglvnd</literal> and <literal>mesa_drivers</literal> in
<literal>LD_LIBRARY_PATH</literal>. For proprietary video drivers you might
have luck with also adding the corresponding video driver package.
</para> </para>
</section> </section>
<section xml:id="locales"> <section xml:id="locales">
<title>Locales</title> <title>Locales</title>
<para> <para>
To allow simultaneous use of packages linked against different versions of To allow simultaneous use of packages linked against different versions of <literal>glibc</literal> with different locale archive formats Nixpkgs patches <literal>glibc</literal> to rely on <literal>LOCALE_ARCHIVE</literal> environment variable.
<literal>glibc</literal> with different locale archive formats Nixpkgs
patches <literal>glibc</literal> to rely on
<literal>LOCALE_ARCHIVE</literal> environment variable.
</para> </para>
<para> <para>
On non-NixOS distributions this variable is obviously not set. This can 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 <literal>LOCALE_ARCHIVE</literal> variable pointing to <literal>${glibcLocales}/lib/locale/locale-archive</literal>. 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 <literal>allLocales</literal> and <literal>locales</literal> of the package.
cause regressions in language support or even crashes in some
Nixpkgs-provided programs. The simplest way to mitigate this problem is
exporting the <literal>LOCALE_ARCHIVE</literal> variable pointing to
<literal>${glibcLocales}/lib/locale/locale-archive</literal>. 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 <literal>allLocales</literal> and
<literal>locales</literal> of the package.
</para> </para>
</section> </section>
<section xml:id="sec-emacs"> <section xml:id="sec-emacs">
@ -50,15 +28,7 @@
<title>Configuring Emacs</title> <title>Configuring Emacs</title>
<para> <para>
The Emacs package comes with some extra helpers to make it easier to The Emacs package comes with some extra helpers to make it easier to configure. <varname>emacsWithPackages</varname> 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 <literal>company</literal>, <literal>counsel</literal>, <literal>flycheck</literal>, <literal>ivy</literal>, <literal>magit</literal>, <literal>projectile</literal>, and <literal>use-package</literal> you could use this as a <filename>~/.config/nixpkgs/config.nix</filename> override:
configure. <varname>emacsWithPackages</varname> 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
<literal>company</literal>, <literal>counsel</literal>,
<literal>flycheck</literal>, <literal>ivy</literal>,
<literal>magit</literal>, <literal>projectile</literal>, and
<literal>use-package</literal> you could use this as a
<filename>~/.config/nixpkgs/config.nix</filename> override:
</para> </para>
<screen> <screen>
@ -78,15 +48,7 @@
</screen> </screen>
<para> <para>
You can install it like any other packages via <command>nix-env -iA You can install it like any other packages via <command>nix-env -iA myEmacs</command>. However, this will only install those packages. It will not <literal>configure</literal> 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 <filename>default.el</filename> file in <filename>/share/emacs/site-start/</filename>. Emacs knows to load this file automatically when it starts.
myEmacs</command>. However, this will only install those packages. It will
not <literal>configure</literal> 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
<filename>default.el</filename> file in
<filename>/share/emacs/site-start/</filename>. Emacs knows to load this
file automatically when it starts.
</para> </para>
<screen> <screen>
@ -168,22 +130,11 @@ cp ${myEmacsConfig} $out/share/emacs/site-lisp/default.el
</screen> </screen>
<para> <para>
This provides a fairly full Emacs start file. It will load in addition to 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 <command>-q</command> to the Emacs command.
the user's presonal config. You can always disable it by passing
<command>-q</command> to the Emacs command.
</para> </para>
<para> <para>
Sometimes <varname>emacsWithPackages</varname> is not enough, as this Sometimes <varname>emacsWithPackages</varname> 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 <filename>pkgs/top-level/emacs-packages.nix</filename>). 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 <varname>overrideScope'</varname>.
package set has some priorities imposed on packages (with the lowest
priority assigned to Melpa Unstable, and the highest for packages manually
defined in <filename>pkgs/top-level/emacs-packages.nix</filename>). 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
<varname>overrideScope'</varname>.
</para> </para>
<screen> <screen>
@ -203,23 +154,18 @@ overrides = self: super: rec {
<title>DLib</title> <title>DLib</title>
<para> <para>
<link xlink:href="http://dlib.net/">DLib</link> is a modern, C++-based <link xlink:href="http://dlib.net/">DLib</link> is a modern, C++-based toolkit which provides several machine learning algorithms.
toolkit which provides several machine learning algorithms.
</para> </para>
<section xml:id="compiling-without-avx-support"> <section xml:id="compiling-without-avx-support">
<title>Compiling without AVX support</title> <title>Compiling without AVX support</title>
<para> <para>
Especially older CPUs don't support 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.
<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.
</para> </para>
<para> <para>
On the affected hardware errors like <literal>Illegal instruction</literal> On the affected hardware errors like <literal>Illegal instruction</literal> will occur. In those cases AVX support needs to be disabled:
will occur. In those cases AVX support needs to be disabled:
<programlisting>self: super: { <programlisting>self: super: {
dlib = super.dlib.override { avxSupport = false; }; dlib = super.dlib.override { avxSupport = false; };
}</programlisting> }</programlisting>
@ -230,22 +176,11 @@ overrides = self: super: rec {
<title>Unfree software</title> <title>Unfree software</title>
<para> <para>
All users of Nixpkgs are free software users, and many users (and All users of Nixpkgs are free software users, and many users (and developers) of Nixpkgs want to limit and tightly control their exposure to unfree software. At the same time, many users need (or want) to run some specific pieces of proprietary software. Nixpkgs includes some expressions for unfree software packages. By default unfree software cannot be installed and doesn’t show up in searches. To allow installing unfree software in a single Nix invocation one can export <literal>NIXPKGS_ALLOW_UNFREE=1</literal>. For a persistent solution, users can set <literal>allowUnfree</literal> in the Nixpkgs configuration.
developers) of Nixpkgs want to limit and tightly control their exposure to
unfree software. At the same time, many users need (or want) to run some
specific pieces of proprietary software. Nixpkgs includes some expressions
for unfree software packages. By default unfree software cannot be installed
and doesn’t show up in searches. To allow installing unfree software in a
single Nix invocation one can export
<literal>NIXPKGS_ALLOW_UNFREE=1</literal>. For a persistent solution, users
can set <literal>allowUnfree</literal> in the Nixpkgs configuration.
</para> </para>
<para> <para>
Fine-grained control is possible by defining Fine-grained control is possible by defining <literal>allowUnfreePredicate</literal> function in config; it takes the <literal>mkDerivation</literal> parameter attrset and returns <literal>true</literal> for unfree packages that should be allowed.
<literal>allowUnfreePredicate</literal> function in config; it takes the
<literal>mkDerivation</literal> parameter attrset and returns
<literal>true</literal> for unfree packages that should be allowed.
</para> </para>
</section> </section>
<section xml:id="sec-steam"> <section xml:id="sec-steam">
@ -255,13 +190,7 @@ overrides = self: super: rec {
<title>Steam in Nix</title> <title>Steam in Nix</title>
<para> <para>
Steam is distributed as a <filename>.deb</filename> file, for now only as Steam is distributed as a <filename>.deb</filename> file, for now only as an i686 package (the amd64 package only has documentation). When unpacked, it has a script called <filename>steam</filename> that in Ubuntu (their target distro) would go to <filename>/usr/bin </filename>. 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.
an i686 package (the amd64 package only has documentation). When unpacked,
it has a script called <filename>steam</filename> that in Ubuntu (their
target distro) would go to <filename>/usr/bin </filename>. 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.
</para> </para>
<para> <para>
@ -269,8 +198,7 @@ overrides = self: super: rec {
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
We don't have <filename>/bin/bash</filename> and many scripts point We don't have <filename>/bin/bash</filename> and many scripts point there. Similarly for <filename>/usr/bin/python</filename> .
there. Similarly for <filename>/usr/bin/python</filename> .
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -280,8 +208,7 @@ overrides = self: super: rec {
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
The <filename>steam.sh</filename> script in $HOME can not be patched, as The <filename>steam.sh</filename> script in $HOME can not be patched, as it is checked and rewritten by steam.
it is checked and rewritten by steam.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -293,11 +220,7 @@ overrides = self: super: rec {
</para> </para>
<para> <para>
The current approach to deploy Steam in NixOS is composing a FHS-compatible The current approach to deploy Steam in NixOS is composing a FHS-compatible chroot environment, as documented <link xlink:href="http://sandervanderburg.blogspot.nl/2013/09/composing-fhs-compatible-chroot.html">here</link>. 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.
chroot environment, as documented
<link xlink:href="http://sandervanderburg.blogspot.nl/2013/09/composing-fhs-compatible-chroot.html">here</link>.
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.
</para> </para>
</section> </section>
@ -309,9 +232,7 @@ overrides = self: super: rec {
<programlisting>hardware.opengl.driSupport32Bit = true;</programlisting> <programlisting>hardware.opengl.driSupport32Bit = true;</programlisting>
in your <filename>/etc/nixos/configuration.nix</filename>. You'll also need in your <filename>/etc/nixos/configuration.nix</filename>. You'll also need
<programlisting>hardware.pulseaudio.support32Bit = true;</programlisting> <programlisting>hardware.pulseaudio.support32Bit = true;</programlisting>
if you are using PulseAudio - this will enable 32bit ALSA apps integration. if you are using PulseAudio - this will enable 32bit ALSA apps integration. To use the Steam controller or other Steam supported controllers such as the DualShock 4 or Nintendo Switch Pro, you need to add
To use the Steam controller or other Steam supported controllers such as
the DualShock 4 or Nintendo Switch Pro, you need to add
<programlisting>hardware.steam-hardware.enable = true;</programlisting> <programlisting>hardware.steam-hardware.enable = true;</programlisting>
to your configuration. to your configuration.
</para> </para>
@ -342,19 +263,14 @@ overrides = self: super: rec {
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
The <literal>newStdcpp</literal> parameter was removed since NixOS The <literal>newStdcpp</literal> parameter was removed since NixOS 17.09 and should not be needed anymore.
17.09 and should not be needed anymore.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Steam ships statically linked with a version of libcrypto that 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
conflics with the one dynamically loaded by radeonsi_dri.so. If you
get the error
<programlisting>steam.sh: line 713: 7842 Segmentation fault (core dumped)</programlisting> <programlisting>steam.sh: line 713: 7842 Segmentation fault (core dumped)</programlisting>
have a look at have a look at <link xlink:href="https://github.com/NixOS/nixpkgs/pull/20269">this pull request</link>.
<link xlink:href="https://github.com/NixOS/nixpkgs/pull/20269">this
pull request</link>.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -368,8 +284,7 @@ overrides = self: super: rec {
<orderedlist> <orderedlist>
<listitem> <listitem>
<para> <para>
There is no java in steam chrootenv by default. If you get a message There is no java in steam chrootenv by default. If you get a message like
like
<programlisting>/home/foo/.local/share/Steam/SteamApps/common/towns/towns.sh: line 1: java: command not found</programlisting> <programlisting>/home/foo/.local/share/Steam/SteamApps/common/towns/towns.sh: line 1: java: command not found</programlisting>
You need to add You need to add
<programlisting> steam.override { withJava = true; };</programlisting> <programlisting> steam.override { withJava = true; };</programlisting>
@ -387,8 +302,7 @@ overrides = self: super: rec {
<title>steam-run</title> <title>steam-run</title>
<para> <para>
The FHS-compatible chroot used for steam can also be used to run other 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
linux games that expect a FHS environment. To do it, add
<programlisting>pkgs.(steam.override { <programlisting>pkgs.(steam.override {
nativeOnly = true; nativeOnly = true;
newStdcpp = true; newStdcpp = true;
@ -404,46 +318,23 @@ overrides = self: super: rec {
<para> <para>
<note> <note>
<para> <para>
Please note that the <literal>citrix_receiver</literal> package has been Please note that the <literal>citrix_receiver</literal> package has been deprecated since its development was <link xlink:href="https://docs.citrix.com/en-us/citrix-workspace-app.html">discontinued by upstream</link> and has been replaced by <link xlink:href="https://www.citrix.com/products/workspace-app/">the citrix workspace app</link>.
deprecated since its development was
<link xlink:href="https://docs.citrix.com/en-us/citrix-workspace-app.html">discontinued
by upstream</link> and has been replaced by
<link xlink:href="https://www.citrix.com/products/workspace-app/">the
citrix workspace app</link>.
</para> </para>
</note> </note>
<link xlink:href="https://www.citrix.com/products/receiver/">Citrix <link xlink:href="https://www.citrix.com/products/receiver/">Citrix Receiver</link> and <link xlink:href="https://www.citrix.com/products/workspace-app/">Citrix Workspace App</link> are a remote desktop viewers which provide access to <link xlink:href="https://www.citrix.com/products/xenapp-xendesktop/">XenDesktop</link> installations.
Receiver</link> and
<link xlink:href="https://www.citrix.com/products/workspace-app/">Citrix
Workspace App</link> are a remote desktop viewers which provide access to
<link xlink:href="https://www.citrix.com/products/xenapp-xendesktop/">XenDesktop</link>
installations.
</para> </para>
<section xml:id="sec-citrix-base"> <section xml:id="sec-citrix-base">
<title>Basic usage</title> <title>Basic usage</title>
<para> <para>
The tarball archive needs to be downloaded manually as the license The tarball archive needs to be downloaded manually as the license agreements of the vendor for <link xlink:href="https://www.citrix.com/downloads/citrix-receiver/">Citrix Receiver</link> or <link xlink:href="https://www.citrix.de/downloads/workspace-app/linux/workspace-app-for-linux-latest.html">Citrix Workspace</link> need 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.
agreements of the vendor for
<link xlink:href="https://www.citrix.com/downloads/citrix-receiver/">Citrix
Receiver</link> or
<link xlink:href="https://www.citrix.de/downloads/workspace-app/linux/workspace-app-for-linux-latest.html">Citrix
Workspace</link> need 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.
</para> </para>
<warning> <warning>
<title>Caution with <command>nix-shell</command> installs</title> <title>Caution with <command>nix-shell</command> installs</title>
<para> <para>
It's recommended to install <literal>Citrix Receiver</literal> and/or It's recommended to install <literal>Citrix Receiver</literal> and/or <literal>Citrix Workspace</literal> using <literal>nix-env -i</literal> or globally to ensure that the <literal>.desktop</literal> files are installed properly into <literal>$XDG_CONFIG_DIRS</literal>. Otherwise it won't be possible to open <literal>.ica</literal> files automatically from the browser to start a Citrix connection.
<literal>Citrix Workspace</literal> using <literal>nix-env -i</literal> or
globally to ensure that the <literal>.desktop</literal> files are
installed properly into <literal>$XDG_CONFIG_DIRS</literal>. Otherwise it
won't be possible to open <literal>.ica</literal> files automatically from
the browser to start a Citrix connection.
</para> </para>
</warning> </warning>
</section> </section>
@ -452,17 +343,7 @@ overrides = self: super: rec {
<title>Custom certificates</title> <title>Custom certificates</title>
<para> <para>
The <literal>Citrix Workspace App</literal> in <literal>nixpkgs</literal> The <literal>Citrix Workspace App</literal> in <literal>nixpkgs</literal> trust 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>:
trust 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>:
<programlisting> <programlisting>
<![CDATA[with import <nixpkgs> { config.allowUnfree = true; }; <![CDATA[with import <nixpkgs> { config.allowUnfree = true; };
let extraCerts = [ ./custom-cert-1.pem ./custom-cert-2.pem /* ... */ ]; in let extraCerts = [ ./custom-cert-1.pem ./custom-cert-2.pem /* ... */ ]; in

34
doc/platform-notes.xml
View File

@ -12,12 +12,7 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
The Darwin <literal>stdenv</literal> uses clang instead of gcc. When 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.
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.
</para> </para>
<programlisting> <programlisting>
stdenv.mkDerivation { stdenv.mkDerivation {
@ -31,12 +26,7 @@ stdenv.mkDerivation {
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
On Darwin, libraries are linked using absolute paths, libraries are 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>.
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>.
</para> </para>
<programlisting> <programlisting>
stdenv.mkDerivation { stdenv.mkDerivation {
@ -48,16 +38,10 @@ stdenv.mkDerivation {
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Even if the libraries are linked using absolute paths and resolved via 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.
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.
</para> </para>
<para> <para>
This can usually be solved by running the tests after the 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>
<varname>installPhase</varname> or alternatively by using
<varname>DYLD_LIBRARY_PATH</varname>. More information about this variable
can be found in the <citerefentry>
<refentrytitle>dyld</refentrytitle> <refentrytitle>dyld</refentrytitle>
<manvolnum>1</manvolnum></citerefentry> manpage. <manvolnum>1</manvolnum></citerefentry> manpage.
</para> </para>
@ -78,11 +62,7 @@ stdenv.mkDerivation {
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Some packages assume xcode is available and use <command>xcrun</command> 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.
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.
</para> </para>
<programlisting> <programlisting>
stdenv.mkDerivation { stdenv.mkDerivation {
@ -95,9 +75,7 @@ stdenv.mkDerivation {
} }
</programlisting> </programlisting>
<para> <para>
The package <literal>xcbuild</literal> can be used to build projects that 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.
really depend on Xcode. However, this replacement is not 100% compatible
with Xcode and can occasionally cause issues.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>

144
doc/quick-start.xml
View File

@ -15,120 +15,75 @@
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Find a good place in the Nixpkgs tree to add the Nix expression for your 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.
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.
<screen> <screen>
<prompt>$ </prompt>mkdir pkgs/development/libraries/libfoo</screen> <prompt>$ </prompt>mkdir pkgs/development/libraries/libfoo</screen>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
In the package directory, create a Nix expression — a piece of code that 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>.
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>.
<screen> <screen>
<prompt>$ </prompt>emacs pkgs/development/libraries/libfoo/default.nix <prompt>$ </prompt>emacs pkgs/development/libraries/libfoo/default.nix
<prompt>$ </prompt>git add pkgs/development/libraries/libfoo/default.nix</screen> <prompt>$ </prompt>git add pkgs/development/libraries/libfoo/default.nix</screen>
</para> </para>
<para> <para>
You can have a look at the existing Nix expressions under 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:
<filename>pkgs/</filename> to see how it’s done. Here are some good
ones:
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
GNU Hello: GNU Hello: <link
<link 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.
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.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
GNU cpio: GNU cpio: <link
<link 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>.
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>.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
GNU Multiple Precision arithmetic library (GMP): GNU Multiple Precision arithmetic library (GMP): <link
<link 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>.
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>.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Pan, a GTK-based newsreader: Pan, a GTK-based newsreader: <link
<link 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>.
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>.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Apache HTTPD: Apache HTTPD: <link
<link 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.
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.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Thunderbird: Thunderbird: <link
<link 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.
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.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
JDiskReport, a Java utility: JDiskReport, a Java utility: <link
<link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/jdiskreport/default.nix"><filename>pkgs/tools/misc/jdiskreport/default.nix</filename></link> (and the <link
xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/jdiskreport/default.nix"><filename>pkgs/tools/misc/jdiskreport/default.nix</filename></link> xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/jdiskreport/builder.sh">builder</link>). Nixpkgs doesn’t have a decent <varname>stdenv</varname> for Java yet so this is pretty ad-hoc.
(and the
<link
xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/jdiskreport/builder.sh">builder</link>).
Nixpkgs doesn’t have a decent <varname>stdenv</varname> for Java yet
so this is pretty ad-hoc.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
XML::Simple, a Perl module: XML::Simple, a Perl module: <link
<link 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.
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.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Adobe Reader: Adobe Reader: <link
<link 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
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>. 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.
Shows how binary-only packages can be supported. In particular the
<link
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.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -138,67 +93,45 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
All <varname linkend="chap-meta">meta</varname> attributes are 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
optional, but it’s still a good idea to provide at least the
<varname>description</varname>, <varname>homepage</varname> and
<varname
linkend="sec-meta-license">license</varname>. linkend="sec-meta-license">license</varname>.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
You can use <command>nix-prefetch-url</command> 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.
<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.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
A list of schemes for <literal>mirror://</literal> URLs can be found in A list of schemes for <literal>mirror://</literal> URLs can be found in <link
<link
xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/build-support/fetchurl/mirrors.nix"><filename>pkgs/build-support/fetchurl/mirrors.nix</filename></link>. xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/build-support/fetchurl/mirrors.nix"><filename>pkgs/build-support/fetchurl/mirrors.nix</filename></link>.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</para> </para>
<para> <para>
The exact syntax and semantics of the Nix expression language, including The exact syntax and semantics of the Nix expression language, including the built-in function, are described in the Nix manual in the <link
the built-in function, are described in the Nix manual in the xlink:href="http://hydra.nixos.org/job/nix/trunk/tarball/latest/download-by-type/doc/manual/#chap-writing-nix-expressions">chapter on writing Nix expressions</link>.
<link
xlink:href="http://hydra.nixos.org/job/nix/trunk/tarball/latest/download-by-type/doc/manual/#chap-writing-nix-expressions">chapter
on writing Nix expressions</link>.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Add a call to the function defined in the previous step to Add a call to the function defined in the previous step to <link
<link 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>.
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>.
<screen> <screen>
<prompt>$ </prompt>emacs pkgs/top-level/all-packages.nix</screen> <prompt>$ </prompt>emacs pkgs/top-level/all-packages.nix</screen>
</para> </para>
<para> <para>
The attributes in that file are sorted by category (like “Development / 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.
Libraries”) that more-or-less correspond to the directory structure of
Nixpkgs, and then by attribute name.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
To test whether the package builds, run the following command from the To test whether the package builds, run the following command from the root of the nixpkgs source tree:
root of the nixpkgs source tree:
<screen> <screen>
<prompt>$ </prompt>nix-build -A libfoo</screen> <prompt>$ </prompt>nix-build -A libfoo</screen>
where <varname>libfoo</varname> should be the variable name defined in the 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.
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.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -210,14 +143,9 @@
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Optionally commit the new package and open a pull request Optionally commit the new package and open a pull request <link
<link xlink:href="https://github.com/NixOS/nixpkgs/pulls">to nixpkgs</link>, or use <link
xlink:href="https://github.com/NixOS/nixpkgs/pulls">to 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.
nixpkgs</link>, or use
<link
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.
</para> </para>
</listitem> </listitem>
</orderedlist> </orderedlist>

260
doc/release-notes.xml
View File

@ -6,15 +6,11 @@
<title>Release 0.14 (June 4, 2012)</title> <title>Release 0.14 (June 4, 2012)</title>
<para> <para>
In preparation for the switch from Subversion to Git, this release is mainly In preparation for the switch from Subversion to Git, this release is mainly the prevent the Nixpkgs version number from going backwards. (This would happen because prerelease version numbers produced for the Git repository are lower than those for the Subversion repository.)
the prevent the Nixpkgs version number from going backwards. (This would
happen because prerelease version numbers produced for the Git repository
are lower than those for the Subversion repository.)
</para> </para>
<para> <para>
Since the last release, there have been thousands of changes and new Since the last release, there have been thousands of changes and new packages by numerous contributors. For details, see the commit logs.
packages by numerous contributors. For details, see the commit logs.
</para> </para>
</section> </section>
<section xml:id="release-notes-0.13"> <section xml:id="release-notes-0.13">
@ -55,14 +51,11 @@
<title>Release 0.12 (April 24, 2009)</title> <title>Release 0.12 (April 24, 2009)</title>
<para> <para>
There are way too many additions to Nixpkgs since the last release to list There are way too many additions to Nixpkgs since the last release to list here: for example, the number of packages on Linux has increased from 1002 to 2159. However, some specific improvements are worth listing:
here: for example, the number of packages on Linux has increased from 1002
to 2159. However, some specific improvements are worth listing:
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
Nixpkgs now has a manual. In particular, it describes the standard build Nixpkgs now has a manual. In particular, it describes the standard build environment in detail.
environment in detail.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -122,9 +115,7 @@
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Support for building derivations in a virtual machine, including RPM and Support for building derivations in a virtual machine, including RPM and Debian builds in automatically generated VM images. See <filename>pkgs/build-support/vm/default.nix</filename> for details.
Debian builds in automatically generated VM images. See
<filename>pkgs/build-support/vm/default.nix</filename> for details.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -136,13 +127,7 @@
</para> </para>
<para> <para>
The following people contributed to this release: Andres Löh, Arie The following people contributed to this release: Andres Löh, Arie Middelkoop, Armijn Hemel, Eelco Dolstra, Lluís Batlle, Ludovic Courtès, Marc Weber, Mart Kolthof, Martin Bravenboer, Michael Raskin, Nicolas Pierron, Peter Simons, Pjotr Prins, Rob Vermaas, Sander van der Burg, Tobias Hammerschmidt, Valentin David, Wouter den Breejen and Yury G. Kudryashov. In addition, several people contributed patches on the <literal>nix-dev</literal> mailing list.
Middelkoop, Armijn Hemel, Eelco Dolstra, Lluís Batlle, Ludovic Courtès,
Marc Weber, Mart Kolthof, Martin Bravenboer, Michael Raskin, Nicolas
Pierron, Peter Simons, Pjotr Prins, Rob Vermaas, Sander van der Burg, Tobias
Hammerschmidt, Valentin David, Wouter den Breejen and Yury G. Kudryashov. In
addition, several people contributed patches on the
<literal>nix-dev</literal> mailing list.
</para> </para>
</section> </section>
<section xml:id="release-notes-0.11"> <section xml:id="release-notes-0.11">
@ -153,25 +138,12 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
The standard build environment (<literal>stdenv</literal>) is now pure on The standard build environment (<literal>stdenv</literal>) is now pure on the <literal>x86_64-linux</literal> and <literal>powerpc-linux</literal> platforms, just as on <literal>i686-linux</literal>. (Purity means that building and using the standard environment has no dependencies outside of the Nix store. For instance, it doesn’t require an external C compiler such as <filename>/usr/bin/gcc</filename>.) Also, the statically linked binaries used in the bootstrap process are now automatically reproducible, making it easy to update the bootstrap tools and to add support for other Linux platforms. See <filename>pkgs/stdenv/linux/make-bootstrap-tools.nix</filename> for details.
the <literal>x86_64-linux</literal> and <literal>powerpc-linux</literal>
platforms, just as on <literal>i686-linux</literal>. (Purity means that
building and using the standard environment has no dependencies outside
of the Nix store. For instance, it doesn’t require an external C
compiler such as <filename>/usr/bin/gcc</filename>.) Also, the statically
linked binaries used in the bootstrap process are now automatically
reproducible, making it easy to update the bootstrap tools and to add
support for other Linux platforms. See
<filename>pkgs/stdenv/linux/make-bootstrap-tools.nix</filename> for
details.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Hook variables in the generic builder are now executed using the Hook variables in the generic builder are now executed using the <function>eval</function> shell command. This has a major advantage: you can write hooks directly in Nix expressions. For instance, rather than writing a builder like this:
<function>eval</function> shell command. This has a major advantage: you
can write hooks directly in Nix expressions. For instance, rather than
writing a builder like this:
<programlisting> <programlisting>
source $stdenv/setup source $stdenv/setup
@ -182,91 +154,57 @@ postInstall() {
} }
genericBuild</programlisting> genericBuild</programlisting>
(the <literal>gzip</literal> builder), you can just add this attribute to (the <literal>gzip</literal> builder), you can just add this attribute to the derivation:
the derivation:
<programlisting> <programlisting>
postInstall = "ln -sf gzip $out/bin/gunzip; ln -sf gzip $out/bin/zcat";</programlisting> postInstall = "ln -sf gzip $out/bin/gunzip; ln -sf gzip $out/bin/zcat";</programlisting>
and so a separate build script becomes unnecessary. This should allow us and so a separate build script becomes unnecessary. This should allow us to get rid of most builders in Nixpkgs.
to get rid of most builders in Nixpkgs.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
It is now possible to have the generic builder pass arguments to It is now possible to have the generic builder pass arguments to <command>configure</command> and <command>make</command> that contain whitespace. Previously, for example, you could say in a builder,
<command>configure</command> and <command>make</command> that contain
whitespace. Previously, for example, you could say in a builder,
<programlisting> <programlisting>
configureFlags="CFLAGS=-O0"</programlisting> configureFlags="CFLAGS=-O0"</programlisting>
but not but not
<programlisting> <programlisting>
configureFlags="CFLAGS=-O0 -g"</programlisting> configureFlags="CFLAGS=-O0 -g"</programlisting>
since the <literal>-g</literal> would be interpreted as a separate since the <literal>-g</literal> would be interpreted as a separate argument to <command>configure</command>. Now you can say
argument to <command>configure</command>. Now you can say
<programlisting> <programlisting>
configureFlagsArray=("CFLAGS=-O0 -g")</programlisting> configureFlagsArray=("CFLAGS=-O0 -g")</programlisting>
or similarly or similarly
<programlisting> <programlisting>
configureFlagsArray=("CFLAGS=-O0 -g" "LDFLAGS=-L/foo -L/bar")</programlisting> configureFlagsArray=("CFLAGS=-O0 -g" "LDFLAGS=-L/foo -L/bar")</programlisting>
which does the right thing. Idem for <literal>makeFlags</literal>, which does the right thing. Idem for <literal>makeFlags</literal>, <literal>installFlags</literal>, <literal>checkFlags</literal> and <literal>distFlags</literal>.
<literal>installFlags</literal>, <literal>checkFlags</literal> and
<literal>distFlags</literal>.
</para> </para>
<para> <para>
Unfortunately you can't pass arrays to Bash through the environment, so Unfortunately you can't pass arrays to Bash through the environment, so you can't put the array above in a Nix expression, e.g.,
you can't put the array above in a Nix expression, e.g.,
<programlisting> <programlisting>
configureFlagsArray = ["CFLAGS=-O0 -g"];</programlisting> configureFlagsArray = ["CFLAGS=-O0 -g"];</programlisting>
since it would just be flattened to a since string. However, you since it would just be flattened to a since string. However, you <emphasis>can</emphasis> use the inline hooks described above:
<emphasis>can</emphasis> use the inline hooks described above:
<programlisting> <programlisting>
preConfigure = "configureFlagsArray=(\"CFLAGS=-O0 -g\")";</programlisting> preConfigure = "configureFlagsArray=(\"CFLAGS=-O0 -g\")";</programlisting>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
The function <function>fetchurl</function> now has support for two The function <function>fetchurl</function> now has support for two different kinds of mirroring of files. First, it has support for <emphasis>content-addressable mirrors</emphasis>. For example, given the <function>fetchurl</function> call
different kinds of mirroring of files. First, it has support for
<emphasis>content-addressable mirrors</emphasis>. For example, given the
<function>fetchurl</function> call
<programlisting> <programlisting>
fetchurl { fetchurl {
url = http://releases.mozilla.org/<replaceable>...</replaceable>/firefox-2.0.0.6-source.tar.bz2; url = http://releases.mozilla.org/<replaceable>...</replaceable>/firefox-2.0.0.6-source.tar.bz2;
sha1 = "eb72f55e4a8bf08e8c6ef227c0ade3d068ba1082"; sha1 = "eb72f55e4a8bf08e8c6ef227c0ade3d068ba1082";
}</programlisting> }</programlisting>
<function>fetchurl</function> will first try to download this file from <function>fetchurl</function> will first try to download this file from <link
<link xlink:href="http://tarballs.nixos.org/sha1/eb72f55e4a8bf08e8c6ef227c0ade3d068ba1082"/>. If that file doesn’t exist, it will try the original URL. In general, the “content-addressed” location is <replaceable>mirror</replaceable><literal>/</literal><replaceable>hash-type</replaceable><literal>/</literal><replaceable>hash</replaceable>. There is currently only one content-addressable mirror (<link
xlink:href="http://tarballs.nixos.org/sha1/eb72f55e4a8bf08e8c6ef227c0ade3d068ba1082"/>. xlink:href="http://tarballs.nixos.org"/>), but more can be specified in the <varname>hashedMirrors</varname> attribute in <filename>pkgs/build-support/fetchurl/mirrors.nix</filename>, or by setting the <envar>NIX_HASHED_MIRRORS</envar> environment variable to a whitespace-separated list of URLs.
If that file doesn’t exist, it will try the original URL. In general,
the “content-addressed” location is
<replaceable>mirror</replaceable><literal>/</literal><replaceable>hash-type</replaceable><literal>/</literal><replaceable>hash</replaceable>.
There is currently only one content-addressable mirror
(<link
xlink:href="http://tarballs.nixos.org"/>), but more can be
specified in the <varname>hashedMirrors</varname> attribute in
<filename>pkgs/build-support/fetchurl/mirrors.nix</filename>, or by
setting the <envar>NIX_HASHED_MIRRORS</envar> environment variable to a
whitespace-separated list of URLs.
</para> </para>
<para> <para>
Second, <function>fetchurl</function> has support for widely-mirrored Second, <function>fetchurl</function> has support for widely-mirrored distribution sites such as SourceForge or the Linux kernel archives. Given a URL of the form <literal>mirror://<replaceable>site</replaceable>/<replaceable>path</replaceable></literal>, it will try to download <replaceable>path</replaceable> from a configurable list of mirrors for <replaceable>site</replaceable>. (This idea was borrowed from Gentoo Linux.) Example:
distribution sites such as SourceForge or the Linux kernel archives.
Given a URL of the form
<literal>mirror://<replaceable>site</replaceable>/<replaceable>path</replaceable></literal>,
it will try to download <replaceable>path</replaceable> from a
configurable list of mirrors for <replaceable>site</replaceable>. (This
idea was borrowed from Gentoo Linux.) Example:
<programlisting> <programlisting>
fetchurl { fetchurl {
url = mirror://gnu/gcc/gcc-4.2.0/gcc-core-4.2.0.tar.bz2; url = mirror://gnu/gcc/gcc-4.2.0/gcc-core-4.2.0.tar.bz2;
sha256 = "0ykhzxhr8857dr97z0j9wyybfz1kjr71xk457cfapfw5fjas4ny1"; sha256 = "0ykhzxhr8857dr97z0j9wyybfz1kjr71xk457cfapfw5fjas4ny1";
}</programlisting> }</programlisting>
Currently <replaceable>site</replaceable> can be Currently <replaceable>site</replaceable> can be <literal>sourceforge</literal>, <literal>gnu</literal> and <literal>kernel</literal>. The list of mirrors is defined in <filename>pkgs/build-support/fetchurl/mirrors.nix</filename>. You can override the list of mirrors for a particular site by setting the environment variable <envar>NIX_MIRRORS_<replaceable>site</replaceable></envar>, e.g.
<literal>sourceforge</literal>, <literal>gnu</literal> and
<literal>kernel</literal>. The list of mirrors is defined in
<filename>pkgs/build-support/fetchurl/mirrors.nix</filename>. You can
override the list of mirrors for a particular site by setting the
environment variable
<envar>NIX_MIRRORS_<replaceable>site</replaceable></envar>, e.g.
<programlisting> <programlisting>
export NIX_MIRRORS_sourceforge=http://osdn.dl.sourceforge.net/sourceforge/</programlisting> export NIX_MIRRORS_sourceforge=http://osdn.dl.sourceforge.net/sourceforge/</programlisting>
</para> </para>
@ -339,9 +277,7 @@ export NIX_MIRRORS_sourceforge=http://osdn.dl.sourceforge.net/sourceforge/</prog
</para> </para>
<para> <para>
The following people contributed to this release: Andres Löh, Arie The following people contributed to this release: Andres Löh, Arie Middelkoop, Armijn Hemel, Eelco Dolstra, Marc Weber, Mart Kolthof, Martin Bravenboer, Michael Raskin, Wouter den Breejen and Yury G. Kudryashov.
Middelkoop, Armijn Hemel, Eelco Dolstra, Marc Weber, Mart Kolthof, Martin
Bravenboer, Michael Raskin, Wouter den Breejen and Yury G. Kudryashov.
</para> </para>
</section> </section>
<section xml:id="release-notes-0.10"> <section xml:id="release-notes-0.10">
@ -349,10 +285,8 @@ export NIX_MIRRORS_sourceforge=http://osdn.dl.sourceforge.net/sourceforge/</prog
<note> <note>
<para> <para>
This release of Nixpkgs requires This release of Nixpkgs requires <link
<link xlink:href='http://nixos.org/releases/nix/nix-0.10/'>Nix 0.10</link> or higher.
xlink:href='http://nixos.org/releases/nix/nix-0.10/'>Nix 0.10</link>
or higher.
</para> </para>
</note> </note>
@ -363,32 +297,15 @@ xlink:href='http://nixos.org/releases/nix/nix-0.10/'>Nix 0.10</link>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
<filename>pkgs/system/all-packages-generic.nix</filename> is gone, we now <filename>pkgs/system/all-packages-generic.nix</filename> is gone, we now just have <filename>pkgs/top-level/all-packages.nix</filename> that contains all available packages. This should cause much less confusion with users. <filename>all-packages.nix</filename> is a function that by default returns packages for the current platform, but you can override this by specifying a different <varname>system</varname> argument.
just have <filename>pkgs/top-level/all-packages.nix</filename> that
contains all available packages. This should cause much less confusion
with users. <filename>all-packages.nix</filename> is a function that by
default returns packages for the current platform, but you can override
this by specifying a different <varname>system</varname> argument.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Certain packages in Nixpkgs are now user-configurable through a Certain packages in Nixpkgs are now user-configurable through a configuration file, i.e., without having to edit the Nix expressions in Nixpkgs. For instance, the Firefox provided in the Nixpkgs channel is built without the RealPlayer plugin (for legal reasons). Previously, you could easily enable RealPlayer support by editing the call to the Firefox function in <filename>all-packages.nix</filename>, but such changes are not respected when Firefox is subsequently updated through the Nixpkgs channel.
configuration file, i.e., without having to edit the Nix expressions in
Nixpkgs. For instance, the Firefox provided in the Nixpkgs channel is
built without the RealPlayer plugin (for legal reasons). Previously, you
could easily enable RealPlayer support by editing the call to the Firefox
function in <filename>all-packages.nix</filename>, but such changes are
not respected when Firefox is subsequently updated through the Nixpkgs
channel.
</para> </para>
<para> <para>
The Nixpkgs configuration file (found in The Nixpkgs configuration file (found in <filename>~/.nixpkgs/config.nix</filename> or through the <envar>NIXPKGS_CONFIG</envar> environment variable) is an attribute set that contains configuration options that <filename>all-packages.nix</filename> reads and uses for certain packages. For instance, the following configuration file:
<filename>~/.nixpkgs/config.nix</filename> or through the
<envar>NIXPKGS_CONFIG</envar> environment variable) is an attribute set
that contains configuration options that
<filename>all-packages.nix</filename> reads and uses for certain packages.
For instance, the following configuration file:
<programlisting> <programlisting>
{ {
firefox = { firefox = {
@ -398,9 +315,7 @@ xlink:href='http://nixos.org/releases/nix/nix-0.10/'>Nix 0.10</link>
persistently enables RealPlayer support in the Firefox build. persistently enables RealPlayer support in the Firefox build.
</para> </para>
<para> <para>
(Actually, <literal>firefox.enableRealPlayer</literal> is the (Actually, <literal>firefox.enableRealPlayer</literal> is the <emphasis>only</emphasis> configuration option currently available, but more are sure to be added.)
<emphasis>only</emphasis> configuration option currently available, but
more are sure to be added.)
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -409,17 +324,8 @@ xlink:href='http://nixos.org/releases/nix/nix-0.10/'>Nix 0.10</link>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
<literal>i686-cygwin</literal>, i.e., Windows (using <literal>i686-cygwin</literal>, i.e., Windows (using <link xlink:href="http://www.cygwin.com/">Cygwin</link>). The standard environment on <literal>i686-cygwin</literal> by default builds binaries for the Cygwin environment (i.e., it uses Cygwin tools and produces executables that use the Cygwin library). However, there is also a standard environment that produces binaries that use <link
<link xlink:href="http://www.cygwin.com/">Cygwin</link>). The standard xlink:href="http://www.mingw.org/">MinGW</link>. You can use it by calling <filename>all-package.nix</filename> with the <varname>stdenvType</varname> argument set to <literal>"i686-mingw"</literal>.
environment on <literal>i686-cygwin</literal> by default builds
binaries for the Cygwin environment (i.e., it uses Cygwin tools and
produces executables that use the Cygwin library). However, there is
also a standard environment that produces binaries that use
<link
xlink:href="http://www.mingw.org/">MinGW</link>. You can
use it by calling <filename>all-package.nix</filename> with the
<varname>stdenvType</varname> argument set to
<literal>"i686-mingw"</literal>.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -434,9 +340,7 @@ xlink:href='http://nixos.org/releases/nix/nix-0.10/'>Nix 0.10</link>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<literal>x86_64-linux</literal>, i.e., Linux on 64-bit AMD/Intel CPUs. <literal>x86_64-linux</literal>, i.e., Linux on 64-bit AMD/Intel CPUs. Unlike <literal>i686-linux</literal>, this platform doesn’t have a pure <literal>stdenv</literal> yet.
Unlike <literal>i686-linux</literal>, this platform doesn’t have a
pure <literal>stdenv</literal> yet.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -472,21 +376,10 @@ xlink:href='http://nixos.org/releases/nix/nix-0.10/'>Nix 0.10</link>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
It is now <emphasis>much</emphasis> easier to override the default C It is now <emphasis>much</emphasis> easier to override the default C compiler and other tools in <literal>stdenv</literal> for specific packages. <filename>all-packages.nix</filename> provides two utility functions for this purpose: <function>overrideGCC</function> and <function>overrideInStdenv</function>. Both take a <literal>stdenv</literal> and return an augmented <literal>stdenv</literal>; the formed changes the C compiler, and the latter adds additional packages to the front of <literal>stdenv</literal>’s initial <envar>PATH</envar>, allowing tools to be overridden.
compiler and other tools in <literal>stdenv</literal> for specific
packages. <filename>all-packages.nix</filename> provides two utility
functions for this purpose: <function>overrideGCC</function> and
<function>overrideInStdenv</function>. Both take a
<literal>stdenv</literal> and return an augmented
<literal>stdenv</literal>; the formed changes the C compiler, and the
latter adds additional packages to the front of
<literal>stdenv</literal>’s initial <envar>PATH</envar>, allowing tools
to be overridden.
</para> </para>
<para> <para>
For instance, the package <varname>strategoxt</varname> doesn’t build For instance, the package <varname>strategoxt</varname> doesn’t build with the GNU Make in <literal>stdenv</literal> (version 3.81), so we call it with an augmented <literal>stdenv</literal> that uses GNU Make 3.80:
with the GNU Make in <literal>stdenv</literal> (version 3.81), so we call
it with an augmented <literal>stdenv</literal> that uses GNU Make 3.80:
<programlisting> <programlisting>
strategoxt = (import ../development/compilers/strategoxt) { strategoxt = (import ../development/compilers/strategoxt) {
inherit fetchurl pkgconfig sdf aterm; inherit fetchurl pkgconfig sdf aterm;
@ -494,8 +387,7 @@ strategoxt = (import ../development/compilers/strategoxt) {
}; };
gnumake380 = <replaceable>...</replaceable>;</programlisting> gnumake380 = <replaceable>...</replaceable>;</programlisting>
Likewise, there are many packages that don’t compile with the default Likewise, there are many packages that don’t compile with the default GCC (4.1.1), but that’s easily fixed:
GCC (4.1.1), but that’s easily fixed:
<programlisting> <programlisting>
exult = import ../games/exult { exult = import ../games/exult {
inherit fetchurl SDL SDL_mixer zlib libpng unzip; inherit fetchurl SDL SDL_mixer zlib libpng unzip;
@ -505,13 +397,7 @@ exult = import ../games/exult {
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
It has also become much easier to experiment with changes to the It has also become much easier to experiment with changes to the <literal>stdenv</literal> setup script (which notably contains the generic builder). Since edits to <filename>pkgs/stdenv/generic/setup.sh</filename> trigger a rebuild of <emphasis>everything</emphasis>, this was formerly quite painful. But now <literal>stdenv</literal> contains a function to “regenerate” <literal>stdenv</literal> with a different setup script, allowing the use of a different setup script for specific packages:
<literal>stdenv</literal> setup script (which notably contains the generic
builder). Since edits to <filename>pkgs/stdenv/generic/setup.sh</filename>
trigger a rebuild of <emphasis>everything</emphasis>, this was formerly
quite painful. But now <literal>stdenv</literal> contains a function to
“regenerate” <literal>stdenv</literal> with a different setup script,
allowing the use of a different setup script for specific packages:
<programlisting> <programlisting>
pkg = import <replaceable>...</replaceable> { pkg = import <replaceable>...</replaceable> {
stdenv = stdenv.regenerate ./my-setup.sh; stdenv = stdenv.regenerate ./my-setup.sh;
@ -521,10 +407,7 @@ pkg = import <replaceable>...</replaceable> {
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Packages can now have a human-readable <emphasis>description</emphasis> Packages can now have a human-readable <emphasis>description</emphasis> field. Package descriptions are shown by <literal>nix-env -qa --description</literal>. In addition, they’re shown on the Nixpkgs release page. A description can be added to a package as follows:
field. Package descriptions are shown by <literal>nix-env -qa
--description</literal>. In addition, they’re shown on the Nixpkgs
release page. A description can be added to a package as follows:
<programlisting> <programlisting>
stdenv.mkDerivation { stdenv.mkDerivation {
name = "exult-1.2"; name = "exult-1.2";
@ -533,34 +416,26 @@ stdenv.mkDerivation {
description = "A reimplementation of the Ultima VII game engine"; description = "A reimplementation of the Ultima VII game engine";
}; };
}</programlisting> }</programlisting>
The <varname>meta</varname> attribute is not passed to the builder, so The <varname>meta</varname> attribute is not passed to the builder, so changes to the description do not trigger a rebuild. Additional <varname>meta</varname> attributes may be defined in the future (such as the URL of the package’s homepage, the license, etc.).
changes to the description do not trigger a rebuild. Additional
<varname>meta</varname> attributes may be defined in the future (such as
the URL of the package’s homepage, the license, etc.).
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<para> <para>
The following people contributed to this release: Andres Löh, Armijn Hemel, The following people contributed to this release: Andres Löh, Armijn Hemel, Christof Douma, Eelco Dolstra, Eelco Visser, Mart Kolthof, Martin Bravenboer, Merijn de Jonge, Rob Vermaas and Roy van den Broek.
Christof Douma, Eelco Dolstra, Eelco Visser, Mart Kolthof, Martin
Bravenboer, Merijn de Jonge, Rob Vermaas and Roy van den Broek.
</para> </para>
</section> </section>
<section xml:id="release-notes-0.9"> <section xml:id="release-notes-0.9">
<title>Release 0.9 (January 31, 2006)</title> <title>Release 0.9 (January 31, 2006)</title>
<para> <para>
There have been zillions of changes since the last release of Nixpkgs. Many There have been zillions of changes since the last release of Nixpkgs. Many packages have been added or updated. The following are some of the more notable changes:
packages have been added or updated. The following are some of the more
notable changes:
</para> </para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
Distribution files have been moved to Distribution files have been moved to <link
<link
xlink:href="http://nixos.org/" />. xlink:href="http://nixos.org/" />.
</para> </para>
</listitem> </listitem>
@ -576,24 +451,17 @@ stdenv.mkDerivation {
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
The old, unofficial Xlibs has been replaced by the official modularised The old, unofficial Xlibs has been replaced by the official modularised X11 distribution from X.org, i.e., X11R7.0. X11R7.0 consists of 287 (!) packages, all of which are in Nixpkgs though not all have been tested. It is now possible to build a working X server (previously we only had X client libraries). We use a fully Nixified X server on NixOS.
X11 distribution from X.org, i.e., X11R7.0. X11R7.0 consists of 287 (!)
packages, all of which are in Nixpkgs though not all have been tested. It
is now possible to build a working X server (previously we only had X
client libraries). We use a fully Nixified X server on NixOS.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
The Sun JDK 5 has been purified, i.e., it doesn’t require any non-Nix The Sun JDK 5 has been purified, i.e., it doesn’t require any non-Nix components such as <filename>/lib/ld-linux.so.2</filename>. This means that Java applications such as Eclipse and Azureus can run on NixOS.
components such as <filename>/lib/ld-linux.so.2</filename>. This means
that Java applications such as Eclipse and Azureus can run on NixOS.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Hardware-accelerated OpenGL support, used by games like Quake 3 (which is Hardware-accelerated OpenGL support, used by games like Quake 3 (which is now built from source).
now built from source).
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -608,8 +476,7 @@ stdenv.mkDerivation {
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Some support for cross-compilation: cross-compiling builds of GCC and Some support for cross-compilation: cross-compiling builds of GCC and Binutils, and cross-compiled builds of the C library uClibc.
Binutils, and cross-compiled builds of the C library uClibc.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -618,8 +485,7 @@ stdenv.mkDerivation {
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
teTeX, including support for building LaTeX documents using Nix (with teTeX, including support for building LaTeX documents using Nix (with automatic dependency determination).
automatic dependency determination).
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -629,14 +495,12 @@ stdenv.mkDerivation {
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
System-level packages to support NixOS, e.g. Grub, GNU System-level packages to support NixOS, e.g. Grub, GNU <literal>parted</literal> and so on.
<literal>parted</literal> and so on.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<literal>ecj</literal>, the Eclipse Compiler for Java, so we finally <literal>ecj</literal>, the Eclipse Compiler for Java, so we finally have a freely distributable compiler that supports Java 5.0.
have a freely distributable compiler that supports Java 5.0.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -661,8 +525,7 @@ stdenv.mkDerivation {
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<literal>kdelibs</literal>. This allows us to add KDE-based packages <literal>kdelibs</literal>. This allows us to add KDE-based packages (such as <literal>kcachegrind</literal>).
(such as <literal>kcachegrind</literal>).
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -671,17 +534,14 @@ stdenv.mkDerivation {
</itemizedlist> </itemizedlist>
<para> <para>
The following people contributed to this release: Andres Löh, Armijn Hemel, The following people contributed to this release: Andres Löh, Armijn Hemel, Bogdan Dumitriu, Christof Douma, Eelco Dolstra, Eelco Visser, Mart Kolthof, Martin Bravenboer, Rob Vermaas and Roy van den Broek.
Bogdan Dumitriu, Christof Douma, Eelco Dolstra, Eelco Visser, Mart Kolthof,
Martin Bravenboer, Rob Vermaas and Roy van den Broek.
</para> </para>
</section> </section>
<section xml:id="release-notes-0.8"> <section xml:id="release-notes-0.8">
<title>Release 0.8 (April 11, 2005)</title> <title>Release 0.8 (April 11, 2005)</title>
<para> <para>
This release is mostly to remain synchronised with the changed hashing This release is mostly to remain synchronised with the changed hashing scheme in Nix 0.8.
scheme in Nix 0.8.
</para> </para>
<para> <para>
@ -706,16 +566,10 @@ stdenv.mkDerivation {
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
The bootstrap process for the standard build environment on Linux The bootstrap process for the standard build environment on Linux (stdenv-linux) has been improved. It is no longer dependent in its initial bootstrap stages on the system Glibc, GCC, and other tools. Rather, Nixpkgs contains a statically linked bash and curl, and uses that to download other statically linked tools. These are then used to build a Glibc and dynamically linked versions of all other tools.
(stdenv-linux) has been improved. It is no longer dependent in its initial
bootstrap stages on the system Glibc, GCC, and other tools. Rather,
Nixpkgs contains a statically linked bash and curl, and uses that to
download other statically linked tools. These are then used to build a
Glibc and dynamically linked versions of all other tools.
</para> </para>
<para> <para>
This change also makes the bootstrap process faster. For instance, GCC is This change also makes the bootstrap process faster. For instance, GCC is built only once instead of three times.
built only once instead of three times.
</para> </para>
<para> <para>
(Contributed by Armijn Hemel.) (Contributed by Armijn Hemel.)
@ -723,17 +577,13 @@ stdenv.mkDerivation {
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Tarballs used by Nixpkgs are now obtained from the same server that hosts Tarballs used by Nixpkgs are now obtained from the same server that hosts Nixpkgs (<link
Nixpkgs (<link xlink:href="http://catamaran.labs.cs.uu.nl/" />). This reduces the risk of packages being unbuildable due to moved or deleted files on various servers.
xlink:href="http://catamaran.labs.cs.uu.nl/" />). This
reduces the risk of packages being unbuildable due to moved or deleted
files on various servers.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
There now is a generic mechanism for building Perl modules. See the There now is a generic mechanism for building Perl modules. See the various Perl modules defined in pkgs/system/all-packages-generic.nix.
various Perl modules defined in pkgs/system/all-packages-generic.nix.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>

160
doc/reviewing-contributions.xml
View File

@ -6,68 +6,40 @@
<title>Reviewing contributions</title> <title>Reviewing contributions</title>
<warning> <warning>
<para> <para>
The following section is a draft, and the policy for reviewing is still The following section is a draft, and the policy for reviewing is still being discussed in issues such as <link
being discussed in issues such as xlink:href="https://github.com/NixOS/nixpkgs/issues/11166">#11166 </link> and <link
<link xlink:href="https://github.com/NixOS/nixpkgs/issues/20836">#20836 </link>.
xlink:href="https://github.com/NixOS/nixpkgs/issues/11166">#11166
</link> and
<link
xlink:href="https://github.com/NixOS/nixpkgs/issues/20836">#20836
</link>.
</para> </para>
</warning> </warning>
<para> <para>
The Nixpkgs project receives a fairly high number of contributions via GitHub 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.
pull requests. Reviewing and approving these is an important task and a way
to contribute to the project.
</para> </para>
<para> <para>
The high change rate of Nixpkgs makes any pull request that remains open for 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
too long subject to conflicts that will require extra work from the submitter xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc">most recently</link> and the <link
or the merger. Reviewing pull requests in a timely manner and being 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>.
responsive to the comments is the key to avoid this issue. GitHub provides
sort filters that can be used to see the
<link
xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc">most
recently</link> and the
<link
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>.
</para> </para>
<para> <para>
When reviewing a pull request, please always be nice and polite. 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.
Controversial changes can lead to controversial opinions, but it is important
to respect every community member and their work.
</para> </para>
<para> <para>
GitHub provides reactions as a simple and quick way to provide feedback to 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.
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.
</para> </para>
<para> <para>
pull request reviews should include a list of what has been reviewed in a 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.
comment, so other reviewers and mergers can know the state of the review.
</para> </para>
<para> <para>
All the review template samples provided in this section are generic and 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.
meant as examples. Their usage is optional and the reviewer is free to adapt
them to their liking.
</para> </para>
<section xml:id="reviewing-contributions-package-updates"> <section xml:id="reviewing-contributions-package-updates">
<title>Package updates</title> <title>Package updates</title>
<para> <para>
A package update is the most trivial and common type of pull request. These 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.
pull requests mainly consist of updating the version part of the package
name and the source hash.
</para> </para>
<para> <para>
It can happen that non-trivial updates include patches or more complex It can happen that non-trivial updates include patches or more complex changes.
changes.
</para> </para>
<para> <para>
@ -82,8 +54,7 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
<literal>8.has: package (update)</literal> and any topic label that fit <literal>8.has: package (update)</literal> and any topic label that fit the updated package.
the updated package.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -105,9 +76,7 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
<link xlink:href="https://help.github.com/articles/about-codeowners/">CODEOWNERS</link> <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.
will make GitHub notify users based on the submitted changes, but it can
happen that it misses some of the package maintainers.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -119,15 +88,12 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
License can change with version updates, so it should be checked to License can change with version updates, so it should be checked to match the upstream license.
match the upstream license.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
If the package has no maintainer, a maintainer must be set. This can be 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.
the update submitter or a community member that accepts to take
maintainership of the package.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -144,14 +110,10 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
pull requests are often targeted to the master or staging branch, and 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.
building the pull request locally when it is submitted can trigger many
source builds.
</para> </para>
<para> <para>
It is possible to rebase the changes on nixos-unstable or 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.
nixpkgs-unstable for easier review by running the following commands
from a nixpkgs clone.
<screen> <screen>
<prompt>$ </prompt>git remote add channels https://github.com/NixOS/nixpkgs-channels.git <co <prompt>$ </prompt>git remote add channels https://github.com/NixOS/nixpkgs-channels.git <co
xml:id='reviewing-rebase-1' /> xml:id='reviewing-rebase-1' />
@ -163,8 +125,7 @@
<calloutlist> <calloutlist>
<callout arearefs='reviewing-rebase-1'> <callout arearefs='reviewing-rebase-1'>
<para> <para>
This should be done only once to be able to fetch channel branches This should be done only once to be able to fetch channel branches from the nixpkgs-channels repository.
from the nixpkgs-channels repository.
</para> </para>
</callout> </callout>
<callout arearefs='reviewing-rebase-2'> <callout arearefs='reviewing-rebase-2'>
@ -174,9 +135,7 @@
</callout> </callout>
<callout arearefs='reviewing-rebase-3'> <callout arearefs='reviewing-rebase-3'>
<para> <para>
Fetching the pull request changes, <varname>PRNUMBER</varname> is the 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.
number at the end of the pull request title and
<varname>BASEBRANCH</varname> the base branch of the pull request.
</para> </para>
</callout> </callout>
<callout arearefs='reviewing-rebase-4'> <callout arearefs='reviewing-rebase-4'>
@ -189,12 +148,7 @@
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
The The <link xlink:href="https://github.com/Mic92/nix-review">nix-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.
<link xlink:href="https://github.com/Mic92/nix-review">nix-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.
</para> </para>
<screen> <screen>
<prompt>$ </prompt>nix-shell -p nix-review --run "nix-review pr PRNUMBER" <prompt>$ </prompt>nix-shell -p nix-review --run "nix-review pr PRNUMBER"
@ -231,8 +185,7 @@
<title>New packages</title> <title>New packages</title>
<para> <para>
New packages are a common type of pull requests. These pull requests New packages are a common type of pull requests. These pull requests consists in adding a new nix-expression for a package.
consists in adding a new nix-expression for a package.
</para> </para>
<para> <para>
@ -247,8 +200,7 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
<literal>8.has: package (new)</literal> and any topic label that fit the <literal>8.has: package (new)</literal> and any topic label that fit the new package.
new package.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -280,8 +232,7 @@
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
A maintainer must be set. This can be the package submitter or a A maintainer must be set. This can be the package submitter or a community member that accepts to take maintainership of the package.
community member that accepts to take maintainership of the package.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -303,8 +254,7 @@
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
The most appropriate function should be used (e.g. packages from GitHub The most appropriate function should be used (e.g. packages from GitHub should use <literal>fetchFromGitHub</literal>).
should use <literal>fetchFromGitHub</literal>).
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -351,8 +301,7 @@
<title>Module updates</title> <title>Module updates</title>
<para> <para>
Module updates are submissions changing modules in some ways. These often Module updates are submissions changing modules in some ways. These often contains changes to the options or introduce new options.
contains changes to the options or introduce new options.
</para> </para>
<para> <para>
@ -367,8 +316,7 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
<literal>8.has: module (update)</literal> and any topic label that fit <literal>8.has: module (update)</literal> and any topic label that fit the module.
the module.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -380,9 +328,7 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
<link xlink:href="https://help.github.com/articles/about-codeowners/">CODEOWNERS</link> <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.
will make GitHub notify users based on the submitted changes, but it can
happen that it misses some of the package maintainers.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -399,9 +345,7 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
Type should be appropriate (string related types differs in their Type should be appropriate (string related types differs in their merging capabilities, <literal>optionSet</literal> and <literal>string</literal> types are deprecated).
merging capabilities, <literal>optionSet</literal> and
<literal>string</literal> types are deprecated).
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -418,23 +362,19 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
<literal>mkRenamedOptionModule</literal> and <literal>mkRenamedOptionModule</literal> and <literal>mkAliasOptionModule</literal> functions provide way to make option changes backward compatible.
<literal>mkAliasOptionModule</literal> functions provide way to make
option changes backward compatible.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Ensure that removed options are declared with Ensure that removed options are declared with <literal>mkRemovedOptionModule</literal>
<literal>mkRemovedOptionModule</literal>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Ensure that changes that are not backward compatible are mentioned in Ensure that changes that are not backward compatible are mentioned in release notes.
release notes.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -480,8 +420,7 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
<literal>8.has: module (new)</literal> and any topic label that fit the <literal>8.has: module (new)</literal> and any topic label that fit the module.
module.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -498,9 +437,7 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
Type should be appropriate (string related types differs in their Type should be appropriate (string related types differs in their merging capabilities, <literal>optionSet</literal> and <literal>string</literal> types are deprecated).
merging capabilities, <literal>optionSet</literal> and
<literal>string</literal> types are deprecated).
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -522,8 +459,7 @@
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Module documentation should be declared with Module documentation should be declared with <literal>meta.doc</literal>.
<literal>meta.doc</literal>.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -535,8 +471,7 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
For example, enabling a module should not open firewall ports by For example, enabling a module should not open firewall ports by default.
default.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -573,25 +508,18 @@
</para> </para>
<para> <para>
If you consider having enough knowledge and experience in a topic and would 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.
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.
</para> </para>
<para> <para>
Container system, boot system and library changes are some examples of the Container system, boot system and library changes are some examples of the pull requests fitting this category.
pull requests fitting this category.
</para> </para>
</section> </section>
<section xml:id="reviewing-contributions--merging-pull-requests"> <section xml:id="reviewing-contributions--merging-pull-requests">
<title>Merging pull requests</title> <title>Merging pull requests</title>
<para> <para>
It is possible for community members that have enough knowledge and It is possible for community members that have enough knowledge and experience on a special topic to contribute by merging pull requests.
experience on a special topic to contribute by merging pull requests.
</para> </para>
<para> <para>
@ -608,12 +536,8 @@ policy.
--> -->
<para> <para>
In a case a contributor definitively leaves the Nix community, they should In a case a contributor definitively leaves the Nix community, they should create an issue or post on <link
create an issue or post on 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.
<link
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.
</para> </para>
</section> </section>
</chapter> </chapter>

1279
doc/stdenv.xml
View File

File diff suppressed because it is too large Load Diff

171
doc/submitting-changes.xml
View File

@ -8,8 +8,7 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
Read <link xlink:href="https://nixos.org/nixpkgs/manual/">Manual (How to Read <link xlink:href="https://nixos.org/nixpkgs/manual/">Manual (How to write packages for Nix)</link>.
write packages for Nix)</link>.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -23,15 +22,11 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
You can make branch from a commit of your local You can make branch from a commit of your local <command>nixos-version</command>. That will help you to avoid additional local compilations. Because you will receive packages from binary cache.
<command>nixos-version</command>. That will help you to avoid
additional local compilations. Because you will receive packages from
binary cache.
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
For example: <command>nixos-version</command> returns For example: <command>nixos-version</command> returns <command>15.05.git.0998212 (Dingo)</command>. So you can do:
<command>15.05.git.0998212 (Dingo)</command>. So you can do:
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -55,9 +50,7 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
If you removed pkgs, made some major NixOS changes etc., write about If you removed pkgs, made some major NixOS changes etc., write about them in <command>nixos/doc/manual/release-notes/rl-unstable.xml</command>.
them in
<command>nixos/doc/manual/release-notes/rl-unstable.xml</command>.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -65,8 +58,7 @@
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Check for unnecessary whitespace with <command>git diff --check</command> Check for unnecessary whitespace with <command>git diff --check</command> before committing.
before committing.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -121,8 +113,7 @@ Additional information.
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
<command>nix-env -i pkg-name -f &lt;path to your local nixpkgs <command>nix-env -i pkg-name -f &lt;path to your local nixpkgs folder&gt;</command>
folder&gt;</command>
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -134,14 +125,12 @@ Additional information.
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
Make sure it's in Make sure it's in <command>pkgs/top-level/all-packages.nix</command>
<command>pkgs/top-level/all-packages.nix</command>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<command>nix-env -i pkg-name -f &lt;path to your local nixpkgs <command>nix-env -i pkg-name -f &lt;path to your local nixpkgs folder&gt;</command>
folder&gt;</command>
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -149,15 +138,11 @@ Additional information.
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<emphasis>If you don't want to install pkg in you <emphasis>If you don't want to install pkg in you profile</emphasis>.
profile</emphasis>.
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
<command>nix-build -A pkg-attribute-name &lt;path to your local <command>nix-build -A pkg-attribute-name &lt;path to your local nixpkgs folder&gt;/default.nix</command> and check results in the folder <command>result</command>. It will appear in the same directory where you did <command>nix-build</command>.
nixpkgs folder&gt;/default.nix</command> and check results in the
folder <command>result</command>. It will appear in the same
directory where you did <command>nix-build</command>.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -165,9 +150,7 @@ Additional information.
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
If you did <command>nix-env -i pkg-name</command> you can do If you did <command>nix-env -i pkg-name</command> you can do <command>nix-env -e pkg-name</command> to uninstall it from your system.
<command>nix-env -e pkg-name</command> to uninstall it from your
system.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -179,10 +162,7 @@ Additional information.
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
You can add new module to your NixOS configuration file (usually You can add new module to your NixOS configuration file (usually it's <command>/etc/nixos/configuration.nix</command>). And do <command>sudo nixos-rebuild test -I nixpkgs=&lt;path to your local nixpkgs folder&gt; --fast</command>.
it's <command>/etc/nixos/configuration.nix</command>). And do
<command>sudo nixos-rebuild test -I nixpkgs=&lt;path to your local
nixpkgs folder&gt; --fast</command>.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -193,9 +173,7 @@ Additional information.
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
If you have commits <command>pkg-name: oh, forgot to insert If you have commits <command>pkg-name: oh, forgot to insert whitespace</command>: squash commits in this case. Use <command>git rebase -i</command>.
whitespace</command>: squash commits in this case. Use <command>git rebase
-i</command>.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -220,8 +198,7 @@ Additional information.
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
Write the title in format <command>(pkg-name | nixos/&lt;module>): Write the title in format <command>(pkg-name | nixos/&lt;module>): improvement</command>.
improvement</command>.
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
@ -233,8 +210,7 @@ Additional information.
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Write in comment if you have tested your patch. Do not rely much on Write in comment if you have tested your patch. Do not rely much on <command>TravisCI</command>.
<command>TravisCI</command>.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -244,8 +220,7 @@ Additional information.
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Notify maintainers of the package. For example add to the message: Notify maintainers of the package. For example add to the message: <command>cc @jagajaga @domenkozar</command>.
<command>cc @jagajaga @domenkozar</command>.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -257,64 +232,39 @@ Additional information.
<title>Pull Request Template</title> <title>Pull Request Template</title>
<para> <para>
The pull request template helps determine what steps have been made for a The pull request template helps determine what steps have been made for a contribution so far, and will help guide maintainers on the status of a change. The motivation section of the PR should include any extra details the title does not address and link any existing issues related to the pull request.
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.
</para> </para>
<para> <para>
When a PR is created, it will be pre-populated with some checkboxes detailed When a PR is created, it will be pre-populated with some checkboxes detailed below:
below:
</para> </para>
<section xml:id="submitting-changes-tested-with-sandbox"> <section xml:id="submitting-changes-tested-with-sandbox">
<title>Tested using sandboxing</title> <title>Tested using sandboxing</title>
<para> <para>
When sandbox builds are enabled, Nix will setup an isolated environment for When sandbox builds are enabled, Nix will setup an isolated environment for each build process. It is used to remove further hidden dependencies set by the build environment to improve reproducibility. This includes access to the network during the build outside of <function>fetch*</function> functions and files outside the Nix store. Depending on the operating system access to other resources are blocked as well (ex. inter process communication is isolated on Linux); see <link
each build process. It is used to remove further hidden dependencies set by xlink:href="https://nixos.org/nix/manual/#description-45">build-use-sandbox</link> in Nix manual for details.
the build environment to improve reproducibility. This includes access to
the network during the build outside of <function>fetch*</function>
functions and files outside the Nix store. Depending on the operating
system access to other resources are blocked as well (ex. inter process
communication is isolated on Linux); see
<link
xlink:href="https://nixos.org/nix/manual/#description-45">build-use-sandbox</link>
in Nix manual for details.
</para> </para>
<para> <para>
Sandboxing is not enabled by default in Nix due to a small performance hit Sandboxing is not enabled by default in Nix due to a small performance hit on each build. In pull requests for <link
on each build. In pull requests for xlink:href="https://github.com/NixOS/nixpkgs/">nixpkgs</link> people are asked to test builds with sandboxing enabled (see <literal>Tested using sandboxing</literal> in the pull request template) because in<link
<link xlink:href="https://nixos.org/hydra/">https://nixos.org/hydra/</link> sandboxing is also used.
xlink:href="https://github.com/NixOS/nixpkgs/">nixpkgs</link>
people are asked to test builds with sandboxing enabled (see
<literal>Tested using sandboxing</literal> in the pull request template)
because
in<link
xlink:href="https://nixos.org/hydra/">https://nixos.org/hydra/</link>
sandboxing is also used.
</para> </para>
<para> <para>
Depending if you use NixOS or other platforms you can use one of the Depending if you use NixOS or other platforms you can use one of the following methods to enable sandboxing <emphasis role="bold">before</emphasis> building the package:
following methods to enable sandboxing
<emphasis role="bold">before</emphasis> building the package:
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
<emphasis role="bold">Globally enable sandboxing on NixOS</emphasis>: <emphasis role="bold">Globally enable sandboxing on NixOS</emphasis>: add the following to <filename>configuration.nix</filename>
add the following to <filename>configuration.nix</filename>
<screen>nix.useSandbox = true;</screen> <screen>nix.useSandbox = true;</screen>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<emphasis role="bold">Globally enable sandboxing on non-NixOS <emphasis role="bold">Globally enable sandboxing on non-NixOS platforms</emphasis>: add the following to: <filename>/etc/nix/nix.conf</filename>
platforms</emphasis>: add the following to:
<filename>/etc/nix/nix.conf</filename>
<screen>build-use-sandbox = true</screen> <screen>build-use-sandbox = true</screen>
</para> </para>
</listitem> </listitem>
@ -326,11 +276,7 @@ Additional information.
<title>Built on platform(s)</title> <title>Built on platform(s)</title>
<para> <para>
Many Nix packages are designed to run on multiple platforms. As such, it's Many Nix packages are designed to run on multiple platforms. As such, it's important to let the maintainer know which platforms your changes have been tested on. It's not always practical to test a change on all platforms, and is not required for a pull request to be merged. Only check the systems you tested the build on in this section.
important to let the maintainer know which platforms your changes have been
tested on. It's not always practical to test a change on all platforms, and
is not required for a pull request to be merged. Only check the systems you
tested the build on in this section.
</para> </para>
</section> </section>
@ -338,15 +284,8 @@ Additional information.
<title>Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)</title> <title>Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)</title>
<para> <para>
Packages with automated tests are much more likely to be merged in a timely 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 <link
fashion because it doesn't require as much manual testing by the maintainer xlink:href="https://nixos.org/nixos/manual/index.html#sec-nixos-tests">section in the NixOS manual</link>.
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
<link
xlink:href="https://nixos.org/nixos/manual/index.html#sec-nixos-tests">section
in the NixOS manual</link>.
</para> </para>
</section> </section>
@ -354,11 +293,7 @@ Additional information.
<title>Tested compilation of all pkgs that depend on this change using <command>nix-review</command></title> <title>Tested compilation of all pkgs that depend on this change using <command>nix-review</command></title>
<para> <para>
If you are updating a package's version, you can use nix-review to make If you are updating a package's version, you can use nix-review to make sure all packages that depend on the updated package still compile correctly. The <command>nix-review</command> utility can look for and build all dependencies either based on uncommited changes with the <literal>wip</literal> option or specifying a github pull request number.
sure all packages that depend on the updated package still compile
correctly. The <command>nix-review</command> utility can look for and build
all dependencies either based on uncommited changes with the
<literal>wip</literal> option or specifying a github pull request number.
</para> </para>
<para> <para>
@ -376,13 +311,7 @@ Additional information.
<title>Tested execution of all binary files (usually in <filename>./result/bin/</filename>)</title> <title>Tested execution of all binary files (usually in <filename>./result/bin/</filename>)</title>
<para> <para>
It's important to test any executables generated by a build when you change It's important to test any executables generated by a build when you change or create a package in nixpkgs. This can be done by looking in <filename>./result/bin</filename> and running any files in there, or at a minimum, the main executable for the package. For example, if you make a change to <package>texlive</package>, you probably would only check the binaries associated with the change you made rather than testing all of them.
or create a package in nixpkgs. This can be done by looking in
<filename>./result/bin</filename> and running any files in there, or at a
minimum, the main executable for the package. For example, if you make a
change to <package>texlive</package>, you probably would only check the
binaries associated with the change you made rather than testing all of
them.
</para> </para>
</section> </section>
@ -390,14 +319,8 @@ Additional information.
<title>Meets Nixpkgs contribution standards</title> <title>Meets Nixpkgs contribution standards</title>
<para> <para>
The last checkbox is fits The last checkbox is fits <link
<link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/.github/CONTRIBUTING.md">CONTRIBUTING.md</link>. 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.
xlink:href="https://github.com/NixOS/nixpkgs/blob/master/.github/CONTRIBUTING.md">CONTRIBUTING.md</link>.
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.
</para> </para>
</section> </section>
</section> </section>
@ -435,22 +358,17 @@ Additional information.
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
Commits must be sufficiently tested before being merged, both for the Commits must be sufficiently tested before being merged, both for the master and staging branches.
master and staging branches.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Hydra builds for master and staging should not be used as testing Hydra builds for master and staging should not be used as testing platform, it's a build farm for changes that have been already tested.
platform, it's a build farm for changes that have been already tested.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
When changing the bootloader installation process, extra care must be When changing the bootloader installation process, extra care must be taken. Grub installations cannot be rolled back, hence changes may break people's installations forever. For any non-trivial change to the bootloader please file a PR asking for review, especially from @edolstra.
taken. Grub installations cannot be rolled back, hence changes may break
people's installations forever. For any non-trivial change to the
bootloader please file a PR asking for review, especially from @edolstra.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -473,20 +391,12 @@ Additional information.
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
It's only for non-breaking mass-rebuild commits. That means it's not to It's only for non-breaking mass-rebuild commits. That means it's not to be used for testing, and changes must have been well tested already. <link xlink:href="https://web.archive.org/web/20160528180406/http://comments.gmane.org/gmane.linux.distributions.nixos/13447">Read policy here</link>.
be used for testing, and changes must have been well tested already.
<link xlink:href="https://web.archive.org/web/20160528180406/http://comments.gmane.org/gmane.linux.distributions.nixos/13447">Read
policy here</link>.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
If the branch is already in a broken state, please refrain from adding If the branch is already in a broken state, please refrain from adding extra new breakages. Stabilize it for a few days, merge into master, then resume development on staging. <link xlink:href="http://hydra.nixos.org/jobset/nixpkgs/staging#tabs-evaluations">Keep an eye on the staging evaluations here</link>. If any fixes for staging happen to be already in master, then master can be merged into staging.
extra new breakages. Stabilize it for a few days, merge into master, then
resume development on staging.
<link xlink:href="http://hydra.nixos.org/jobset/nixpkgs/staging#tabs-evaluations">Keep
an eye on the staging evaluations here</link>. If any fixes for staging
happen to be already in master, then master can be merged into staging.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -498,10 +408,7 @@ Additional information.
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
If you're cherry-picking a commit to a stable release branch, always use If you're cherry-picking a commit to a stable release branch, always use <command>git cherry-pick -xe</command> and ensure the message contains a clear description about why this needs to be included in the stable branch.
<command>git cherry-pick -xe</command> and ensure the message contains a
clear description about why this needs to be included in the stable
branch.
</para> </para>
<para> <para>
An example of a cherry-picked commit would look like this: An example of a cherry-picked commit would look like this: