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

nixpkgs docs: format =)

Browse Source
This commit is contained in:
Graham Christensen 2018-05-01 19:54:21 -04:00
parent fd2dce9708
commit 77161de454
No known key found for this signature in database
GPG Key ID: ACA1C1D120C83D5C
27 changed files with 8153 additions and 6710 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

688
doc/coding-conventions.xml
View File

File diff suppressed because it is too large Load Diff

359
doc/configuration.xml
View File

@ -1,41 +1,50 @@
<chapter xmlns="http://docbook.org/ns/docbook" <chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"
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 Nix comes with certain defaults about what packages can and cannot be
cannot be installed, based on a package's metadata. By default, Nix installed, based on a package's metadata. By default, Nix will prevent
will prevent installation if any of the following criteria are installation if any of the following criteria are true:
true:</para>
<itemizedlist>
<listitem><para>The package is thought to be broken, and has had
its <literal>meta.broken</literal> set to
<literal>true</literal>.</para></listitem>
<listitem><para>The package isn't intended to run on the given system, as none of its <literal>meta.platforms</literal> match the given system.</para></listitem>
<listitem><para>The package's <literal>meta.license</literal> is set
to a license which is considered to be unfree.</para></listitem>
<listitem><para>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>.</para></listitem>
</itemizedlist>
<para>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.
</para> </para>
<itemizedlist>
<para>Each of these criteria can be altered in the nixpkgs <listitem>
configuration.</para> <para>
The package is thought to be broken, and has had its
<para>The nixpkgs configuration for a NixOS system is set in the <literal>meta.broken</literal> set to <literal>true</literal>.
</para>
</listitem>
<listitem>
<para>
The package isn't intended to run on the given system, as none of its
<literal>meta.platforms</literal> match the given system.
</para>
</listitem>
<listitem>
<para>
The package's <literal>meta.license</literal> is set to a license which is
considered to be unfree.
</para>
</listitem>
<listitem>
<para>
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>.
</para>
</listitem>
</itemizedlist>
<para>
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.
</para>
<para>
Each of these criteria can be altered in the nixpkgs configuration.
</para>
<para>
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>
{ {
@ -44,71 +53,75 @@ configuration.</para>
}; };
} }
</programlisting> </programlisting>
However, this does not allow unfree software for individual users. However, this does not allow unfree software for individual users. Their
Their configurations are managed separately.</para> configurations are managed separately.
</para>
<para>A user's of nixpkgs configuration is stored in a user-specific <para>
configuration file located at A user's of nixpkgs configuration is stored in a user-specific configuration
<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;
} }
</programlisting> </programlisting>
</para> </para>
<para>
<para>Note that we are not able to test or build unfree software on Hydra Note that we are not able to test or build unfree software on Hydra due to
due to policy. Most unfree licenses prohibit us from either executing or policy. Most unfree licenses prohibit us from either executing or
distributing the software.</para> distributing the software.
</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 There are two ways to try compiling a package which has been marked as
marked as broken.</para> broken.
</para>
<itemizedlist> <itemizedlist>
<listitem><para> <listitem>
<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></listitem> </para>
</listitem>
<listitem><para> <listitem>
For permanently allowing broken packages to be built, you may <para>
add <literal>allowBroken = true;</literal> to your user's For permanently allowing broken packages to be built, you may add
configuration file, like this: <literal>allowBroken = true;</literal> to your user's configuration file,
like this:
<programlisting> <programlisting>
{ {
allowBroken = true; allowBroken = true;
} }
</programlisting> </programlisting>
</para></listitem> </para>
</listitem>
</itemizedlist> </itemizedlist>
</section> </section>
<section xml:id="sec-allow-unsupported-system"> <section xml:id="sec-allow-unsupported-system">
<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 unsuported for the given system. There are also two ways to try compiling a package which has been marked as
unsuported for the given system.
</para> </para>
<itemizedlist> <itemizedlist>
<listitem><para>
For allowing the build of a broken package once, you can use an environment variable for a single invocation of the nix tools:
<programlisting>$ export NIXPKGS_ALLOW_UNSUPPORTED_SYSTEM=1</programlisting>
</para></listitem>
<listitem> <listitem>
<para> <para>
For permanently allowing broken packages to be built, you may add <literal>allowUnsupportedSystem = true;</literal> to your user's configuration file, like this: For allowing the build of a broken package once, you can use an
environment variable for a single invocation of the nix tools:
<programlisting>$ export NIXPKGS_ALLOW_UNSUPPORTED_SYSTEM=1</programlisting>
</para>
</listitem>
<listitem>
<para>
For permanently allowing broken packages to be built, you may add
<literal>allowUnsupportedSystem = true;</literal> to your user's
configuration file, like this:
<programlisting> <programlisting>
{ {
allowUnsupportedSystem = true; allowUnsupportedSystem = true;
@ -119,73 +132,77 @@ distributing the software.</para>
</itemizedlist> </itemizedlist>
<para> <para>
The difference between an a package being unsupported on some system and being broken is admittedly a bit fuzzy. The difference between an a package being unsupported on some system and
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>. being broken is admittedly a bit fuzzy. If a program
Of course, this begs the question of what "ought" means exactly. <emphasis>ought</emphasis> to work on a certain platform, but doesn't, the
That is left to the package maintainer. 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>There are several ways to tweak how Nix handles a package <para>
which has been marked as unfree.</para> There are several ways to tweak how Nix handles a package which has been
marked as unfree.
</para>
<itemizedlist> <itemizedlist>
<listitem><para> <listitem>
To temporarily allow all unfree packages, you can use an <para>
environment variable for a single invocation of the nix tools: To temporarily allow all unfree packages, you can use an environment
variable for a single invocation of the nix tools:
<programlisting>$ export NIXPKGS_ALLOW_UNFREE=1</programlisting> <programlisting>$ export NIXPKGS_ALLOW_UNFREE=1</programlisting>
</para></listitem> </para>
</listitem>
<listitem><para> <listitem>
It is possible to permanently allow individual unfree packages, <para>
while still blocking unfree packages by default using the It is possible to permanently allow individual unfree packages, while
<literal>allowUnfreePredicate</literal> configuration still blocking unfree packages by default using the
option in the user configuration file.</para> <literal>allowUnfreePredicate</literal> configuration option in the user
configuration file.
<para>This option is a function which accepts a package as a </para>
parameter, and returns a boolean. The following example <para>
configuration accepts a package and always returns false: 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:
<programlisting> <programlisting>
{ {
allowUnfreePredicate = (pkg: false); allowUnfreePredicate = (pkg: false);
} }
</programlisting> </programlisting>
</para> </para>
<para>
<para>A more useful example, the following configuration allows A more useful example, the following configuration allows only allows
only allows flash player and visual studio code: flash player and visual studio code:
<programlisting> <programlisting>
{ {
allowUnfreePredicate = (pkg: elem (builtins.parseDrvName pkg.name).name [ "flashplayer" "vscode" ]); allowUnfreePredicate = (pkg: elem (builtins.parseDrvName pkg.name).name [ "flashplayer" "vscode" ]);
} }
</programlisting> </programlisting>
</para></listitem> </para>
</listitem>
<listitem> <listitem>
<para>It is also possible to whitelist and blacklist licenses <para>
that are specifically acceptable or not acceptable, using It is also possible to whitelist and blacklist licenses that are
specifically acceptable or not acceptable, using
<literal>whitelistedLicenses</literal> and <literal>whitelistedLicenses</literal> and
<literal>blacklistedLicenses</literal>, respectively. <literal>blacklistedLicenses</literal>, respectively.
</para> </para>
<para>
<para>The following example configuration whitelists the The following example configuration whitelists the licenses
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 ];
} }
</programlisting> </programlisting>
</para> </para>
<para>
<para>The following example configuration blacklists the The following example configuration blacklists the <literal>gpl3</literal>
<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 ];
@ -195,36 +212,38 @@ distributing the software.</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<para>A complete list of licenses can be found in the file <para>
<filename>lib/licenses.nix</filename> of the nixpkgs tree.</para> A complete list of licenses can be found in the file
<filename>lib/licenses.nix</filename> of the nixpkgs tree.
</para>
</section> </section>
<section xml:id="sec-allow-insecure"> <section xml:id="sec-allow-insecure">
<title> <title>Installing insecure packages</title>
Installing insecure packages
</title>
<para>There are several ways to tweak how Nix handles a package <para>
which has been marked as insecure.</para> There are several ways to tweak how Nix handles a package which has been
marked as insecure.
</para>
<itemizedlist> <itemizedlist>
<listitem><para> <listitem>
To temporarily allow all insecure packages, you can use an <para>
environment variable for a single invocation of the nix tools: To temporarily allow all insecure packages, you can use an environment
variable for a single invocation of the nix tools:
<programlisting>$ export NIXPKGS_ALLOW_INSECURE=1</programlisting> <programlisting>$ export NIXPKGS_ALLOW_INSECURE=1</programlisting>
</para></listitem> </para>
</listitem>
<listitem><para> <listitem>
It is possible to permanently allow individual insecure <para>
packages, while still blocking other insecure packages by It is possible to permanently allow individual insecure packages, while
default using the <literal>permittedInsecurePackages</literal> still blocking other insecure packages by default using the
configuration option in the user configuration file.</para> <literal>permittedInsecurePackages</literal> configuration option in the
user configuration file.
<para>The following example configuration permits the </para>
installation of the hypothetically insecure package <para>
<literal>hello</literal>, version <literal>1.2.3</literal>: The following example configuration permits the installation of the
hypothetically insecure package <literal>hello</literal>, version
<literal>1.2.3</literal>:
<programlisting> <programlisting>
{ {
permittedInsecurePackages = [ permittedInsecurePackages = [
@ -234,45 +253,42 @@ distributing the software.</para>
</programlisting> </programlisting>
</para> </para>
</listitem> </listitem>
<listitem>
<listitem><para> <para>
It is also possible to create a custom policy around which It is also possible to create a custom policy around which insecure
insecure packages to allow and deny, by overriding the packages to allow and deny, by overriding the
<literal>allowInsecurePredicate</literal> configuration <literal>allowInsecurePredicate</literal> configuration option.
option.</para> </para>
<para>
<para>The <literal>allowInsecurePredicate</literal> option is a The <literal>allowInsecurePredicate</literal> option is a function which
function which accepts a package and returns a boolean, much accepts a package and returns a boolean, much like
like <literal>allowUnfreePredicate</literal>.</para> <literal>allowUnfreePredicate</literal>.
</para>
<para>The following configuration example only allows insecure <para>
packages with very short names: The following configuration example only allows insecure packages with
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);
} }
</programlisting> </programlisting>
</para> </para>
<para>
<para>Note that <literal>permittedInsecurePackages</literal> is Note that <literal>permittedInsecurePackages</literal> is only checked if
only checked if <literal>allowInsecurePredicate</literal> is not <literal>allowInsecurePredicate</literal> is not specified.
specified. </para>
</para></listitem> </listitem>
</itemizedlist> </itemizedlist>
</section> </section>
<!--============================================================--> <!--============================================================-->
<section xml:id="sec-modify-via-packageOverrides">
<title>Modify packages via <literal>packageOverrides</literal></title>
<section xml:id="sec-modify-via-packageOverrides"><title>Modify <para>
packages via <literal>packageOverrides</literal></title> You can define a function called <varname>packageOverrides</varname> in your
local <filename>~/.config/nixpkgs/config.nix</filename> to override nix
<para>You can define a function called packages. It must be a function that takes pkgs as an argument and return
<varname>packageOverrides</varname> in your local modified set of packages.
<filename>~/.config/nixpkgs/config.nix</filename> to override nix packages. It
must be a function that takes pkgs as an argument and return modified
set of packages.
<programlisting> <programlisting>
{ {
packageOverrides = pkgs: rec { packageOverrides = pkgs: rec {
@ -280,11 +296,8 @@ set of packages.
}; };
} }
</programlisting> </programlisting>
</para> </para>
</section> </section>
<section xml:id="sec-declarative-package-management"> <section xml:id="sec-declarative-package-management">
<title>Declarative Package Management</title> <title>Declarative Package Management</title>
@ -338,13 +351,12 @@ set of packages.
<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. which gets rid of the extra stuff in the profile. <filename>/bin</filename>
<filename>/bin</filename> and <filename>/share</filename> are good and <filename>/share</filename> are good defaults for a user environment,
defaults for a user environment, getting rid of the clutter. If you are getting rid of the clutter. If you are running on Nix on MacOS, you may
running on Nix on MacOS, you may want to add another path as well, want to add another path as well, <filename>/Applications</filename>, that
<filename>/Applications</filename>, that makes GUI apps available. makes GUI apps available.
</para> </para>
</section> </section>
<section xml:id="sec-getting-documentation"> <section xml:id="sec-getting-documentation">
@ -376,8 +388,7 @@ set of packages.
<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 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 to set up our environment. This can also be managed within Nix expressions.
expressions.
</para> </para>
<screen> <screen>
@ -413,8 +424,8 @@ cp ${myProfile} $out/etc/profile.d/my-profile.sh
</screen> </screen>
<para> <para>
For this to work fully, you must also have this script sourced when you For this to work fully, you must also have this script sourced when you are
are logged in. Try adding something like this to your logged in. Try adding something like this to your
<filename>~/.profile</filename> file: <filename>~/.profile</filename> file:
</para> </para>
@ -433,7 +444,6 @@ fi
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>
<section xml:id="sec-gnu-info-setup"> <section xml:id="sec-gnu-info-setup">
@ -494,9 +504,6 @@ cp ${myProfile} $out/etc/profile.d/my-profile.sh
root node. Note that <literal>texinfoInteractive</literal> is added to the root node. Note that <literal>texinfoInteractive</literal> is added to the
environment to give the <literal>install-info</literal> command. environment to give the <literal>install-info</literal> command.
</para> </para>
</section> </section>
</section> </section>
</chapter> </chapter>

34
doc/contributing.xml
View File

@ -1,35 +1,35 @@
<chapter xmlns="http://docbook.org/ns/docbook" <chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"
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 <filename The DocBook sources of the Nixpkgs manual are in the
<filename
xlink:href="https://github.com/NixOS/nixpkgs/tree/master/doc">doc</filename> xlink:href="https://github.com/NixOS/nixpkgs/tree/master/doc">doc</filename>
subdirectory of the Nixpkgs repository.</para> subdirectory of the Nixpkgs repository.
</para>
<para>You can quickly check your edits with <command>make</command>:</para> <para>
You can quickly check your edits with <command>make</command>:
</para>
<screen> <screen>
$ cd /path/to/nixpkgs/doc $ cd /path/to/nixpkgs/doc
$ nix-shell $ nix-shell
[nix-shell]$ make [nix-shell]$ make
</screen> </screen>
<para>
<para>If you experience problems, run <command>make debug</command> If you experience problems, run <command>make debug</command> to help
to help understand the docbook errors.</para> understand the docbook errors.
</para>
<para>After making modifications to the manual, it's important to <para>
build it before committing. You can do that as follows: After making modifications to the manual, it's important to build it before
committing. You can do that as follows:
<screen> <screen>
$ cd /path/to/nixpkgs/doc $ cd /path/to/nixpkgs/doc
$ nix-shell $ nix-shell
[nix-shell]$ make clean [nix-shell]$ make clean
[nix-shell]$ nix-build . [nix-shell]$ 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>.</para> <filename>./result/share/doc/nixpkgs/manual.html</filename>.
</para>
</chapter> </chapter>

493
doc/cross-compilation.xml
View File

@ -1,153 +1,209 @@
<chapter xmlns="http://docbook.org/ns/docbook" <chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"
xml:id="chap-cross"> xml:id="chap-cross">
<title>Cross-compilation</title> <title>Cross-compilation</title>
<section xml:id="sec-cross-intro"> <section xml:id="sec-cross-intro">
<title>Introduction</title> <title>Introduction</title>
<para> <para>
"Cross-compilation" means compiling a program on one machine for another type of machine. "Cross-compilation" means compiling a program on one machine for another
For example, a typical use of cross compilation is to compile programs for embedded devices. type of machine. For example, a typical use of cross compilation is to
These devices often don't have the computing power and memory to compile their own programs. compile programs for embedded devices. These devices often don't have the
One might think that cross-compilation is a fairly niche concern, but there are advantages to being rigorous about distinguishing build-time vs run-time environments even when one is developing and deploying on the same machine. computing power and memory to compile their own programs. One might think
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. that cross-compilation is a fairly niche concern, but there are advantages
to being rigorous about distinguishing build-time vs run-time environments
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. This chapter will be organized in three parts. First, it will describe the
First, it will describe the basics of how to package software in a way that supports 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. Second, it will describe how to use Nixpkgs when cross-compiling. Third, it
Third, it will describe the internal infrastructure supporting cross-compilation. will describe the internal infrastructure supporting cross-compilation.
</para> </para>
</section> </section>
<!--============================================================--> <!--============================================================-->
<section xml:id="sec-cross-packaging"> <section xml:id="sec-cross-packaging">
<title>Packaging in a cross-friendly manner</title> <title>Packaging in a cross-friendly manner</title>
<section> <section>
<title>Platform parameters</title> <title>Platform parameters</title>
<para>
Nixpkgs follows the <link xlink:href="https://gcc.gnu.org/onlinedocs/gccint/Configure-Terms.html">common historical convention of GNU autoconf</link> of distinguishing between 3 types of platform: <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 is to run. The third attribute, <wordasword>target</wordasword>, is relevant only for certain specific compilers and build tools. <para>
Nixpkgs follows the
<link xlink:href="https://gcc.gnu.org/onlinedocs/gccint/Configure-Terms.html">common
historical convention of GNU autoconf</link> of distinguishing between 3
types of platform: <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
is to 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 names <literal>buildPlatform</literal>, <literal>hostPlatform</literal>, and <literal>targetPlatform</literal>. In Nixpkgs, these three platforms are defined as attribute sets under the
All three are always defined as attributes in the standard environment, and at the top level. That means one can get at them just like a dependency in a function that is imported with <literal>callPackage</literal>: names <literal>buildPlatform</literal>, <literal>hostPlatform</literal>,
<programlisting>{ stdenv, buildPlatform, hostPlatform, fooDep, barDep, .. }: ...buildPlatform...</programlisting>, or just off <varname>stdenv</varname>: and <literal>targetPlatform</literal>. All three are always defined as
<programlisting>{ stdenv, fooDep, barDep, .. }: ...stdenv.buildPlatform...</programlisting>. attributes in the standard environment, and at the top level. That means
one can get at them just like a dependency in a function that is imported
with <literal>callPackage</literal>:
<programlisting>{ stdenv, buildPlatform, hostPlatform, fooDep, barDep, .. }: ...buildPlatform...</programlisting>
, or just off <varname>stdenv</varname>:
<programlisting>{ stdenv, fooDep, barDep, .. }: ...stdenv.buildPlatform...</programlisting>
.
</para> </para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><varname>buildPlatform</varname></term> <term><varname>buildPlatform</varname>
<listitem><para> </term>
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 be safe to ignore.
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>hostPlatform</varname></term>
<listitem><para>
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.
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>targetPlatform</varname></term>
<listitem> <listitem>
<para> <para>
The "target platform" attribute is, unlike the other two attributes, not actually fundamental to the process of building software. The "build platform" is the platform on which a package is built. Once
Instead, it is only relevant for compatibility with building certain specific compilers and build tools. someone has a built package, or pre-built binary package, the build
It can be safely ignored for all other packages. platform should not matter and be safe to ignore.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>hostPlatform</varname>
</term>
<listitem>
<para>
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.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>targetPlatform</varname>
</term>
<listitem>
<para>
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.
</para> </para>
<para> <para>
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 build process of certain compilers is written in such a way that the
The task specifying this single "target platform" is thus pushed to build time of the compiler. compiler resulting from a single build can itself only produce binaries
The root cause of this mistake is often that the compiler (which will be run on the host) and the the standard library/runtime (which will be run on the target) are built by a single build process. for a single platform. The task specifying this single "target platform"
is thus pushed to build time of the compiler. The root cause of this
mistake is often that the compiler (which will be run on the host) and
the 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 time like this. There is no fundamental need to think about a single target ahead of
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. time like this. If the tool supports modular or pluggable backends, both
An example of such a tool is LLVM. 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 mistake, it is a common one: examples of tools that suffer from it are GCC, Binutils, GHC and Autoconf. Although the existence of a "target platfom" is arguably a historical
Nixpkgs tries to avoid sharing in the mistake where possible. mistake, it is a common one: examples of tools that suffer from it are
Still, because the concept of a target platform is so ingrained, it is best to support it as is. 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 convoluted evolution, but this is slowly being cleaned up. The exact schema these fields follow is a bit ill-defined due to a long and
You can see examples of ones used in practice in <literal>lib.systems.examples</literal>; note how they are not all very consistent. convoluted evolution, but this is slowly being cleaned up. You can see
For now, here are few fields can count on them containing: 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>
<varlistentry> <varlistentry>
<term><varname>system</varname></term> <term><varname>system</varname>
</term>
<listitem> <listitem>
<para> <para>
This is a two-component shorthand for the platform. This is a two-component shorthand for the platform. Examples of this
Examples of this would be "x86_64-darwin" and "i686-linux"; see <literal>lib.systems.doubles</literal> for more. would be "x86_64-darwin" and "i686-linux"; see
This format isn't very standard, but has built-in support in Nix, such as the <varname>builtins.currentSystem</varname> impure string. <literal>lib.systems.doubles</literal> for more. This format isn't very
standard, but has built-in support in Nix, such as the
<varname>builtins.currentSystem</varname> impure string.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>config</varname></term> <term><varname>config</varname>
</term>
<listitem> <listitem>
<para> <para>
This is a 3- or 4- component shorthand for the platform. This is a 3- or 4- component shorthand for the platform. Examples of
Examples of this would be "x86_64-unknown-linux-gnu" and "aarch64-apple-darwin14". this would be "x86_64-unknown-linux-gnu" and "aarch64-apple-darwin14".
This is a standard format called the "LLVM target triple", as they are pioneered by LLVM and traditionally just used for the <varname>targetPlatform</varname>. This is a standard format called the "LLVM target triple", as they are
This format is strictly more informative than the "Nix host double", as the previous format could analogously be termed. pioneered by LLVM and traditionally just used for the
This needs a better name than <varname>config</varname>! <varname>targetPlatform</varname>. 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>
<varlistentry> <varlistentry>
<term><varname>parsed</varname></term> <term><varname>parsed</varname>
</term>
<listitem> <listitem>
<para> <para>
This is a nix representation of a parsed LLVM target triple with white-listed components. This is a nix representation of a parsed LLVM target triple with
This can be specified directly, or actually parsed from the <varname>config</varname>. white-listed components. This can be specified directly, or actually
[Technically, only one need be specified and the others can be inferred, though the precision of inference may not be very good.] parsed from the <varname>config</varname>. [Technically, only one need
See <literal>lib.systems.parse</literal> for the exact representation. be specified and the others can be inferred, though the precision of
inference may not be very good.] See
<literal>lib.systems.parse</literal> for the exact representation.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>libc</varname></term> <term><varname>libc</varname>
</term>
<listitem> <listitem>
<para> <para>
This is a string identifying the standard C library used. This is a string identifying the standard C library used. Valid
Valid identifiers include "glibc" for GNU libc, "libSystem" for Darwin's Libsystem, and "uclibc" for µClibc. identifiers include "glibc" for GNU libc, "libSystem" for Darwin's
It should probably be refactored to use the module system, like <varname>parse</varname>. 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>
<varlistentry> <varlistentry>
<term><varname>is*</varname></term> <term><varname>is*</varname>
</term>
<listitem> <listitem>
<para> <para>
These predicates are defined in <literal>lib.systems.inspect</literal>, and slapped on every platform. These predicates are defined in <literal>lib.systems.inspect</literal>,
They are superior to the ones in <varname>stdenv</varname> as they force the user to be explicit about which platform they are inspecting. and slapped on every platform. They are superior to the ones in
Please use these instead of those. <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>
<varlistentry> <varlistentry>
<term><varname>platform</varname></term> <term><varname>platform</varname>
</term>
<listitem> <listitem>
<para> <para>
This is, quite frankly, a dumping ground of ad-hoc settings (it's an attribute set). This is, quite frankly, a dumping ground of ad-hoc settings (it's an
See <literal>lib.systems.platforms</literal> for examples—there's hopefully one in there that will work verbatim for each platform that is working. attribute set). See <literal>lib.systems.platforms</literal> for
Please help us triage these flags and give them better homes! 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>
@ -156,153 +212,258 @@
<section> <section>
<title>Specifying Dependencies</title> <title>Specifying Dependencies</title>
<para> <para>
In this section we explore the relationship between both runtime and buildtime dependencies and the 3 Autoconf platforms. In this section we explore the relationship between both runtime and
buildtime dependencies and the 3 Autoconf platforms.
</para> </para>
<para> <para>
A runtime dependency between 2 packages implies that between them both the host and target platforms match. A runtime dependency between 2 packages implies that between them both the
This is directly implied by the meaning of "host platform" and "runtime dependency": host and target platforms match. This is directly implied by the meaning of
The package dependency exists while both packages are running on a single host platform. "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, implies a shift in platforms between the depending package and the depended-on package. A build time dependency, however, implies a shift in platforms between the
The meaning of a build time dependency is that to build the depending package we need to be able to run the depended-on's package. depending package and the depended-on package. The meaning of a build time
The depending package's build platform is therefore equal to the depended-on package's host platform. dependency is that to build the depending package we need to be able to run
Analogously, the depending package's host platform is equal to the depended-on package's target platform. the depended-on's package. The depending package's build platform is
therefore equal to the depended-on package's host platform. Analogously,
the depending package's host platform is equal to the depended-on package's
target platform.
</para> </para>
<para> <para>
In this manner, given the 3 platforms for one package, we can determine the three platforms for all its transitive dependencies. In this manner, given the 3 platforms for one package, we can determine the
This is the most important guiding principle behind cross-compilation with Nixpkgs, and will be called the <wordasword>sliding window principle</wordasword>. three platforms for all its transitive dependencies. This is the most
important guiding principle behind cross-compilation with Nixpkgs, and will
be called the <wordasword>sliding window principle</wordasword>.
</para> </para>
<para> <para>
Some examples will probably make this clearer. Some examples will probably make this clearer. If a package is being built
If a package is being built with a <literal>(build, host, target)</literal> platform triple of <literal>(foo, bar, bar)</literal>, then its build-time dependencies would have a triple of <literal>(foo, foo, bar)</literal>, and <emphasis>those packages'</emphasis> build-time dependencies would have triple of <literal>(foo, foo, foo)</literal>. with a <literal>(build, host, target)</literal> platform triple of
In other words, it should take two "rounds" of following build-time dependency edges before one reaches a fixed point where, by the sliding window principle, the platform triple no longer changes. <literal>(foo, bar, bar)</literal>, then its build-time dependencies would
Indeed, this happens with cross compilation, where only rounds of native dependencies starting with the second necessarily coincide with native packages. have a triple of <literal>(foo, foo, bar)</literal>, and <emphasis>those
packages'</emphasis> build-time dependencies would have triple of
<literal>(foo, foo, foo)</literal>. In other words, it should take two
"rounds" of following build-time dependency edges before one reaches a
fixed point where, by the sliding window principle, the platform triple no
longer changes. Indeed, this happens with cross compilation, where only
rounds of native dependencies starting with the second necessarily coincide
with native packages.
</para> </para>
<note><para>
The depending package's target platform is unconstrained by the sliding window principle, which makes sense in that one can in principle build cross compilers targeting arbitrary platforms. <note>
</para></note>
<para> <para>
How does this work in practice? Nixpkgs is now structured so that build-time dependencies are taken from <varname>buildPackages</varname>, whereas run-time dependencies are taken from the top level attribute set. The depending package's target platform is unconstrained by the sliding
For example, <varname>buildPackages.gcc</varname> should be used at build time, while <varname>gcc</varname> should be used at run time. window principle, which makes sense in that one can in principle build
Now, for most of Nixpkgs's history, there was no <varname>buildPackages</varname>, and most packages have not been refactored to use it explicitly. cross compilers targeting arbitrary platforms.
Instead, one can use the six (<emphasis>gasp</emphasis>) attributes used for specifying dependencies as documented in <xref linkend="ssec-stdenv-dependencies"/>.
We "splice" together the run-time and build-time package sets with <varname>callPackage</varname>, and then <varname>mkDerivation</varname> for each of four attributes pulls the right derivation out.
This splicing can be skipped when not cross compiling as the package sets are the same, but is a bit slow for cross compiling.
Because of this, a best-of-both-worlds solution is in the works with no splicing or explicit access of <varname>buildPackages</varname> needed.
For now, feel free to use either method.
</para> </para>
<note><para> </note>
There is also a "backlink" <varname>targetPackages</varname>, yielding a package set whose <varname>buildPackages</varname> is the current package set.
This is a hack, though, to accommodate compilers with lousy build systems. <para>
Please do not use this unless you are absolutely sure you are packaging such a compiler and there is no other way. How does this work in practice? Nixpkgs is now structured so that
</para></note> build-time dependencies are taken from <varname>buildPackages</varname>,
whereas run-time dependencies are taken from the top level attribute set.
For example, <varname>buildPackages.gcc</varname> should be used at build
time, while <varname>gcc</varname> should be used at run time. Now, for
most of Nixpkgs's history, there was no <varname>buildPackages</varname>,
and most packages have not been refactored to use it explicitly. Instead,
one can use the six (<emphasis>gasp</emphasis>) attributes used for
specifying dependencies as documented in
<xref linkend="ssec-stdenv-dependencies"/>. We "splice" together the
run-time and build-time package sets with <varname>callPackage</varname>,
and then <varname>mkDerivation</varname> for each of four attributes pulls
the right derivation out. This splicing can be skipped when not cross
compiling as the package sets are the same, but is a bit slow for cross
compiling. Because of this, a best-of-both-worlds solution is in the works
with no splicing or explicit access of <varname>buildPackages</varname>
needed. For now, feel free to use either method.
</para>
<note>
<para>
There is also a "backlink" <varname>targetPackages</varname>, yielding a
package set whose <varname>buildPackages</varname> is the current package
set. This is a hack, though, to accommodate compilers with lousy build
systems. Please do not use this unless you are absolutely sure you are
packaging such a compiler and there is no other way.
</para>
</note>
</section> </section>
<section> <section>
<title>Cross packagaing cookbook</title> <title>Cross packagaing cookbook</title>
<para> <para>
Some frequently problems when packaging for cross compilation are good to just spell and answer. Some frequently problems when packaging for cross compilation are good to
Ideally the information above is exhaustive, so this section cannot provide any new information, just spell and answer. Ideally the information above is exhaustive, so this
but its 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. section cannot provide any new information, but its 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! Feel free to add to this list!
</para> </para>
<qandaset> <qandaset>
<qandaentry> <qandaentry>
<question><para> <question>
What if my package's build system needs to build a C program to be run under the build environment? <para>
</para></question> What if my package's build system needs to build a C program to be run
<answer><para> under the build environment?
</para>
</question>
<answer>
<para>
<programlisting>depsBuildBuild = [ buildPackages.stdenv.cc ];</programlisting> <programlisting>depsBuildBuild = [ buildPackages.stdenv.cc ];</programlisting>
Add it to your <function>mkDerivation</function> invocation. Add it to your <function>mkDerivation</function> invocation.
</para></answer> </para>
</answer>
</qandaentry> </qandaentry>
<qandaentry> <qandaentry>
<question><para> <question>
<para>
My package fails to find <command>ar</command>. My package fails to find <command>ar</command>.
</para></question> </para>
<answer><para> </question>
Many packages assume that an unprefixed <command>ar</command> is available, but Nix doesn't provide one. <answer>
It only provides a prefixed one, just as it only does for all the other binutils programs. <para>
It may be necessary to patch the package to fix the build system to use a prefixed `ar`. Many packages assume that an unprefixed <command>ar</command> is
</para></answer> 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>
</answer>
</qandaentry> </qandaentry>
<qandaentry> <qandaentry>
<question><para> <question>
<para>
My package's testsuite needs to run host platform code. My package's testsuite needs to run host platform code.
</para></question> </para>
<answer><para> </question>
<answer>
<para>
<programlisting>doCheck = stdenv.hostPlatform != stdenv.buildPlatfrom;</programlisting> <programlisting>doCheck = stdenv.hostPlatform != stdenv.buildPlatfrom;</programlisting>
Add it to your <function>mkDerivation</function> invocation. Add it to your <function>mkDerivation</function> invocation.
</para></answer> </para>
</answer>
</qandaentry> </qandaentry>
</qandaset> </qandaset>
</section> </section>
</section> </section>
<!--============================================================--> <!--============================================================-->
<section xml:id="sec-cross-usage"> <section xml:id="sec-cross-usage">
<title>Cross-building packages</title> <title>Cross-building packages</title>
<note><para>
More information needs to moved from the old wiki, especially <link xlink:href="https://nixos.org/wiki/CrossCompiling" />, for this section. <note>
</para></note>
<para> <para>
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, More information needs to moved from the old wiki, especially
or also with <varname>crossSystem</varname>, in which case packages run on the latter, but all building happens on the former. <link xlink:href="https://nixos.org/wiki/CrossCompiling" />, for this
Both parameters take the same schema as the 3 (build, host, and target) platforms defined in the previous section. section.
As mentioned above, <literal>lib.systems.examples</literal> has some platforms which are used as arguments for these parameters in practice. </para>
You can use them programmatically, or on the command line: <programlisting> </note>
<para>
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:
<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 convenience so that <programlisting> Eventually we would like to make these platform examples an unnecessary
convenience so that
<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. works in the vast majority of cases. The problem today is dependencies on
The problem today is dependencies on other sorts of configuration which aren't given proper defaults. other sorts of configuration which aren't given proper defaults. We rely on
We rely on the examples to crudely to set those configuration parameters in some vaguely sane manner on the users behalf. the examples to crudely to set those configuration parameters in some
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. 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 fill in missing fields. While one is free to pass both parameters in full, there's a lot of logic to
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. fill in missing fields. As discussed in the previous section, only one of
Additionally, <varname>libc</varname> will be inferred from <varname>parse</varname>. <varname>system</varname>, <varname>config</varname>, and
Finally, <literal>localSystem.system</literal> is also <emphasis>impurely</emphasis> inferred based on the platform evaluation occurs. <varname>parsed</varname> is needed to infer the other two. Additionally,
This means it is often not necessary to pass <varname>localSystem</varname> at all, as in the command-line example in the previous paragraph. <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 <varname>system</varname>, <varname>platform</varname>, along with the optional <varname>crossSystem</varname> to nixpkgs: Many sources (manual, wiki, etc) probably mention passing
<literal>import &lt;nixpkgs&gt; { system = ..; platform = ..; crossSystem = ..; }</literal>. <varname>system</varname>, <varname>platform</varname>, along with the
Passing those two instead of <varname>localSystem</varname> is still supported for compatibility, but is discouraged. optional <varname>crossSystem</varname> to nixpkgs: <literal>import
Indeed, much of the inference we do for these parameters is motivated by compatibility as much as convenience. &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 <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). One would think that <varname>localSystem</varname> and
Actually, those identifiers are purposefully not used here to draw a subtle but important distinction: <varname>crossSystem</varname> overlap horribly with the three
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. <varname>*Platforms</varname> (<varname>buildPlatform</varname>,
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. <varname>hostPlatform,</varname> and <varname>targetPlatform</varname>; see
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. <varname>stage.nix</varname> or the manual). Actually, those identifiers are
A last simple difference then is <varname>crossSystem</varname> should be null when one doesn't want to cross-compile, while the <varname>*Platform</varname>s are always non-null. 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 then is
<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>localSystem</varname> is always non-null.
</para> </para>
</section> </section>
<!--============================================================--> <!--============================================================-->
<section xml:id="sec-cross-infra"> <section xml:id="sec-cross-infra">
<title>Cross-compilation infrastructure</title> <title>Cross-compilation infrastructure</title>
<para>To be written.</para>
<note><para>
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.
</para></note>
</section>
<para>
To be written.
</para>
<note>
<para>
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.
</para>
</note>
</section>
</chapter> </chapter>

506
doc/functions.xml
View File

@ -1,20 +1,18 @@
<chapter xmlns="http://docbook.org/ns/docbook" <chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"
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 expressions. The nixpkgs repository has several utility functions to manipulate Nix
expressions.
</para> </para>
<section xml:id="sec-overrides"> <section xml:id="sec-overrides">
<title>Overriding</title> <title>Overriding</title>
<para> <para>
Sometimes one wants to override parts of Sometimes one wants to override parts of <literal>nixpkgs</literal>, e.g.
<literal>nixpkgs</literal>, e.g. derivation attributes, the results of derivation attributes, the results of derivations or even the whole package
derivations or even the whole package set. set.
</para> </para>
<section xml:id="sec-pkg-override"> <section xml:id="sec-pkg-override">
@ -24,12 +22,13 @@
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>
It is used to override the arguments passed to a function. It is used to override the arguments passed to a function.
</para> </para>
<para> <para>
Example usages: Example usages:
<programlisting>pkgs.foo.override { arg1 = val1; arg2 = val2; ... }</programlisting> <programlisting>pkgs.foo.override { arg1 = val1; arg2 = val2; ... }</programlisting>
<programlisting>import pkgs.path { overlays = [ (self: super: { <programlisting>import pkgs.path { overlays = [ (self: super: {
foo = super.foo.override { barSupport = true ; }; foo = super.foo.override { barSupport = true ; };
@ -40,12 +39,11 @@
</para> </para>
<para> <para>
In the first example, <varname>pkgs.foo</varname> is the result of a function call In the first example, <varname>pkgs.foo</varname> is the result of a
with some default arguments, usually a derivation. function call with some default arguments, usually a derivation. Using
Using <varname>pkgs.foo.override</varname> will call the same function with <varname>pkgs.foo.override</varname> will call the same function with the
the given new arguments. given new arguments.
</para> </para>
</section> </section>
<section xml:id="sec-pkg-overrideAttrs"> <section xml:id="sec-pkg-overrideAttrs">
@ -54,15 +52,14 @@
<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, attribute set passed to a <varname>stdenv.mkDerivation</varname> call,
producing a new derivation based on the original one. producing a new derivation based on the original one. This function is
This function is available on all derivations produced by the available on all derivations produced by the
<varname>stdenv.mkDerivation</varname> function, which is most packages <varname>stdenv.mkDerivation</varname> function, which is most packages in
in the nixpkgs expression <varname>pkgs</varname>. the nixpkgs expression <varname>pkgs</varname>.
</para> </para>
<para> <para>
Example usage: Example usage:
<programlisting>helloWithDebug = pkgs.hello.overrideAttrs (oldAttrs: rec { <programlisting>helloWithDebug = pkgs.hello.overrideAttrs (oldAttrs: rec {
separateDebugInfo = true; separateDebugInfo = true;
});</programlisting> });</programlisting>
@ -84,28 +81,27 @@
<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 <varname>stdenv.mkDerivation</varname> function, not the generated, raw
Nix derivation. Thus, using <varname>overrideDerivation</varname> will Nix derivation. Thus, using <varname>overrideDerivation</varname> will not
not work in this case, as it overrides only the attributes of the final work in this case, as it overrides only the attributes of the final
derivation. It is for this reason that <varname>overrideAttrs</varname> derivation. It is for this reason that <varname>overrideAttrs</varname>
should be preferred in (almost) all cases to should be preferred in (almost) all cases to
<varname>overrideDerivation</varname>, i.e. to allow using <varname>overrideDerivation</varname>, i.e. to allow using
<varname>sdenv.mkDerivation</varname> to process input arguments, as well <varname>sdenv.mkDerivation</varname> to process input arguments, as well
as the fact that it is easier to use (you can use the same attribute as the fact that it is easier to use (you can use the same attribute names
names you see in your Nix code, instead of the ones generated (e.g. you see in your Nix code, instead of the ones generated (e.g.
<varname>buildInputs</varname> vs <varname>nativeBuildInputs</varname>, <varname>buildInputs</varname> vs <varname>nativeBuildInputs</varname>,
and involves less typing. and involves less typing.
</para> </para>
</note> </note>
</section> </section>
<section xml:id="sec-pkg-overrideDerivation"> <section xml:id="sec-pkg-overrideDerivation">
<title>&lt;pkg&gt;.overrideDerivation</title> <title>&lt;pkg&gt;.overrideDerivation</title>
<warning> <warning>
<para>You should prefer <varname>overrideAttrs</varname> in almost all <para>
cases, see its documentation for the reasons why. 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 <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 to work, but is less nice to use and does not have as many abilities as
<varname>overrideAttrs</varname>. <varname>overrideAttrs</varname>.
@ -113,31 +109,30 @@
</warning> </warning>
<warning> <warning>
<para>Do not use this function in Nixpkgs as it evaluates a Derivation <para>
before modifying it, which breaks package abstraction and removes Do not use this function in Nixpkgs as it evaluates a Derivation before
error-checking of function arguments. In addition, this modifying it, which breaks package abstraction and removes error-checking
evaluation-per-function application incurs a performance penalty, of function arguments. In addition, this evaluation-per-function
which can become a problem if many overrides are used. application incurs a performance penalty, which can become a problem if
It is only intended for ad-hoc customisation, such as in many overrides are used. It is only intended for ad-hoc customisation,
<filename>~/.config/nixpkgs/config.nix</filename>. 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 based on an existing one by overriding the original's attributes with the
the attribute set produced by the specified function. attribute set produced by the specified function. This function is
This function is available on all available on all derivations defined using the
derivations defined using the <varname>makeOverridable</varname> function. <varname>makeOverridable</varname> function. Most standard
Most standard derivation-producing functions, such as derivation-producing functions, such as
<varname>stdenv.mkDerivation</varname>, are defined using this <varname>stdenv.mkDerivation</varname>, are defined using this function,
function, which means most packages in the nixpkgs expression, which means most packages in the nixpkgs expression,
<varname>pkgs</varname>, have this function. <varname>pkgs</varname>, have this function.
</para> </para>
<para> <para>
Example usage: Example usage:
<programlisting>mySed = pkgs.gnused.overrideDerivation (oldAttrs: { <programlisting>mySed = pkgs.gnused.overrideDerivation (oldAttrs: {
name = "sed-4.2.2-pre"; name = "sed-4.2.2-pre";
src = fetchurl { src = fetchurl {
@ -155,75 +150,67 @@
</para> </para>
<para> <para>
The argument <varname>oldAttrs</varname> is used to refer to the attribute set of The argument <varname>oldAttrs</varname> is used to refer to the attribute
the original derivation. set of the original derivation.
</para> </para>
<note> <note>
<para> <para>
A package's attributes are evaluated *before* being modified by A package's attributes are evaluated *before* being modified by the
the <varname>overrideDerivation</varname> function. <varname>overrideDerivation</varname> function. For example, the
For example, the <varname>name</varname> attribute reference <varname>name</varname> attribute reference in <varname>url =
in <varname>url = "mirror://gnu/hello/${name}.tar.gz";</varname> "mirror://gnu/hello/${name}.tar.gz";</varname> is filled-in *before* the
is filled-in *before* the <varname>overrideDerivation</varname> function <varname>overrideDerivation</varname> function modifies the attribute set.
modifies the attribute set. This means that overriding the This means that overriding the <varname>name</varname> attribute, in this
<varname>name</varname> attribute, in this example, *will not* change the example, *will not* change the value of the <varname>url</varname>
value of the <varname>url</varname> attribute. Instead, we need to override attribute. Instead, we need to override both the <varname>name</varname>
both the <varname>name</varname> *and* <varname>url</varname> attributes. *and* <varname>url</varname> attributes.
</para> </para>
</note> </note>
</section> </section>
<section xml:id="sec-lib-makeOverridable"> <section xml:id="sec-lib-makeOverridable">
<title>lib.makeOverridable</title> <title>lib.makeOverridable</title>
<para> <para>
The function <varname>lib.makeOverridable</varname> is used to make the result The function <varname>lib.makeOverridable</varname> is used to make the
of a function easily customizable. This utility only makes sense for functions result of a function easily customizable. This utility only makes sense for
that accept an argument set and return an attribute set. functions that accept an argument set and return an attribute set.
</para> </para>
<para> <para>
Example usage: Example usage:
<programlisting>f = { a, b }: { result = a+b; } <programlisting>f = { a, b }: { result = a+b; }
c = lib.makeOverridable f { a = 1; b = 2; }</programlisting> c = lib.makeOverridable f { a = 1; b = 2; }</programlisting>
</para> </para>
<para> <para>
The variable <varname>c</varname> is the value of the <varname>f</varname> function The variable <varname>c</varname> is the value of the <varname>f</varname>
applied with some default arguments. Hence the value of <varname>c.result</varname> function applied with some default arguments. Hence the value of
is <literal>3</literal>, in this example. <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 functions, like The variable <varname>c</varname> however also has some additional
<link linkend="sec-pkg-override">c.override</link> which can be used to functions, like <link linkend="sec-pkg-override">c.override</link> which
override the default arguments. In this example the value of can be used to override the default arguments. In this example the value of
<varname>(c.override { a = 4; }).result</varname> is 6. <varname>(c.override { a = 4; }).result</varname> is 6.
</para> </para>
</section> </section>
</section> </section>
<section xml:id="sec-generators"> <section xml:id="sec-generators">
<title>Generators</title> <title>Generators</title>
<para> <para>
Generators are functions that create file formats from nix Generators are functions that create file formats from nix data structures,
data structures, e. g. for configuration files. e. g. for configuration files. There are generators available for:
There are generators available for: <literal>INI</literal>, <literal>INI</literal>, <literal>JSON</literal> and <literal>YAML</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 configFunctions data</code>, where <literal>configFunctions</literal> is an
an attrset of user-defined functions that format nested parts of the attrset of user-defined functions that format nested parts of the content.
content.
They each have common defaults, so often they do not need to be set They each have common defaults, so often they do not need to be set
manually. An example is <code>mkSectionName ? (name: libStr.escape [ "[" "]" manually. An example is <code>mkSectionName ? (name: libStr.escape [ "[" "]"
] name)</code> from the <literal>INI</literal> generator. It receives the ] name)</code> from the <literal>INI</literal> generator. It receives the
@ -233,11 +220,11 @@
</para> </para>
<para> <para>
Generators can be fine-tuned to produce exactly the file format required Generators can be fine-tuned to produce exactly the file format required by
by your application/service. One example is an INI-file format which uses your application/service. One example is an INI-file format which uses
<literal>: </literal> as separator, the strings <literal>: </literal> as separator, the strings
<literal>"yes"</literal>/<literal>"no"</literal> as boolean values <literal>"yes"</literal>/<literal>"no"</literal> as boolean values and
and requires all string values to be quoted: requires all string values to be quoted:
</para> </para>
<programlisting> <programlisting>
@ -270,7 +257,9 @@ in customToINI {
} }
</programlisting> </programlisting>
<para>This will produce the following INI file as nix string:</para> <para>
This will produce the following INI file as nix string:
</para>
<programlisting> <programlisting>
[main] [main]
@ -284,105 +273,132 @@ str\:ange:"very::strange"
merge:"diff3" merge:"diff3"
</programlisting> </programlisting>
<note><para>Nix store paths can be converted to strings by enclosing a <note>
derivation attribute like so: <code>"${drv}"</code>.</para></note> <para>
Nix store paths can be converted to strings by enclosing a derivation
attribute like so: <code>"${drv}"</code>.
</para>
</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>
<section xml:id="sec-debug"> <section xml:id="sec-debug">
<title>Debugging Nix Expressions</title> <title>Debugging Nix Expressions</title>
<para>Nix is a unityped, dynamic language, this means every value can <para>
potentially appear anywhere. Since it is also non-strict, evaluation order Nix is a unityped, dynamic language, this means every value can potentially
and what ultimately is evaluated might surprise you. Therefore it is important appear anywhere. Since it is also non-strict, evaluation order and what
to be able to debug nix expressions.</para> ultimately is evaluated might surprise you. Therefore it is important to be
able to debug nix expressions.
</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 functions that help (pretty-)printing values while evaluation is runnnig.
can even specify how deep these values should be printed recursively, and You can even specify how deep these values should be printed recursively,
transform them on the fly. Please consult the docstrings in and transform them on the fly. Please consult the docstrings in
<literal>lib/debug.nix</literal> for usage information.</para> <literal>lib/debug.nix</literal> for usage information.
</para>
</section> </section>
<section xml:id="sec-fhs-environments"> <section xml:id="sec-fhs-environments">
<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 FHS-compatible lightweight sandboxes. It creates an isolated root with bound
bound <filename>/nix/store</filename>, so its footprint in terms of disk <filename>/nix/store</filename>, so its footprint in terms of disk space
space needed is quite small. This allows one to run software which is hard or 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, unfeasible to patch for NixOS -- 3rd-party source trees with FHS
games distributed as tarballs, software with integrity checking and/or external assumptions, games distributed as tarballs, software with integrity checking
self-updated binaries. It uses Linux namespaces feature to create and/or external self-updated binaries. It uses Linux namespaces feature to
temporary lightweight environments which are destroyed after all child create temporary lightweight environments which are destroyed after all
processes exit, without root user rights requirement. Accepted arguments are: child processes exit, without root user rights requirement. Accepted
arguments are:
</para> </para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><literal>name</literal></term> <term><literal>name</literal>
</term>
<listitem><para>Environment name.</para></listitem> <listitem>
<para>
Environment name.
</para>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><literal>targetPkgs</literal></term> <term><literal>targetPkgs</literal>
</term>
<listitem><para>Packages to be installed for the main host's architecture <listitem>
(i.e. x86_64 on x86_64 installations). Along with libraries binaries are also <para>
installed.</para></listitem> 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.
</para>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><literal>multiPkgs</literal></term> <term><literal>multiPkgs</literal>
</term>
<listitem><para>Packages to be installed for all architectures supported by <listitem>
a host (i.e. i686 and x86_64 on x86_64 installations). Only libraries are <para>
installed by default.</para></listitem> 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.
</para>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><literal>extraBuildCommands</literal></term> <term><literal>extraBuildCommands</literal>
</term>
<listitem><para>Additional commands to be executed for finalizing the <listitem>
directory structure.</para></listitem> <para>
Additional commands to be executed for finalizing the directory
structure.
</para>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><literal>extraBuildCommandsMulti</literal></term> <term><literal>extraBuildCommandsMulti</literal>
</term>
<listitem><para>Like <literal>extraBuildCommands</literal>, but <listitem>
executed only on multilib architectures.</para></listitem> <para>
Like <literal>extraBuildCommands</literal>, but executed only on multilib
architectures.
</para>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><literal>extraOutputsToInstall</literal></term> <term><literal>extraOutputsToInstall</literal>
</term>
<listitem><para>Additional derivation outputs to be linked for both <listitem>
target and multi-architecture packages.</para></listitem> <para>
Additional derivation outputs to be linked for both target and
multi-architecture packages.
</para>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><literal>extraInstallCommands</literal></term> <term><literal>extraInstallCommands</literal>
</term>
<listitem><para>Additional commands to be executed for finalizing the <listitem>
derivation with runner script.</para></listitem> <para>
Additional commands to be executed for finalizing the derivation with
runner script.
</para>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><literal>runScript</literal></term> <term><literal>runScript</literal>
</term>
<listitem><para>A command that would be executed inside the sandbox and <listitem>
passed all the command line arguments. It defaults to <para>
<literal>bash</literal>.</para></listitem> A command that would be executed inside the sandbox and passed all the
command line arguments. It defaults to <literal>bash</literal>.
</para>
</listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
@ -416,11 +432,10 @@ merge:"diff3"
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 these libraries and binaries available. You can use this to run
closed-source applications which expect FHS structure without hassles: closed-source applications which expect FHS structure without hassles:
simply change <literal>runScript</literal> to the application path, simply change <literal>runScript</literal> to the application path, e.g.
e.g. <filename>./bin/start.sh</filename> -- relative paths are supported. <filename>./bin/start.sh</filename> -- relative paths are supported.
</para> </para>
</section> </section>
<section xml:id="sec-pkgs-dockerTools"> <section xml:id="sec-pkgs-dockerTools">
<title>pkgs.dockerTools</title> <title>pkgs.dockerTools</title>
@ -428,9 +443,8 @@ merge:"diff3"
<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 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"> <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 Docker Image Specification v1.2.0 </link>. Docker itself is not used to
</link>. Docker itself is not used to perform any of the operations done by these perform any of the operations done by these functions.
functions.
</para> </para>
<warning> <warning>
@ -446,16 +460,17 @@ merge:"diff3"
<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 can used to build a Docker-compatible repository tarball containing in that can used to build a Docker-compatible repository tarball containing
a single image with one or multiple layers. As such, the result a single image with one or multiple layers. As such, the result is suitable
is suitable for being loaded in Docker with <command>docker load</command>. for being loaded in Docker with <command>docker load</command>.
</para> </para>
<para> <para>
The parameters of <varname>buildImage</varname> with relative example values are The parameters of <varname>buildImage</varname> with relative example
described below: values are described below:
</para> </para>
<example xml:id='ex-dockerTools-buildImage'><title>Docker build</title> <example xml:id='ex-dockerTools-buildImage'>
<title>Docker build</title>
<programlisting> <programlisting>
buildImage { buildImage {
name = "redis"; <co xml:id='ex-dockerTools-buildImage-1' /> name = "redis"; <co xml:id='ex-dockerTools-buildImage-1' />
@ -482,99 +497,92 @@ merge:"diff3"
</programlisting> </programlisting>
</example> </example>
<para>The above example will build a Docker image <literal>redis/latest</literal> <para>
from the given base image. Loading and running this image in Docker results in The above example will build a Docker image <literal>redis/latest</literal>
<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. <varname>name</varname> specifies the name of the resulting image. This
This is the only required argument for <varname>buildImage</varname>. is 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. <varname>tag</varname> specifies the tag of the resulting image. By
By default it's <literal>latest</literal>. default it's <literal>latest</literal>.
</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 image. <varname>fromImage</varname> is the repository tarball containing the
It must be a valid Docker image, such as exported by <command>docker save</command>. base image. It must be a valid Docker image, such as exported by
By default it's <literal>null</literal>, which can be seen as equivalent <command>docker save</command>. By default it's <literal>null</literal>,
to <literal>FROM scratch</literal> of a <filename>Dockerfile</filename>. 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 <varname>fromImageName</varname> can be used to further specify the base
the base image within the repository, in case it contains multiple images. image within the repository, in case it contains multiple images. By
By default it's <literal>null</literal>, in which case default it's <literal>null</literal>, in which case
<varname>buildImage</varname> will peek the first image available <varname>buildImage</varname> will peek the first image available in the
in the repository. 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 <varname>fromImageTag</varname> can be used to further specify the tag of
of the base image within the repository, in case an image contains multiple tags. the base image within the repository, in case an image contains multiple
By default it's <literal>null</literal>, in which case tags. By default it's <literal>null</literal>, in which case
<varname>buildImage</varname> will peek the first tag available for the base image. <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
layer of the resulting image. This can be similarly seen as new layer of the resulting image. This can be similarly seen as
<command>ADD contents/ /</command> in a <filename>Dockerfile</filename>. <command>ADD contents/ /</command> in a <filename>Dockerfile</filename>.
By default it's <literal>null</literal>. 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 <varname>runAsRoot</varname> is a bash script that will run as root in an
in an environment that overlays the existing layers of the base image with environment that overlays the existing layers of the base image with the
the new resulting layer, including the previously copied new resulting layer, including the previously copied
<varname>contents</varname> derivation. <varname>contents</varname> derivation. This can be similarly seen as
This can be similarly seen as
<command>RUN ...</command> in a <filename>Dockerfile</filename>. <command>RUN ...</command> in a <filename>Dockerfile</filename>.
<note> <note>
<para> <para>
Using this parameter requires the <literal>kvm</literal> Using this parameter requires the <literal>kvm</literal> device to be
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. containers that will be started off the built image in Docker. The
The available options are listed in 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"> <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 Docker Image Specification v1.2.0 </link>.
</link>.
</para> </para>
</callout> </callout>
</calloutlist> </calloutlist>
<para> <para>
After the new layer has been created, its closure After the new layer has been created, its closure (to which
(to which <varname>contents</varname>, <varname>config</varname> and <varname>contents</varname>, <varname>config</varname> and
<varname>runAsRoot</varname> contribute) will be copied in the layer itself. <varname>runAsRoot</varname> contribute) will be copied in the layer
Only new dependencies that are not already in the existing layers will be copied. itself. Only new dependencies that are not already in the existing layers
will be copied.
</para> </para>
<para> <para>
@ -584,31 +592,31 @@ merge:"diff3"
<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'/> <varname>image/tag</varname>. In the case of
it would be <varname>redis/latest</varname>. <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 It is possible to inspect the arguments with which an image was built using
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 such protocol name: tcp)</literal> If you see errors similar to <literal>getProtocolByName: does not exist
you may need to add <literal>pkgs.iana-etc</literal> to <varname>contents</varname>. (no 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 unknown CA",True,UnknownCa)</literal> If you see errors similar to <literal>Error_Protocol ("certificate has
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>
</section> </section>
<section xml:id="ssec-pkgs-dockerTools-fetchFromRegistry"> <section xml:id="ssec-pkgs-dockerTools-fetchFromRegistry">
@ -617,16 +625,17 @@ merge:"diff3"
<para> <para>
This function is analogous to the <command>docker pull</command> command, This function is analogous to the <command>docker pull</command> command,
in that can be used to fetch a Docker image from a Docker registry. in that can be used to fetch a Docker image from a Docker registry.
Currently only registry <literal>v1</literal> is supported. Currently only registry <literal>v1</literal> is supported. By default
By default <link xlink:href="https://hub.docker.com/">Docker Hub</link> <link xlink:href="https://hub.docker.com/">Docker Hub</link> is used to
is used to pull images. pull images.
</para> </para>
<para> <para>
Its parameters are described in the example below: Its parameters are described in the example below:
</para> </para>
<example xml:id='ex-dockerTools-pullImage'><title>Docker pull</title> <example xml:id='ex-dockerTools-pullImage'>
<title>Docker pull</title>
<programlisting> <programlisting>
pullImage { pullImage {
imageName = "debian"; <co xml:id='ex-dockerTools-pullImage-1' /> imageName = "debian"; <co xml:id='ex-dockerTools-pullImage-1' />
@ -643,49 +652,46 @@ merge:"diff3"
<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 downloaded, <varname>imageName</varname> specifies the name of the image to be
which can also include the registry namespace (e.g. <literal>library/debian</literal>). downloaded, which can also include the registry namespace (e.g.
This argument is required. <literal>library/debian</literal>). This argument is required.
</para> </para>
</callout> </callout>
<callout arearefs='ex-dockerTools-pullImage-2'> <callout arearefs='ex-dockerTools-pullImage-2'>
<para> <para>
<varname>imageTag</varname> specifies the tag of the image to be downloaded. <varname>imageTag</varname> specifies the tag of the image to be
By default it's <literal>latest</literal>. downloaded. By default it's <literal>latest</literal>.
</para> </para>
</callout> </callout>
<callout arearefs='ex-dockerTools-pullImage-3'> <callout arearefs='ex-dockerTools-pullImage-3'>
<para> <para>
<varname>imageId</varname>, if specified this exact image will be fetched, instead <varname>imageId</varname>, if specified this exact image will be
of <varname>imageName/imageTag</varname>. However, the resulting repository fetched, instead of <varname>imageName/imageTag</varname>. However, the
will still be named <varname>imageName/imageTag</varname>. resulting repository will still be named
By default it's <literal>null</literal>. <varname>imageName/imageTag</varname>. By default it's
<literal>null</literal>.
</para> </para>
</callout> </callout>
<callout arearefs='ex-dockerTools-pullImage-4'> <callout arearefs='ex-dockerTools-pullImage-4'>
<para> <para>
<varname>sha256</varname> is the checksum of the whole fetched image. <varname>sha256</varname> is the checksum of the whole fetched image.
This argument is required. This argument is required.
</para> </para>
<note> <note>
<para>The checksum is computed on the unpacked directory, not on the final tarball.</para> <para>
The checksum is computed on the unpacked directory, not on the final
tarball.
</para>
</note> </note>
</callout> </callout>
<callout arearefs='ex-dockerTools-pullImage-5'> <callout arearefs='ex-dockerTools-pullImage-5'>
<para> <para>
In the above example the default values are shown for the variables In the above example the default values are shown for the variables
<varname>indexUrl</varname> and <varname>registryVersion</varname>. <varname>indexUrl</varname> and <varname>registryVersion</varname>. Hence
Hence by default the Docker.io registry is used to pull the images. by default the Docker.io registry is used to pull the images.
</para> </para>
</callout> </callout>
</calloutlist> </calloutlist>
</section> </section>
<section xml:id="ssec-pkgs-dockerTools-exportImage"> <section xml:id="ssec-pkgs-dockerTools-exportImage">
@ -694,15 +700,15 @@ merge:"diff3"
<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 can used to flatten a Docker image that contains multiple layers. in that can 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. It is in fact the result of the merge of all the layers of the image. As
As such, the result is suitable for being imported in Docker such, the result is suitable for being imported in Docker with
with <command>docker import</command>. <command>docker import</command>.
</para> </para>
<note> <note>
<para> <para>
Using this function requires the <literal>kvm</literal> Using this function requires the <literal>kvm</literal> device to be
device to be available. available.
</para> </para>
</note> </note>
@ -710,7 +716,8 @@ merge:"diff3"
The parameters of <varname>exportImage</varname> are the following: The parameters of <varname>exportImage</varname> are the following:
</para> </para>
<example xml:id='ex-dockerTools-exportImage'><title>Docker export</title> <example xml:id='ex-dockerTools-exportImage'>
<title>Docker export</title>
<programlisting> <programlisting>
exportImage { exportImage {
fromImage = someLayeredImage; fromImage = someLayeredImage;
@ -724,8 +731,9 @@ merge:"diff3"
<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 described in <xref linkend='ssec-pkgs-dockerTools-buildImage'/>, except
<varname>fromImage</varname> is the only required argument in this case. that <varname>fromImage</varname> is the only required argument in this
case.
</para> </para>
<para> <para>
@ -739,13 +747,14 @@ merge:"diff3"
<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. users and groups, only if such files don't exist already. It is suitable
It is suitable for being used in a for being used in a <varname>runAsRoot</varname>
<varname>runAsRoot</varname> <xref linkend='ex-dockerTools-buildImage-runAsRoot'/> script for cases like <xref linkend='ex-dockerTools-buildImage-runAsRoot'/> script for cases like
in the example below: in the example below:
</para> </para>
<example xml:id='ex-dockerTools-shadowSetup'><title>Shadow base files</title> <example xml:id='ex-dockerTools-shadowSetup'>
<title>Shadow base files</title>
<programlisting> <programlisting>
buildImage { buildImage {
name = "shadow-basic"; name = "shadow-basic";
@ -767,9 +776,6 @@ merge:"diff3"
<literal>/etc/login.defs</literal> are necessary for shadow-utils to <literal>/etc/login.defs</literal> are necessary for shadow-utils to
manipulate users and groups. manipulate users and groups.
</para> </para>
</section> </section>
</section> </section>
</chapter> </chapter>

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

@ -1,30 +1,34 @@
<section xmlns="http://docbook.org/ns/docbook" <section xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"
xml:id="sec-beam"> xml:id="sec-beam">
<title>BEAM Languages (Erlang, Elixir &amp; LFE)</title> <title>BEAM Languages (Erlang, Elixir &amp; LFE)</title>
<section xml:id="beam-introduction"> <section xml:id="beam-introduction">
<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 <emphasis>BEAM</emphasis>, to describe the environment. BEAM is the name of
of the Erlang Virtual Machine and, as far as we're concerned, from a the Erlang Virtual Machine and, as far as we're concerned, from a packaging
packaging perspective, all languages that run on the BEAM are perspective, all languages that run on the BEAM are interchangeable. That
interchangeable. That which varies, like the build system, is transparent which varies, like the build system, is transparent to users of any given
to users of any given BEAM package, so we make no distinction. BEAM package, so we make no distinction.
</para> </para>
</section> </section>
<section xml:id="beam-structure"> <section xml:id="beam-structure">
<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 <literal>interpreters</literal>: a set of compilers running on the BEAM,
BEAM, including multiple Erlang/OTP versions including multiple Erlang/OTP versions
(<literal>beam.interpreters.erlangR19</literal>, etc), Elixir (<literal>beam.interpreters.erlangR19</literal>, etc), Elixir
(<literal>beam.interpreters.elixir</literal>) and LFE (<literal>beam.interpreters.elixir</literal>) and LFE
(<literal>beam.interpreters.lfe</literal>). (<literal>beam.interpreters.lfe</literal>).
@ -32,12 +36,13 @@
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<literal>packages</literal>: a set of package sets, each compiled with <literal>packages</literal>: a set of package sets, each compiled with a
a specific Erlang/OTP version, e.g. specific Erlang/OTP version, e.g.
<literal>beam.packages.erlangR19</literal>. <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>beam.interpreters.erlang</literal>, is aliased as
@ -45,19 +50,22 @@
<literal>beam.packages.erlang</literal> and aliased at the top level as <literal>beam.packages.erlang</literal> and aliased at the top level as
<literal>beamPackages</literal>. <literal>beamPackages</literal>.
</para> </para>
<para> <para>
To create a package set built with a custom Erlang version, use the To create a package set built with a custom Erlang version, use the lambda,
lambda, <literal>beam.packagesWith</literal>, which accepts an Erlang/OTP <literal>beam.packagesWith</literal>, which accepts an Erlang/OTP derivation
derivation and produces a package set similar to and produces a package set similar to
<literal>beam.packages.erlang</literal>. <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 <literal>beam.interpreters</literal> have versions with ODBC and/or Java
enabled. For example, there's enabled. For example, there's
<literal>beam.interpreters.erlangR19_odbc_javac</literal>, which <literal>beam.interpreters.erlangR19_odbc_javac</literal>, which corresponds
corresponds to <literal>beam.interpreters.erlangR19</literal>. 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 <literal>beam.packages.erlang.callPackage</literal>, which simplifies
@ -65,10 +73,13 @@
<literal>beam.packages.erlang</literal> into the top-level context. <literal>beam.packages.erlang</literal> into the top-level context.
</para> </para>
</section> </section>
<section xml:id="build-tools"> <section xml:id="build-tools">
<title>Build Tools</title> <title>Build Tools</title>
<section xml:id="build-tools-rebar3"> <section xml:id="build-tools-rebar3">
<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. acceptable in the normal, non-Nix setup, but in the Nix world, it is not.
@ -84,17 +95,20 @@
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<literal>rebar3-open</literal>: the normal, unmodified Rebar3. It <literal>rebar3-open</literal>: the normal, unmodified Rebar3. It should
should work exactly as would any other version of Rebar3. Any Erlang work exactly as would any other version of Rebar3. Any Erlang package
package should rely on <literal>rebar3</literal> instead. See <xref should rely on <literal>rebar3</literal> instead. See
<xref
linkend="rebar3-packages"/>. linkend="rebar3-packages"/>.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</para> </para>
</section> </section>
<section xml:id="build-tools-other"> <section xml:id="build-tools-other">
<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 process that needs to be run for both, however, which is supported by the
@ -106,16 +120,15 @@
<section xml:id="how-to-install-beam-packages"> <section xml:id="how-to-install-beam-packages">
<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 not relevant to the vast majority of Nix users. They are installable using
the <literal>beam.packages.erlang</literal> attribute set (aliased as the <literal>beam.packages.erlang</literal> attribute set (aliased as
<literal>beamPackages</literal>), which points to packages built by the <literal>beamPackages</literal>), which points to packages built by the
default Erlang/OTP version in Nixpkgs, as defined by default Erlang/OTP version in Nixpkgs, as defined by
<literal>beam.interpreters.erlang</literal>. <literal>beam.interpreters.erlang</literal>. To list the available packages
in <literal>beamPackages</literal>, use the following command:
To list the available packages in
<literal>beamPackages</literal>, use the following command:
</para> </para>
<programlisting> <programlisting>
@ -128,33 +141,42 @@ beamPackages.lager lager-3.0.2
beamPackages.meck meck-0.8.3 beamPackages.meck meck-0.8.3
beamPackages.rebar3-pc pc-1.1.0 beamPackages.rebar3-pc pc-1.1.0
</programlisting> </programlisting>
<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>
<programlisting> <programlisting>
$ nix-env -f &quot;&lt;nixpkgs&gt;&quot; -iA beamPackages.ibrowse $ nix-env -f &quot;&lt;nixpkgs&gt;&quot; -iA beamPackages.ibrowse
</programlisting> </programlisting>
<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 particular package in <link xlink:href="https://hex.pm">Hex</link> or its
OTP Application/Release name. OTP Application/Release name.
</para> </para>
</section> </section>
<section xml:id="packaging-beam-applications"> <section xml:id="packaging-beam-applications">
<title>Packaging BEAM Applications</title> <title>Packaging BEAM Applications</title>
<section xml:id="packaging-erlang-applications"> <section xml:id="packaging-erlang-applications">
<title>Erlang Applications</title> <title>Erlang Applications</title>
<section xml:id="rebar3-packages"> <section xml:id="rebar3-packages">
<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 <literal>beam.packages.erlang.buildRebar3</literal> and aliased at the top
top level, can be used to build a derivation that understands how to level, can be used to build a derivation that understands how to build a
build a Rebar3 project. For example, we can build <link Rebar3 project. For example, we can build
xlink:href="https://github.com/erlang-nix/hex2nix">hex2nix</link> as <link
follows: xlink:href="https://github.com/erlang-nix/hex2nix">hex2nix</link>
as follows:
</para> </para>
<programlisting> <programlisting>
{ stdenv, fetchFromGitHub, buildRebar3, ibrowse, jsx, erlware_commons }: { stdenv, fetchFromGitHub, buildRebar3, ibrowse, jsx, erlware_commons }:
@ -172,32 +194,39 @@ $ nix-env -f &quot;&lt;nixpkgs&gt;&quot; -iA beamPackages.ibrowse
beamDeps = [ ibrowse jsx erlware_commons ]; beamDeps = [ ibrowse jsx erlware_commons ];
} }
</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 <xref
<literal>callPackage</literal>, refer to dependency packages via linkend="erlang-call-package"/>). To call this package using
<literal>beamPackages</literal>, e.g. the normal <literal>callPackage</literal>, refer to dependency packages
via <literal>beamPackages</literal>, e.g.
<literal>beamPackages.ibrowse</literal>. <literal>beamPackages.ibrowse</literal>.
</para> </para>
<para> <para>
Notably, <literal>buildRebar3</literal> includes Notably, <literal>buildRebar3</literal> includes
<literal>beamDeps</literal>, while <literal>beamDeps</literal>, while <literal>stdenv.mkDerivation</literal>
<literal>stdenv.mkDerivation</literal> does not. BEAM dependencies added does not. BEAM dependencies added there will be correctly handled by the
there will be correctly handled by the system. 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>
<section xml:id="erlang-mk-packages"> <section xml:id="erlang-mk-packages">
<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>buildErlangMk</literal> instead of
<literal>buildRebar3</literal>. <literal>buildRebar3</literal>.
</para> </para>
<programlisting> <programlisting>
{ buildErlangMk, fetchHex, cowlib, ranch }: { buildErlangMk, fetchHex, cowlib, ranch }:
@ -223,12 +252,15 @@ $ nix-env -f &quot;&lt;nixpkgs&gt;&quot; -iA beamPackages.ibrowse
} }
</programlisting> </programlisting>
</section> </section>
<section xml:id="mix-packages"> <section xml:id="mix-packages">
<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>
{ buildMix, fetchHex, plug, absinthe }: { buildMix, fetchHex, plug, absinthe }:
@ -253,9 +285,11 @@ $ nix-env -f &quot;&lt;nixpkgs&gt;&quot; -iA beamPackages.ibrowse
}; };
} }
</programlisting> </programlisting>
<para> <para>
Alternatively, we can use <literal>buildHex</literal> as a shortcut: Alternatively, we can use <literal>buildHex</literal> as a shortcut:
</para> </para>
<programlisting> <programlisting>
{ buildHex, buildMix, plug, absinthe }: { buildHex, buildMix, plug, absinthe }:
@ -281,17 +315,21 @@ $ nix-env -f &quot;&lt;nixpkgs&gt;&quot; -iA beamPackages.ibrowse
</section> </section>
</section> </section>
</section> </section>
<section xml:id="how-to-develop"> <section xml:id="how-to-develop">
<title>How to Develop</title> <title>How to Develop</title>
<section xml:id="accessing-an-environment"> <section xml:id="accessing-an-environment">
<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 specific package and its dependencies. We can accomplish that with the
<literal>env</literal> attribute of a derivation. For example, let's say <literal>env</literal> attribute of a derivation. For example, let's say we
we want to access an Erlang REPL with <literal>ibrowse</literal> loaded want to access an Erlang REPL with <literal>ibrowse</literal> loaded up. We
up. We could do the following: could do the following:
</para> </para>
<programlisting> <programlisting>
$ nix-shell -A beamPackages.ibrowse.env --run "erl" $ nix-shell -A beamPackages.ibrowse.env --run "erl"
Erlang/OTP 18 [erts-7.0] [source] [64-bit] [smp:4:4] [async-threads:10] [hipe] [kernel-poll:false] Erlang/OTP 18 [erts-7.0] [source] [64-bit] [smp:4:4] [async-threads:10] [hipe] [kernel-poll:false]
@ -333,21 +371,24 @@ $ nix-env -f &quot;&lt;nixpkgs&gt;&quot; -iA beamPackages.ibrowse
ok ok
2> 2>
</programlisting> </programlisting>
<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>
<section xml:id="creating-a-shell"> <section xml:id="creating-a-shell">
<title>Creating a Shell</title> <title>Creating a Shell</title>
<para> <para>
Getting access to an environment often isn't enough to do real Getting access to an environment often isn't enough to do real development.
development. Usually, we need to create a <literal>shell.nix</literal> Usually, we need to create a <literal>shell.nix</literal> file and do our
file and do our development inside of the environment specified therein. development inside of the environment specified therein. This file looks a
This file looks a lot like the packaging described above, except that lot like the packaging described above, except that <literal>src</literal>
<literal>src</literal> points to the project root and we call the package points to the project root and we call the package directly.
directly.
</para> </para>
<programlisting> <programlisting>
{ pkgs ? import &quot;&lt;nixpkgs&quot;&gt; {} }: { pkgs ? import &quot;&lt;nixpkgs&quot;&gt; {} }:
@ -368,12 +409,15 @@ in
drv drv
</programlisting> </programlisting>
<section xml:id="building-in-a-shell"> <section xml:id="building-in-a-shell">
<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>
# ============================================================================= # =============================================================================
# Variables # Variables
@ -431,8 +475,10 @@ analyze: build plt
$(NIX_SHELL) --run "mix dialyzer --no-compile" $(NIX_SHELL) --run "mix dialyzer --no-compile"
</programlisting> </programlisting>
<para> <para>
Using a <literal>shell.nix</literal> as described (see <xref Using a <literal>shell.nix</literal> as described (see
<xref
linkend="creating-a-shell"/>) should just work. Aside from linkend="creating-a-shell"/>) should just work. Aside from
<literal>test</literal>, <literal>plt</literal>, and <literal>test</literal>, <literal>plt</literal>, and
<literal>analyze</literal>, the Make targets work just fine for all of the <literal>analyze</literal>, the Make targets work just fine for all of the
@ -441,34 +487,42 @@ analyze: build plt
</section> </section>
</section> </section>
</section> </section>
<section xml:id="generating-packages-from-hex-with-hex2nix"> <section xml:id="generating-packages-from-hex-with-hex2nix">
<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 <link
path to the Erlang modules (usually 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 <literal>pkgs/development/erlang-modules</literal>), it will dump a file
called <literal>hex-packages.nix</literal>, containing all the packages that called <literal>hex-packages.nix</literal>, containing all the packages that
use a recognized build system in <link use a recognized build system in
xlink:href="https://hex.pm">Hex</link>. It can't be determined, however, <link
whether every package is buildable. 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 <link To make life easier for our users, try to build every
xlink:href="https://hex.pm">Hex</link> package and remove those that fail. <link
To do that, simply run the following command in the root of your 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: <literal>nixpkgs</literal> repository:
</para> </para>
<programlisting> <programlisting>
$ nix-build -A beamPackages $ nix-build -A beamPackages
</programlisting> </programlisting>
<para> <para>
That will attempt to build every package in That will attempt to build every package in <literal>beamPackages</literal>.
<literal>beamPackages</literal>. Then manually remove those that fail. Then manually remove those that fail. Hopefully, someone will improve
Hopefully, someone will improve <link <link
xlink:href="https://github.com/erlang-nix/hex2nix">hex2nix</link> in the xlink:href="https://github.com/erlang-nix/hex2nix">hex2nix</link>
future to automate the process. in the future to automate the process.
</para> </para>
</section> </section>
</section> </section>

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

@ -1,23 +1,20 @@
<section xmlns="http://docbook.org/ns/docbook" <section xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"
xml:id="sec-bower"> xml:id="sec-bower">
<title>Bower</title> <title>Bower</title>
<para> <para>
<link xlink:href="http://bower.io">Bower</link> is a package manager <link xlink:href="http://bower.io">Bower</link> is a package manager for web
for web site front-end components. Bower packages (comprising of site front-end components. Bower packages (comprising of build artefacts and
build artefacts and sometimes sources) are stored in sometimes sources) are stored in <command>git</command> repositories,
<command>git</command> repositories, typically on Github. The typically on Github. The package registry is run by the Bower team with
package registry is run by the Bower team with package metadata package metadata coming from the <filename>bower.json</filename> file within
coming from the <filename>bower.json</filename> file within each each package.
package.
</para> </para>
<para> <para>
The end result of running Bower is a The end result of running Bower is a <filename>bower_components</filename>
<filename>bower_components</filename> directory which can be included directory which can be included in the web app's build process.
in the web app's build process.
</para> </para>
<para> <para>
@ -31,10 +28,10 @@
<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 contents: Suppose you have a <filename>bower.json</filename> with the following
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">
<![CDATA[{ <![CDATA[{
"name": "my-web-app", "name": "my-web-app",
@ -47,11 +44,9 @@
</example> </example>
</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 = [
@ -62,29 +57,29 @@ buildEnv { name = "bower-env"; ignoreCollisions = true; paths = [
</programlisting> </programlisting>
</para> </para>
<para> <para>
Using the <command>bower2nix</command> command line arguments, the Using the <command>bower2nix</command> command line arguments, the output
output can be redirected to a file. A name like can be redirected to a file. A name like
<filename>bower-packages.nix</filename> would be fine. <filename>bower-packages.nix</filename> would be fine.
</para> </para>
<para> <para>
The resulting derivation is a union of all the downloaded Bower The resulting derivation is a union of all the downloaded Bower packages
packages (and their dependencies). To use it, they still need to be (and their dependencies). To use it, they still need to be linked together
linked together by Bower, which is where by Bower, which is where <varname>buildBowerComponents</varname> is useful.
<varname>buildBowerComponents</varname> is useful.
</para> </para>
</section> </section>
<section xml:id="ssec-build-bower-components"><title><varname>buildBowerComponents</varname> function</title> <section xml:id="ssec-build-bower-components">
<title><varname>buildBowerComponents</varname> function</title>
<para> <para>
The function is implemented in <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/bower-modules/generic/default.nix"> 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>. <filename>pkgs/development/bower-modules/generic/default.nix</filename></link>.
Example usage: Example usage:
<example xml:id="ex-buildBowerComponents">
<example xml:id="ex-buildBowerComponents"><title>buildBowerComponents</title> <title>buildBowerComponents</title>
<programlisting language="nix"> <programlisting language="nix">
bowerComponents = buildBowerComponents { bowerComponents = buildBowerComponents {
name = "my-web-app"; name = "my-web-app";
@ -96,38 +91,38 @@ bowerComponents = buildBowerComponents {
</para> </para>
<para> <para>
In <xref linkend="ex-buildBowerComponents" />, the following arguments In <xref linkend="ex-buildBowerComponents" />, the following arguments are
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 <command>bower2nix</command>. <varname>generated</varname> specifies the file which was created by
<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 <varname>src</varname> is your project's sources. It needs to contain a
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 <varname>buildBowerComponents</varname> will run Bower to link together the
together the output of <command>bower2nix</command>, resulting in a output of <command>bower2nix</command>, resulting in a
<filename>bower_components</filename> directory which can be used. <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 <command>gulp</command>. You might use <command>grunt</command>, or anything
anything else. else.
</para> </para>
<example xml:id="ex-bowerGulpFile"><title>Example build script (<filename>gulpfile.js</filename>)</title> <example xml:id="ex-bowerGulpFile">
<title>Example build script (<filename>gulpfile.js</filename>)</title>
<programlisting language="javascript"> <programlisting language="javascript">
<![CDATA[var gulp = require('gulp'); <![CDATA[var gulp = require('gulp');
@ -176,31 +171,26 @@ pkgs.stdenv.mkDerivation {
<para> <para>
A few notes about <xref linkend="ex-buildBowerComponentsDefaultNix" />: A few notes about <xref linkend="ex-buildBowerComponentsDefaultNix" />:
<calloutlist> <calloutlist>
<callout arearefs="ex-buildBowerComponentsDefault-1"> <callout arearefs="ex-buildBowerComponentsDefault-1">
<para> <para>
The result of <varname>buildBowerComponents</varname> is an The result of <varname>buildBowerComponents</varname> is an input to the
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 Whether to symlink or copy the <filename>bower_components</filename>
<filename>bower_components</filename> directory depends on the directory depends on the build tool in use. In this case a copy is used
build tool in use. In this case a copy is used to avoid to avoid <command>gulp</command> silliness with permissions.
<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 <command>gulp</command> requires <varname>HOME</varname> to refer to a
refer to a writeable directory. writeable directory.
</para> </para>
</callout> </callout>
<callout arearefs="ex-buildBowerComponentsDefault-4"> <callout arearefs="ex-buildBowerComponentsDefault-4">
<para> <para>
The actual build command. Other tools could be used. The actual build command. Other tools could be used.
@ -214,17 +204,14 @@ A few notes about <xref linkend="ex-buildBowerComponentsDefaultNix" />:
<title>Troubleshooting</title> <title>Troubleshooting</title>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term><literal>ENOCACHE</literal> errors from
<literal>ENOCACHE</literal> errors from
<varname>buildBowerComponents</varname> <varname>buildBowerComponents</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
This means that Bower was looking for a package version which This means that Bower was looking for a package version which doesn't
doesn't exist in the generated exist in the generated <filename>bower-packages.nix</filename>.
<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
@ -232,13 +219,11 @@ A few notes about <xref linkend="ex-buildBowerComponentsDefaultNix" />:
</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 <command>fetchbower</command>. If possible, try reformulating the version
the version specification in <filename>bower.json</filename>. specification in <filename>bower.json</filename>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</section> </section>
</section> </section>

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

@ -1,35 +1,37 @@
<section xmlns="http://docbook.org/ns/docbook" <section xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"
xml:id="sec-language-coq"> xml:id="sec-language-coq">
<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>. <literal>$(out)/lib/coq/${coq.coq-version}/user-contrib/</literal>. Such
Such directories are automatically added to the directories are automatically added to the <literal>$COQPATH</literal>
<literal>$COQPATH</literal> environment variable by the hook defined environment variable by the hook defined in the Coq derivation.
in the Coq derivation.
</para> </para>
<para> <para>
Some libraries require OCaml and sometimes also Camlp5 or findlib. Some libraries require OCaml and sometimes also Camlp5 or findlib. The exact
The exact versions that were used to build Coq are saved in the versions that were used to build Coq are saved in the
<literal>coq.ocaml</literal> and <literal>coq.camlp5</literal> <literal>coq.ocaml</literal> and <literal>coq.camlp5</literal> and
and <literal>coq.findlib</literal> attributes. <literal>coq.findlib</literal> attributes.
</para> </para>
<para> <para>
Coq libraries may be compatible with some specific versions of Coq only. Coq libraries may be compatible with some specific versions of Coq only. The
The <literal>compatibleCoqVersions</literal> attribute is used to <literal>compatibleCoqVersions</literal> attribute is used to precisely
precisely select those versions of Coq that are compatible with this select those versions of Coq that are compatible with this derivation.
derivation.
</para> </para>
<para> <para>
Here is a simple package example. It is a pure Coq library, thus it Here is a simple package example. It is a pure Coq library, thus it depends
depends on Coq. It builds on the Mathematical Components library, thus it on Coq. It builds on the Mathematical Components library, thus it also takes
also takes <literal>mathcomp</literal> as <literal>buildInputs</literal>. <literal>mathcomp</literal> as <literal>buildInputs</literal>. Its
Its <literal>Makefile</literal> has been generated using <literal>Makefile</literal> has been generated using
<literal>coq_makefile</literal> so we only have to <literal>coq_makefile</literal> so we only have to set the
set the <literal>$COQLIB</literal> variable at install time. <literal>$COQLIB</literal> variable at install time.
</para> </para>
<programlisting> <programlisting>
{ stdenv, fetchFromGitHub, coq, mathcomp }: { stdenv, fetchFromGitHub, coq, mathcomp }:

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

@ -1,14 +1,14 @@
<section xmlns="http://docbook.org/ns/docbook" <section xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"
xml:id="sec-language-go"> xml:id="sec-language-go">
<title>Go</title> <title>Go</title>
<para>The function <varname>buildGoPackage</varname> builds <para>
standard Go programs. The function <varname>buildGoPackage</varname> builds standard Go programs.
</para> </para>
<example xml:id='ex-buildGoPackage'><title>buildGoPackage</title> <example xml:id='ex-buildGoPackage'>
<title>buildGoPackage</title>
<programlisting> <programlisting>
deis = buildGoPackage rec { deis = buildGoPackage rec {
name = "deis-${version}"; name = "deis-${version}";
@ -31,53 +31,54 @@ deis = buildGoPackage rec {
</programlisting> </programlisting>
</example> </example>
<para><xref linkend='ex-buildGoPackage'/> is an example expression using buildGoPackage, <para>
the following arguments are of special significance to the function: <xref linkend='ex-buildGoPackage'/> is an example expression using
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 import path. <varname>goPackagePath</varname> specifies the package's canonical Go
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 packages that <varname>subPackages</varname> limits the builder from building child
have not been listed. If <varname>subPackages</varname> is not specified, all child packages that have not been listed. If <varname>subPackages</varname> is
packages will be built. not specified, all child packages will be built.
</para> </para>
<para> <para>
In this example only <literal>github.com/deis/deis/client</literal> will be built. In this example only <literal>github.com/deis/deis/client</literal> will
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 are listed <varname>goDeps</varname> is where the Go dependencies of a Go program are
as a list of package source identified by Go import path. listed as a list of package source identified by Go import path. It could
It could be imported as a separate <varname>deps.nix</varname> file for be imported as a separate <varname>deps.nix</varname> file for
readability. The dependency data structure is described below. 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 command. <varname>buildFlags</varname> is a list of flags passed to the go build
command.
</para> </para>
</callout> </callout>
</calloutlist> </calloutlist>
</para> </para>
<para>The <varname>goDeps</varname> attribute can be imported from a separate <para>
<varname>nix</varname> file that defines which Go libraries are needed and should The <varname>goDeps</varname> attribute can be imported from a separate
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'><title>deps.nix</title> <example xml:id='ex-goDeps'>
<title>deps.nix</title>
<programlisting> <programlisting>
[ <co xml:id='ex-goDeps-1' /> [ <co xml:id='ex-goDeps-1' />
{ {
@ -103,64 +104,57 @@ the following arguments are of special significance to the function:
</example> </example>
<para> <para>
<calloutlist> <calloutlist>
<callout arearefs='ex-goDeps-1'> <callout arearefs='ex-goDeps-1'>
<para> <para>
<varname>goDeps</varname> is a list of Go dependencies. <varname>goDeps</varname> is a list of Go dependencies.
</para> </para>
</callout> </callout>
<callout arearefs='ex-goDeps-2'> <callout arearefs='ex-goDeps-2'>
<para> <para>
<varname>goPackagePath</varname> specifies Go package import path. <varname>goPackagePath</varname> specifies Go package import path.
</para> </para>
</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 source. If <varname>git</varname> <varname>fetch type</varname> that needs to be used to get package source.
is used there should be <varname>url</varname>, <varname>rev</varname> and <varname>sha256</varname> If <varname>git</varname> is used there should be <varname>url</varname>,
defined next to it. <varname>rev</varname> and <varname>sha256</varname> defined next to it.
</para> </para>
</callout> </callout>
</calloutlist> </calloutlist>
</para> </para>
<para>To extract dependency information from a Go package in automated way use <link xlink:href="https://github.com/kamilchm/go2nix">go2nix</link>. <para>
It can produce complete derivation and <varname>goDeps</varname> file for Go programs.</para> 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.
</para>
<para> <para>
<varname>buildGoPackage</varname> produces <xref linkend='chap-multiple-output' xrefstyle="select: title" /> <varname>buildGoPackage</varname> produces
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>
$ nix-build -A deis.bin $ nix-build -A deis.bin
</screen> </screen>
or build all outputs with: or build all outputs with:
<screen> <screen>
$ nix-build -A deis.all $ 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> <varname>nix-env -i</varname> or <varname>systemPackages</varname>.
or <varname>systemPackages</varname>.
</para> </para>
<para> <para>
You may use Go packages installed into the active Nix profiles by adding You may use Go packages installed into the active Nix profiles by adding the
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"
done done
</screen> </screen>
</para> </para>
</section> </section>

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

@ -1,18 +1,15 @@
<chapter xmlns="http://docbook.org/ns/docbook" <chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
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 The <link linkend="chap-stdenv">standard build environment</link> makes it
environment</link> makes it easy to build typical Autotools-based easy to build typical Autotools-based packages with very little code. Any
packages with very little code. Any other kind of package can be other kind of package can be accomodated by overriding the appropriate phases
accomodated by overriding the appropriate phases of of <literal>stdenv</literal>. However, there are specialised functions in
<literal>stdenv</literal>. However, there are specialised functions Nixpkgs to easily build packages for other programming languages, such as
in Nixpkgs to easily build packages for other programming languages, Perl or Haskell. These are described in this chapter.
such as Perl or Haskell. These are described in this chapter.</para> </para>
<xi:include href="beam.xml" /> <xi:include href="beam.xml" />
<xi:include href="bower.xml" /> <xi:include href="bower.xml" />
<xi:include href="coq.xml" /> <xi:include href="coq.xml" />
@ -31,6 +28,4 @@ such as Perl or Haskell. These are described in this chapter.</para>
<xi:include href="texlive.xml" /> <xi:include href="texlive.xml" />
<xi:include href="vim.section.xml" /> <xi:include href="vim.section.xml" />
<xi:include href="emscripten.section.xml" /> <xi:include href="emscripten.section.xml" />
</chapter> </chapter>

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

@ -1,11 +1,10 @@
<section xmlns="http://docbook.org/ns/docbook" <section xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"
xml:id="sec-language-java"> xml:id="sec-language-java">
<title>Java</title> <title>Java</title>
<para>Ant-based Java packages are typically built from source as follows: <para>
Ant-based Java packages are typically built from source as follows:
<programlisting> <programlisting>
stdenv.mkDerivation { stdenv.mkDerivation {
name = "..."; name = "...";
@ -16,33 +15,33 @@ stdenv.mkDerivation {
buildPhase = "ant"; buildPhase = "ant";
} }
</programlisting> </programlisting>
Note that <varname>jdk</varname> is an alias for the OpenJDK.
</para>
Note that <varname>jdk</varname> is an alias for the OpenJDK.</para> <para>
JAR files that are intended to be used by other packages should be installed
<para>JAR files that are intended to be used by other packages should in <filename>$out/share/java</filename>. The OpenJDK has a stdenv setup hook
be installed in <filename>$out/share/java</filename>. The OpenJDK has that adds any JARs in the <filename>share/java</filename> directories of the
a stdenv setup hook that adds any JARs in the build inputs to the <envar>CLASSPATH</envar> environment variable. For
<filename>share/java</filename> directories of the build inputs to the instance, if the package <literal>libfoo</literal> installs a JAR named
<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> <filename>foo.jar</filename> in its <filename>share/java</filename>
directory, and another package declares the attribute directory, and another package declares the attribute
<programlisting> <programlisting>
buildInputs = [ jdk libfoo ]; buildInputs = [ jdk libfoo ];
</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>.</para> <filename>/nix/store/...-libfoo/share/java/foo.jar</filename>.
</para>
<para>Private JARs <para>
should be installed in a location like Private JARs should be installed in a location like
<filename>$out/share/<replaceable>package-name</replaceable></filename>.</para> <filename>$out/share/<replaceable>package-name</replaceable></filename>.
</para>
<para>If your Java package provides a program, you need to generate a <para>
wrapper script to run it using the OpenJRE. You can use 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: <literal>makeWrapper</literal> for this:
<programlisting> <programlisting>
buildInputs = [ makeWrapper ]; buildInputs = [ makeWrapper ];
@ -53,23 +52,20 @@ 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 package that contains the Java Runtime Environment. By using
OpenJDK package that contains the Java Runtime Environment. By using
<literal>${jre}/bin/java</literal> instead of <literal>${jre}/bin/java</literal> instead of
<literal>${jdk}/bin/java</literal>, you prevent your package from <literal>${jdk}/bin/java</literal>, you prevent your package from depending
depending on the JDK at runtime.</para> on the JDK at runtime.
</para>
<para>It is possible to use a different Java compiler than
<command>javac</command> from the OpenJDK. For instance, to use the
GNU Java Compiler:
<para>
It is possible to use a different Java compiler than <command>javac</command>
from the OpenJDK. For instance, to use the GNU Java Compiler:
<programlisting> <programlisting>
buildInputs = [ gcj ant ]; buildInputs = [ 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.</para> Runtime) instead of the OpenJRE.
</para>
</section> </section>

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

@ -1,23 +1,21 @@
<section xmlns="http://docbook.org/ns/docbook" <section xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"
xml:id="sec-language-lua"> xml:id="sec-language-lua">
<title>Lua</title> <title>Lua</title>
<para> <para>
Lua packages are built by the <varname>buildLuaPackage</varname> function. This function is Lua packages are built by the <varname>buildLuaPackage</varname> function.
implemented This function is implemented in
in <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/lua-modules/generic/default.nix"> <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> <filename>pkgs/development/lua-modules/generic/default.nix</filename></link>
and works similarly to <varname>buildPerlPackage</varname>. (See and works similarly to <varname>buildPerlPackage</varname>. (See
<xref linkend="sec-language-perl"/> for details.) <xref linkend="sec-language-perl"/> for details.)
</para> </para>
<para> <para>
Lua packages are defined Lua packages are defined in
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>. <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: Most of them are simple. For example:
<programlisting> <programlisting>
fileSystem = buildLuaPackage { fileSystem = buildLuaPackage {
name = "filesystem-1.6.2"; name = "filesystem-1.6.2";
@ -39,13 +37,12 @@ fileSystem = buildLuaPackage {
<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 defines Lua packages accept additional parameter <varname>disabled</varname>, which
the condition of disabling package from luaPackages. For example, if package has defines the condition of disabling package from luaPackages. For example, if
<varname>disabled</varname> assigned to <literal>lua.luaversion != "5.1"</literal>, package has <varname>disabled</varname> assigned to <literal>lua.luaversion
it will not be included in any luaPackages except lua51Packages, making it != "5.1"</literal>, it will not be included in any luaPackages except
only be built for lua 5.1. lua51Packages, making it only be built for lua 5.1.
</para> </para>
</section> </section>

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

@ -1,24 +1,27 @@
<section xmlns="http://docbook.org/ns/docbook" <section xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"
xml:id="sec-language-perl"> xml:id="sec-language-perl">
<title>Perl</title> <title>Perl</title>
<para>Nixpkgs provides a function <varname>buildPerlPackage</varname>, <para>
a generic package builder function for any Perl package that has a Nixpkgs provides a function <varname>buildPerlPackage</varname>, a generic
standard <varname>Makefile.PL</varname>. It’s implemented in <link package builder function for any Perl package that has a standard
xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/perl-modules/generic"><filename>pkgs/development/perl-modules/generic</filename></link>.</para> <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>.
</para>
<para>Perl packages from CPAN are defined in <link <para>
Perl packages from CPAN are defined in
<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>, 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 rather than <filename>pkgs/all-packages.nix</filename>. Most Perl packages
packages are so straight-forward to build that they are defined here are so straight-forward to build that they are defined here directly, rather
directly, rather than having a separate function for each package than having a separate function for each package called from
called from <filename>perl-packages.nix</filename>. However, more <filename>perl-packages.nix</filename>. However, more complicated packages
complicated packages should be put in a separate file, typically in should be put in a separate file, typically in
<filename>pkgs/development/perl-modules</filename>. Here is an <filename>pkgs/development/perl-modules</filename>. Here is an example of the
example of the former: former:
<programlisting> <programlisting>
ClassC3 = buildPerlPackage rec { ClassC3 = buildPerlPackage rec {
name = "Class-C3-0.21"; name = "Class-C3-0.21";
@ -28,74 +31,72 @@ 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 <literal>${name}</literal> in the URL definition to ensure that the name
name attribute is consistent with the source that we’re actually attribute is consistent with the source that we’re actually downloading.
downloading. Perl packages are made available in Perl packages are made available in <filename>all-packages.nix</filename>
<filename>all-packages.nix</filename> through the variable through the variable <varname>perlPackages</varname>. For instance, if you
<varname>perlPackages</varname>. For instance, if you have a package have a package that needs <varname>ClassC3</varname>, you would typically
that needs <varname>ClassC3</varname>, you would typically write 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 package as follows:
Perl package as follows:
<screen> <screen>
$ nix-build -A perlPackages.ClassC3 $ nix-build -A perlPackages.ClassC3
</screen> </screen>
<varname>buildPerlPackage</varname> adds <literal>perl-</literal> to the
<varname>buildPerlPackage</varname> adds <literal>perl-</literal> to start of the name attribute, so the package above is actually called
the start of the name attribute, so the package above is actually <literal>perl-Class-C3-0.21</literal>. So to install it, you can say:
called <literal>perl-Class-C3-0.21</literal>. So to install it, you
can say:
<screen> <screen>
$ nix-env -i perl-Class-C3 $ 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: -A perlPackages.ClassC3</literal>.)
<literal>nix-env -i -A perlPackages.ClassC3</literal>.)</para>
<para>So what does <varname>buildPerlPackage</varname> do? It does
the following:
<orderedlist>
<listitem><para>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></para></listitem>
<listitem><para>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.</para></listitem>
<listitem><para>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.</para></listitem>
</orderedlist>
</para> </para>
<para><varname>buildPerlPackage</varname> is built on top of <para>
<varname>stdenv</varname>, so everything can be customised in the So what does <varname>buildPerlPackage</varname> do? It does the following:
usual way. For instance, the <literal>BerkeleyDB</literal> module has <orderedlist>
a <varname>preConfigure</varname> hook to generate a configuration <listitem>
file used by <filename>Makefile.PL</filename>: <para>
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>
</para>
</listitem>
<listitem>
<para>
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.
</para>
</listitem>
<listitem>
<para>
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.
</para>
</listitem>
</orderedlist>
</para>
<para>
<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>:
<programlisting> <programlisting>
{ buildPerlPackage, fetchurl, db }: { buildPerlPackage, fetchurl, db }:
@ -113,18 +114,15 @@ buildPerlPackage rec {
''; '';
} }
</programlisting> </programlisting>
</para> </para>
<para>Dependencies on other Perl packages can be specified in the <para>
<varname>buildInputs</varname> and Dependencies on other Perl packages can be specified in the
<varname>propagatedBuildInputs</varname> attributes. If something is <varname>buildInputs</varname> and <varname>propagatedBuildInputs</varname>
exclusively a build-time dependency, use attributes. If something is exclusively a build-time dependency, use
<varname>buildInputs</varname>; if it’s (also) a runtime dependency, <varname>buildInputs</varname>; if it’s (also) a runtime dependency, use
use <varname>propagatedBuildInputs</varname>. For instance, this <varname>propagatedBuildInputs</varname>. For instance, this builds a Perl
builds a Perl module that has runtime dependencies on a bunch of other module that has runtime dependencies on a bunch of other modules:
modules:
<programlisting> <programlisting>
ClassC3Componentised = buildPerlPackage rec { ClassC3Componentised = buildPerlPackage rec {
name = "Class-C3-Componentised-1.0004"; name = "Class-C3-Componentised-1.0004";
@ -137,24 +135,26 @@ ClassC3Componentised = buildPerlPackage rec {
]; ];
}; };
</programlisting> </programlisting>
</para> </para>
<section xml:id="ssec-generation-from-CPAN"><title>Generation from CPAN</title> <section xml:id="ssec-generation-from-CPAN">
<title>Generation from CPAN</title>
<para>Nix expressions for Perl packages can be generated (almost) <para>
automatically from CPAN. This is done by the program Nix expressions for Perl packages can be generated (almost) automatically
<command>nix-generate-from-cpan</command>, which can be installed from CPAN. This is done by the program
as follows:</para> <command>nix-generate-from-cpan</command>, which can be installed as
follows:
</para>
<screen> <screen>
$ nix-env -i nix-generate-from-cpan $ nix-env -i nix-generate-from-cpan
</screen> </screen>
<para>This program takes a Perl module name, looks it up on CPAN, <para>
fetches and unpacks the corresponding package, and prints a Nix This program takes a Perl module name, looks it up on CPAN, fetches and
expression on standard output. For example: unpacks the corresponding package, and prints a Nix expression on standard
output. For example:
<screen> <screen>
$ nix-generate-from-cpan XML::Simple $ nix-generate-from-cpan XML::Simple
XMLSimple = buildPerlPackage rec { XMLSimple = buildPerlPackage rec {
@ -170,26 +170,23 @@ $ nix-generate-from-cpan XML::Simple
}; };
}; };
</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 <filename>pkgs/top-level/perl-packages.nix</filename> or wherever else you
you need it.</para> need it.
</para>
</section> </section>
<section xml:id="ssec-perl-cross-compilation"><title>Cross-compiling modules</title> <section xml:id="ssec-perl-cross-compilation">
<title>Cross-compiling modules</title>
<para>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.</para>
<para>
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.
</para>
</section> </section>
</section> </section>

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

@ -1,58 +1,74 @@
<section xmlns="http://docbook.org/ns/docbook" <section xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"
xml:id="sec-language-qt"> xml:id="sec-language-qt">
<title>Qt</title> <title>Qt</title>
<para> <para>
Qt is a comprehensive desktop and mobile application development toolkit for C++. Qt is a comprehensive desktop and mobile application development toolkit for
Legacy support is available for Qt 3 and Qt 4, but all current development uses Qt 5. C++. Legacy support is available for Qt 3 and Qt 4, but all current
The Qt 5 packages in Nixpkgs are updated frequently to take advantage of new features, development uses Qt 5. The Qt 5 packages in Nixpkgs are updated frequently to
but older versions are typically retained until their support window ends. take advantage of new features, but older versions are typically retained
The most important consideration in packaging Qt-based software is ensuring that each package and all its dependencies use the same version of Qt 5; until their support window ends. The most important consideration in
this consideration motivates most of the tools described below. packaging Qt-based software is ensuring that each package and all its
dependencies use the same version of Qt 5; this consideration motivates most
of the tools described below.
</para> </para>
<section xml:id="ssec-qt-libraries"><title>Packaging Libraries for Nixpkgs</title> <section xml:id="ssec-qt-libraries">
<title>Packaging Libraries for Nixpkgs</title>
<para> <para>
Whenever possible, libraries that use Qt 5 should be built with each available version. Whenever possible, libraries that use Qt 5 should be built with each
Packages providing libraries should be added to the top-level function <varname>mkLibsForQt5</varname>, available version. Packages providing libraries should be added to the
which is used to build a set of libraries for every Qt 5 version. top-level function <varname>mkLibsForQt5</varname>, which is used to build a
A special <varname>callPackage</varname> function is used in this scope to ensure that the entire dependency tree uses the same Qt 5 version. set of libraries for every Qt 5 version. A special
Import dependencies unqualified, i.e., <literal>qtbase</literal> not <literal>qt5.qtbase</literal>. <varname>callPackage</varname> function is used in this scope to ensure that
<emphasis>Do not</emphasis> import a package set such as <literal>qt5</literal> or <literal>libsForQt5</literal>. the entire dependency tree uses the same Qt 5 version. Import dependencies
unqualified, i.e., <literal>qtbase</literal> not
<literal>qt5.qtbase</literal>. <emphasis>Do not</emphasis> import a package
set such as <literal>qt5</literal> or <literal>libsForQt5</literal>.
</para> </para>
<para> <para>
If a library does not support a particular version of Qt 5, it is best to mark it as broken by setting its <literal>meta.broken</literal> attribute. If a library does not support a particular version of Qt 5, it is best to
A package may be marked broken for certain versions by testing the <literal>qtbase.version</literal> attribute, which will always give the current Qt 5 version. mark it as broken by setting its <literal>meta.broken</literal> attribute. A
package may be marked broken for certain versions by testing the
<literal>qtbase.version</literal> attribute, which will always give the
current Qt 5 version.
</para> </para>
</section> </section>
<section xml:id="ssec-qt-applications"><title>Packaging Applications for Nixpkgs</title> <section xml:id="ssec-qt-applications">
<title>Packaging Applications for Nixpkgs</title>
<para> <para>
Call your application expression using <literal>libsForQt5.callPackage</literal> instead of <literal>callPackage</literal>. Call your application expression using
Import dependencies unqualified, i.e., <literal>qtbase</literal> not <literal>qt5.qtbase</literal>. <literal>libsForQt5.callPackage</literal> instead of
<emphasis>Do not</emphasis> import a package set such as <literal>qt5</literal> or <literal>libsForQt5</literal>. <literal>callPackage</literal>. Import dependencies unqualified, i.e.,
<literal>qtbase</literal> not <literal>qt5.qtbase</literal>. <emphasis>Do
not</emphasis> import a package set such as <literal>qt5</literal> or
<literal>libsForQt5</literal>.
</para> </para>
<para> <para>
Qt 5 maintains strict backward compatibility, so it is generally best to build an application package against the latest version using the <varname>libsForQt5</varname> library set. Qt 5 maintains strict backward compatibility, so it is generally best to
In case a package does not build with the latest Qt version, it is possible to pick a set pinned to a particular version, e.g. <varname>libsForQt55</varname> for Qt 5.5, if that is the latest version the package supports. build an application package against the latest version using the
If a package must be pinned to an older Qt version, be sure to file a bug upstream; <varname>libsForQt5</varname> library set. In case a package does not build
because Qt is strictly backwards-compatible, any incompatibility is by definition a bug in the application. with the latest Qt version, it is possible to pick a set pinned to a
particular version, e.g. <varname>libsForQt55</varname> for Qt 5.5, if that
is the latest version the package supports. If a package must be pinned to
an older Qt version, be sure to file a bug upstream; because Qt is strictly
backwards-compatible, any incompatibility is by definition a bug in the
application.
</para> </para>
<para> <para>
When testing applications in Nixpkgs, it is a common practice to build the package with <literal>nix-build</literal> and run it using the created symbolic link. When testing applications in Nixpkgs, it is a common practice to build the
This will not work with Qt applications, however, because they have many hard runtime requirements that can only be guaranteed if the package is actually installed. package with <literal>nix-build</literal> and run it using the created
To test a Qt application, install it with <literal>nix-env</literal> or run it inside <literal>nix-shell</literal>. symbolic link. This will not work with Qt applications, however, because
they have many hard runtime requirements that can only be guaranteed if the
package is actually installed. To test a Qt application, install it with
<literal>nix-env</literal> or run it inside <literal>nix-shell</literal>.
</para> </para>
</section> </section>
</section> </section>

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

@ -1,17 +1,19 @@
<section xmlns="http://docbook.org/ns/docbook" <section xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"
xml:id="sec-language-ruby"> xml:id="sec-language-ruby">
<title>Ruby</title> <title>Ruby</title>
<para>There currently is support to bundle applications that are packaged as <para>
Ruby gems. The utility "bundix" allows you to write a 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</filename>, let bundler create a
<filename>Gemfile.lock</filename>, and then convert this into a nix <filename>Gemfile.lock</filename>, and then convert this into a nix
expression that contains all Gem dependencies automatically. expression that contains all Gem dependencies automatically.
</para> </para>
<para>For example, to package sensu, we did:</para> <para>
For example, to package sensu, we did:
</para>
<screen> <screen>
<![CDATA[$ cd pkgs/servers/monitoring <![CDATA[$ cd pkgs/servers/monitoring
@ -42,16 +44,17 @@ bundlerEnv rec {
}]]> }]]>
</screen> </screen>
<para>Please check in the <filename>Gemfile</filename>, <para>
<filename>Gemfile.lock</filename> and the Please check in the <filename>Gemfile</filename>,
<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>For tools written in Ruby - i.e. where the desire is to install <para>
a package and then execute e.g. <command>rake</command> at the command For tools written in Ruby - i.e. where the desire is to install a package and
line, there is an alternative builder called <literal>bundlerApp</literal>. then execute e.g. <command>rake</command> at the command line, there is an
Set up the <filename>gemset.nix</filename> the same way, and then, for alternative builder called <literal>bundlerApp</literal>. Set up the
example: <filename>gemset.nix</filename> the same way, and then, for example:
</para> </para>
<screen> <screen>
@ -72,30 +75,30 @@ bundlerApp {
}]]> }]]>
</screen> </screen>
<para>The chief advantage of <literal>bundlerApp</literal> over <para>
The chief advantage of <literal>bundlerApp</literal> over
<literal>bundlerEnv</literal> is the executables introduced in the <literal>bundlerEnv</literal> is the executables introduced in the
environment are precisely those selected in the <literal>exes</literal> environment are precisely those selected in the <literal>exes</literal> list,
list, as opposed to <literal>bundlerEnv</literal> which adds all the as opposed to <literal>bundlerEnv</literal> which adds all the executables
executables made available by gems in the gemset, which can mean e.g. made available by gems in the gemset, which can mean e.g.
<command>rspec</command> or <command>rake</command> in unpredictable <command>rspec</command> or <command>rake</command> in unpredictable versions
versions available from various packages. available from various packages.
</para> </para>
<para>Resulting derivations for both builders also have two helpful <para>
attributes, <literal>env</literal> and <literal>wrappedRuby</literal>. Resulting derivations for both builders also have two helpful attributes,
The first one allows one to quickly drop into <literal>env</literal> and <literal>wrappedRuby</literal>. The first one
<command>nix-shell</command> with the specified environment present. allows one to quickly drop into <command>nix-shell</command> with the
E.g. <command>nix-shell -A sensu.env</command> would give you an specified environment present. E.g. <command>nix-shell -A sensu.env</command>
environment with Ruby preset so it has all the libraries necessary would give you an environment with Ruby preset so it has all the libraries
for <literal>sensu</literal> in its paths. The second one can be necessary for <literal>sensu</literal> in its paths. The second one can be
used to make derivations from custom Ruby scripts which have used to make derivations from custom Ruby scripts which have
<filename>Gemfile</filename>s with their dependencies specified. It is <filename>Gemfile</filename>s with their dependencies specified. It is a
a derivation with <command>ruby</command> wrapped so it can find all derivation with <command>ruby</command> wrapped so it can find all the needed
the needed dependencies. For example, to make a derivation dependencies. For example, to make a derivation <literal>my-script</literal>
<literal>my-script</literal> for a <filename>my-script.rb</filename> for a <filename>my-script.rb</filename> (which should be placed in
(which should be placed in <filename>bin</filename>) you should run <filename>bin</filename>) you should run <command>bundix</command> as
<command>bundix</command> as specified above and then use specified above and then use <literal>bundlerEnv</literal> like this:
<literal>bundlerEnv</literal> like this:
</para> </para>
<programlisting> <programlisting>
@ -118,5 +121,4 @@ in stdenv.mkDerivation {
''; '';
}]]> }]]>
</programlisting> </programlisting>
</section> </section>

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

@ -1,15 +1,25 @@
<section xmlns="http://docbook.org/ns/docbook" <section xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"
xml:id="sec-language-texlive"> xml:id="sec-language-texlive">
<title>TeX Live</title> <title>TeX Live</title>
<para>Since release 15.09 there is a new TeX Live packaging that lives entirely under attribute <varname>texlive</varname>.</para> <para>
<section><title>User's guide</title> Since release 15.09 there is a new TeX Live packaging that lives entirely
under attribute <varname>texlive</varname>.
</para>
<section>
<title>User's guide</title>
<itemizedlist> <itemizedlist>
<listitem><para> <listitem>
For basic usage just pull <varname>texlive.combined.scheme-basic</varname> for an environment with basic LaTeX support.</para></listitem> <para>
<listitem><para> For basic usage just pull <varname>texlive.combined.scheme-basic</varname>
for an environment with basic LaTeX support.
</para>
</listitem>
<listitem>
<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>
@ -17,10 +27,15 @@ 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 defined upstream (perhaps with tiny differences). There are all the schemes, collections and a few thousand packages, as
</para></listitem> defined upstream (perhaps with tiny differences).
<listitem><para> </para>
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>. </listitem>
<listitem>
<para>
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>.
<programlisting> <programlisting>
texlive.combine { texlive.combine {
# inherit (texlive) whatever-you-want; # inherit (texlive) whatever-you-want;
@ -30,34 +45,55 @@ texlive.combine {
# there are also other attributes: version, name # there are also other attributes: version, name
} }
</programlisting> </programlisting>
</para></listitem> </para>
<listitem><para> </listitem>
<listitem>
<para>
You can list packages e.g. by <command>nix-repl</command>. You can list packages e.g. by <command>nix-repl</command>.
<programlisting> <programlisting>
$ nix-repl $ nix-repl
nix-repl> :l &lt;nixpkgs> nix-repl> :l &lt;nixpkgs>
nix-repl> texlive.collection-&lt;TAB> nix-repl> texlive.collection-&lt;TAB>
</programlisting> </programlisting>
</para></listitem> </para>
<listitem><para> </listitem>
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. <listitem>
</para></listitem> <para>
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.
</para>
</listitem>
</itemizedlist> </itemizedlist>
</section> </section>
<section><title>Known problems</title> <section>
<title>Known problems</title>
<itemizedlist> <itemizedlist>
<listitem><para> <listitem>
Some tools are still missing, e.g. luajittex;</para></listitem> <para>
<listitem><para> Some tools are still missing, e.g. luajittex;
some apps aren't packaged/tested yet (asymptote, biber, etc.);</para></listitem> </para>
<listitem><para> </listitem>
feature/bug: when a package is rejected by <varname>pkgFilter</varname>, its dependencies are still propagated;</para></listitem> <listitem>
<listitem><para> <para>
in case of any bugs or feature requests, file a github issue or better a pull request and /cc @vcunat.</para></listitem> some apps aren't packaged/tested yet (asymptote, biber, etc.);
</para>
</listitem>
<listitem>
<para>
feature/bug: when a package is rejected by <varname>pkgFilter</varname>,
its dependencies are still propagated;
</para>
</listitem>
<listitem>
<para>
in case of any bugs or feature requests, file a github issue or better a
pull request and /cc @vcunat.
</para>
</listitem>
</itemizedlist> </itemizedlist>
</section> </section>
</section> </section>

9
doc/manual.xml
View File

@ -1,14 +1,10 @@
<book xmlns="http://docbook.org/ns/docbook" <book xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"> xmlns:xi="http://www.w3.org/2001/XInclude">
<info> <info>
<title>Nixpkgs Contributors Guide</title> <title>Nixpkgs Contributors Guide</title>
<subtitle>Version <xi:include href=".version" parse="text" />
<subtitle>Version <xi:include href=".version" parse="text" /></subtitle> </subtitle>
</info> </info>
<xi:include href="introduction.chapter.xml" /> <xi:include href="introduction.chapter.xml" />
<xi:include href="quick-start.xml" /> <xi:include href="quick-start.xml" />
<xi:include href="stdenv.xml" /> <xi:include href="stdenv.xml" />
@ -25,5 +21,4 @@
<xi:include href="submitting-changes.xml" /> <xi:include href="submitting-changes.xml" />
<xi:include href="reviewing-contributions.xml" /> <xi:include href="reviewing-contributions.xml" />
<xi:include href="contributing.xml" /> <xi:include href="contributing.xml" />
</book> </book>

442
doc/meta.xml
View File

@ -1,14 +1,12 @@
<chapter xmlns="http://docbook.org/ns/docbook" <chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"
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> Nix packages can declare <emphasis>meta-attributes</emphasis> that contain
that contain information about a package such as a description, its information about a package such as a description, its homepage, its license,
homepage, its license, and so on. For instance, the GNU Hello package and so on. For instance, the GNU Hello package has a <varname>meta</varname>
has a <varname>meta</varname> declaration like this: declaration like this:
<programlisting> <programlisting>
meta = { meta = {
description = "A program that produces a familiar, friendly greeting"; description = "A program that produces a familiar, friendly greeting";
@ -22,16 +20,15 @@ meta = {
platforms = stdenv.lib.platforms.all; platforms = stdenv.lib.platforms.all;
}; };
</programlisting> </programlisting>
</para> </para>
<para>
<para>Meta-attributes are not passed to the builder of the package. Meta-attributes are not passed to the builder of the package. Thus, a change
Thus, a change to a meta-attribute doesn’t trigger a recompilation of to a meta-attribute doesn’t trigger a recompilation of the package. The
the package. The value of a meta-attribute must be a string.</para> value of a meta-attribute must be a string.
</para>
<para>The meta-attributes of a package can be queried from the <para>
command-line using <command>nix-env</command>: The meta-attributes of a package can be queried from the command-line using
<command>nix-env</command>:
<screen> <screen>
$ nix-env -qa hello --json $ nix-env -qa hello --json
{ {
@ -70,252 +67,299 @@ $ nix-env -qa hello --json
</screen> </screen>
<command>nix-env</command> knows about the <varname>description</varname>
<command>nix-env</command> knows about the field specifically:
<varname>description</varname> field specifically:
<screen> <screen>
$ nix-env -qa hello --description $ 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
</screen> </screen>
</para>
<section xml:id="sec-standard-meta-attributes">
<title>Standard meta-attributes</title>
<para>
It is expected that each meta-attribute is one of the following:
</para> </para>
<section xml:id="sec-standard-meta-attributes"><title>Standard
meta-attributes</title>
<para>It is expected that each meta-attribute is one of the following:</para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><varname>description</varname></term> <term><varname>description</varname>
<listitem><para>A short (one-line) description of the package. </term>
This is shown by <command>nix-env -q --description</command> and <listitem>
also on the Nixpkgs release pages.</para> <para>
A short (one-line) description of the package. This is shown by
<para>Don’t include a period at the end. Don’t include newline <command>nix-env -q --description</command> and also on the Nixpkgs
characters. Capitalise the first character. For brevity, don’t release pages.
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 images."</literal></para> 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
<para>Right: <literal>"A library for decoding PNG images"</literal></para> package — just describe what it does.
</para>
<para>
Wrong: <literal>"libpng is a library that allows you to decode PNG
images."</literal>
</para>
<para>
Right: <literal>"A library for decoding PNG images"</literal>
</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>longDescription</varname></term> <term><varname>longDescription</varname>
<listitem><para>An arbitrarily long description of the </term>
package.</para></listitem> <listitem>
<para>
An arbitrarily long description of the package.
</para>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>branch</varname></term> <term><varname>branch</varname>
<listitem><para>Release branch. Used to specify that a package is not </term>
going to receive updates that are not in this branch; for example, Linux <listitem>
kernel 3.0 is supposed to be updated to 3.0.X, not 3.1.</para></listitem> <para>
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.
</para>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>homepage</varname></term> <term><varname>homepage</varname>
<listitem><para>The package’s homepage. Example: </term>
<literal>http://www.gnu.org/software/hello/manual/</literal></para></listitem> <listitem>
<para>
The package’s homepage. Example:
<literal>http://www.gnu.org/software/hello/manual/</literal>
</para>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>downloadPage</varname></term> <term><varname>downloadPage</varname>
<listitem><para>The page where a link to the current version can be found. Example: </term>
<literal>http://ftp.gnu.org/gnu/hello/</literal></para></listitem> <listitem>
<para>
The page where a link to the current version can be found. Example:
<literal>http://ftp.gnu.org/gnu/hello/</literal>
</para>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>license</varname></term> <term><varname>license</varname>
</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
<link
xlink:href="https://github.com/NixOS/nixpkgs/blob/master/lib/licenses.nix"> xlink:href="https://github.com/NixOS/nixpkgs/blob/master/lib/licenses.nix">
<filename>nixpkgs/lib/licenses.nix</filename></link>. At this moment <filename>nixpkgs/lib/licenses.nix</filename></link>. At this moment
using both a list of licenses and a single license is valid. If the 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 license field is in the form of a list representation, then it means that
that parts of the package are licensed differently. Each license parts of the package are licensed differently. Each license should
should preferably be referenced by their attribute. The non-list preferably be referenced by their attribute. The non-list attribute value
attribute value can also be a space delimited string representation of can also be a space delimited string representation of the contained
the contained attribute shortNames or spdxIds. The following are all valid attribute shortNames or spdxIds. The following are all valid examples:
examples:
<itemizedlist> <itemizedlist>
<listitem><para>Single license referenced by attribute (preferred) <listitem>
<para>
Single license referenced by attribute (preferred)
<literal>stdenv.lib.licenses.gpl3</literal>. <literal>stdenv.lib.licenses.gpl3</literal>.
</para></listitem> </para>
<listitem><para>Single license referenced by its attribute shortName (frowned upon) </listitem>
<listitem>
<para>
Single license referenced by its attribute shortName (frowned upon)
<literal>"gpl3"</literal>. <literal>"gpl3"</literal>.
</para></listitem> </para>
<listitem><para>Single license referenced by its attribute spdxId (frowned upon) </listitem>
<listitem>
<para>
Single license referenced by its attribute spdxId (frowned upon)
<literal>"GPL-3.0"</literal>. <literal>"GPL-3.0"</literal>.
</para></listitem> </para>
<listitem><para>Multiple licenses referenced by attribute (preferred) </listitem>
<literal>with stdenv.lib.licenses; [ asl20 free ofl ]</literal>. <listitem>
</para></listitem> <para>
<listitem><para>Multiple licenses referenced as a space delimited string of attribute shortNames (frowned upon) Multiple licenses referenced by attribute (preferred) <literal>with
<literal>"asl20 free ofl"</literal>. stdenv.lib.licenses; [ asl20 free ofl ]</literal>.
</para></listitem> </para>
</listitem>
<listitem>
<para>
Multiple licenses referenced as a space delimited string of attribute
shortNames (frowned upon) <literal>"asl20 free ofl"</literal>.
</para>
</listitem>
</itemizedlist> </itemizedlist>
For details, see <xref linkend='sec-meta-license'/>. For details, see <xref linkend='sec-meta-license'/>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>maintainers</varname></term> <term><varname>maintainers</varname>
<listitem><para>A list of names and e-mail addresses of the </term>
maintainers of this Nix expression. If <listitem>
you would like to be a maintainer of a package, you may want to add <para>
yourself to <link 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
xlink:href="https://github.com/NixOS/nixpkgs/blob/master/maintainers/maintainer-list.nix"><filename>nixpkgs/maintainers/maintainer-list.nix</filename></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 and write something like <literal>[ stdenv.lib.maintainers.alice
stdenv.lib.maintainers.bob ]</literal>.</para></listitem> stdenv.lib.maintainers.bob ]</literal>.
</para>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>priority</varname></term> <term><varname>priority</varname>
<listitem><para>The <emphasis>priority</emphasis> of the package, </term>
used by <command>nix-env</command> to resolve file name conflicts <listitem>
between packages. See the Nix manual page for <para>
<command>nix-env</command> for details. Example: The <emphasis>priority</emphasis> of the package, used by
<literal>"10"</literal> (a low-priority <command>nix-env</command> to resolve file name conflicts between
package).</para></listitem> packages. See the Nix manual page for <command>nix-env</command> for
details. Example: <literal>"10"</literal> (a low-priority package).
</para>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>platforms</varname></term> <term><varname>platforms</varname>
<listitem><para>The list of Nix platform types on which the </term>
package is supported. Hydra builds packages according to the <listitem>
platform specified. If no platform is specified, the package does <para>
not have prebuilt binaries. An example is: 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:
<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"> <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/lib/systems/doubles.nix">
various common lists</link> of platforms types.</para></listitem> various common lists</link> of platforms types.
</para>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>hydraPlatforms</varname></term> <term><varname>hydraPlatforms</varname>
<listitem><para>The list of Nix platform types for which the Hydra </term>
instance at <literal>hydra.nixos.org</literal> will build the <listitem>
package. (Hydra is the Nix-based continuous build system.) It <para>
defaults to the value of <varname>meta.platforms</varname>. Thus, The list of Nix platform types for which the Hydra instance at
the only reason to set <varname>meta.hydraPlatforms</varname> is <literal>hydra.nixos.org</literal> will build the package. (Hydra is the
if you want <literal>hydra.nixos.org</literal> to build the Nix-based continuous build system.) It defaults to the value of
package on a subset of <varname>meta.platforms</varname>, or not <varname>meta.platforms</varname>. Thus, the only reason to set
at all, e.g. <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 = [];
</programlisting> </programlisting>
</para>
</para></listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>broken</varname></term> <term><varname>broken</varname>
<listitem><para>If set to <literal>true</literal>, the package is </term>
marked as “broken”, meaning that it won’t show up in <listitem>
<literal>nix-env -qa</literal>, and cannot be built or installed. <para>
Such packages should be removed from Nixpkgs eventually unless If set to <literal>true</literal>, the package is marked as “broken”,
they are fixed.</para></listitem> 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>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>updateWalker</varname></term> <term><varname>updateWalker</varname>
<listitem><para>If set to <literal>true</literal>, the package is </term>
tested to be updated correctly by the <literal>update-walker.sh</literal> <listitem>
script without additional settings. Such packages have <para>
<varname>meta.version</varname> set and their homepage (or If set to <literal>true</literal>, the package is tested to be updated
the page specified by <varname>meta.downloadPage</varname>) contains correctly by the <literal>update-walker.sh</literal> script without
a direct link to the package tarball.</para></listitem> 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>
</listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</section> </section>
<section xml:id="sec-meta-license">
<title>Licenses</title>
<para>
<section xml:id="sec-meta-license"><title>Licenses</title> The <varname>meta.license</varname> attribute should preferrably contain a
value from <varname>stdenv.lib.licenses</varname> defined in
<para>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"> <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/lib/licenses.nix">
<filename>nixpkgs/lib/licenses.nix</filename></link>, <filename>nixpkgs/lib/licenses.nix</filename></link>, or in-place license
or in-place license description of the same format if the license is description of the same format if the license is unlikely to be useful in
unlikely to be useful in another expression.</para> another expression.
<para>Although it's typically better to indicate the specific license,
a few generic options are available:
<variablelist>
<varlistentry>
<term><varname>stdenv.lib.licenses.free</varname>,
<varname>"free"</varname></term>
<listitem><para>Catch-all for free software licenses not listed
above.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>stdenv.lib.licenses.unfreeRedistributable</varname>,
<varname>"unfree-redistributable"</varname></term>
<listitem><para>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.</para>
<para>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.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>stdenv.lib.licenses.unfree</varname>,
<varname>"unfree"</varname></term>
<listitem><para>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.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>stdenv.lib.licenses.unfreeRedistributableFirmware</varname>,
<varname>"unfree-redistributable-firmware"</varname></term>
<listitem><para>This package supplies unfree, redistributable
firmware. This is a separate value from
<varname>unfree-redistributable</varname> because not everybody
cares whether firmware is free.</para></listitem>
</varlistentry>
</variablelist>
</para> </para>
<para>
Although it's typically better to indicate the specific license, a few
generic options are available:
<variablelist>
<varlistentry>
<term><varname>stdenv.lib.licenses.free</varname>,
<varname>"free"</varname>
</term>
<listitem>
<para>
Catch-all for free software licenses not listed above.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>stdenv.lib.licenses.unfreeRedistributable</varname>,
<varname>"unfree-redistributable"</varname>
</term>
<listitem>
<para>
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.
</para>
<para>
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.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>stdenv.lib.licenses.unfree</varname>,
<varname>"unfree"</varname>
</term>
<listitem>
<para>
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.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>stdenv.lib.licenses.unfreeRedistributableFirmware</varname>,
<varname>"unfree-redistributable-firmware"</varname>
</term>
<listitem>
<para>
This package supplies unfree, redistributable firmware. This is a
separate value from <varname>unfree-redistributable</varname> because
not everybody cares whether firmware is free.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</section> </section>
</chapter> </chapter>

360
doc/multiple-output.xml
View File

@ -5,105 +5,319 @@
<chapter xmlns="http://docbook.org/ns/docbook" <chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"
xml:id="chap-multiple-output"> xml:id="chap-multiple-output">
<title>Multiple-output packages</title> <title>Multiple-output packages</title>
<section>
<title>Introduction</title>
<section><title>Introduction</title> <para>
<para>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.</para> The Nix language allows a derivation to produce multiple outputs, which is
<para>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.</para> similar to what is utilized by other Linux distribution packaging systems.
<note><para>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.</para></note> 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>
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.
</para>
<note>
<para>
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.
</para>
</note>
</section> </section>
<section>
<title>Installing a split package</title>
<para>
When installing a package via <varname>systemPackages</varname> or
<command>nix-env</command> you have several options:
</para>
<section><title>Installing a split package</title>
<para>When installing a package via <varname>systemPackages</varname> or <command>nix-env</command> you have several options:</para>
<itemizedlist> <itemizedlist>
<listitem><para>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.</para></listitem> <listitem>
<listitem><para>You can let it use the default outputs. These are handled by <varname>meta.outputsToInstall</varname> attribute that contains a list of output names.</para> <para>
<para>TODO: more about tweaking the attribute, etc.</para></listitem> You can install particular outputs explicitly, as each is available in the
<listitem><para>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.</para> Nix language as an attribute of the package. The
<note><para>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.</para></note> <varname>outputs</varname> attribute contains a list of output names.
</para>
</listitem>
<listitem>
<para>
You can let it use the default outputs. These are handled by
<varname>meta.outputsToInstall</varname> attribute that contains a list of
output names.
</para>
<para>
TODO: more about tweaking the attribute, etc.
</para>
</listitem>
<listitem>
<para>
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.
</para>
<note>
<para>
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.
</para>
</note>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</section> </section>
<section>
<title>Using a split package</title>
<section><title>Using a split package</title> <para>
<para>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.</para> In the Nix language the individual outputs can be reached explicitly as
<para>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" />.)</para> attributes, e.g. <varname>coreutils.info</varname>, but the typical case is
just using packages as build inputs.
</para>
<para>
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" />.)
</para>
</section> </section>
<section>
<title>Writing a split derivation</title>
<para>
Here you find how to write a derivation that produces multiple outputs.
</para>
<para>
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).
</para>
<section><title>Writing a split derivation</title>
<para>Here you find how to write a derivation that produces multiple outputs.</para>
<para>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).</para>
<programlisting>outputs = [ "bin" "dev" "out" "doc" ];</programlisting> <programlisting>outputs = [ "bin" "dev" "out" "doc" ];</programlisting>
<para>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.</para>
<note><para>There is a special handling of the <varname>debug</varname> output, described at <xref linkend="stdenv-separateDebugInfo" />.</para></note> <para>
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.
</para>
<note>
<para>
There is a special handling of the <varname>debug</varname> output,
described at <xref linkend="stdenv-separateDebugInfo" />.
</para>
</note>
<section xml:id="multiple-output-file-binaries-first-convention"> <section xml:id="multiple-output-file-binaries-first-convention">
<title><quote>Binaries first</quote></title> <title><quote>Binaries first</quote></title>
<para>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.</para>
<para>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>).</para> <para>
<para>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).</para> 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.
</para>
<para>
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>).
</para>
<para>
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).
</para>
</section> </section>
<section xml:id="multiple-output-file-type-groups"> <section xml:id="multiple-output-file-type-groups">
<title>File type groups</title> <title>File type groups</title>
<para>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.</para>
<para>
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.
</para>
<variablelist> <variablelist>
<varlistentry>
<varlistentry><term><varname> <term><varname>
$outputDev</varname></term><listitem><para> $outputDev</varname>
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. </term>
</para></listitem> <listitem>
<para>
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.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>
$outputBin</varname>
</term>
<listitem>
<para>
is meant for user-facing binaries, typically residing in bin/. They go
to <varname>bin</varname> or <varname>out</varname> by default.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>
$outputLib</varname>
</term>
<listitem>
<para>
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.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>
$outputDoc</varname>
</term>
<listitem>
<para>
is for user documentation, typically residing in
<filename>share/doc/</filename>. It goes to <varname>doc</varname> or
<varname>out</varname> by default.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>
$outputDevdoc</varname>
</term>
<listitem>
<para>
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.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>
$outputMan</varname>
</term>
<listitem>
<para>
is for man pages (except for section 3). They go to
<varname>man</varname> or <varname>$outputBin</varname> by default.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>
$outputDevman</varname>
</term>
<listitem>
<para>
is for section 3 man pages. They go to <varname>devman</varname> or
<varname>$outputMan</varname> by default.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>
$outputInfo</varname>
</term>
<listitem>
<para>
is for info pages. They go to <varname>info</varname> or
<varname>$outputBin</varname> by default.
</para>
</listitem>
</varlistentry> </varlistentry>
<varlistentry><term><varname>
$outputBin</varname></term><listitem><para>
is meant for user-facing binaries, typically residing in bin/. They go to <varname>bin</varname> or <varname>out</varname> by default.
</para></listitem></varlistentry>
<varlistentry><term><varname>
$outputLib</varname></term><listitem><para>
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.
</para></listitem></varlistentry>
<varlistentry><term><varname>
$outputDoc</varname></term><listitem><para>
is for user documentation, typically residing in <filename>share/doc/</filename>. It goes to <varname>doc</varname> or <varname>out</varname> by default.
</para></listitem></varlistentry>
<varlistentry><term><varname>
$outputDevdoc</varname></term><listitem><para>
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.
</para></listitem></varlistentry>
<varlistentry><term><varname>
$outputMan</varname></term><listitem><para>
is for man pages (except for section 3). They go to <varname>man</varname> or <varname>$outputBin</varname> by default.
</para></listitem></varlistentry>
<varlistentry><term><varname>
$outputDevman</varname></term><listitem><para>
is for section 3 man pages. They go to <varname>devman</varname> or <varname>$outputMan</varname> by default.
</para></listitem></varlistentry>
<varlistentry><term><varname>
$outputInfo</varname></term><listitem><para>
is for info pages. They go to <varname>info</varname> or <varname>$outputBin</varname> by default.
</para></listitem></varlistentry>
</variablelist> </variablelist>
</section> </section>
<section><title>Common caveats</title> <section>
<title>Common caveats</title>
<itemizedlist> <itemizedlist>
<listitem><para>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>.</para></listitem> <listitem>
<listitem><para>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.)</para></listitem> <para>
<listitem><para>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.</para></listitem> Some configure scripts don't like some of the parameters passed by
<listitem><para>Some packages have hidden assumptions on install paths, which complicates splitting.</para></listitem> default by the framework, e.g. <literal>--docdir=/foo/bar</literal>. You
can disable this by setting <literal>setOutputFlags = false;</literal>.
</para>
</listitem>
<listitem>
<para>
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.)
</para>
</listitem>
<listitem>
<para>
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.
</para>
</listitem>
<listitem>
<para>
Some packages have hidden assumptions on install paths, which complicates
splitting.
</para>
</listitem>
</itemizedlist> </itemizedlist>
</section> </section>
</section>
</section><!--Writing a split derivation--> <!--Writing a split derivation-->
</chapter> </chapter>

180
doc/overlays.xml
View File

@ -1,70 +1,86 @@
<chapter xmlns="http://docbook.org/ns/docbook" <chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"
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 packages using This chapter describes how to extend and change Nixpkgs packages using
overlays. Overlays are used to add layers in the fix-point used by Nixpkgs overlays. Overlays are used to add layers in the fix-point used by Nixpkgs to
to compose the set of all packages.</para> compose the set of all packages.
</para>
<para>Nixpkgs can be configured with a list of overlays, which are <para>
applied in order. This means that the order of the overlays can be significant Nixpkgs can be configured with a list of overlays, which are applied in
if multiple layers override the same package.</para> order. This means that the order of the overlays can be significant if
multiple layers override the same package.
</para>
<!--============================================================--> <!--============================================================-->
<section xml:id="sec-overlays-install"> <section xml:id="sec-overlays-install">
<title>Installing overlays</title> <title>Installing overlays</title>
<para>The list of overlays is determined as follows.</para> <para>
The list of overlays is determined as follows.
<para>If the <varname>overlays</varname> argument is not provided explicitly, we look for overlays in a path. The path </para>
is determined as follows:
<para>
If the <varname>overlays</varname> argument is not provided explicitly, we
look for overlays in a path. The path is determined as follows:
<orderedlist> <orderedlist>
<listitem> <listitem>
<para>First, if an <varname>overlays</varname> argument to the nixpkgs function itself is given, <para>
then that is used.</para> First, if an <varname>overlays</varname> argument to the nixpkgs function
itself is given, then that is used.
<para>This can be passed explicitly when importing nipxkgs, for example </para>
<literal>import &lt;nixpkgs> { overlays = [ overlay1 overlay2 ]; }</literal>.</para> <para>
This can be passed explicitly when importing nipxkgs, for example
<literal>import &lt;nixpkgs> { overlays = [ overlay1 overlay2 ];
}</literal>.
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Otherwise, if the Nix path entry <literal>&lt;nixpkgs-overlays></literal> exists, we look for overlays <para>
at that path, as described below.</para> Otherwise, if the Nix path entry <literal>&lt;nixpkgs-overlays></literal>
exists, we look for overlays at that path, as described below.
<para>See the section on <literal>NIX_PATH</literal> in the Nix manual for more details on how to </para>
set a value for <literal>&lt;nixpkgs-overlays>.</literal></para> <para>
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>
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>If one of <filename>~/.config/nixpkgs/overlays.nix</filename> and <para>
<filename>~/.config/nixpkgs/overlays/</filename> exists, then we look for overlays at that path, as If one of <filename>~/.config/nixpkgs/overlays.nix</filename> and
described below. It is an error if both exist.</para> <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>
</listitem> </listitem>
</orderedlist> </orderedlist>
</para> </para>
<para>If we are looking for overlays at a path, then there are two cases: <para>
If we are looking for overlays at a path, then there are two cases:
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>If the path is a file, then the file is imported as a Nix expression and used as the list of <para>
overlays.</para> If the path is a file, then the file is imported as a Nix expression and
used as the list of overlays.
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>If the path is a directory, then we take the content of the directory, order it <para>
lexicographically, and attempt to interpret each as an overlay by: 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:
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>Importing the file, if it is a <literal>.nix</literal> file.</para> <para>
Importing the file, if it is a <literal>.nix</literal> file.
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Importing a top-level <filename>default.nix</filename> file, if it is a directory.</para> <para>
Importing a top-level <filename>default.nix</filename> file, if it is
a directory.
</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</para> </para>
@ -72,24 +88,30 @@ is determined as follows:
</itemizedlist> </itemizedlist>
</para> </para>
<para>On a NixOS system the value of the <literal>nixpkgs.overlays</literal> option, if present, <para>
is passed to the system Nixpkgs directly as an argument. Note that this does not affect the overlays for On a NixOS system the value of the <literal>nixpkgs.overlays</literal>
non-NixOS operations (e.g. <literal>nix-env</literal>), which are looked up independently.</para> 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.
<para>The <filename>overlays.nix</filename> option therefore provides a convenient way to use the same <literal>nix-env</literal>), which are looked up independently.
overlays for a NixOS system configuration and user configuration: the same file can be used </para>
as <filename>overlays.nix</filename> and imported as the value of <literal>nixpkgs.overlays</literal>.</para>
<para>
The <filename>overlays.nix</filename> option therefore 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>
</section> </section>
<!--============================================================--> <!--============================================================-->
<section xml:id="sec-overlays-definition"> <section xml:id="sec-overlays-definition">
<title>Defining overlays</title> <title>Defining overlays</title>
<para>Overlays are Nix functions which accept two arguments, <para>
conventionally called <varname>self</varname> and <varname>super</varname>, Overlays are Nix functions which accept two arguments, conventionally called
and return a set of packages. For example, the following is a valid overlay.</para> <varname>self</varname> and <varname>super</varname>, and return a set of
packages. For example, the following is a valid overlay.
</para>
<programlisting> <programlisting>
self: super: self: super:
@ -104,31 +126,39 @@ self: super:
} }
</programlisting> </programlisting>
<para>The first argument (<varname>self</varname>) corresponds to the final package <para>
set. You should use this set for the dependencies of all packages specified in your The first argument (<varname>self</varname>) corresponds to the final
overlay. For example, all the dependencies of <varname>rr</varname> in the example above come package set. You should use this set for the dependencies of all packages
from <varname>self</varname>, as well as the overridden dependencies used in the specified in your overlay. For example, all the dependencies of
<varname>boost</varname> override.</para> <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>The second argument (<varname>super</varname>) <para>
corresponds to the result of the evaluation of the previous stages of The second argument (<varname>super</varname>) corresponds to the result of
Nixpkgs. It does not contain any of the packages added by the current the evaluation of the previous stages of Nixpkgs. It does not contain any of
overlay, nor any of the following overlays. This set should be used either the packages added by the current overlay, nor any of the following
to refer to packages you wish to override, or to access functions defined overlays. This set should be used either to refer to packages you wish to
in Nixpkgs. For example, the original recipe of <varname>boost</varname> override, or to access functions defined in Nixpkgs. For example, the
in the above example, comes from <varname>super</varname>, as well as the original recipe of <varname>boost</varname> in the above example, comes from
<varname>callPackage</varname> function.</para> <varname>super</varname>, as well as the <varname>callPackage</varname>
function.
</para>
<para>The value returned by this function should be a set similar to <para>
<filename>pkgs/top-level/all-packages.nix</filename>, containing The value returned by this function should be a set similar to
overridden and/or new packages.</para> <filename>pkgs/top-level/all-packages.nix</filename>, containing overridden
and/or new packages.
<para>Overlays are similar to other methods for customizing Nixpkgs, in particular </para>
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>
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.
</para>
</section> </section>
</chapter> </chapter>

553
doc/package-notes.xml
View File

@ -1,206 +1,185 @@
<chapter xmlns="http://docbook.org/ns/docbook" <chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"
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 This chapter contains information about how to use and maintain the Nix
the Nix expressions for a number of specific packages, such as the expressions for a number of specific packages, such as the Linux kernel or
Linux kernel or X.org.</para> X.org.
</para>
<!--============================================================--> <!--============================================================-->
<section xml:id="sec-linux-kernel"> <section xml:id="sec-linux-kernel">
<title>Linux kernel</title> <title>Linux kernel</title>
<para>The Nix expressions to build the Linux kernel are in <link <para>
xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/os-specific/linux/kernel"><filename>pkgs/os-specific/linux/kernel</filename></link>.</para> The Nix expressions to build the Linux kernel are in
<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>The function that builds the kernel has an argument <para>
<varname>kernelPatches</varname> which should be a list of The function that builds the kernel has an argument
<literal>{name, patch, extraConfig}</literal> attribute sets, where <varname>kernelPatches</varname> which should be a list of <literal>{name,
<varname>name</varname> is the name of the patch (which is included in patch, extraConfig}</literal> attribute sets, where <varname>name</varname>
the kernel’s <varname>meta.description</varname> attribute), is the name of the patch (which is included in the kernel’s
<varname>patch</varname> is the patch itself (possibly compressed), <varname>meta.description</varname> attribute), <varname>patch</varname> is
and <varname>extraConfig</varname> (optional) is a string specifying the patch itself (possibly compressed), and <varname>extraConfig</varname>
extra options to be concatenated to the kernel configuration file (optional) is a string specifying extra options to be concatenated to the
(<filename>.config</filename>).</para> kernel configuration file (<filename>.config</filename>).
</para>
<para>The kernel derivation exports an attribute <para>
<varname>features</varname> specifying whether optional functionality The kernel derivation exports an attribute <varname>features</varname>
is or isn’t enabled. This is used in NixOS to implement specifying whether optional functionality is or isn’t enabled. This is
kernel-specific behaviour. For instance, if the kernel has the used in NixOS to implement kernel-specific behaviour. For instance, if the
<varname>iwlwifi</varname> feature (i.e. has built-in support for kernel has the <varname>iwlwifi</varname> feature (i.e. has built-in support
Intel wireless chipsets), then NixOS doesn’t have to build the for Intel wireless chipsets), then NixOS doesn’t have to build the
external <varname>iwlwifi</varname> package: 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
++ ...; ++ ...;
</programlisting> </programlisting>
</para> </para>
<para>How to add a new (major) version of the Linux kernel to Nixpkgs: <para>
How to add a new (major) version of the Linux kernel to Nixpkgs:
<orderedlist> <orderedlist>
<listitem> <listitem>
<para>Copy the old Nix expression <para>
(e.g. <filename>linux-2.6.21.nix</filename>) to the new one Copy the old Nix expression (e.g. <filename>linux-2.6.21.nix</filename>)
(e.g. <filename>linux-2.6.22.nix</filename>) and update it.</para> to the new one (e.g. <filename>linux-2.6.22.nix</filename>) and update
it.
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Add the new kernel to <filename>all-packages.nix</filename> <para>
(e.g., create an attribute Add the new kernel to <filename>all-packages.nix</filename> (e.g., create
<varname>kernel_2_6_22</varname>).</para> an attribute <varname>kernel_2_6_22</varname>).
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Now we’re going to update the kernel configuration. First <para>
unpack the kernel. Then for each supported platform Now we’re going to update the kernel configuration. First unpack the
(<literal>i686</literal>, <literal>x86_64</literal>, kernel. Then for each supported platform (<literal>i686</literal>,
<literal>uml</literal>) do the following: <literal>x86_64</literal>, <literal>uml</literal>) do the following:
<orderedlist> <orderedlist>
<listitem> <listitem>
<para>Make an copy from the old <para>
config (e.g. <filename>config-2.6.21-i686-smp</filename>) to Make an copy from the old config (e.g.
the new one <filename>config-2.6.21-i686-smp</filename>) to the new one (e.g.
(e.g. <filename>config-2.6.22-i686-smp</filename>).</para> <filename>config-2.6.22-i686-smp</filename>).
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Copy the config file for this platform <para>
(e.g. <filename>config-2.6.22-i686-smp</filename>) to 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</filename> in the kernel source tree.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para>Run <literal>make oldconfig <para>
ARCH=<replaceable>{i386,x86_64,um}</replaceable></literal> Run <literal>make oldconfig
and answer all questions. (For the uml configuration, also ARCH=<replaceable>{i386,x86_64,um}</replaceable></literal> and answer
add <literal>SHELL=bash</literal>.) Make sure to keep the all questions. (For the uml configuration, also add
configuration consistent between platforms (i.e. don’t <literal>SHELL=bash</literal>.) Make sure to keep the configuration
enable some feature on <literal>i686</literal> and disable consistent between platforms (i.e. don’t enable some feature on
it on <literal>x86_64</literal>). <literal>i686</literal> and disable it on <literal>x86_64</literal>).
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para>If needed you can also run <literal>make <para>
menuconfig</literal>: If needed you can also run <literal>make menuconfig</literal>:
<screen> <screen>
$ nix-env -i ncurses $ nix-env -i ncurses
$ export NIX_CFLAGS_LINK=-lncurses $ export NIX_CFLAGS_LINK=-lncurses
$ make menuconfig ARCH=<replaceable>arch</replaceable></screen> $ make menuconfig ARCH=<replaceable>arch</replaceable></screen>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para>Copy <filename>.config</filename> over the new config <para>
file (e.g. <filename>config-2.6.22-i686-smp</filename>).</para> Copy <filename>.config</filename> over the new config file (e.g.
<filename>config-2.6.22-i686-smp</filename>).
</para>
</listitem> </listitem>
</orderedlist> </orderedlist>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para>Test building the kernel: <literal>nix-build -A <para>
kernel_2_6_22</literal>. If it compiles, ship it! For extra Test building the kernel: <literal>nix-build -A kernel_2_6_22</literal>.
credit, try booting NixOS with it.</para> If it compiles, ship it! For extra credit, try booting NixOS with it.
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>It may be that the new kernel requires updating the external <para>
kernel modules and kernel-dependent packages listed in the 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 <varname>linuxPackagesFor</varname> function in
<filename>all-packages.nix</filename> (such as the NVIDIA drivers, <filename>all-packages.nix</filename> (such as the NVIDIA drivers, AUFS,
AUFS, etc.). If the updated packages aren’t backwards compatible etc.). If the updated packages aren’t backwards compatible with older
with older kernels, you may need to keep the older versions kernels, you may need to keep the older versions around.
around.</para> </para>
</listitem> </listitem>
</orderedlist>
</orderedlist>
</para> </para>
</section> </section>
<!--============================================================--> <!--============================================================-->
<section xml:id="sec-xorg"> <section xml:id="sec-xorg">
<title>X.org</title> <title>X.org</title>
<para>The Nix expressions for the X.org packages reside in <para>
The Nix expressions for the X.org packages reside in
<filename>pkgs/servers/x11/xorg/default.nix</filename>. This file is <filename>pkgs/servers/x11/xorg/default.nix</filename>. This file is
automatically generated from lists of tarballs in an X.org release. automatically generated from lists of tarballs in an X.org release. As such
As such it should not be modified directly; rather, you should modify it should not be modified directly; rather, you should modify the lists, the
the lists, the generator script or the file generator script or the file
<filename>pkgs/servers/x11/xorg/overrides.nix</filename>, in which you <filename>pkgs/servers/x11/xorg/overrides.nix</filename>, in which you can
can override or add to the derivations produced by the override or add to the derivations produced by the generator.
generator.</para> </para>
<para>The generator is invoked as follows:
<para>
The generator is invoked as follows:
<screen> <screen>
$ cd pkgs/servers/x11/xorg $ cd pkgs/servers/x11/xorg
$ cat tarballs-7.5.list extra.list old.list \ $ 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
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>
For each of the tarballs in the <filename>.list</filename> files, the <para>
script downloads it, unpacks it, and searches its A file like <filename>tarballs-7.5.list</filename> contains all tarballs in
<filename>configure.ac</filename> and <filename>*.pc.in</filename> a X.org release. It can be generated like this:
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>A file like <filename>tarballs-7.5.list</filename> contains all
tarballs in a X.org release. It can be generated like this:
<screen> <screen>
$ export i="mirror://xorg/X11R7.4/src/everything/" $ export i="mirror://xorg/X11R7.4/src/everything/"
$ cat $(PRINT_PATH=1 nix-prefetch-url $i | tail -n 1) \ $ 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 X.org proper, but are closely related to it, such as
<literal>libxcb</literal>. <filename>old.list</filename> contains <literal>libxcb</literal>. <filename>old.list</filename> contains some
some packages that were removed from X.org, but are still needed by packages that were removed from X.org, but are still needed by some people
some people or by other packages (such as or by other packages (such as <varname>imake</varname>).
<varname>imake</varname>).</para> </para>
<para>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>.</para>
<para>
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>.
</para>
</section> </section>
<!--============================================================--> <!--============================================================-->
<!-- <!--
<section> <section>
<title>Gnome</title> <title>Gnome</title>
@ -208,21 +187,15 @@ you should modify
<para>* How to update</para> <para>* How to update</para>
</section> </section>
--> -->
<!--============================================================--> <!--============================================================-->
<!-- <!--
<section> <section>
<title>GCC</title> <title>GCC</title>
<para>…</para> <para>…</para>
</section> </section>
--> -->
<!--============================================================--> <!--============================================================-->
<section xml:id="sec-eclipse"> <section xml:id="sec-eclipse">
<title>Eclipse</title> <title>Eclipse</title>
<para> <para>
@ -231,42 +204,36 @@ you should modify
</para> </para>
<para> <para>
Nixpkgs provides a number of packages that will install Eclipse in Nixpkgs provides a number of packages that will install Eclipse in its
its various forms, these range from the bare-bones Eclipse various forms, these range from the bare-bones Eclipse Platform to the more
Platform to the more fully featured Eclipse SDK or Scala-IDE fully featured Eclipse SDK or Scala-IDE packages and multiple version are
packages and multiple version are often available. It is possible often available. It is possible to list available Eclipse packages by
to list available Eclipse packages by issuing the command: issuing the command:
<screen> <screen>
$ nix-env -f '&lt;nixpkgs&gt;' -qaP -A eclipses --description $ 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 <command>eclipse</command> command, as expected. From within Eclipse it is
Eclipse it is then possible to install plugins in the usual manner then possible to install plugins in the usual manner by either manually
by either manually specifying an Eclipse update site or by specifying an Eclipse update site or by installing the Marketplace Client
installing the Marketplace Client plugin and using it to discover plugin and using it to discover and install other plugins. This installation
and install other plugins. This installation method provides an method provides an Eclipse installation that closely resemble a manually
Eclipse installation that closely resemble a manually installed installed Eclipse.
Eclipse.
</para> </para>
<para> <para>
If you prefer to install plugins in a more declarative manner then If you prefer to install plugins in a more declarative manner then Nixpkgs
Nixpkgs also offer a number of Eclipse plugins that can be also offer a number of Eclipse plugins that can be installed in an
installed in an <emphasis>Eclipse environment</emphasis>. This <emphasis>Eclipse environment</emphasis>. This type of environment is
type of environment is created using the function created using the function <varname>eclipseWithPlugins</varname> found
<varname>eclipseWithPlugins</varname> found inside the inside the <varname>nixpkgs.eclipses</varname> attribute set. This function
<varname>nixpkgs.eclipses</varname> attribute set. This function takes as argument <literal>{ eclipse, plugins ? [], jvmArgs ? [] }</literal>
takes as argument <literal>{ eclipse, plugins ? [], jvmArgs ? [] where <varname>eclipse</varname> is a one of the Eclipse packages described
}</literal> where <varname>eclipse</varname> is a one of the above, <varname>plugins</varname> is a list of plugin derivations, and
Eclipse packages described above, <varname>plugins</varname> is a <varname>jvmArgs</varname> is a list of arguments given to the JVM running
list of plugin derivations, and <varname>jvmArgs</varname> is a the Eclipse. For example, say you wish to install the latest Eclipse
list of arguments given to the JVM running the Eclipse. For Platform with the popular Eclipse Color Theme plugin and also allow Eclipse
example, say you wish to install the latest Eclipse Platform with to use more RAM. You could then add
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 {
@ -276,42 +243,38 @@ packageOverrides = pkgs: {
}; };
} }
</screen> </screen>
to your Nixpkgs configuration to your Nixpkgs configuration
(<filename>~/.config/nixpkgs/config.nix</filename>) and install it by (<filename>~/.config/nixpkgs/config.nix</filename>) and install it by
running <command>nix-env -f '&lt;nixpkgs&gt;' -iA running <command>nix-env -f '&lt;nixpkgs&gt;' -iA myEclipse</command> and
myEclipse</command> and afterward run Eclipse as usual. It is afterward run Eclipse as usual. It is possible to find out which plugins are
possible to find out which plugins are available for installation available for installation using <varname>eclipseWithPlugins</varname> by
using <varname>eclipseWithPlugins</varname> by running running
<screen> <screen>
$ nix-env -f '&lt;nixpkgs&gt;' -qaP -A eclipses.plugins --description $ 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 If there is a need to install plugins that are not available in Nixpkgs then
Nixpkgs then it may be possible to define these plugins outside it may be possible to define these plugins outside Nixpkgs using the
Nixpkgs using the <varname>buildEclipseUpdateSite</varname> and <varname>buildEclipseUpdateSite</varname> and
<varname>buildEclipsePlugin</varname> functions found in the <varname>buildEclipsePlugin</varname> functions found in the
<varname>nixpkgs.eclipses.plugins</varname> attribute set. Use the <varname>nixpkgs.eclipses.plugins</varname> attribute set. Use the
<varname>buildEclipseUpdateSite</varname> function to install a <varname>buildEclipseUpdateSite</varname> function to install a plugin
plugin distributed as an Eclipse update site. This function takes distributed as an Eclipse update site. This function takes <literal>{ name,
<literal>{ name, src }</literal> as argument where src }</literal> as argument where <literal>src</literal> indicates the
<literal>src</literal> indicates the Eclipse update site archive. Eclipse update site archive. All Eclipse features and plugins within the
All Eclipse features and plugins within the downloaded update site downloaded update site will be installed. When an update site archive is not
will be installed. When an update site archive is not available available then the <varname>buildEclipsePlugin</varname> function can be
then the <varname>buildEclipsePlugin</varname> function can be used to install a plugin that consists of a pair of feature and plugin JARs.
used to install a plugin that consists of a pair of feature and This function takes an argument <literal>{ name, srcFeature, srcPlugin
plugin JARs. This function takes an argument <literal>{ name, }</literal> where <literal>srcFeature</literal> and
srcFeature, srcPlugin }</literal> where <literal>srcPlugin</literal> are the feature and plugin JARs, respectively.
<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 Expanding the previous example with two plugins using the above functions we
functions we have have
<screen> <screen>
packageOverrides = pkgs: { packageOverrides = pkgs: {
myEclipse = with pkgs.eclipses; eclipseWithPlugins { myEclipse = with pkgs.eclipses; eclipseWithPlugins {
@ -343,18 +306,15 @@ packageOverrides = pkgs: {
} }
</screen> </screen>
</para> </para>
</section> </section>
<section xml:id="sec-elm"> <section xml:id="sec-elm">
<title>Elm</title> <title>Elm</title>
<para> <para>
The Nix expressions for Elm reside in The Nix expressions for Elm reside in
<filename>pkgs/development/compilers/elm</filename>. They are generated <filename>pkgs/development/compilers/elm</filename>. They are generated
automatically by <command>update-elm.rb</command> script. One should automatically by <command>update-elm.rb</command> script. One should specify
specify versions of Elm packages inside the script, clear the versions of Elm packages inside the script, clear the
<filename>packages</filename> directory and run the script from inside it. <filename>packages</filename> directory and run the script from inside it.
<literal>elm-reactor</literal> is special because it also has Elm package <literal>elm-reactor</literal> is special because it also has Elm package
dependencies. The process is not automated very much for now -- you should dependencies. The process is not automated very much for now -- you should
@ -363,22 +323,16 @@ get the <literal>elm-reactor</literal> source tree (e.g. with
it. Place the resulting <filename>package.nix</filename> file into it. Place the resulting <filename>package.nix</filename> file into
<filename>packages/elm-reactor-elm.nix</filename>. <filename>packages/elm-reactor-elm.nix</filename>.
</para> </para>
</section> </section>
<section xml:id="sec-shell-helpers"> <section xml:id="sec-shell-helpers">
<title>Interactive shell helpers</title> <title>Interactive shell helpers</title>
<para> <para>
Some packages provide the shell integration to be more useful. But Some packages provide the shell integration to be more useful. But unlike
unlike other systems, nix doesn't have a standard share directory other systems, nix doesn't have a standard share directory location. This is
location. This is why a bunch <command>PACKAGE-share</command> why a bunch <command>PACKAGE-share</command> scripts are shipped that print
scripts are shipped that print the location of the corresponding the location of the corresponding shared folder. Current list of such
shared folder. packages is as following:
Current list of such packages is as following:
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
@ -391,58 +345,66 @@ it. Place the resulting <filename>package.nix</filename> file into
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
E.g. <literal>autojump</literal> can then used in the .bashrc like this: E.g. <literal>autojump</literal> can then used in the .bashrc like this:
<screen> <screen>
source "$(autojump-share)/autojump.bash" source "$(autojump-share)/autojump.bash"
</screen> </screen>
</para> </para>
</section> </section>
<section xml:id="sec-steam"> <section xml:id="sec-steam">
<title>Steam</title> <title>Steam</title>
<section xml:id="sec-steam-nix"> <section xml:id="sec-steam-nix">
<title>Steam in Nix</title> <title>Steam in Nix</title>
<para> <para>
Steam is distributed as a <filename>.deb</filename> file, for now only Steam is distributed as a <filename>.deb</filename> file, for now only as
as an i686 package (the amd64 package only has documentation). an i686 package (the amd64 package only has documentation). When unpacked,
When unpacked, it has a script called <filename>steam</filename> that it has a script called <filename>steam</filename> that in ubuntu (their
in ubuntu (their target distro) would go to <filename>/usr/bin target distro) would go to <filename>/usr/bin </filename>. When run for the
</filename>. When run for the first time, this script copies some first time, this script copies some files to the user's home, which include
files to the user's home, which include another script that is the another script that is the ultimate responsible for launching the steam
ultimate responsible for launching the steam binary, which is also binary, which is also in $HOME.
in $HOME.
</para> </para>
<para> <para>
Nix problems and constraints: Nix problems and constraints:
<itemizedlist> <itemizedlist>
<listitem><para>We don't have <filename>/bin/bash</filename> and many <listitem>
scripts point there. Similarly for <filename>/usr/bin/python</filename> <para>
.</para></listitem> We don't have <filename>/bin/bash</filename> and many scripts point
<listitem><para>We don't have the dynamic loader in <filename>/lib there. Similarly for <filename>/usr/bin/python</filename> .
</filename>.</para></listitem> </para>
<listitem><para>The <filename>steam.sh</filename> script in $HOME can </listitem>
not be patched, as it is checked and rewritten by steam.</para></listitem> <listitem>
<listitem><para>The steam binary cannot be patched, it's also checked.</para></listitem> <para>
We don't have the dynamic loader in <filename>/lib </filename>.
</para>
</listitem>
<listitem>
<para>
The <filename>steam.sh</filename> script in $HOME can not be patched, as
it is checked and rewritten by steam.
</para>
</listitem>
<listitem>
<para>
The steam binary cannot be patched, it's also checked.
</para>
</listitem>
</itemizedlist> </itemizedlist>
</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 chroot environment, as documented
<link xlink:href="http://sandervanderburg.blogspot.nl/2013/09/composing-fhs-compatible-chroot.html">here</link>. <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, This allows us to have binaries in the expected paths without disrupting
and to avoid patching them to work in a non FHS environment. the system, and to avoid patching them to work in a non FHS environment.
</para> </para>
</section> </section>
<section xml:id="sec-steam-play"> <section xml:id="sec-steam-play">
<title>How to play</title> <title>How to play</title>
<para> <para>
@ -458,64 +420,74 @@ it. Place the resulting <filename>package.nix</filename> file into
'';</programlisting> '';</programlisting>
to your configuration. to your configuration.
</para> </para>
</section> </section>
<section xml:id="sec-steam-troub"> <section xml:id="sec-steam-troub">
<title>Troubleshooting</title> <title>Troubleshooting</title>
<para> <para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term>Steam fails to start. What do I do?</term> <term>Steam fails to start. What do I do?</term>
<listitem><para>Try to run <listitem>
<para>
Try to run
<programlisting>strace steam</programlisting> <programlisting>strace steam</programlisting>
to see what is causing steam to fail.</para></listitem> to see what is causing steam to fail.
</para>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>Using the FOSS Radeon or nouveau (nvidia) drivers</term> <term>Using the FOSS Radeon or nouveau (nvidia) drivers</term>
<listitem><itemizedlist> <listitem>
<listitem><para>The <literal>newStdcpp</literal> parameter <itemizedlist>
was removed since NixOS 17.09 and should not be needed anymore. <listitem>
</para></listitem> <para>
The <literal>newStdcpp</literal> parameter was removed since NixOS
<listitem><para> 17.09 and should not be needed anymore.
</para>
</listitem>
<listitem>
<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. conflics with the one dynamically loaded by radeonsi_dri.so. If you
If you get the error 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 <link xlink:href="https://github.com/NixOS/nixpkgs/pull/20269">this pull request</link>. have a look at
</para></listitem> <link xlink:href="https://github.com/NixOS/nixpkgs/pull/20269">this
pull request</link>.
</itemizedlist></listitem></varlistentry> </para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term>Java</term> <term>Java</term>
<listitem><orderedlist> <listitem>
<listitem><para> <orderedlist>
There is no java in steam chrootenv by default. If you get a message like <listitem>
<para>
There is no java in steam chrootenv by default. If you get a message
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>
to your configuration. to your configuration.
</para></listitem> </para>
</orderedlist></listitem></varlistentry> </listitem>
</orderedlist>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</para> </para>
</section> </section>
<section xml:id="sec-steam-run"> <section xml:id="sec-steam-run">
<title>steam-run</title> <title>steam-run</title>
<para> <para>
The FHS-compatible chroot used for steam can also be used to run The FHS-compatible chroot used for steam can also be used to run other
other linux games that expect a FHS environment. linux games that expect a FHS environment. To do it, add
To do it, add
<programlisting>pkgs.(steam.override { <programlisting>pkgs.(steam.override {
nativeOnly = true; nativeOnly = true;
newStdcpp = true; newStdcpp = true;
@ -523,24 +495,19 @@ To do it, add
to your configuration, rebuild, and run the game with to your configuration, rebuild, and run the game with
<programlisting>steam-run ./foo</programlisting> <programlisting>steam-run ./foo</programlisting>
</para> </para>
</section> </section>
</section> </section>
<section xml:id="sec-emacs"> <section xml:id="sec-emacs">
<title>Emacs</title> <title>Emacs</title>
<section xml:id="sec-emacs-config"> <section xml:id="sec-emacs-config">
<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 configure. <varname>emacsWithPackages</varname> allows you to manage
packages from ELPA. This means that you will not have to install packages from ELPA. This means that you will not have to install that
that packages from within Emacs. For instance, if you wanted to use packages from within Emacs. For instance, if you wanted to use
<literal>company</literal>, <literal>counsel</literal>, <literal>company</literal>, <literal>counsel</literal>,
<literal>flycheck</literal>, <literal>ivy</literal>, <literal>flycheck</literal>, <literal>ivy</literal>,
<literal>magit</literal>, <literal>projectile</literal>, and <literal>magit</literal>, <literal>projectile</literal>, and
@ -566,14 +533,14 @@ to your configuration, rebuild, and run the game with
<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. myEmacs</command>. However, this will only install those packages. It will
It will not <literal>configure</literal> them for us. To do this, we not <literal>configure</literal> them for us. To do this, we need to
need to provide a configuration file. Luckily, it is possible to do provide a configuration file. Luckily, it is possible to do this from
this from within Nix! By modifying the above example, we can make within Nix! By modifying the above example, we can make Emacs load a custom
Emacs load a custom config file. The key is to create a package that config file. The key is to create a package that provide a
provide a <filename>default.el</filename> file in <filename>default.el</filename> file in
<filename>/share/emacs/site-start/</filename>. Emacs knows to load <filename>/share/emacs/site-start/</filename>. Emacs knows to load this
this file automatically when it starts. file automatically when it starts.
</para> </para>
<screen> <screen>
@ -655,23 +622,22 @@ 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 This provides a fairly full Emacs start file. It will load in addition to
addition to the user's presonal config. You can always disable it by the user's presonal config. You can always disable it by passing
passing <command>-q</command> to the Emacs command. <command>-q</command> to the Emacs command.
</para> </para>
<para> <para>
Sometimes <varname>emacsWithPackages</varname> is not enough, as Sometimes <varname>emacsWithPackages</varname> is not enough, as this
this package set has some priorities imposed on packages (with package set has some priorities imposed on packages (with the lowest
the lowest priority assigned to Melpa Unstable, and the highest for priority assigned to Melpa Unstable, and the highest for packages manually
packages manually defined in defined in <filename>pkgs/top-level/emacs-packages.nix</filename>). But you
<filename>pkgs/top-level/emacs-packages.nix</filename>). But you
can't control this priorities when some package is installed as a can't control this priorities when some package is installed as a
dependency. You can override it on per-package-basis, providing all dependency. You can override it on per-package-basis, providing all the
the required dependencies manually - but it's tedious and there is required dependencies manually - but it's tedious and there is always a
always a possibility that an unwanted dependency will sneak in possibility that an unwanted dependency will sneak in through some other
through some other package. To completely override such a package package. To completely override such a package you can use
you can use <varname>overrideScope</varname>. <varname>overrideScope</varname>.
</para> </para>
<screen> <screen>
@ -685,13 +651,11 @@ overrides = super: self: rec {
dante dante
]) ])
</screen> </screen>
</section> </section>
</section> </section>
<section xml:id="sec-weechat"> <section xml:id="sec-weechat">
<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 closure size from the default configuration which includes all available
@ -702,17 +666,19 @@ overrides its configuration such as
} }
}</programlisting> }</programlisting>
</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>perl</literal>, <literal>ruby</literal>, <literal>guile</literal>,
<literal>tcl</literal> and <literal>lua</literal>. <literal>tcl</literal> and <literal>lua</literal>.
</para> </para>
<para> <para>
The python plugin allows the addition of extra libraries. For instance, The python plugin allows the addition of extra libraries. For instance, the
the <literal>inotify.py</literal> script in weechat-scripts requires <literal>inotify.py</literal> script in weechat-scripts requires D-Bus or
D-Bus or libnotify, and the <literal>fish.py</literal> script requires libnotify, and the <literal>fish.py</literal> script requires pycrypto. To
pycrypto. To use these scripts, use the <literal>python</literal> use these scripts, use the <literal>python</literal> plugin's
plugin's <literal>withPackages</literal> attribute: <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 ]))
@ -721,6 +687,7 @@ plugin's <literal>withPackages</literal> attribute:
} }
</programlisting> </programlisting>
</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:

56
doc/platform-notes.xml
View File

@ -1,26 +1,24 @@
<chapter xmlns="http://docbook.org/ns/docbook" <chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"
xml:id="chap-platform-nodes"> xml:id="chap-platform-nodes">
<title>Platform Notes</title> <title>Platform Notes</title>
<section xml:id="sec-darwin"> <section xml:id="sec-darwin">
<title>Darwin (macOS)</title> <title>Darwin (macOS)</title>
<para>Some common issues when packaging software for darwin:</para>
<itemizedlist>
<listitem>
<para> <para>
The darwin <literal>stdenv</literal> uses clang instead of gcc. Some common issues when packaging software for darwin:
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.
</para> </para>
<itemizedlist>
<listitem>
<para>
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.
</para>
<programlisting> <programlisting>
stdenv.mkDerivation { stdenv.mkDerivation {
name = "libfoo-1.2.3"; name = "libfoo-1.2.3";
@ -31,17 +29,15 @@
} }
</programlisting> </programlisting>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
On darwin libraries are linked using absolute paths, libraries On darwin libraries are linked using absolute paths, libraries are
are resolved by their <literal>install_name</literal> at link resolved by their <literal>install_name</literal> at link time. Sometimes
time. Sometimes packages won't set this correctly causing the packages won't set this correctly causing the library lookups to fail at
library lookups to fail at runtime. This can be fixed by adding runtime. This can be fixed by adding extra linker flags or by running
extra linker flags or by running <command>install_name_tool -id</command> <command>install_name_tool -id</command> during the
during the <function>fixupPhase</function>. <function>fixupPhase</function>.
</para> </para>
<programlisting> <programlisting>
stdenv.mkDerivation { stdenv.mkDerivation {
name = "libfoo-1.2.3"; name = "libfoo-1.2.3";
@ -50,15 +46,14 @@
} }
</programlisting> </programlisting>
</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. to resolve build tools like <command>clang</command>, etc. This causes
This causes errors like <code>xcode-select: error: no developer tools were found at '/Applications/Xcode.app'</code> errors like <code>xcode-select: error: no developer tools were found at
while the build doesn't actually depend on xcode. '/Applications/Xcode.app'</code> while the build doesn't actually depend
on xcode.
</para> </para>
<programlisting> <programlisting>
stdenv.mkDerivation { stdenv.mkDerivation {
name = "libfoo-1.2.3"; name = "libfoo-1.2.3";
@ -69,15 +64,12 @@
''; '';
} }
</programlisting> </programlisting>
<para> <para>
The package <literal>xcbuild</literal> can be used to build projects The package <literal>xcbuild</literal> can be used to build projects that
that really depend on Xcode, however projects that build some kind of really depend on Xcode, however projects that build some kind of graphical
graphical interface won't work without using Xcode in an impure way. interface won't work without using Xcode in an impure way.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</section> </section>
</chapter> </chapter>

280
doc/quick-start.xml
View File

@ -1,223 +1,219 @@
<chapter xmlns="http://docbook.org/ns/docbook" <chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"
xml:id="chap-quick-start"> xml:id="chap-quick-start">
<title>Quick Start to Adding a Package</title> <title>Quick Start to Adding a Package</title>
<para>
<para>To add a package to Nixpkgs: To add a package to Nixpkgs:
<orderedlist> <orderedlist>
<listitem> <listitem>
<para>Checkout the Nixpkgs source tree: <para>
Checkout the Nixpkgs source tree:
<screen> <screen>
$ git clone git://github.com/NixOS/nixpkgs.git $ git clone git://github.com/NixOS/nixpkgs.git
$ cd nixpkgs</screen> $ cd nixpkgs</screen>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para>Find a good place in the Nixpkgs tree to add the Nix <para>
expression for your package. For instance, a library package Find a good place in the Nixpkgs tree to add the Nix expression for your
typically goes into package. For instance, a library package typically goes into
<filename>pkgs/development/libraries/<replaceable>pkgname</replaceable></filename>, <filename>pkgs/development/libraries/<replaceable>pkgname</replaceable></filename>,
while a web browser goes into while a web browser goes into
<filename>pkgs/applications/networking/browsers/<replaceable>pkgname</replaceable></filename>. <filename>pkgs/applications/networking/browsers/<replaceable>pkgname</replaceable></filename>.
See <xref linkend="sec-organisation" /> for some hints on the tree See <xref linkend="sec-organisation" /> for some hints on the tree
organisation. Create a directory for your package, e.g. organisation. Create a directory for your package, e.g.
<screen> <screen>
$ mkdir pkgs/development/libraries/libfoo</screen> $ mkdir pkgs/development/libraries/libfoo</screen>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para>In the package directory, create a Nix expression — a piece <para>
of code that describes how to build the package. In this case, it In the package directory, create a Nix expression — a piece of code that
should be a <emphasis>function</emphasis> that is called with the describes how to build the package. In this case, it should be a
package dependencies as arguments, and returns a build of the <emphasis>function</emphasis> that is called with the package dependencies
package in the Nix store. The expression should usually be called as arguments, and returns a build of the package in the Nix store. The
<filename>default.nix</filename>. expression should usually be called <filename>default.nix</filename>.
<screen> <screen>
$ emacs pkgs/development/libraries/libfoo/default.nix $ emacs pkgs/development/libraries/libfoo/default.nix
$ git add pkgs/development/libraries/libfoo/default.nix</screen> $ 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 <filename>pkgs/</filename> to see how it’s done. Here are some good
good ones: ones:
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>GNU Hello: <link <para>
GNU Hello:
<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>. 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> Trivial package, which specifies some <varname>meta</varname>
attributes which is good practice.</para> attributes which is good practice.
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>GNU cpio: <link <para>
GNU cpio:
<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>. 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 Also a simple package. The generic builder in <varname>stdenv</varname>
<varname>stdenv</varname> does everything for you. It has does everything for you. It has no dependencies beyond
no dependencies beyond <varname>stdenv</varname>.</para> <varname>stdenv</varname>.
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>GNU Multiple Precision arithmetic library (GMP): <link <para>
GNU Multiple Precision arithmetic library (GMP):
<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>. 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 Also done by the generic builder, but has a dependency on
<varname>m4</varname>.</para> <varname>m4</varname>.
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Pan, a GTK-based newsreader: <link <para>
Pan, a GTK-based newsreader:
<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>. 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>, Has an optional dependency on <varname>gtkspell</varname>, which is
which is only built if <varname>spellCheck</varname> is only built if <varname>spellCheck</varname> is <literal>true</literal>.
<literal>true</literal>.</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para>Apache HTTPD: <link <para>
Apache HTTPD:
<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>. 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 A bunch of optional features, variable substitutions in the configure
configure flags, a post-install hook, and miscellaneous flags, a post-install hook, and miscellaneous hackery.
hackery.</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para>Thunderbird: <link <para>
Thunderbird:
<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>. 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> Lots of dependencies.
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>JDiskReport, a Java utility: <link <para>
JDiskReport, a Java utility:
<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/default.nix"><filename>pkgs/tools/misc/jdiskreport/default.nix</filename></link>
(and the <link (and the
<link
xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/jdiskreport/builder.sh">builder</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 Nixpkgs doesn’t have a decent <varname>stdenv</varname> for Java yet
Java yet so this is pretty ad-hoc.</para> so this is pretty ad-hoc.
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>XML::Simple, a Perl module: <link <para>
XML::Simple, a Perl module:
<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> 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). (search for the <varname>XMLSimple</varname> attribute). Most Perl
Most Perl modules are so simple to build that they are modules are so simple to build that they are defined directly in
defined directly in <filename>perl-packages.nix</filename>; <filename>perl-packages.nix</filename>; no need to make a separate file
no need to make a separate file for them.</para> for them.
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Adobe Reader: <link <para>
Adobe Reader:
<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/default.nix"><filename>pkgs/applications/misc/adobe-reader/default.nix</filename></link>.
Shows how binary-only packages can be supported. In Shows how binary-only packages can be supported. In particular the
particular the <link <link
xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/misc/adobe-reader/builder.sh">builder</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 uses <command>patchelf</command> to set the RUNPATH and ELF interpreter
interpreter of the executables so that the right libraries of the executables so that the right libraries are found at runtime.
are found at runtime.</para>
</listitem>
</itemizedlist>
</para> </para>
</listitem>
<para>Some notes: </itemizedlist>
</para>
<para>
Some notes:
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>All <varname linkend="chap-meta">meta</varname> <para>
attributes are optional, but it’s still a good idea to All <varname linkend="chap-meta">meta</varname> attributes are
provide at least the <varname>description</varname>, optional, but it’s still a good idea to provide at least the
<varname>homepage</varname> and <varname <varname>description</varname>, <varname>homepage</varname> and
linkend="sec-meta-license">license</varname>.</para> <varname
</listitem> linkend="sec-meta-license">license</varname>.
<listitem>
<para>You can use <command>nix-prefetch-url</command> (or similar nix-prefetch-git, etc)
<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>
</listitem>
<listitem>
<para>A list of schemes for <literal>mirror://</literal>
URLs can be found in <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>
</listitem>
</itemizedlist>
</para> </para>
<para>The exact syntax and semantics of the Nix expression
language, including the built-in function, are described in the
Nix manual in the <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>
</listitem> </listitem>
<listitem> <listitem>
<para>Add a call to the function defined in the previous step to <para>
You can use <command>nix-prefetch-url</command> (or similar
nix-prefetch-git, etc) <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>
</listitem>
<listitem>
<para>
A list of schemes for <literal>mirror://</literal> URLs can be found in
<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>
</listitem>
</itemizedlist>
</para>
<para>
The exact syntax and semantics of the Nix expression language, including
the built-in function, are described in the Nix manual in the
<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>
</listitem>
<listitem>
<para>
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> 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, with some descriptive name for the variable, e.g.
e.g. <varname>libfoo</varname>. <varname>libfoo</varname>.
<screen> <screen>
$ emacs pkgs/top-level/all-packages.nix</screen> $ emacs pkgs/top-level/all-packages.nix</screen>
</para> </para>
<para>
<para>The attributes in that file are sorted by category (like The attributes in that file are sorted by category (like “Development /
“Development / Libraries”) that more-or-less correspond to the Libraries”) that more-or-less correspond to the directory structure of
directory structure of Nixpkgs, and then by attribute name.</para> Nixpkgs, and then by attribute name.
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>To test whether the package builds, run the following command <para>
from the root of the nixpkgs source tree: To test whether the package builds, run the following command from the
root of the nixpkgs source tree:
<screen> <screen>
$ nix-build -A libfoo</screen> $ 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 previous step. You may want to add the flag <option>-K</option> to keep
defined in the previous step. You may want to add the flag the temporary build directory in case something fails. If the build
<option>-K</option> to keep the temporary build directory in case succeeds, a symlink <filename>./result</filename> to the package in the
something fails. If the build succeeds, a symlink Nix store is created.
<filename>./result</filename> to the package in the Nix store is </para>
created.</para>
</listitem> </listitem>
<listitem> <listitem>
<para>If you want to install the package into your profile <para>
(optional), do If you want to install the package into your profile (optional), do
<screen> <screen>
$ nix-env -f . -iA libfoo</screen> $ nix-env -f . -iA libfoo</screen>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para>Optionally commit the new package and open a pull request, or send a patch to <para>
<literal>https://groups.google.com/forum/#!forum/nix-devel</literal>.</para> Optionally commit the new package and open a pull request, or send a patch
</listitem> to <literal>https://groups.google.com/forum/#!forum/nix-devel</literal>.
</para>
</listitem>
</orderedlist> </orderedlist>
</para> </para>
</chapter> </chapter>

1229
doc/release-notes.xml
View File

File diff suppressed because it is too large Load Diff

597
doc/reviewing-contributions.xml
View File

@ -3,93 +3,146 @@
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
version="5.0" version="5.0"
xml:id="sec-reviewing-contributions"> xml:id="sec-reviewing-contributions">
<title>Reviewing contributions</title> <title>Reviewing contributions</title>
<warning> <warning>
<para>The following section is a draft and reviewing policy is still being <para>
discussed.</para> The following section is a draft and reviewing policy is still being
discussed.
</para>
</warning> </warning>
<para>
<para>The nixpkgs projects receives a fairly high number of contributions via The nixpkgs projects receives a fairly high number of contributions via
GitHub pull-requests. Reviewing and approving these is an important task and a GitHub pull-requests. Reviewing and approving these is an important task and
way to contribute to the project.</para> a way to contribute to the project.
</para>
<para>The high change rate of nixpkgs make any pull request that is open for <para>
long enough subject to conflicts that will require extra work from the The high change rate of nixpkgs make any pull request that is open for long
submitter or the merger. Reviewing pull requests in a timely manner and being enough 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 these. GitHub provides sort responsive to the comments is the key to avoid these. GitHub provides sort
filters that can be used to see the <link 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 xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc">most
recently</link> and the <link recently</link> and the
<link
xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-asc">least xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-asc">least
recently</link> updated pull-requests. recently</link> updated pull-requests. We highly encourage looking at
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"> <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> this list of ready to merge, unreviewed pull requests</link>.
</para>
<para>When reviewing a pull request, please always be nice and polite. <para>
When reviewing a pull request, please always be nice and polite.
Controversial changes can lead to controversial opinions, but it is important Controversial changes can lead to controversial opinions, but it is important
to respect every community members and their work.</para> to respect every community members and their work.
</para>
<para>GitHub provides reactions, they are a simple and quick way to provide <para>
GitHub provides reactions, they are a simple and quick way to provide
feedback to pull-requests or any comments. The thumb-down reaction should be feedback to pull-requests or any comments. The thumb-down reaction should be
used with care and if possible accompanied with some explanations so the used with care and if possible accompanied with some explanations so the
submitter has directions to improve his contribution.</para> submitter has directions to improve his contribution.
</para>
<para>Pull-requests reviews should include a list of what has been reviewed in a <para>
comment, so other reviewers and mergers can know the state of the Pull-requests reviews should include a list of what has been reviewed in a
review.</para> comment, so other reviewers and mergers can know the state of the review.
</para>
<para>All the review template samples provided in this section are generic and <para>
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 meant as examples. Their usage is optional and the reviewer is free to adapt
them to his liking.</para> them to his liking.
</para>
<section>
<title>Package updates</title>
<section><title>Package updates</title> <para>
A package update is the most trivial and common type of pull-request. These
pull-requests mainly consist in updating the version part of the package
name and the source hash.
</para>
<para>A package update is the most trivial and common type of pull-request. <para>
These pull-requests mainly consist in updating the version part of the package It can happen that non trivial updates include patches or more complex
name and the source hash.</para> changes.
<para>It can happen that non trivial updates include patches or more complex </para>
changes.</para>
<para>Reviewing process:</para> <para>
Reviewing process:
</para>
<itemizedlist> <itemizedlist>
<listitem><para>Add labels to the pull-request. (Requires commit <listitem>
rights)</para> <para>
Add labels to the pull-request. (Requires commit rights)
</para>
<itemizedlist> <itemizedlist>
<listitem><para><literal>8.has: package (update)</literal> and any topic <listitem>
label that fit the updated package.</para></listitem> <para>
<literal>8.has: package (update)</literal> and any topic label that fit
the updated package.
</para>
</listitem>
</itemizedlist> </itemizedlist>
</listitem> </listitem>
<listitem><para>Ensure that the package versioning is fitting the <listitem>
guidelines.</para></listitem> <para>
<listitem><para>Ensure that the commit text is fitting the Ensure that the package versioning is fitting the guidelines.
guidelines.</para></listitem> </para>
<listitem><para>Ensure that the package maintainers are notified.</para> </listitem>
<listitem>
<para>
Ensure that the commit text is fitting the guidelines.
</para>
</listitem>
<listitem>
<para>
Ensure that the package maintainers are notified.
</para>
<itemizedlist> <itemizedlist>
<listitem><para>mention-bot usually notify GitHub users based on the <listitem>
submitted changes, but it can happen that it misses some of the <para>
package maintainers.</para></listitem> mention-bot usually notify GitHub users based on the submitted changes,
but it can happen that it misses some of the package maintainers.
</para>
</listitem>
</itemizedlist> </itemizedlist>
</listitem> </listitem>
<listitem><para>Ensure that the meta field contains correct <listitem>
information.</para> <para>
Ensure that the meta field contains correct information.
</para>
<itemizedlist> <itemizedlist>
<listitem><para>License can change with version updates, so it should be <listitem>
checked to be fitting upstream license.</para></listitem> <para>
<listitem><para>If the package has no maintainer, a maintainer must be License can change with version updates, so it should be checked to be
set. This can be the update submitter or a community member that fitting upstream license.
accepts to take maintainership of the package.</para></listitem> </para>
</listitem>
<listitem>
<para>
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.
</para>
</listitem>
</itemizedlist> </itemizedlist>
</listitem> </listitem>
<listitem><para>Ensure that the code contains no typos.</para></listitem> <listitem>
<listitem><para>Building the package locally.</para> <para>
Ensure that the code contains no typos.
</para>
</listitem>
<listitem>
<para>
Building the package locally.
</para>
<itemizedlist> <itemizedlist>
<listitem><para>Pull-requests are often targeted to the master or staging <listitem>
branch so building the pull-request locally as it is submitted can <para>
trigger a large amount of source builds.</para> Pull-requests are often targeted to the master or staging branch so
<para>It is possible to rebase the changes on nixos-unstable or building the pull-request locally as it is submitted can trigger a large
amount of source builds.
</para>
<para>
It is possible to rebase the changes on nixos-unstable or
nixpkgs-unstable for easier review by running the following commands nixpkgs-unstable for easier review by running the following commands
from a nixpkgs clone. from a nixpkgs clone.
<screen> <screen>
@ -102,41 +155,54 @@ $ git rebase --onto nixos-unstable BASEBRANCH FETCH_HEAD <co
</screen> </screen>
<calloutlist> <calloutlist>
<callout arearefs='reviewing-rebase-1'> <callout arearefs='reviewing-rebase-1'>
<para>This should be done only once to be able to fetch channel <para>
branches from the nixpkgs-channels repository.</para> This should be done only once to be able to fetch channel branches
from the nixpkgs-channels repository.
</para>
</callout> </callout>
<callout arearefs='reviewing-rebase-2'> <callout arearefs='reviewing-rebase-2'>
<para>Fetching the nixos-unstable branch.</para> <para>
Fetching the nixos-unstable branch.
</para>
</callout> </callout>
<callout arearefs='reviewing-rebase-3'> <callout arearefs='reviewing-rebase-3'>
<para>Fetching the pull-request changes, <varname>PRNUMBER</varname> <para>
is the number at the end of the pull-request title and Fetching the pull-request changes, <varname>PRNUMBER</varname> is the
<varname>BASEBRANCH</varname> the base branch of the number at the end of the pull-request title and
pull-request.</para> <varname>BASEBRANCH</varname> the base branch of the pull-request.
</para>
</callout> </callout>
<callout arearefs='reviewing-rebase-4'> <callout arearefs='reviewing-rebase-4'>
<para>Rebasing the pull-request changes to the nixos-unstable <para>
branch.</para> Rebasing the pull-request changes to the nixos-unstable branch.
</para>
</callout> </callout>
</calloutlist> </calloutlist>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para>The <link xlink:href="https://github.com/madjar/nox">nox</link> <para>
tool can be used to review a pull-request content in a single command. The <link xlink:href="https://github.com/madjar/nox">nox</link> tool can
It doesn't rebase on a channel branch so it might trigger multiple be used to review a pull-request content in a single command. It doesn't
source builds. <varname>PRNUMBER</varname> should be replaced by the rebase on a channel branch so it might trigger multiple source builds.
number at the end of the pull-request title.</para> <varname>PRNUMBER</varname> should be replaced by the number at the end
of the pull-request title.
</para>
<screen> <screen>
$ nix-shell -p nox --run "nox-review -k pr PRNUMBER" $ nix-shell -p nox --run "nox-review -k pr PRNUMBER"
</screen> </screen>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</listitem> </listitem>
<listitem><para>Running every binary.</para></listitem> <listitem>
<para>
Running every binary.
</para>
</listitem>
</itemizedlist> </itemizedlist>
<example><title>Sample template for a package update review</title> <example>
<title>Sample template for a package update review</title>
<screen> <screen>
##### Reviewed points ##### Reviewed points
@ -150,55 +216,105 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER"
##### Comments ##### Comments
</screen></example> </screen>
</example>
</section> </section>
<section>
<title>New packages</title>
<section><title>New packages</title> <para>
New packages are a common type of pull-requests. These pull requests
consists in adding a new nix-expression for a package.
</para>
<para>New packages are a common type of pull-requests. These pull requests <para>
consists in adding a new nix-expression for a package.</para> Reviewing process:
</para>
<para>Reviewing process:</para>
<itemizedlist> <itemizedlist>
<listitem><para>Add labels to the pull-request. (Requires commit <listitem>
rights)</para> <para>
Add labels to the pull-request. (Requires commit rights)
</para>
<itemizedlist> <itemizedlist>
<listitem><para><literal>8.has: package (new)</literal> and any topic <listitem>
label that fit the new package.</para></listitem> <para>
<literal>8.has: package (new)</literal> and any topic label that fit the
new package.
</para>
</listitem>
</itemizedlist> </itemizedlist>
</listitem> </listitem>
<listitem><para>Ensure that the package versioning is fitting the <listitem>
guidelines.</para></listitem> <para>
<listitem><para>Ensure that the commit name is fitting the Ensure that the package versioning is fitting the guidelines.
guidelines.</para></listitem> </para>
<listitem><para>Ensure that the meta field contains correct </listitem>
information.</para> <listitem>
<para>
Ensure that the commit name is fitting the guidelines.
</para>
</listitem>
<listitem>
<para>
Ensure that the meta field contains correct information.
</para>
<itemizedlist> <itemizedlist>
<listitem><para>License must be checked to be fitting upstream <listitem>
license.</para></listitem> <para>
<listitem><para>Platforms should be set or the package will not get binary License must be checked to be fitting upstream license.
substitutes.</para></listitem> </para>
<listitem><para>A maintainer must be set, this can be the package </listitem>
submitter or a community member that accepts to take maintainership of <listitem>
the package.</para></listitem> <para>
Platforms should be set or the package will not get binary substitutes.
</para>
</listitem>
<listitem>
<para>
A maintainer must be set, this can be the package submitter or a
community member that accepts to take maintainership of the package.
</para>
</listitem>
</itemizedlist> </itemizedlist>
</listitem> </listitem>
<listitem><para>Ensure that the code contains no typos.</para></listitem> <listitem>
<listitem><para>Ensure the package source.</para> <para>
Ensure that the code contains no typos.
</para>
</listitem>
<listitem>
<para>
Ensure the package source.
</para>
<itemizedlist> <itemizedlist>
<listitem><para>Mirrors urls should be used when <listitem>
available.</para></listitem> <para>
<listitem><para>The most appropriate function should be used (e.g. Mirrors urls should be used when available.
packages from GitHub should use </para>
<literal>fetchFromGitHub</literal>).</para></listitem> </listitem>
<listitem>
<para>
The most appropriate function should be used (e.g. packages from GitHub
should use <literal>fetchFromGitHub</literal>).
</para>
</listitem>
</itemizedlist> </itemizedlist>
</listitem> </listitem>
<listitem><para>Building the package locally.</para></listitem> <listitem>
<listitem><para>Running every binary.</para></listitem> <para>
Building the package locally.
</para>
</listitem>
<listitem>
<para>
Running every binary.
</para>
</listitem>
</itemizedlist> </itemizedlist>
<example><title>Sample template for a new package review</title> <example>
<title>Sample template for a new package review</title>
<screen> <screen>
##### Reviewed points ##### Reviewed points
@ -220,58 +336,107 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER"
##### Comments ##### Comments
</screen></example> </screen>
</example>
</section> </section>
<section>
<title>Module updates</title>
<section><title>Module updates</title> <para>
Module updates are submissions changing modules in some ways. These often
contains changes to the options or introduce new options.
</para>
<para>Module updates are submissions changing modules in some ways. These often <para>
contains changes to the options or introduce new options.</para> Reviewing process
</para>
<para>Reviewing process</para>
<itemizedlist> <itemizedlist>
<listitem><para>Add labels to the pull-request. (Requires commit <listitem>
rights)</para> <para>
Add labels to the pull-request. (Requires commit rights)
</para>
<itemizedlist> <itemizedlist>
<listitem><para><literal>8.has: module (update)</literal> and any topic <listitem>
label that fit the module.</para></listitem> <para>
<literal>8.has: module (update)</literal> and any topic label that fit
the module.
</para>
</listitem>
</itemizedlist> </itemizedlist>
</listitem> </listitem>
<listitem><para>Ensure that the module maintainers are notified.</para> <listitem>
<para>
Ensure that the module maintainers are notified.
</para>
<itemizedlist> <itemizedlist>
<listitem><para>Mention-bot notify GitHub users based on the submitted <listitem>
changes, but it can happen that it miss some of the package <para>
maintainers.</para></listitem> Mention-bot notify GitHub users based on the submitted changes, but it
can happen that it miss some of the package maintainers.
</para>
</listitem>
</itemizedlist> </itemizedlist>
</listitem> </listitem>
<listitem><para>Ensure that the module tests, if any, are <listitem>
succeeding.</para></listitem> <para>
<listitem><para>Ensure that the introduced options are correct.</para> Ensure that the module tests, if any, are succeeding.
</para>
</listitem>
<listitem>
<para>
Ensure that the introduced options are correct.
</para>
<itemizedlist> <itemizedlist>
<listitem><para>Type should be appropriate (string related types differs <listitem>
in their merging capabilities, <literal>optionSet</literal> and <para>
<literal>string</literal> types are deprecated).</para></listitem> Type should be appropriate (string related types differs in their
<listitem><para>Description, default and example should be merging capabilities, <literal>optionSet</literal> and
provided.</para></listitem> <literal>string</literal> types are deprecated).
</para>
</listitem>
<listitem>
<para>
Description, default and example should be provided.
</para>
</listitem>
</itemizedlist> </itemizedlist>
</listitem> </listitem>
<listitem><para>Ensure that option changes are backward compatible.</para> <listitem>
<para>
Ensure that option changes are backward compatible.
</para>
<itemizedlist> <itemizedlist>
<listitem><para><literal>mkRenamedOptionModule</literal> and <listitem>
<para>
<literal>mkRenamedOptionModule</literal> and
<literal>mkAliasOptionModule</literal> functions provide way to make <literal>mkAliasOptionModule</literal> functions provide way to make
option changes backward compatible.</para></listitem> option changes backward compatible.
</para>
</listitem>
</itemizedlist> </itemizedlist>
</listitem> </listitem>
<listitem><para>Ensure that removed options are declared with <listitem>
<literal>mkRemovedOptionModule</literal></para></listitem> <para>
<listitem><para>Ensure that changes that are not backward compatible are Ensure that removed options are declared with
mentioned in release notes.</para></listitem> <literal>mkRemovedOptionModule</literal>
<listitem><para>Ensure that documentations affected by the change is </para>
updated.</para></listitem> </listitem>
<listitem>
<para>
Ensure that changes that are not backward compatible are mentioned in
release notes.
</para>
</listitem>
<listitem>
<para>
Ensure that documentations affected by the change is updated.
</para>
</listitem>
</itemizedlist> </itemizedlist>
<example><title>Sample template for a module update review</title> <example>
<title>Sample template for a module update review</title>
<screen> <screen>
##### Reviewed points ##### Reviewed points
@ -288,51 +453,89 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER"
##### Comments ##### Comments
</screen></example> </screen>
</example>
</section> </section>
<section>
<title>New modules</title>
<section><title>New modules</title> <para>
New modules submissions introduce a new module to NixOS.
<para>New modules submissions introduce a new module to NixOS.</para> </para>
<itemizedlist> <itemizedlist>
<listitem><para>Add labels to the pull-request. (Requires commit <listitem>
rights)</para> <para>
Add labels to the pull-request. (Requires commit rights)
</para>
<itemizedlist> <itemizedlist>
<listitem><para><literal>8.has: module (new)</literal> and any topic label <listitem>
that fit the module.</para></listitem> <para>
<literal>8.has: module (new)</literal> and any topic label that fit the
module.
</para>
</listitem>
</itemizedlist> </itemizedlist>
</listitem> </listitem>
<listitem><para>Ensure that the module tests, if any, are <listitem>
succeeding.</para></listitem> <para>
<listitem><para>Ensure that the introduced options are correct.</para> Ensure that the module tests, if any, are succeeding.
</para>
</listitem>
<listitem>
<para>
Ensure that the introduced options are correct.
</para>
<itemizedlist> <itemizedlist>
<listitem><para>Type should be appropriate (string related types differs <listitem>
in their merging capabilities, <literal>optionSet</literal> and <para>
<literal>string</literal> types are deprecated).</para></listitem> Type should be appropriate (string related types differs in their
<listitem><para>Description, default and example should be merging capabilities, <literal>optionSet</literal> and
provided.</para></listitem> <literal>string</literal> types are deprecated).
</para>
</listitem>
<listitem>
<para>
Description, default and example should be provided.
</para>
</listitem>
</itemizedlist> </itemizedlist>
</listitem> </listitem>
<listitem><para>Ensure that module <literal>meta</literal> field is <listitem>
present</para> <para>
Ensure that module <literal>meta</literal> field is present
</para>
<itemizedlist> <itemizedlist>
<listitem><para>Maintainers should be declared in <listitem>
<literal>meta.maintainers</literal>.</para></listitem> <para>
<listitem><para>Module documentation should be declared with Maintainers should be declared in <literal>meta.maintainers</literal>.
<literal>meta.doc</literal>.</para></listitem> </para>
</listitem>
<listitem>
<para>
Module documentation should be declared with
<literal>meta.doc</literal>.
</para>
</listitem>
</itemizedlist> </itemizedlist>
</listitem> </listitem>
<listitem><para>Ensure that the module respect other modules <listitem>
functionality.</para> <para>
Ensure that the module respect other modules functionality.
</para>
<itemizedlist> <itemizedlist>
<listitem><para>For example, enabling a module should not open firewall <listitem>
ports by default.</para></listitem> <para>
For example, enabling a module should not open firewall ports by
default.
</para>
</listitem>
</itemizedlist> </itemizedlist>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<example><title>Sample template for a new module review</title> <example>
<title>Sample template for a new module review</title>
<screen> <screen>
##### Reviewed points ##### Reviewed points
@ -350,32 +553,41 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER"
##### Comments ##### Comments
</screen></example> </screen>
</example>
</section> </section>
<section>
<title>Other submissions</title>
<section><title>Other submissions</title> <para>
Other type of submissions requires different reviewing steps.
</para>
<para>Other type of submissions requires different reviewing steps.</para> <para>
If you consider having enough knowledge and experience in a topic and would
<para>If you consider having enough knowledge and experience in a topic and like to be a long-term reviewer for related submissions, please contact the
would like to be a long-term reviewer for related submissions, please contact current reviewers for that topic. They will give you information about the
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
reviewing process. there is no list, but checking past pull-requests to see who reviewed or
The main reviewers for a topic can be hard to find as there is no list, but git-blaming the code to see who committed to that topic can give some hints.
checking past pull-requests to see who reviewed or git-blaming the code to see </para>
who committed to that topic can give some hints.</para>
<para>Container system, boot system and library changes are some examples of the
pull requests fitting this category.</para>
<para>
Container system, boot system and library changes are some examples of the
pull requests fitting this category.
</para>
</section> </section>
<section>
<title>Merging pull-requests</title>
<section><title>Merging pull-requests</title> <para>
It is possible for community members that have enough knowledge and
experience on a special topic to contribute by merging pull requests.
</para>
<para>It is possible for community members that have enough knowledge and <para>
experience on a special topic to contribute by merging pull requests.</para> TODO: add the procedure to request merging rights.
</para>
<para>TODO: add the procedure to request merging rights.</para>
<!-- <!--
The following paragraph about how to deal with unactive contributors is just a The following paragraph about how to deal with unactive contributors is just a
@ -386,10 +598,11 @@ policy.
three months will have their commit rights revoked.</para> three months will have their commit rights revoked.</para>
--> -->
<para>In a case a contributor leaves definitively the Nix community, he should <para>
In a case a contributor leaves definitively the Nix community, he should
create an issue or notify the mailing list with references of packages and create an issue or notify the mailing list with references of packages and
modules he maintains so the maintainership can be taken over by other modules he maintains so the maintainership can be taken over by other
contributors.</para> contributors.
</para>
</section> </section>
</chapter> </chapter>

3077
doc/stdenv.xml
View File

File diff suppressed because it is too large Load Diff

416
doc/submitting-changes.xml
View File

@ -1,93 +1,102 @@
<chapter xmlns="http://docbook.org/ns/docbook" <chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink"
xml:id="chap-submitting-changes"> xml:id="chap-submitting-changes">
<title>Submitting changes</title> <title>Submitting changes</title>
<section> <section>
<title>Making patches</title> <title>Making patches</title>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>Read <link xlink:href="https://nixos.org/nixpkgs/manual/">Manual (How to write packages for Nix)</link>.</para> <para>
Read <link xlink:href="https://nixos.org/nixpkgs/manual/">Manual (How to
write packages for Nix)</link>.
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Fork the repository on GitHub.</para> <para>
Fork the repository on GitHub.
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Create a branch for your future fix. <para>
Create a branch for your future fix.
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>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. <para>
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.
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>For example: <command>nixos-version</command> returns <command>15.05.git.0998212 (Dingo)</command>. So you can do:</para> <para>
For example: <command>nixos-version</command> returns
<command>15.05.git.0998212 (Dingo)</command>. So you can do:
</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<screen> <screen>
$ git checkout 0998212 $ git checkout 0998212
$ git checkout -b 'fix/pkg-name-update' $ git checkout -b 'fix/pkg-name-update'
</screen> </screen>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para>Please avoid working directly on the <command>master</command> branch.</para> <para>
Please avoid working directly on the <command>master</command> branch.
</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para>Make commits of logical units. <para>
Make commits of logical units.
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>If you removed pkgs, made some major NixOS changes etc., write about them in <command>nixos/doc/manual/release-notes/rl-unstable.xml</command>.</para> <para>
If you removed pkgs, made some major NixOS changes etc., write about
them in
<command>nixos/doc/manual/release-notes/rl-unstable.xml</command>.
</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para>Check for unnecessary whitespace with <command>git diff --check</command> before committing.</para> <para>
Check for unnecessary whitespace with <command>git diff --check</command>
before committing.
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Format the commit in a following way:</para> <para>
Format the commit in a following way:
</para>
<programlisting> <programlisting>
(pkg-name | nixos/&lt;module>): (from -> to | init at version | refactor | etc) (pkg-name | nixos/&lt;module>): (from -> to | init at version | refactor | etc)
Additional information. Additional information.
</programlisting> </programlisting>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>Examples: <para>
Examples:
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
<command>nginx: init at 2.0.1</command> <command>nginx: init at 2.0.1</command>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<command>firefox: 54.0.1 -> 55.0</command> <command>firefox: 54.0.1 -> 55.0</command>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<command>nixos/hydra: add bazBaz option</command> <command>nixos/hydra: add bazBaz option</command>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<command>nixos/nginx: refactor config generation</command> <command>nixos/nginx: refactor config generation</command>
@ -98,73 +107,83 @@ Additional information.
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</listitem> </listitem>
<listitem> <listitem>
<para>Test your changes. If you work with <para>
Test your changes. If you work with
<itemizedlist>
<listitem>
<para>nixpkgs:
<itemizedlist>
<listitem>
<para>update pkg ->
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
<command>nix-env -i pkg-name -f &lt;path to your local nixpkgs folder&gt;</command> nixpkgs:
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
<listitem>
<para>add pkg ->
<itemizedlist>
<listitem>
<para>Make sure it's in <command>pkgs/top-level/all-packages.nix</command>
</para>
</listitem>
<listitem>
<para>
<command>nix-env -i pkg-name -f &lt;path to your local nixpkgs folder&gt;</command>
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
<listitem>
<para>
<emphasis>If you don't want to install pkg in you profile</emphasis>.
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
<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>.</para> update pkg ->
</listitem>
</itemizedlist>
</para>
</listitem>
<listitem>
<para>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.</para>
</listitem>
</itemizedlist>
</para>
</listitem>
<listitem>
<para>NixOS and its modules:
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>You can add new module to your NixOS configuration file (usually it's <command>/etc/nixos/configuration.nix</command>). <para>
And do <command>sudo nixos-rebuild test -I nixpkgs=&lt;path to your local nixpkgs folder&gt; --fast</command>.</para> <command>nix-env -i pkg-name -f &lt;path to your local nixpkgs
folder&gt;</command>
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
<listitem>
<para>
add pkg ->
<itemizedlist>
<listitem>
<para>
Make sure it's in
<command>pkgs/top-level/all-packages.nix</command>
</para>
</listitem>
<listitem>
<para>
<command>nix-env -i pkg-name -f &lt;path to your local nixpkgs
folder&gt;</command>
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
<listitem>
<para>
<emphasis>If you don't want to install pkg in you
profile</emphasis>.
<itemizedlist>
<listitem>
<para>
<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>.
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
<listitem>
<para>
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.
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
<listitem>
<para>
NixOS and its modules:
<itemizedlist>
<listitem>
<para>
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>.
</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</para> </para>
@ -172,59 +191,71 @@ Additional information.
</itemizedlist> </itemizedlist>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para>If you have commits <command>pkg-name: oh, forgot to insert whitespace</command>: squash commits in this case. Use <command>git rebase -i</command>.</para> <para>
If you have commits <command>pkg-name: oh, forgot to insert
whitespace</command>: squash commits in this case. Use <command>git rebase
-i</command>.
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Rebase you branch against current <command>master</command>.</para> <para>
Rebase you branch against current <command>master</command>.
</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</section> </section>
<section> <section>
<title>Submitting changes</title> <title>Submitting changes</title>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>Push your changes to your fork of nixpkgs.</para> <para>
Push your changes to your fork of nixpkgs.
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Create pull request: <para>
Create pull request:
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>Write the title in format <command>(pkg-name | nixos/&lt;module>): improvement</command>. <para>
Write the title in format <command>(pkg-name | nixos/&lt;module>):
improvement</command>.
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>If you update the pkg, write versions <command>from -> to</command>.</para> <para>
If you update the pkg, write versions <command>from -> to</command>.
</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para>Write in comment if you have tested your patch. Do not rely much on <command>TravisCI</command>.</para> <para>
Write in comment if you have tested your patch. Do not rely much on
<command>TravisCI</command>.
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>If you make an improvement, write about your motivation.</para> <para>
If you make an improvement, write about your motivation.
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Notify maintainers of the package. For example add to the message: <command>cc @jagajaga @domenkozar</command>.</para> <para>
Notify maintainers of the package. For example add to the message:
<command>cc @jagajaga @domenkozar</command>.
</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</section> </section>
<section> <section>
<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 contribution so far, and will help guide maintainers on the status of a
@ -232,164 +263,196 @@ Additional information.
the title does not address and link any existing issues related to the pull the title does not address and link any existing issues related to the pull
request. request.
</para> </para>
<para>When a PR is created, it will be pre-populated with some checkboxes detailed below:
<para>
When a PR is created, it will be pre-populated with some checkboxes detailed
below:
</para> </para>
<section> <section>
<title>Tested using sandboxing</title> <title>Tested using sandboxing</title>
<para> <para>
When sandbox builds are enabled, Nix will setup an isolated environment When sandbox builds are enabled, Nix will setup an isolated environment for
for each build process. It is used to remove further hidden dependencies each build process. It is used to remove further hidden dependencies set by
set by the build environment to improve reproducibility. This includes the build environment to improve reproducibility. This includes access to
access to the network during the build outside of the network during the build outside of <function>fetch*</function>
<function>fetch*</function> functions and files outside the Nix store. functions and files outside the Nix store. Depending on the operating
Depending on the operating system access to other resources are blocked system access to other resources are blocked as well (ex. inter process
as well (ex. inter process communication is isolated on Linux); see <link communication is isolated on Linux); see
<link
xlink:href="https://nixos.org/nix/manual/#description-45">build-use-sandbox</link> xlink:href="https://nixos.org/nix/manual/#description-45">build-use-sandbox</link>
in Nix manual for details. in Nix manual for details.
</para> </para>
<para> <para>
Sandboxing is not enabled by default in Nix due to a small performance Sandboxing is not enabled by default in Nix due to a small performance hit
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 <link
are asked to test builds with sandboxing enabled (see <literal>Tested xlink:href="https://github.com/NixOS/nixpkgs/">nixpkgs</link>
using sandboxing</literal> in the pull request template) because people are asked to test builds with sandboxing enabled (see
<literal>Tested using sandboxing</literal> in the pull request template)
because
in<link in<link
xlink:href="https://nixos.org/hydra/">https://nixos.org/hydra/</link> xlink:href="https://nixos.org/hydra/">https://nixos.org/hydra/</link>
sandboxing is also used. 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 add the following to <filename>configuration.nix</filename>
<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 platforms</emphasis>: <emphasis role="bold">Globally enable sandboxing on non-NixOS
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>
</itemizedlist> </itemizedlist>
</para> </para>
</section> </section>
<section> <section>
<title>Built on platform(s)</title> <title>Built on platform(s)</title>
<para> <para>
Many Nix packages are designed to run on multiple Many Nix packages are designed to run on multiple platforms. As such, it's
platforms. As such, it's important to let the maintainer know which important to let the maintainer know which platforms your changes have been
platforms your changes have been tested on. It's not always practical to tested on. It's not always practical to test a change on all platforms, and
test a change on all platforms, and is not required for a pull request to is not required for a pull request to be merged. Only check the systems you
be merged. Only check the systems you tested the build on in this tested the build on in this section.
section.
</para> </para>
</section> </section>
<section> <section>
<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 Packages with automated tests are much more likely to be merged in a timely
timely fashion because it doesn't require as much manual testing by the fashion because it doesn't require as much manual testing by the maintainer
maintainer to verify the functionality of the package. If there are to verify the functionality of the package. If there are existing tests for
existing tests for the package, they should be run to verify your changes the package, they should be run to verify your changes do not break the
do not break the tests. Tests only apply to packages with NixOS modules tests. Tests only apply to packages with NixOS modules defined and can only
defined and can only be run on Linux. For more details on writing and be run on Linux. For more details on writing and running tests, see the
running tests, see the <link <link
xlink:href="https://nixos.org/nixos/manual/index.html#sec-nixos-tests">section xlink:href="https://nixos.org/nixos/manual/index.html#sec-nixos-tests">section
in the NixOS manual</link>. in the NixOS manual</link>.
</para> </para>
</section> </section>
<section> <section>
<title>Tested compilation of all pkgs that depend on this change using <command>nox-review</command></title> <title>Tested compilation of all pkgs that depend on this change using <command>nox-review</command></title>
<para> <para>
If you are updating a package's version, you can use nox to make sure all If you are updating a package's version, you can use nox to make sure all
packages that depend on the updated package still compile correctly. This packages that depend on the updated package still compile correctly. This
can be done using the nox utility. The <command>nox-review</command> can be done using the nox utility. The <command>nox-review</command>
utility can look for and build all dependencies either based on utility can look for and build all dependencies either based on uncommited
uncommited changes with the <literal>wip</literal> option or specifying a changes with the <literal>wip</literal> option or specifying a github pull
github pull request number. request number.
</para> </para>
<para> <para>
review uncommitted changes: review uncommitted changes:
<screen>nix-shell -p nox --run "nox-review wip"</screen> <screen>nix-shell -p nox --run "nox-review wip"</screen>
</para> </para>
<para> <para>
review changes from pull request number 12345: review changes from pull request number 12345:
<screen>nix-shell -p nox --run "nox-review pr 12345"</screen> <screen>nix-shell -p nox --run "nox-review pr 12345"</screen>
</para> </para>
</section> </section>
<section> <section>
<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 It's important to test any executables generated by a build when you change
change or create a package in nixpkgs. This can be done by looking in 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 <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 minimum, the main executable for the package. For example, if you make a
to <package>texlive</package>, you probably would only check the binaries change to <package>texlive</package>, you probably would only check the
associated with the change you made rather than testing all of them. binaries associated with the change you made rather than testing all of
them.
</para> </para>
</section> </section>
<section> <section>
<title>Meets nixpkgs contribution standards</title> <title>Meets nixpkgs contribution standards</title>
<para> <para>
The last checkbox is fits <link The last checkbox is fits
<link
xlink:href="https://github.com/NixOS/nixpkgs/blob/master/.github/CONTRIBUTING.md">CONTRIBUTING.md</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 The contributing document has detailed information on standards the Nix
community has for commit messages, reviews, licensing of contributions community has for commit messages, reviews, licensing of contributions you
you make to the project, etc... Everyone should read and understand the make to the project, etc... Everyone should read and understand the
standards the community has for contributing before submitting a pull standards the community has for contributing before submitting a pull
request. request.
</para> </para>
</section> </section>
</section> </section>
<section> <section>
<title>Hotfixing pull requests</title> <title>Hotfixing pull requests</title>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>Make the appropriate changes in you branch.</para> <para>
</listitem> Make the appropriate changes in you branch.
</para>
<listitem>
<para>Don't create additional commits, do
<itemizedlist>
<listitem>
<para><command>git rebase -i</command></para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<command>git push --force</command> to your branch.</para> Don't create additional commits, do
<itemizedlist>
<listitem>
<para>
<command>git rebase -i</command>
</para>
</listitem>
<listitem>
<para>
<command>git push --force</command> to your branch.
</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</section> </section>
<section> <section>
<title>Commit policy</title> <title>Commit policy</title>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>Commits must be sufficiently tested before being merged, both for the master and staging branches.</para> <para>
Commits must be sufficiently tested before being merged, both for the
master and staging branches.
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>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.</para> <para>
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.
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>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.</para> <para>
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.
</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -413,17 +476,18 @@ Additional information.
<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. be used for testing, and changes must have been well tested already.
<link xlink:href="http://comments.gmane.org/gmane.linux.distributions.nixos/13447">Read policy here</link>. <link xlink:href="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, extra new breakages. Stabilize it for a few days, merge into master, then
then resume development on staging. 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>. <link xlink:href="http://hydra.nixos.org/jobset/nixpkgs/staging#tabs-evaluations">Keep
If any fixes for staging happen to be already in master, then master can an eye on the staging evaluations here</link>. If any fixes for staging
be merged into staging. happen to be already in master, then master can be merged into staging.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -440,7 +504,9 @@ Additional information.
clear description about why this needs to be included in the stable clear description about why this needs to be included in the stable
branch. branch.
</para> </para>
<para>An example of a cherry-picked commit would look like this:</para> <para>
An example of a cherry-picked commit would look like this:
</para>
<screen> <screen>
nixos: Refactor the world. nixos: Refactor the world.
@ -453,7 +519,5 @@ the stone age.
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</section> </section>
</section> </section>
</chapter> </chapter>