diff options
Diffstat (limited to 'nixpkgs/doc')
45 files changed, 1428 insertions, 4233 deletions
diff --git a/nixpkgs/doc/coding-conventions.xml b/nixpkgs/doc/coding-conventions.xml index 48356247a49e..799f1479467a 100644 --- a/nixpkgs/doc/coding-conventions.xml +++ b/nixpkgs/doc/coding-conventions.xml @@ -8,24 +8,17 @@ <itemizedlist> <listitem> <para> - Use 2 spaces of indentation per indentation level in Nix expressions, 4 - spaces in shell scripts. + Use 2 spaces of indentation per indentation level in Nix expressions, 4 spaces in shell scripts. </para> </listitem> <listitem> <para> - Do not use tab characters, i.e. configure your editor to use soft tabs. - For instance, use <literal>(setq-default indent-tabs-mode nil)</literal> - in Emacs. Everybody has different tab settings so it’s asking for - trouble. + Do not use tab characters, i.e. configure your editor to use soft tabs. For instance, use <literal>(setq-default indent-tabs-mode nil)</literal> in Emacs. Everybody has different tab settings so it’s asking for trouble. </para> </listitem> <listitem> <para> - Use <literal>lowerCamelCase</literal> for variable names, not - <literal>UpperCamelCase</literal>. Note, this rule does not apply to - package attribute names, which instead follow the rules in - <xref linkend="sec-package-naming"/>. + Use <literal>lowerCamelCase</literal> for variable names, not <literal>UpperCamelCase</literal>. Note, this rule does not apply to package attribute names, which instead follow the rules in <xref linkend="sec-package-naming"/>. </para> </listitem> <listitem> @@ -52,8 +45,7 @@ foo { arg = ...; } </listitem> <listitem> <para> - In attribute sets or lists that span multiple lines, the attribute names - or list elements should be aligned: + In attribute sets or lists that span multiple lines, the attribute names or list elements should be aligned: <programlisting> # A long list. list = [ @@ -97,8 +89,7 @@ attrs = { x = 1280; y = 1024; }; </listitem> <listitem> <para> - Breaking in the middle of a function argument can give hard-to-read code, - like + Breaking in the middle of a function argument can give hard-to-read code, like <programlisting> someFunction { x = 1280; y = 1024; } otherArg @@ -123,8 +114,7 @@ in someFunction res otherArg yetAnotherArg </listitem> <listitem> <para> - The bodies of functions, asserts, and withs are not indented to prevent a - lot of superfluous indentation levels, i.e. + The bodies of functions, asserts, and withs are not indented to prevent a lot of superfluous indentation levels, i.e. <programlisting> { arg1, arg2 }: assert system == "i686-linux"; @@ -156,8 +146,7 @@ stdenv.mkDerivation { ... </listitem> <listitem> <para> - Functions should list their expected arguments as precisely as possible. - That is, write + Functions should list their expected arguments as precisely as possible. That is, write <programlisting> { stdenv, fetchurl, perl }: <replaceable>...</replaceable> </programlisting> @@ -171,9 +160,7 @@ args: with args; <replaceable>...</replaceable> </programlisting> </para> <para> - For functions that are truly generic in the number of arguments (such as - wrappers around <varname>mkDerivation</varname>) that have some required - arguments, you should write them using an <literal>@</literal>-pattern: + For functions that are truly generic in the number of arguments (such as wrappers around <varname>mkDerivation</varname>) that have some required arguments, you should write them using an <literal>@</literal>-pattern: <programlisting> { stdenv, doCoverageAnalysis ? false, ... } @ args: @@ -197,35 +184,20 @@ args.stdenv.mkDerivation (args // { <title>Package naming</title> <para> - The key words <emphasis>must</emphasis>, <emphasis>must not</emphasis>, - <emphasis>required</emphasis>, <emphasis>shall</emphasis>, <emphasis>shall - not</emphasis>, <emphasis>should</emphasis>, <emphasis>should - not</emphasis>, <emphasis>recommended</emphasis>, <emphasis>may</emphasis>, - and <emphasis>optional</emphasis> in this section are to be interpreted as - described in <link xlink:href="https://tools.ietf.org/html/rfc2119">RFC - 2119</link>. Only <emphasis>emphasized</emphasis> words are to be - interpreted in this way. + The key words <emphasis>must</emphasis>, <emphasis>must not</emphasis>, <emphasis>required</emphasis>, <emphasis>shall</emphasis>, <emphasis>shall not</emphasis>, <emphasis>should</emphasis>, <emphasis>should not</emphasis>, <emphasis>recommended</emphasis>, <emphasis>may</emphasis>, and <emphasis>optional</emphasis> in this section are to be interpreted as described in <link xlink:href="https://tools.ietf.org/html/rfc2119">RFC 2119</link>. Only <emphasis>emphasized</emphasis> words are to be interpreted in this way. </para> <para> - In Nixpkgs, there are generally three different names associated with a - package: + In Nixpkgs, there are generally three different names associated with a package: <itemizedlist> <listitem> <para> - The <varname>name</varname> attribute of the derivation (excluding the - version part). This is what most users see, in particular when using - <command>nix-env</command>. + The <varname>name</varname> attribute of the derivation (excluding the version part). This is what most users see, in particular when using <command>nix-env</command>. </para> </listitem> <listitem> <para> - The variable name used for the instantiated package in - <filename>all-packages.nix</filename>, and when passing it as a - dependency to other functions. Typically this is called the - <emphasis>package attribute name</emphasis>. This is what Nix expression - authors see. It can also be used when installing using <command>nix-env - -iA</command>. + The variable name used for the instantiated package in <filename>all-packages.nix</filename>, and when passing it as a dependency to other functions. Typically this is called the <emphasis>package attribute name</emphasis>. This is what Nix expression authors see. It can also be used when installing using <command>nix-env -iA</command>. </para> </listitem> <listitem> @@ -234,12 +206,7 @@ args.stdenv.mkDerivation (args // { </para> </listitem> </itemizedlist> - Most of the time, these are the same. For instance, the package - <literal>e2fsprogs</literal> has a <varname>name</varname> attribute - <literal>"e2fsprogs-<replaceable>version</replaceable>"</literal>, is bound - to the variable name <varname>e2fsprogs</varname> in - <filename>all-packages.nix</filename>, and the Nix expression is in - <filename>pkgs/os-specific/linux/e2fsprogs/default.nix</filename>. + Most of the time, these are the same. For instance, the package <literal>e2fsprogs</literal> has a <varname>name</varname> attribute <literal>"e2fsprogs-<replaceable>version</replaceable>"</literal>, is bound to the variable name <varname>e2fsprogs</varname> in <filename>all-packages.nix</filename>, and the Nix expression is in <filename>pkgs/os-specific/linux/e2fsprogs/default.nix</filename>. </para> <para> @@ -247,51 +214,32 @@ args.stdenv.mkDerivation (args // { <itemizedlist> <listitem> <para> - The <literal>name</literal> attribute <emphasis>should</emphasis> be - identical to the upstream package name. + The <literal>name</literal> attribute <emphasis>should</emphasis> be identical to the upstream package name. </para> </listitem> <listitem> <para> - The <literal>name</literal> attribute <emphasis>must not</emphasis> - contain uppercase letters — e.g., <literal>"mplayer-1.0rc2"</literal> - instead of <literal>"MPlayer-1.0rc2"</literal>. + The <literal>name</literal> attribute <emphasis>must not</emphasis> contain uppercase letters — e.g., <literal>"mplayer-1.0rc2"</literal> instead of <literal>"MPlayer-1.0rc2"</literal>. </para> </listitem> <listitem> <para> - The version part of the <literal>name</literal> attribute - <emphasis>must</emphasis> start with a digit (following a dash) — e.g., - <literal>"hello-0.3.1rc2"</literal>. + The version part of the <literal>name</literal> attribute <emphasis>must</emphasis> start with a digit (following a dash) — e.g., <literal>"hello-0.3.1rc2"</literal>. </para> </listitem> <listitem> <para> - If a package is not a release but a commit from a repository, then the - version part of the name <emphasis>must</emphasis> be the date of that - (fetched) commit. The date <emphasis>must</emphasis> be in - <literal>"YYYY-MM-DD"</literal> format. Also append - <literal>"unstable"</literal> to the name - e.g., - <literal>"pkgname-unstable-2014-09-23"</literal>. + If a package is not a release but a commit from a repository, then the version part of the name <emphasis>must</emphasis> be the date of that (fetched) commit. The date <emphasis>must</emphasis> be in <literal>"YYYY-MM-DD"</literal> format. Also append <literal>"unstable"</literal> to the name - e.g., <literal>"pkgname-unstable-2014-09-23"</literal>. </para> </listitem> <listitem> <para> - Dashes in the package name <emphasis>should</emphasis> be preserved in - new variable names, rather than converted to underscores or camel cased - — e.g., <varname>http-parser</varname> instead of - <varname>http_parser</varname> or <varname>httpParser</varname>. The - hyphenated style is preferred in all three package names. + Dashes in the package name <emphasis>should</emphasis> be preserved in new variable names, rather than converted to underscores or camel cased — e.g., <varname>http-parser</varname> instead of <varname>http_parser</varname> or <varname>httpParser</varname>. The hyphenated style is preferred in all three package names. </para> </listitem> <listitem> <para> - If there are multiple versions of a package, this - <emphasis>should</emphasis> be reflected in the variable names in - <filename>all-packages.nix</filename>, e.g. <varname>json-c-0-9</varname> - and <varname>json-c-0-11</varname>. If there is an obvious “default” - version, make an attribute like <literal>json-c = json-c-0-9;</literal>. - See also <xref linkend="sec-versioning" /> + If there are multiple versions of a package, this <emphasis>should</emphasis> be reflected in the variable names in <filename>all-packages.nix</filename>, e.g. <varname>json-c-0-9</varname> and <varname>json-c-0-11</varname>. If there is an obvious “default” version, make an attribute like <literal>json-c = json-c-0-9;</literal>. See also <xref linkend="sec-versioning" /> </para> </listitem> </itemizedlist> @@ -301,31 +249,18 @@ args.stdenv.mkDerivation (args // { <title>File naming and organisation</title> <para> - Names of files and directories should be in lowercase, with dashes between - words — not in camel case. For instance, it should be - <filename>all-packages.nix</filename>, not - <filename>allPackages.nix</filename> or - <filename>AllPackages.nix</filename>. + Names of files and directories should be in lowercase, with dashes between words — not in camel case. For instance, it should be <filename>all-packages.nix</filename>, not <filename>allPackages.nix</filename> or <filename>AllPackages.nix</filename>. </para> <section xml:id="sec-hierarchy"> <title>Hierarchy</title> <para> - Each package should be stored in its own directory somewhere in the - <filename>pkgs/</filename> tree, i.e. in - <filename>pkgs/<replaceable>category</replaceable>/<replaceable>subcategory</replaceable>/<replaceable>...</replaceable>/<replaceable>pkgname</replaceable></filename>. - Below are some rules for picking the right category for a package. Many - packages fall under several categories; what matters is the - <emphasis>primary</emphasis> purpose of a package. For example, the - <literal>libxml2</literal> package builds both a library and some tools; - but it’s a library foremost, so it goes under - <filename>pkgs/development/libraries</filename>. + Each package should be stored in its own directory somewhere in the <filename>pkgs/</filename> tree, i.e. in <filename>pkgs/<replaceable>category</replaceable>/<replaceable>subcategory</replaceable>/<replaceable>...</replaceable>/<replaceable>pkgname</replaceable></filename>. Below are some rules for picking the right category for a package. Many packages fall under several categories; what matters is the <emphasis>primary</emphasis> purpose of a package. For example, the <literal>libxml2</literal> package builds both a library and some tools; but it’s a library foremost, so it goes under <filename>pkgs/development/libraries</filename>. </para> <para> - When in doubt, consider refactoring the <filename>pkgs/</filename> tree, - e.g. creating new categories or splitting up an existing category. + When in doubt, consider refactoring the <filename>pkgs/</filename> tree, e.g. creating new categories or splitting up an existing category. </para> <variablelist> @@ -341,8 +276,7 @@ args.stdenv.mkDerivation (args // { </term> <listitem> <para> - <filename>development/libraries</filename> (e.g. - <filename>libxml2</filename>) + <filename>development/libraries</filename> (e.g. <filename>libxml2</filename>) </para> </listitem> </varlistentry> @@ -352,8 +286,7 @@ args.stdenv.mkDerivation (args // { </term> <listitem> <para> - <filename>development/compilers</filename> (e.g. - <filename>gcc</filename>) + <filename>development/compilers</filename> (e.g. <filename>gcc</filename>) </para> </listitem> </varlistentry> @@ -363,8 +296,7 @@ args.stdenv.mkDerivation (args // { </term> <listitem> <para> - <filename>development/interpreters</filename> (e.g. - <filename>guile</filename>) + <filename>development/interpreters</filename> (e.g. <filename>guile</filename>) </para> </listitem> </varlistentry> @@ -380,8 +312,7 @@ args.stdenv.mkDerivation (args // { </term> <listitem> <para> - <filename>development/tools/parsing</filename> (e.g. - <filename>bison</filename>, <filename>flex</filename>) + <filename>development/tools/parsing</filename> (e.g. <filename>bison</filename>, <filename>flex</filename>) </para> </listitem> </varlistentry> @@ -391,8 +322,7 @@ args.stdenv.mkDerivation (args // { </term> <listitem> <para> - <filename>development/tools/build-managers</filename> (e.g. - <filename>gnumake</filename>) + <filename>development/tools/build-managers</filename> (e.g. <filename>gnumake</filename>) </para> </listitem> </varlistentry> @@ -402,8 +332,7 @@ args.stdenv.mkDerivation (args // { </term> <listitem> <para> - <filename>development/tools/misc</filename> (e.g. - <filename>binutils</filename>) + <filename>development/tools/misc</filename> (e.g. <filename>binutils</filename>) </para> </listitem> </varlistentry> @@ -429,8 +358,7 @@ args.stdenv.mkDerivation (args // { </term> <listitem> <para> - (A tool is a relatively small program, especially one intended to be - used non-interactively.) + (A tool is a relatively small program, especially one intended to be used non-interactively.) </para> <variablelist> <varlistentry> @@ -439,8 +367,7 @@ args.stdenv.mkDerivation (args // { </term> <listitem> <para> - <filename>tools/networking</filename> (e.g. - <filename>wget</filename>) + <filename>tools/networking</filename> (e.g. <filename>wget</filename>) </para> </listitem> </varlistentry> @@ -470,8 +397,7 @@ args.stdenv.mkDerivation (args // { </term> <listitem> <para> - <filename>tools/archivers</filename> (e.g. <filename>zip</filename>, - <filename>tar</filename>) + <filename>tools/archivers</filename> (e.g. <filename>zip</filename>, <filename>tar</filename>) </para> </listitem> </varlistentry> @@ -481,8 +407,7 @@ args.stdenv.mkDerivation (args // { </term> <listitem> <para> - <filename>tools/compression</filename> (e.g. - <filename>gzip</filename>, <filename>bzip2</filename>) + <filename>tools/compression</filename> (e.g. <filename>gzip</filename>, <filename>bzip2</filename>) </para> </listitem> </varlistentry> @@ -492,8 +417,7 @@ args.stdenv.mkDerivation (args // { </term> <listitem> <para> - <filename>tools/security</filename> (e.g. <filename>nmap</filename>, - <filename>gnupg</filename>) + <filename>tools/security</filename> (e.g. <filename>nmap</filename>, <filename>gnupg</filename>) </para> </listitem> </varlistentry> @@ -532,8 +456,7 @@ args.stdenv.mkDerivation (args // { </term> <listitem> <para> - <filename>servers/http</filename> (e.g. - <filename>apache-httpd</filename>) + <filename>servers/http</filename> (e.g. <filename>apache-httpd</filename>) </para> </listitem> </varlistentry> @@ -543,8 +466,7 @@ args.stdenv.mkDerivation (args // { </term> <listitem> <para> - <filename>servers/x11</filename> (e.g. <filename>xorg</filename> — - this includes the client libraries and programs) + <filename>servers/x11</filename> (e.g. <filename>xorg</filename> — this includes the client libraries and programs) </para> </listitem> </varlistentry> @@ -567,8 +489,7 @@ args.stdenv.mkDerivation (args // { </term> <listitem> <para> - <filename>desktops</filename> (e.g. <filename>kde</filename>, - <filename>gnome</filename>, <filename>enlightenment</filename>) + <filename>desktops</filename> (e.g. <filename>kde</filename>, <filename>gnome</filename>, <filename>enlightenment</filename>) </para> </listitem> </varlistentry> @@ -578,8 +499,7 @@ args.stdenv.mkDerivation (args // { </term> <listitem> <para> - <filename>applications/window-managers</filename> (e.g. - <filename>awesome</filename>, <filename>stumpwm</filename>) + <filename>applications/window-managers</filename> (e.g. <filename>awesome</filename>, <filename>stumpwm</filename>) </para> </listitem> </varlistentry> @@ -589,8 +509,7 @@ args.stdenv.mkDerivation (args // { </term> <listitem> <para> - A (typically large) program with a distinct user interface, primarily - used interactively. + A (typically large) program with a distinct user interface, primarily used interactively. </para> <variablelist> <varlistentry> @@ -599,8 +518,7 @@ args.stdenv.mkDerivation (args // { </term> <listitem> <para> - <filename>applications/version-management</filename> (e.g. - <filename>subversion</filename>) + <filename>applications/version-management</filename> (e.g. <filename>subversion</filename>) </para> </listitem> </varlistentry> @@ -610,8 +528,7 @@ args.stdenv.mkDerivation (args // { </term> <listitem> <para> - <filename>applications/video</filename> (e.g. - <filename>vlc</filename>) + <filename>applications/video</filename> (e.g. <filename>vlc</filename>) </para> </listitem> </varlistentry> @@ -621,8 +538,7 @@ args.stdenv.mkDerivation (args // { </term> <listitem> <para> - <filename>applications/graphics</filename> (e.g. - <filename>gimp</filename>) + <filename>applications/graphics</filename> (e.g. <filename>gimp</filename>) </para> </listitem> </varlistentry> @@ -638,8 +554,7 @@ args.stdenv.mkDerivation (args // { </term> <listitem> <para> - <filename>applications/networking/mailreaders</filename> (e.g. - <filename>thunderbird</filename>) + <filename>applications/networking/mailreaders</filename> (e.g. <filename>thunderbird</filename>) </para> </listitem> </varlistentry> @@ -649,8 +564,7 @@ args.stdenv.mkDerivation (args // { </term> <listitem> <para> - <filename>applications/networking/newsreaders</filename> (e.g. - <filename>pan</filename>) + <filename>applications/networking/newsreaders</filename> (e.g. <filename>pan</filename>) </para> </listitem> </varlistentry> @@ -660,8 +574,7 @@ args.stdenv.mkDerivation (args // { </term> <listitem> <para> - <filename>applications/networking/browsers</filename> (e.g. - <filename>firefox</filename>) + <filename>applications/networking/browsers</filename> (e.g. <filename>firefox</filename>) </para> </listitem> </varlistentry> @@ -719,8 +632,7 @@ args.stdenv.mkDerivation (args // { </term> <listitem> <para> - <filename>data/sgml+xml/schemas/xml-dtd</filename> (e.g. - <filename>docbook</filename>) + <filename>data/sgml+xml/schemas/xml-dtd</filename> (e.g. <filename>docbook</filename>) </para> </listitem> </varlistentry> @@ -733,8 +645,7 @@ args.stdenv.mkDerivation (args // { (Okay, these are executable...) </para> <para> - <filename>data/sgml+xml/stylesheets/xslt</filename> (e.g. - <filename>docbook-xsl</filename>) + <filename>data/sgml+xml/stylesheets/xslt</filename> (e.g. <filename>docbook-xsl</filename>) </para> </listitem> </varlistentry> @@ -771,36 +682,15 @@ args.stdenv.mkDerivation (args // { <title>Versioning</title> <para> - Because every version of a package in Nixpkgs creates a potential - maintenance burden, old versions of a package should not be kept unless - there is a good reason to do so. For instance, Nixpkgs contains several - versions of GCC because other packages don’t build with the latest - version of GCC. Other examples are having both the latest stable and latest - pre-release version of a package, or to keep several major releases of an - application that differ significantly in functionality. + Because every version of a package in Nixpkgs creates a potential maintenance burden, old versions of a package should not be kept unless there is a good reason to do so. For instance, Nixpkgs contains several versions of GCC because other packages don’t build with the latest version of GCC. Other examples are having both the latest stable and latest pre-release version of a package, or to keep several major releases of an application that differ significantly in functionality. </para> <para> - If there is only one version of a package, its Nix expression should be - named <filename>e2fsprogs/default.nix</filename>. If there are multiple - versions, this should be reflected in the filename, e.g. - <filename>e2fsprogs/1.41.8.nix</filename> and - <filename>e2fsprogs/1.41.9.nix</filename>. The version in the filename - should leave out unnecessary detail. For instance, if we keep the latest - Firefox 2.0.x and 3.5.x versions in Nixpkgs, they should be named - <filename>firefox/2.0.nix</filename> and - <filename>firefox/3.5.nix</filename>, respectively (which, at a given - point, might contain versions <literal>2.0.0.20</literal> and - <literal>3.5.4</literal>). If a version requires many auxiliary files, you - can use a subdirectory for each version, e.g. - <filename>firefox/2.0/default.nix</filename> and - <filename>firefox/3.5/default.nix</filename>. + If there is only one version of a package, its Nix expression should be named <filename>e2fsprogs/default.nix</filename>. If there are multiple versions, this should be reflected in the filename, e.g. <filename>e2fsprogs/1.41.8.nix</filename> and <filename>e2fsprogs/1.41.9.nix</filename>. The version in the filename should leave out unnecessary detail. For instance, if we keep the latest Firefox 2.0.x and 3.5.x versions in Nixpkgs, they should be named <filename>firefox/2.0.nix</filename> and <filename>firefox/3.5.nix</filename>, respectively (which, at a given point, might contain versions <literal>2.0.0.20</literal> and <literal>3.5.4</literal>). If a version requires many auxiliary files, you can use a subdirectory for each version, e.g. <filename>firefox/2.0/default.nix</filename> and <filename>firefox/3.5/default.nix</filename>. </para> <para> - All versions of a package <emphasis>must</emphasis> be included in - <filename>all-packages.nix</filename> to make sure that they evaluate - correctly. + All versions of a package <emphasis>must</emphasis> be included in <filename>all-packages.nix</filename> to make sure that they evaluate correctly. </para> </section> </section> @@ -808,25 +698,15 @@ args.stdenv.mkDerivation (args // { <title>Fetching Sources</title> <para> - There are multiple ways to fetch a package source in nixpkgs. The general - guideline is that you should package reproducible sources with a high degree - of availability. Right now there is only one fetcher which has mirroring - support and that is <literal>fetchurl</literal>. Note that you should also - prefer protocols which have a corresponding proxy environment variable. + There are multiple ways to fetch a package source in nixpkgs. The general guideline is that you should package reproducible sources with a high degree of availability. Right now there is only one fetcher which has mirroring support and that is <literal>fetchurl</literal>. Note that you should also prefer protocols which have a corresponding proxy environment variable. </para> <para> - You can find many source fetch helpers in - <literal>pkgs/build-support/fetch*</literal>. + You can find many source fetch helpers in <literal>pkgs/build-support/fetch*</literal>. </para> <para> - In the file <literal>pkgs/top-level/all-packages.nix</literal> you can find - fetch helpers, these have names on the form <literal>fetchFrom*</literal>. - The intention of these are to provide snapshot fetches but using the same - api as some of the version controlled fetchers from - <literal>pkgs/build-support/</literal>. As an example going from bad to - good: + In the file <literal>pkgs/top-level/all-packages.nix</literal> you can find fetch helpers, these have names on the form <literal>fetchFrom*</literal>. The intention of these are to provide snapshot fetches but using the same api as some of the version controlled fetchers from <literal>pkgs/build-support/</literal>. As an example going from bad to good: <itemizedlist> <listitem> <para> @@ -863,11 +743,7 @@ src = fetchFromGitHub { sha256 = "1i2yxndxb6yc9l6c99pypbd92lfq5aac4klq7y2v93c9qvx2cgpc"; } </programlisting> - Find the value to put as <literal>sha256</literal> by running - <literal>nix run -f '<nixpkgs>' nix-prefetch-github -c - nix-prefetch-github --rev 1f795f9f44607cc5bec70d1300150bfefcef2aae NixOS - nix</literal> or <literal>nix-prefetch-url --unpack - https://github.com/NixOS/nix/archive/1f795f9f44607cc5bec70d1300150bfefcef2aae.tar.gz</literal>. + Find the value to put as <literal>sha256</literal> by running <literal>nix run -f '<nixpkgs>' nix-prefetch-github -c nix-prefetch-github --rev 1f795f9f44607cc5bec70d1300150bfefcef2aae NixOS nix</literal> or <literal>nix-prefetch-url --unpack https://github.com/NixOS/nix/archive/1f795f9f44607cc5bec70d1300150bfefcef2aae.tar.gz</literal>. </para> </listitem> </itemizedlist> @@ -883,40 +759,23 @@ src = fetchFromGitHub { <orderedlist> <listitem> <para> - Prefetch URL (with <literal>nix-prefetch-<replaceable>XXX</replaceable> - <replaceable>URL</replaceable></literal>, where - <replaceable>XXX</replaceable> is one of <literal>url</literal>, - <literal>git</literal>, <literal>hg</literal>, <literal>cvs</literal>, - <literal>bzr</literal>, <literal>svn</literal>). Hash is printed to - stdout. + Prefetch URL (with <literal>nix-prefetch-<replaceable>XXX</replaceable> <replaceable>URL</replaceable></literal>, where <replaceable>XXX</replaceable> is one of <literal>url</literal>, <literal>git</literal>, <literal>hg</literal>, <literal>cvs</literal>, <literal>bzr</literal>, <literal>svn</literal>). Hash is printed to stdout. </para> </listitem> <listitem> <para> - Prefetch by package source (with <literal>nix-prefetch-url - '<nixpkgs>' -A <replaceable>PACKAGE</replaceable>.src</literal>, - where <replaceable>PACKAGE</replaceable> is package attribute name). Hash - is printed to stdout. + Prefetch by package source (with <literal>nix-prefetch-url '<nixpkgs>' -A <replaceable>PACKAGE</replaceable>.src</literal>, where <replaceable>PACKAGE</replaceable> is package attribute name). Hash is printed to stdout. </para> <para> - This works well when you've upgraded existing package version and want to - find out new hash, but is useless if package can't be accessed by - attribute or package has multiple sources (<literal>.srcs</literal>, - architecture-dependent sources, etc). + This works well when you've upgraded existing package version and want to find out new hash, but is useless if package can't be accessed by attribute or package has multiple sources (<literal>.srcs</literal>, architecture-dependent sources, etc). </para> </listitem> <listitem> <para> - Upstream provided hash: use it when upstream provides - <literal>sha256</literal> or <literal>sha512</literal> (when upstream - provides <literal>md5</literal>, don't use it, compute - <literal>sha256</literal> instead). + Upstream provided hash: use it when upstream provides <literal>sha256</literal> or <literal>sha512</literal> (when upstream provides <literal>md5</literal>, don't use it, compute <literal>sha256</literal> instead). </para> <para> - A little nuance is that <literal>nix-prefetch-*</literal> tools produce - hash encoded with <literal>base32</literal>, but upstream usually provides - hexadecimal (<literal>base16</literal>) encoding. Fetchers understand both - formats. Nixpkgs does not standardize on any one format. + A little nuance is that <literal>nix-prefetch-*</literal> tools produce hash encoded with <literal>base32</literal>, but upstream usually provides hexadecimal (<literal>base16</literal>) encoding. Fetchers understand both formats. Nixpkgs does not standardize on any one format. </para> <para> You can convert between formats with nix-hash, for example: @@ -927,28 +786,18 @@ src = fetchFromGitHub { </listitem> <listitem> <para> - Extracting hash from local source tarball can be done with - <literal>sha256sum</literal>. Use <literal>nix-prefetch-url - file:///path/to/tarball </literal> if you want base32 hash. + Extracting hash from local source tarball can be done with <literal>sha256sum</literal>. Use <literal>nix-prefetch-url file:///path/to/tarball </literal> if you want base32 hash. </para> </listitem> <listitem> <para> - Fake hash: set fake hash in package expression, perform build and extract - correct hash from error Nix prints. + Fake hash: set fake hash in package expression, perform build and extract correct hash from error Nix prints. </para> <para> - For package updates it is enough to change one symbol to make hash fake. - For new packages, you can use <literal>lib.fakeSha256</literal>, - <literal>lib.fakeSha512</literal> or any other fake hash. + For package updates it is enough to change one symbol to make hash fake. For new packages, you can use <literal>lib.fakeSha256</literal>, <literal>lib.fakeSha512</literal> or any other fake hash. </para> <para> - This is last resort method when reconstructing source URL is non-trivial - and <literal>nix-prefetch-url -A</literal> isn't applicable (for example, - <link xlink:href="https://github.com/NixOS/nixpkgs/blob/d2ab091dd308b99e4912b805a5eb088dd536adb9/pkgs/applications/video/kodi/default.nix#L73"> - one of <literal>kodi</literal> dependencies</link>). The easiest way then - would be replace hash with a fake one and rebuild. Nix build will fail and - error message will contain desired hash. + This is last resort method when reconstructing source URL is non-trivial and <literal>nix-prefetch-url -A</literal> isn't applicable (for example, <link xlink:href="https://github.com/NixOS/nixpkgs/blob/d2ab091dd308b99e4912b805a5eb088dd536adb9/pkgs/applications/video/kodi/default.nix#L73"> one of <literal>kodi</literal> dependencies</link>). The easiest way then would be replace hash with a fake one and rebuild. Nix build will fail and error message will contain desired hash. </para> <warning> <para> @@ -962,9 +811,7 @@ src = fetchFromGitHub { <title>Obtaining hashes securely</title> <para> - Let's say Man-in-the-Middle (MITM) sits close to your network. Then instead - of fetching source you can fetch malware, and instead of source hash you - get hash of malware. Here are security considerations for this scenario: + Let's say Man-in-the-Middle (MITM) sits close to your network. Then instead of fetching source you can fetch malware, and instead of source hash you get hash of malware. Here are security considerations for this scenario: </para> <itemizedlist> @@ -975,8 +822,7 @@ src = fetchFromGitHub { </listitem> <listitem> <para> - hashes from upstream (in method 3) should be obtained via secure - protocol; + hashes from upstream (in method 3) should be obtained via secure protocol; </para> </listitem> <listitem> @@ -986,12 +832,7 @@ src = fetchFromGitHub { </listitem> <listitem> <para> - <literal>https://</literal> URLs are not secure in method 5. When - obtaining hashes with fake hash method, TLS checks are disabled. So - refetch source hash from several different networks to exclude MITM - scenario. Alternatively, use fake hash method to make Nix error, but - instead of extracting hash from error, extract - <literal>https://</literal> URL and prefetch it with method 1. + <literal>https://</literal> URLs are not secure in method 5. When obtaining hashes with fake hash method, TLS checks are disabled. So refetch source hash from several different networks to exclude MITM scenario. Alternatively, use fake hash method to make Nix error, but instead of extracting hash from error, extract <literal>https://</literal> URL and prefetch it with method 1. </para> </listitem> </itemizedlist> @@ -1001,8 +842,7 @@ src = fetchFromGitHub { <title>Patches</title> <para> - Patches available online should be retrieved using - <literal>fetchpatch</literal>. + Patches available online should be retrieved using <literal>fetchpatch</literal>. </para> <para> @@ -1018,10 +858,7 @@ patches = [ </para> <para> - Otherwise, you can add a <literal>.patch</literal> file to the - <literal>nixpkgs</literal> repository. In the interest of keeping our - maintenance burden to a minimum, only patches that are unique to - <literal>nixpkgs</literal> should be added in this way. + Otherwise, you can add a <literal>.patch</literal> file to the <literal>nixpkgs</literal> repository. In the interest of keeping our maintenance burden to a minimum, only patches that are unique to <literal>nixpkgs</literal> should be added in this way. </para> <para> @@ -1031,8 +868,7 @@ patches = [ ./0001-changes.patch ]; </para> <para> - If you do need to do create this sort of patch file, one way to do so is - with git: + If you do need to do create this sort of patch file, one way to do so is with git: <orderedlist> <listitem> <para> @@ -1043,8 +879,7 @@ patches = [ ./0001-changes.patch ]; </listitem> <listitem> <para> - If a git repository is not already present, create one and stage all of - the source files. + If a git repository is not already present, create one and stage all of the source files. <screen> <prompt>$ </prompt>git init <prompt>$ </prompt>git add .</screen> @@ -1052,8 +887,7 @@ patches = [ ./0001-changes.patch ]; </listitem> <listitem> <para> - Edit some files to make whatever changes need to be included in the - patch. + Edit some files to make whatever changes need to be included in the patch. </para> </listitem> <listitem> diff --git a/nixpkgs/doc/configuration.xml b/nixpkgs/doc/configuration.xml index b497fa4e2722..cb660452d828 100644 --- a/nixpkgs/doc/configuration.xml +++ b/nixpkgs/doc/configuration.xml @@ -3,49 +3,38 @@ xml:id="chap-packageconfig"> <title>Global configuration</title> <para> - Nix comes with certain defaults about what packages can and cannot be - installed, based on a package's metadata. By default, Nix will prevent - installation if any of the following criteria are true: + Nix comes with certain defaults about what packages can and cannot be installed, based on a package's metadata. By default, Nix will prevent installation if any of the following criteria are true: </para> <itemizedlist> <listitem> <para> - The package is thought to be broken, and has had its - <literal>meta.broken</literal> set to <literal>true</literal>. + 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. + 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. + 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>. + 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. + 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: + The nixpkgs configuration for a NixOS system is set in the <literal>configuration.nix</literal>, as in the following example: <programlisting> { nixpkgs.config = { @@ -53,13 +42,10 @@ }; } </programlisting> - However, this does not allow unfree software for individual users. Their - configurations are managed separately. + However, this does not allow unfree software for individual users. Their configurations are managed separately. </para> <para> - A user's of nixpkgs configuration is stored in a user-specific configuration - file located at <filename>~/.config/nixpkgs/config.nix</filename>. For - example: + A user's of nixpkgs configuration is stored in a user-specific configuration file located at <filename>~/.config/nixpkgs/config.nix</filename>. For example: <programlisting> { allowUnfree = true; @@ -67,31 +53,25 @@ </programlisting> </para> <para> - Note that we are not able to test or build unfree software on Hydra due to - policy. Most unfree licenses prohibit us from either executing or - distributing the software. + Note that we are not able to test or build unfree software on Hydra due to policy. Most unfree licenses prohibit us from either executing or distributing the software. </para> <section xml:id="sec-allow-broken"> <title>Installing broken packages</title> <para> - There are two ways to try compiling a package which has been marked as - broken. + There are two ways to try compiling a package which has been marked as broken. </para> <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: + 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_BROKEN=1</programlisting> </para> </listitem> <listitem> <para> - For permanently allowing broken packages to be built, you may add - <literal>allowBroken = true;</literal> to your user's configuration file, - like this: + For permanently allowing broken packages to be built, you may add <literal>allowBroken = true;</literal> to your user's configuration file, like this: <programlisting> { allowBroken = true; @@ -105,23 +85,19 @@ <title>Installing packages on unsupported systems</title> <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> <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: + 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: + For permanently allowing broken packages to be built, you may add <literal>allowUnsupportedSystem = true;</literal> to your user's configuration file, like this: <programlisting> { allowUnsupportedSystem = true; @@ -132,42 +108,29 @@ </itemizedlist> <para> - The difference between a package being unsupported on some system and being - broken is admittedly a bit fuzzy. If a program <emphasis>ought</emphasis> to - work on a certain platform, but doesn't, the platform should be included in - <literal>meta.platforms</literal>, but marked as broken with e.g. - <literal>meta.broken = !hostPlatform.isWindows</literal>. Of course, this - begs the question of what "ought" means exactly. That is left to the package - maintainer. + The difference between a package being unsupported on some system and being broken is admittedly a bit fuzzy. If a program <emphasis>ought</emphasis> to work on a certain platform, but doesn't, the platform should be included in <literal>meta.platforms</literal>, but marked as broken with e.g. <literal>meta.broken = !hostPlatform.isWindows</literal>. Of course, this begs the question of what "ought" means exactly. That is left to the package maintainer. </para> </section> <section xml:id="sec-allow-unfree"> <title>Installing unfree packages</title> <para> - There are several ways to tweak how Nix handles a package which has been - marked as unfree. + There are several ways to tweak how Nix handles a package which has been marked as unfree. </para> <itemizedlist> <listitem> <para> - To temporarily allow all unfree packages, you can use an 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> </para> </listitem> <listitem> <para> - It is possible to permanently allow individual unfree packages, while - still blocking unfree packages by default using the - <literal>allowUnfreePredicate</literal> configuration option in the user - configuration file. + It is possible to permanently allow individual unfree packages, while still blocking unfree packages by default using the <literal>allowUnfreePredicate</literal> configuration option in the user configuration file. </para> <para> - 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: + 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> { allowUnfreePredicate = (pkg: false); @@ -175,8 +138,7 @@ </programlisting> </para> <para> - For a more useful example, try the following. This configuration only - allows unfree packages named flash player and visual studio code: + For a more useful example, try the following. This configuration only allows unfree packages named flash player and visual studio code: <programlisting> { allowUnfreePredicate = (pkg: builtins.elem @@ -190,14 +152,10 @@ </listitem> <listitem> <para> - It is also possible to whitelist and blacklist licenses that are - specifically acceptable or not acceptable, using - <literal>whitelistedLicenses</literal> and - <literal>blacklistedLicenses</literal>, respectively. + It is also possible to whitelist and blacklist licenses that are specifically acceptable or not acceptable, using <literal>whitelistedLicenses</literal> and <literal>blacklistedLicenses</literal>, respectively. </para> <para> - The following example configuration whitelists the licenses - <literal>amd</literal> and <literal>wtfpl</literal>: + The following example configuration whitelists the licenses <literal>amd</literal> and <literal>wtfpl</literal>: <programlisting> { whitelistedLicenses = with stdenv.lib.licenses; [ amd wtfpl ]; @@ -205,8 +163,7 @@ </programlisting> </para> <para> - The following example configuration blacklists the <literal>gpl3</literal> - and <literal>agpl3</literal> licenses: + The following example configuration blacklists the <literal>gpl3</literal> and <literal>agpl3</literal> licenses: <programlisting> { blacklistedLicenses = with stdenv.lib.licenses; [ agpl3 gpl3 ]; @@ -217,37 +174,29 @@ </itemizedlist> <para> - A complete list of licenses can be found in the file - <filename>lib/licenses.nix</filename> of the nixpkgs tree. + A complete list of licenses can be found in the file <filename>lib/licenses.nix</filename> of the nixpkgs tree. </para> </section> <section xml:id="sec-allow-insecure"> <title>Installing insecure packages</title> <para> - There are several ways to tweak how Nix handles a package which has been - marked as insecure. + There are several ways to tweak how Nix handles a package which has been marked as insecure. </para> <itemizedlist> <listitem> <para> - To temporarily allow all insecure packages, you can use an 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> </para> </listitem> <listitem> <para> - It is possible to permanently allow individual insecure packages, while - still blocking other insecure packages by default using the - <literal>permittedInsecurePackages</literal> configuration option in the - user configuration file. + It is possible to permanently allow individual insecure packages, while still blocking other insecure packages by default using the <literal>permittedInsecurePackages</literal> configuration option in the user configuration file. </para> <para> - The following example configuration permits the installation of the - hypothetically insecure package <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> { permittedInsecurePackages = [ @@ -259,18 +208,13 @@ </listitem> <listitem> <para> - It is also possible to create a custom policy around which insecure - packages to allow and deny, by overriding the - <literal>allowInsecurePredicate</literal> configuration option. + It is also possible to create a custom policy around which insecure packages to allow and deny, by overriding the <literal>allowInsecurePredicate</literal> configuration option. </para> <para> - The <literal>allowInsecurePredicate</literal> option is a function which - accepts a package and returns a boolean, much like - <literal>allowUnfreePredicate</literal>. + The <literal>allowInsecurePredicate</literal> option is a function which accepts a package and returns a boolean, much like <literal>allowUnfreePredicate</literal>. </para> <para> - The following configuration example only allows insecure packages with - very short names: + The following configuration example only allows insecure packages with very short names: <programlisting> { allowInsecurePredicate = (pkg: (builtins.stringLength (builtins.parseDrvName pkg.name).name) <= 5); @@ -278,8 +222,7 @@ </programlisting> </para> <para> - Note that <literal>permittedInsecurePackages</literal> is only checked if - <literal>allowInsecurePredicate</literal> is not specified. + Note that <literal>permittedInsecurePackages</literal> is only checked if <literal>allowInsecurePredicate</literal> is not specified. </para> </listitem> </itemizedlist> @@ -289,10 +232,7 @@ <title>Modify packages via <literal>packageOverrides</literal></title> <para> - You can define a function called <varname>packageOverrides</varname> in your - local <filename>~/.config/nixpkgs/config.nix</filename> to override Nix - packages. It must be a function that takes pkgs as an argument and returns a - modified set of packages. + You can define a function called <varname>packageOverrides</varname> in your local <filename>~/.config/nixpkgs/config.nix</filename> to override Nix packages. It must be a function that takes pkgs as an argument and returns a modified set of packages. <programlisting> { packageOverrides = pkgs: rec { @@ -309,15 +249,7 @@ <title>Build an environment</title> <para> - Using <literal>packageOverrides</literal>, it is possible to manage - packages declaratively. This means that we can list all of our desired - packages within a declarative Nix expression. For example, to have - <literal>aspell</literal>, <literal>bc</literal>, - <literal>ffmpeg</literal>, <literal>coreutils</literal>, - <literal>gdb</literal>, <literal>nixUnstable</literal>, - <literal>emscripten</literal>, <literal>jq</literal>, - <literal>nox</literal>, and <literal>silver-searcher</literal>, we could - use the following in <filename>~/.config/nixpkgs/config.nix</filename>: + Using <literal>packageOverrides</literal>, it is possible to manage packages declaratively. This means that we can list all of our desired packages within a declarative Nix expression. For example, to have <literal>aspell</literal>, <literal>bc</literal>, <literal>ffmpeg</literal>, <literal>coreutils</literal>, <literal>gdb</literal>, <literal>nixUnstable</literal>, <literal>emscripten</literal>, <literal>jq</literal>, <literal>nox</literal>, and <literal>silver-searcher</literal>, we could use the following in <filename>~/.config/nixpkgs/config.nix</filename>: </para> <screen> @@ -343,13 +275,7 @@ </screen> <para> - To install it into our environment, you can just run <literal>nix-env -iA - nixpkgs.myPackages</literal>. If you want to load the packages to be built - from a working copy of <literal>nixpkgs</literal> you just run - <literal>nix-env -f. -iA myPackages</literal>. To explore what's been - installed, just look through <filename>~/.nix-profile/</filename>. You can - see that a lot of stuff has been installed. Some of this stuff is useful - some of it isn't. Let's tell Nixpkgs to only link the stuff that we want: + To install it into our environment, you can just run <literal>nix-env -iA nixpkgs.myPackages</literal>. If you want to load the packages to be built from a working copy of <literal>nixpkgs</literal> you just run <literal>nix-env -f. -iA myPackages</literal>. To explore what's been installed, just look through <filename>~/.nix-profile/</filename>. You can see that a lot of stuff has been installed. Some of this stuff is useful some of it isn't. Let's tell Nixpkgs to only link the stuff that we want: </para> <screen> @@ -376,12 +302,7 @@ </screen> <para> - <literal>pathsToLink</literal> tells Nixpkgs to only link the paths listed - which gets rid of the extra stuff in the profile. <filename>/bin</filename> - and <filename>/share</filename> are good defaults for a user environment, - getting rid of the clutter. If you are running on Nix on MacOS, you may - want to add another path as well, <filename>/Applications</filename>, that - makes GUI apps available. + <literal>pathsToLink</literal> tells Nixpkgs to only link the paths listed which gets rid of the extra stuff in the profile. <filename>/bin</filename> and <filename>/share</filename> are good defaults for a user environment, getting rid of the clutter. If you are running on Nix on MacOS, you may want to add another path as well, <filename>/Applications</filename>, that makes GUI apps available. </para> </section> @@ -389,13 +310,7 @@ <title>Getting documentation</title> <para> - After building that new environment, look through - <filename>~/.nix-profile</filename> to make sure everything is there that - we wanted. Discerning readers will note that some files are missing. Look - inside <filename>~/.nix-profile/share/man/man1/</filename> to verify this. - There are no man pages for any of the Nix tools! This is because some - packages like Nix have multiple outputs for things like documentation (see - section 4). Let's make Nix install those as well. + After building that new environment, look through <filename>~/.nix-profile</filename> to make sure everything is there that we wanted. Discerning readers will note that some files are missing. Look inside <filename>~/.nix-profile/share/man/man1/</filename> to verify this. There are no man pages for any of the Nix tools! This is because some packages like Nix have multiple outputs for things like documentation (see section 4). Let's make Nix install those as well. </para> <screen> @@ -422,9 +337,7 @@ </screen> <para> - This provides us with some useful documentation for using our packages. - However, if we actually want those manpages to be detected by man, we need - to set up our environment. This can also be managed within Nix expressions. + This provides us with some useful documentation for using our packages. However, if we actually want those manpages to be detected by man, we need to set up our environment. This can also be managed within Nix expressions. </para> <screen> @@ -460,9 +373,7 @@ </screen> <para> - For this to work fully, you must also have this script sourced when you are - logged in. Try adding something like this to your - <filename>~/.profile</filename> file: + For this to work fully, you must also have this script sourced when you are logged in. Try adding something like this to your <filename>~/.profile</filename> file: </para> <screen> @@ -477,8 +388,7 @@ fi </screen> <para> - Now just run <literal>source $HOME/.profile</literal> and you can starting - loading man pages from your environent. + Now just run <literal>source $HOME/.profile</literal> and you can starting loading man pages from your environent. </para> </section> @@ -486,9 +396,7 @@ fi <title>GNU info setup</title> <para> - Configuring GNU info is a little bit trickier than man pages. To work - correctly, info needs a database to be generated. This can be done with - some small modifications to our environment scripts. + Configuring GNU info is a little bit trickier than man pages. To work correctly, info needs a database to be generated. This can be done with some small modifications to our environment scripts. </para> <screen> @@ -534,11 +442,7 @@ fi </screen> <para> - <literal>postBuild</literal> tells Nixpkgs to run a command after building - the environment. In this case, <literal>install-info</literal> adds the - installed info pages to <literal>dir</literal> which is GNU info's default - root node. Note that <literal>texinfoInteractive</literal> is added to the - environment to give the <literal>install-info</literal> command. + <literal>postBuild</literal> tells Nixpkgs to run a command after building the environment. In this case, <literal>install-info</literal> adds the installed info pages to <literal>dir</literal> which is GNU info's default root node. Note that <literal>texinfoInteractive</literal> is added to the environment to give the <literal>install-info</literal> command. </para> </section> </section> diff --git a/nixpkgs/doc/contributing.xml b/nixpkgs/doc/contributing.xml index 523c1c9c8f03..b0266043775f 100644 --- a/nixpkgs/doc/contributing.xml +++ b/nixpkgs/doc/contributing.xml @@ -3,10 +3,8 @@ xml:id="chap-contributing"> <title>Contributing to this documentation</title> <para> - The DocBook sources of the Nixpkgs manual are in the - <filename -xlink:href="https://github.com/NixOS/nixpkgs/tree/master/doc">doc</filename> - subdirectory of the Nixpkgs repository. + The DocBook sources of the Nixpkgs manual are in the <filename +xlink:href="https://github.com/NixOS/nixpkgs/tree/master/doc">doc</filename> subdirectory of the Nixpkgs repository. </para> <para> You can quickly check your edits with <command>make</command>: @@ -17,19 +15,16 @@ xlink:href="https://github.com/NixOS/nixpkgs/tree/master/doc">doc</filename> <prompt>[nix-shell]$ </prompt>make </screen> <para> - If you experience problems, run <command>make debug</command> to help - understand the docbook errors. + If you experience problems, run <command>make debug</command> to help understand the docbook errors. </para> <para> - After making modifications to the manual, it's important to 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> <prompt>$ </prompt>cd /path/to/nixpkgs/doc <prompt>$ </prompt>nix-shell <prompt>[nix-shell]$ </prompt>make clean <prompt>[nix-shell]$ </prompt>nix-build . </screen> - If the build succeeds, the manual will be in - <filename>./result/share/doc/nixpkgs/manual.html</filename>. + If the build succeeds, the manual will be in <filename>./result/share/doc/nixpkgs/manual.html</filename>. </para> </chapter> diff --git a/nixpkgs/doc/cross-compilation.xml b/nixpkgs/doc/cross-compilation.xml index b7844da195d7..93fe9095ce2f 100644 --- a/nixpkgs/doc/cross-compilation.xml +++ b/nixpkgs/doc/cross-compilation.xml @@ -6,25 +6,11 @@ <title>Introduction</title> <para> - "Cross-compilation" means compiling a program on one machine for another - type of machine. For example, a typical use of cross-compilation is to - compile programs for embedded devices. These devices often don't have the - computing power and memory to compile their own programs. One might think - that cross-compilation is a fairly niche concern. However, there are - significant advantages to rigorously distinguishing between build-time and - run-time environments! Significant, because the benefits apply even when one - is developing and deploying on the same machine. Nixpkgs is increasingly - adopting the opinion that packages should be written with cross-compilation - in mind, and nixpkgs should evaluate in a similar way (by minimizing - cross-compilation-specific special cases) whether or not one is - cross-compiling. + "Cross-compilation" means compiling a program on one machine for another type of machine. For example, a typical use of cross-compilation is to compile programs for embedded devices. These devices often don't have the computing power and memory to compile their own programs. One might think that cross-compilation is a fairly niche concern. However, there are significant advantages to rigorously distinguishing between build-time and run-time environments! Significant, because the benefits apply even when one is developing and deploying on the same machine. Nixpkgs is increasingly adopting the opinion that packages should be written with cross-compilation in mind, and nixpkgs should evaluate in a similar way (by minimizing cross-compilation-specific special cases) whether or not one is cross-compiling. </para> <para> - This chapter will be organized in three parts. First, it will describe the - basics of how to package software in a way that supports cross-compilation. - Second, it will describe how to use Nixpkgs when cross-compiling. Third, it - will describe the internal infrastructure supporting cross-compilation. + This chapter will be organized in three parts. First, it will describe the basics of how to package software in a way that supports cross-compilation. Second, it will describe how to use Nixpkgs when cross-compiling. Third, it will describe the internal infrastructure supporting cross-compilation. </para> </section> <!--============================================================--> @@ -35,24 +21,12 @@ <title>Platform parameters</title> <para> - Nixpkgs follows the - <link - xlink:href="https://gcc.gnu.org/onlinedocs/gccint/Configure-Terms.html">conventions - of GNU autoconf</link>. We distinguish between 3 types of platforms when - building a derivation: <wordasword>build</wordasword>, - <wordasword>host</wordasword>, and <wordasword>target</wordasword>. In - summary, <wordasword>build</wordasword> is the platform on which a package - is being built, <wordasword>host</wordasword> is the platform on which it - will run. The third attribute, <wordasword>target</wordasword>, is relevant - only for certain specific compilers and build tools. + Nixpkgs follows the <link + xlink:href="https://gcc.gnu.org/onlinedocs/gccint/Configure-Terms.html">conventions of GNU autoconf</link>. We distinguish between 3 types of platforms when building a derivation: <wordasword>build</wordasword>, <wordasword>host</wordasword>, and <wordasword>target</wordasword>. In summary, <wordasword>build</wordasword> is the platform on which a package is being built, <wordasword>host</wordasword> is the platform on which it will run. The third attribute, <wordasword>target</wordasword>, is relevant only for certain specific compilers and build tools. </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>. They are always defined as - attributes in the standard environment. That means one can access them - like: + In Nixpkgs, these three platforms are defined as attribute sets under the names <literal>buildPlatform</literal>, <literal>hostPlatform</literal>, and <literal>targetPlatform</literal>. They are always defined as attributes in the standard environment. That means one can access them like: <programlisting>{ stdenv, fooDep, barDep, .. }: ...stdenv.buildPlatform...</programlisting> . </para> @@ -64,9 +38,7 @@ </term> <listitem> <para> - The "build platform" is the platform on which a package is built. Once - someone has a built package, or pre-built binary package, the build - platform should not matter and can be ignored. + The "build platform" is the platform on which a package is built. Once someone has a built package, or pre-built binary package, the build platform should not matter and can be ignored. </para> </listitem> </varlistentry> @@ -76,9 +48,7 @@ </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. + 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> @@ -88,44 +58,23 @@ </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. + 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> - The build process of certain compilers is written in such a way that the - compiler resulting from a single build can itself only produce binaries - for a single platform. The task of specifying this single "target - platform" is thus pushed to build time of the compiler. The root cause - of this is that the compiler (which will be run on the host) and the - standard library/runtime (which will be run on the target) are built by - a single build process. + The build process of certain compilers is written in such a way that the compiler resulting from a single build can itself only produce binaries for a single platform. The task of specifying this single "target platform" is thus pushed to build time of the compiler. The root cause of this is that the compiler (which will be run on the host) and the standard library/runtime (which will be run on the target) are built by a single build process. </para> <para> - There is no fundamental need to think about a single target ahead of - time like this. If the tool supports modular or pluggable backends, both - the need to specify the target at build time and the constraint of - having only a single target disappear. An example of such a tool is - LLVM. + There is no fundamental need to think about a single target ahead of time like this. If the tool supports modular or pluggable backends, both the need to specify the target at build time and the constraint of having only a single target disappear. An example of such a tool is LLVM. </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. 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. + Although the existence of a "target platfom" is arguably a historical mistake, it is a common one: examples of tools that suffer from it are GCC, Binutils, GHC and Autoconf. Nixpkgs tries to avoid sharing in the mistake where possible. Still, because the concept of a target platform is so ingrained, it is best to support it as is. </para> </listitem> </varlistentry> </variablelist> <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. You can see - examples of ones used in practice in - <literal>lib.systems.examples</literal>; note how they are not all very - consistent. For now, here are few fields can count on them containing: + The exact schema these fields follow is a bit ill-defined due to a long and convoluted evolution, but this is slowly being cleaned up. You can see examples of ones used in practice in <literal>lib.systems.examples</literal>; note how they are not all very consistent. For now, here are few fields can count on them containing: </para> <variablelist> @@ -135,13 +84,7 @@ </term> <listitem> <para> - This is a two-component shorthand for the platform. Examples of this - would be "x86_64-darwin" and "i686-linux"; see - <literal>lib.systems.doubles</literal> for more. The first component - corresponds to the CPU architecture of the platform and the second to - the operating system of the platform (<literal>[cpu]-[os]</literal>). - This format has built-in support in Nix, such as the - <varname>builtins.currentSystem</varname> impure string. + This is a two-component shorthand for the platform. Examples of this would be "x86_64-darwin" and "i686-linux"; see <literal>lib.systems.doubles</literal> for more. The first component corresponds to the CPU architecture of the platform and the second to the operating system of the platform (<literal>[cpu]-[os]</literal>). This format has built-in support in Nix, such as the <varname>builtins.currentSystem</varname> impure string. </para> </listitem> </varlistentry> @@ -151,15 +94,7 @@ </term> <listitem> <para> - This is a 3- or 4- component shorthand for the platform. Examples of - this would be <literal>x86_64-unknown-linux-gnu</literal> and - <literal>aarch64-apple-darwin14</literal>. This is a standard format - called the "LLVM target triple", as they are pioneered by LLVM. In the - 4-part form, this corresponds to - <literal>[cpu]-[vendor]-[os]-[abi]</literal>. This format is strictly - more informative than the "Nix host double", as the previous format - could analogously be termed. This needs a better name than - <varname>config</varname>! + This is a 3- or 4- component shorthand for the platform. Examples of this would be <literal>x86_64-unknown-linux-gnu</literal> and <literal>aarch64-apple-darwin14</literal>. This is a standard format called the "LLVM target triple", as they are pioneered by LLVM. In the 4-part form, this corresponds to <literal>[cpu]-[vendor]-[os]-[abi]</literal>. This format is strictly more informative than the "Nix host double", as the previous format could analogously be termed. This needs a better name than <varname>config</varname>! </para> </listitem> </varlistentry> @@ -169,10 +104,7 @@ </term> <listitem> <para> - This is a Nix representation of a parsed LLVM target triple with - white-listed components. This can be specified directly, or actually - parsed from the <varname>config</varname>. See - <literal>lib.systems.parse</literal> for the exact representation. + This is a Nix representation of a parsed LLVM target triple with white-listed components. This can be specified directly, or actually parsed from the <varname>config</varname>. See <literal>lib.systems.parse</literal> for the exact representation. </para> </listitem> </varlistentry> @@ -182,10 +114,7 @@ </term> <listitem> <para> - This is a string identifying the standard C library used. Valid - identifiers include "glibc" for GNU libc, "libSystem" for Darwin's - Libsystem, and "uclibc" for µClibc. It should probably be refactored to - use the module system, like <varname>parse</varname>. + This is a string identifying the standard C library used. Valid identifiers include "glibc" for GNU libc, "libSystem" for Darwin's Libsystem, and "uclibc" for µClibc. It should probably be refactored to use the module system, like <varname>parse</varname>. </para> </listitem> </varlistentry> @@ -195,10 +124,7 @@ </term> <listitem> <para> - These predicates are defined in <literal>lib.systems.inspect</literal>, - and slapped onto every platform. They are superior to the ones in - <varname>stdenv</varname> as they force the user to be explicit about - which platform they are inspecting. Please use these instead of those. + These predicates are defined in <literal>lib.systems.inspect</literal>, and slapped onto every platform. They are superior to the ones in <varname>stdenv</varname> as they force the user to be explicit about which platform they are inspecting. Please use these instead of those. </para> </listitem> </varlistentry> @@ -208,11 +134,7 @@ </term> <listitem> <para> - This is, quite frankly, a dumping ground of ad-hoc settings (it's an - attribute set). See <literal>lib.systems.platforms</literal> for - examples—there's hopefully one in there that will work verbatim for - each platform that is working. Please help us triage these flags and - give them better homes! + This is, quite frankly, a dumping ground of ad-hoc settings (it's an attribute set). See <literal>lib.systems.platforms</literal> for examples—there's hopefully one in there that will work verbatim for each platform that is working. Please help us triage these flags and give them better homes! </para> </listitem> </varlistentry> @@ -224,62 +146,33 @@ <note> <para> - This is a rather philosophical description that isn't very - Nixpkgs-specific. For an overview of all the relevant attributes given to - <varname>mkDerivation</varname>, see - <xref - linkend="ssec-stdenv-dependencies"/>. For a description of how - everything is implemented, see - <xref linkend="ssec-cross-dependency-implementation" />. + This is a rather philosophical description that isn't very Nixpkgs-specific. For an overview of all the relevant attributes given to <varname>mkDerivation</varname>, see <xref + linkend="ssec-stdenv-dependencies"/>. For a description of how everything is implemented, see <xref linkend="ssec-cross-dependency-implementation" />. </para> </note> <para> - In this section we explore the relationship between both runtime and - build-time dependencies and the 3 Autoconf platforms. + In this section we explore the relationship between both runtime and build-time dependencies and the 3 Autoconf platforms. </para> <para> - A run time dependency between two packages requires that their host - platforms match. This is directly implied by the meaning of "host platform" - and "runtime dependency": The package dependency exists while both packages - are running on a single host platform. + A run time dependency between two packages requires that their host platforms match. This is directly implied by the meaning of "host platform" and "runtime dependency": The package dependency exists while both packages are running on a single host platform. </para> <para> - A build time dependency, however, has a shift in platforms between the - depending package and the depended-on package. "build time dependency" - means that to build the depending package we need to be able to run the - depended-on's package. The depending package's build platform is therefore - equal to the depended-on package's host platform. + A build time dependency, however, has a shift in platforms between the depending package and the depended-on package. "build time dependency" means that to build the depending package we need to be able to run the depended-on's package. The depending package's build platform is therefore equal to the depended-on package's host platform. </para> <para> - If both the dependency and depending packages aren't compilers or other - machine-code-producing tools, we're done. And indeed - <varname>buildInputs</varname> and <varname>nativeBuildInputs</varname> - have covered these simpler build-time and run-time (respectively) changes - for many years. But if the dependency does produce machine code, we might - need to worry about its target platform too. In principle, that target - platform might be any of the depending package's build, host, or target - platforms, but we prohibit dependencies from a "later" platform to an - earlier platform to limit confusion because we've never seen a legitimate - use for them. + If both the dependency and depending packages aren't compilers or other machine-code-producing tools, we're done. And indeed <varname>buildInputs</varname> and <varname>nativeBuildInputs</varname> have covered these simpler build-time and run-time (respectively) changes for many years. But if the dependency does produce machine code, we might need to worry about its target platform too. In principle, that target platform might be any of the depending package's build, host, or target platforms, but we prohibit dependencies from a "later" platform to an earlier platform to limit confusion because we've never seen a legitimate use for them. </para> <para> - Finally, if the depending package is a compiler or other - machine-code-producing tool, it might need dependencies that run at "emit - time". This is for compilers that (regrettably) insist on being built - together with their source langauges' standard libraries. Assuming build != - host != target, a run-time dependency of the standard library cannot be run - at the compiler's build time or run time, but only at the run time of code - emitted by the compiler. + Finally, if the depending package is a compiler or other machine-code-producing tool, it might need dependencies that run at "emit time". This is for compilers that (regrettably) insist on being built together with their source langauges' standard libraries. Assuming build != host != target, a run-time dependency of the standard library cannot be run at the compiler's build time or run time, but only at the run time of code emitted by the compiler. </para> <para> - Putting this all together, that means we have dependencies in the form - "host → target", in at most the following six combinations: + Putting this all together, that means we have dependencies in the form "host → target", in at most the following six combinations: <table> <caption>Possible dependency types</caption> <thead> @@ -318,16 +211,7 @@ </para> <para> - Some examples will make this table clearer. Suppose there's some package - that is being built with a <literal>(build, host, target)</literal> - platform triple of <literal>(foo, bar, baz)</literal>. If it has a - build-time library dependency, that would be a "host → build" dependency - with a triple of <literal>(foo, foo, *)</literal> (the target platform is - irrelevant). If it needs a compiler to be built, that would be a "build → - host" dependency with a triple of <literal>(foo, foo, *)</literal> (the - target platform is irrelevant). That compiler, would be built with another - compiler, also "build → host" dependency, with a triple of <literal>(foo, - foo, foo)</literal>. + Some examples will make this table clearer. Suppose there's some package that is being built with a <literal>(build, host, target)</literal> platform triple of <literal>(foo, bar, baz)</literal>. If it has a build-time library dependency, that would be a "host → build" dependency with a triple of <literal>(foo, foo, *)</literal> (the target platform is irrelevant). If it needs a compiler to be built, that would be a "build → host" dependency with a triple of <literal>(foo, foo, *)</literal> (the target platform is irrelevant). That compiler, would be built with another compiler, also "build → host" dependency, with a triple of <literal>(foo, foo, foo)</literal>. </para> </section> @@ -335,20 +219,14 @@ <title>Cross packaging cookbook</title> <para> - Some frequently encountered problems when packaging for cross-compilation - should be answered here. Ideally, the information above is exhaustive, so - this section cannot provide any new information, but it is ludicrous and - cruel to expect everyone to spend effort working through the interaction of - many features just to figure out the same answer to the same common - problem. Feel free to add to this list! + Some frequently encountered problems when packaging for cross-compilation should be answered here. Ideally, the information above is exhaustive, so this section cannot provide any new information, but it is ludicrous and cruel to expect everyone to spend effort working through the interaction of many features just to figure out the same answer to the same common problem. Feel free to add to this list! </para> <qandaset> <qandaentry xml:id="cross-qa-build-c-program-in-build-environment"> <question> <para> - What if my package's build system needs to build a C program to be run - under the build environment? + What if my package's build system needs to build a C program to be run under the build environment? </para> </question> <answer> @@ -366,11 +244,7 @@ </question> <answer> <para> - Many packages assume that an unprefixed <command>ar</command> is - available, but Nix doesn't provide one. It only provides a prefixed one, - just as it only does for all the other binutils programs. It may be - necessary to patch the package to fix the build system to use a prefixed - `ar`. + Many packages assume that an unprefixed <command>ar</command> is available, but Nix doesn't provide one. It only provides a prefixed one, just as it only does for all the other binutils programs. It may be necessary to patch the package to fix the build system to use a prefixed `ar`. </para> </answer> </qandaentry> @@ -395,82 +269,32 @@ <title>Cross-building packages</title> <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: + 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 <nixpkgs> --arg crossSystem '(import <nixpkgs/lib>).systems.examples.fooBarBaz' -A whatever</programlisting> +nix-build '<nixpkgs>' --arg crossSystem '(import <nixpkgs/lib>).systems.examples.fooBarBaz' -A whatever</programlisting> </para> <note> <para> - Eventually we would like to make these platform examples an unnecessary - convenience so that + Eventually we would like to make these platform examples an unnecessary convenience so that <programlisting> -nix-build <nixpkgs> --arg crossSystem '{ config = "<arch>-<os>-<vendor>-<abi>"; }' -A whatever</programlisting> - works in the vast majority of cases. The problem today is dependencies on - other sorts of configuration which aren't given proper defaults. We rely on - the examples to crudely to set those configuration parameters in some - vaguely sane manner on the users behalf. Issue - <link xlink:href="https://github.com/NixOS/nixpkgs/issues/34274">#34274</link> - tracks this inconvenience along with its root cause in crufty configuration - options. +nix-build '<nixpkgs>' --arg crossSystem '{ config = "<arch>-<os>-<vendor>-<abi>"; }' -A whatever</programlisting> + works in the vast majority of cases. The problem today is dependencies on other sorts of configuration which aren't given proper defaults. We rely on the examples to crudely to set those configuration parameters in some vaguely sane manner on the users behalf. Issue <link xlink:href="https://github.com/NixOS/nixpkgs/issues/34274">#34274</link> tracks this inconvenience along with its root cause in crufty configuration options. </para> </note> <para> - While one is free to pass both parameters in full, there's a lot of logic to - fill in missing fields. As discussed in the previous section, only one of - <varname>system</varname>, <varname>config</varname>, and - <varname>parsed</varname> is needed to infer the other two. Additionally, - <varname>libc</varname> will be inferred from <varname>parse</varname>. - Finally, <literal>localSystem.system</literal> is also - <emphasis>impurely</emphasis> inferred based on the platform evaluation - occurs. This means it is often not necessary to pass - <varname>localSystem</varname> at all, as in the command-line example in the - previous paragraph. + While one is free to pass both parameters in full, there's a lot of logic to fill in missing fields. As discussed in the previous section, only one of <varname>system</varname>, <varname>config</varname>, and <varname>parsed</varname> is needed to infer the other two. Additionally, <varname>libc</varname> will be inferred from <varname>parse</varname>. Finally, <literal>localSystem.system</literal> is also <emphasis>impurely</emphasis> inferred based on the platform evaluation occurs. This means it is often not necessary to pass <varname>localSystem</varname> at all, as in the command-line example in the previous paragraph. </para> <note> <para> - Many sources (manual, wiki, etc) probably mention passing - <varname>system</varname>, <varname>platform</varname>, along with the - optional <varname>crossSystem</varname> to nixpkgs: <literal>import - <nixpkgs> { 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. + Many sources (manual, wiki, etc) probably mention passing <varname>system</varname>, <varname>platform</varname>, along with the optional <varname>crossSystem</varname> to nixpkgs: <literal>import <nixpkgs> { 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> </note> <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). Actually, those identifiers are - purposefully not used here to draw a subtle but important distinction: While - the granularity of having 3 platforms is necessary to properly *build* - packages, it is overkill for specifying the user's *intent* when making a - build plan or package set. A simple "build vs deploy" dichotomy is adequate: - the sliding window principle described in the previous section shows how to - interpolate between the these two "end points" to get the 3 platform triple - for each bootstrapping stage. That means for any package a given package - set, even those not bound on the top level but only reachable via - dependencies or <varname>buildPackages</varname>, the three platforms will - be defined as one of <varname>localSystem</varname> or - <varname>crossSystem</varname>, with the former replacing the latter as one - traverses build-time dependencies. A last simple difference is that - <varname>crossSystem</varname> should be null when one doesn't want to - cross-compile, while the <varname>*Platform</varname>s are always non-null. - <varname>localSystem</varname> is always non-null. + One would think that <varname>localSystem</varname> and <varname>crossSystem</varname> overlap horribly with the three <varname>*Platforms</varname> (<varname>buildPlatform</varname>, <varname>hostPlatform,</varname> and <varname>targetPlatform</varname>; see <varname>stage.nix</varname> or the manual). Actually, those identifiers are purposefully not used here to draw a subtle but important distinction: While the granularity of having 3 platforms is necessary to properly *build* packages, it is overkill for specifying the user's *intent* when making a build plan or package set. A simple "build vs deploy" dichotomy is adequate: the sliding window principle described in the previous section shows how to interpolate between the these two "end points" to get the 3 platform triple for each bootstrapping stage. That means for any package a given package set, even those not bound on the top level but only reachable via dependencies or <varname>buildPackages</varname>, the three platforms will be defined as one of <varname>localSystem</varname> or <varname>crossSystem</varname>, with the former replacing the latter as one traverses build-time dependencies. A last simple difference is that <varname>crossSystem</varname> should be null when one doesn't want to cross-compile, while the <varname>*Platform</varname>s are always non-null. <varname>localSystem</varname> is always non-null. </para> </section> <!--============================================================--> @@ -481,62 +305,20 @@ nix-build <nixpkgs> --arg crossSystem '{ config = "<arch>-<os> <title>Implementation of dependencies</title> <para> - The categorizes of dependencies developed in - <xref - linkend="ssec-cross-dependency-categorization"/> are specified as - lists of derivations given to <varname>mkDerivation</varname>, as - documented in <xref linkend="ssec-stdenv-dependencies"/>. In short, - each list of dependencies for "host → target" of "foo → bar" is called - <varname>depsFooBar</varname>, with exceptions for backwards - compatibility that <varname>depsBuildHost</varname> is instead called - <varname>nativeBuildInputs</varname> and <varname>depsHostTarget</varname> - is instead called <varname>buildInputs</varname>. Nixpkgs is now structured - so that each <varname>depsFooBar</varname> is automatically taken from - <varname>pkgsFooBar</varname>. (These <varname>pkgsFooBar</varname>s are - quite new, so there is no special case for - <varname>nativeBuildInputs</varname> and <varname>buildInputs</varname>.) - For example, <varname>pkgsBuildHost.gcc</varname> should be used at - build-time, while <varname>pkgsHostTarget.gcc</varname> should be used at - run-time. + The categorizes of dependencies developed in <xref + linkend="ssec-cross-dependency-categorization"/> are specified as lists of derivations given to <varname>mkDerivation</varname>, as documented in <xref linkend="ssec-stdenv-dependencies"/>. In short, each list of dependencies for "host → target" of "foo → bar" is called <varname>depsFooBar</varname>, with exceptions for backwards compatibility that <varname>depsBuildHost</varname> is instead called <varname>nativeBuildInputs</varname> and <varname>depsHostTarget</varname> is instead called <varname>buildInputs</varname>. Nixpkgs is now structured so that each <varname>depsFooBar</varname> is automatically taken from <varname>pkgsFooBar</varname>. (These <varname>pkgsFooBar</varname>s are quite new, so there is no special case for <varname>nativeBuildInputs</varname> and <varname>buildInputs</varname>.) For example, <varname>pkgsBuildHost.gcc</varname> should be used at build-time, while <varname>pkgsHostTarget.gcc</varname> should be used at run-time. </para> <para> - Now, for most of Nixpkgs's history, there were no - <varname>pkgsFooBar</varname> attributes, and most packages have not been - refactored to use it explicitly. Prior to those, there were just - <varname>buildPackages</varname>, <varname>pkgs</varname>, and - <varname>targetPackages</varname>. Those are now redefined as aliases to - <varname>pkgsBuildHost</varname>, <varname>pkgsHostTarget</varname>, and - <varname>pkgsTargetTarget</varname>. It is acceptable, even - recommended, to use them for libraries to show that the host platform is - irrelevant. + Now, for most of Nixpkgs's history, there were no <varname>pkgsFooBar</varname> attributes, and most packages have not been refactored to use it explicitly. Prior to those, there were just <varname>buildPackages</varname>, <varname>pkgs</varname>, and <varname>targetPackages</varname>. Those are now redefined as aliases to <varname>pkgsBuildHost</varname>, <varname>pkgsHostTarget</varname>, and <varname>pkgsTargetTarget</varname>. It is acceptable, even recommended, to use them for libraries to show that the host platform is irrelevant. </para> <para> - But before that, there was just <varname>pkgs</varname>, even though both - <varname>buildInputs</varname> and <varname>nativeBuildInputs</varname> - existed. [Cross barely worked, and those were implemented with some hacks - on <varname>mkDerivation</varname> to override dependencies.] What this - means is the vast majority of packages do not use any explicit package set - to populate their dependencies, just using whatever - <varname>callPackage</varname> gives them even if they do correctly sort - their dependencies into the multiple lists described above. And indeed, - asking that users both sort their dependencies, <emphasis>and</emphasis> - take them from the right attribute set, is both too onerous and redundant, - so the recommended approach (for now) is to continue just categorizing by - list and not using an explicit package set. + But before that, there was just <varname>pkgs</varname>, even though both <varname>buildInputs</varname> and <varname>nativeBuildInputs</varname> existed. [Cross barely worked, and those were implemented with some hacks on <varname>mkDerivation</varname> to override dependencies.] What this means is the vast majority of packages do not use any explicit package set to populate their dependencies, just using whatever <varname>callPackage</varname> gives them even if they do correctly sort their dependencies into the multiple lists described above. And indeed, asking that users both sort their dependencies, <emphasis>and</emphasis> take them from the right attribute set, is both too onerous and redundant, so the recommended approach (for now) is to continue just categorizing by list and not using an explicit package set. </para> <para> - To make this work, we "splice" together the six - <varname>pkgsFooBar</varname> package sets and have - <varname>callPackage</varname> actually take its arguments from that. This - is currently implemented in <filename>pkgs/top-level/splice.nix</filename>. - <varname>mkDerivation</varname> then, for each dependency attribute, pulls - the right derivation out from the splice. This splicing can be skipped when - not cross-compiling as the package sets are the same, but still is a bit - slow for cross-compiling. We'd like to do something better, but haven't - come up with anything yet. + To make this work, we "splice" together the six <varname>pkgsFooBar</varname> package sets and have <varname>callPackage</varname> actually take its arguments from that. This is currently implemented in <filename>pkgs/top-level/splice.nix</filename>. <varname>mkDerivation</varname> then, for each dependency attribute, pulls the right derivation out from the splice. This splicing can be skipped when not cross-compiling as the package sets are the same, but still is a bit slow for cross-compiling. We'd like to do something better, but haven't come up with anything yet. </para> </section> @@ -544,21 +326,11 @@ nix-build <nixpkgs> --arg crossSystem '{ config = "<arch>-<os> <title>Bootstrapping</title> <para> - Each of the package sets described above come from a single bootstrapping - stage. While <filename>pkgs/top-level/default.nix</filename>, coordinates - the composition of stages at a high level, - <filename>pkgs/top-level/stage.nix</filename> "ties the knot" (creates the - fixed point) of each stage. The package sets are defined per-stage however, - so they can be thought of as edges between stages (the nodes) in a graph. - Compositions like <literal>pkgsBuildTarget.targetPackages</literal> can be - thought of as paths to this graph. + Each of the package sets described above come from a single bootstrapping stage. While <filename>pkgs/top-level/default.nix</filename>, coordinates the composition of stages at a high level, <filename>pkgs/top-level/stage.nix</filename> "ties the knot" (creates the fixed point) of each stage. The package sets are defined per-stage however, so they can be thought of as edges between stages (the nodes) in a graph. Compositions like <literal>pkgsBuildTarget.targetPackages</literal> can be thought of as paths to this graph. </para> <para> - While there are many package sets, and thus many edges, the stages can also - be arranged in a linear chain. In other words, many of the edges are - redundant as far as connectivity is concerned. This hinges on the type of - bootstrapping we do. Currently for cross it is: + While there are many package sets, and thus many edges, the stages can also be arranged in a linear chain. In other words, many of the edges are redundant as far as connectivity is concerned. This hinges on the type of bootstrapping we do. Currently for cross it is: <orderedlist> <listitem> <para> @@ -576,101 +348,45 @@ nix-build <nixpkgs> --arg crossSystem '{ config = "<arch>-<os> </para> </listitem> </orderedlist> - In each stage, <varname>pkgsBuildHost</varname> refers the the previous - stage, <varname>pkgsBuildBuild</varname> refers to the one before that, and - <varname>pkgsHostTarget</varname> refers to the current one, and - <varname>pkgsTargetTarget</varname> refers to the next one. When there is - no previous or next stage, they instead refer to the current stage. Note - how all the invariants regarding the mapping between dependency and depending - packages' build host and target platforms are preserved. - <varname>pkgsBuildTarget</varname> and <varname>pkgsHostHost</varname> are - more complex in that the stage fitting the requirements isn't always a - fixed chain of "prevs" and "nexts" away (modulo the "saturating" - self-references at the ends). We just special case each instead. All the primary - edges are implemented is in <filename>pkgs/stdenv/booter.nix</filename>, - and secondarily aliases in <filename>pkgs/top-level/stage.nix</filename>. + In each stage, <varname>pkgsBuildHost</varname> refers the the previous stage, <varname>pkgsBuildBuild</varname> refers to the one before that, and <varname>pkgsHostTarget</varname> refers to the current one, and <varname>pkgsTargetTarget</varname> refers to the next one. When there is no previous or next stage, they instead refer to the current stage. Note how all the invariants regarding the mapping between dependency and depending packages' build host and target platforms are preserved. <varname>pkgsBuildTarget</varname> and <varname>pkgsHostHost</varname> are more complex in that the stage fitting the requirements isn't always a fixed chain of "prevs" and "nexts" away (modulo the "saturating" self-references at the ends). We just special case each instead. All the primary edges are implemented is in <filename>pkgs/stdenv/booter.nix</filename>, and secondarily aliases in <filename>pkgs/top-level/stage.nix</filename>. </para> <note> <para> - Note the native stages are bootstrapped in legacy ways that predate the - current cross implementation. This is why the the bootstrapping stages - leading up to the final stages are ignored inthe previous paragraph. + Note the native stages are bootstrapped in legacy ways that predate the current cross implementation. This is why the the bootstrapping stages leading up to the final stages are ignored inthe previous paragraph. </para> </note> <para> - If one looks at the 3 platform triples, one can see that they overlap such - that one could put them together into a chain like: + If one looks at the 3 platform triples, one can see that they overlap such that one could put them together into a chain like: <programlisting> (native, native, native, foreign, foreign) </programlisting> - If one imagines the saturating self references at the end being replaced - with infinite stages, and then overlays those platform triples, one ends up - with the infinite tuple: + If one imagines the saturating self references at the end being replaced with infinite stages, and then overlays those platform triples, one ends up with the infinite tuple: <programlisting> (native..., native, native, native, foreign, foreign, foreign...) </programlisting> - On can then imagine any sequence of platforms such that there are bootstrap - stages with their 3 platforms determined by "sliding a window" that is the - 3 tuple through the sequence. This was the original model for - bootstrapping. Without a target platform (assume a better world where all - compilers are multi-target and all standard libraries are built in their - own derivation), this is sufficient. Conversely if one wishes to cross - compile "faster", with a "Canadian Cross" bootstraping stage where - <literal>build != host != target</literal>, more bootstrapping stages are - needed since no sliding window providess the pesky - <varname>pkgsBuildTarget</varname> package set since it skips the Canadian - cross stage's "host". + On can then imagine any sequence of platforms such that there are bootstrap stages with their 3 platforms determined by "sliding a window" that is the 3 tuple through the sequence. This was the original model for bootstrapping. Without a target platform (assume a better world where all compilers are multi-target and all standard libraries are built in their own derivation), this is sufficient. Conversely if one wishes to cross compile "faster", with a "Canadian Cross" bootstraping stage where <literal>build != host != target</literal>, more bootstrapping stages are needed since no sliding window providess the pesky <varname>pkgsBuildTarget</varname> package set since it skips the Canadian cross stage's "host". </para> <note> <para> - It is much better to refer to <varname>buildPackages</varname> than - <varname>targetPackages</varname>, or more broadly package sets that do - not mention "target". There are three reasons for this. + It is much better to refer to <varname>buildPackages</varname> than <varname>targetPackages</varname>, or more broadly package sets that do not mention "target". There are three reasons for this. </para> <para> - First, it is because bootstrapping stages do not have a unique - <varname>targetPackages</varname>. For example a <literal>(x86-linux, - x86-linux, arm-linux)</literal> and <literal>(x86-linux, x86-linux, - x86-windows)</literal> package set both have a <literal>(x86-linux, - x86-linux, x86-linux)</literal> package set. Because there is no canonical - <varname>targetPackages</varname> for such a native (<literal>build == - host == target</literal>) package set, we set their - <varname>targetPackages</varname> + First, it is because bootstrapping stages do not have a unique <varname>targetPackages</varname>. For example a <literal>(x86-linux, x86-linux, arm-linux)</literal> and <literal>(x86-linux, x86-linux, x86-windows)</literal> package set both have a <literal>(x86-linux, x86-linux, x86-linux)</literal> package set. Because there is no canonical <varname>targetPackages</varname> for such a native (<literal>build == host == target</literal>) package set, we set their <varname>targetPackages</varname> </para> <para> - Second, it is because this is a frequent source of hard-to-follow - "infinite recursions" / cycles. When only package sets that don't mention - target are used, the package set forms a directed acyclic graph. This - means that all cycles that exist are confined to one stage. This means - they are a lot smaller, and easier to follow in the code or a backtrace. It - also means they are present in native and cross builds alike, and so more - likely to be caught by CI and other users. + Second, it is because this is a frequent source of hard-to-follow "infinite recursions" / cycles. When only package sets that don't mention target are used, the package set forms a directed acyclic graph. This means that all cycles that exist are confined to one stage. This means they are a lot smaller, and easier to follow in the code or a backtrace. It also means they are present in native and cross builds alike, and so more likely to be caught by CI and other users. </para> <para> - Thirdly, it is because everything target-mentioning only exists to - accommodate compilers with lousy build systems that insist on the compiler - itself and standard library being built together. Of course that is bad - because bigger derivations means longer rebuilds. It is also problematic because - it tends to make the standard libraries less like other libraries than - they could be, complicating code and build systems alike. Because of the - other problems, and because of these innate disadvantages, compilers ought - to be packaged another way where possible. + Thirdly, it is because everything target-mentioning only exists to accommodate compilers with lousy build systems that insist on the compiler itself and standard library being built together. Of course that is bad because bigger derivations means longer rebuilds. It is also problematic because it tends to make the standard libraries less like other libraries than they could be, complicating code and build systems alike. Because of the other problems, and because of these innate disadvantages, compilers ought to be packaged another way where possible. </para> </note> <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. + 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> diff --git a/nixpkgs/doc/functions.xml b/nixpkgs/doc/functions.xml index 96bd95958eae..3e126e6b1397 100644 --- a/nixpkgs/doc/functions.xml +++ b/nixpkgs/doc/functions.xml @@ -4,8 +4,7 @@ xml:id="chap-functions"> <title>Functions reference</title> <para> - The nixpkgs repository has several utility functions to manipulate Nix - expressions. + The nixpkgs repository has several utility functions to manipulate Nix expressions. </para> <xi:include href="functions/library.xml" /> <xi:include href="functions/overrides.xml" /> diff --git a/nixpkgs/doc/functions/appimagetools.xml b/nixpkgs/doc/functions/appimagetools.xml index e6dbc22f48dd..37e4251cda2e 100644 --- a/nixpkgs/doc/functions/appimagetools.xml +++ b/nixpkgs/doc/functions/appimagetools.xml @@ -5,17 +5,12 @@ <title>pkgs.appimageTools</title> <para> - <varname>pkgs.appimageTools</varname> is a set of functions for extracting - and wrapping <link xlink:href="https://appimage.org/">AppImage</link> files. - They are meant to be used if traditional packaging from source is infeasible, - or it would take too long. To quickly run an AppImage file, - <literal>pkgs.appimage-run</literal> can be used as well. + <varname>pkgs.appimageTools</varname> is a set of functions for extracting and wrapping <link xlink:href="https://appimage.org/">AppImage</link> files. They are meant to be used if traditional packaging from source is infeasible, or it would take too long. To quickly run an AppImage file, <literal>pkgs.appimage-run</literal> can be used as well. </para> <warning> <para> - The <varname>appimageTools</varname> API is unstable and may be subject to - backwards-incompatible changes in the future. + The <varname>appimageTools</varname> API is unstable and may be subject to backwards-incompatible changes in the future. </para> </warning> @@ -23,9 +18,7 @@ <title>AppImage formats</title> <para> - There are different formats for AppImages, see - <link xlink:href="https://github.com/AppImage/AppImageSpec/blob/74ad9ca2f94bf864a4a0dac1f369dd4f00bd1c28/draft.md#image-format">the - specification</link> for details. + There are different formats for AppImages, see <link xlink:href="https://github.com/AppImage/AppImageSpec/blob/74ad9ca2f94bf864a4a0dac1f369dd4f00bd1c28/draft.md#image-format">the specification</link> for details. </para> <itemizedlist> @@ -55,8 +48,7 @@ type2.AppImage: ELF 64-bit LSB executable, x86-64, version 1 (SYSV) (Lepton 3.x) </screen> <para> - Note how the type 1 AppImage is described as an <literal>ISO 9660 CD-ROM - filesystem</literal>, and the type 2 AppImage is not. + Note how the type 1 AppImage is described as an <literal>ISO 9660 CD-ROM filesystem</literal>, and the type 2 AppImage is not. </para> </section> @@ -64,8 +56,7 @@ type2.AppImage: ELF 64-bit LSB executable, x86-64, version 1 (SYSV) (Lepton 3.x) <title>Wrapping</title> <para> - Depending on the type of AppImage you're wrapping, you'll have to use - <varname>wrapType1</varname> or <varname>wrapType2</varname>. + Depending on the type of AppImage you're wrapping, you'll have to use <varname>wrapType1</varname> or <varname>wrapType2</varname>. </para> <programlisting> @@ -91,23 +82,16 @@ appimageTools.wrapType2 { # or wrapType1 </callout> <callout arearefs='ex-appimageTools-wrapping-2'> <para> - <varname>extraPkgs</varname> allows you to pass a function to include - additional packages inside the FHS environment your AppImage is going to - run in. There are a few ways to learn which dependencies an application - needs: + <varname>extraPkgs</varname> allows you to pass a function to include additional packages inside the FHS environment your AppImage is going to run in. There are a few ways to learn which dependencies an application needs: <itemizedlist> <listitem> <para> - Looking through the extracted AppImage files, reading its scripts and - running <command>patchelf</command> and <command>ldd</command> on its - executables. This can also be done in <command>appimage-run</command>, - by setting <command>APPIMAGE_DEBUG_EXEC=bash</command>. + Looking through the extracted AppImage files, reading its scripts and running <command>patchelf</command> and <command>ldd</command> on its executables. This can also be done in <command>appimage-run</command>, by setting <command>APPIMAGE_DEBUG_EXEC=bash</command>. </para> </listitem> <listitem> <para> - Running <command>strace -vfefile</command> on the wrapped executable, - looking for libraries that can't be found. + Running <command>strace -vfefile</command> on the wrapped executable, looking for libraries that can't be found. </para> </listitem> </itemizedlist> diff --git a/nixpkgs/doc/functions/debug.xml b/nixpkgs/doc/functions/debug.xml index c6b3611eea53..c27421f12e76 100644 --- a/nixpkgs/doc/functions/debug.xml +++ b/nixpkgs/doc/functions/debug.xml @@ -5,17 +5,10 @@ <title>Debugging Nix Expressions</title> <para> - Nix is a unityped, dynamic language, this means every value can potentially - appear anywhere. Since it is also non-strict, evaluation order and what - ultimately is evaluated might surprise you. Therefore it is important to be - able to debug nix expressions. + Nix is a unityped, dynamic language, this means every value can potentially appear anywhere. Since it is also non-strict, evaluation order and what ultimately is evaluated might surprise you. Therefore it is important to be able to debug nix expressions. </para> <para> - In the <literal>lib/debug.nix</literal> file you will find a number of - functions that help (pretty-)printing values while evaluation is runnnig. You - can even specify how deep these values should be printed recursively, and - transform them on the fly. Please consult the docstrings in - <literal>lib/debug.nix</literal> for usage information. + In the <literal>lib/debug.nix</literal> file you will find a number of functions that help (pretty-)printing values while evaluation is runnnig. You can even specify how deep these values should be printed recursively, and transform them on the fly. Please consult the docstrings in <literal>lib/debug.nix</literal> for usage information. </para> </section> diff --git a/nixpkgs/doc/functions/dockertools.xml b/nixpkgs/doc/functions/dockertools.xml index a284182bb047..2243453c3e97 100644 --- a/nixpkgs/doc/functions/dockertools.xml +++ b/nixpkgs/doc/functions/dockertools.xml @@ -5,17 +5,12 @@ <title>pkgs.dockerTools</title> <para> - <varname>pkgs.dockerTools</varname> is a set of functions for creating and - manipulating Docker images according to the - <link xlink:href="https://github.com/moby/moby/blob/master/image/spec/v1.2.md#docker-image-specification-v120"> - Docker Image Specification v1.2.0 </link>. Docker itself is not used to - perform any of the operations done by these functions. + <varname>pkgs.dockerTools</varname> is a set of functions for creating and manipulating Docker images according to the <link xlink:href="https://github.com/moby/moby/blob/master/image/spec/v1.2.md#docker-image-specification-v120"> Docker Image Specification v1.2.0 </link>. Docker itself is not used to perform any of the operations done by these functions. </para> <warning> <para> - The <varname>dockerTools</varname> API is unstable and may be subject to - backwards-incompatible changes in the future. + The <varname>dockerTools</varname> API is unstable and may be subject to backwards-incompatible changes in the future. </para> </warning> @@ -23,15 +18,11 @@ <title>buildImage</title> <para> - This function is analogous to the <command>docker build</command> command, - in that it can be used to build a Docker-compatible repository tarball - containing a single image with one or multiple layers. As such, the result - is suitable for being loaded in Docker with <command>docker load</command>. + This function is analogous to the <command>docker build</command> command, in that it can be used to build a Docker-compatible repository tarball containing a single image with one or multiple layers. As such, the result is suitable for being loaded in Docker with <command>docker load</command>. </para> <para> - The parameters of <varname>buildImage</varname> with relative example values - are described below: + The parameters of <varname>buildImage</varname> with relative example values are described below: </para> <example xml:id='ex-dockerTools-buildImage'> @@ -63,135 +54,89 @@ buildImage { </example> <para> - The above example will build a Docker image <literal>redis/latest</literal> - from the given base image. Loading and running this image in Docker results - in <literal>redis-server</literal> being started automatically. + The above example will build a Docker image <literal>redis/latest</literal> from the given base image. Loading and running this image in Docker results in <literal>redis-server</literal> being started automatically. </para> <calloutlist> <callout arearefs='ex-dockerTools-buildImage-1'> <para> - <varname>name</varname> specifies the name of the resulting image. This is - the only required argument for <varname>buildImage</varname>. + <varname>name</varname> specifies the name of the resulting image. This is the only required argument for <varname>buildImage</varname>. </para> </callout> <callout arearefs='ex-dockerTools-buildImage-2'> <para> - <varname>tag</varname> specifies the tag of the resulting image. By - default it's <literal>null</literal>, which indicates that the nix output - hash will be used as tag. + <varname>tag</varname> specifies the tag of the resulting image. By default it's <literal>null</literal>, which indicates that the nix output hash will be used as tag. </para> </callout> <callout arearefs='ex-dockerTools-buildImage-3'> <para> - <varname>fromImage</varname> is the repository tarball containing the base - image. It must be a valid Docker image, such as exported by - <command>docker save</command>. By default it's <literal>null</literal>, - which can be seen as equivalent to <literal>FROM scratch</literal> of a - <filename>Dockerfile</filename>. + <varname>fromImage</varname> is the repository tarball containing the base image. It must be a valid Docker image, such as exported by <command>docker save</command>. By default it's <literal>null</literal>, which can be seen as equivalent to <literal>FROM scratch</literal> of a <filename>Dockerfile</filename>. </para> </callout> <callout arearefs='ex-dockerTools-buildImage-4'> <para> - <varname>fromImageName</varname> can be used to further specify the base - image within the repository, in case it contains multiple images. By - default it's <literal>null</literal>, in which case - <varname>buildImage</varname> will peek the first image available in the - repository. + <varname>fromImageName</varname> can be used to further specify the base image within the repository, in case it contains multiple images. By default it's <literal>null</literal>, in which case <varname>buildImage</varname> will peek the first image available in the repository. </para> </callout> <callout arearefs='ex-dockerTools-buildImage-5'> <para> - <varname>fromImageTag</varname> can be used to further specify the tag of - the base image within the repository, in case an image contains multiple - tags. By default it's <literal>null</literal>, in which case - <varname>buildImage</varname> will peek the first tag available for the - base image. + <varname>fromImageTag</varname> can be used to further specify the tag of the base image within the repository, in case an image contains multiple tags. By default it's <literal>null</literal>, in which case <varname>buildImage</varname> will peek the first tag available for the base image. </para> </callout> <callout arearefs='ex-dockerTools-buildImage-6'> <para> - <varname>contents</varname> is a derivation that will be copied in the new - layer of the resulting image. This can be similarly seen as <command>ADD - contents/ /</command> in a <filename>Dockerfile</filename>. By default - it's <literal>null</literal>. + <varname>contents</varname> is a derivation that will be copied in the new layer of the resulting image. This can be similarly seen as <command>ADD contents/ /</command> in a <filename>Dockerfile</filename>. By default it's <literal>null</literal>. </para> </callout> <callout arearefs='ex-dockerTools-buildImage-runAsRoot'> <para> - <varname>runAsRoot</varname> is a bash script that will run as root in an - environment that overlays the existing layers of the base image with the - new resulting layer, including the previously copied - <varname>contents</varname> derivation. This can be similarly seen as - <command>RUN ...</command> in a <filename>Dockerfile</filename>. + <varname>runAsRoot</varname> is a bash script that will run as root in an environment that overlays the existing layers of the base image with the new resulting layer, including the previously copied <varname>contents</varname> derivation. This can be similarly seen as <command>RUN ...</command> in a <filename>Dockerfile</filename>. <note> <para> - Using this parameter requires the <literal>kvm</literal> device to be - available. + Using this parameter requires the <literal>kvm</literal> device to be available. </para> </note> </para> </callout> <callout arearefs='ex-dockerTools-buildImage-8'> <para> - <varname>config</varname> is used to specify the configuration of the - containers that will be started off the built image in Docker. The - available options are listed in the - <link xlink:href="https://github.com/moby/moby/blob/master/image/spec/v1.2.md#image-json-field-descriptions"> - Docker Image Specification v1.2.0 </link>. + <varname>config</varname> is used to specify the configuration of the containers that will be started off the built image in Docker. The available options are listed in the <link xlink:href="https://github.com/moby/moby/blob/master/image/spec/v1.2.md#image-json-field-descriptions"> Docker Image Specification v1.2.0 </link>. </para> </callout> </calloutlist> <para> - After the new layer has been created, its closure (to which - <varname>contents</varname>, <varname>config</varname> and - <varname>runAsRoot</varname> contribute) will be copied in the layer itself. - Only new dependencies that are not already in the existing layers will be - copied. + After the new layer has been created, its closure (to which <varname>contents</varname>, <varname>config</varname> and <varname>runAsRoot</varname> contribute) will be copied in the layer itself. Only new dependencies that are not already in the existing layers will be copied. </para> <para> - At the end of the process, only one new single layer will be produced and - added to the resulting image. + At the end of the process, only one new single layer will be produced and added to the resulting image. </para> <para> - The resulting repository will only list the single image - <varname>image/tag</varname>. In the case of - <xref linkend='ex-dockerTools-buildImage'/> it would be - <varname>redis/latest</varname>. + The resulting repository will only list the single image <varname>image/tag</varname>. In the case of <xref linkend='ex-dockerTools-buildImage'/> it would be <varname>redis/latest</varname>. </para> <para> - It is possible to inspect the arguments with which an image was built using - its <varname>buildArgs</varname> attribute. + It is possible to inspect the arguments with which an image was built using its <varname>buildArgs</varname> attribute. </para> <note> <para> - If you see errors similar to <literal>getProtocolByName: does not exist (no - such protocol name: tcp)</literal> you may need to add - <literal>pkgs.iana-etc</literal> to <varname>contents</varname>. + If you see errors similar to <literal>getProtocolByName: does not exist (no such protocol name: tcp)</literal> you may need to add <literal>pkgs.iana-etc</literal> to <varname>contents</varname>. </para> </note> <note> <para> - If you see errors similar to <literal>Error_Protocol ("certificate has - unknown CA",True,UnknownCa)</literal> you may need to add - <literal>pkgs.cacert</literal> to <varname>contents</varname>. + If you see errors similar to <literal>Error_Protocol ("certificate has unknown CA",True,UnknownCa)</literal> you may need to add <literal>pkgs.cacert</literal> to <varname>contents</varname>. </para> </note> <example xml:id="example-pkgs-dockerTools-buildImage-creation-date"> <title>Impurely Defining a Docker Layer's Creation Date</title> <para> - By default <function>buildImage</function> will use a static date of one - second past the UNIX Epoch. This allows <function>buildImage</function> to - produce binary reproducible images. When listing images with - <command>docker images</command>, the newly created images will be listed - like this: + By default <function>buildImage</function> will use a static date of one second past the UNIX Epoch. This allows <function>buildImage</function> to produce binary reproducible images. When listing images with <command>docker images</command>, the newly created images will be listed like this: </para> <screen><![CDATA[ $ docker images @@ -199,9 +144,7 @@ REPOSITORY TAG IMAGE ID CREATED SIZE hello latest 08c791c7846e 48 years ago 25.2MB ]]></screen> <para> - You can break binary reproducibility but have a sorted, meaningful - <literal>CREATED</literal> column by setting <literal>created</literal> to - <literal>now</literal>. + You can break binary reproducibility but have a sorted, meaningful <literal>CREATED</literal> column by setting <literal>created</literal> to <literal>now</literal>. </para> <programlisting><![CDATA[ pkgs.dockerTools.buildImage { @@ -214,8 +157,7 @@ pkgs.dockerTools.buildImage { } ]]></programlisting> <para> - and now the Docker CLI will display a reasonable date and sort the images - as expected: + and now the Docker CLI will display a reasonable date and sort the images as expected: <screen><![CDATA[ $ docker images REPOSITORY TAG IMAGE ID CREATED SIZE @@ -230,8 +172,7 @@ hello latest de2bf4786de6 About a minute ago 25.2MB <title>buildLayeredImage</title> <para> - Create a Docker image with many of the store paths being on their own layer - to improve sharing between images. + Create a Docker image with many of the store paths being on their own layer to improve sharing between images. </para> <variablelist> @@ -264,8 +205,7 @@ hello latest de2bf4786de6 About a minute ago 25.2MB </term> <listitem> <para> - Top level paths in the container. Either a single derivation, or a list - of derivations. + Top level paths in the container. Either a single derivation, or a list of derivations. </para> <para> <emphasis>Default:</emphasis> <literal>[]</literal> @@ -278,10 +218,7 @@ hello latest de2bf4786de6 About a minute ago 25.2MB </term> <listitem> <para> - Run-time configuration of the container. A full list of the options are - available at in the - <link xlink:href="https://github.com/moby/moby/blob/master/image/spec/v1.2.md#image-json-field-descriptions"> - Docker Image Specification v1.2.0 </link>. + Run-time configuration of the container. A full list of the options are available at in the <link xlink:href="https://github.com/moby/moby/blob/master/image/spec/v1.2.md#image-json-field-descriptions"> Docker Image Specification v1.2.0 </link>. </para> <para> <emphasis>Default:</emphasis> <literal>{}</literal> @@ -294,9 +231,7 @@ hello latest de2bf4786de6 About a minute ago 25.2MB </term> <listitem> <para> - Date and time the layers were created. Follows the same - <literal>now</literal> exception supported by - <literal>buildImage</literal>. + Date and time the layers were created. Follows the same <literal>now</literal> exception supported by <literal>buildImage</literal>. </para> <para> <emphasis>Default:</emphasis> <literal>1970-01-01T00:00:01Z</literal> @@ -325,10 +260,7 @@ hello latest de2bf4786de6 About a minute ago 25.2MB </term> <listitem> <para> - Shell commands to run while building the final layer, without access - to most of the layer contents. Changes to this layer are "on top" - of all the other layers, so can create additional directories - and files. + Shell commands to run while building the final layer, without access to most of the layer contents. Changes to this layer are "on top" of all the other layers, so can create additional directories and files. </para> </listitem> </varlistentry> @@ -338,8 +270,7 @@ hello latest de2bf4786de6 About a minute ago 25.2MB <title>Behavior of <varname>contents</varname> in the final image</title> <para> - Each path directly listed in <varname>contents</varname> will have a - symlink in the root of the image. + Each path directly listed in <varname>contents</varname> will have a symlink in the root of the image. </para> <para> @@ -350,8 +281,7 @@ pkgs.dockerTools.buildLayeredImage { contents = [ pkgs.hello ]; } ]]></programlisting> - will create symlinks for all the paths in the <literal>hello</literal> - package: + will create symlinks for all the paths in the <literal>hello</literal> package: <screen><![CDATA[ /bin/hello -> /nix/store/h1zb1padqbbb7jicsvkmrym3r6snphxg-hello-2.10/bin/hello /share/info/hello.info -> /nix/store/h1zb1padqbbb7jicsvkmrym3r6snphxg-hello-2.10/share/info/hello.info @@ -364,13 +294,11 @@ pkgs.dockerTools.buildLayeredImage { <title>Automatic inclusion of <varname>config</varname> references</title> <para> - The closure of <varname>config</varname> is automatically included in the - closure of the final image. + The closure of <varname>config</varname> is automatically included in the closure of the final image. </para> <para> - This allows you to make very simple Docker images with very little code. - This container will start up and run <command>hello</command>: + This allows you to make very simple Docker images with very little code. This container will start up and run <command>hello</command>: <programlisting><![CDATA[ pkgs.dockerTools.buildLayeredImage { name = "hello"; @@ -384,31 +312,23 @@ pkgs.dockerTools.buildLayeredImage { <title>Adjusting <varname>maxLayers</varname></title> <para> - Increasing the <varname>maxLayers</varname> increases the number of layers - which have a chance to be shared between different images. + Increasing the <varname>maxLayers</varname> increases the number of layers which have a chance to be shared between different images. </para> <para> - Modern Docker installations support up to 128 layers, however older - versions support as few as 42. + Modern Docker installations support up to 128 layers, however older versions support as few as 42. </para> <para> - If the produced image will not be extended by other Docker builds, it is - safe to set <varname>maxLayers</varname> to <literal>128</literal>. However - it will be impossible to extend the image further. + If the produced image will not be extended by other Docker builds, it is safe to set <varname>maxLayers</varname> to <literal>128</literal>. However it will be impossible to extend the image further. </para> <para> - The first (<literal>maxLayers-2</literal>) most "popular" paths will have - their own individual layers, then layer #<literal>maxLayers-1</literal> - will contain all the remaining "unpopular" paths, and finally layer - #<literal>maxLayers</literal> will contain the Image configuration. + The first (<literal>maxLayers-2</literal>) most "popular" paths will have their own individual layers, then layer #<literal>maxLayers-1</literal> will contain all the remaining "unpopular" paths, and finally layer #<literal>maxLayers</literal> will contain the Image configuration. </para> <para> - Docker's Layers are not inherently ordered, they are content-addressable - and are not explicitly layered until they are composed in to an Image. + Docker's Layers are not inherently ordered, they are content-addressable and are not explicitly layered until they are composed in to an Image. </para> </section> </section> @@ -417,10 +337,7 @@ pkgs.dockerTools.buildLayeredImage { <title>pullImage</title> <para> - This function is analogous to the <command>docker pull</command> command, in - that it can be used to pull a Docker image from a Docker registry. By - default <link xlink:href="https://hub.docker.com/">Docker Hub</link> is used - to pull images. + This function is analogous to the <command>docker pull</command> command, in that it can be used to pull a Docker image from a Docker registry. By default <link xlink:href="https://hub.docker.com/">Docker Hub</link> is used to pull images. </para> <para> @@ -445,76 +362,51 @@ pullImage { <calloutlist> <callout arearefs='ex-dockerTools-pullImage-1'> <para> - <varname>imageName</varname> specifies the name of the image to be - downloaded, which can also include the registry namespace (e.g. - <literal>nixos</literal>). This argument is required. + <varname>imageName</varname> specifies the name of the image to be downloaded, which can also include the registry namespace (e.g. <literal>nixos</literal>). This argument is required. </para> </callout> <callout arearefs='ex-dockerTools-pullImage-2'> <para> - <varname>imageDigest</varname> specifies the digest of the image to be - downloaded. This argument is required. + <varname>imageDigest</varname> specifies the digest of the image to be downloaded. This argument is required. </para> </callout> <callout arearefs='ex-dockerTools-pullImage-3'> <para> - <varname>finalImageName</varname>, if specified, this is the name of the - image to be created. Note it is never used to fetch the image since we - prefer to rely on the immutable digest ID. By default it's equal to - <varname>imageName</varname>. + <varname>finalImageName</varname>, if specified, this is the name of the image to be created. Note it is never used to fetch the image since we prefer to rely on the immutable digest ID. By default it's equal to <varname>imageName</varname>. </para> </callout> <callout arearefs='ex-dockerTools-pullImage-4'> <para> - <varname>finalImageTag</varname>, if specified, this is the tag of the - image to be created. Note it is never used to fetch the image since we - prefer to rely on the immutable digest ID. By default it's - <literal>latest</literal>. + <varname>finalImageTag</varname>, if specified, this is the tag of the image to be created. Note it is never used to fetch the image since we prefer to rely on the immutable digest ID. By default it's <literal>latest</literal>. </para> </callout> <callout arearefs='ex-dockerTools-pullImage-5'> <para> - <varname>sha256</varname> is the checksum of the whole fetched image. This - argument is required. + <varname>sha256</varname> is the checksum of the whole fetched image. This argument is required. </para> </callout> <callout arearefs='ex-dockerTools-pullImage-6'> <para> - <varname>os</varname>, if specified, is the operating system of the - fetched image. By default it's <literal>linux</literal>. + <varname>os</varname>, if specified, is the operating system of the fetched image. By default it's <literal>linux</literal>. </para> </callout> <callout arearefs='ex-dockerTools-pullImage-7'> <para> - <varname>arch</varname>, if specified, is the cpu architecture of the - fetched image. By default it's <literal>x86_64</literal>. + <varname>arch</varname>, if specified, is the cpu architecture of the fetched image. By default it's <literal>x86_64</literal>. </para> </callout> </calloutlist> <para> - <literal>nix-prefetch-docker</literal> command can be used to get required - image parameters: - + <literal>nix-prefetch-docker</literal> command can be used to get required image parameters: <screen> <prompt>$ </prompt>nix run nixpkgs.nix-prefetch-docker -c nix-prefetch-docker --image-name mysql --image-tag 5 </screen> - - Since a given <varname>imageName</varname> may transparently refer to a - manifest list of images which support multiple architectures and/or - operating systems, you can supply the <option>--os</option> and - <option>--arch</option> arguments to specify exactly which image you want. - By default it will match the OS and architecture of the host the command is - run on. - + Since a given <varname>imageName</varname> may transparently refer to a manifest list of images which support multiple architectures and/or operating systems, you can supply the <option>--os</option> and <option>--arch</option> arguments to specify exactly which image you want. By default it will match the OS and architecture of the host the command is run on. <screen> <prompt>$ </prompt>nix-prefetch-docker --image-name mysql --image-tag 5 --arch x86_64 --os linux </screen> - - Desired image name and tag can be set using - <option>--final-image-name</option> and <option>--final-image-tag</option> - arguments: - + Desired image name and tag can be set using <option>--final-image-name</option> and <option>--final-image-tag</option> arguments: <screen> <prompt>$ </prompt>nix-prefetch-docker --image-name mysql --image-tag 5 --final-image-name eu.gcr.io/my-project/mysql --final-image-tag prod </screen> @@ -525,17 +417,12 @@ pullImage { <title>exportImage</title> <para> - This function is analogous to the <command>docker export</command> command, - in that it can be used to flatten a Docker image that contains multiple - layers. It is in fact the result of the merge of all the layers of the - image. As such, the result is suitable for being imported in Docker with - <command>docker import</command>. + This function is analogous to the <command>docker export</command> command, in that it can be used to flatten a Docker image that contains multiple layers. It is in fact the result of the merge of all the layers of the image. As such, the result is suitable for being imported in Docker with <command>docker import</command>. </para> <note> <para> - Using this function requires the <literal>kvm</literal> device to be - available. + Using this function requires the <literal>kvm</literal> device to be available. </para> </note> @@ -557,14 +444,11 @@ exportImage { </example> <para> - The parameters relative to the base image have the same synopsis as - described in <xref linkend='ssec-pkgs-dockerTools-buildImage'/>, except that - <varname>fromImage</varname> is the only required argument in this case. + The parameters relative to the base image have the same synopsis as described in <xref linkend='ssec-pkgs-dockerTools-buildImage'/>, except that <varname>fromImage</varname> is the only required argument in this case. </para> <para> - The <varname>name</varname> argument is the name of the derivation output, - which defaults to <varname>fromImage.name</varname>. + The <varname>name</varname> argument is the name of the derivation output, which defaults to <varname>fromImage.name</varname>. </para> </section> @@ -572,11 +456,7 @@ exportImage { <title>shadowSetup</title> <para> - This constant string is a helper for setting up the base files for managing - users and groups, only if such files don't exist already. It is suitable for - being used in a <varname>runAsRoot</varname> - <xref linkend='ex-dockerTools-buildImage-runAsRoot'/> script for cases like - in the example below: + This constant string is a helper for setting up the base files for managing users and groups, only if such files don't exist already. It is suitable for being used in a <varname>runAsRoot</varname> <xref linkend='ex-dockerTools-buildImage-runAsRoot'/> script for cases like in the example below: </para> <example xml:id='ex-dockerTools-shadowSetup'> @@ -598,9 +478,7 @@ buildImage { </example> <para> - Creating base files like <literal>/etc/passwd</literal> or - <literal>/etc/login.defs</literal> is necessary for shadow-utils to - manipulate users and groups. + Creating base files like <literal>/etc/passwd</literal> or <literal>/etc/login.defs</literal> is necessary for shadow-utils to manipulate users and groups. </para> </section> </section> diff --git a/nixpkgs/doc/functions/fetchers.xml b/nixpkgs/doc/functions/fetchers.xml index a736008c9d41..369c1fb153eb 100644 --- a/nixpkgs/doc/functions/fetchers.xml +++ b/nixpkgs/doc/functions/fetchers.xml @@ -5,18 +5,11 @@ <title>Fetcher functions</title> <para> - When using Nix, you will frequently need to download source code and other - files from the internet. Nixpkgs comes with a few helper functions that allow - you to fetch fixed-output derivations in a structured way. + When using Nix, you will frequently need to download source code and other files from the internet. Nixpkgs comes with a few helper functions that allow you to fetch fixed-output derivations in a structured way. </para> <para> - The two fetcher primitives are <function>fetchurl</function> and - <function>fetchzip</function>. Both of these have two required arguments, a - URL and a hash. The hash is typically <literal>sha256</literal>, although - many more hash algorithms are supported. Nixpkgs contributors are currently - recommended to use <literal>sha256</literal>. This hash will be used by Nix - to identify your source. A typical usage of fetchurl is provided below. + The two fetcher primitives are <function>fetchurl</function> and <function>fetchzip</function>. Both of these have two required arguments, a URL and a hash. The hash is typically <literal>sha256</literal>, although many more hash algorithms are supported. Nixpkgs contributors are currently recommended to use <literal>sha256</literal>. This hash will be used by Nix to identify your source. A typical usage of fetchurl is provided below. </para> <programlisting><![CDATA[ @@ -32,30 +25,15 @@ stdenv.mkDerivation { ]]></programlisting> <para> - The main difference between <function>fetchurl</function> and - <function>fetchzip</function> is in how they store the contents. - <function>fetchurl</function> will store the unaltered contents of the URL - within the Nix store. <function>fetchzip</function> on the other hand will - decompress the archive for you, making files and directories directly - accessible in the future. <function>fetchzip</function> can only be used with - archives. Despite the name, <function>fetchzip</function> is not limited to - .zip files and can also be used with any tarball. + The main difference between <function>fetchurl</function> and <function>fetchzip</function> is in how they store the contents. <function>fetchurl</function> will store the unaltered contents of the URL within the Nix store. <function>fetchzip</function> on the other hand will decompress the archive for you, making files and directories directly accessible in the future. <function>fetchzip</function> can only be used with archives. Despite the name, <function>fetchzip</function> is not limited to .zip files and can also be used with any tarball. </para> <para> - <function>fetchpatch</function> works very similarly to - <function>fetchurl</function> with the same arguments expected. It expects - patch files as a source and and performs normalization on them before - computing the checksum. For example it will remove comments or other unstable - parts that are sometimes added by version control systems and can change over - time. + <function>fetchpatch</function> works very similarly to <function>fetchurl</function> with the same arguments expected. It expects patch files as a source and and performs normalization on them before computing the checksum. For example it will remove comments or other unstable parts that are sometimes added by version control systems and can change over time. </para> <para> - Other fetcher functions allow you to add source code directly from a VCS such - as subversion or git. These are mostly straightforward names based on the - name of the command used with the VCS system. Because they give you a working - repository, they act most like <function>fetchzip</function>. + Other fetcher functions allow you to add source code directly from a VCS such as subversion or git. These are mostly straightforward names based on the name of the command used with the VCS system. Because they give you a working repository, they act most like <function>fetchzip</function>. </para> <variablelist> @@ -65,8 +43,7 @@ stdenv.mkDerivation { </term> <listitem> <para> - Used with Subversion. Expects <literal>url</literal> to a Subversion - directory, <literal>rev</literal>, and <literal>sha256</literal>. + Used with Subversion. Expects <literal>url</literal> to a Subversion directory, <literal>rev</literal>, and <literal>sha256</literal>. </para> </listitem> </varlistentry> @@ -76,10 +53,7 @@ stdenv.mkDerivation { </term> <listitem> <para> - Used with Git. Expects <literal>url</literal> to a Git repo, - <literal>rev</literal>, and <literal>sha256</literal>. - <literal>rev</literal> in this case can be full the git commit id (SHA1 - hash) or a tag name like <literal>refs/tags/v1.0</literal>. + Used with Git. Expects <literal>url</literal> to a Git repo, <literal>rev</literal>, and <literal>sha256</literal>. <literal>rev</literal> in this case can be full the git commit id (SHA1 hash) or a tag name like <literal>refs/tags/v1.0</literal>. </para> </listitem> </varlistentry> @@ -89,8 +63,7 @@ stdenv.mkDerivation { </term> <listitem> <para> - Used with Fossil. Expects <literal>url</literal> to a Fossil archive, - <literal>rev</literal>, and <literal>sha256</literal>. + Used with Fossil. Expects <literal>url</literal> to a Fossil archive, <literal>rev</literal>, and <literal>sha256</literal>. </para> </listitem> </varlistentry> @@ -100,8 +73,7 @@ stdenv.mkDerivation { </term> <listitem> <para> - Used with CVS. Expects <literal>cvsRoot</literal>, <literal>tag</literal>, - and <literal>sha256</literal>. + Used with CVS. Expects <literal>cvsRoot</literal>, <literal>tag</literal>, and <literal>sha256</literal>. </para> </listitem> </varlistentry> @@ -111,18 +83,14 @@ stdenv.mkDerivation { </term> <listitem> <para> - Used with Mercurial. Expects <literal>url</literal>, - <literal>rev</literal>, and <literal>sha256</literal>. + Used with Mercurial. Expects <literal>url</literal>, <literal>rev</literal>, and <literal>sha256</literal>. </para> </listitem> </varlistentry> </variablelist> <para> - A number of fetcher functions wrap part of <function>fetchurl</function> and - <function>fetchzip</function>. They are mainly convenience functions intended - for commonly used destinations of source code in Nixpkgs. These wrapper - fetchers are listed below. + A number of fetcher functions wrap part of <function>fetchurl</function> and <function>fetchzip</function>. They are mainly convenience functions intended for commonly used destinations of source code in Nixpkgs. These wrapper fetchers are listed below. </para> <variablelist> @@ -132,17 +100,7 @@ stdenv.mkDerivation { </term> <listitem> <para> - <function>fetchFromGitHub</function> expects four arguments. - <literal>owner</literal> is a string corresponding to the GitHub user or - organization that controls this repository. <literal>repo</literal> - corresponds to the name of the software repository. These are located at - the top of every GitHub HTML page as - <literal>owner</literal>/<literal>repo</literal>. <literal>rev</literal> - corresponds to the Git commit hash or tag (e.g <literal>v1.0</literal>) - that will be downloaded from Git. Finally, <literal>sha256</literal> - corresponds to the hash of the extracted directory. Again, other hash - algorithms are also available but <literal>sha256</literal> is currently - preferred. + <function>fetchFromGitHub</function> expects four arguments. <literal>owner</literal> is a string corresponding to the GitHub user or organization that controls this repository. <literal>repo</literal> corresponds to the name of the software repository. These are located at the top of every GitHub HTML page as <literal>owner</literal>/<literal>repo</literal>. <literal>rev</literal> corresponds to the Git commit hash or tag (e.g <literal>v1.0</literal>) that will be downloaded from Git. Finally, <literal>sha256</literal> corresponds to the hash of the extracted directory. Again, other hash algorithms are also available but <literal>sha256</literal> is currently preferred. </para> </listitem> </varlistentry> @@ -152,8 +110,7 @@ stdenv.mkDerivation { </term> <listitem> <para> - This is used with GitLab repositories. The arguments expected are very - similar to fetchFromGitHub above. + This is used with GitLab repositories. The arguments expected are very similar to fetchFromGitHub above. </para> </listitem> </varlistentry> @@ -163,8 +120,7 @@ stdenv.mkDerivation { </term> <listitem> <para> - This is used with BitBucket repositories. The arguments expected are very - similar to fetchFromGitHub above. + This is used with BitBucket repositories. The arguments expected are very similar to fetchFromGitHub above. </para> </listitem> </varlistentry> @@ -174,8 +130,7 @@ stdenv.mkDerivation { </term> <listitem> <para> - This is used with Savannah repositories. The arguments expected are very - similar to fetchFromGitHub above. + This is used with Savannah repositories. The arguments expected are very similar to fetchFromGitHub above. </para> </listitem> </varlistentry> @@ -185,8 +140,7 @@ stdenv.mkDerivation { </term> <listitem> <para> - This is used with repo.or.cz repositories. The arguments expected are very - similar to fetchFromGitHub above. + This is used with repo.or.cz repositories. The arguments expected are very similar to fetchFromGitHub above. </para> </listitem> </varlistentry> diff --git a/nixpkgs/doc/functions/fhs-environments.xml b/nixpkgs/doc/functions/fhs-environments.xml index 79682080be31..e7b81e97a23f 100644 --- a/nixpkgs/doc/functions/fhs-environments.xml +++ b/nixpkgs/doc/functions/fhs-environments.xml @@ -5,15 +5,7 @@ <title>buildFHSUserEnv</title> <para> - <function>buildFHSUserEnv</function> provides a way to build and run - FHS-compatible lightweight sandboxes. It creates an isolated root with bound - <filename>/nix/store</filename>, so its footprint in terms of disk space - needed is quite small. This allows one to run software which is hard or - unfeasible to patch for NixOS -- 3rd-party source trees with FHS assumptions, - games distributed as tarballs, software with integrity checking and/or - external self-updated binaries. It uses Linux namespaces feature to create - temporary lightweight environments which are destroyed after all child - processes exit, without root user rights requirement. Accepted arguments are: + <function>buildFHSUserEnv</function> provides a way to build and run FHS-compatible lightweight sandboxes. It creates an isolated root with bound <filename>/nix/store</filename>, so its footprint in terms of disk space needed is quite small. This allows one to run software which is hard or unfeasible to patch for NixOS -- 3rd-party source trees with FHS assumptions, games distributed as tarballs, software with integrity checking and/or external self-updated binaries. It uses Linux namespaces feature to create temporary lightweight environments which are destroyed after all child processes exit, without root user rights requirement. Accepted arguments are: </para> <variablelist> @@ -33,8 +25,7 @@ </term> <listitem> <para> - 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. + 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> @@ -44,9 +35,7 @@ </term> <listitem> <para> - 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. + 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> @@ -66,8 +55,7 @@ </term> <listitem> <para> - Like <literal>extraBuildCommands</literal>, but executed only on multilib - architectures. + Like <literal>extraBuildCommands</literal>, but executed only on multilib architectures. </para> </listitem> </varlistentry> @@ -77,8 +65,7 @@ </term> <listitem> <para> - Additional derivation outputs to be linked for both target and - multi-architecture packages. + Additional derivation outputs to be linked for both target and multi-architecture packages. </para> </listitem> </varlistentry> @@ -88,8 +75,7 @@ </term> <listitem> <para> - Additional commands to be executed for finalizing the derivation with - runner script. + Additional commands to be executed for finalizing the derivation with runner script. </para> </listitem> </varlistentry> @@ -99,16 +85,14 @@ </term> <listitem> <para> - A command that would be executed inside the sandbox and passed all the - command line arguments. It defaults to <literal>bash</literal>. + 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> </variablelist> <para> - One can create a simple environment using a <literal>shell.nix</literal> like - that: + One can create a simple environment using a <literal>shell.nix</literal> like that: </para> <programlisting><![CDATA[ @@ -133,10 +117,6 @@ ]]></programlisting> <para> - Running <literal>nix-shell</literal> would then drop you into a shell with - these libraries and binaries available. You can use this to run closed-source - applications which expect FHS structure without hassles: simply change - <literal>runScript</literal> to the application path, e.g. - <filename>./bin/start.sh</filename> -- relative paths are supported. + Running <literal>nix-shell</literal> would then drop you into a shell with these libraries and binaries available. You can use this to run closed-source applications which expect FHS structure without hassles: simply change <literal>runScript</literal> to the application path, e.g. <filename>./bin/start.sh</filename> -- relative paths are supported. </para> </section> diff --git a/nixpkgs/doc/functions/generators.xml b/nixpkgs/doc/functions/generators.xml index e860b10e8979..9ce1f85eb173 100644 --- a/nixpkgs/doc/functions/generators.xml +++ b/nixpkgs/doc/functions/generators.xml @@ -5,28 +5,15 @@ <title>Generators</title> <para> - Generators are functions that create file formats from nix data structures, - e. g. for configuration files. There are generators available for: - <literal>INI</literal>, <literal>JSON</literal> and <literal>YAML</literal> + Generators are functions that create file formats from nix data structures, e. g. for configuration files. There are generators available for: <literal>INI</literal>, <literal>JSON</literal> and <literal>YAML</literal> </para> <para> - All generators follow a similar call interface: <code>generatorName - configFunctions data</code>, where <literal>configFunctions</literal> is an - attrset of user-defined functions that format nested parts of the content. - They each have common defaults, so often they do not need to be set manually. - An example is <code>mkSectionName ? (name: libStr.escape [ "[" "]" ] - name)</code> from the <literal>INI</literal> generator. It receives the name - of a section and sanitizes it. The default <literal>mkSectionName</literal> - escapes <literal>[</literal> and <literal>]</literal> with a backslash. + All generators follow a similar call interface: <code>generatorName configFunctions data</code>, where <literal>configFunctions</literal> is an attrset of user-defined functions that format nested parts of the content. They each have common defaults, so often they do not need to be set manually. An example is <code>mkSectionName ? (name: libStr.escape [ "[" "]" ] name)</code> from the <literal>INI</literal> generator. It receives the name of a section and sanitizes it. The default <literal>mkSectionName</literal> escapes <literal>[</literal> and <literal>]</literal> with a backslash. </para> <para> - Generators can be fine-tuned to produce exactly the file format required by - your application/service. One example is an INI-file format which uses - <literal>: </literal> as separator, the strings - <literal>"yes"</literal>/<literal>"no"</literal> as boolean values and - requires all string values to be quoted: + Generators can be fine-tuned to produce exactly the file format required by your application/service. One example is an INI-file format which uses <literal>: </literal> as separator, the strings <literal>"yes"</literal>/<literal>"no"</literal> as boolean values and requires all string values to be quoted: </para> <programlisting> @@ -77,13 +64,11 @@ merge:"diff3" <note> <para> - Nix store paths can be converted to strings by enclosing a derivation - attribute like so: <code>"${drv}"</code>. + Nix store paths can be converted to strings by enclosing a derivation attribute like so: <code>"${drv}"</code>. </para> </note> <para> - Detailed documentation for each generator can be found in - <literal>lib/generators.nix</literal>. + Detailed documentation for each generator can be found in <literal>lib/generators.nix</literal>. </para> </section> diff --git a/nixpkgs/doc/functions/library.xml b/nixpkgs/doc/functions/library.xml index e6aedaa6efdd..6ffb944b5a60 100644 --- a/nixpkgs/doc/functions/library.xml +++ b/nixpkgs/doc/functions/library.xml @@ -5,8 +5,7 @@ <title>Nixpkgs Library Functions</title> <para> - Nixpkgs provides a standard library at <varname>pkgs.lib</varname>, or - through <code>import <nixpkgs/lib></code>. + Nixpkgs provides a standard library at <varname>pkgs.lib</varname>, or through <code>import <nixpkgs/lib></code>. </para> <xi:include href="./library/asserts.xml" /> diff --git a/nixpkgs/doc/functions/library/asserts.xml b/nixpkgs/doc/functions/library/asserts.xml index 437850e408bc..10891039e869 100644 --- a/nixpkgs/doc/functions/library/asserts.xml +++ b/nixpkgs/doc/functions/library/asserts.xml @@ -27,8 +27,7 @@ </term> <listitem> <para> - Condition under which the <varname>msg</varname> should - <emphasis>not</emphasis> be printed. + Condition under which the <varname>msg</varname> should <emphasis>not</emphasis> be printed. </para> </listitem> </varlistentry> @@ -64,9 +63,7 @@ stderr> assert failed <xi:include href="./locations.xml" xpointer="lib.asserts.assertOneOf" /> <para> - Specialized <function>asserts.assertMsg</function> for checking if - <varname>val</varname> is one of the elements of <varname>xs</varname>. - Useful for checking enums. + Specialized <function>asserts.assertMsg</function> for checking if <varname>val</varname> is one of the elements of <varname>xs</varname>. Useful for checking enums. </para> <variablelist> @@ -76,8 +73,7 @@ stderr> assert failed </term> <listitem> <para> - The name of the variable the user entered <varname>val</varname> into, - for inclusion in the error message. + The name of the variable the user entered <varname>val</varname> into, for inclusion in the error message. </para> </listitem> </varlistentry> @@ -87,8 +83,7 @@ stderr> assert failed </term> <listitem> <para> - The value of what the user provided, to be compared against the values in - <varname>xs</varname>. + The value of what the user provided, to be compared against the values in <varname>xs</varname>. </para> </listitem> </varlistentry> diff --git a/nixpkgs/doc/functions/library/attrsets.xml b/nixpkgs/doc/functions/library/attrsets.xml index 65d0b40e2e82..f9234069392e 100644 --- a/nixpkgs/doc/functions/library/attrsets.xml +++ b/nixpkgs/doc/functions/library/attrsets.xml @@ -23,8 +23,7 @@ </term> <listitem> <para> - A list of strings representing the path through the nested attribute set - <varname>set</varname>. + A list of strings representing the path through the nested attribute set <varname>set</varname>. </para> </listitem> </varlistentry> @@ -34,8 +33,7 @@ </term> <listitem> <para> - Default value if <varname>attrPath</varname> does not resolve to an - existing value. + Default value if <varname>attrPath</varname> does not resolve to an existing value. </para> </listitem> </varlistentry> @@ -88,8 +86,7 @@ lib.attrsets.attrByPath [ "a" "b" ] 0 {} </term> <listitem> <para> - A list of strings representing the path through the nested attribute set - <varname>set</varname>. + A list of strings representing the path through the nested attribute set <varname>set</varname>. </para> </listitem> </varlistentry> @@ -125,8 +122,7 @@ lib.attrsets.hasAttrByPath <xi:include href="./locations.xml" xpointer="lib.attrsets.setAttrByPath" /> <para> - Create a new attribute set with <varname>value</varname> set at the nested - attribute location specified in <varname>attrPath</varname>. + Create a new attribute set with <varname>value</varname> set at the nested attribute location specified in <varname>attrPath</varname>. </para> <variablelist> @@ -146,8 +142,7 @@ lib.attrsets.hasAttrByPath </term> <listitem> <para> - The value to set at the location described by - <varname>attrPath</varname>. + The value to set at the location described by <varname>attrPath</varname>. </para> </listitem> </varlistentry> @@ -171,8 +166,7 @@ lib.attrsets.setAttrByPath [ "a" "b" ] 3 <xi:include href="./locations.xml" xpointer="lib.attrsets.getAttrFromPath" /> <para> - Like <xref linkend="function-library-lib.attrsets.attrByPath" /> except - without a default, and it will throw if the value doesn't exist. + Like <xref linkend="function-library-lib.attrsets.attrByPath" /> except without a default, and it will throw if the value doesn't exist. </para> <variablelist> @@ -182,8 +176,7 @@ lib.attrsets.setAttrByPath [ "a" "b" ] 3 </term> <listitem> <para> - A list of strings representing the path through the nested attribute set - <varname>set</varname>. + A list of strings representing the path through the nested attribute set <varname>set</varname>. </para> </listitem> </varlistentry> @@ -235,8 +228,7 @@ lib.attrsets.getAttrFromPath [ "x" "y" ] { } </term> <listitem> <para> - The list of attributes to fetch from <varname>set</varname>. Each - attribute name must exist on the attrbitue set. + The list of attributes to fetch from <varname>set</varname>. Each attribute name must exist on the attrbitue set. </para> </listitem> </varlistentry> @@ -282,8 +274,7 @@ error: attribute 'd' missing </para> <para> - Provides a backwards-compatible interface of - <function>builtins.attrValues</function> for Nix version older than 1.8. + Provides a backwards-compatible interface of <function>builtins.attrValues</function> for Nix version older than 1.8. </para> <variablelist> @@ -317,14 +308,11 @@ lib.attrsets.attrValues { a = 1; b = 2; c = 3; } <xi:include href="./locations.xml" xpointer="lib.attrsets.catAttrs" /> <para> - Collect each attribute named `attr' from the list of attribute sets, - <varname>sets</varname>. Sets that don't contain the named attribute are - ignored. + Collect each attribute named `attr' from the list of attribute sets, <varname>sets</varname>. Sets that don't contain the named attribute are ignored. </para> <para> - Provides a backwards-compatible interface of - <function>builtins.catAttrs</function> for Nix version older than 1.9. + Provides a backwards-compatible interface of <function>builtins.catAttrs</function> for Nix version older than 1.9. </para> <variablelist> @@ -334,8 +322,7 @@ lib.attrsets.attrValues { a = 1; b = 2; c = 3; } </term> <listitem> <para> - Attribute name to select from each attribute set in - <varname>sets</varname>. + Attribute name to select from each attribute set in <varname>sets</varname>. </para> </listitem> </varlistentry> @@ -372,8 +359,7 @@ catAttrs "a" [{a = 1;} {b = 0;} {a = 2;}] <xi:include href="./locations.xml" xpointer="lib.attrsets.filterAttrs" /> <para> - Filter an attribute set by removing all attributes for which the given - predicate return false. + Filter an attribute set by removing all attributes for which the given predicate return false. </para> <variablelist> @@ -386,8 +372,7 @@ catAttrs "a" [{a = 1;} {b = 0;} {a = 2;}] <literal>String -> Any -> Bool</literal> </para> <para> - Predicate which returns true to include an attribute, or returns false to - exclude it. + Predicate which returns true to include an attribute, or returns false to exclude it. </para> <variablelist> <varlistentry> @@ -412,8 +397,7 @@ catAttrs "a" [{a = 1;} {b = 0;} {a = 2;}] </varlistentry> </variablelist> <para> - Returns <literal>true</literal> to include the attribute, - <literal>false</literal> to exclude the attribute. + Returns <literal>true</literal> to include the attribute, <literal>false</literal> to exclude the attribute. </para> </listitem> </varlistentry> @@ -447,8 +431,7 @@ filterAttrs (n: v: n == "foo") { foo = 1; bar = 2; } <xi:include href="./locations.xml" xpointer="lib.attrsets.filterAttrsRecursive" /> <para> - Filter an attribute set recursively by removing all attributes for which the - given predicate return false. + Filter an attribute set recursively by removing all attributes for which the given predicate return false. </para> <variablelist> @@ -461,8 +444,7 @@ filterAttrs (n: v: n == "foo") { foo = 1; bar = 2; } <literal>String -> Any -> Bool</literal> </para> <para> - Predicate which returns true to include an attribute, or returns false to - exclude it. + Predicate which returns true to include an attribute, or returns false to exclude it. </para> <variablelist> <varlistentry> @@ -487,8 +469,7 @@ filterAttrs (n: v: n == "foo") { foo = 1; bar = 2; } </varlistentry> </variablelist> <para> - Returns <literal>true</literal> to include the attribute, - <literal>false</literal> to exclude the attribute. + Returns <literal>true</literal> to include the attribute, <literal>false</literal> to exclude the attribute. </para> </listitem> </varlistentry> @@ -557,8 +538,7 @@ lib.attrsets.filterAttrsRecursive <literal>Any -> Any -> Any</literal> </para> <para> - Given a value <varname>val</varname> and a collector - <varname>col</varname>, combine the two. + Given a value <varname>val</varname> and a collector <varname>col</varname>, combine the two. </para> <variablelist> <varlistentry> @@ -578,8 +558,7 @@ lib.attrsets.filterAttrsRecursive <listitem> <!-- TODO: make this not bad, use more fold-ey terms --> <para> - The result of previous <function>op</function> calls with other values - and <function>nul</function>. + The result of previous <function>op</function> calls with other values and <function>nul</function>. </para> </listitem> </varlistentry> @@ -632,9 +611,7 @@ lib.attrsets.foldAttrs <xi:include href="./locations.xml" xpointer="lib.attrsets.collect" /> <para> - Recursively collect sets that verify a given predicate named - <varname>pred</varname> from the set <varname>attrs</varname>. The recursion - stops when <varname>pred</varname> returns <literal>true</literal>. + Recursively collect sets that verify a given predicate named <varname>pred</varname> from the set <varname>attrs</varname>. The recursion stops when <varname>pred</varname> returns <literal>true</literal>. </para> <variablelist> @@ -702,8 +679,7 @@ collect (x: x ? outPath) <xi:include href="./locations.xml" xpointer="lib.attrsets.nameValuePair" /> <para> - Utility function that creates a <literal>{name, value}</literal> pair as - expected by <function>builtins.listToAttrs</function>. + Utility function that creates a <literal>{name, value}</literal> pair as expected by <function>builtins.listToAttrs</function>. </para> <variablelist> @@ -747,13 +723,11 @@ nameValuePair "some" 6 <xi:include href="./locations.xml" xpointer="lib.attrsets.mapAttrs" /> <para> - Apply a function to each element in an attribute set, creating a new - attribute set. + Apply a function to each element in an attribute set, creating a new attribute set. </para> <para> - Provides a backwards-compatible interface of - <function>builtins.mapAttrs</function> for Nix version older than 2.1. + Provides a backwards-compatible interface of <function>builtins.mapAttrs</function> for Nix version older than 2.1. </para> <variablelist> @@ -814,9 +788,7 @@ lib.attrsets.mapAttrs <xi:include href="./locations.xml" xpointer="lib.attrsets.mapAttrs-prime" /> <para> - Like <function>mapAttrs</function>, but allows the name of each attribute to - be changed in addition to the value. The applied function should return both - the new name and value as a <function>nameValuePair</function>. + Like <function>mapAttrs</function>, but allows the name of each attribute to be changed in addition to the value. The applied function should return both the new name and value as a <function>nameValuePair</function>. </para> <variablelist> @@ -829,10 +801,8 @@ lib.attrsets.mapAttrs <literal>String -> Any -> { name = String; value = Any }</literal> </para> <para> - Given an attribute's name and value, return a new - <link - linkend="function-library-lib.attrsets.nameValuePair">name - value pair</link>. + Given an attribute's name and value, return a new <link + linkend="function-library-lib.attrsets.nameValuePair">name value pair</link>. </para> <variablelist> <varlistentry> @@ -891,8 +861,7 @@ lib.attrsets.mapAttrs' (name: value: lib.attrsets.nameValuePair ("foo_" + name) <xi:include href="./locations.xml" xpointer="lib.attrsets.mapAttrsToList" /> <para> - Call <varname>fn</varname> for each attribute in the given - <varname>set</varname> and return the result in a list. + Call <varname>fn</varname> for each attribute in the given <varname>set</varname> and return the result in a list. </para> <variablelist> @@ -962,9 +931,7 @@ lib.attrsets.mapAttrsToList (name: value: "${name}=${value}") <xi:include href="./locations.xml" xpointer="lib.attrsets.mapAttrsRecursive" /> <para> - Like <function>mapAttrs</function>, except that it recursively applies - itself to attribute sets. Also, the first argument of the argument function - is a <emphasis>list</emphasis> of the names of the containing attributes. + Like <function>mapAttrs</function>, except that it recursively applies itself to attribute sets. Also, the first argument of the argument function is a <emphasis>list</emphasis> of the names of the containing attributes. </para> <variablelist> @@ -989,10 +956,7 @@ lib.attrsets.mapAttrsToList (name: value: "${name}=${value}") The list of attribute names to this value. </para> <para> - For example, the <varname>name_path</varname> for the - <literal>example</literal> string in the attribute set <literal>{ foo - = { bar = "example"; }; }</literal> is <literal>[ "foo" "bar" - ]</literal>. + For example, the <varname>name_path</varname> for the <literal>example</literal> string in the attribute set <literal>{ foo = { bar = "example"; }; }</literal> is <literal>[ "foo" "bar" ]</literal>. </para> </listitem> </varlistentry> @@ -1059,11 +1023,7 @@ mapAttrsRecursive <xi:include href="./locations.xml" xpointer="lib.attrsets.mapAttrsRecursiveCond" /> <para> - Like <function>mapAttrsRecursive</function>, but it takes an additional - predicate function that tells it whether to recursive into an attribute set. - If it returns false, <function>mapAttrsRecursiveCond</function> does not - recurse, but does apply the map function. It is returns true, it does - recurse, and does not apply the map function. + Like <function>mapAttrsRecursive</function>, but it takes an additional predicate function that tells it whether to recursive into an attribute set. If it returns false, <function>mapAttrsRecursiveCond</function> does not recurse, but does apply the map function. It is returns true, it does recurse, and does not apply the map function. </para> <variablelist> @@ -1076,8 +1036,7 @@ mapAttrsRecursive <literal>(AttrSet -> Bool)</literal> </para> <para> - Determine if <function>mapAttrsRecursive</function> should recurse deeper - in to the attribute set. + Determine if <function>mapAttrsRecursive</function> should recurse deeper in to the attribute set. </para> <variablelist> <varlistentry> @@ -1114,10 +1073,7 @@ mapAttrsRecursive The list of attribute names to this value. </para> <para> - For example, the <varname>name_path</varname> for the - <literal>example</literal> string in the attribute set <literal>{ foo - = { bar = "example"; }; }</literal> is <literal>[ "foo" "bar" - ]</literal>. + For example, the <varname>name_path</varname> for the <literal>example</literal> string in the attribute set <literal>{ foo = { bar = "example"; }; }</literal> is <literal>[ "foo" "bar" ]</literal>. </para> </listitem> </varlistentry> @@ -1181,8 +1137,7 @@ lib.attrsets.mapAttrsRecursiveCond <xi:include href="./locations.xml" xpointer="lib.attrsets.genAttrs" /> <para> - Generate an attribute set by mapping a function over a list of attribute - names. + Generate an attribute set by mapping a function over a list of attribute names. </para> <variablelist> @@ -1241,8 +1196,7 @@ lib.attrsets.genAttrs [ "foo" "bar" ] (name: "x_${name}") <xi:include href="./locations.xml" xpointer="lib.attrsets.isDerivation" /> <para> - Check whether the argument is a derivation. Any set with <code>{ type = - "derivation"; }</code> counts as a derivation. + Check whether the argument is a derivation. Any set with <code>{ type = "derivation"; }</code> counts as a derivation. </para> <variablelist> @@ -1320,8 +1274,7 @@ lib.attrsets.isDerivation "foobar" </term> <listitem> <para> - Condition under which the <varname>as</varname> attribute set is - returned. + Condition under which the <varname>as</varname> attribute set is returned. </para> </listitem> </varlistentry> @@ -1363,8 +1316,7 @@ lib.attrsets.optionalAttrs false { my = "set"; } <xi:include href="./locations.xml" xpointer="lib.attrsets.zipAttrsWithNames" /> <para> - Merge sets of attributes and use the function <varname>f</varname> to merge - attribute values where the attribute name is in <varname>names</varname>. + Merge sets of attributes and use the function <varname>f</varname> to merge attribute values where the attribute name is in <varname>names</varname>. </para> <variablelist> @@ -1451,11 +1403,8 @@ lib.attrsets.zipAttrsWithNames <xi:include href="./locations.xml" xpointer="lib.attrsets.zipAttrsWith" /> <para> - Merge sets of attributes and use the function <varname>f</varname> to merge - attribute values. Similar to - <xref - linkend="function-library-lib.attrsets.zipAttrsWithNames" /> where - all key names are passed for <varname>names</varname>. + Merge sets of attributes and use the function <varname>f</varname> to merge attribute values. Similar to <xref + linkend="function-library-lib.attrsets.zipAttrsWithNames" /> where all key names are passed for <varname>names</varname>. </para> <variablelist> @@ -1531,9 +1480,7 @@ lib.attrsets.zipAttrsWith <xi:include href="./locations.xml" xpointer="lib.attrsets.zipAttrs" /> <para> - Merge sets of attributes and combine each attribute value in to a list. - Similar to <xref linkend="function-library-lib.attrsets.zipAttrsWith" /> - where the merge function returns a list of all values. + Merge sets of attributes and combine each attribute value in to a list. Similar to <xref linkend="function-library-lib.attrsets.zipAttrsWith" /> where the merge function returns a list of all values. </para> <variablelist> @@ -1573,12 +1520,7 @@ lib.attrsets.zipAttrs <xi:include href="./locations.xml" xpointer="lib.attrsets.recursiveUpdateUntil" /> <para> - Does the same as the update operator <literal>//</literal> except that - attributes are merged until the given predicate is verified. The predicate - should accept 3 arguments which are the path to reach the attribute, a part - of the first attribute set and a part of the second attribute set. When the - predicate is verified, the value of the first attribute set is replaced by - the value of the second attribute set. + Does the same as the update operator <literal>//</literal> except that attributes are merged until the given predicate is verified. The predicate should accept 3 arguments which are the path to reach the attribute, a part of the first attribute set and a part of the second attribute set. When the predicate is verified, the value of the first attribute set is replaced by the value of the second attribute set. </para> <variablelist> @@ -1681,10 +1623,7 @@ lib.attrsets.recursiveUpdateUntil (path: l: r: path == ["foo"]) <xi:include href="./locations.xml" xpointer="lib.attrsets.recursiveUpdate" /> <para> - A recursive variant of the update operator <literal>//</literal>. The - recursion stops when one of the attribute values is not an attribute set, in - which case the right hand side value takes precedence over the left hand - side value. + A recursive variant of the update operator <literal>//</literal>. The recursion stops when one of the attribute values is not an attribute set, in which case the right hand side value takes precedence over the left hand side value. </para> <variablelist> diff --git a/nixpkgs/doc/functions/nix-gitignore.xml b/nixpkgs/doc/functions/nix-gitignore.xml index 9011570d1eae..37a82b196ccf 100644 --- a/nixpkgs/doc/functions/nix-gitignore.xml +++ b/nixpkgs/doc/functions/nix-gitignore.xml @@ -5,21 +5,14 @@ <title>pkgs.nix-gitignore</title> <para> - <function>pkgs.nix-gitignore</function> is a function that acts similarly to - <literal>builtins.filterSource</literal> but also allows filtering with the - help of the gitignore format. + <function>pkgs.nix-gitignore</function> is a function that acts similarly to <literal>builtins.filterSource</literal> but also allows filtering with the help of the gitignore format. </para> <section xml:id="sec-pkgs-nix-gitignore-usage"> <title>Usage</title> <para> - <literal>pkgs.nix-gitignore</literal> exports a number of functions, but - you'll most likely need either <literal>gitignoreSource</literal> or - <literal>gitignoreSourcePure</literal>. As their first argument, they both - accept either 1. a file with gitignore lines or 2. a string with gitignore - lines, or 3. a list of either of the two. They will be concatenated into a - single big string. + <literal>pkgs.nix-gitignore</literal> exports a number of functions, but you'll most likely need either <literal>gitignoreSource</literal> or <literal>gitignoreSourcePure</literal>. As their first argument, they both accept either 1. a file with gitignore lines or 2. a string with gitignore lines, or 3. a list of either of the two. They will be concatenated into a single big string. </para> <programlisting><![CDATA[ @@ -40,8 +33,7 @@ ]]></programlisting> <para> - These functions are derived from the <literal>Filter</literal> functions by - setting the first filter argument to <literal>(_: _: true)</literal>: + These functions are derived from the <literal>Filter</literal> functions by setting the first filter argument to <literal>(_: _: true)</literal>: </para> <programlisting><![CDATA[ @@ -50,12 +42,7 @@ gitignoreSource = gitignoreFilterSource (_: _: true); ]]></programlisting> <para> - Those filter functions accept the same arguments the - <literal>builtins.filterSource</literal> function would pass to its filters, - thus <literal>fn: gitignoreFilterSourcePure fn ""</literal> should be - extensionally equivalent to <literal>filterSource</literal>. The file is - blacklisted iff it's blacklisted by either your filter or the - gitignoreFilter. + Those filter functions accept the same arguments the <literal>builtins.filterSource</literal> function would pass to its filters, thus <literal>fn: gitignoreFilterSourcePure fn ""</literal> should be extensionally equivalent to <literal>filterSource</literal>. The file is blacklisted iff it's blacklisted by either your filter or the gitignoreFilter. </para> <para> @@ -71,8 +58,7 @@ gitignoreFilter = ign: root: filterPattern (gitignoreToPatterns ign) root; <title>gitignore files in subdirectories</title> <para> - If you wish to use a filter that would search for .gitignore files in - subdirectories, just like git does by default, use this function: + If you wish to use a filter that would search for .gitignore files in subdirectories, just like git does by default, use this function: </para> <programlisting><![CDATA[ diff --git a/nixpkgs/doc/functions/ocitools.xml b/nixpkgs/doc/functions/ocitools.xml index 4500c41a34ae..f61075b242f8 100644 --- a/nixpkgs/doc/functions/ocitools.xml +++ b/nixpkgs/doc/functions/ocitools.xml @@ -5,36 +5,28 @@ <title>pkgs.ociTools</title> <para> - <varname>pkgs.ociTools</varname> is a set of functions for creating - containers according to the - <link xlink:href="https://github.com/opencontainers/runtime-spec">OCI - container specification v1.0.0</link>. Beyond that it makes no assumptions - about the container runner you choose to use to run the created container. + <varname>pkgs.ociTools</varname> is a set of functions for creating containers according to the <link xlink:href="https://github.com/opencontainers/runtime-spec">OCI container specification v1.0.0</link>. Beyond that it makes no assumptions about the container runner you choose to use to run the created container. </para> <section xml:id="ssec-pkgs-ociTools-buildContainer"> <title>buildContainer</title> <para> - This function creates a simple OCI container that runs a single command - inside of it. An OCI container consists of a <varname>config.json</varname> - and a rootfs directory.The nix store of the container will contain all - referenced dependencies of the given command. + This function creates a simple OCI container that runs a single command inside of it. An OCI container consists of a <varname>config.json</varname> and a rootfs directory.The nix store of the container will contain all referenced dependencies of the given command. </para> <para> - The parameters of <varname>buildContainer</varname> with an example value - are described below: + The parameters of <varname>buildContainer</varname> with an example value are described below: </para> <example xml:id='ex-ociTools-buildContainer'> <title>Build Container</title> <programlisting> buildContainer { - cmd = with pkgs; writeScript "run.sh" '' + args = [ (with pkgs; writeScript "run.sh" '' #!${bash}/bin/bash ${coreutils}/bin/exec ${bash}/bin/bash - ''; <co xml:id='ex-ociTools-buildContainer-1' /> + '').outPath ]; <co xml:id='ex-ociTools-buildContainer-1' /> mounts = { "/data" = { @@ -51,23 +43,17 @@ buildContainer { <calloutlist> <callout arearefs='ex-ociTools-buildContainer-1'> <para> - <varname>cmd</varname> specifies the program to run inside the container. - This is the only required argument for <varname>buildContainer</varname>. - All referenced packages inside the derivation will be made available - inside the container + <varname>args</varname> specifies a set of arguments to run inside the container. This is the only required argument for <varname>buildContainer</varname>. All referenced packages inside the derivation will be made available inside the container </para> </callout> <callout arearefs='ex-ociTools-buildContainer-2'> <para> - <varname>mounts</varname> specifies additional mount points chosen by the - user. By default only a minimal set of necessary filesystems are mounted - into the container (e.g procfs, cgroupfs) + <varname>mounts</varname> specifies additional mount points chosen by the user. By default only a minimal set of necessary filesystems are mounted into the container (e.g procfs, cgroupfs) </para> </callout> <callout arearefs='ex-ociTools-buildContainer-3'> <para> - <varname>readonly</varname> makes the container's rootfs read-only if it is set to true. - The default value is false <literal>false</literal>. + <varname>readonly</varname> makes the container's rootfs read-only if it is set to true. The default value is false <literal>false</literal>. </para> </callout> </calloutlist> diff --git a/nixpkgs/doc/functions/overrides.xml b/nixpkgs/doc/functions/overrides.xml index 1bd90d2a0c76..4ba4283c6094 100644 --- a/nixpkgs/doc/functions/overrides.xml +++ b/nixpkgs/doc/functions/overrides.xml @@ -5,23 +5,18 @@ <title>Overriding</title> <para> - Sometimes one wants to override parts of <literal>nixpkgs</literal>, e.g. - derivation attributes, the results of derivations. + Sometimes one wants to override parts of <literal>nixpkgs</literal>, e.g. derivation attributes, the results of derivations. </para> <para> - These functions are used to make changes to packages, returning only single - packages. <link xlink:href="#chap-overlays">Overlays</link>, on the other - hand, can be used to combine the overridden packages across the entire - package set of Nixpkgs. + These functions are used to make changes to packages, returning only single packages. <link xlink:href="#chap-overlays">Overlays</link>, on the other hand, can be used to combine the overridden packages across the entire package set of Nixpkgs. </para> <section xml:id="sec-pkg-override"> <title><pkg>.override</title> <para> - The function <varname>override</varname> is usually available for all the - derivations in the nixpkgs expression (<varname>pkgs</varname>). + The function <varname>override</varname> is usually available for all the derivations in the nixpkgs expression (<varname>pkgs</varname>). </para> <para> @@ -47,10 +42,7 @@ mypkg = pkgs.callPackage ./mypkg.nix { </para> <para> - In the first example, <varname>pkgs.foo</varname> is the result of a - function call with some default arguments, usually a derivation. Using - <varname>pkgs.foo.override</varname> will call the same function with the - given new arguments. + In the first example, <varname>pkgs.foo</varname> is the result of a function call with some default arguments, usually a derivation. Using <varname>pkgs.foo.override</varname> will call the same function with the given new arguments. </para> </section> @@ -58,12 +50,7 @@ mypkg = pkgs.callPackage ./mypkg.nix { <title><pkg>.overrideAttrs</title> <para> - The function <varname>overrideAttrs</varname> allows overriding the - attribute set passed to a <varname>stdenv.mkDerivation</varname> call, - producing a new derivation based on the original one. This function is - available on all derivations produced by the - <varname>stdenv.mkDerivation</varname> function, which is most packages in - the nixpkgs expression <varname>pkgs</varname>. + The function <varname>overrideAttrs</varname> allows overriding the attribute set passed to a <varname>stdenv.mkDerivation</varname> call, producing a new derivation based on the original one. This function is available on all derivations produced by the <varname>stdenv.mkDerivation</varname> function, which is most packages in the nixpkgs expression <varname>pkgs</varname>. </para> <para> @@ -76,30 +63,16 @@ helloWithDebug = pkgs.hello.overrideAttrs (oldAttrs: rec { </para> <para> - In the above example, the <varname>separateDebugInfo</varname> attribute is - overridden to be true, thus building debug info for - <varname>helloWithDebug</varname>, while all other attributes will be - retained from the original <varname>hello</varname> package. + In the above example, the <varname>separateDebugInfo</varname> attribute is overridden to be true, thus building debug info for <varname>helloWithDebug</varname>, while all other attributes will be retained from the original <varname>hello</varname> package. </para> <para> - The argument <varname>oldAttrs</varname> is conventionally used to refer to - the attr set originally passed to <varname>stdenv.mkDerivation</varname>. + The argument <varname>oldAttrs</varname> is conventionally used to refer to the attr set originally passed to <varname>stdenv.mkDerivation</varname>. </para> <note> <para> - Note that <varname>separateDebugInfo</varname> is processed only by the - <varname>stdenv.mkDerivation</varname> function, not the generated, raw Nix - derivation. Thus, using <varname>overrideDerivation</varname> will not work - in this case, as it overrides only the attributes of the final derivation. - It is for this reason that <varname>overrideAttrs</varname> should be - preferred in (almost) all cases to <varname>overrideDerivation</varname>, - i.e. to allow using <varname>stdenv.mkDerivation</varname> to process input - arguments, as well as the fact that it is easier to use (you can use the - same attribute names you see in your Nix code, instead of the ones - generated (e.g. <varname>buildInputs</varname> vs - <varname>nativeBuildInputs</varname>), and it involves less typing). + Note that <varname>separateDebugInfo</varname> is processed only by the <varname>stdenv.mkDerivation</varname> function, not the generated, raw Nix derivation. Thus, using <varname>overrideDerivation</varname> will not work in this case, as it overrides only the attributes of the final derivation. It is for this reason that <varname>overrideAttrs</varname> should be preferred in (almost) all cases to <varname>overrideDerivation</varname>, i.e. to allow using <varname>stdenv.mkDerivation</varname> to process input arguments, as well as the fact that it is easier to use (you can use the same attribute names you see in your Nix code, instead of the ones generated (e.g. <varname>buildInputs</varname> vs <varname>nativeBuildInputs</varname>), and it involves less typing). </para> </note> </section> @@ -109,34 +82,18 @@ helloWithDebug = pkgs.hello.overrideAttrs (oldAttrs: rec { <warning> <para> - You should prefer <varname>overrideAttrs</varname> in almost all cases, see - its documentation for the reasons why. - <varname>overrideDerivation</varname> is not deprecated and will continue - to work, but is less nice to use and does not have as many abilities as - <varname>overrideAttrs</varname>. + You should prefer <varname>overrideAttrs</varname> in almost all cases, see its documentation for the reasons why. <varname>overrideDerivation</varname> is not deprecated and will continue to work, but is less nice to use and does not have as many abilities as <varname>overrideAttrs</varname>. </para> </warning> <warning> <para> - Do not use this function in Nixpkgs as it evaluates a Derivation before - modifying it, which breaks package abstraction and removes error-checking - of function arguments. In addition, this evaluation-per-function - application incurs a performance penalty, which can become a problem if - many overrides are used. It is only intended for ad-hoc customisation, such - as in <filename>~/.config/nixpkgs/config.nix</filename>. + Do not use this function in Nixpkgs as it evaluates a Derivation before modifying it, which breaks package abstraction and removes error-checking of function arguments. In addition, this evaluation-per-function application incurs a performance penalty, which can become a problem if many overrides are used. It is only intended for ad-hoc customisation, such as in <filename>~/.config/nixpkgs/config.nix</filename>. </para> </warning> <para> - The function <varname>overrideDerivation</varname> creates a new derivation - based on an existing one by overriding the original's attributes with the - attribute set produced by the specified function. This function is available - on all derivations defined using the <varname>makeOverridable</varname> - function. Most standard derivation-producing functions, such as - <varname>stdenv.mkDerivation</varname>, are defined using this function, - which means most packages in the nixpkgs expression, - <varname>pkgs</varname>, have this function. + The function <varname>overrideDerivation</varname> creates a new derivation based on an existing one by overriding the original's attributes with the attribute set produced by the specified function. This function is available on all derivations defined using the <varname>makeOverridable</varname> function. Most standard derivation-producing functions, such as <varname>stdenv.mkDerivation</varname>, are defined using this function, which means most packages in the nixpkgs expression, <varname>pkgs</varname>, have this function. </para> <para> @@ -154,27 +111,16 @@ mySed = pkgs.gnused.overrideDerivation (oldAttrs: { </para> <para> - In the above example, the <varname>name</varname>, <varname>src</varname>, - and <varname>patches</varname> of the derivation will be overridden, while - all other attributes will be retained from the original derivation. + In the above example, the <varname>name</varname>, <varname>src</varname>, and <varname>patches</varname> of the derivation will be overridden, while all other attributes will be retained from the original derivation. </para> <para> - The argument <varname>oldAttrs</varname> is used to refer to the attribute - set of the original derivation. + The argument <varname>oldAttrs</varname> is used to refer to the attribute set of the original derivation. </para> <note> <para> - A package's attributes are evaluated *before* being modified by the - <varname>overrideDerivation</varname> function. For example, the - <varname>name</varname> attribute reference in <varname>url = - "mirror://gnu/hello/${name}.tar.gz";</varname> is filled-in *before* the - <varname>overrideDerivation</varname> function modifies the attribute set. - This means that overriding the <varname>name</varname> attribute, in this - example, *will not* change the value of the <varname>url</varname> - attribute. Instead, we need to override both the <varname>name</varname> - *and* <varname>url</varname> attributes. + A package's attributes are evaluated *before* being modified by the <varname>overrideDerivation</varname> function. For example, the <varname>name</varname> attribute reference in <varname>url = "mirror://gnu/hello/${name}.tar.gz";</varname> is filled-in *before* the <varname>overrideDerivation</varname> function modifies the attribute set. This means that overriding the <varname>name</varname> attribute, in this example, *will not* change the value of the <varname>url</varname> attribute. Instead, we need to override both the <varname>name</varname> *and* <varname>url</varname> attributes. </para> </note> </section> @@ -183,9 +129,7 @@ mySed = pkgs.gnused.overrideDerivation (oldAttrs: { <title>lib.makeOverridable</title> <para> - The function <varname>lib.makeOverridable</varname> is used to make the - result of a function easily customizable. This utility only makes sense for - functions that accept an argument set and return an attribute set. + The function <varname>lib.makeOverridable</varname> is used to make the result of a function easily customizable. This utility only makes sense for functions that accept an argument set and return an attribute set. </para> <para> @@ -197,16 +141,11 @@ c = lib.makeOverridable f { a = 1; b = 2; }; </para> <para> - The variable <varname>c</varname> is the value of the <varname>f</varname> - function applied with some default arguments. Hence the value of - <varname>c.result</varname> is <literal>3</literal>, in this example. + The variable <varname>c</varname> is the value of the <varname>f</varname> function applied with some default arguments. Hence the value of <varname>c.result</varname> is <literal>3</literal>, in this example. </para> <para> - The variable <varname>c</varname> however also has some additional - functions, like <link linkend="sec-pkg-override">c.override</link> which can - be used to override the default arguments. In this example the value of - <varname>(c.override { a = 4; }).result</varname> is 6. + The variable <varname>c</varname> however also has some additional functions, like <link linkend="sec-pkg-override">c.override</link> which can be used to override the default arguments. In this example the value of <varname>(c.override { a = 4; }).result</varname> is 6. </para> </section> </section> diff --git a/nixpkgs/doc/functions/prefer-remote-fetch.xml b/nixpkgs/doc/functions/prefer-remote-fetch.xml index 3e43fd28ade8..94d25d3d3aeb 100644 --- a/nixpkgs/doc/functions/prefer-remote-fetch.xml +++ b/nixpkgs/doc/functions/prefer-remote-fetch.xml @@ -5,16 +5,12 @@ <title>prefer-remote-fetch overlay</title> <para> - <function>prefer-remote-fetch</function> is an overlay that download sources - on remote builder. This is useful when the evaluating machine has a slow - upload while the builder can fetch faster directly from the source. To use - it, put the following snippet as a new overlay: + <function>prefer-remote-fetch</function> is an overlay that download sources on remote builder. This is useful when the evaluating machine has a slow upload while the builder can fetch faster directly from the source. To use it, put the following snippet as a new overlay: <programlisting> self: super: (super.prefer-remote-fetch self super) </programlisting> - A full configuration example for that sets the overlay up for your own - account, could look like this + A full configuration example for that sets the overlay up for your own account, could look like this <screen> <prompt>$ </prompt>mkdir ~/.config/nixpkgs/overlays/ <prompt>$ </prompt>cat > ~/.config/nixpkgs/overlays/prefer-remote-fetch.nix <<EOF diff --git a/nixpkgs/doc/functions/shell.xml b/nixpkgs/doc/functions/shell.xml index e5031c9463c0..cef65d06b882 100644 --- a/nixpkgs/doc/functions/shell.xml +++ b/nixpkgs/doc/functions/shell.xml @@ -5,9 +5,7 @@ <title>pkgs.mkShell</title> <para> - <function>pkgs.mkShell</function> is a special kind of derivation that is - only useful when using it combined with <command>nix-shell</command>. It will - in fact fail to instantiate when invoked with <command>nix-build</command>. + <function>pkgs.mkShell</function> is a special kind of derivation that is only useful when using it combined with <command>nix-shell</command>. It will in fact fail to instantiate when invoked with <command>nix-build</command>. </para> <section xml:id="sec-pkgs-mkShell-usage"> diff --git a/nixpkgs/doc/functions/snaptools.xml b/nixpkgs/doc/functions/snaptools.xml index d0e3efdf6c67..422fcfa37d88 100644 --- a/nixpkgs/doc/functions/snaptools.xml +++ b/nixpkgs/doc/functions/snaptools.xml @@ -5,28 +5,22 @@ <title>pkgs.snapTools</title> <para> - <varname>pkgs.snapTools</varname> is a set of functions for creating - Snapcraft images. Snap and Snapcraft is not used to perform these operations. + <varname>pkgs.snapTools</varname> is a set of functions for creating Snapcraft images. Snap and Snapcraft is not used to perform these operations. </para> <section xml:id="ssec-pkgs-snapTools-makeSnap-signature"> <title>The makeSnap Function</title> <para> - <function>makeSnap</function> takes a single named argument, - <parameter>meta</parameter>. This argument mirrors - <link xlink:href="https://docs.snapcraft.io/snap-format">the upstream - <filename>snap.yaml</filename> format</link> exactly. + <function>makeSnap</function> takes a single named argument, <parameter>meta</parameter>. This argument mirrors <link xlink:href="https://docs.snapcraft.io/snap-format">the upstream <filename>snap.yaml</filename> format</link> exactly. </para> <para> - The <parameter>base</parameter> should not be be specified, as - <function>makeSnap</function> will force set it. + The <parameter>base</parameter> should not be be specified, as <function>makeSnap</function> will force set it. </para> <para> - Currently, <function>makeSnap</function> does not support creating GUI - stubs. + Currently, <function>makeSnap</function> does not support creating GUI stubs. </para> </section> @@ -40,9 +34,7 @@ </para> <programlisting><xi:include href="./snap/example-hello.nix" parse="text" /></programlisting> <para> - <command>nix-build</command> this expression and install it with - <command>snap install ./result --dangerous</command>. - <command>hello</command> will now be the Snapcraft version of the package. + <command>nix-build</command> this expression and install it with <command>snap install ./result --dangerous</command>. <command>hello</command> will now be the Snapcraft version of the package. </para> </example> </section> @@ -53,21 +45,14 @@ <example xml:id="ex-snapTools-buildSnap-firefox"> <title>Making a Graphical Snap</title> <para> - Graphical programs require many more integrations with the host. This - example uses Firefox as an example, because it is one of the most - complicated programs we could package. + Graphical programs require many more integrations with the host. This example uses Firefox as an example, because it is one of the most complicated programs we could package. </para> <programlisting><xi:include href="./snap/example-firefox.nix" parse="text" /></programlisting> <para> - <command>nix-build</command> this expression and install it with - <command>snap install ./result --dangerous</command>. - <command>nix-example-firefox</command> will now be the Snapcraft version of - the Firefox package. + <command>nix-build</command> this expression and install it with <command>snap install ./result --dangerous</command>. <command>nix-example-firefox</command> will now be the Snapcraft version of the Firefox package. </para> <para> - The specific meaning behind plugs can be looked up in the - <link xlink:href="https://docs.snapcraft.io/supported-interfaces">Snapcraft - interface documentation</link>. + The specific meaning behind plugs can be looked up in the <link xlink:href="https://docs.snapcraft.io/supported-interfaces">Snapcraft interface documentation</link>. </para> </example> </section> diff --git a/nixpkgs/doc/functions/trivial-builders.xml b/nixpkgs/doc/functions/trivial-builders.xml index 0211a4f31728..ae9f3a1b255d 100644 --- a/nixpkgs/doc/functions/trivial-builders.xml +++ b/nixpkgs/doc/functions/trivial-builders.xml @@ -5,11 +5,7 @@ <title>Trivial builders</title> <para> - Nixpkgs provides a couple of functions that help with building derivations. - The most important one, <function>stdenv.mkDerivation</function>, has already - been documented above. The following functions wrap - <function>stdenv.mkDerivation</function>, making it easier to use in certain - cases. + Nixpkgs provides a couple of functions that help with building derivations. The most important one, <function>stdenv.mkDerivation</function>, has already been documented above. The following functions wrap <function>stdenv.mkDerivation</function>, making it easier to use in certain cases. </para> <variablelist> @@ -19,17 +15,7 @@ </term> <listitem> <para> - This takes three arguments, <literal>name</literal>, - <literal>env</literal>, and <literal>buildCommand</literal>. - <literal>name</literal> is just the name that Nix will append to the store - path in the same way that <literal>stdenv.mkDerivation</literal> uses its - <literal>name</literal> attribute. <literal>env</literal> is an attribute - set specifying environment variables that will be set for this derivation. - These attributes are then passed to the wrapped - <literal>stdenv.mkDerivation</literal>. <literal>buildCommand</literal> - specifies the commands that will be run to create this derivation. Note - that you will need to create <literal>$out</literal> for Nix to register - the command as successful. + This takes three arguments, <literal>name</literal>, <literal>env</literal>, and <literal>buildCommand</literal>. <literal>name</literal> is just the name that Nix will append to the store path in the same way that <literal>stdenv.mkDerivation</literal> uses its <literal>name</literal> attribute. <literal>env</literal> is an attribute set specifying environment variables that will be set for this derivation. These attributes are then passed to the wrapped <literal>stdenv.mkDerivation</literal>. <literal>buildCommand</literal> specifies the commands that will be run to create this derivation. Note that you will need to create <literal>$out</literal> for Nix to register the command as successful. </para> <para> An example of using <literal>runCommand</literal> is provided below. @@ -62,10 +48,7 @@ </term> <listitem> <para> - This works just like <literal>runCommand</literal>. The only difference is - that it also provides a C compiler in <literal>buildCommand</literal>’s - environment. To minimize your dependencies, you should only use this if - you are sure you will need a C compiler as part of running your command. + This works just like <literal>runCommand</literal>. The only difference is that it also provides a C compiler in <literal>buildCommand</literal>’s environment. To minimize your dependencies, you should only use this if you are sure you will need a C compiler as part of running your command. </para> </listitem> </varlistentry> @@ -75,20 +58,10 @@ </term> <listitem> <para> - These functions write <literal>text</literal> to the Nix store. This is - useful for creating scripts from Nix expressions. - <literal>writeTextFile</literal> takes an attribute set and expects two - arguments, <literal>name</literal> and <literal>text</literal>. - <literal>name</literal> corresponds to the name used in the Nix store - path. <literal>text</literal> will be the contents of the file. You can - also set <literal>executable</literal> to true to make this file have the - executable bit set. + These functions write <literal>text</literal> to the Nix store. This is useful for creating scripts from Nix expressions. <literal>writeTextFile</literal> takes an attribute set and expects two arguments, <literal>name</literal> and <literal>text</literal>. <literal>name</literal> corresponds to the name used in the Nix store path. <literal>text</literal> will be the contents of the file. You can also set <literal>executable</literal> to true to make this file have the executable bit set. </para> <para> - Many more commands wrap <literal>writeTextFile</literal> including - <literal>writeText</literal>, <literal>writeTextDir</literal>, - <literal>writeScript</literal>, and <literal>writeScriptBin</literal>. - These are convenience functions over <literal>writeTextFile</literal>. + Many more commands wrap <literal>writeTextFile</literal> including <literal>writeText</literal>, <literal>writeTextDir</literal>, <literal>writeScript</literal>, and <literal>writeScriptBin</literal>. These are convenience functions over <literal>writeTextFile</literal>. </para> </listitem> </varlistentry> @@ -98,14 +71,7 @@ </term> <listitem> <para> - This can be used to put many derivations into the same directory - structure. It works by creating a new derivation and adding symlinks to - each of the paths listed. It expects two arguments, - <literal>name</literal>, and <literal>paths</literal>. - <literal>name</literal> is the name used in the Nix store path for the - created derivation. <literal>paths</literal> is a list of paths that will - be symlinked. These paths can be to Nix store derivations or any other - subdirectory contained within. + This can be used to put many derivations into the same directory structure. It works by creating a new derivation and adding symlinks to each of the paths listed. It expects two arguments, <literal>name</literal>, and <literal>paths</literal>. <literal>name</literal> is the name used in the Nix store path for the created derivation. <literal>paths</literal> is a list of paths that will be symlinked. These paths can be to Nix store derivations or any other subdirectory contained within. </para> </listitem> </varlistentry> diff --git a/nixpkgs/doc/languages-frameworks/beam.xml b/nixpkgs/doc/languages-frameworks/beam.xml index dee7f2d74191..65f28d0a2d3b 100644 --- a/nixpkgs/doc/languages-frameworks/beam.xml +++ b/nixpkgs/doc/languages-frameworks/beam.xml @@ -7,12 +7,7 @@ <title>Introduction</title> <para> - In this document and related Nix expressions, we use the term, - <emphasis>BEAM</emphasis>, to describe the environment. BEAM is the name of - the Erlang Virtual Machine and, as far as we're concerned, from a packaging - perspective, all languages that run on the BEAM are interchangeable. That - which varies, like the build system, is transparent to users of any given - BEAM package, so we make no distinction. + In this document and related Nix expressions, we use the term, <emphasis>BEAM</emphasis>, to describe the environment. BEAM is the name of the Erlang Virtual Machine and, as far as we're concerned, from a packaging perspective, all languages that run on the BEAM are interchangeable. That which varies, like the build system, is transparent to users of any given BEAM package, so we make no distinction. </para> </section> @@ -20,57 +15,36 @@ <title>Structure</title> <para> - All BEAM-related expressions are available via the top-level - <literal>beam</literal> attribute, which includes: + All BEAM-related expressions are available via the top-level <literal>beam</literal> attribute, which includes: </para> <itemizedlist> <listitem> <para> - <literal>interpreters</literal>: a set of compilers running on the BEAM, - including multiple Erlang/OTP versions - (<literal>beam.interpreters.erlangR19</literal>, etc), Elixir - (<literal>beam.interpreters.elixir</literal>) and LFE - (<literal>beam.interpreters.lfe</literal>). + <literal>interpreters</literal>: a set of compilers running on the BEAM, including multiple Erlang/OTP versions (<literal>beam.interpreters.erlangR19</literal>, etc), Elixir (<literal>beam.interpreters.elixir</literal>) and LFE (<literal>beam.interpreters.lfe</literal>). </para> </listitem> <listitem> <para> - <literal>packages</literal>: a set of package sets, each compiled with a - specific Erlang/OTP version, e.g. - <literal>beam.packages.erlangR19</literal>. + <literal>packages</literal>: a set of package sets, each compiled with a specific Erlang/OTP version, e.g. <literal>beam.packages.erlangR19</literal>. </para> </listitem> </itemizedlist> <para> - The default Erlang compiler, defined by - <literal>beam.interpreters.erlang</literal>, is aliased as - <literal>erlang</literal>. The default BEAM package set is defined by - <literal>beam.packages.erlang</literal> and aliased at the top level as - <literal>beamPackages</literal>. + The default Erlang compiler, defined by <literal>beam.interpreters.erlang</literal>, is aliased as <literal>erlang</literal>. The default BEAM package set is defined by <literal>beam.packages.erlang</literal> and aliased at the top level as <literal>beamPackages</literal>. </para> <para> - To create a package set built with a custom Erlang version, use the lambda, - <literal>beam.packagesWith</literal>, which accepts an Erlang/OTP derivation - and produces a package set similar to - <literal>beam.packages.erlang</literal>. + To create a package set built with a custom Erlang version, use the lambda, <literal>beam.packagesWith</literal>, which accepts an Erlang/OTP derivation and produces a package set similar to <literal>beam.packages.erlang</literal>. </para> <para> - Many Erlang/OTP distributions available in - <literal>beam.interpreters</literal> have versions with ODBC and/or Java - enabled. For example, there's - <literal>beam.interpreters.erlangR19_odbc_javac</literal>, which corresponds - to <literal>beam.interpreters.erlangR19</literal>. + Many Erlang/OTP distributions available in <literal>beam.interpreters</literal> have versions with ODBC and/or Java enabled. For example, there's <literal>beam.interpreters.erlangR19_odbc_javac</literal>, which corresponds to <literal>beam.interpreters.erlangR19</literal>. </para> <para xml:id="erlang-call-package"> - We also provide the lambda, - <literal>beam.packages.erlang.callPackage</literal>, which simplifies - writing BEAM package definitions by injecting all packages from - <literal>beam.packages.erlang</literal> into the top-level context. + We also provide the lambda, <literal>beam.packages.erlang.callPackage</literal>, which simplifies writing BEAM package definitions by injecting all packages from <literal>beam.packages.erlang</literal> into the top-level context. </para> </section> @@ -81,24 +55,16 @@ <title>Rebar3</title> <para> - By default, Rebar3 wants to manage its own dependencies. This is perfectly - acceptable in the normal, non-Nix setup, but in the Nix world, it is not. - To rectify this, we provide two versions of Rebar3: + By default, Rebar3 wants to manage its own dependencies. This is perfectly acceptable in the normal, non-Nix setup, but in the Nix world, it is not. To rectify this, we provide two versions of Rebar3: <itemizedlist> <listitem> <para> - <literal>rebar3</literal>: patched to remove the ability to download - anything. When not running it via <literal>nix-shell</literal> or - <literal>nix-build</literal>, it's probably not going to work as - desired. + <literal>rebar3</literal>: patched to remove the ability to download anything. When not running it via <literal>nix-shell</literal> or <literal>nix-build</literal>, it's probably not going to work as desired. </para> </listitem> <listitem> <para> - <literal>rebar3-open</literal>: the normal, unmodified Rebar3. It should - work exactly as would any other version of Rebar3. Any Erlang package - should rely on <literal>rebar3</literal> instead. See - <xref + <literal>rebar3-open</literal>: the normal, unmodified Rebar3. It should work exactly as would any other version of Rebar3. Any Erlang package should rely on <literal>rebar3</literal> instead. See <xref linkend="rebar3-packages"/>. </para> </listitem> @@ -110,10 +76,7 @@ <title>Mix & Erlang.mk</title> <para> - Both Mix and Erlang.mk work exactly as expected. There is a bootstrap - process that needs to be run for both, however, which is supported by the - <literal>buildMix</literal> and <literal>buildErlangMk</literal> - derivations, respectively. + Both Mix and Erlang.mk work exactly as expected. There is a bootstrap process that needs to be run for both, however, which is supported by the <literal>buildMix</literal> and <literal>buildErlangMk</literal> derivations, respectively. </para> </section> </section> @@ -122,13 +85,7 @@ <title>How to Install BEAM Packages</title> <para> - BEAM packages are not registered at the top level, simply because they are - not relevant to the vast majority of Nix users. They are installable using - the <literal>beam.packages.erlang</literal> attribute set (aliased as - <literal>beamPackages</literal>), which points to packages built by the - default Erlang/OTP version in Nixpkgs, as defined by - <literal>beam.interpreters.erlang</literal>. To list the available packages - in <literal>beamPackages</literal>, use the following command: + BEAM packages are not registered at the top level, simply because they are not relevant to the vast majority of Nix users. They are installable using the <literal>beam.packages.erlang</literal> attribute set (aliased as <literal>beamPackages</literal>), which points to packages built by the default Erlang/OTP version in Nixpkgs, as defined by <literal>beam.interpreters.erlang</literal>. To list the available packages in <literal>beamPackages</literal>, use the following command: </para> <screen> @@ -143,8 +100,7 @@ beamPackages.rebar3-pc pc-1.1.0 </screen> <para> - To install any of those packages into your profile, refer to them by their - attribute path (first column): + To install any of those packages into your profile, refer to them by their attribute path (first column): </para> <screen> @@ -152,9 +108,7 @@ beamPackages.rebar3-pc pc-1.1.0 </screen> <para> - The attribute path of any BEAM package corresponds to the name of that - particular package in <link xlink:href="https://hex.pm">Hex</link> or its - OTP Application/Release name. + The attribute path of any BEAM package corresponds to the name of that particular package in <link xlink:href="https://hex.pm">Hex</link> or its OTP Application/Release name. </para> </section> @@ -168,13 +122,8 @@ beamPackages.rebar3-pc pc-1.1.0 <title>Rebar3 Packages</title> <para> - The Nix function, <literal>buildRebar3</literal>, defined in - <literal>beam.packages.erlang.buildRebar3</literal> and aliased at the top - level, can be used to build a derivation that understands how to build a - Rebar3 project. For example, we can build - <link - xlink:href="https://github.com/erlang-nix/hex2nix">hex2nix</link> - as follows: + The Nix function, <literal>buildRebar3</literal>, defined in <literal>beam.packages.erlang.buildRebar3</literal> and aliased at the top level, can be used to build a derivation that understands how to build a Rebar3 project. For example, we can build <link + xlink:href="https://github.com/erlang-nix/hex2nix">hex2nix</link> as follows: </para> <programlisting> @@ -196,25 +145,16 @@ buildRebar3 rec { </programlisting> <para> - Such derivations are callable with - <literal>beam.packages.erlang.callPackage</literal> (see - <xref - linkend="erlang-call-package"/>). To call this package using - the normal <literal>callPackage</literal>, refer to dependency packages - via <literal>beamPackages</literal>, e.g. - <literal>beamPackages.ibrowse</literal>. + Such derivations are callable with <literal>beam.packages.erlang.callPackage</literal> (see <xref + linkend="erlang-call-package"/>). To call this package using the normal <literal>callPackage</literal>, refer to dependency packages via <literal>beamPackages</literal>, e.g. <literal>beamPackages.ibrowse</literal>. </para> <para> - Notably, <literal>buildRebar3</literal> includes - <literal>beamDeps</literal>, while <literal>stdenv.mkDerivation</literal> - does not. BEAM dependencies added there will be correctly handled by the - system. + Notably, <literal>buildRebar3</literal> includes <literal>beamDeps</literal>, while <literal>stdenv.mkDerivation</literal> does not. BEAM dependencies added there will be correctly handled by the system. </para> <para> - If a package needs to compile native code via Rebar3's port compilation - mechanism, add <literal>compilePort = true;</literal> to the derivation. + If a package needs to compile native code via Rebar3's port compilation mechanism, add <literal>compilePort = true;</literal> to the derivation. </para> </section> @@ -222,9 +162,7 @@ buildRebar3 rec { <title>Erlang.mk Packages</title> <para> - Erlang.mk functions similarly to Rebar3, except we use - <literal>buildErlangMk</literal> instead of - <literal>buildRebar3</literal>. + Erlang.mk functions similarly to Rebar3, except we use <literal>buildErlangMk</literal> instead of <literal>buildRebar3</literal>. </para> <programlisting> @@ -257,8 +195,7 @@ buildErlangMk { <title>Mix Packages</title> <para> - Mix functions similarly to Rebar3, except we use - <literal>buildMix</literal> instead of <literal>buildRebar3</literal>. + Mix functions similarly to Rebar3, except we use <literal>buildMix</literal> instead of <literal>buildRebar3</literal>. </para> <programlisting> @@ -323,11 +260,7 @@ buildHex { <title>Accessing an Environment</title> <para> - Often, we simply want to access a valid environment that contains a - specific package and its dependencies. We can accomplish that with the - <literal>env</literal> attribute of a derivation. For example, let's say we - want to access an Erlang REPL with <literal>ibrowse</literal> loaded up. We - could do the following: + Often, we simply want to access a valid environment that contains a specific package and its dependencies. We can accomplish that with the <literal>env</literal> attribute of a derivation. For example, let's say we want to access an Erlang REPL with <literal>ibrowse</literal> loaded up. We could do the following: </para> <screen> @@ -373,8 +306,7 @@ ok</computeroutput> </screen> <para> - Notice the <literal>-A beamPackages.ibrowse.env</literal>. That is the key - to this functionality. + Notice the <literal>-A beamPackages.ibrowse.env</literal>. That is the key to this functionality. </para> </section> @@ -382,11 +314,7 @@ ok</computeroutput> <title>Creating a Shell</title> <para> - Getting access to an environment often isn't enough to do real development. - Usually, we need to create a <literal>shell.nix</literal> file and do our - development inside of the environment specified therein. This file looks a - lot like the packaging described above, except that <literal>src</literal> - points to the project root and we call the package directly. + Getting access to an environment often isn't enough to do real development. Usually, we need to create a <literal>shell.nix</literal> file and do our development inside of the environment specified therein. This file looks a lot like the packaging described above, except that <literal>src</literal> points to the project root and we call the package directly. </para> <programlisting> @@ -414,8 +342,7 @@ in <title>Building in a Shell (for Mix Projects)</title> <para> - We can leverage the support of the derivation, irrespective of the build - derivation, by calling the commands themselves. + We can leverage the support of the derivation, irrespective of the build derivation, by calling the commands themselves. </para> <programlisting> @@ -477,12 +404,8 @@ analyze: build plt </programlisting> <para> - Using a <literal>shell.nix</literal> as described (see - <xref - linkend="creating-a-shell"/>) should just work. Aside from - <literal>test</literal>, <literal>plt</literal>, and - <literal>analyze</literal>, the Make targets work just fine for all of the - build derivations. + Using a <literal>shell.nix</literal> as described (see <xref + linkend="creating-a-shell"/>) should just work. Aside from <literal>test</literal>, <literal>plt</literal>, and <literal>analyze</literal>, the Make targets work just fine for all of the build derivations. </para> </section> </section> @@ -492,25 +415,14 @@ analyze: build plt <title>Generating Packages from Hex with <literal>hex2nix</literal></title> <para> - Updating the <link xlink:href="https://hex.pm">Hex</link> package set - requires - <link - xlink:href="https://github.com/erlang-nix/hex2nix">hex2nix</link>. - Given the path to the Erlang modules (usually - <literal>pkgs/development/erlang-modules</literal>), it will dump a file - called <literal>hex-packages.nix</literal>, containing all the packages that - use a recognized build system in - <link - xlink:href="https://hex.pm">Hex</link>. It can't be determined, - however, whether every package is buildable. + Updating the <link xlink:href="https://hex.pm">Hex</link> package set requires <link + xlink:href="https://github.com/erlang-nix/hex2nix">hex2nix</link>. Given the path to the Erlang modules (usually <literal>pkgs/development/erlang-modules</literal>), it will dump a file called <literal>hex-packages.nix</literal>, containing all the packages that use a recognized build system in <link + xlink:href="https://hex.pm">Hex</link>. It can't be determined, however, whether every package is buildable. </para> <para> - To make life easier for our users, try to build every - <link - xlink:href="https://hex.pm">Hex</link> package and remove those - that fail. To do that, simply run the following command in the root of your - <literal>nixpkgs</literal> repository: + To make life easier for our users, try to build every <link + xlink:href="https://hex.pm">Hex</link> package and remove those that fail. To do that, simply run the following command in the root of your <literal>nixpkgs</literal> repository: </para> <screen> @@ -518,11 +430,8 @@ analyze: build plt </screen> <para> - That will attempt to build every package in <literal>beamPackages</literal>. - Then manually remove those that fail. Hopefully, someone will improve - <link - xlink:href="https://github.com/erlang-nix/hex2nix">hex2nix</link> - in the future to automate the process. + That will attempt to build every package in <literal>beamPackages</literal>. Then manually remove those that fail. Hopefully, someone will improve <link + xlink:href="https://github.com/erlang-nix/hex2nix">hex2nix</link> in the future to automate the process. </para> </section> </section> diff --git a/nixpkgs/doc/languages-frameworks/bower.xml b/nixpkgs/doc/languages-frameworks/bower.xml index 118f6e10473a..b0738cad293b 100644 --- a/nixpkgs/doc/languages-frameworks/bower.xml +++ b/nixpkgs/doc/languages-frameworks/bower.xml @@ -4,32 +4,22 @@ <title>Bower</title> <para> - <link xlink:href="http://bower.io">Bower</link> is a package manager for web - site front-end components. Bower packages (comprising of build artefacts and - sometimes sources) are stored in <command>git</command> repositories, - typically on Github. The package registry is run by the Bower team with - package metadata coming from the <filename>bower.json</filename> file within - each package. + <link xlink:href="http://bower.io">Bower</link> is a package manager for web site front-end components. Bower packages (comprising of build artefacts and sometimes sources) are stored in <command>git</command> repositories, typically on Github. The package registry is run by the Bower team with package metadata coming from the <filename>bower.json</filename> file within each package. </para> <para> - The end result of running Bower is a <filename>bower_components</filename> - directory which can be included in the web app's build process. + The end result of running Bower is a <filename>bower_components</filename> directory which can be included in the web app's build process. </para> <para> - Bower can be run interactively, by installing - <varname>nodePackages.bower</varname>. More interestingly, the Bower - components can be declared in a Nix derivation, with the help of - <varname>nodePackages.bower2nix</varname>. + Bower can be run interactively, by installing <varname>nodePackages.bower</varname>. More interestingly, the Bower components can be declared in a Nix derivation, with the help of <varname>nodePackages.bower2nix</varname>. </para> <section xml:id="ssec-bower2nix-usage"> <title><command>bower2nix</command> usage</title> <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"> <title><filename>bower.json</filename></title> <programlisting language="json"> @@ -45,8 +35,7 @@ </para> <para> - Running <command>bower2nix</command> will produce something like the - following output: + Running <command>bower2nix</command> will produce something like the following output: <programlisting language="nix"> <![CDATA[{ fetchbower, buildEnv }: buildEnv { name = "bower-env"; ignoreCollisions = true; paths = [ @@ -58,15 +47,11 @@ buildEnv { name = "bower-env"; ignoreCollisions = true; paths = [ </para> <para> - Using the <command>bower2nix</command> command line arguments, the output - can be redirected to a file. A name like - <filename>bower-packages.nix</filename> would be fine. + Using the <command>bower2nix</command> command line arguments, the output can be redirected to a file. A name like <filename>bower-packages.nix</filename> would be fine. </para> <para> - The resulting derivation is a union of all the downloaded Bower packages - (and their dependencies). To use it, they still need to be linked together - by Bower, which is where <varname>buildBowerComponents</varname> is useful. + The resulting derivation is a union of all the downloaded Bower packages (and their dependencies). To use it, they still need to be linked together by Bower, which is where <varname>buildBowerComponents</varname> is useful. </para> </section> @@ -74,10 +59,7 @@ buildEnv { name = "bower-env"; ignoreCollisions = true; paths = [ <title><varname>buildBowerComponents</varname> function</title> <para> - The function is implemented in - <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/bower-modules/generic/default.nix"> - <filename>pkgs/development/bower-modules/generic/default.nix</filename></link>. - Example usage: + The function is implemented in <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/bower-modules/generic/default.nix"> <filename>pkgs/development/bower-modules/generic/default.nix</filename></link>. Example usage: <example xml:id="ex-buildBowerComponents"> <title>buildBowerComponents</title> <programlisting language="nix"> @@ -91,34 +73,27 @@ bowerComponents = buildBowerComponents { </para> <para> - In <xref linkend="ex-buildBowerComponents" />, the following arguments are - of special significance to the function: + In <xref linkend="ex-buildBowerComponents" />, the following arguments are of special significance to the function: <calloutlist> <callout arearefs="ex-buildBowerComponents-1"> <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> </callout> <callout arearefs="ex-buildBowerComponents-2"> <para> - <varname>src</varname> is your project's sources. It needs to contain a - <filename>bower.json</filename> file. + <varname>src</varname> is your project's sources. It needs to contain a <filename>bower.json</filename> file. </para> </callout> </calloutlist> </para> <para> - <varname>buildBowerComponents</varname> will run Bower to link together the - output of <command>bower2nix</command>, resulting in a - <filename>bower_components</filename> directory which can be used. + <varname>buildBowerComponents</varname> will run Bower to link together the output of <command>bower2nix</command>, resulting in a <filename>bower_components</filename> directory which can be used. </para> <para> - Here is an example of a web frontend build process using - <command>gulp</command>. You might use <command>grunt</command>, or anything - else. + Here is an example of a web frontend build process using <command>gulp</command>. You might use <command>grunt</command>, or anything else. </para> <example xml:id="ex-bowerGulpFile"> @@ -174,21 +149,17 @@ pkgs.stdenv.mkDerivation { <calloutlist> <callout arearefs="ex-buildBowerComponentsDefault-1"> <para> - The result of <varname>buildBowerComponents</varname> is an input to the - frontend build. + The result of <varname>buildBowerComponents</varname> is an input to the frontend build. </para> </callout> <callout arearefs="ex-buildBowerComponentsDefault-2"> <para> - Whether to symlink or copy the <filename>bower_components</filename> - directory depends on the build tool in use. In this case a copy is used - to avoid <command>gulp</command> silliness with permissions. + Whether to symlink or copy the <filename>bower_components</filename> directory depends on the build tool in use. In this case a copy is used to avoid <command>gulp</command> silliness with permissions. </para> </callout> <callout arearefs="ex-buildBowerComponentsDefault-3"> <para> - <command>gulp</command> requires <varname>HOME</varname> to refer to a - writeable directory. + <command>gulp</command> requires <varname>HOME</varname> to refer to a writeable directory. </para> </callout> <callout arearefs="ex-buildBowerComponentsDefault-4"> @@ -210,17 +181,13 @@ pkgs.stdenv.mkDerivation { </term> <listitem> <para> - This means that Bower was looking for a package version which doesn't - exist in the generated <filename>bower-packages.nix</filename>. + This means that Bower was looking for a package version which doesn't exist in the generated <filename>bower-packages.nix</filename>. </para> <para> - If <filename>bower.json</filename> has been updated, then run - <command>bower2nix</command> again. + If <filename>bower.json</filename> has been updated, then run <command>bower2nix</command> again. </para> <para> - It could also be a bug in <command>bower2nix</command> or - <command>fetchbower</command>. If possible, try reformulating the version - specification in <filename>bower.json</filename>. + It could also be a bug in <command>bower2nix</command> or <command>fetchbower</command>. If possible, try reformulating the version specification in <filename>bower.json</filename>. </para> </listitem> </varlistentry> diff --git a/nixpkgs/doc/languages-frameworks/coq.xml b/nixpkgs/doc/languages-frameworks/coq.xml index 4314df5c9df2..86d9226166f5 100644 --- a/nixpkgs/doc/languages-frameworks/coq.xml +++ b/nixpkgs/doc/languages-frameworks/coq.xml @@ -4,31 +4,19 @@ <title>Coq</title> <para> - Coq libraries should be installed in - <literal>$(out)/lib/coq/${coq.coq-version}/user-contrib/</literal>. Such - directories are automatically added to the <literal>$COQPATH</literal> - environment variable by the hook defined in the Coq derivation. + Coq libraries should be installed in <literal>$(out)/lib/coq/${coq.coq-version}/user-contrib/</literal>. Such directories are automatically added to the <literal>$COQPATH</literal> environment variable by the hook defined in the Coq derivation. </para> <para> - Some extensions (plugins) might require OCaml and sometimes other OCaml - packages. The <literal>coq.ocamlPackages</literal> attribute can be used to - depend on the same package set Coq was built against. + Some extensions (plugins) might require OCaml and sometimes other OCaml packages. The <literal>coq.ocamlPackages</literal> attribute can be used to depend on the same package set Coq was built against. </para> <para> - Coq libraries may be compatible with some specific versions of Coq only. The - <literal>compatibleCoqVersions</literal> attribute is used to precisely - select those versions of Coq that are compatible with this derivation. + Coq libraries may be compatible with some specific versions of Coq only. The <literal>compatibleCoqVersions</literal> attribute is used to precisely select those versions of Coq that are compatible with this derivation. </para> <para> - Here is a simple package example. It is a pure Coq library, thus it depends - on Coq. It builds on the Mathematical Components library, thus it also takes - <literal>mathcomp</literal> as <literal>buildInputs</literal>. Its - <literal>Makefile</literal> has been generated using - <literal>coq_makefile</literal> so we only have to set the - <literal>$COQLIB</literal> variable at install time. + Here is a simple package example. It is a pure Coq library, thus it depends on Coq. It builds on the Mathematical Components library, thus it also takes <literal>mathcomp</literal> as <literal>buildInputs</literal>. Its <literal>Makefile</literal> has been generated using <literal>coq_makefile</literal> so we only have to set the <literal>$COQLIB</literal> variable at install time. </para> <programlisting> diff --git a/nixpkgs/doc/languages-frameworks/gnome.xml b/nixpkgs/doc/languages-frameworks/gnome.xml new file mode 100644 index 000000000000..9e0f21a6c74f --- /dev/null +++ b/nixpkgs/doc/languages-frameworks/gnome.xml @@ -0,0 +1,263 @@ +<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-language-gnome"> + <title>GNOME</title> + + <section xml:id="ssec-gnome-packaging"> + <title>Packaging GNOME applications</title> + + <para> + Programs in the GNOME universe are written in various languages but they all use GObject-based libraries like GLib, GTK or GStreamer. These libraries are often modular, relying on looking into certain directories to find their modules. However, due to Nix’s specific file system organization, this will fail without our intervention. Fortunately, the libraries usually allow overriding the directories through environment variables, either natively or thanks to a patch in nixpkgs. <link xlink:href="#fun-wrapProgram">Wrapping</link> the executables to ensure correct paths are available to the application constitutes a significant part of packaging a modern desktop application. In this section, we will describe various modules needed by such applications, environment variables needed to make the modules load, and finally a script that will do the work for us. + </para> + + <section xml:id="ssec-gnome-settings"> + <title>Settings</title> + + <para> + <link xlink:href="https://developer.gnome.org/gio/stable/GSettings.html">GSettings</link> API is often used for storing settings. GSettings schemas are required, to know the type and other metadata of the stored values. GLib looks for <filename>glib-2.0/schemas/gschemas.compiled</filename> files inside the directories of <envar>XDG_DATA_DIRS</envar>. + </para> + + <para> + On Linux, GSettings API is implemented using <link xlink:href="https://wiki.gnome.org/Projects/dconf">dconf</link> backend. You will need to add <literal>dconf</literal> GIO module to <envar>GIO_EXTRA_MODULES</envar> variable, otherwise the <literal>memory</literal> backend will be used and the saved settings will not be persistent. + </para> + + <para> + Last you will need the dconf database D-Bus service itself. You can enable it using <option>programs.dconf.enable</option>. + </para> + + <para> + Some applications will also require <package>gsettings-desktop-schemas</package> for things like reading proxy configuration or user interface customization. This dependency is often not mentioned by upstream, you should grep for <literal>org.gnome.desktop</literal> and <literal>org.gnome.system</literal> to see if the schemas are needed. + </para> + </section> + + <section xml:id="ssec-gnome-icons"> + <title>Icons</title> + + <para> + When an application uses icons, an icon theme should be available in <envar>XDG_DATA_DIRS</envar>. The package for the default, icon-less <link xlink:href="https://www.freedesktop.org/wiki/Software/icon-theme/">hicolor-icon-theme</link> contains <link linkend="ssec-gnome-hooks-hicolor-icon-theme">a setup hook</link> that will pick up icon themes from <literal>buildInputs</literal> and pass it to our wrapper. Unfortunately, relying on that would mean every user has to download the theme included in the package expression no matter their preference. For that reason, we leave the installation of icon theme on the user. If you use one of the desktop environments, you probably already have an icon theme installed. + </para> + </section> + + <section xml:id="ssec-gnome-themes"> + <title>GTK Themes</title> + + <para> + Previously, a GTK theme needed to be in <envar>XDG_DATA_DIRS</envar>. This is no longer necessary for most programs since GTK incorporated Adwaita theme. Some programs (for example, those designed for <link xlink:href="https://elementary.io/docs/human-interface-guidelines#human-interface-guidelines">elementary HIG</link>) might require a special theme like <package>pantheon.elementary-gtk-theme</package>. + </para> + </section> + + <section xml:id="ssec-gnome-typelibs"> + <title>GObject introspection typelibs</title> + + <para> + <link xlink:href="https://wiki.gnome.org/Projects/GObjectIntrospection">GObject introspection</link> allows applications to use C libraries in other languages easily. It does this through <literal>typelib</literal> files searched in <envar>GI_TYPELIB_PATH</envar>. + </para> + </section> + + <section xml:id="ssec-gnome-plugins"> + <title>Various plug-ins</title> + + <para> + If your application uses <link xlink:href="https://gstreamer.freedesktop.org/">GStreamer</link> or <link xlink:href="https://wiki.gnome.org/Projects/Grilo">Grilo</link>, you should set <envar>GST_PLUGIN_SYSTEM_PATH_1_0</envar> and <envar>GRL_PLUGIN_PATH</envar>, respectively. + </para> + </section> + </section> + + <section xml:id="ssec-gnome-hooks"> + <title>Onto <package>wrapGAppsHook</package></title> + + <para> + Given the requirements above, the package expression would become messy quickly: +<programlisting> +preFixup = '' + for f in $(find $out/bin/ $out/libexec/ -type f -executable); do + wrapProgram "$f" \ + --prefix GIO_EXTRA_MODULES : "${getLib gnome3.dconf}/lib/gio/modules" \ + --prefix XDG_DATA_DIRS : "$out/share" \ + --prefix XDG_DATA_DIRS : "$out/share/gsettings-schemas/${name}" \ + --prefix XDG_DATA_DIRS : "${gsettings-desktop-schemas}/share/gsettings-schemas/${gsettings-desktop-schemas.name}" \ + --prefix XDG_DATA_DIRS : "${hicolor-icon-theme}/share" \ + --prefix GI_TYPELIB_PATH : "${lib.makeSearchPath "lib/girepository-1.0" [ pango json-glib ]}" + done +''; +</programlisting> + Fortunately, there is <package>wrapGAppsHook</package>, that does the wrapping for us. In particular, it works in conjunction with other setup hooks that will populate the variable: + <itemizedlist> + <listitem xml:id="ssec-gnome-hooks-wrapgappshook"> + <para> + <package>wrapGAppsHook</package> itself will add the package’s <filename>share</filename> directory to <envar>XDG_DATA_DIRS</envar>. + </para> + </listitem> + <listitem xml:id="ssec-gnome-hooks-glib"> + <para> + <package>glib</package> setup hook will populate <envar>GSETTINGS_SCHEMAS_PATH</envar> and then <package>wrapGAppsHook</package> will prepend it to <envar>XDG_DATA_DIRS</envar>. + </para> + </listitem> + <listitem xml:id="ssec-gnome-hooks-dconf"> + <para> + <package>gnome3.dconf.lib</package> is a dependency of <package>wrapGAppsHook</package>, which then also adds it to the <envar>GIO_EXTRA_MODULES</envar> variable. + </para> + </listitem> + <listitem xml:id="ssec-gnome-hooks-hicolor-icon-theme"> + <para> + <package>hicolor-icon-theme</package>’s setup hook will add icon themes to <envar>XDG_ICON_DIRS</envar> which is prepended to <envar>XDG_DATA_DIRS</envar> by <package>wrapGAppsHook</package>. + </para> + </listitem> + <listitem xml:id="ssec-gnome-hooks-gobject-introspection"> + <para> + <package>gobject-introspection</package> setup hook populates <envar>GI_TYPELIB_PATH</envar> variable with <filename>lib/girepository-1.0</filename> directories of dependencies, which is then added to wrapper by <package>wrapGAppsHook</package>. It also adds <filename>share</filename> directories of dependencies to <envar>XDG_DATA_DIRS</envar>, which is intended to promote GIR files but it also <link xlink:href="https://github.com/NixOS/nixpkgs/issues/32790">pollutes the closures</link> of packages using <package>wrapGAppsHook</package>. + </para> + <warning> + <para> + The setup hook <link xlink:href="https://github.com/NixOS/nixpkgs/issues/56943">currently</link> does not work in expressions with <literal>strictDeps</literal> enabled, like Python packages. In those cases, you will need to disable it with <code>strictDeps = false;</code>. + </para> + </warning> + </listitem> + <listitem xml:id="ssec-gnome-hooks-gst-grl-plugins"> + <para> + Setup hooks of <package>gst_all_1.gstreamer</package> and <package>gnome3.grilo</package> will populate the <envar>GST_PLUGIN_SYSTEM_PATH_1_0</envar> and <envar>GRL_PLUGIN_PATH</envar> variables, respectively, which will then be added to the wrapper by <literal>wrapGAppsHook</literal>. + </para> + </listitem> + </itemizedlist> + </para> + + <para> + You can also pass additional arguments to <literal>makeWrapper</literal> using <literal>gappsWrapperArgs</literal> in <literal>preFixup</literal> hook: +<programlisting> +preFixup = '' + gappsWrapperArgs+=( + # Thumbnailers + --prefix XDG_DATA_DIRS : "${gdk-pixbuf}/share" + --prefix XDG_DATA_DIRS : "${librsvg}/share" + --prefix XDG_DATA_DIRS : "${shared-mime-info}/share" + ) +''; +</programlisting> + </para> + </section> + + <section xml:id="ssec-gnome-updating"> + <title>Updating GNOME packages</title> + + <para> + Most GNOME package offer <link linkend="var-passthru-updateScript"><literal>updateScript</literal></link>, it is therefore possible to update to latest source tarball by running <command>nix-shell maintainers/scripts/update.nix --argstr package gnome3.nautilus</command> or even en masse with <command>nix-shell maintainers/scripts/update.nix --argstr path gnome3</command>. Read the package’s <filename>NEWS</filename> file to see what changed. + </para> + </section> + + <section xml:id="ssec-gnome-common-issues"> + <title>Frequently encountered issues</title> + + <variablelist> + <varlistentry xml:id="ssec-gnome-common-issues-no-schemas"> + <term> + <computeroutput>GLib-GIO-ERROR **: <replaceable>06:04:50.903</replaceable>: No GSettings schemas are installed on the system</computeroutput> + </term> + <listitem> + <para> + There are no schemas avalable in <envar>XDG_DATA_DIRS</envar>. Temporarily add a random package containing schemas like <package>gsettings-desktop-schemas</package> to <literal>buildInputs</literal>. <link linkend="ssec-gnome-hooks-glib"><package>glib</package></link> and <link linkend="ssec-gnome-hooks-wrapgappshook"><package>wrapGAppsHook</package></link> setup hooks will take care of making the schemas available to application and you will see the actual missing schemas with the <link linkend="ssec-gnome-common-issues-missing-schema">next error</link>. Or you can try looking through the source code for the actual schemas used. + </para> + </listitem> + </varlistentry> + <varlistentry xml:id="ssec-gnome-common-issues-missing-schema"> + <term> + <computeroutput>GLib-GIO-ERROR **: <replaceable>06:04:50.903</replaceable>: Settings schema ‘<replaceable>org.gnome.foo</replaceable>’ is not installed</computeroutput> + </term> + <listitem> + <para> + Package is missing some GSettings schemas. You can find out the package containing the schema with <command>nix-locate <replaceable>org.gnome.foo</replaceable>.gschema.xml</command> and let the hooks handle the wrapping as <link linkend="ssec-gnome-common-issues-no-schemas">above</link>. + </para> + </listitem> + </varlistentry> + <varlistentry xml:id="ssec-gnome-common-issues-double-wrapped"> + <term> + When using <package>wrapGAppsHook</package> with special derivers you can end up with double wrapped binaries. + </term> + <listitem> + <para> + This is because derivers like <function>python.pkgs.buildPythonApplication</function> or <function>qt5.mkDerivation</function> have setup-hooks automatically added that produce wrappers with <package>makeWrapper</package>. The simplest way to workaround that is to disable the <package>wrapGAppsHook</package> automatic wrapping with <code>dontWrapGApps = true;</code> and pass the arguments it intended to pass to <package>makeWrapper</package> to another. + </para> + <para> + In the case of a Python application it could look like: +<programlisting> +python3.pkgs.buildPythonApplication { + pname = "gnome-music"; + version = "3.32.2"; + + nativeBuildInputs = [ + wrapGAppsHook + gobject-introspection + ... + ]; + + dontWrapGApps = true; + + # Arguments to be passed to `makeWrapper`, only used by buildPython* + makeWrapperArgs = [ + "\${gappsWrapperArgs[@]}" + ]; +} +</programlisting> + And for a QT app like: +<programlisting> +mkDerivation { + pname = "calibre"; + version = "3.47.0"; + + nativeBuildInputs = [ + wrapGAppsHook + qmake + ... + ]; + + dontWrapGApps = true; + + # Arguments to be passed to `makeWrapper`, only used by qt5’s mkDerivation + qtWrapperArgs [ + "\${gappsWrapperArgs[@]}" + ]; +} +</programlisting> + </para> + </listitem> + </varlistentry> + <varlistentry xml:id="ssec-gnome-common-issues-unwrappable-package"> + <term> + I am packaging a project that cannot be wrapped, like a library or GNOME Shell extension. + </term> + <listitem> + <para> + You can rely on applications depending on the library set the necessary environment variables but that it often easy to miss. Instead we recommend to patch the paths in the source code whenever possible. Here are some examples: + <itemizedlist> + <listitem xml:id="ssec-gnome-common-issues-unwrappable-package-gnome-shell-ext"> + <para> + <link xlink:href="https://github.com/NixOS/nixpkgs/blob/7bb8f05f12ca3cff9da72b56caa2f7472d5732bc/pkgs/desktops/gnome-3/core/gnome-shell-extensions/default.nix#L21-L24">Replacing a <envar>GI_TYPELIB_PATH</envar> in GNOME Shell extension</link> – we are using <function>substituteAll</function> to include the path to a typelib into a patch. + </para> + </listitem> + <listitem xml:id="ssec-gnome-common-issues-unwrappable-package-gsettings"> + <para> + The following examples are hardcoding GSettings schema paths. To get the schema paths we use the functions + <itemizedlist> + <listitem> + <para> + <function>glib.getSchemaPath</function> Takes a nix package attribute as an argument. + </para> + </listitem> + <listitem> + <para> + <function>glib.makeSchemaPath</function> Takes a package output like <literal>$out</literal> and a derivation name. You should use this if the schemas you need to hardcode are in the same derivation. + </para> + </listitem> + </itemizedlist> + </para> + <para xml:id="ssec-gnome-common-issues-unwrappable-package-gsettings-vala"> + <link xlink:href="https://github.com/NixOS/nixpkgs/blob/7bb8f05f12ca3cff9da72b56caa2f7472d5732bc/pkgs/desktops/pantheon/apps/elementary-files/default.nix#L78-L86">Hard-coding GSettings schema path in Vala plug-in (dynamically loaded library)</link> – here, <function>substituteAll</function> cannot be used since the schema comes from the same package preventing us from pass its path to the function, probably due to a <link xlink:href="https://github.com/NixOS/nix/issues/1846">Nix bug</link>. + </para> + <para xml:id="ssec-gnome-common-issues-unwrappable-package-gsettings-c"> + <link xlink:href="https://github.com/NixOS/nixpkgs/blob/29c120c065d03b000224872251bed93932d42412/pkgs/development/libraries/glib-networking/default.nix#L31-L34">Hard-coding GSettings schema path in C library</link> – nothing special other than using <link xlink:href="https://github.com/NixOS/nixpkgs/pull/67957#issuecomment-527717467">Coccinelle patch</link> to generate the patch itself. + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + </variablelist> + </section> +</section> diff --git a/nixpkgs/doc/languages-frameworks/go.xml b/nixpkgs/doc/languages-frameworks/go.xml index b2b4962cb5f6..288a90298631 100644 --- a/nixpkgs/doc/languages-frameworks/go.xml +++ b/nixpkgs/doc/languages-frameworks/go.xml @@ -7,21 +7,16 @@ <title>Go modules</title> <para> - The function <varname> buildGoModule </varname> builds Go programs managed - with Go modules. It builds a - <link xlink:href="https://github.com/golang/go/wiki/Modules">Go - modules</link> through a two phase build: + The function <varname> buildGoModule </varname> builds Go programs managed with Go modules. It builds a <link xlink:href="https://github.com/golang/go/wiki/Modules">Go modules</link> through a two phase build: <itemizedlist> <listitem> <para> - An intermediate fetcher derivation. This derivation will be used to fetch - all of the dependencies of the Go module. + An intermediate fetcher derivation. This derivation will be used to fetch all of the dependencies of the Go module. </para> </listitem> <listitem> <para> - A final derivation will use the output of the intermediate derivation to - build the binaries and produce the final output. + A final derivation will use the output of the intermediate derivation to build the binaries and produce the final output. </para> </listitem> </itemizedlist> @@ -57,21 +52,16 @@ pet = buildGoModule rec { </example> <para> - <xref linkend='ex-buildGoModule'/> is an example expression using - buildGoModule, the following arguments are of special significance to the - function: + <xref linkend='ex-buildGoModule'/> is an example expression using buildGoModule, the following arguments are of special significance to the function: <calloutlist> <callout arearefs='ex-buildGoModule-1'> <para> - <varname>modSha256</varname> is the hash of the output of the - intermediate fetcher derivation. + <varname>modSha256</varname> is the hash of the output of the intermediate fetcher derivation. </para> </callout> <callout arearefs='ex-buildGoModule-2'> <para> - <varname>subPackages</varname> limits the builder from building child - packages that have not been listed. If <varname>subPackages</varname> is - not specified, all child packages will be built. + <varname>subPackages</varname> limits the builder from building child packages that have not been listed. If <varname>subPackages</varname> is not specified, all child packages will be built. </para> </callout> </calloutlist> @@ -82,8 +72,7 @@ pet = buildGoModule rec { <title>Go legacy</title> <para> - The function <varname> buildGoPackage </varname> builds legacy Go programs, - not supporting Go modules. + The function <varname> buildGoPackage </varname> builds legacy Go programs, not supporting Go modules. </para> <example xml:id='ex-buildGoPackage'> @@ -111,49 +100,36 @@ deis = buildGoPackage rec { </example> <para> - <xref linkend='ex-buildGoPackage'/> is an example expression using - buildGoPackage, 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> <callout arearefs='ex-buildGoPackage-1'> <para> - <varname>goPackagePath</varname> specifies the package's canonical Go - import path. + <varname>goPackagePath</varname> specifies the package's canonical Go import path. </para> </callout> <callout arearefs='ex-buildGoPackage-2'> <para> - <varname>subPackages</varname> limits the builder from building child - packages that have not been listed. If <varname>subPackages</varname> is - not specified, all child packages will be built. + <varname>subPackages</varname> limits the builder from building child packages that have not been listed. If <varname>subPackages</varname> is not specified, all child packages will be built. </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> </callout> <callout arearefs='ex-buildGoPackage-3'> <para> - <varname>goDeps</varname> is where the Go dependencies of a Go program - are listed as a list of package source identified by Go import path. It - could be imported as a separate <varname>deps.nix</varname> file for - readability. The dependency data structure is described below. + <varname>goDeps</varname> is where the Go dependencies of a Go program are listed as a list of package source identified by Go import path. It could be imported as a separate <varname>deps.nix</varname> file for readability. The dependency data structure is described below. </para> </callout> <callout arearefs='ex-buildGoPackage-4'> <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> </callout> </calloutlist> </para> <para> - The <varname>goDeps</varname> attribute can be imported from a separate - <varname>nix</varname> file that defines which Go libraries are needed and - should be included in <varname>GOPATH</varname> for - <varname>buildPhase</varname>. + The <varname>goDeps</varname> attribute can be imported from a separate <varname>nix</varname> file that defines which Go libraries are needed and should be included in <varname>GOPATH</varname> for <varname>buildPhase</varname>. </para> <example xml:id='ex-goDeps'> @@ -196,27 +172,18 @@ deis = buildGoPackage rec { </callout> <callout arearefs='ex-goDeps-3'> <para> - <varname>fetch type</varname> that needs to be used to get package - source. If <varname>git</varname> is used there should be - <varname>url</varname>, <varname>rev</varname> and - <varname>sha256</varname> defined next to it. + <varname>fetch type</varname> that needs to be used to get package source. If <varname>git</varname> is used there should be <varname>url</varname>, <varname>rev</varname> and <varname>sha256</varname> defined next to it. </para> </callout> </calloutlist> </para> <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. + 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> - <varname>buildGoPackage</varname> produces - <xref linkend='chap-multiple-output' xrefstyle="select: title" /> where - <varname>bin</varname> includes program binaries. You can test build a Go - binary as follows: + <varname>buildGoPackage</varname> produces <xref linkend='chap-multiple-output' xrefstyle="select: title" /> where <varname>bin</varname> includes program binaries. You can test build a Go binary as follows: <screen> <prompt>$ </prompt>nix-build -A deis.bin </screen> @@ -224,13 +191,11 @@ deis = buildGoPackage rec { <screen> <prompt>$ </prompt>nix-build -A deis.all </screen> - <varname>bin</varname> output will be installed by default with - <varname>nix-env -i</varname> or <varname>systemPackages</varname>. + <varname>bin</varname> output will be installed by default with <varname>nix-env -i</varname> or <varname>systemPackages</varname>. </para> <para> - You may use Go packages installed into the active Nix profiles by adding the - following to your ~/.bashrc: + You may use Go packages installed into the active Nix profiles by adding the following to your ~/.bashrc: <screen> for p in $NIX_PROFILES; do GOPATH="$p/share/go:$GOPATH" diff --git a/nixpkgs/doc/languages-frameworks/index.xml b/nixpkgs/doc/languages-frameworks/index.xml index cd4e95cfae69..cd0b48adb14a 100644 --- a/nixpkgs/doc/languages-frameworks/index.xml +++ b/nixpkgs/doc/languages-frameworks/index.xml @@ -3,17 +3,13 @@ xml:id="chap-language-support"> <title>Support for specific programming languages and frameworks</title> <para> - The <link linkend="chap-stdenv">standard build environment</link> makes it - easy to build typical Autotools-based packages with very little code. Any - other kind of package can be accomodated by overriding the appropriate phases - of <literal>stdenv</literal>. However, there are specialised functions in - Nixpkgs to easily build packages for other programming languages, such as - Perl or Haskell. These are described in this chapter. + The <link linkend="chap-stdenv">standard build environment</link> makes it easy to build typical Autotools-based packages with very little code. Any other kind of package can be accomodated by overriding the appropriate phases of <literal>stdenv</literal>. However, there are specialised functions in Nixpkgs to easily build packages for other programming languages, such as Perl or Haskell. These are described in this chapter. </para> <xi:include href="android.section.xml" /> <xi:include href="beam.xml" /> <xi:include href="bower.xml" /> <xi:include href="coq.xml" /> + <xi:include href="gnome.xml" /> <xi:include href="go.xml" /> <xi:include href="haskell.section.xml" /> <xi:include href="idris.section.xml" /> diff --git a/nixpkgs/doc/languages-frameworks/java.xml b/nixpkgs/doc/languages-frameworks/java.xml index 68a1a097984d..bf0fc4883922 100644 --- a/nixpkgs/doc/languages-frameworks/java.xml +++ b/nixpkgs/doc/languages-frameworks/java.xml @@ -15,37 +15,24 @@ stdenv.mkDerivation { buildPhase = "ant"; } </programlisting> - Note that <varname>jdk</varname> is an alias for the OpenJDK (self-built - where available, or pre-built via Zulu). Platforms with OpenJDK not (yet) in - Nixpkgs (<literal>Aarch32</literal>, <literal>Aarch64</literal>) point to the - (unfree) <literal>oraclejdk</literal>. + Note that <varname>jdk</varname> is an alias for the OpenJDK (self-built where available, or pre-built via Zulu). Platforms with OpenJDK not (yet) in Nixpkgs (<literal>Aarch32</literal>, <literal>Aarch64</literal>) point to the (unfree) <literal>oraclejdk</literal>. </para> <para> - JAR files that are intended to be used by other packages should be installed - in <filename>$out/share/java</filename>. JDKs have a stdenv setup hook that - add any JARs in the <filename>share/java</filename> directories of the build - inputs to the <envar>CLASSPATH</envar> environment variable. For instance, if - the package <literal>libfoo</literal> installs a JAR named - <filename>foo.jar</filename> in its <filename>share/java</filename> - directory, and another package declares the attribute + JAR files that are intended to be used by other packages should be installed in <filename>$out/share/java</filename>. JDKs have a stdenv setup hook that add any JARs in the <filename>share/java</filename> directories of the build inputs to the <envar>CLASSPATH</envar> environment variable. For instance, if the package <literal>libfoo</literal> installs a JAR named <filename>foo.jar</filename> in its <filename>share/java</filename> directory, and another package declares the attribute <programlisting> buildInputs = [ libfoo ]; nativeBuildInputs = [ jdk ]; </programlisting> - then <envar>CLASSPATH</envar> will be set to - <filename>/nix/store/...-libfoo/share/java/foo.jar</filename>. + then <envar>CLASSPATH</envar> will be set to <filename>/nix/store/...-libfoo/share/java/foo.jar</filename>. </para> <para> - Private JARs should be installed in a location like - <filename>$out/share/<replaceable>package-name</replaceable></filename>. + Private JARs should be installed in a location like <filename>$out/share/<replaceable>package-name</replaceable></filename>. </para> <para> - 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: + 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: <programlisting> nativeBuildInputs = [ makeWrapper ]; @@ -56,30 +43,21 @@ installPhase = --add-flags "-cp $out/share/java/foo.jar org.foo.Main" ''; </programlisting> - Note the use of <literal>jre</literal>, which is the part of the OpenJDK - package that contains the Java Runtime Environment. By using - <literal>${jre}/bin/java</literal> instead of - <literal>${jdk}/bin/java</literal>, you prevent your package from depending - on the JDK at runtime. + Note the use of <literal>jre</literal>, which is the part of the OpenJDK package that contains the Java Runtime Environment. By using <literal>${jre}/bin/java</literal> instead of <literal>${jdk}/bin/java</literal>, you prevent your package from depending on the JDK at runtime. </para> <para> - Note all JDKs passthru <literal>home</literal>, so if your application - requires environment variables like <envar>JAVA_HOME</envar> being set, that - can be done in a generic fashion with the <literal>--set</literal> argument - of <literal>makeWrapper</literal>: + Note all JDKs passthru <literal>home</literal>, so if your application requires environment variables like <envar>JAVA_HOME</envar> being set, that can be done in a generic fashion with the <literal>--set</literal> argument of <literal>makeWrapper</literal>: <programlisting> --set JAVA_HOME ${jdk.home} </programlisting> </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: + 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> nativeBuildInputs = [ gcj ant ]; </programlisting> - Here, Ant will automatically use <command>gij</command> (the GNU Java - Runtime) instead of the OpenJRE. + Here, Ant will automatically use <command>gij</command> (the GNU Java Runtime) instead of the OpenJRE. </para> </section> diff --git a/nixpkgs/doc/languages-frameworks/lua.xml b/nixpkgs/doc/languages-frameworks/lua.xml index 5144bb24ff6e..bcca6b737539 100644 --- a/nixpkgs/doc/languages-frameworks/lua.xml +++ b/nixpkgs/doc/languages-frameworks/lua.xml @@ -4,18 +4,11 @@ <title>Lua</title> <para> - Lua packages are built by the <varname>buildLuaPackage</varname> function. - This function is implemented in - <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/lua-modules/generic/default.nix"> - <filename>pkgs/development/lua-modules/generic/default.nix</filename></link> - and works similarly to <varname>buildPerlPackage</varname>. (See - <xref linkend="sec-language-perl"/> for details.) + Lua packages are built by the <varname>buildLuaPackage</varname> function. This function is implemented in <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/lua-modules/generic/default.nix"> <filename>pkgs/development/lua-modules/generic/default.nix</filename></link> and works similarly to <varname>buildPerlPackage</varname>. (See <xref linkend="sec-language-perl"/> for details.) </para> <para> - Lua packages are defined in - <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/top-level/lua-packages.nix"><filename>pkgs/top-level/lua-packages.nix</filename></link>. - Most of them are simple. For example: + Lua packages are defined in <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/top-level/lua-packages.nix"><filename>pkgs/top-level/lua-packages.nix</filename></link>. Most of them are simple. For example: <programlisting> fileSystem = buildLuaPackage { name = "filesystem-1.6.2"; @@ -33,16 +26,11 @@ fileSystem = buildLuaPackage { </para> <para> - Though, more complicated package should be placed in a seperate file in - <link + Though, more complicated package should be placed in a seperate file in <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/lua-modules"><filename>pkgs/development/lua-modules</filename></link>. </para> <para> - Lua packages accept additional parameter <varname>disabled</varname>, which - defines the condition of disabling package from luaPackages. For example, if - package has <varname>disabled</varname> assigned to <literal>lua.luaversion - != "5.1"</literal>, it will not be included in any luaPackages except - lua51Packages, making it only be built for lua 5.1. + Lua packages accept additional parameter <varname>disabled</varname>, which defines the condition of disabling package from luaPackages. For example, if package has <varname>disabled</varname> assigned to <literal>lua.luaversion != "5.1"</literal>, it will not be included in any luaPackages except lua51Packages, making it only be built for lua 5.1. </para> </section> diff --git a/nixpkgs/doc/languages-frameworks/ocaml.xml b/nixpkgs/doc/languages-frameworks/ocaml.xml index b7006ecba998..a0ea209b493c 100644 --- a/nixpkgs/doc/languages-frameworks/ocaml.xml +++ b/nixpkgs/doc/languages-frameworks/ocaml.xml @@ -4,35 +4,15 @@ <title>OCaml</title> <para> - OCaml libraries should be installed in - <literal>$(out)/lib/ocaml/${ocaml.version}/site-lib/</literal>. Such - directories are automatically added to the <literal>$OCAMLPATH</literal> - environment variable when building another package that depends on them or - when opening a <literal>nix-shell</literal>. + OCaml libraries should be installed in <literal>$(out)/lib/ocaml/${ocaml.version}/site-lib/</literal>. Such directories are automatically added to the <literal>$OCAMLPATH</literal> environment variable when building another package that depends on them or when opening a <literal>nix-shell</literal>. </para> <para> - Given that most of the OCaml ecosystem is now built with dune, nixpkgs - includes a convenience build support function called - <literal>buildDunePackage</literal> that will build an OCaml package using - dune, OCaml and findlib and any additional dependencies provided as - <literal>buildInputs</literal> or <literal>propagatedBuildInputs</literal>. + Given that most of the OCaml ecosystem is now built with dune, nixpkgs includes a convenience build support function called <literal>buildDunePackage</literal> that will build an OCaml package using dune, OCaml and findlib and any additional dependencies provided as <literal>buildInputs</literal> or <literal>propagatedBuildInputs</literal>. </para> <para> - Here is a simple package example. It defines an (optional) attribute - <literal>minimumOCamlVersion</literal> that will be used to throw a - descriptive evaluation error if building with an older OCaml is attempted. It - uses the <literal>fetchFromGitHub</literal> fetcher to get its source. It - sets the <literal>doCheck</literal> (optional) attribute to - <literal>true</literal> which means that tests will be run with <literal>dune - runtest -p angstrom</literal> after the build (<literal>dune build -p - angstrom</literal>) is complete. It uses <literal>alcotest</literal> as a - build input (because it is needed to run the tests) and - <literal>bigstringaf</literal> and <literal>result</literal> as propagated - build inputs (thus they will also be available to libraries depending on this - library). The library will be installed using the - <literal>angstrom.install</literal> file that dune generates. + Here is a simple package example. It defines an (optional) attribute <literal>minimumOCamlVersion</literal> that will be used to throw a descriptive evaluation error if building with an older OCaml is attempted. It uses the <literal>fetchFromGitHub</literal> fetcher to get its source. It sets the <literal>doCheck</literal> (optional) attribute to <literal>true</literal> which means that tests will be run with <literal>dune runtest -p angstrom</literal> after the build (<literal>dune build -p angstrom</literal>) is complete. It uses <literal>alcotest</literal> as a build input (because it is needed to run the tests) and <literal>bigstringaf</literal> and <literal>result</literal> as propagated build inputs (thus they will also be available to libraries depending on this library). The library will be installed using the <literal>angstrom.install</literal> file that dune generates. </para> <programlisting> @@ -65,11 +45,7 @@ buildDunePackage rec { </programlisting> <para> - Here is a second example, this time using a source archive generated with - <literal>dune-release</literal>. It is a good idea to use this archive when - it is available as it will usually contain substituted variables such as a - <literal>%%VERSION%%</literal> field. This library does not depend on any - other OCaml library and no tests are run after building it. + Here is a second example, this time using a source archive generated with <literal>dune-release</literal>. It is a good idea to use this archive when it is available as it will usually contain substituted variables such as a <literal>%%VERSION%%</literal> field. This library does not depend on any other OCaml library and no tests are run after building it. </para> <programlisting> diff --git a/nixpkgs/doc/languages-frameworks/perl.xml b/nixpkgs/doc/languages-frameworks/perl.xml index 065212a0e180..d9b6b2721c67 100644 --- a/nixpkgs/doc/languages-frameworks/perl.xml +++ b/nixpkgs/doc/languages-frameworks/perl.xml @@ -4,24 +4,13 @@ <title>Perl</title> <para> - Nixpkgs provides a function <varname>buildPerlPackage</varname>, a generic - package builder function for any Perl package that has a standard - <varname>Makefile.PL</varname>. It’s implemented in - <link + Nixpkgs provides a function <varname>buildPerlPackage</varname>, a generic package builder function for any Perl package that has a standard <varname>Makefile.PL</varname>. It’s implemented in <link 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 -xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/top-level/perl-packages.nix"><filename>pkgs/top-level/perl-packages.nix</filename></link>, - rather than <filename>pkgs/all-packages.nix</filename>. Most Perl packages - are so straight-forward to build that they are defined here directly, rather - than having a separate function for each package called from - <filename>perl-packages.nix</filename>. However, more complicated packages - should be put in a separate file, typically in - <filename>pkgs/development/perl-modules</filename>. Here is an example of the - former: + 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>, rather than <filename>pkgs/all-packages.nix</filename>. Most Perl packages are so straight-forward to build that they are defined here directly, rather than having a separate function for each package called from <filename>perl-packages.nix</filename>. However, more complicated packages should be put in a separate file, typically in <filename>pkgs/development/perl-modules</filename>. Here is an example of the former: <programlisting> ClassC3 = buildPerlPackage rec { name = "Class-C3-0.21"; @@ -31,32 +20,22 @@ ClassC3 = buildPerlPackage rec { }; }; </programlisting> - Note the use of <literal>mirror://cpan/</literal>, and the - <literal>${name}</literal> in the URL definition to ensure that the name - attribute is consistent with the source that we’re actually downloading. - Perl packages are made available in <filename>all-packages.nix</filename> - through the variable <varname>perlPackages</varname>. For instance, if you - have a package that needs <varname>ClassC3</varname>, you would typically - write + Note the use of <literal>mirror://cpan/</literal>, and the <literal>${name}</literal> in the URL definition to ensure that the name attribute is consistent with the source that we’re actually downloading. Perl packages are made available in <filename>all-packages.nix</filename> through the variable <varname>perlPackages</varname>. For instance, if you have a package that needs <varname>ClassC3</varname>, you would typically write <programlisting> foo = import ../path/to/foo.nix { inherit stdenv fetchurl ...; inherit (perlPackages) ClassC3; }; </programlisting> - in <filename>all-packages.nix</filename>. You can test building a Perl - package as follows: + in <filename>all-packages.nix</filename>. You can test building a Perl package as follows: <screen> <prompt>$ </prompt>nix-build -A perlPackages.ClassC3 </screen> - <varname>buildPerlPackage</varname> adds <literal>perl-</literal> to the - start of the name attribute, so the package above is actually called - <literal>perl-Class-C3-0.21</literal>. So to install it, you can say: + <varname>buildPerlPackage</varname> adds <literal>perl-</literal> to the start of the name attribute, so the package above is actually called <literal>perl-Class-C3-0.21</literal>. So to install it, you can say: <screen> <prompt>$ </prompt>nix-env -i perl-Class-C3 </screen> - (Of course you can also install using the attribute name: <literal>nix-env -i - -A perlPackages.ClassC3</literal>.) + (Of course you can also install using the attribute name: <literal>nix-env -i -A perlPackages.ClassC3</literal>.) </para> <para> @@ -64,40 +43,24 @@ foo = import ../path/to/foo.nix { <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> + 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. (This can cause this shebang line - to become too long for Darwin to handle; see the note below.) + It adds the contents of the <envar>PERL5LIB</envar> environment variable to <literal>#! .../bin/perl</literal> line of Perl scripts as <literal>-I<replaceable>dir</replaceable></literal> flags. This ensures that a script can find its dependencies. (This can cause this shebang line to become too long for Darwin to handle; see the note below.) </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. + 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>: + <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> { buildPerlPackage, fetchurl, db }: @@ -118,12 +81,7 @@ buildPerlPackage rec { </para> <para> - Dependencies on other Perl packages can be specified in the - <varname>buildInputs</varname> and <varname>propagatedBuildInputs</varname> - attributes. If something is exclusively a build-time dependency, use - <varname>buildInputs</varname>; if it’s (also) a runtime dependency, use - <varname>propagatedBuildInputs</varname>. For instance, this builds a Perl - module that has runtime dependencies on a bunch of other modules: + Dependencies on other Perl packages can be specified in the <varname>buildInputs</varname> and <varname>propagatedBuildInputs</varname> attributes. If something is exclusively a build-time dependency, use <varname>buildInputs</varname>; if it’s (also) a runtime dependency, use <varname>propagatedBuildInputs</varname>. For instance, this builds a Perl module that has runtime dependencies on a bunch of other modules: <programlisting> ClassC3Componentised = buildPerlPackage rec { name = "Class-C3-Componentised-1.0004"; @@ -139,11 +97,7 @@ ClassC3Componentised = buildPerlPackage rec { </para> <para> - On Darwin, if a script has too many - <literal>-I<replaceable>dir</replaceable></literal> flags in its first line - (its “shebang line”), it will not run. This can be worked around by calling - the <literal>shortenPerlShebang</literal> function from the - <literal>postInstall</literal> phase: + On Darwin, if a script has too many <literal>-I<replaceable>dir</replaceable></literal> flags in its first line (its “shebang line”), it will not run. This can be worked around by calling the <literal>shortenPerlShebang</literal> function from the <literal>postInstall</literal> phase: <programlisting> { stdenv, buildPerlPackage, fetchurl, shortenPerlShebang }: @@ -162,20 +116,14 @@ ImageExifTool = buildPerlPackage { ''; }; </programlisting> - This will remove the <literal>-I</literal> flags from the shebang line, - rewrite them in the <literal>use lib</literal> form, and put them on the next - line instead. This function can be given any number of Perl scripts as - arguments; it will modify them in-place. + This will remove the <literal>-I</literal> flags from the shebang line, rewrite them in the <literal>use lib</literal> form, and put them on the next line instead. This function can be given any number of Perl scripts as arguments; it will modify them in-place. </para> <section xml:id="ssec-generation-from-CPAN"> <title>Generation from CPAN</title> <para> - Nix expressions for Perl packages can be generated (almost) automatically - from CPAN. This is done by the program - <command>nix-generate-from-cpan</command>, which can be installed as - follows: + Nix expressions for Perl packages can be generated (almost) automatically from CPAN. This is done by the program <command>nix-generate-from-cpan</command>, which can be installed as follows: </para> <screen> @@ -183,9 +131,7 @@ ImageExifTool = buildPerlPackage { </screen> <para> - This program takes a Perl module name, looks it up on CPAN, fetches and - unpacks the corresponding package, and prints a Nix expression on standard - output. For example: + This program takes a Perl module name, looks it up on CPAN, fetches and unpacks the corresponding package, and prints a Nix expression on standard output. For example: <screen> <prompt>$ </prompt>nix-generate-from-cpan XML::Simple XMLSimple = buildPerlPackage rec { @@ -201,9 +147,7 @@ ImageExifTool = buildPerlPackage { }; }; </screen> - The output can be pasted into - <filename>pkgs/top-level/perl-packages.nix</filename> or wherever else you - need it. + The output can be pasted into <filename>pkgs/top-level/perl-packages.nix</filename> or wherever else you need it. </para> </section> @@ -211,13 +155,7 @@ ImageExifTool = buildPerlPackage { <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. + 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> diff --git a/nixpkgs/doc/languages-frameworks/qt.xml b/nixpkgs/doc/languages-frameworks/qt.xml index 3332ce8c06e4..8d97de504ad3 100644 --- a/nixpkgs/doc/languages-frameworks/qt.xml +++ b/nixpkgs/doc/languages-frameworks/qt.xml @@ -4,16 +4,12 @@ <title>Qt</title> <para> - This section describes the differences between Nix expressions for Qt - libraries and applications and Nix expressions for other C++ software. Some - knowledge of the latter is assumed. There are primarily two problems which - the Qt infrastructure is designed to address: ensuring consistent versioning - of all dependencies and finding dependencies at runtime. + This section describes the differences between Nix expressions for Qt libraries and applications and Nix expressions for other C++ software. Some knowledge of the latter is assumed. There are primarily two problems which the Qt infrastructure is designed to address: ensuring consistent versioning of all dependencies and finding dependencies at runtime. </para> <example xml:id='qt-default-nix'> - <title>Nix expression for a Qt package (<filename>default.nix</filename>)</title> - <programlisting> + <title>Nix expression for a Qt package (<filename>default.nix</filename>)</title> +<programlisting> { mkDerivation, lib, qtbase }: <co xml:id='qt-default-nix-co-1' /> mkDerivation { <co xml:id='qt-default-nix-co-2' /> @@ -26,53 +22,36 @@ mkDerivation { <co xml:id='qt-default-nix-co-2' /> </example> <calloutlist> - <callout arearefs='qt-default-nix-co-1'> - <para> - Import <literal>mkDerivation</literal> and Qt (such as - <literal>qtbase</literal> modules directly. <emphasis>Do not</emphasis> - import Qt package sets; the Qt versions of dependencies may not be - coherent, causing build and runtime failures. - </para> - </callout> - <callout arearefs='qt-default-nix-co-2'> - <para> - Use <literal>mkDerivation</literal> instead of - <literal>stdenv.mkDerivation</literal>. <literal>mkDerivation</literal> - is a wrapper around <literal>stdenv.mkDerivation</literal> which - applies some Qt-specific settings. - This deriver accepts the same arguments as - <literal>stdenv.mkDerivation</literal>; refer to - <xref linkend='chap-stdenv' /> for details. - </para> - <para> - To use another deriver instead of - <literal>stdenv.mkDerivation</literal>, use - <literal>mkDerivationWith</literal>: + <callout arearefs='qt-default-nix-co-1'> + <para> + Import <literal>mkDerivation</literal> and Qt (such as <literal>qtbase</literal> modules directly. <emphasis>Do not</emphasis> import Qt package sets; the Qt versions of dependencies may not be coherent, causing build and runtime failures. + </para> + </callout> + <callout arearefs='qt-default-nix-co-2'> + <para> + Use <literal>mkDerivation</literal> instead of <literal>stdenv.mkDerivation</literal>. <literal>mkDerivation</literal> is a wrapper around <literal>stdenv.mkDerivation</literal> which applies some Qt-specific settings. This deriver accepts the same arguments as <literal>stdenv.mkDerivation</literal>; refer to <xref linkend='chap-stdenv' /> for details. + </para> + <para> + To use another deriver instead of <literal>stdenv.mkDerivation</literal>, use <literal>mkDerivationWith</literal>: <programlisting> mkDerivationWith myDeriver { # ... } </programlisting> - If you cannot use <literal>mkDerivationWith</literal>, please refer to - <xref linkend='qt-runtime-dependencies' />. - </para> - </callout> - <callout arearefs='qt-default-nix-co-3'> - <para> - <literal>mkDerivation</literal> accepts the same arguments as - <literal>stdenv.mkDerivation</literal>, such as - <literal>buildInputs</literal>. - </para> - </callout> + If you cannot use <literal>mkDerivationWith</literal>, please refer to <xref linkend='qt-runtime-dependencies' />. + </para> + </callout> + <callout arearefs='qt-default-nix-co-3'> + <para> + <literal>mkDerivation</literal> accepts the same arguments as <literal>stdenv.mkDerivation</literal>, such as <literal>buildInputs</literal>. + </para> + </callout> </calloutlist> <formalpara xml:id='qt-runtime-dependencies'> - <title>Locating runtime dependencies</title> - <para> - Qt applications need to be wrapped to find runtime dependencies. If you - cannot use <literal>mkDerivation</literal> or - <literal>mkDerivationWith</literal> above, include - <literal>wrapQtAppsHook</literal> in <literal>nativeBuildInputs</literal>: + <title>Locating runtime dependencies</title> + <para> + Qt applications need to be wrapped to find runtime dependencies. If you cannot use <literal>mkDerivation</literal> or <literal>mkDerivationWith</literal> above, include <literal>wrapQtAppsHook</literal> in <literal>nativeBuildInputs</literal>: <programlisting> stdenv.mkDerivation { # ... @@ -80,13 +59,11 @@ stdenv.mkDerivation { nativeBuildInputs = [ wrapQtAppsHook ]; } </programlisting> - </para> + </para> </formalpara> <para> - Entries added to <literal>qtWrapperArgs</literal> are used to modify the - wrappers created by <literal>wrapQtAppsHook</literal>. The entries are - passed as arguments to <xref linkend='fun-wrapProgram' />. + Entries added to <literal>qtWrapperArgs</literal> are used to modify the wrappers created by <literal>wrapQtAppsHook</literal>. The entries are passed as arguments to <xref linkend='fun-wrapProgram' />. <programlisting> mkDerivation { # ... @@ -97,10 +74,7 @@ mkDerivation { </para> <para> - Set <literal>dontWrapQtApps</literal> to stop applications from being - wrapped automatically. It is required to wrap applications manually with - <literal>wrapQtApp</literal>, using the syntax of - <xref linkend='fun-wrapProgram' />: + Set <literal>dontWrapQtApps</literal> to stop applications from being wrapped automatically. It is required to wrap applications manually with <literal>wrapQtApp</literal>, using the syntax of <xref linkend='fun-wrapProgram' />: <programlisting> mkDerivation { # ... @@ -115,16 +89,12 @@ mkDerivation { <note> <para> - <literal>wrapQtAppsHook</literal> ignores files that are non-ELF executables. - This means that scripts won't be automatically wrapped so you'll need to manually - wrap them as previously mentioned. An example of when you'd always need to do this - is with Python applications that use PyQT. + <literal>wrapQtAppsHook</literal> ignores files that are non-ELF executables. This means that scripts won't be automatically wrapped so you'll need to manually wrap them as previously mentioned. An example of when you'd always need to do this is with Python applications that use PyQT. </para> </note> <para> - Libraries are built with every available version of Qt. Use the <literal>meta.broken</literal> - attribute to disable the package for unsupported Qt versions: + Libraries are built with every available version of Qt. Use the <literal>meta.broken</literal> attribute to disable the package for unsupported Qt versions: <programlisting> mkDerivation { # ... @@ -136,13 +106,11 @@ mkDerivation { </para> <formalpara> - <title>Adding a library to Nixpkgs</title> - <para> - Add a Qt library to <filename>all-packages.nix</filename> by adding it to the - collection inside <literal>mkLibsForQt5</literal>. This ensures that the - library is built with every available version of Qt as needed. - <example xml:id='qt-library-all-packages-nix'> - <title>Adding a Qt library to <filename>all-packages.nix</filename></title> + <title>Adding a library to Nixpkgs</title> + <para> + Add a Qt library to <filename>all-packages.nix</filename> by adding it to the collection inside <literal>mkLibsForQt5</literal>. This ensures that the library is built with every available version of Qt as needed. + <example xml:id='qt-library-all-packages-nix'> + <title>Adding a Qt library to <filename>all-packages.nix</filename></title> <programlisting> { # ... @@ -156,19 +124,16 @@ mkDerivation { # ... } </programlisting> - </example> - </para> + </example> + </para> </formalpara> <formalpara> - <title>Adding an application to Nixpkgs</title> - <para> - Add a Qt application to <filename>all-packages.nix</filename> using - <literal>libsForQt5.callPackage</literal> instead of the usual - <literal>callPackage</literal>. The former ensures that all dependencies - are built with the same version of Qt. - <example xml:id='qt-application-all-packages-nix'> - <title>Adding a Qt application to <filename>all-packages.nix</filename></title> + <title>Adding an application to Nixpkgs</title> + <para> + Add a Qt application to <filename>all-packages.nix</filename> using <literal>libsForQt5.callPackage</literal> instead of the usual <literal>callPackage</literal>. The former ensures that all dependencies are built with the same version of Qt. + <example xml:id='qt-application-all-packages-nix'> + <title>Adding a Qt application to <filename>all-packages.nix</filename></title> <programlisting> { # ... @@ -178,8 +143,7 @@ mkDerivation { # ... } </programlisting> - </example> - </para> + </example> + </para> </formalpara> - </section> diff --git a/nixpkgs/doc/languages-frameworks/ruby.xml b/nixpkgs/doc/languages-frameworks/ruby.xml index df4e5acb22cb..b28745fd6e27 100644 --- a/nixpkgs/doc/languages-frameworks/ruby.xml +++ b/nixpkgs/doc/languages-frameworks/ruby.xml @@ -4,11 +4,7 @@ <title>Ruby</title> <para> - There currently is support to bundle applications that are packaged as Ruby - gems. The utility "bundix" allows you to write a - <filename>Gemfile</filename>, let bundler create a - <filename>Gemfile.lock</filename>, and then convert this into a nix - expression that contains all Gem dependencies automatically. + There currently is support to bundle applications that are packaged as Ruby gems. The utility "bundix" allows you to write a <filename>Gemfile</filename>, let bundler create a <filename>Gemfile.lock</filename>, and then convert this into a nix expression that contains all Gem dependencies automatically. </para> <para> @@ -45,9 +41,7 @@ bundlerEnv rec { </screen> <para> - Please check in the <filename>Gemfile</filename>, - <filename>Gemfile.lock</filename> and the <filename>gemset.nix</filename> so - future updates can be run easily. + Please check in the <filename>Gemfile</filename>, <filename>Gemfile.lock</filename> and the <filename>gemset.nix</filename> so future updates can be run easily. </para> <para> @@ -62,10 +56,7 @@ $ nix-shell -p bundix --run 'bundix' </screen> <para> - For tools written in Ruby - i.e. where the desire is to install a package and - then execute e.g. <command>rake</command> at the command line, there is an - alternative builder called <literal>bundlerApp</literal>. Set up the - <filename>gemset.nix</filename> the same way, and then, for example: + For tools written in Ruby - i.e. where the desire is to install a package and then execute e.g. <command>rake</command> at the command line, there is an alternative builder called <literal>bundlerApp</literal>. Set up the <filename>gemset.nix</filename> the same way, and then, for example: </para> <screen> @@ -87,29 +78,11 @@ bundlerApp { </screen> <para> - The chief advantage of <literal>bundlerApp</literal> over - <literal>bundlerEnv</literal> is the executables introduced in the - environment are precisely those selected in the <literal>exes</literal> list, - as opposed to <literal>bundlerEnv</literal> which adds all the executables - made available by gems in the gemset, which can mean e.g. - <command>rspec</command> or <command>rake</command> in unpredictable versions - available from various packages. + The chief advantage of <literal>bundlerApp</literal> over <literal>bundlerEnv</literal> is the executables introduced in the environment are precisely those selected in the <literal>exes</literal> list, as opposed to <literal>bundlerEnv</literal> which adds all the executables made available by gems in the gemset, which can mean e.g. <command>rspec</command> or <command>rake</command> in unpredictable versions available from various packages. </para> <para> - Resulting derivations for both builders also have two helpful attributes, - <literal>env</literal> and <literal>wrappedRuby</literal>. The first one - allows one to quickly drop into <command>nix-shell</command> with the - specified environment present. E.g. <command>nix-shell -A sensu.env</command> - would give you an environment with Ruby preset so it has all the libraries - necessary for <literal>sensu</literal> in its paths. The second one can be - used to make derivations from custom Ruby scripts which have - <filename>Gemfile</filename>s with their dependencies specified. It is a - derivation with <command>ruby</command> wrapped so it can find all the needed - dependencies. For example, to make a derivation <literal>my-script</literal> - for a <filename>my-script.rb</filename> (which should be placed in - <filename>bin</filename>) you should run <command>bundix</command> as - specified above and then use <literal>bundlerEnv</literal> like this: + Resulting derivations for both builders also have two helpful attributes, <literal>env</literal> and <literal>wrappedRuby</literal>. The first one allows one to quickly drop into <command>nix-shell</command> with the specified environment present. E.g. <command>nix-shell -A sensu.env</command> would give you an environment with Ruby preset so it has all the libraries necessary for <literal>sensu</literal> in its paths. The second one can be used to make derivations from custom Ruby scripts which have <filename>Gemfile</filename>s with their dependencies specified. It is a derivation with <command>ruby</command> wrapped so it can find all the needed dependencies. For example, to make a derivation <literal>my-script</literal> for a <filename>my-script.rb</filename> (which should be placed in <filename>bin</filename>) you should run <command>bundix</command> as specified above and then use <literal>bundlerEnv</literal> like this: </para> <programlisting> diff --git a/nixpkgs/doc/languages-frameworks/texlive.xml b/nixpkgs/doc/languages-frameworks/texlive.xml index 97f274933bef..7876cc213b66 100644 --- a/nixpkgs/doc/languages-frameworks/texlive.xml +++ b/nixpkgs/doc/languages-frameworks/texlive.xml @@ -4,8 +4,7 @@ <title>TeX Live</title> <para> - Since release 15.09 there is a new TeX Live packaging that lives entirely - under attribute <varname>texlive</varname>. + Since release 15.09 there is a new TeX Live packaging that lives entirely under attribute <varname>texlive</varname>. </para> <section xml:id="sec-language-texlive-users-guide"> @@ -14,28 +13,23 @@ <itemizedlist> <listitem> <para> - For basic usage just pull <varname>texlive.combined.scheme-basic</varname> - for an environment with basic LaTeX support. + 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. - Instead, you can build a custom set of packages like this: + It typically won't work to use separately installed packages together. Instead, you can build a custom set of packages like this: <programlisting> texlive.combine { inherit (texlive) scheme-small collection-langkorean algorithms cm-super; } </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 defined upstream (perhaps with tiny differences). </para> </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>. + 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> texlive.combine { # inherit (texlive) whatever-you-want; @@ -59,10 +53,7 @@ nix-repl> texlive.collection-<TAB> </listitem> <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. + 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> @@ -84,14 +75,12 @@ nix-repl> texlive.collection-<TAB> </listitem> <listitem> <para> - feature/bug: when a package is rejected by <varname>pkgFilter</varname>, - its dependencies are still propagated; + 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. + in case of any bugs or feature requests, file a github issue or better a pull request and /cc @vcunat. </para> </listitem> </itemizedlist> diff --git a/nixpkgs/doc/meta.xml b/nixpkgs/doc/meta.xml index 58c390a68b84..9371196818ad 100644 --- a/nixpkgs/doc/meta.xml +++ b/nixpkgs/doc/meta.xml @@ -3,10 +3,7 @@ xml:id="chap-meta"> <title>Meta-attributes</title> <para> - Nix packages can declare <emphasis>meta-attributes</emphasis> that contain - information about a package such as a description, its homepage, its license, - and so on. For instance, the GNU Hello package has a <varname>meta</varname> - declaration like this: + Nix packages can declare <emphasis>meta-attributes</emphasis> that contain information about a package such as a description, its homepage, its license, and so on. For instance, the GNU Hello package has a <varname>meta</varname> declaration like this: <programlisting> meta = with stdenv.lib; { description = "A program that produces a familiar, friendly greeting"; @@ -22,13 +19,10 @@ meta = with stdenv.lib; { </programlisting> </para> <para> - Meta-attributes are not passed to the builder of the package. Thus, a change - to a meta-attribute doesn’t trigger a recompilation of the package. The - value of a meta-attribute must be a string. + Meta-attributes are not passed to the builder of the package. Thus, a change to a meta-attribute doesn’t trigger a recompilation of the package. The value of a meta-attribute must be a string. </para> <para> - The meta-attributes of a package can be queried from the 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> <prompt>$ </prompt>nix-env -qa hello --json { @@ -67,8 +61,7 @@ meta = with stdenv.lib; { </screen> - <command>nix-env</command> knows about the <varname>description</varname> - field specifically: + <command>nix-env</command> knows about the <varname>description</varname> field specifically: <screen> <prompt>$ </prompt>nix-env -qa hello --description hello-2.3 A program that produces a familiar, friendly greeting @@ -88,18 +81,13 @@ hello-2.3 A program that produces a familiar, friendly greeting </term> <listitem> <para> - A short (one-line) description of the package. This is shown by - <command>nix-env -q --description</command> and also on the Nixpkgs - release pages. + A short (one-line) description of the package. This is shown by <command>nix-env -q --description</command> and also on the Nixpkgs release pages. </para> <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 - package — just describe what it does. + Don’t include a period at the end. Don’t include newline characters. Capitalise the first character. For brevity, don’t repeat the name of package — just describe what it does. </para> <para> - Wrong: <literal>"libpng is a library that allows you to decode PNG - images."</literal> + 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> @@ -122,9 +110,7 @@ hello-2.3 A program that produces a familiar, friendly greeting </term> <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. + 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> @@ -134,8 +120,7 @@ hello-2.3 A program that produces a familiar, friendly greeting </term> <listitem> <para> - The package’s homepage. Example: - <literal>https://www.gnu.org/software/hello/manual/</literal> + The package’s homepage. Example: <literal>https://www.gnu.org/software/hello/manual/</literal> </para> </listitem> </varlistentry> @@ -145,8 +130,7 @@ hello-2.3 A program that produces a familiar, friendly greeting </term> <listitem> <para> - The page where a link to the current version can be found. Example: - <literal>https://ftp.gnu.org/gnu/hello/</literal> + The page where a link to the current version can be found. Example: <literal>https://ftp.gnu.org/gnu/hello/</literal> </para> </listitem> </varlistentry> @@ -156,10 +140,7 @@ hello-2.3 A program that produces a familiar, friendly greeting </term> <listitem> <para> - A link or a list of links to the location of Changelog for a package. - A link may use expansion to refer to the correct changelog version. - Example: - <literal>"https://git.savannah.gnu.org/cgit/hello.git/plain/NEWS?h=v${version}"</literal> + A link or a list of links to the location of Changelog for a package. A link may use expansion to refer to the correct changelog version. Example: <literal>"https://git.savannah.gnu.org/cgit/hello.git/plain/NEWS?h=v${version}"</literal> </para> </listitem> </varlistentry> @@ -169,46 +150,32 @@ hello-2.3 A program that produces a familiar, friendly greeting </term> <listitem> <para> - The license, or licenses, for the package. One from the attribute set - defined in - <link - xlink:href="https://github.com/NixOS/nixpkgs/blob/master/lib/licenses.nix"> - <filename>nixpkgs/lib/licenses.nix</filename></link>. At this moment - using both a list of licenses and a single license is valid. If the - license field is in the form of a list representation, then it means that - parts of the package are licensed differently. Each license should - preferably be referenced by their attribute. The non-list attribute value - can also be a space delimited string representation of the contained - attribute shortNames or spdxIds. The following are all valid examples: + The license, or licenses, for the package. One from the attribute set defined in <link + xlink:href="https://github.com/NixOS/nixpkgs/blob/master/lib/licenses.nix"> <filename>nixpkgs/lib/licenses.nix</filename></link>. At this moment using both a list of licenses and a single license is valid. If the license field is in the form of a list representation, then it means that parts of the package are licensed differently. Each license should preferably be referenced by their attribute. The non-list attribute value can also be a space delimited string representation of the contained attribute shortNames or spdxIds. The following are all valid examples: <itemizedlist> <listitem> <para> - Single license referenced by attribute (preferred) - <literal>stdenv.lib.licenses.gpl3</literal>. + Single license referenced by attribute (preferred) <literal>stdenv.lib.licenses.gpl3</literal>. </para> </listitem> <listitem> <para> - Single license referenced by its attribute shortName (frowned upon) - <literal>"gpl3"</literal>. + Single license referenced by its attribute shortName (frowned upon) <literal>"gpl3"</literal>. </para> </listitem> <listitem> <para> - Single license referenced by its attribute spdxId (frowned upon) - <literal>"GPL-3.0"</literal>. + Single license referenced by its attribute spdxId (frowned upon) <literal>"GPL-3.0"</literal>. </para> </listitem> <listitem> <para> - Multiple licenses referenced by attribute (preferred) <literal>with - stdenv.lib.licenses; [ asl20 free ofl ]</literal>. + Multiple licenses referenced by attribute (preferred) <literal>with stdenv.lib.licenses; [ asl20 free ofl ]</literal>. </para> </listitem> <listitem> <para> - Multiple licenses referenced as a space delimited string of attribute - shortNames (frowned upon) <literal>"asl20 free ofl"</literal>. + Multiple licenses referenced as a space delimited string of attribute shortNames (frowned upon) <literal>"asl20 free ofl"</literal>. </para> </listitem> </itemizedlist> @@ -222,13 +189,8 @@ hello-2.3 A program that produces a familiar, friendly greeting </term> <listitem> <para> - 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> - and write something like <literal>[ stdenv.lib.maintainers.alice - stdenv.lib.maintainers.bob ]</literal>. + 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> and write something like <literal>[ stdenv.lib.maintainers.alice stdenv.lib.maintainers.bob ]</literal>. </para> </listitem> </varlistentry> @@ -238,10 +200,7 @@ hello-2.3 A program that produces a familiar, friendly greeting </term> <listitem> <para> - The <emphasis>priority</emphasis> of the package, used by - <command>nix-env</command> to resolve file name conflicts between - packages. See the Nix manual page for <command>nix-env</command> for - details. Example: <literal>"10"</literal> (a low-priority package). + The <emphasis>priority</emphasis> of the package, used by <command>nix-env</command> to resolve file name conflicts between packages. See the Nix manual page for <command>nix-env</command> for details. Example: <literal>"10"</literal> (a low-priority package). </para> </listitem> </varlistentry> @@ -251,15 +210,11 @@ hello-2.3 A program that produces a familiar, friendly greeting </term> <listitem> <para> - 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: + 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> meta.platforms = stdenv.lib.platforms.linux; </programlisting> - Attribute Set <varname>stdenv.lib.platforms</varname> defines - <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/lib/systems/doubles.nix"> - various common lists</link> of platforms types. + Attribute Set <varname>stdenv.lib.platforms</varname> defines <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/lib/systems/doubles.nix"> various common lists</link> of platforms types. </para> </listitem> </varlistentry> @@ -270,23 +225,14 @@ meta.platforms = stdenv.lib.platforms.linux; <listitem> <warning> <para> - This attribute is special in that it is not actually under the - <literal>meta</literal> attribute set but rather under the - <literal>passthru</literal> attribute set. This is due to how - <literal>meta</literal> attributes work, and the fact that they - are supposed to contain only metadata, not derivations. + This attribute is special in that it is not actually under the <literal>meta</literal> attribute set but rather under the <literal>passthru</literal> attribute set. This is due to how <literal>meta</literal> attributes work, and the fact that they are supposed to contain only metadata, not derivations. </para> </warning> <para> - An attribute set with as values tests. A test is a derivation, which - builds successfully when the test passes, and fails to build otherwise. A - derivation that is a test needs to have <literal>meta.timeout</literal> - defined. + An attribute set with as values tests. A test is a derivation, which builds successfully when the test passes, and fails to build otherwise. A derivation that is a test needs to have <literal>meta.timeout</literal> defined. </para> <para> - The NixOS tests are available as <literal>nixosTests</literal> in - parameters of derivations. For instance, the OpenSMTPD derivation - includes lines similar to: + The NixOS tests are available as <literal>nixosTests</literal> in parameters of derivations. For instance, the OpenSMTPD derivation includes lines similar to: <programlisting> { /* ... */, nixosTests }: { @@ -305,13 +251,7 @@ meta.platforms = stdenv.lib.platforms.linux; </term> <listitem> <para> - A timeout (in seconds) for building the derivation. If the derivation - takes longer than this time to build, it can fail due to breaking the - timeout. However, all computers do not have the same computing power, - hence some builders may decide to apply a multiplicative factor to this - value. When filling this value in, try to keep it approximately - consistent with other values already present in - <literal>nixpkgs</literal>. + A timeout (in seconds) for building the derivation. If the derivation takes longer than this time to build, it can fail due to breaking the timeout. However, all computers do not have the same computing power, hence some builders may decide to apply a multiplicative factor to this value. When filling this value in, try to keep it approximately consistent with other values already present in <literal>nixpkgs</literal>. </para> </listitem> </varlistentry> @@ -321,13 +261,7 @@ meta.platforms = stdenv.lib.platforms.linux; </term> <listitem> <para> - The list of Nix platform types for which the Hydra instance at - <literal>hydra.nixos.org</literal> will build the package. (Hydra is the - Nix-based continuous build system.) It defaults to the value of - <varname>meta.platforms</varname>. Thus, the only reason to set - <varname>meta.hydraPlatforms</varname> is if you want - <literal>hydra.nixos.org</literal> to build the package on a subset of - <varname>meta.platforms</varname>, or not at all, e.g. + The list of Nix platform types for which the Hydra instance at <literal>hydra.nixos.org</literal> will build the package. (Hydra is the Nix-based continuous build system.) It defaults to the value of <varname>meta.platforms</varname>. Thus, the only reason to set <varname>meta.hydraPlatforms</varname> is if you want <literal>hydra.nixos.org</literal> to build the package on a subset of <varname>meta.platforms</varname>, or not at all, e.g. <programlisting> meta.platforms = stdenv.lib.platforms.linux; meta.hydraPlatforms = []; @@ -341,10 +275,7 @@ meta.hydraPlatforms = []; </term> <listitem> <para> - If set to <literal>true</literal>, the package is marked as “broken”, - meaning that it won’t show up in <literal>nix-env -qa</literal>, and - cannot be built or installed. Such packages should be removed from - Nixpkgs eventually unless they are fixed. + If set to <literal>true</literal>, the package is marked as “broken”, meaning that it won’t show up in <literal>nix-env -qa</literal>, and cannot be built or installed. Such packages should be removed from Nixpkgs eventually unless they are fixed. </para> </listitem> </varlistentry> @@ -354,12 +285,7 @@ meta.hydraPlatforms = []; </term> <listitem> <para> - If set to <literal>true</literal>, the package is tested to be updated - correctly by the <literal>update-walker.sh</literal> script without - additional settings. Such packages have <varname>meta.version</varname> - set and their homepage (or the page specified by - <varname>meta.downloadPage</varname>) contains a direct link to the - package tarball. + If set to <literal>true</literal>, the package is tested to be updated correctly by the <literal>update-walker.sh</literal> script without additional settings. Such packages have <varname>meta.version</varname> set and their homepage (or the page specified by <varname>meta.downloadPage</varname>) contains a direct link to the package tarball. </para> </listitem> </varlistentry> @@ -369,17 +295,11 @@ meta.hydraPlatforms = []; <title>Licenses</title> <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"> - <filename>nixpkgs/lib/licenses.nix</filename></link>, or in-place license - description of the same format if the license is unlikely to be useful in - another expression. + The <varname>meta.license</varname> attribute should preferrably contain a value from <varname>stdenv.lib.licenses</varname> defined in <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/lib/licenses.nix"> <filename>nixpkgs/lib/licenses.nix</filename></link>, or in-place license description of the same format if the license is unlikely to be useful in another expression. </para> <para> - Although it's typically better to indicate the specific license, a few - generic options are available: + Although it's typically better to indicate the specific license, a few generic options are available: <variablelist> <varlistentry> <term> @@ -397,18 +317,10 @@ meta.hydraPlatforms = []; </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. + 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. + 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> @@ -418,9 +330,7 @@ meta.hydraPlatforms = []; </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. + 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> @@ -430,9 +340,7 @@ meta.hydraPlatforms = []; </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. + 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> diff --git a/nixpkgs/doc/multiple-output.xml b/nixpkgs/doc/multiple-output.xml index d0247e081f99..83275bb2fbd1 100644 --- a/nixpkgs/doc/multiple-output.xml +++ b/nixpkgs/doc/multiple-output.xml @@ -10,31 +10,16 @@ <title>Introduction</title> <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. + 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> <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. + 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. + 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> @@ -42,23 +27,18 @@ <title>Installing a split package</title> <para> - When installing a package via <varname>systemPackages</varname> or - <command>nix-env</command> you have several options: + When installing a package via <varname>systemPackages</varname> or <command>nix-env</command> you have several options: </para> <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. + 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> <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. + 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. @@ -66,19 +46,11 @@ </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. + 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. + 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> @@ -88,25 +60,15 @@ <title>Using a split package</title> <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. + 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> <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" />.) + 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> <para> - In some cases it may be desirable to combine different outputs under a - single store path. A function <literal>symlinkJoin</literal> can be used to - do this. (Note that it may negate some closure size benefits of using a - multiple-output package.) + In some cases it may be desirable to combine different outputs under a single store path. A function <literal>symlinkJoin</literal> can be used to do this. (Note that it may negate some closure size benefits of using a multiple-output package.) </para> </section> <section xml:id="sec-multiple-outputs-"> @@ -117,29 +79,18 @@ </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 - <<filename>nixpkgs/pkgs/build-support/setup-hooks/multiple-outputs.sh</filename>>; - it's relatively well-readable. The whole machinery is triggered by defining - the <varname>outputs</varname> attribute to contain the list of desired - output names (strings). + In nixpkgs there is a framework supporting multiple-output derivations. It tries to cover most cases by default behavior. You can find the source separated in <<filename>nixpkgs/pkgs/build-support/setup-hooks/multiple-outputs.sh</filename>>; it's relatively well-readable. The whole machinery is triggered by defining the <varname>outputs</varname> attribute to contain the list of desired output names (strings). </para> <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. + 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" />. + There is a special handling of the <varname>debug</varname> output, described at <xref linkend="stdenv-separateDebugInfo" />. </para> </note> @@ -147,36 +98,15 @@ <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. + 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>). + 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). + 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> @@ -184,13 +114,7 @@ <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 – a default output name is defined, - falling back to other possibilities if the output isn't defined. + The support code currently recognizes some particular kinds of outputs and either instructs the build system of the package to put files into their desired outputs or it moves the files during the fixup phase. Each group of file types has an <varname>outputFoo</varname> variable specifying the output name where they should go. If that variable isn't defined by the derivation writer, it is guessed – a default output name is defined, falling back to other possibilities if the output isn't defined. </para> <variablelist> @@ -200,9 +124,7 @@ </term> <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. + 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> @@ -212,8 +134,7 @@ </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. + 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> @@ -223,9 +144,7 @@ </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. + 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> @@ -235,9 +154,7 @@ </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. + 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> @@ -247,10 +164,7 @@ </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. + 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> @@ -260,8 +174,7 @@ </term> <listitem> <para> - is for man pages (except for section 3). They go to - <varname>man</varname> or <varname>$outputBin</varname> by default. + is for man pages (except for section 3). They go to <varname>man</varname> or <varname>$outputBin</varname> by default. </para> </listitem> </varlistentry> @@ -271,8 +184,7 @@ </term> <listitem> <para> - is for section 3 man pages. They go to <varname>devman</varname> or - <varname>$outputMan</varname> by default. + is for section 3 man pages. They go to <varname>devman</varname> or <varname>$outputMan</varname> by default. </para> </listitem> </varlistentry> @@ -282,8 +194,7 @@ </term> <listitem> <para> - is for info pages. They go to <varname>info</varname> or - <varname>$outputBin</varname> by default. + is for info pages. They go to <varname>info</varname> or <varname>$outputBin</varname> by default. </para> </listitem> </varlistentry> @@ -296,31 +207,22 @@ <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>. + 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> <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.) + 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. + 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. + Some packages have hidden assumptions on install paths, which complicates splitting. </para> </listitem> </itemizedlist> diff --git a/nixpkgs/doc/overlays.xml b/nixpkgs/doc/overlays.xml index bff2339ca933..26a888368abf 100644 --- a/nixpkgs/doc/overlays.xml +++ b/nixpkgs/doc/overlays.xml @@ -3,47 +3,32 @@ xml:id="chap-overlays"> <title>Overlays</title> <para> - This chapter describes how to extend and change Nixpkgs using overlays. - Overlays are used to add layers in the fixed-point used by Nixpkgs to compose - the set of all packages. + This chapter describes how to extend and change Nixpkgs using overlays. Overlays are used to add layers in the fixed-point used by Nixpkgs to compose the set of all packages. </para> <para> - Nixpkgs can be configured with a list of overlays, which are applied in - order. This means that the order of the overlays can be significant if - multiple layers override the same package. + Nixpkgs can be configured with a list of overlays, which are applied in order. This means that the order of the overlays can be significant if multiple layers override the same package. </para> <!--============================================================--> <section xml:id="sec-overlays-install"> <title>Installing overlays</title> <para> - The list of overlays can be set either explicitly in a Nix expression, or - through <literal><nixpkgs-overlays></literal> or user configuration - files. + The list of overlays can be set either explicitly in a Nix expression, or through <literal><nixpkgs-overlays></literal> or user configuration files. </para> <section xml:id="sec-overlays-argument"> <title>Set overlays in NixOS or Nix expressions</title> <para> - On a NixOS system the value of the <literal>nixpkgs.overlays</literal> - option, if present, is passed to the system Nixpkgs directly as an - argument. Note that this does not affect the overlays for non-NixOS - operations (e.g. <literal>nix-env</literal>), which are - <link xlink:href="#sec-overlays-lookup">looked</link> up independently. + On a NixOS system the value of the <literal>nixpkgs.overlays</literal> option, if present, is passed to the system Nixpkgs directly as an argument. Note that this does not affect the overlays for non-NixOS operations (e.g. <literal>nix-env</literal>), which are <link xlink:href="#sec-overlays-lookup">looked</link> up independently. </para> <para> - The list of overlays can be passed explicitly when importing nixpkgs, for - example <literal>import <nixpkgs> { overlays = [ overlay1 overlay2 ]; - }</literal>. + The list of overlays can be passed explicitly when importing nixpkgs, for example <literal>import <nixpkgs> { overlays = [ overlay1 overlay2 ]; }</literal>. </para> <para> - Further overlays can be added by calling the <literal>pkgs.extend</literal> - or <literal>pkgs.appendOverlays</literal>, although it is often preferable - to avoid these functions, because they recompute the Nixpkgs fixpoint, - which is somewhat expensive to do. + Further overlays can be added by calling the <literal>pkgs.extend</literal> or <literal>pkgs.appendOverlays</literal>, although it is often preferable to avoid these functions, because they recompute the Nixpkgs fixpoint, which is somewhat expensive to do. </para> </section> @@ -58,30 +43,20 @@ <orderedlist> <listitem> <para> - First, if an - <link xlink:href="#sec-overlays-argument"><varname>overlays</varname> - argument</link> to the Nixpkgs function itself is given, then that is - used and no path lookup will be performed. + First, if an <link xlink:href="#sec-overlays-argument"><varname>overlays</varname> argument</link> to the Nixpkgs function itself is given, then that is used and no path lookup will be performed. </para> </listitem> <listitem> <para> - Otherwise, if the Nix path entry - <literal><nixpkgs-overlays></literal> exists, we look for overlays at - that path, as described below. + Otherwise, if the Nix path entry <literal><nixpkgs-overlays></literal> exists, we look for overlays at that path, as described below. </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><nixpkgs-overlays>.</literal> + See the section on <literal>NIX_PATH</literal> in the Nix manual for more details on how to set a value for <literal><nixpkgs-overlays>.</literal> </para> </listitem> <listitem> <para> - If one of <filename>~/.config/nixpkgs/overlays.nix</filename> and - <filename>~/.config/nixpkgs/overlays/</filename> exists, then we look - for overlays at that path, as described below. It is an error if both - exist. + If one of <filename>~/.config/nixpkgs/overlays.nix</filename> and <filename>~/.config/nixpkgs/overlays/</filename> exists, then we look for overlays at that path, as described below. It is an error if both exist. </para> </listitem> </orderedlist> @@ -92,15 +67,12 @@ <itemizedlist> <listitem> <para> - If the path is a file, then the file is imported as a Nix expression and - used as the list of overlays. + 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> <para> - 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: + 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> <listitem> <para> @@ -109,8 +81,7 @@ </listitem> <listitem> <para> - Importing a top-level <filename>default.nix</filename> file, if it is - a directory. + Importing a top-level <filename>default.nix</filename> file, if it is a directory. </para> </listitem> </itemizedlist> @@ -120,12 +91,7 @@ </para> <para> - Because overlays that are set in NixOS configuration do not affect - non-NixOS operations such as <literal>nix-env</literal>, the - <filename>overlays.nix</filename> option provides a convenient way to use - the same overlays for a NixOS system configuration and user configuration: - the same file can be used as <filename>overlays.nix</filename> and imported - as the value of <literal>nixpkgs.overlays</literal>. + Because overlays that are set in NixOS configuration do not affect non-NixOS operations such as <literal>nix-env</literal>, the <filename>overlays.nix</filename> option provides a convenient way to use the same overlays for a NixOS system configuration and user configuration: the same file can be used as <filename>overlays.nix</filename> and imported as the value of <literal>nixpkgs.overlays</literal>. </para> <!-- TODO: Example of sharing overlays between NixOS configuration @@ -139,9 +105,7 @@ <title>Defining overlays</title> <para> - Overlays are Nix functions which accept two arguments, conventionally called - <varname>self</varname> and <varname>super</varname>, and return a set of - packages. For example, the following is a valid overlay. + Overlays are Nix functions which accept two arguments, conventionally called <varname>self</varname> and <varname>super</varname>, and return a set of packages. For example, the following is a valid overlay. </para> <programlisting> @@ -158,38 +122,19 @@ self: super: </programlisting> <para> - The first argument (<varname>self</varname>) corresponds to the final - package set. You should use this set for the dependencies of all packages - specified in your overlay. For example, all the dependencies of - <varname>rr</varname> in the example above come from - <varname>self</varname>, as well as the overridden dependencies used in the - <varname>boost</varname> override. + The first argument (<varname>self</varname>) corresponds to the final package set. You should use this set for the dependencies of all packages specified in your overlay. For example, all the dependencies of <varname>rr</varname> in the example above come from <varname>self</varname>, as well as the overridden dependencies used in the <varname>boost</varname> override. </para> <para> - The second argument (<varname>super</varname>) corresponds to the result of - the evaluation of the previous stages of Nixpkgs. It does not contain any of - the packages added by the current overlay, nor any of the following - overlays. This set should be used either to refer to packages you wish to - override, or to access functions defined in Nixpkgs. For example, the - original recipe of <varname>boost</varname> in the above example, comes from - <varname>super</varname>, as well as the <varname>callPackage</varname> - function. + The second argument (<varname>super</varname>) corresponds to the result of the evaluation of the previous stages of Nixpkgs. It does not contain any of the packages added by the current overlay, nor any of the following overlays. This set should be used either to refer to packages you wish to override, or to access functions defined in Nixpkgs. For example, the original recipe of <varname>boost</varname> in the above example, comes from <varname>super</varname>, as well as the <varname>callPackage</varname> function. </para> <para> - The value returned by this function should be a set similar to - <filename>pkgs/top-level/all-packages.nix</filename>, containing overridden - and/or new packages. + The value returned by this function should be a set similar to <filename>pkgs/top-level/all-packages.nix</filename>, containing overridden and/or new packages. </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. + 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> </chapter> diff --git a/nixpkgs/doc/package-notes.xml b/nixpkgs/doc/package-notes.xml index d2c660e22a9b..770b277cd909 100644 --- a/nixpkgs/doc/package-notes.xml +++ b/nixpkgs/doc/package-notes.xml @@ -3,38 +3,23 @@ xml:id="chap-package-notes"> <title>Package Notes</title> <para> - This chapter contains information about how to use and maintain the Nix - expressions for a number of specific packages, such as the Linux kernel or - X.org. + This chapter contains information about how to use and maintain the Nix expressions for a number of specific packages, such as the Linux kernel or X.org. </para> <!--============================================================--> <section xml:id="sec-linux-kernel"> <title>Linux kernel</title> <para> - The Nix expressions to build the Linux kernel are in - <link + 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 - <varname>kernelPatches</varname> which should be a list of <literal>{name, - patch, extraConfig}</literal> attribute sets, where <varname>name</varname> - is the name of the patch (which is included in the kernel’s - <varname>meta.description</varname> attribute), <varname>patch</varname> is - the patch itself (possibly compressed), and <varname>extraConfig</varname> - (optional) is a string specifying extra options to be concatenated to the - kernel configuration file (<filename>.config</filename>). + The function that builds the kernel has an argument <varname>kernelPatches</varname> which should be a list of <literal>{name, patch, extraConfig}</literal> attribute sets, where <varname>name</varname> is the name of the patch (which is included in the kernel’s <varname>meta.description</varname> attribute), <varname>patch</varname> is the patch itself (possibly compressed), and <varname>extraConfig</varname> (optional) is a string specifying extra options to be concatenated to the kernel configuration file (<filename>.config</filename>). </para> <para> - The kernel derivation exports an attribute <varname>features</varname> - specifying whether optional functionality is or isn’t enabled. This is - used in NixOS to implement kernel-specific behaviour. For instance, if the - kernel has the <varname>iwlwifi</varname> feature (i.e. has built-in support - for Intel wireless chipsets), then NixOS doesn’t have to build the - external <varname>iwlwifi</varname> package: + The kernel derivation exports an attribute <varname>features</varname> specifying whether optional functionality is or isn’t enabled. This is used in NixOS to implement kernel-specific behaviour. For instance, if the kernel has the <varname>iwlwifi</varname> feature (i.e. has built-in support for Intel wireless chipsets), then NixOS doesn’t have to build the external <varname>iwlwifi</varname> package: <programlisting> modulesTree = [kernel] ++ pkgs.lib.optional (!kernel.features ? iwlwifi) kernelPackages.iwlwifi @@ -47,45 +32,31 @@ modulesTree = [kernel] <orderedlist> <listitem> <para> - Copy the old Nix expression (e.g. <filename>linux-2.6.21.nix</filename>) - to the new one (e.g. <filename>linux-2.6.22.nix</filename>) and update - it. + Copy the old Nix expression (e.g. <filename>linux-2.6.21.nix</filename>) to the new one (e.g. <filename>linux-2.6.22.nix</filename>) and update it. </para> </listitem> <listitem> <para> - Add the new kernel to <filename>all-packages.nix</filename> (e.g., create - an attribute <varname>kernel_2_6_22</varname>). + Add the new kernel to <filename>all-packages.nix</filename> (e.g., create an attribute <varname>kernel_2_6_22</varname>). </para> </listitem> <listitem> <para> - Now we’re going to update the kernel configuration. First unpack the - kernel. Then for each supported platform (<literal>i686</literal>, - <literal>x86_64</literal>, <literal>uml</literal>) do the following: + Now we’re going to update the kernel configuration. First unpack the kernel. Then for each supported platform (<literal>i686</literal>, <literal>x86_64</literal>, <literal>uml</literal>) do the following: <orderedlist> <listitem> <para> - Make an copy from the old config (e.g. - <filename>config-2.6.21-i686-smp</filename>) to the new one (e.g. - <filename>config-2.6.22-i686-smp</filename>). + Make an copy from the old config (e.g. <filename>config-2.6.21-i686-smp</filename>) to the new one (e.g. <filename>config-2.6.22-i686-smp</filename>). </para> </listitem> <listitem> <para> - 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. + 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. </para> </listitem> <listitem> <para> - Run <literal>make oldconfig - ARCH=<replaceable>{i386,x86_64,um}</replaceable></literal> and answer - all questions. (For the uml configuration, also add - <literal>SHELL=bash</literal>.) Make sure to keep the configuration - consistent between platforms (i.e. don’t enable some feature on - <literal>i686</literal> and disable it on <literal>x86_64</literal>). + Run <literal>make oldconfig ARCH=<replaceable>{i386,x86_64,um}</replaceable></literal> and answer all questions. (For the uml configuration, also add <literal>SHELL=bash</literal>.) Make sure to keep the configuration consistent between platforms (i.e. don’t enable some feature on <literal>i686</literal> and disable it on <literal>x86_64</literal>). </para> </listitem> <listitem> @@ -99,8 +70,7 @@ modulesTree = [kernel] </listitem> <listitem> <para> - Copy <filename>.config</filename> over the new config file (e.g. - <filename>config-2.6.22-i686-smp</filename>). + Copy <filename>.config</filename> over the new config file (e.g. <filename>config-2.6.22-i686-smp</filename>). </para> </listitem> </orderedlist> @@ -108,18 +78,12 @@ modulesTree = [kernel] </listitem> <listitem> <para> - Test building the kernel: <literal>nix-build -A kernel_2_6_22</literal>. - If it compiles, ship it! For extra credit, try booting NixOS with it. + Test building the kernel: <literal>nix-build -A kernel_2_6_22</literal>. If it compiles, ship it! For extra credit, try booting NixOS with it. </para> </listitem> <listitem> <para> - It may be that the new kernel requires updating the external kernel - modules and kernel-dependent packages listed in the - <varname>linuxPackagesFor</varname> function in - <filename>all-packages.nix</filename> (such as the NVIDIA drivers, AUFS, - etc.). If the updated packages aren’t backwards compatible with older - kernels, you may need to keep the older versions around. + It may be that the new kernel requires updating the external kernel modules and kernel-dependent packages listed in the <varname>linuxPackagesFor</varname> function in <filename>all-packages.nix</filename> (such as the NVIDIA drivers, AUFS, etc.). If the updated packages aren’t backwards compatible with older kernels, you may need to keep the older versions around. </para> </listitem> </orderedlist> @@ -130,13 +94,7 @@ modulesTree = [kernel] <title>X.org</title> <para> - The Nix expressions for the X.org packages reside in - <filename>pkgs/servers/x11/xorg/default.nix</filename>. This file is - automatically generated from lists of tarballs in an X.org release. As such - it should not be modified directly; rather, you should modify the lists, the - generator script or the file - <filename>pkgs/servers/x11/xorg/overrides.nix</filename>, in which you can - override or add to the derivations produced by the generator. + The Nix expressions for the X.org packages reside in <filename>pkgs/servers/x11/xorg/default.nix</filename>. This file is automatically generated from lists of tarballs in an X.org release. As such it should not be modified directly; rather, you should modify the lists, the generator script or the file <filename>pkgs/servers/x11/xorg/overrides.nix</filename>, in which you can override or add to the derivations produced by the generator. </para> <para> @@ -146,37 +104,22 @@ modulesTree = [kernel] <prompt>$ </prompt>cat tarballs-7.5.list extra.list old.list \ | perl ./generate-expr-from-tarballs.pl </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.) + 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> <para> - A file like <filename>tarballs-7.5.list</filename> contains all tarballs in - a X.org release. It can be generated like this: + A file like <filename>tarballs-7.5.list</filename> contains all tarballs in a X.org release. It can be generated like this: <screen> <prompt>$ </prompt>export i="mirror://xorg/X11R7.4/src/everything/" <prompt>$ </prompt>cat $(PRINT_PATH=1 nix-prefetch-url $i | tail -n 1) \ | perl -e 'while (<>) { if (/(href|HREF)="([^"]*.bz2)"/) { print "$ENV{'i'}$2\n"; }; }' \ | sort > tarballs-7.4.list </screen> - <filename>extra.list</filename> contains libraries that aren’t part of - X.org proper, but are closely related to it, such as - <literal>libxcb</literal>. <filename>old.list</filename> contains some - packages that were removed from X.org, but are still needed by some people - or by other packages (such as <varname>imake</varname>). + <filename>extra.list</filename> contains libraries that aren’t part of X.org proper, but are closely related to it, such as <literal>libxcb</literal>. <filename>old.list</filename> contains some packages that were removed from X.org, but are still needed by some people or by other packages (such as <varname>imake</varname>). </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>. + 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> <!--============================================================--> @@ -199,41 +142,19 @@ modulesTree = [kernel] <title>Eclipse</title> <para> - The Nix expressions related to the Eclipse platform and IDE are in - <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/editors/eclipse"><filename>pkgs/applications/editors/eclipse</filename></link>. + The Nix expressions related to the Eclipse platform and IDE are in <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/editors/eclipse"><filename>pkgs/applications/editors/eclipse</filename></link>. </para> <para> - Nixpkgs provides a number of packages that will install Eclipse in its - various forms. These range from the bare-bones Eclipse Platform to the more - fully featured Eclipse SDK or Scala-IDE packages and multiple version are - often available. It is possible to list available Eclipse packages by - issuing the command: + Nixpkgs provides a number of packages that will install Eclipse in its various forms. These range from the bare-bones Eclipse Platform to the more fully featured Eclipse SDK or Scala-IDE packages and multiple version are often available. It is possible to list available Eclipse packages by issuing the command: <screen> <prompt>$ </prompt>nix-env -f '<nixpkgs>' -qaP -A eclipses --description </screen> - Once an Eclipse variant is installed it can be run using the - <command>eclipse</command> command, as expected. From within Eclipse it is - then possible to install plugins in the usual manner by either manually - specifying an Eclipse update site or by installing the Marketplace Client - plugin and using it to discover and install other plugins. This installation - method provides an Eclipse installation that closely resemble a manually - installed Eclipse. + Once an Eclipse variant is installed it can be run using the <command>eclipse</command> command, as expected. From within Eclipse it is then possible to install plugins in the usual manner by either manually specifying an Eclipse update site or by installing the Marketplace Client plugin and using it to discover and install other plugins. This installation method provides an Eclipse installation that closely resemble a manually installed Eclipse. </para> <para> - If you prefer to install plugins in a more declarative manner then Nixpkgs - also offer a number of Eclipse plugins that can be installed in an - <emphasis>Eclipse environment</emphasis>. This type of environment is - created using the function <varname>eclipseWithPlugins</varname> found - inside the <varname>nixpkgs.eclipses</varname> attribute set. This function - takes as argument <literal>{ eclipse, plugins ? [], jvmArgs ? [] }</literal> - where <varname>eclipse</varname> is a one of the Eclipse packages described - above, <varname>plugins</varname> is a list of plugin derivations, and - <varname>jvmArgs</varname> is a list of arguments given to the JVM running - the Eclipse. For example, say you wish to install the latest Eclipse - Platform with the popular Eclipse Color Theme plugin and also allow Eclipse - to use more RAM. You could then add + If you prefer to install plugins in a more declarative manner then Nixpkgs also offer a number of Eclipse plugins that can be installed in an <emphasis>Eclipse environment</emphasis>. This type of environment is created using the function <varname>eclipseWithPlugins</varname> found inside the <varname>nixpkgs.eclipses</varname> attribute set. This function takes as argument <literal>{ eclipse, plugins ? [], jvmArgs ? [] }</literal> where <varname>eclipse</varname> is a one of the Eclipse packages described above, <varname>plugins</varname> is a list of plugin derivations, and <varname>jvmArgs</varname> is a list of arguments given to the JVM running the Eclipse. For example, say you wish to install the latest Eclipse Platform with the popular Eclipse Color Theme plugin and also allow Eclipse to use more RAM. You could then add <screen> packageOverrides = pkgs: { myEclipse = with pkgs.eclipses; eclipseWithPlugins { @@ -243,38 +164,18 @@ packageOverrides = pkgs: { }; } </screen> - to your Nixpkgs configuration - (<filename>~/.config/nixpkgs/config.nix</filename>) and install it by - running <command>nix-env -f '<nixpkgs>' -iA myEclipse</command> and - afterward run Eclipse as usual. It is possible to find out which plugins are - available for installation using <varname>eclipseWithPlugins</varname> by - running + to your Nixpkgs configuration (<filename>~/.config/nixpkgs/config.nix</filename>) and install it by running <command>nix-env -f '<nixpkgs>' -iA myEclipse</command> and afterward run Eclipse as usual. It is possible to find out which plugins are available for installation using <varname>eclipseWithPlugins</varname> by running <screen> <prompt>$ </prompt>nix-env -f '<nixpkgs>' -qaP -A eclipses.plugins --description </screen> </para> <para> - If there is a need to install plugins that are not available in Nixpkgs then - it may be possible to define these plugins outside Nixpkgs using the - <varname>buildEclipseUpdateSite</varname> and - <varname>buildEclipsePlugin</varname> functions found in the - <varname>nixpkgs.eclipses.plugins</varname> attribute set. Use the - <varname>buildEclipseUpdateSite</varname> function to install a plugin - distributed as an Eclipse update site. This function takes <literal>{ name, - src }</literal> as argument where <literal>src</literal> indicates the - Eclipse update site archive. All Eclipse features and plugins within the - downloaded update site will be installed. When an update site archive is not - available then the <varname>buildEclipsePlugin</varname> function can be - used to install a plugin that consists of a pair of feature and plugin JARs. - This function takes an argument <literal>{ name, srcFeature, srcPlugin - }</literal> where <literal>srcFeature</literal> and - <literal>srcPlugin</literal> are the feature and plugin JARs, respectively. + If there is a need to install plugins that are not available in Nixpkgs then it may be possible to define these plugins outside Nixpkgs using the <varname>buildEclipseUpdateSite</varname> and <varname>buildEclipsePlugin</varname> functions found in the <varname>nixpkgs.eclipses.plugins</varname> attribute set. Use the <varname>buildEclipseUpdateSite</varname> function to install a plugin distributed as an Eclipse update site. This function takes <literal>{ name, src }</literal> as argument where <literal>src</literal> indicates the Eclipse update site archive. All Eclipse features and plugins within the downloaded update site will be installed. When an update site archive is not available then the <varname>buildEclipsePlugin</varname> function can be used to install a plugin that consists of a pair of feature and plugin JARs. This function takes an argument <literal>{ name, srcFeature, srcPlugin }</literal> where <literal>srcFeature</literal> and <literal>srcPlugin</literal> are the feature and plugin JARs, respectively. </para> <para> - Expanding the previous example with two plugins using the above functions we - have + Expanding the previous example with two plugins using the above functions we have <screen> packageOverrides = pkgs: { myEclipse = with pkgs.eclipses; eclipseWithPlugins { @@ -315,14 +216,11 @@ packageOverrides = pkgs: { </para> <para> - To update Elm compiler, see - <filename>nixpkgs/pkgs/development/compilers/elm/README.md</filename>. + To update Elm compiler, see <filename>nixpkgs/pkgs/development/compilers/elm/README.md</filename>. </para> <para> - To package Elm applications, - <link xlink:href="https://github.com/hercules-ci/elm2nix#elm2nix">read about - elm2nix</link>. + To package Elm applications, <link xlink:href="https://github.com/hercules-ci/elm2nix#elm2nix">read about elm2nix</link>. </para> </section> <section xml:id="sec-kakoune"> @@ -341,11 +239,7 @@ packageOverrides = pkgs: { <title>Interactive shell helpers</title> <para> - Some packages provide the shell integration to be more useful. But unlike - other systems, nix doesn't have a standard share directory location. This is - why a bunch <command>PACKAGE-share</command> scripts are shipped that print - the location of the corresponding shared folder. Current list of such - packages is as following: + Some packages provide the shell integration to be more useful. But unlike other systems, nix doesn't have a standard share directory location. This is why a bunch <command>PACKAGE-share</command> scripts are shipped that print the location of the corresponding shared folder. Current list of such packages is as following: <itemizedlist> <listitem> <para> @@ -368,31 +262,20 @@ packageOverrides = pkgs: { <title>Weechat</title> <para> - Weechat can be configured to include your choice of plugins, reducing its - closure size from the default configuration which includes all available - plugins. To make use of this functionality, install an expression that - overrides its configuration such as + Weechat can be configured to include your choice of plugins, reducing its closure size from the default configuration which includes all available plugins. To make use of this functionality, install an expression that overrides its configuration such as <programlisting>weechat.override {configure = {availablePlugins, ...}: { plugins = with availablePlugins; [ python perl ]; } }</programlisting> - If the <literal>configure</literal> function returns an attrset without the - <literal>plugins</literal> attribute, <literal>availablePlugins</literal> - will be used automatically. + If the <literal>configure</literal> function returns an attrset without the <literal>plugins</literal> attribute, <literal>availablePlugins</literal> will be used automatically. </para> <para> - The plugins currently available are <literal>python</literal>, - <literal>perl</literal>, <literal>ruby</literal>, <literal>guile</literal>, - <literal>tcl</literal> and <literal>lua</literal>. + The plugins currently available are <literal>python</literal>, <literal>perl</literal>, <literal>ruby</literal>, <literal>guile</literal>, <literal>tcl</literal> and <literal>lua</literal>. </para> <para> - The python and perl plugins allows the addition of extra libraries. For - instance, the <literal>inotify.py</literal> script in weechat-scripts - requires D-Bus or libnotify, and the <literal>fish.py</literal> script - requires pycrypto. To use these scripts, use the plugin's - <literal>withPackages</literal> attribute: + The python and perl plugins allows the addition of extra libraries. For instance, the <literal>inotify.py</literal> script in weechat-scripts requires D-Bus or libnotify, and the <literal>fish.py</literal> script requires pycrypto. To use these scripts, use the plugin's <literal>withPackages</literal> attribute: <programlisting>weechat.override { configure = {availablePlugins, ...}: { plugins = with availablePlugins; [ (python.withPackages (ps: with ps; [ pycrypto python-dbus ])) @@ -403,8 +286,7 @@ packageOverrides = pkgs: { </para> <para> - In order to also keep all default plugins installed, it is possible to use - the following method: + In order to also keep all default plugins installed, it is possible to use the following method: <programlisting>weechat.override { configure = { availablePlugins, ... }: { plugins = builtins.attrValues (availablePlugins // { python = availablePlugins.python.withPackages (ps: with ps; [ pycrypto python-dbus ]); @@ -414,9 +296,7 @@ packageOverrides = pkgs: { </para> <para> - WeeChat allows to set defaults on startup using the - <literal>--run-command</literal>. The <literal>configure</literal> method - can be used to pass commands to the program: + WeeChat allows to set defaults on startup using the <literal>--run-command</literal>. The <literal>configure</literal> method can be used to pass commands to the program: <programlisting>weechat.override { configure = { availablePlugins, ... }: { init = '' @@ -425,14 +305,11 @@ packageOverrides = pkgs: { ''; }; }</programlisting> - Further values can be added to the list of commands when running - <literal>weechat --run-command "your-commands"</literal>. + Further values can be added to the list of commands when running <literal>weechat --run-command "your-commands"</literal>. </para> <para> - Additionally it's possible to specify scripts to be loaded when starting - <literal>weechat</literal>. These will be loaded before the commands from - <literal>init</literal>: + Additionally it's possible to specify scripts to be loaded when starting <literal>weechat</literal>. These will be loaded before the commands from <literal>init</literal>: <programlisting>weechat.override { configure = { availablePlugins, ... }: { scripts = with pkgs.weechatScripts; [ @@ -446,11 +323,7 @@ packageOverrides = pkgs: { </para> <para> - In <literal>nixpkgs</literal> there's a subpackage which contains - derivations for WeeChat scripts. Such derivations expect a - <literal>passthru.scripts</literal> attribute which contains a list of all - scripts inside the store path. Furthermore all scripts have to live in - <literal>$out/share</literal>. An exemplary derivation looks like this: + In <literal>nixpkgs</literal> there's a subpackage which contains derivations for WeeChat scripts. Such derivations expect a <literal>passthru.scripts</literal> attribute which contains a list of all scripts inside the store path. Furthermore all scripts have to live in <literal>$out/share</literal>. An exemplary derivation looks like this: <programlisting>{ stdenv, fetchurl }: stdenv.mkDerivation { @@ -479,18 +352,11 @@ stdenv.mkDerivation { <title>Activating the engine</title> <para> - IBus needs to be configured accordingly to activate - <literal>typing-booster</literal>. The configuration depends on the desktop - manager in use. For detailed instructions, please refer to the - <link xlink:href="https://mike-fabian.github.io/ibus-typing-booster/documentation.html">upstream - docs</link>. + IBus needs to be configured accordingly to activate <literal>typing-booster</literal>. The configuration depends on the desktop manager in use. For detailed instructions, please refer to the <link xlink:href="https://mike-fabian.github.io/ibus-typing-booster/documentation.html">upstream docs</link>. </para> <para> - On NixOS you need to explicitly enable <literal>ibus</literal> with given - engines before customizing your desktop to use - <literal>typing-booster</literal>. This can be achieved using the - <literal>ibus</literal> module: + On NixOS you need to explicitly enable <literal>ibus</literal> with given engines before customizing your desktop to use <literal>typing-booster</literal>. This can be achieved using the <literal>ibus</literal> module: <programlisting>{ pkgs, ... }: { i18n.inputMethod = { enabled = "ibus"; @@ -504,20 +370,14 @@ stdenv.mkDerivation { <title>Using custom hunspell dictionaries</title> <para> - The IBus engine is based on <literal>hunspell</literal> to support - completion in many languages. By default the dictionaries - <literal>de-de</literal>, <literal>en-us</literal>, <literal>fr-moderne</literal> - <literal>es-es</literal>, <literal>it-it</literal>, - <literal>sv-se</literal> and <literal>sv-fi</literal> are in use. To add - another dictionary, the package can be overridden like this: + The IBus engine is based on <literal>hunspell</literal> to support completion in many languages. By default the dictionaries <literal>de-de</literal>, <literal>en-us</literal>, <literal>fr-moderne</literal> <literal>es-es</literal>, <literal>it-it</literal>, <literal>sv-se</literal> and <literal>sv-fi</literal> are in use. To add another dictionary, the package can be overridden like this: <programlisting>ibus-engines.typing-booster.override { langs = [ "de-at" "en-gb" ]; }</programlisting> </para> <para> - <emphasis>Note: each language passed to <literal>langs</literal> must be an - attribute name in <literal>pkgs.hunspellDicts</literal>.</emphasis> + <emphasis>Note: each language passed to <literal>langs</literal> must be an attribute name in <literal>pkgs.hunspellDicts</literal>.</emphasis> </para> </section> @@ -525,10 +385,7 @@ stdenv.mkDerivation { <title>Built-in emoji picker</title> <para> - The <literal>ibus-engines.typing-booster</literal> package contains a - program named <literal>emoji-picker</literal>. To display all emojis - correctly, a special font such as <literal>noto-fonts-emoji</literal> is - needed: + The <literal>ibus-engines.typing-booster</literal> package contains a program named <literal>emoji-picker</literal>. To display all emojis correctly, a special font such as <literal>noto-fonts-emoji</literal> is needed: </para> <para> @@ -543,47 +400,22 @@ stdenv.mkDerivation { <title>Nginx</title> <para> - <link xlink:href="https://nginx.org/">Nginx</link> is a - reverse proxy and lightweight webserver. + <link xlink:href="https://nginx.org/">Nginx</link> is a reverse proxy and lightweight webserver. </para> <section xml:id="sec-nginx-etag"> <title>ETags on static files served from the Nix store</title> <para> - HTTP has a couple different mechanisms for caching to prevent - clients from having to download the same content repeatedly - if a resource has not changed since the last time it was requested. - When nginx is used as a server for static files, it implements - the caching mechanism based on the - <link xlink:href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Last-Modified"><literal>Last-Modified</literal></link> - response header automatically; unfortunately, it works by using - filesystem timestamps to determine the value of the - <literal>Last-Modified</literal> header. This doesn't give the - desired behavior when the file is in the Nix store, because all - file timestamps are set to 0 (for reasons related to build - reproducibility). + HTTP has a couple different mechanisms for caching to prevent clients from having to download the same content repeatedly if a resource has not changed since the last time it was requested. When nginx is used as a server for static files, it implements the caching mechanism based on the <link xlink:href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Last-Modified"><literal>Last-Modified</literal></link> response header automatically; unfortunately, it works by using filesystem timestamps to determine the value of the <literal>Last-Modified</literal> header. This doesn't give the desired behavior when the file is in the Nix store, because all file timestamps are set to 0 (for reasons related to build reproducibility). </para> <para> - Fortunately, HTTP supports an alternative (and more effective) - caching mechanism: the - <link xlink:href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag"><literal>ETag</literal></link> - response header. The value of the <literal>ETag</literal> header - specifies some identifier for the particular content that the - server is sending (e.g. a hash). When a client makes a second - request for the same resource, it sends that value back in an - <literal>If-None-Match</literal> header. If the ETag value is - unchanged, then the server does not need to resend the content. + Fortunately, HTTP supports an alternative (and more effective) caching mechanism: the <link xlink:href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag"><literal>ETag</literal></link> response header. The value of the <literal>ETag</literal> header specifies some identifier for the particular content that the server is sending (e.g. a hash). When a client makes a second request for the same resource, it sends that value back in an <literal>If-None-Match</literal> header. If the ETag value is unchanged, then the server does not need to resend the content. </para> <para> - As of NixOS 19.09, the nginx package in Nixpkgs is patched such - that when nginx serves a file out of <filename>/nix/store</filename>, - the hash in the store path is used as the <literal>ETag</literal> - header in the HTTP response, thus providing proper caching functionality. - This happens automatically; you do not need to do modify any - configuration to get this behavior. + As of NixOS 19.09, the nginx package in Nixpkgs is patched such that when nginx serves a file out of <filename>/nix/store</filename>, the hash in the store path is used as the <literal>ETag</literal> header in the HTTP response, thus providing proper caching functionality. This happens automatically; you do not need to do modify any configuration to get this behavior. </para> </section> </section> diff --git a/nixpkgs/doc/package-specific-user-notes.xml b/nixpkgs/doc/package-specific-user-notes.xml index a176f4d13959..a3ee42dc7fa0 100644 --- a/nixpkgs/doc/package-specific-user-notes.xml +++ b/nixpkgs/doc/package-specific-user-notes.xml @@ -1,53 +1,26 @@ <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="package-specific-user-notes"> <title>Package-specific usage notes</title> <para> - These chapters includes some notes - that apply to specific packages and should - answer some of the frequently asked questions - related to Nixpkgs use. - - Some useful information related to package use - can be found in <link linkend="chap-package-notes">package-specific development notes</link>. - + These chapters includes some notes that apply to specific packages and should answer some of the frequently asked questions related to Nixpkgs use. Some useful information related to package use can be found in <link linkend="chap-package-notes">package-specific development notes</link>. </para> <section xml:id="opengl"> <title>OpenGL</title> <para> - Packages that use OpenGL have NixOS desktop as their primary target. The - current solution for loading the GPU-specific drivers is based on - <literal>libglvnd</literal> and looks for the driver implementation in - <literal>LD_LIBRARY_PATH</literal>. If you are using a non-NixOS - GNU/Linux/X11 desktop with free software video drivers, consider launching - OpenGL-dependent programs from Nixpkgs with Nixpkgs versions of - <literal>libglvnd</literal> and <literal>mesa_drivers</literal> in - <literal>LD_LIBRARY_PATH</literal>. For proprietary video drivers you might - have luck with also adding the corresponding video driver package. + Packages that use OpenGL have NixOS desktop as their primary target. The current solution for loading the GPU-specific drivers is based on <literal>libglvnd</literal> and looks for the driver implementation in <literal>LD_LIBRARY_PATH</literal>. If you are using a non-NixOS GNU/Linux/X11 desktop with free software video drivers, consider launching OpenGL-dependent programs from Nixpkgs with Nixpkgs versions of <literal>libglvnd</literal> and <literal>mesa_drivers</literal> in <literal>LD_LIBRARY_PATH</literal>. For proprietary video drivers you might have luck with also adding the corresponding video driver package. </para> </section> <section xml:id="locales"> <title>Locales</title> <para> - To allow simultaneous use of packages linked against different versions of - <literal>glibc</literal> with different locale archive formats Nixpkgs - patches <literal>glibc</literal> to rely on - <literal>LOCALE_ARCHIVE</literal> environment variable. + To allow simultaneous use of packages linked against different versions of <literal>glibc</literal> with different locale archive formats Nixpkgs patches <literal>glibc</literal> to rely on <literal>LOCALE_ARCHIVE</literal> environment variable. </para> <para> - On non-NixOS distributions this variable is obviously not set. This can - cause regressions in language support or even crashes in some - Nixpkgs-provided programs. The simplest way to mitigate this problem is - exporting the <literal>LOCALE_ARCHIVE</literal> variable pointing to - <literal>${glibcLocales}/lib/locale/locale-archive</literal>. The drawback - (and the reason this is not the default) is the relatively large (a hundred - MiB) size of the full set of locales. It is possible to build a custom set - of locales by overriding parameters <literal>allLocales</literal> and - <literal>locales</literal> of the package. + On non-NixOS distributions this variable is obviously not set. This can cause regressions in language support or even crashes in some Nixpkgs-provided programs. The simplest way to mitigate this problem is exporting the <literal>LOCALE_ARCHIVE</literal> variable pointing to <literal>${glibcLocales}/lib/locale/locale-archive</literal>. The drawback (and the reason this is not the default) is the relatively large (a hundred MiB) size of the full set of locales. It is possible to build a custom set of locales by overriding parameters <literal>allLocales</literal> and <literal>locales</literal> of the package. </para> </section> - <section xml:id="sec-emacs"> <title>Emacs</title> @@ -55,15 +28,7 @@ <title>Configuring Emacs</title> <para> - The Emacs package comes with some extra helpers to make it easier to - configure. <varname>emacsWithPackages</varname> allows you to manage - packages from ELPA. This means that you will not have to install that - packages from within Emacs. For instance, if you wanted to use - <literal>company</literal>, <literal>counsel</literal>, - <literal>flycheck</literal>, <literal>ivy</literal>, - <literal>magit</literal>, <literal>projectile</literal>, and - <literal>use-package</literal> you could use this as a - <filename>~/.config/nixpkgs/config.nix</filename> override: + The Emacs package comes with some extra helpers to make it easier to configure. <varname>emacsWithPackages</varname> allows you to manage packages from ELPA. This means that you will not have to install that packages from within Emacs. For instance, if you wanted to use <literal>company</literal>, <literal>counsel</literal>, <literal>flycheck</literal>, <literal>ivy</literal>, <literal>magit</literal>, <literal>projectile</literal>, and <literal>use-package</literal> you could use this as a <filename>~/.config/nixpkgs/config.nix</filename> override: </para> <screen> @@ -83,15 +48,7 @@ </screen> <para> - You can install it like any other packages via <command>nix-env -iA - myEmacs</command>. However, this will only install those packages. It will - not <literal>configure</literal> them for us. To do this, we need to - provide a configuration file. Luckily, it is possible to do this from - within Nix! By modifying the above example, we can make Emacs load a custom - config file. The key is to create a package that provide a - <filename>default.el</filename> file in - <filename>/share/emacs/site-start/</filename>. Emacs knows to load this - file automatically when it starts. + You can install it like any other packages via <command>nix-env -iA myEmacs</command>. However, this will only install those packages. It will not <literal>configure</literal> them for us. To do this, we need to provide a configuration file. Luckily, it is possible to do this from within Nix! By modifying the above example, we can make Emacs load a custom config file. The key is to create a package that provide a <filename>default.el</filename> file in <filename>/share/emacs/site-start/</filename>. Emacs knows to load this file automatically when it starts. </para> <screen> @@ -173,22 +130,11 @@ cp ${myEmacsConfig} $out/share/emacs/site-lisp/default.el </screen> <para> - This provides a fairly full Emacs start file. It will load in addition to - the user's presonal config. You can always disable it by passing - <command>-q</command> to the Emacs command. + This provides a fairly full Emacs start file. It will load in addition to the user's presonal config. You can always disable it by passing <command>-q</command> to the Emacs command. </para> <para> - Sometimes <varname>emacsWithPackages</varname> is not enough, as this - package set has some priorities imposed on packages (with the lowest - priority assigned to Melpa Unstable, and the highest for packages manually - defined in <filename>pkgs/top-level/emacs-packages.nix</filename>). But you - can't control this priorities when some package is installed as a - dependency. You can override it on per-package-basis, providing all the - required dependencies manually - but it's tedious and there is always a - possibility that an unwanted dependency will sneak in through some other - package. To completely override such a package you can use - <varname>overrideScope'</varname>. + Sometimes <varname>emacsWithPackages</varname> is not enough, as this package set has some priorities imposed on packages (with the lowest priority assigned to Melpa Unstable, and the highest for packages manually defined in <filename>pkgs/top-level/emacs-packages.nix</filename>). But you can't control this priorities when some package is installed as a dependency. You can override it on per-package-basis, providing all the required dependencies manually - but it's tedious and there is always a possibility that an unwanted dependency will sneak in through some other package. To completely override such a package you can use <varname>overrideScope'</varname>. </para> <screen> @@ -204,59 +150,39 @@ overrides = self: super: rec { </screen> </section> </section> - <section xml:id="dlib"> <title>DLib</title> <para> - <link xlink:href="http://dlib.net/">DLib</link> is a modern, C++-based toolkit which - provides several machine learning algorithms. + <link xlink:href="http://dlib.net/">DLib</link> is a modern, C++-based toolkit which provides several machine learning algorithms. </para> <section xml:id="compiling-without-avx-support"> <title>Compiling without AVX support</title> <para> - Especially older CPUs don't support - <link xlink:href="https://en.wikipedia.org/wiki/Advanced_Vector_Extensions">AVX</link> - (<abbrev>Advanced Vector Extensions</abbrev>) instructions that are used by DLib to - optimize their algorithms. + Especially older CPUs don't support <link xlink:href="https://en.wikipedia.org/wiki/Advanced_Vector_Extensions">AVX</link> (<abbrev>Advanced Vector Extensions</abbrev>) instructions that are used by DLib to optimize their algorithms. </para> <para> - On the affected hardware errors like <literal>Illegal instruction</literal> will occur. - In those cases AVX support needs to be disabled: + On the affected hardware errors like <literal>Illegal instruction</literal> will occur. In those cases AVX support needs to be disabled: <programlisting>self: super: { dlib = super.dlib.override { avxSupport = false; }; }</programlisting> </para> </section> </section> - <section xml:id="unfree-software"> <title>Unfree software</title> <para> - All users of Nixpkgs are free software users, and many users (and - developers) of Nixpkgs want to limit and tightly control their exposure to - unfree software. At the same time, many users need (or want) - to run some specific - pieces of proprietary software. Nixpkgs includes some expressions for unfree - software packages. By default unfree software cannot be installed and - doesn’t show up in searches. To allow installing unfree software in a - single Nix invocation one can export - <literal>NIXPKGS_ALLOW_UNFREE=1</literal>. For a persistent solution, users - can set <literal>allowUnfree</literal> in the Nixpkgs configuration. + All users of Nixpkgs are free software users, and many users (and developers) of Nixpkgs want to limit and tightly control their exposure to unfree software. At the same time, many users need (or want) to run some specific pieces of proprietary software. Nixpkgs includes some expressions for unfree software packages. By default unfree software cannot be installed and doesn’t show up in searches. To allow installing unfree software in a single Nix invocation one can export <literal>NIXPKGS_ALLOW_UNFREE=1</literal>. For a persistent solution, users can set <literal>allowUnfree</literal> in the Nixpkgs configuration. </para> <para> - Fine-grained control is possible by defining - <literal>allowUnfreePredicate</literal> function in config; it takes the - <literal>mkDerivation</literal> parameter attrset and returns - <literal>true</literal> for unfree packages that should be allowed. + Fine-grained control is possible by defining <literal>allowUnfreePredicate</literal> function in config; it takes the <literal>mkDerivation</literal> parameter attrset and returns <literal>true</literal> for unfree packages that should be allowed. </para> </section> - <section xml:id="sec-steam"> <title>Steam</title> @@ -264,13 +190,7 @@ overrides = self: super: rec { <title>Steam in Nix</title> <para> - Steam is distributed as a <filename>.deb</filename> file, for now only as - an i686 package (the amd64 package only has documentation). When unpacked, - it has a script called <filename>steam</filename> that in Ubuntu (their - target distro) would go to <filename>/usr/bin </filename>. When run for the - first time, this script copies some files to the user's home, which include - another script that is the ultimate responsible for launching the steam - binary, which is also in $HOME. + Steam is distributed as a <filename>.deb</filename> file, for now only as an i686 package (the amd64 package only has documentation). When unpacked, it has a script called <filename>steam</filename> that in Ubuntu (their target distro) would go to <filename>/usr/bin </filename>. When run for the first time, this script copies some files to the user's home, which include another script that is the ultimate responsible for launching the steam binary, which is also in $HOME. </para> <para> @@ -278,8 +198,7 @@ overrides = self: super: rec { <itemizedlist> <listitem> <para> - We don't have <filename>/bin/bash</filename> and many scripts point - there. Similarly for <filename>/usr/bin/python</filename> . + We don't have <filename>/bin/bash</filename> and many scripts point there. Similarly for <filename>/usr/bin/python</filename> . </para> </listitem> <listitem> @@ -289,8 +208,7 @@ overrides = self: super: rec { </listitem> <listitem> <para> - The <filename>steam.sh</filename> script in $HOME can not be patched, as - it is checked and rewritten by steam. + The <filename>steam.sh</filename> script in $HOME can not be patched, as it is checked and rewritten by steam. </para> </listitem> <listitem> @@ -302,11 +220,7 @@ overrides = self: super: rec { </para> <para> - The current approach to deploy Steam in NixOS is composing a FHS-compatible - chroot environment, as documented - <link xlink:href="http://sandervanderburg.blogspot.nl/2013/09/composing-fhs-compatible-chroot.html">here</link>. - This allows us to have binaries in the expected paths without disrupting - the system, and to avoid patching them to work in a non FHS environment. + The current approach to deploy Steam in NixOS is composing a FHS-compatible chroot environment, as documented <link xlink:href="http://sandervanderburg.blogspot.nl/2013/09/composing-fhs-compatible-chroot.html">here</link>. This allows us to have binaries in the expected paths without disrupting the system, and to avoid patching them to work in a non FHS environment. </para> </section> @@ -318,9 +232,7 @@ overrides = self: super: rec { <programlisting>hardware.opengl.driSupport32Bit = true;</programlisting> in your <filename>/etc/nixos/configuration.nix</filename>. You'll also need <programlisting>hardware.pulseaudio.support32Bit = true;</programlisting> - if you are using PulseAudio - this will enable 32bit ALSA apps integration. - To use the Steam controller or other Steam supported controllers such as - the DualShock 4 or Nintendo Switch Pro, you need to add + if you are using PulseAudio - this will enable 32bit ALSA apps integration. To use the Steam controller or other Steam supported controllers such as the DualShock 4 or Nintendo Switch Pro, you need to add <programlisting>hardware.steam-hardware.enable = true;</programlisting> to your configuration. </para> @@ -351,19 +263,14 @@ overrides = self: super: rec { <itemizedlist> <listitem> <para> - The <literal>newStdcpp</literal> parameter was removed since NixOS - 17.09 and should not be needed anymore. + The <literal>newStdcpp</literal> parameter was removed since NixOS 17.09 and should not be needed anymore. </para> </listitem> <listitem> <para> - Steam ships statically linked with a version of libcrypto that - conflics with the one dynamically loaded by radeonsi_dri.so. If you - get the error + Steam ships statically linked with a version of libcrypto that conflics with the one dynamically loaded by radeonsi_dri.so. If you get the error <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 <link xlink:href="https://github.com/NixOS/nixpkgs/pull/20269">this pull request</link>. </para> </listitem> </itemizedlist> @@ -377,8 +284,7 @@ overrides = self: super: rec { <orderedlist> <listitem> <para> - There is no java in steam chrootenv by default. If you get a message - like + 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> You need to add <programlisting> steam.override { withJava = true; };</programlisting> @@ -396,8 +302,7 @@ overrides = self: super: rec { <title>steam-run</title> <para> - The FHS-compatible chroot used for steam can also be used to run other - linux games that expect a FHS environment. To do it, add + The FHS-compatible chroot used for steam can also be used to run other linux games that expect a FHS environment. To do it, add <programlisting>pkgs.(steam.override { nativeOnly = true; newStdcpp = true; @@ -407,49 +312,29 @@ overrides = self: super: rec { </para> </section> </section> - <section xml:id="sec-citrix"> <title>Citrix Receiver & Citrix Workspace App</title> <para> <note> <para> - Please note that the <literal>citrix_receiver</literal> package has been deprecated since its - development was <link xlink:href="https://docs.citrix.com/en-us/citrix-workspace-app.html">discontinued by upstream</link> - and will be replaced by <link xlink:href="https://www.citrix.com/products/workspace-app/">the citrix workspace app</link>. + Please note that the <literal>citrix_receiver</literal> package has been deprecated since its development was <link xlink:href="https://docs.citrix.com/en-us/citrix-workspace-app.html">discontinued by upstream</link> and has been replaced by <link xlink:href="https://www.citrix.com/products/workspace-app/">the citrix workspace app</link>. </para> </note> - <link xlink:href="https://www.citrix.com/products/receiver/">Citrix Receiver</link> and - <link xlink:href="https://www.citrix.com/products/workspace-app/">Citrix Workspace App</link> - are a remote desktop viewers which provide access to - <link xlink:href="https://www.citrix.com/products/xenapp-xendesktop/">XenDesktop</link> - installations. + <link xlink:href="https://www.citrix.com/products/receiver/">Citrix Receiver</link> and <link xlink:href="https://www.citrix.com/products/workspace-app/">Citrix Workspace App</link> are a remote desktop viewers which provide access to <link xlink:href="https://www.citrix.com/products/xenapp-xendesktop/">XenDesktop</link> installations. </para> <section xml:id="sec-citrix-base"> <title>Basic usage</title> <para> - The tarball archive needs to be downloaded manually as the license - agreements of the vendor for - <link xlink:href="https://www.citrix.com/downloads/citrix-receiver/">Citrix Receiver</link> - or <link xlink:href="https://www.citrix.de/downloads/workspace-app/linux/workspace-app-for-linux-latest.html">Citrix Workspace</link> - need to be accepted first. - Then run <command>nix-prefetch-url file://$PWD/linuxx64-$version.tar.gz</command>. - With the archive available - in the store the package can be built and installed with Nix. + The tarball archive needs to be downloaded manually as the license agreements of the vendor for <link xlink:href="https://www.citrix.com/downloads/citrix-receiver/">Citrix Receiver</link> or <link xlink:href="https://www.citrix.de/downloads/workspace-app/linux/workspace-app-for-linux-latest.html">Citrix Workspace</link> need to be accepted first. Then run <command>nix-prefetch-url file://$PWD/linuxx64-$version.tar.gz</command>. With the archive available in the store the package can be built and installed with Nix. </para> <warning> <title>Caution with <command>nix-shell</command> installs</title> <para> - It's recommended to install <literal>Citrix Receiver</literal> - and/or <literal>Citrix Workspace</literal> using - <literal>nix-env -i</literal> or globally to - ensure that the <literal>.desktop</literal> files are installed properly - into <literal>$XDG_CONFIG_DIRS</literal>. Otherwise it won't be possible to - open <literal>.ica</literal> files automatically from the browser to start - a Citrix connection. + It's recommended to install <literal>Citrix Receiver</literal> and/or <literal>Citrix Workspace</literal> using <literal>nix-env -i</literal> or globally to ensure that the <literal>.desktop</literal> files are installed properly into <literal>$XDG_CONFIG_DIRS</literal>. Otherwise it won't be possible to open <literal>.ica</literal> files automatically from the browser to start a Citrix connection. </para> </warning> </section> @@ -458,21 +343,11 @@ overrides = self: super: rec { <title>Custom certificates</title> <para> - The <literal>Citrix Receiver</literal> and <literal>Citrix Workspace App</literal> - in <literal>nixpkgs</literal> trust several certificates - <link xlink:href="https://curl.haxx.se/docs/caextract.html">from the - Mozilla database</link> by default. However several companies using Citrix - might require their own corporate certificate. On distros with imperative - packaging these certs can be stored easily in - <link xlink:href="https://developer-docs.citrix.com/projects/receiver-for-linux-command-reference/en/13.7/"><literal>$ICAROOT</literal></link>, - however this directory is a store path in <literal>nixpkgs</literal>. In - order to work around this issue the package provides a simple mechanism to - add custom certificates without rebuilding the entire package using - <literal>symlinkJoin</literal>: + The <literal>Citrix Workspace App</literal> in <literal>nixpkgs</literal> trust several certificates <link xlink:href="https://curl.haxx.se/docs/caextract.html">from the Mozilla database</link> by default. However several companies using Citrix might require their own corporate certificate. On distros with imperative packaging these certs can be stored easily in <link xlink:href="https://developer-docs.citrix.com/projects/receiver-for-linux-command-reference/en/13.7/"><literal>$ICAROOT</literal></link>, however this directory is a store path in <literal>nixpkgs</literal>. In order to work around this issue the package provides a simple mechanism to add custom certificates without rebuilding the entire package using <literal>symlinkJoin</literal>: <programlisting> <![CDATA[with import <nixpkgs> { config.allowUnfree = true; }; let extraCerts = [ ./custom-cert-1.pem ./custom-cert-2.pem /* ... */ ]; in -citrix_workspace.override { # the same applies for `citrix_receiver` if used. +citrix_workspace.override { inherit extraCerts; }]]> </programlisting> diff --git a/nixpkgs/doc/platform-notes.xml b/nixpkgs/doc/platform-notes.xml index 157d3fe2fcdd..d8d7692fc9a7 100644 --- a/nixpkgs/doc/platform-notes.xml +++ b/nixpkgs/doc/platform-notes.xml @@ -12,12 +12,7 @@ <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. + 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> stdenv.mkDerivation { @@ -31,12 +26,7 @@ stdenv.mkDerivation { </listitem> <listitem> <para> - On Darwin, libraries are linked using absolute paths, libraries are - resolved by their <literal>install_name</literal> at link time. Sometimes - packages won't set this correctly causing the library lookups to fail at - runtime. This can be fixed by adding extra linker flags or by running - <command>install_name_tool -id</command> during the - <function>fixupPhase</function>. + On Darwin, libraries are linked using absolute paths, libraries are resolved by their <literal>install_name</literal> at link time. Sometimes packages won't set this correctly causing the library lookups to fail at runtime. This can be fixed by adding extra linker flags or by running <command>install_name_tool -id</command> during the <function>fixupPhase</function>. </para> <programlisting> stdenv.mkDerivation { @@ -48,16 +38,10 @@ stdenv.mkDerivation { </listitem> <listitem> <para> - Even if the libraries are linked using absolute paths and resolved via - their <literal>install_name</literal> correctly, tests can sometimes fail - to run binaries. This happens because the <varname>checkPhase</varname> - runs before the libraries are installed. + Even if the libraries are linked using absolute paths and resolved via their <literal>install_name</literal> correctly, tests can sometimes fail to run binaries. This happens because the <varname>checkPhase</varname> runs before the libraries are installed. </para> <para> - This can usually be solved by running the tests after the - <varname>installPhase</varname> or alternatively by using - <varname>DYLD_LIBRARY_PATH</varname>. More information about this variable - can be found in the <citerefentry> + This can usually be solved by running the tests after the <varname>installPhase</varname> or alternatively by using <varname>DYLD_LIBRARY_PATH</varname>. More information about this variable can be found in the <citerefentry> <refentrytitle>dyld</refentrytitle> <manvolnum>1</manvolnum></citerefentry> manpage. </para> @@ -78,11 +62,7 @@ stdenv.mkDerivation { </listitem> <listitem> <para> - Some packages assume xcode is available and use <command>xcrun</command> - to resolve build tools like <command>clang</command>, etc. This causes - errors like <code>xcode-select: error: no developer tools were found at - '/Applications/Xcode.app'</code> while the build doesn't actually depend - on xcode. + Some packages assume xcode is available and use <command>xcrun</command> to resolve build tools like <command>clang</command>, etc. This causes errors like <code>xcode-select: error: no developer tools were found at '/Applications/Xcode.app'</code> while the build doesn't actually depend on xcode. </para> <programlisting> stdenv.mkDerivation { @@ -95,9 +75,7 @@ stdenv.mkDerivation { } </programlisting> <para> - The package <literal>xcbuild</literal> can be used to build projects that - really depend on Xcode. However, this replacement is not 100% compatible - with Xcode and can occasionally cause issues. + The package <literal>xcbuild</literal> can be used to build projects that really depend on Xcode. However, this replacement is not 100% compatible with Xcode and can occasionally cause issues. </para> </listitem> </itemizedlist> diff --git a/nixpkgs/doc/quick-start.xml b/nixpkgs/doc/quick-start.xml index 292d66864a4c..80514cba4904 100644 --- a/nixpkgs/doc/quick-start.xml +++ b/nixpkgs/doc/quick-start.xml @@ -15,120 +15,75 @@ </listitem> <listitem> <para> - Find a good place in the Nixpkgs tree to add the Nix expression for your - package. For instance, a library package typically goes into - <filename>pkgs/development/libraries/<replaceable>pkgname</replaceable></filename>, - while a web browser goes into - <filename>pkgs/applications/networking/browsers/<replaceable>pkgname</replaceable></filename>. - See <xref linkend="sec-organisation" /> for some hints on the tree - organisation. Create a directory for your package, e.g. + Find a good place in the Nixpkgs tree to add the Nix expression for your package. For instance, a library package typically goes into <filename>pkgs/development/libraries/<replaceable>pkgname</replaceable></filename>, while a web browser goes into <filename>pkgs/applications/networking/browsers/<replaceable>pkgname</replaceable></filename>. See <xref linkend="sec-organisation" /> for some hints on the tree organisation. Create a directory for your package, e.g. <screen> <prompt>$ </prompt>mkdir pkgs/development/libraries/libfoo</screen> </para> </listitem> <listitem> <para> - In the package directory, create a Nix expression — a piece of code that - describes how to build the package. In this case, it should be a - <emphasis>function</emphasis> that is called with the package dependencies - as arguments, and returns a build of the package in the Nix store. The - expression should usually be called <filename>default.nix</filename>. + In the package directory, create a Nix expression — a piece of code that describes how to build the package. In this case, it should be a <emphasis>function</emphasis> that is called with the package dependencies as arguments, and returns a build of the package in the Nix store. The expression should usually be called <filename>default.nix</filename>. <screen> <prompt>$ </prompt>emacs pkgs/development/libraries/libfoo/default.nix <prompt>$ </prompt>git add pkgs/development/libraries/libfoo/default.nix</screen> </para> <para> - You can have a look at the existing Nix expressions under - <filename>pkgs/</filename> to see how it’s done. Here are some good - ones: + You can have a look at the existing Nix expressions under <filename>pkgs/</filename> to see how it’s done. Here are some good ones: <itemizedlist> <listitem> <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>. - Trivial package, which specifies some <varname>meta</varname> - attributes which is good practice. + 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>. Trivial package, which specifies some <varname>meta</varname> attributes which is good practice. </para> </listitem> <listitem> <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>. - Also a simple package. The generic builder in <varname>stdenv</varname> - does everything for you. It has no dependencies beyond - <varname>stdenv</varname>. + 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>. Also a simple package. The generic builder in <varname>stdenv</varname> does everything for you. It has no dependencies beyond <varname>stdenv</varname>. </para> </listitem> <listitem> <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>. - Also done by the generic builder, but has a dependency on - <varname>m4</varname>. + 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>. Also done by the generic builder, but has a dependency on <varname>m4</varname>. </para> </listitem> <listitem> <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>. - Has an optional dependency on <varname>gtkspell</varname>, which is - only built if <varname>spellCheck</varname> is <literal>true</literal>. + 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>. Has an optional dependency on <varname>gtkspell</varname>, which is only built if <varname>spellCheck</varname> is <literal>true</literal>. </para> </listitem> <listitem> <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>. - A bunch of optional features, variable substitutions in the configure - flags, a post-install hook, and miscellaneous hackery. + 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>. A bunch of optional features, variable substitutions in the configure flags, a post-install hook, and miscellaneous hackery. </para> </listitem> <listitem> <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>. - Lots of dependencies. + 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>. Lots of dependencies. </para> </listitem> <listitem> <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> - (and the - <link - xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/jdiskreport/builder.sh">builder</link>). - Nixpkgs doesn’t have a decent <varname>stdenv</varname> for Java yet - so this is pretty ad-hoc. + 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> (and the <link + xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/misc/jdiskreport/builder.sh">builder</link>). Nixpkgs doesn’t have a decent <varname>stdenv</varname> for Java yet so this is pretty ad-hoc. </para> </listitem> <listitem> <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> - (search for the <varname>XMLSimple</varname> attribute). Most Perl - modules are so simple to build that they are defined directly in - <filename>perl-packages.nix</filename>; no need to make a separate file - for them. + 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> (search for the <varname>XMLSimple</varname> attribute). Most Perl modules are so simple to build that they are defined directly in <filename>perl-packages.nix</filename>; no need to make a separate file for them. </para> </listitem> <listitem> <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>. - Shows how binary-only packages can be supported. In particular the - <link - xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/misc/adobe-reader/builder.sh">builder</link> - uses <command>patchelf</command> to set the RUNPATH and ELF interpreter - of the executables so that the right libraries are found at runtime. + 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>. Shows how binary-only packages can be supported. In particular the <link + xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/misc/adobe-reader/builder.sh">builder</link> uses <command>patchelf</command> to set the RUNPATH and ELF interpreter of the executables so that the right libraries are found at runtime. </para> </listitem> </itemizedlist> @@ -138,67 +93,45 @@ <itemizedlist> <listitem> <para> - All <varname linkend="chap-meta">meta</varname> attributes are - optional, but it’s still a good idea to provide at least the - <varname>description</varname>, <varname>homepage</varname> and - <varname + All <varname linkend="chap-meta">meta</varname> attributes are optional, but it’s still a good idea to provide at least the <varname>description</varname>, <varname>homepage</varname> and <varname linkend="sec-meta-license">license</varname>. </para> </listitem> <listitem> <para> - You can use <command>nix-prefetch-url</command> - <replaceable>url</replaceable> to get the SHA-256 hash of source - distributions. There are similar commands as - <command>nix-prefetch-git</command> and - <command>nix-prefetch-hg</command> available in - <literal>nix-prefetch-scripts</literal> package. + You can use <command>nix-prefetch-url</command> <replaceable>url</replaceable> to get the SHA-256 hash of source distributions. There are similar commands as <command>nix-prefetch-git</command> and <command>nix-prefetch-hg</command> available in <literal>nix-prefetch-scripts</literal> package. </para> </listitem> <listitem> <para> - A list of schemes for <literal>mirror://</literal> URLs can be found in - <link + 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>. + 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 - xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/top-level/all-packages.nix"><filename>pkgs/top-level/all-packages.nix</filename></link> - with some descriptive name for the variable, e.g. - <varname>libfoo</varname>. + Add a call to the function defined in the previous step to <link + xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/top-level/all-packages.nix"><filename>pkgs/top-level/all-packages.nix</filename></link> with some descriptive name for the variable, e.g. <varname>libfoo</varname>. <screen> <prompt>$ </prompt>emacs pkgs/top-level/all-packages.nix</screen> </para> <para> - The attributes in that file are sorted by category (like “Development / - Libraries”) that more-or-less correspond to the directory structure of - Nixpkgs, and then by attribute name. + The attributes in that file are sorted by category (like “Development / Libraries”) that more-or-less correspond to the directory structure of Nixpkgs, and then by attribute name. </para> </listitem> <listitem> <para> - To test whether the package builds, run the following command 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> <prompt>$ </prompt>nix-build -A libfoo</screen> - where <varname>libfoo</varname> should be the variable name defined in the - previous step. You may want to add the flag <option>-K</option> to keep - the temporary build directory in case something fails. If the build - succeeds, a symlink <filename>./result</filename> to the package in the - Nix store is created. + where <varname>libfoo</varname> should be the variable name defined in the previous step. You may want to add the flag <option>-K</option> to keep the temporary build directory in case something fails. If the build succeeds, a symlink <filename>./result</filename> to the package in the Nix store is created. </para> </listitem> <listitem> @@ -211,11 +144,8 @@ <listitem> <para> Optionally commit the new package and open a pull request <link - xlink:href="https://github.com/NixOS/nixpkgs/pulls">to nixpkgs</link>, or - use <link - xlink:href="https://discourse.nixos.org/t/about-the-patches-category/477"> - the Patches category</link> on Discourse for sending a patch without a - GitHub account. + xlink:href="https://github.com/NixOS/nixpkgs/pulls">to nixpkgs</link>, or use <link + xlink:href="https://discourse.nixos.org/t/about-the-patches-category/477"> the Patches category</link> on Discourse for sending a patch without a GitHub account. </para> </listitem> </orderedlist> diff --git a/nixpkgs/doc/release-notes.xml b/nixpkgs/doc/release-notes.xml index 8d9b1813010a..b85f61da079c 100644 --- a/nixpkgs/doc/release-notes.xml +++ b/nixpkgs/doc/release-notes.xml @@ -6,15 +6,11 @@ <title>Release 0.14 (June 4, 2012)</title> <para> - In preparation for the switch from Subversion to Git, this release is mainly - the prevent the Nixpkgs version number from going backwards. (This would - happen because prerelease version numbers produced for the Git repository - are lower than those for the Subversion repository.) + In preparation for the switch from Subversion to Git, this release is mainly the prevent the Nixpkgs version number from going backwards. (This would happen because prerelease version numbers produced for the Git repository are lower than those for the Subversion repository.) </para> <para> - Since the last release, there have been thousands of changes and new - packages by numerous contributors. For details, see the commit logs. + Since the last release, there have been thousands of changes and new packages by numerous contributors. For details, see the commit logs. </para> </section> <section xml:id="release-notes-0.13"> @@ -55,14 +51,11 @@ <title>Release 0.12 (April 24, 2009)</title> <para> - There are way too many additions to Nixpkgs since the last release to list - here: for example, the number of packages on Linux has increased from 1002 - to 2159. However, some specific improvements are worth listing: + There are way too many additions to Nixpkgs since the last release to list here: for example, the number of packages on Linux has increased from 1002 to 2159. However, some specific improvements are worth listing: <itemizedlist> <listitem> <para> - Nixpkgs now has a manual. In particular, it describes the standard build - environment in detail. + Nixpkgs now has a manual. In particular, it describes the standard build environment in detail. </para> </listitem> <listitem> @@ -122,9 +115,7 @@ </listitem> <listitem> <para> - Support for building derivations in a virtual machine, including RPM and - Debian builds in automatically generated VM images. See - <filename>pkgs/build-support/vm/default.nix</filename> for details. + Support for building derivations in a virtual machine, including RPM and Debian builds in automatically generated VM images. See <filename>pkgs/build-support/vm/default.nix</filename> for details. </para> </listitem> <listitem> @@ -136,13 +127,7 @@ </para> <para> - The following people contributed to this release: Andres Löh, Arie - Middelkoop, Armijn Hemel, Eelco Dolstra, Lluís Batlle, Ludovic Courtès, - Marc Weber, Mart Kolthof, Martin Bravenboer, Michael Raskin, Nicolas - Pierron, Peter Simons, Pjotr Prins, Rob Vermaas, Sander van der Burg, Tobias - Hammerschmidt, Valentin David, Wouter den Breejen and Yury G. Kudryashov. In - addition, several people contributed patches on the - <literal>nix-dev</literal> mailing list. + The following people contributed to this release: Andres Löh, Arie Middelkoop, Armijn Hemel, Eelco Dolstra, Lluís Batlle, Ludovic Courtès, Marc Weber, Mart Kolthof, Martin Bravenboer, Michael Raskin, Nicolas Pierron, Peter Simons, Pjotr Prins, Rob Vermaas, Sander van der Burg, Tobias Hammerschmidt, Valentin David, Wouter den Breejen and Yury G. Kudryashov. In addition, several people contributed patches on the <literal>nix-dev</literal> mailing list. </para> </section> <section xml:id="release-notes-0.11"> @@ -153,25 +138,12 @@ <itemizedlist> <listitem> <para> - The standard build environment (<literal>stdenv</literal>) is now pure on - the <literal>x86_64-linux</literal> and <literal>powerpc-linux</literal> - platforms, just as on <literal>i686-linux</literal>. (Purity means that - building and using the standard environment has no dependencies outside - of the Nix store. For instance, it doesn’t require an external C - compiler such as <filename>/usr/bin/gcc</filename>.) Also, the statically - linked binaries used in the bootstrap process are now automatically - reproducible, making it easy to update the bootstrap tools and to add - support for other Linux platforms. See - <filename>pkgs/stdenv/linux/make-bootstrap-tools.nix</filename> for - details. + The standard build environment (<literal>stdenv</literal>) is now pure on the <literal>x86_64-linux</literal> and <literal>powerpc-linux</literal> platforms, just as on <literal>i686-linux</literal>. (Purity means that building and using the standard environment has no dependencies outside of the Nix store. For instance, it doesn’t require an external C compiler such as <filename>/usr/bin/gcc</filename>.) Also, the statically linked binaries used in the bootstrap process are now automatically reproducible, making it easy to update the bootstrap tools and to add support for other Linux platforms. See <filename>pkgs/stdenv/linux/make-bootstrap-tools.nix</filename> for details. </para> </listitem> <listitem> <para> - Hook variables in the generic builder are now executed using the - <function>eval</function> shell command. This has a major advantage: you - can write hooks directly in Nix expressions. For instance, rather than - writing a builder like this: + Hook variables in the generic builder are now executed using the <function>eval</function> shell command. This has a major advantage: you can write hooks directly in Nix expressions. For instance, rather than writing a builder like this: <programlisting> source $stdenv/setup @@ -182,91 +154,57 @@ postInstall() { } genericBuild</programlisting> - (the <literal>gzip</literal> builder), you can just add this attribute to - the derivation: + (the <literal>gzip</literal> builder), you can just add this attribute to the derivation: <programlisting> postInstall = "ln -sf gzip $out/bin/gunzip; ln -sf gzip $out/bin/zcat";</programlisting> - and so a separate build script becomes unnecessary. This should allow us - to get rid of most builders in Nixpkgs. + and so a separate build script becomes unnecessary. This should allow us to get rid of most builders in Nixpkgs. </para> </listitem> <listitem> <para> - It is now possible to have the generic builder pass arguments to - <command>configure</command> and <command>make</command> that contain - whitespace. Previously, for example, you could say in a builder, + It is now possible to have the generic builder pass arguments to <command>configure</command> and <command>make</command> that contain whitespace. Previously, for example, you could say in a builder, <programlisting> configureFlags="CFLAGS=-O0"</programlisting> but not <programlisting> configureFlags="CFLAGS=-O0 -g"</programlisting> - since the <literal>-g</literal> would be interpreted as a separate - argument to <command>configure</command>. Now you can say + since the <literal>-g</literal> would be interpreted as a separate argument to <command>configure</command>. Now you can say <programlisting> configureFlagsArray=("CFLAGS=-O0 -g")</programlisting> or similarly <programlisting> configureFlagsArray=("CFLAGS=-O0 -g" "LDFLAGS=-L/foo -L/bar")</programlisting> - which does the right thing. Idem for <literal>makeFlags</literal>, - <literal>installFlags</literal>, <literal>checkFlags</literal> and - <literal>distFlags</literal>. + which does the right thing. Idem for <literal>makeFlags</literal>, <literal>installFlags</literal>, <literal>checkFlags</literal> and <literal>distFlags</literal>. </para> <para> - Unfortunately you can't pass arrays to Bash through the environment, so - you can't put the array above in a Nix expression, e.g., + Unfortunately you can't pass arrays to Bash through the environment, so you can't put the array above in a Nix expression, e.g., <programlisting> configureFlagsArray = ["CFLAGS=-O0 -g"];</programlisting> - since it would just be flattened to a since string. However, you - <emphasis>can</emphasis> use the inline hooks described above: + since it would just be flattened to a since string. However, you <emphasis>can</emphasis> use the inline hooks described above: <programlisting> preConfigure = "configureFlagsArray=(\"CFLAGS=-O0 -g\")";</programlisting> </para> </listitem> <listitem> <para> - The function <function>fetchurl</function> now has support for two - different kinds of mirroring of files. First, it has support for - <emphasis>content-addressable mirrors</emphasis>. For example, given the - <function>fetchurl</function> call + The function <function>fetchurl</function> now has support for two different kinds of mirroring of files. First, it has support for <emphasis>content-addressable mirrors</emphasis>. For example, given the <function>fetchurl</function> call <programlisting> fetchurl { url = http://releases.mozilla.org/<replaceable>...</replaceable>/firefox-2.0.0.6-source.tar.bz2; sha1 = "eb72f55e4a8bf08e8c6ef227c0ade3d068ba1082"; }</programlisting> - <function>fetchurl</function> will first try to download this file from - <link - xlink:href="http://tarballs.nixos.org/sha1/eb72f55e4a8bf08e8c6ef227c0ade3d068ba1082"/>. - If that file doesn’t exist, it will try the original URL. In general, - the “content-addressed” location is - <replaceable>mirror</replaceable><literal>/</literal><replaceable>hash-type</replaceable><literal>/</literal><replaceable>hash</replaceable>. - There is currently only one content-addressable mirror - (<link - xlink:href="http://tarballs.nixos.org"/>), but more can be - specified in the <varname>hashedMirrors</varname> attribute in - <filename>pkgs/build-support/fetchurl/mirrors.nix</filename>, or by - setting the <envar>NIX_HASHED_MIRRORS</envar> environment variable to a - whitespace-separated list of URLs. + <function>fetchurl</function> will first try to download this file from <link + xlink:href="http://tarballs.nixos.org/sha1/eb72f55e4a8bf08e8c6ef227c0ade3d068ba1082"/>. If that file doesn’t exist, it will try the original URL. In general, the “content-addressed” location is <replaceable>mirror</replaceable><literal>/</literal><replaceable>hash-type</replaceable><literal>/</literal><replaceable>hash</replaceable>. There is currently only one content-addressable mirror (<link + xlink:href="http://tarballs.nixos.org"/>), but more can be specified in the <varname>hashedMirrors</varname> attribute in <filename>pkgs/build-support/fetchurl/mirrors.nix</filename>, or by setting the <envar>NIX_HASHED_MIRRORS</envar> environment variable to a whitespace-separated list of URLs. </para> <para> - Second, <function>fetchurl</function> has support for widely-mirrored - distribution sites such as SourceForge or the Linux kernel archives. - Given a URL of the form - <literal>mirror://<replaceable>site</replaceable>/<replaceable>path</replaceable></literal>, - it will try to download <replaceable>path</replaceable> from a - configurable list of mirrors for <replaceable>site</replaceable>. (This - idea was borrowed from Gentoo Linux.) Example: + Second, <function>fetchurl</function> has support for widely-mirrored distribution sites such as SourceForge or the Linux kernel archives. Given a URL of the form <literal>mirror://<replaceable>site</replaceable>/<replaceable>path</replaceable></literal>, it will try to download <replaceable>path</replaceable> from a configurable list of mirrors for <replaceable>site</replaceable>. (This idea was borrowed from Gentoo Linux.) Example: <programlisting> fetchurl { url = mirror://gnu/gcc/gcc-4.2.0/gcc-core-4.2.0.tar.bz2; sha256 = "0ykhzxhr8857dr97z0j9wyybfz1kjr71xk457cfapfw5fjas4ny1"; }</programlisting> - Currently <replaceable>site</replaceable> can be - <literal>sourceforge</literal>, <literal>gnu</literal> and - <literal>kernel</literal>. The list of mirrors is defined in - <filename>pkgs/build-support/fetchurl/mirrors.nix</filename>. You can - override the list of mirrors for a particular site by setting the - environment variable - <envar>NIX_MIRRORS_<replaceable>site</replaceable></envar>, e.g. + Currently <replaceable>site</replaceable> can be <literal>sourceforge</literal>, <literal>gnu</literal> and <literal>kernel</literal>. The list of mirrors is defined in <filename>pkgs/build-support/fetchurl/mirrors.nix</filename>. You can override the list of mirrors for a particular site by setting the environment variable <envar>NIX_MIRRORS_<replaceable>site</replaceable></envar>, e.g. <programlisting> export NIX_MIRRORS_sourceforge=http://osdn.dl.sourceforge.net/sourceforge/</programlisting> </para> @@ -339,9 +277,7 @@ export NIX_MIRRORS_sourceforge=http://osdn.dl.sourceforge.net/sourceforge/</prog </para> <para> - The following people contributed to this release: Andres Löh, Arie - Middelkoop, Armijn Hemel, Eelco Dolstra, Marc Weber, Mart Kolthof, Martin - Bravenboer, Michael Raskin, Wouter den Breejen and Yury G. Kudryashov. + The following people contributed to this release: Andres Löh, Arie Middelkoop, Armijn Hemel, Eelco Dolstra, Marc Weber, Mart Kolthof, Martin Bravenboer, Michael Raskin, Wouter den Breejen and Yury G. Kudryashov. </para> </section> <section xml:id="release-notes-0.10"> @@ -349,10 +285,8 @@ export NIX_MIRRORS_sourceforge=http://osdn.dl.sourceforge.net/sourceforge/</prog <note> <para> - This release of Nixpkgs requires - <link -xlink:href='http://nixos.org/releases/nix/nix-0.10/'>Nix 0.10</link> - or higher. + This release of Nixpkgs requires <link +xlink:href='http://nixos.org/releases/nix/nix-0.10/'>Nix 0.10</link> or higher. </para> </note> @@ -363,32 +297,15 @@ xlink:href='http://nixos.org/releases/nix/nix-0.10/'>Nix 0.10</link> <itemizedlist> <listitem> <para> - <filename>pkgs/system/all-packages-generic.nix</filename> is gone, we now - just have <filename>pkgs/top-level/all-packages.nix</filename> that - contains all available packages. This should cause much less confusion - with users. <filename>all-packages.nix</filename> is a function that by - default returns packages for the current platform, but you can override - this by specifying a different <varname>system</varname> argument. + <filename>pkgs/system/all-packages-generic.nix</filename> is gone, we now just have <filename>pkgs/top-level/all-packages.nix</filename> that contains all available packages. This should cause much less confusion with users. <filename>all-packages.nix</filename> is a function that by default returns packages for the current platform, but you can override this by specifying a different <varname>system</varname> argument. </para> </listitem> <listitem> <para> - Certain packages in Nixpkgs are now user-configurable through a - configuration file, i.e., without having to edit the Nix expressions in - Nixpkgs. For instance, the Firefox provided in the Nixpkgs channel is - built without the RealPlayer plugin (for legal reasons). Previously, you - could easily enable RealPlayer support by editing the call to the Firefox - function in <filename>all-packages.nix</filename>, but such changes are - not respected when Firefox is subsequently updated through the Nixpkgs - channel. + Certain packages in Nixpkgs are now user-configurable through a configuration file, i.e., without having to edit the Nix expressions in Nixpkgs. For instance, the Firefox provided in the Nixpkgs channel is built without the RealPlayer plugin (for legal reasons). Previously, you could easily enable RealPlayer support by editing the call to the Firefox function in <filename>all-packages.nix</filename>, but such changes are not respected when Firefox is subsequently updated through the Nixpkgs channel. </para> <para> - The Nixpkgs configuration file (found in - <filename>~/.nixpkgs/config.nix</filename> or through the - <envar>NIXPKGS_CONFIG</envar> environment variable) is an attribute set - that contains configuration options that - <filename>all-packages.nix</filename> reads and uses for certain packages. - For instance, the following configuration file: + The Nixpkgs configuration file (found in <filename>~/.nixpkgs/config.nix</filename> or through the <envar>NIXPKGS_CONFIG</envar> environment variable) is an attribute set that contains configuration options that <filename>all-packages.nix</filename> reads and uses for certain packages. For instance, the following configuration file: <programlisting> { firefox = { @@ -398,9 +315,7 @@ xlink:href='http://nixos.org/releases/nix/nix-0.10/'>Nix 0.10</link> persistently enables RealPlayer support in the Firefox build. </para> <para> - (Actually, <literal>firefox.enableRealPlayer</literal> is the - <emphasis>only</emphasis> configuration option currently available, but - more are sure to be added.) + (Actually, <literal>firefox.enableRealPlayer</literal> is the <emphasis>only</emphasis> configuration option currently available, but more are sure to be added.) </para> </listitem> <listitem> @@ -409,17 +324,8 @@ xlink:href='http://nixos.org/releases/nix/nix-0.10/'>Nix 0.10</link> <itemizedlist> <listitem> <para> - <literal>i686-cygwin</literal>, i.e., Windows (using - <link xlink:href="http://www.cygwin.com/">Cygwin</link>). The standard - environment on <literal>i686-cygwin</literal> by default builds - binaries for the Cygwin environment (i.e., it uses Cygwin tools and - produces executables that use the Cygwin library). However, there is - also a standard environment that produces binaries that use - <link - xlink:href="http://www.mingw.org/">MinGW</link>. You can - use it by calling <filename>all-package.nix</filename> with the - <varname>stdenvType</varname> argument set to - <literal>"i686-mingw"</literal>. + <literal>i686-cygwin</literal>, i.e., Windows (using <link xlink:href="http://www.cygwin.com/">Cygwin</link>). The standard environment on <literal>i686-cygwin</literal> by default builds binaries for the Cygwin environment (i.e., it uses Cygwin tools and produces executables that use the Cygwin library). However, there is also a standard environment that produces binaries that use <link + xlink:href="http://www.mingw.org/">MinGW</link>. You can use it by calling <filename>all-package.nix</filename> with the <varname>stdenvType</varname> argument set to <literal>"i686-mingw"</literal>. </para> </listitem> <listitem> @@ -434,9 +340,7 @@ xlink:href='http://nixos.org/releases/nix/nix-0.10/'>Nix 0.10</link> </listitem> <listitem> <para> - <literal>x86_64-linux</literal>, i.e., Linux on 64-bit AMD/Intel CPUs. - Unlike <literal>i686-linux</literal>, this platform doesn’t have a - pure <literal>stdenv</literal> yet. + <literal>x86_64-linux</literal>, i.e., Linux on 64-bit AMD/Intel CPUs. Unlike <literal>i686-linux</literal>, this platform doesn’t have a pure <literal>stdenv</literal> yet. </para> </listitem> </itemizedlist> @@ -472,21 +376,10 @@ xlink:href='http://nixos.org/releases/nix/nix-0.10/'>Nix 0.10</link> </listitem> <listitem> <para> - It is now <emphasis>much</emphasis> easier to override the default C - compiler and other tools in <literal>stdenv</literal> for specific - packages. <filename>all-packages.nix</filename> provides two utility - functions for this purpose: <function>overrideGCC</function> and - <function>overrideInStdenv</function>. Both take a - <literal>stdenv</literal> and return an augmented - <literal>stdenv</literal>; the formed changes the C compiler, and the - latter adds additional packages to the front of - <literal>stdenv</literal>’s initial <envar>PATH</envar>, allowing tools - to be overridden. + It is now <emphasis>much</emphasis> easier to override the default C compiler and other tools in <literal>stdenv</literal> for specific packages. <filename>all-packages.nix</filename> provides two utility functions for this purpose: <function>overrideGCC</function> and <function>overrideInStdenv</function>. Both take a <literal>stdenv</literal> and return an augmented <literal>stdenv</literal>; the formed changes the C compiler, and the latter adds additional packages to the front of <literal>stdenv</literal>’s initial <envar>PATH</envar>, allowing tools to be overridden. </para> <para> - For instance, the package <varname>strategoxt</varname> doesn’t build - with the GNU Make in <literal>stdenv</literal> (version 3.81), so we call - it with an augmented <literal>stdenv</literal> that uses GNU Make 3.80: + For instance, the package <varname>strategoxt</varname> doesn’t build with the GNU Make in <literal>stdenv</literal> (version 3.81), so we call it with an augmented <literal>stdenv</literal> that uses GNU Make 3.80: <programlisting> strategoxt = (import ../development/compilers/strategoxt) { inherit fetchurl pkgconfig sdf aterm; @@ -494,8 +387,7 @@ strategoxt = (import ../development/compilers/strategoxt) { }; gnumake380 = <replaceable>...</replaceable>;</programlisting> - Likewise, there are many packages that don’t compile with the default - GCC (4.1.1), but that’s easily fixed: + Likewise, there are many packages that don’t compile with the default GCC (4.1.1), but that’s easily fixed: <programlisting> exult = import ../games/exult { inherit fetchurl SDL SDL_mixer zlib libpng unzip; @@ -505,13 +397,7 @@ exult = import ../games/exult { </listitem> <listitem> <para> - It has also become much easier to experiment with changes to the - <literal>stdenv</literal> setup script (which notably contains the generic - builder). Since edits to <filename>pkgs/stdenv/generic/setup.sh</filename> - trigger a rebuild of <emphasis>everything</emphasis>, this was formerly - quite painful. But now <literal>stdenv</literal> contains a function to - “regenerate” <literal>stdenv</literal> with a different setup script, - allowing the use of a different setup script for specific packages: + It has also become much easier to experiment with changes to the <literal>stdenv</literal> setup script (which notably contains the generic builder). Since edits to <filename>pkgs/stdenv/generic/setup.sh</filename> trigger a rebuild of <emphasis>everything</emphasis>, this was formerly quite painful. But now <literal>stdenv</literal> contains a function to “regenerate” <literal>stdenv</literal> with a different setup script, allowing the use of a different setup script for specific packages: <programlisting> pkg = import <replaceable>...</replaceable> { stdenv = stdenv.regenerate ./my-setup.sh; @@ -521,10 +407,7 @@ pkg = import <replaceable>...</replaceable> { </listitem> <listitem> <para> - Packages can now have a human-readable <emphasis>description</emphasis> - field. Package descriptions are shown by <literal>nix-env -qa - --description</literal>. In addition, they’re shown on the Nixpkgs - release page. A description can be added to a package as follows: + Packages can now have a human-readable <emphasis>description</emphasis> field. Package descriptions are shown by <literal>nix-env -qa --description</literal>. In addition, they’re shown on the Nixpkgs release page. A description can be added to a package as follows: <programlisting> stdenv.mkDerivation { name = "exult-1.2"; @@ -533,34 +416,26 @@ stdenv.mkDerivation { description = "A reimplementation of the Ultima VII game engine"; }; }</programlisting> - The <varname>meta</varname> attribute is not passed to the builder, so - changes to the description do not trigger a rebuild. Additional - <varname>meta</varname> attributes may be defined in the future (such as - the URL of the package’s homepage, the license, etc.). + The <varname>meta</varname> attribute is not passed to the builder, so changes to the description do not trigger a rebuild. Additional <varname>meta</varname> attributes may be defined in the future (such as the URL of the package’s homepage, the license, etc.). </para> </listitem> </itemizedlist> <para> - The following people contributed to this release: Andres Löh, Armijn Hemel, - Christof Douma, Eelco Dolstra, Eelco Visser, Mart Kolthof, Martin - Bravenboer, Merijn de Jonge, Rob Vermaas and Roy van den Broek. + The following people contributed to this release: Andres Löh, Armijn Hemel, Christof Douma, Eelco Dolstra, Eelco Visser, Mart Kolthof, Martin Bravenboer, Merijn de Jonge, Rob Vermaas and Roy van den Broek. </para> </section> <section xml:id="release-notes-0.9"> <title>Release 0.9 (January 31, 2006)</title> <para> - There have been zillions of changes since the last release of Nixpkgs. Many - packages have been added or updated. The following are some of the more - notable changes: + There have been zillions of changes since the last release of Nixpkgs. Many packages have been added or updated. The following are some of the more notable changes: </para> <itemizedlist> <listitem> <para> - Distribution files have been moved to - <link + Distribution files have been moved to <link xlink:href="http://nixos.org/" />. </para> </listitem> @@ -576,24 +451,17 @@ stdenv.mkDerivation { </listitem> <listitem> <para> - The old, unofficial Xlibs has been replaced by the official modularised - X11 distribution from X.org, i.e., X11R7.0. X11R7.0 consists of 287 (!) - packages, all of which are in Nixpkgs though not all have been tested. It - is now possible to build a working X server (previously we only had X - client libraries). We use a fully Nixified X server on NixOS. + The old, unofficial Xlibs has been replaced by the official modularised X11 distribution from X.org, i.e., X11R7.0. X11R7.0 consists of 287 (!) packages, all of which are in Nixpkgs though not all have been tested. It is now possible to build a working X server (previously we only had X client libraries). We use a fully Nixified X server on NixOS. </para> </listitem> <listitem> <para> - The Sun JDK 5 has been purified, i.e., it doesn’t require any non-Nix - components such as <filename>/lib/ld-linux.so.2</filename>. This means - that Java applications such as Eclipse and Azureus can run on NixOS. + The Sun JDK 5 has been purified, i.e., it doesn’t require any non-Nix components such as <filename>/lib/ld-linux.so.2</filename>. This means that Java applications such as Eclipse and Azureus can run on NixOS. </para> </listitem> <listitem> <para> - Hardware-accelerated OpenGL support, used by games like Quake 3 (which is - now built from source). + Hardware-accelerated OpenGL support, used by games like Quake 3 (which is now built from source). </para> </listitem> <listitem> @@ -608,8 +476,7 @@ stdenv.mkDerivation { </listitem> <listitem> <para> - Some support for cross-compilation: cross-compiling builds of GCC and - Binutils, and cross-compiled builds of the C library uClibc. + Some support for cross-compilation: cross-compiling builds of GCC and Binutils, and cross-compiled builds of the C library uClibc. </para> </listitem> <listitem> @@ -618,8 +485,7 @@ stdenv.mkDerivation { <itemizedlist> <listitem> <para> - teTeX, including support for building LaTeX documents using Nix (with - automatic dependency determination). + teTeX, including support for building LaTeX documents using Nix (with automatic dependency determination). </para> </listitem> <listitem> @@ -629,14 +495,12 @@ stdenv.mkDerivation { </listitem> <listitem> <para> - System-level packages to support NixOS, e.g. Grub, GNU - <literal>parted</literal> and so on. + System-level packages to support NixOS, e.g. Grub, GNU <literal>parted</literal> and so on. </para> </listitem> <listitem> <para> - <literal>ecj</literal>, the Eclipse Compiler for Java, so we finally - have a freely distributable compiler that supports Java 5.0. + <literal>ecj</literal>, the Eclipse Compiler for Java, so we finally have a freely distributable compiler that supports Java 5.0. </para> </listitem> <listitem> @@ -661,8 +525,7 @@ stdenv.mkDerivation { </listitem> <listitem> <para> - <literal>kdelibs</literal>. This allows us to add KDE-based packages - (such as <literal>kcachegrind</literal>). + <literal>kdelibs</literal>. This allows us to add KDE-based packages (such as <literal>kcachegrind</literal>). </para> </listitem> </itemizedlist> @@ -671,17 +534,14 @@ stdenv.mkDerivation { </itemizedlist> <para> - The following people contributed to this release: Andres Löh, Armijn Hemel, - Bogdan Dumitriu, Christof Douma, Eelco Dolstra, Eelco Visser, Mart Kolthof, - Martin Bravenboer, Rob Vermaas and Roy van den Broek. + The following people contributed to this release: Andres Löh, Armijn Hemel, Bogdan Dumitriu, Christof Douma, Eelco Dolstra, Eelco Visser, Mart Kolthof, Martin Bravenboer, Rob Vermaas and Roy van den Broek. </para> </section> <section xml:id="release-notes-0.8"> <title>Release 0.8 (April 11, 2005)</title> <para> - This release is mostly to remain synchronised with the changed hashing - scheme in Nix 0.8. + This release is mostly to remain synchronised with the changed hashing scheme in Nix 0.8. </para> <para> @@ -706,16 +566,10 @@ stdenv.mkDerivation { <itemizedlist> <listitem> <para> - The bootstrap process for the standard build environment on Linux - (stdenv-linux) has been improved. It is no longer dependent in its initial - bootstrap stages on the system Glibc, GCC, and other tools. Rather, - Nixpkgs contains a statically linked bash and curl, and uses that to - download other statically linked tools. These are then used to build a - Glibc and dynamically linked versions of all other tools. + The bootstrap process for the standard build environment on Linux (stdenv-linux) has been improved. It is no longer dependent in its initial bootstrap stages on the system Glibc, GCC, and other tools. Rather, Nixpkgs contains a statically linked bash and curl, and uses that to download other statically linked tools. These are then used to build a Glibc and dynamically linked versions of all other tools. </para> <para> - This change also makes the bootstrap process faster. For instance, GCC is - built only once instead of three times. + This change also makes the bootstrap process faster. For instance, GCC is built only once instead of three times. </para> <para> (Contributed by Armijn Hemel.) @@ -723,17 +577,13 @@ stdenv.mkDerivation { </listitem> <listitem> <para> - Tarballs used by Nixpkgs are now obtained from the same server that hosts - Nixpkgs (<link - xlink:href="http://catamaran.labs.cs.uu.nl/" />). This - reduces the risk of packages being unbuildable due to moved or deleted - files on various servers. + Tarballs used by Nixpkgs are now obtained from the same server that hosts Nixpkgs (<link + xlink:href="http://catamaran.labs.cs.uu.nl/" />). This reduces the risk of packages being unbuildable due to moved or deleted files on various servers. </para> </listitem> <listitem> <para> - There now is a generic mechanism for building Perl modules. See the - various Perl modules defined in pkgs/system/all-packages-generic.nix. + There now is a generic mechanism for building Perl modules. See the various Perl modules defined in pkgs/system/all-packages-generic.nix. </para> </listitem> <listitem> diff --git a/nixpkgs/doc/reviewing-contributions.xml b/nixpkgs/doc/reviewing-contributions.xml index 5aa950625efa..5a14684f9b1e 100644 --- a/nixpkgs/doc/reviewing-contributions.xml +++ b/nixpkgs/doc/reviewing-contributions.xml @@ -6,68 +6,40 @@ <title>Reviewing contributions</title> <warning> <para> - The following section is a draft, and the policy for reviewing is still - being discussed in issues such as - <link - xlink:href="https://github.com/NixOS/nixpkgs/issues/11166">#11166 - </link> and - <link - xlink:href="https://github.com/NixOS/nixpkgs/issues/20836">#20836 - </link>. + The following section is a draft, and the policy for reviewing is still being discussed in issues such as <link + xlink:href="https://github.com/NixOS/nixpkgs/issues/11166">#11166 </link> and <link + xlink:href="https://github.com/NixOS/nixpkgs/issues/20836">#20836 </link>. </para> </warning> <para> - The Nixpkgs project receives a fairly high number of contributions via GitHub - pull requests. Reviewing and approving these is an important task and a way - to contribute to the project. + The Nixpkgs project receives a fairly high number of contributions via GitHub pull requests. Reviewing and approving these is an important task and a way to contribute to the project. </para> <para> - The high change rate of Nixpkgs makes any pull request that remains open for - too long subject to conflicts that will require extra work from the submitter - or the merger. Reviewing pull requests in a timely manner and being - responsive to the comments is the key to avoid this issue. GitHub provides - sort filters that can be used to see the - <link - xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc">most - recently</link> and the - <link - xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-asc">least - recently</link> updated pull requests. We highly encourage looking at - <link xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+review%3Anone+status%3Asuccess+-label%3A%222.status%3A+work-in-progress%22+no%3Aproject+no%3Aassignee+no%3Amilestone"> - this list of ready to merge, unreviewed pull requests</link>. + The high change rate of Nixpkgs makes any pull request that remains open for too long subject to conflicts that will require extra work from the submitter or the merger. Reviewing pull requests in a timely manner and being responsive to the comments is the key to avoid this issue. GitHub provides sort filters that can be used to see the <link + xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc">most recently</link> and the <link + xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-asc">least recently</link> updated pull requests. We highly encourage looking at <link xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+review%3Anone+status%3Asuccess+-label%3A%222.status%3A+work-in-progress%22+no%3Aproject+no%3Aassignee+no%3Amilestone"> this list of ready to merge, unreviewed pull requests</link>. </para> <para> - When reviewing a pull request, please always be nice and polite. - Controversial changes can lead to controversial opinions, but it is important - to respect every community member and their work. + When reviewing a pull request, please always be nice and polite. Controversial changes can lead to controversial opinions, but it is important to respect every community member and their work. </para> <para> - GitHub provides reactions as a simple and quick way to provide feedback to - pull requests or any comments. The thumb-down reaction should be used with - care and if possible accompanied with some explanation so the submitter has - directions to improve their contribution. + GitHub provides reactions as a simple and quick way to provide feedback to pull requests or any comments. The thumb-down reaction should be used with care and if possible accompanied with some explanation so the submitter has directions to improve their contribution. </para> <para> - pull request reviews should include a list of what has been reviewed in a - comment, so other reviewers and mergers can know the state of the review. + pull request reviews should include a list of what has been reviewed in a comment, so other reviewers and mergers can know the state of the review. </para> <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 - them to their liking. + All the review template samples provided in this section are generic and meant as examples. Their usage is optional and the reviewer is free to adapt them to their liking. </para> <section xml:id="reviewing-contributions-package-updates"> <title>Package updates</title> <para> - A package update is the most trivial and common type of pull request. These - pull requests mainly consist of updating the version part of the package - name and the source hash. + A package update is the most trivial and common type of pull request. These pull requests mainly consist of updating the version part of the package name and the source hash. </para> <para> - It can happen that non-trivial updates include patches or more complex - changes. + It can happen that non-trivial updates include patches or more complex changes. </para> <para> @@ -82,8 +54,7 @@ <itemizedlist> <listitem> <para> - <literal>8.has: package (update)</literal> and any topic label that fit - the updated package. + <literal>8.has: package (update)</literal> and any topic label that fit the updated package. </para> </listitem> </itemizedlist> @@ -105,9 +76,7 @@ <itemizedlist> <listitem> <para> - <link xlink:href="https://help.github.com/articles/about-codeowners/">CODEOWNERS</link> - will make GitHub notify users based on the submitted changes, but it can - happen that it misses some of the package maintainers. + <link xlink:href="https://help.github.com/articles/about-codeowners/">CODEOWNERS</link> will make GitHub notify users based on the submitted changes, but it can happen that it misses some of the package maintainers. </para> </listitem> </itemizedlist> @@ -119,15 +88,12 @@ <itemizedlist> <listitem> <para> - License can change with version updates, so it should be checked to - match the upstream license. + License can change with version updates, so it should be checked to match the upstream license. </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. + 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> @@ -144,14 +110,10 @@ <itemizedlist> <listitem> <para> - pull requests are often targeted to the master or staging branch, and - building the pull request locally when it is submitted can trigger many - source builds. + pull requests are often targeted to the master or staging branch, and building the pull request locally when it is submitted can trigger many source builds. </para> <para> - It is possible to rebase the changes on nixos-unstable or - nixpkgs-unstable for easier review by running the following commands - from a nixpkgs clone. + It is possible to rebase the changes on nixos-unstable or nixpkgs-unstable for easier review by running the following commands from a nixpkgs clone. <screen> <prompt>$ </prompt>git remote add channels https://github.com/NixOS/nixpkgs-channels.git <co xml:id='reviewing-rebase-1' /> @@ -163,8 +125,7 @@ <calloutlist> <callout arearefs='reviewing-rebase-1'> <para> - This should be done only once to be able to fetch channel branches - from the nixpkgs-channels repository. + This should be done only once to be able to fetch channel branches from the nixpkgs-channels repository. </para> </callout> <callout arearefs='reviewing-rebase-2'> @@ -174,9 +135,7 @@ </callout> <callout arearefs='reviewing-rebase-3'> <para> - Fetching the pull request changes, <varname>PRNUMBER</varname> is the - number at the end of the pull request title and - <varname>BASEBRANCH</varname> the base branch of the pull request. + Fetching the pull request changes, <varname>PRNUMBER</varname> is the number at the end of the pull request title and <varname>BASEBRANCH</varname> the base branch of the pull request. </para> </callout> <callout arearefs='reviewing-rebase-4'> @@ -189,12 +148,7 @@ </listitem> <listitem> <para> - The - <link xlink:href="https://github.com/Mic92/nix-review">nix-review</link> - tool can be used to review a pull request content in a single command. - <varname>PRNUMBER</varname> should be replaced by the number at the end - of the pull request title. You can also provide the full github pull - request url. + The <link xlink:href="https://github.com/Mic92/nix-review">nix-review</link> tool can be used to review a pull request content in a single command. <varname>PRNUMBER</varname> should be replaced by the number at the end of the pull request title. You can also provide the full github pull request url. </para> <screen> <prompt>$ </prompt>nix-shell -p nix-review --run "nix-review pr PRNUMBER" @@ -231,8 +185,7 @@ <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. + New packages are a common type of pull requests. These pull requests consists in adding a new nix-expression for a package. </para> <para> @@ -247,8 +200,7 @@ <itemizedlist> <listitem> <para> - <literal>8.has: package (new)</literal> and any topic label that fit the - new package. + <literal>8.has: package (new)</literal> and any topic label that fit the new package. </para> </listitem> </itemizedlist> @@ -280,8 +232,7 @@ </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. + 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> @@ -303,8 +254,7 @@ </listitem> <listitem> <para> - The most appropriate function should be used (e.g. packages from GitHub - should use <literal>fetchFromGitHub</literal>). + The most appropriate function should be used (e.g. packages from GitHub should use <literal>fetchFromGitHub</literal>). </para> </listitem> </itemizedlist> @@ -351,8 +301,7 @@ <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. + Module updates are submissions changing modules in some ways. These often contains changes to the options or introduce new options. </para> <para> @@ -367,8 +316,7 @@ <itemizedlist> <listitem> <para> - <literal>8.has: module (update)</literal> and any topic label that fit - the module. + <literal>8.has: module (update)</literal> and any topic label that fit the module. </para> </listitem> </itemizedlist> @@ -380,9 +328,7 @@ <itemizedlist> <listitem> <para> - <link xlink:href="https://help.github.com/articles/about-codeowners/">CODEOWNERS</link> - will make GitHub notify users based on the submitted changes, but it can - happen that it misses some of the package maintainers. + <link xlink:href="https://help.github.com/articles/about-codeowners/">CODEOWNERS</link> will make GitHub notify users based on the submitted changes, but it can happen that it misses some of the package maintainers. </para> </listitem> </itemizedlist> @@ -399,9 +345,7 @@ <itemizedlist> <listitem> <para> - Type should be appropriate (string related types differs in their - merging capabilities, <literal>optionSet</literal> and - <literal>string</literal> types are deprecated). + Type should be appropriate (string related types differs in their merging capabilities, <literal>optionSet</literal> and <literal>string</literal> types are deprecated). </para> </listitem> <listitem> @@ -418,23 +362,19 @@ <itemizedlist> <listitem> <para> - <literal>mkRenamedOptionModule</literal> and - <literal>mkAliasOptionModule</literal> functions provide way to make - option changes backward compatible. + <literal>mkRenamedOptionModule</literal> and <literal>mkAliasOptionModule</literal> functions provide way to make option changes backward compatible. </para> </listitem> </itemizedlist> </listitem> <listitem> <para> - Ensure that removed options are declared with - <literal>mkRemovedOptionModule</literal> + Ensure that removed options are declared with <literal>mkRemovedOptionModule</literal> </para> </listitem> <listitem> <para> - Ensure that changes that are not backward compatible are mentioned in - release notes. + Ensure that changes that are not backward compatible are mentioned in release notes. </para> </listitem> <listitem> @@ -480,8 +420,7 @@ <itemizedlist> <listitem> <para> - <literal>8.has: module (new)</literal> and any topic label that fit the - module. + <literal>8.has: module (new)</literal> and any topic label that fit the module. </para> </listitem> </itemizedlist> @@ -498,9 +437,7 @@ <itemizedlist> <listitem> <para> - Type should be appropriate (string related types differs in their - merging capabilities, <literal>optionSet</literal> and - <literal>string</literal> types are deprecated). + Type should be appropriate (string related types differs in their merging capabilities, <literal>optionSet</literal> and <literal>string</literal> types are deprecated). </para> </listitem> <listitem> @@ -522,8 +459,7 @@ </listitem> <listitem> <para> - Module documentation should be declared with - <literal>meta.doc</literal>. + Module documentation should be declared with <literal>meta.doc</literal>. </para> </listitem> </itemizedlist> @@ -535,8 +471,7 @@ <itemizedlist> <listitem> <para> - For example, enabling a module should not open firewall ports by - default. + For example, enabling a module should not open firewall ports by default. </para> </listitem> </itemizedlist> @@ -573,25 +508,18 @@ </para> <para> - If you consider having enough knowledge and experience in a topic and would - like to be a long-term reviewer for related submissions, please contact the - current reviewers for that topic. They will give you information about the - reviewing process. The main reviewers for a topic can be hard to find as - there is no list, but checking past pull requests to see who reviewed or - git-blaming the code to see who committed to that topic can give some hints. + If you consider having enough knowledge and experience in a topic and would like to be a long-term reviewer for related submissions, please contact the current reviewers for that topic. They will give you information about the reviewing process. The main reviewers for a topic can be hard to find as there is no list, but checking past pull requests to see who reviewed or git-blaming the code to see who committed to that topic can give some hints. </para> <para> - Container system, boot system and library changes are some examples of the - pull requests fitting this category. + Container system, boot system and library changes are some examples of the pull requests fitting this category. </para> </section> <section xml:id="reviewing-contributions--merging-pull-requests"> <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. + It is possible for community members that have enough knowledge and experience on a special topic to contribute by merging pull requests. </para> <para> @@ -608,12 +536,8 @@ policy. --> <para> - In a case a contributor definitively leaves the Nix community, they should - create an issue or post on - <link - xlink:href="https://discourse.nixos.org">Discourse</link> with - references of packages and modules they maintain so the maintainership can - be taken over by other contributors. + In a case a contributor definitively leaves the Nix community, they should create an issue or post on <link + xlink:href="https://discourse.nixos.org">Discourse</link> with references of packages and modules they maintain so the maintainership can be taken over by other contributors. </para> </section> </chapter> diff --git a/nixpkgs/doc/stdenv.xml b/nixpkgs/doc/stdenv.xml index 15a13ba49e8e..5495ce29ce31 100644 --- a/nixpkgs/doc/stdenv.xml +++ b/nixpkgs/doc/stdenv.xml @@ -3,22 +3,13 @@ xml:id="chap-stdenv"> <title>The Standard Environment</title> <para> - The standard build environment in the Nix Packages collection provides an - environment for building Unix packages that does a lot of common build tasks - automatically. In fact, for Unix packages that use the standard - <literal>./configure; make; make install</literal> build interface, you - don’t need to write a build script at all; the standard environment does - everything automatically. If <literal>stdenv</literal> doesn’t do what you - need automatically, you can easily customise or override the various build - phases. + The standard build environment in the Nix Packages collection provides an environment for building Unix packages that does a lot of common build tasks automatically. In fact, for Unix packages that use the standard <literal>./configure; make; make install</literal> build interface, you don’t need to write a build script at all; the standard environment does everything automatically. If <literal>stdenv</literal> doesn’t do what you need automatically, you can easily customise or override the various build phases. </para> <section xml:id="sec-using-stdenv"> <title>Using <literal>stdenv</literal></title> <para> - To build a package with the standard environment, you use the function - <varname>stdenv.mkDerivation</varname>, instead of the primitive built-in - function <varname>derivation</varname>, e.g. + To build a package with the standard environment, you use the function <varname>stdenv.mkDerivation</varname>, instead of the primitive built-in function <varname>derivation</varname>, e.g. <programlisting> stdenv.mkDerivation { name = "libfoo-1.2.3"; @@ -27,17 +18,7 @@ stdenv.mkDerivation { sha256 = "0x2g1jqygyr5wiwg4ma1nd7w4ydpy82z9gkcv8vh2v8dn3y58v5m"; }; }</programlisting> - (<varname>stdenv</varname> needs to be in scope, so if you write this in a - separate Nix expression from <filename>pkgs/all-packages.nix</filename>, you - need to pass it as a function argument.) Specifying a - <varname>name</varname> and a <varname>src</varname> is the absolute minimum - Nix requires. For convenience, you can also use <varname>pname</varname> and - <varname>version</varname> attributes and <literal>mkDerivation</literal> - will automatically set <varname>name</varname> to - <literal>"${pname}-${version}"</literal> by default. Since - <link xlink:href="https://github.com/NixOS/rfcs/pull/35">RFC 0035</link>, - this is preferred for packages in Nixpkgs, as it allows us to reuse the - version easily: + (<varname>stdenv</varname> needs to be in scope, so if you write this in a separate Nix expression from <filename>pkgs/all-packages.nix</filename>, you need to pass it as a function argument.) Specifying a <varname>name</varname> and a <varname>src</varname> is the absolute minimum Nix requires. For convenience, you can also use <varname>pname</varname> and <varname>version</varname> attributes and <literal>mkDerivation</literal> will automatically set <varname>name</varname> to <literal>"${pname}-${version}"</literal> by default. Since <link xlink:href="https://github.com/NixOS/rfcs/pull/35">RFC 0035</link>, this is preferred for packages in Nixpkgs, as it allows us to reuse the version easily: <programlisting> stdenv.mkDerivation rec { pname = "libfoo"; @@ -50,31 +31,18 @@ stdenv.mkDerivation rec { </para> <para> - Many packages have dependencies that are not provided in the standard - environment. It’s usually sufficient to specify those dependencies in the - <varname>buildInputs</varname> attribute: + Many packages have dependencies that are not provided in the standard environment. It’s usually sufficient to specify those dependencies in the <varname>buildInputs</varname> attribute: <programlisting> stdenv.mkDerivation { name = "libfoo-1.2.3"; ... buildInputs = [libbar perl ncurses]; }</programlisting> - This attribute ensures that the <filename>bin</filename> subdirectories of - these packages appear in the <envar>PATH</envar> environment variable during - the build, that their <filename>include</filename> subdirectories are - searched by the C compiler, and so on. (See - <xref linkend="ssec-setup-hooks"/> for details.) + This attribute ensures that the <filename>bin</filename> subdirectories of these packages appear in the <envar>PATH</envar> environment variable during the build, that their <filename>include</filename> subdirectories are searched by the C compiler, and so on. (See <xref linkend="ssec-setup-hooks"/> for details.) </para> <para> - Often it is necessary to override or modify some aspect of the build. To - make this easier, the standard environment breaks the package build into a - number of <emphasis>phases</emphasis>, all of which can be overridden or - modified individually: unpacking the sources, applying patches, configuring, - building, and installing. (There are some others; see - <xref linkend="sec-stdenv-phases"/>.) For instance, a package that doesn’t - supply a makefile but instead has to be compiled “manually” could be - handled like this: + Often it is necessary to override or modify some aspect of the build. To make this easier, the standard environment breaks the package build into a number of <emphasis>phases</emphasis>, all of which can be overridden or modified individually: unpacking the sources, applying patches, configuring, building, and installing. (There are some others; see <xref linkend="sec-stdenv-phases"/>.) For instance, a package that doesn’t supply a makefile but instead has to be compiled “manually” could be handled like this: <programlisting> stdenv.mkDerivation { name = "fnord-4.5"; @@ -87,20 +55,15 @@ stdenv.mkDerivation { cp foo $out/bin ''; }</programlisting> - (Note the use of <literal>''</literal>-style string literals, which are very - convenient for large multi-line script fragments because they don’t need - escaping of <literal>"</literal> and <literal>\</literal>, and because - indentation is intelligently removed.) + (Note the use of <literal>''</literal>-style string literals, which are very convenient for large multi-line script fragments because they don’t need escaping of <literal>"</literal> and <literal>\</literal>, and because indentation is intelligently removed.) </para> <para> - There are many other attributes to customise the build. These are listed in - <xref linkend="ssec-stdenv-attributes"/>. + There are many other attributes to customise the build. These are listed in <xref linkend="ssec-stdenv-attributes"/>. </para> <para> - While the standard environment provides a generic builder, you can still - supply your own build script: + While the standard environment provides a generic builder, you can still supply your own build script: <programlisting> stdenv.mkDerivation { name = "libfoo-1.2.3"; @@ -111,9 +74,7 @@ stdenv.mkDerivation { <programlisting> source $stdenv/setup </programlisting> - to let <literal>stdenv</literal> set up the environment (e.g., process the - <varname>buildInputs</varname>). If you want, you can still use - <literal>stdenv</literal>’s generic builder: + to let <literal>stdenv</literal> set up the environment (e.g., process the <varname>buildInputs</varname>). If you want, you can still use <literal>stdenv</literal>’s generic builder: <programlisting> source $stdenv/setup @@ -179,23 +140,17 @@ genericBuild </listitem> <listitem> <para> - <command>gzip</command>, <command>bzip2</command> and - <command>xz</command>. + <command>gzip</command>, <command>bzip2</command> and <command>xz</command>. </para> </listitem> <listitem> <para> - GNU Make. It has been patched to provide <quote>nested</quote> output - that can be fed into the <command>nix-log2xml</command> command and - <command>log2html</command> stylesheet to create a structured, readable - output of the build steps performed by Make. + GNU Make. It has been patched to provide <quote>nested</quote> output that can be fed into the <command>nix-log2xml</command> command and <command>log2html</command> stylesheet to create a structured, readable output of the build steps performed by Make. </para> </listitem> <listitem> <para> - Bash. This is the shell used for all builders in the Nix Packages - collection. Not using <command>/bin/sh</command> removes a large source - of portability problems. + Bash. This is the shell used for all builders in the Nix Packages collection. Not using <command>/bin/sh</command> removes a large source of portability problems. </para> </listitem> <listitem> @@ -207,108 +162,52 @@ genericBuild </para> <para> - On Linux, <literal>stdenv</literal> also includes the - <command>patchelf</command> utility. + On Linux, <literal>stdenv</literal> also includes the <command>patchelf</command> utility. </para> </section> <section xml:id="ssec-stdenv-dependencies"> <title>Specifying dependencies</title> <para> - As described in the Nix manual, almost any <filename>*.drv</filename> store - path in a derivation's attribute set will induce a dependency on that - derivation. <varname>mkDerivation</varname>, however, takes a few attributes - intended to, between them, include all the dependencies of a package. This - is done both for structure and consistency, but also so that certain other - setup can take place. For example, certain dependencies need their bin - directories added to the <envar>PATH</envar>. That is built-in, but other - setup is done via a pluggable mechanism that works in conjunction with these - dependency attributes. See <xref linkend="ssec-setup-hooks"/> for details. + As described in the Nix manual, almost any <filename>*.drv</filename> store path in a derivation's attribute set will induce a dependency on that derivation. <varname>mkDerivation</varname>, however, takes a few attributes intended to, between them, include all the dependencies of a package. This is done both for structure and consistency, but also so that certain other setup can take place. For example, certain dependencies need their bin directories added to the <envar>PATH</envar>. That is built-in, but other setup is done via a pluggable mechanism that works in conjunction with these dependency attributes. See <xref linkend="ssec-setup-hooks"/> for details. </para> <para> - Dependencies can be broken down along three axes: their host and target - platforms relative to the new derivation's, and whether they are propagated. - The platform distinctions are motivated by cross compilation; see - <xref linkend="chap-cross"/> for exactly what each platform means. + Dependencies can be broken down along three axes: their host and target platforms relative to the new derivation's, and whether they are propagated. The platform distinctions are motivated by cross compilation; see <xref linkend="chap-cross"/> for exactly what each platform means. <footnote xml:id="footnote-stdenv-ignored-build-platform"> <para> - The build platform is ignored because it is a mere implementation detail - of the package satisfying the dependency: As a general programming - principle, dependencies are always <emphasis>specified</emphasis> as - interfaces, not concrete implementation. + The build platform is ignored because it is a mere implementation detail of the package satisfying the dependency: As a general programming principle, dependencies are always <emphasis>specified</emphasis> as interfaces, not concrete implementation. </para> </footnote> - But even if one is not cross compiling, the platforms imply whether or not - the dependency is needed at run-time or build-time, a concept that makes - perfect sense outside of cross compilation. By default, the - run-time/build-time distinction is just a hint for mental clarity, but with - <varname>strictDeps</varname> set it is mostly enforced even in the native - case. + But even if one is not cross compiling, the platforms imply whether or not the dependency is needed at run-time or build-time, a concept that makes perfect sense outside of cross compilation. By default, the run-time/build-time distinction is just a hint for mental clarity, but with <varname>strictDeps</varname> set it is mostly enforced even in the native case. </para> <para> - The extension of <envar>PATH</envar> with dependencies, alluded to above, - proceeds according to the relative platforms alone. The process is carried - out only for dependencies whose host platform matches the new derivation's - build platform i.e. dependencies which run on the platform where the new - derivation will be built. + The extension of <envar>PATH</envar> with dependencies, alluded to above, proceeds according to the relative platforms alone. The process is carried out only for dependencies whose host platform matches the new derivation's build platform i.e. dependencies which run on the platform where the new derivation will be built. <footnote xml:id="footnote-stdenv-native-dependencies-in-path"> <para> - Currently, this means for native builds all dependencies are put on the - <envar>PATH</envar>. But in the future that may not be the case for sake - of matching cross: the platforms would be assumed to be unique for native - and cross builds alike, so only the <varname>depsBuild*</varname> and - <varname>nativeBuildInputs</varname> would be added to the - <envar>PATH</envar>. + Currently, this means for native builds all dependencies are put on the <envar>PATH</envar>. But in the future that may not be the case for sake of matching cross: the platforms would be assumed to be unique for native and cross builds alike, so only the <varname>depsBuild*</varname> and <varname>nativeBuildInputs</varname> would be added to the <envar>PATH</envar>. </para> </footnote> - For each dependency <replaceable>dep</replaceable> of those dependencies, - <filename><replaceable>dep</replaceable>/bin</filename>, if present, is - added to the <envar>PATH</envar> environment variable. + For each dependency <replaceable>dep</replaceable> of those dependencies, <filename><replaceable>dep</replaceable>/bin</filename>, if present, is added to the <envar>PATH</envar> environment variable. </para> <para> - The dependency is propagated when it forces some of its other-transitive - (non-immediate) downstream dependencies to also take it on as an immediate - dependency. Nix itself already takes a package's transitive dependencies - into account, but this propagation ensures nixpkgs-specific infrastructure - like setup hooks (mentioned above) also are run as if the propagated - dependency. + The dependency is propagated when it forces some of its other-transitive (non-immediate) downstream dependencies to also take it on as an immediate dependency. Nix itself already takes a package's transitive dependencies into account, but this propagation ensures nixpkgs-specific infrastructure like setup hooks (mentioned above) also are run as if the propagated dependency. </para> <para> - It is important to note that dependencies are not necessarily propagated as - the same sort of dependency that they were before, but rather as the - corresponding sort so that the platform rules still line up. The exact rules - for dependency propagation can be given by assigning to each dependency two - integers based one how its host and target platforms are offset from the - depending derivation's platforms. Those offsets are given below in the - descriptions of each dependency list attribute. Algorithmically, we traverse - propagated inputs, accumulating every propagated dependency's propagated - dependencies and adjusting them to account for the "shift in perspective" - described by the current dependency's platform offsets. This results in sort - a transitive closure of the dependency relation, with the offsets being - approximately summed when two dependency links are combined. We also prune - transitive dependencies whose combined offsets go out-of-bounds, which can - be viewed as a filter over that transitive closure removing dependencies - that are blatantly absurd. + It is important to note that dependencies are not necessarily propagated as the same sort of dependency that they were before, but rather as the corresponding sort so that the platform rules still line up. The exact rules for dependency propagation can be given by assigning to each dependency two integers based one how its host and target platforms are offset from the depending derivation's platforms. Those offsets are given below in the descriptions of each dependency list attribute. Algorithmically, we traverse propagated inputs, accumulating every propagated dependency's propagated dependencies and adjusting them to account for the "shift in perspective" described by the current dependency's platform offsets. This results in sort a transitive closure of the dependency relation, with the offsets being approximately summed when two dependency links are combined. We also prune transitive dependencies whose combined offsets go out-of-bounds, which can be viewed as a filter over that transitive closure removing dependencies that are blatantly absurd. </para> <para> - We can define the process precisely with - <link xlink:href="https://en.wikipedia.org/wiki/Natural_deduction">Natural - Deduction</link> using the inference rules. This probably seems a bit - obtuse, but so is the bash code that actually implements it! + We can define the process precisely with <link xlink:href="https://en.wikipedia.org/wiki/Natural_deduction">Natural Deduction</link> using the inference rules. This probably seems a bit obtuse, but so is the bash code that actually implements it! <footnote xml:id="footnote-stdenv-find-inputs-location"> <para> - The <function>findInputs</function> function, currently residing in - <filename>pkgs/stdenv/generic/setup.sh</filename>, implements the - propagation logic. + The <function>findInputs</function> function, currently residing in <filename>pkgs/stdenv/generic/setup.sh</filename>, implements the propagation logic. </para> </footnote> - They're confusing in very different ways so... hopefully if something - doesn't make sense in one presentation, it will in the other! + They're confusing in very different ways so... hopefully if something doesn't make sense in one presentation, it will in the other! <programlisting> let mapOffset(h, t, i) = i + (if i <= 0 then h else t - 1) @@ -335,50 +234,22 @@ propagated-dep(mapOffset(h0, t0, h1), propagated-dep(h, t, A, B) ----------------------------- Propagated dependencies count as dependencies dep(h, t, A, B)</programlisting> - Some explanation of this monstrosity is in order. In the common case, the - target offset of a dependency is the successor to the target offset: - <literal>t = h + 1</literal>. That means that: + Some explanation of this monstrosity is in order. In the common case, the target offset of a dependency is the successor to the target offset: <literal>t = h + 1</literal>. That means that: <programlisting> let f(h, t, i) = i + (if i <= 0 then h else t - 1) let f(h, h + 1, i) = i + (if i <= 0 then h else (h + 1) - 1) let f(h, h + 1, i) = i + (if i <= 0 then h else h) let f(h, h + 1, i) = i + h </programlisting> - This is where "sum-like" comes in from above: We can just sum all of the - host offsets to get the host offset of the transitive dependency. The target - offset is the transitive dependency is simply the host offset + 1, just as - it was with the dependencies composed to make this transitive one; it can be - ignored as it doesn't add any new information. + This is where "sum-like" comes in from above: We can just sum all of the host offsets to get the host offset of the transitive dependency. The target offset is the transitive dependency is simply the host offset + 1, just as it was with the dependencies composed to make this transitive one; it can be ignored as it doesn't add any new information. </para> <para> - Because of the bounds checks, the uncommon cases are <literal>h = - t</literal> and <literal>h + 2 = t</literal>. In the former case, the - motivation for <function>mapOffset</function> is that since its host and - target platforms are the same, no transitive dependency of it should be able - to "discover" an offset greater than its reduced target offsets. - <function>mapOffset</function> effectively "squashes" all its transitive - dependencies' offsets so that none will ever be greater than the target - offset of the original <literal>h = t</literal> package. In the other case, - <literal>h + 1</literal> is skipped over between the host and target - offsets. Instead of squashing the offsets, we need to "rip" them apart so no - transitive dependencies' offset is that one. + Because of the bounds checks, the uncommon cases are <literal>h = t</literal> and <literal>h + 2 = t</literal>. In the former case, the motivation for <function>mapOffset</function> is that since its host and target platforms are the same, no transitive dependency of it should be able to "discover" an offset greater than its reduced target offsets. <function>mapOffset</function> effectively "squashes" all its transitive dependencies' offsets so that none will ever be greater than the target offset of the original <literal>h = t</literal> package. In the other case, <literal>h + 1</literal> is skipped over between the host and target offsets. Instead of squashing the offsets, we need to "rip" them apart so no transitive dependencies' offset is that one. </para> <para> - Overall, the unifying theme here is that propagation shouldn't be - introducing transitive dependencies involving platforms the depending - package is unaware of. [One can imagine the dependending package asking for - dependencies with the platforms it knows about; other platforms it doesn't - know how to ask for. The platform description in that scenario is a kind of - unforagable capability.] The offset bounds checking and definition of - <function>mapOffset</function> together ensure that this is the case. - Discovering a new offset is discovering a new platform, and since those - platforms weren't in the derivation "spec" of the needing package, they - cannot be relevant. From a capability perspective, we can imagine that the - host and target platforms of a package are the capabilities a package - requires, and the depending package must provide the capability to the - dependency. + Overall, the unifying theme here is that propagation shouldn't be introducing transitive dependencies involving platforms the depending package is unaware of. [One can imagine the dependending package asking for dependencies with the platforms it knows about; other platforms it doesn't know how to ask for. The platform description in that scenario is a kind of unforagable capability.] The offset bounds checking and definition of <function>mapOffset</function> together ensure that this is the case. Discovering a new offset is discovering a new platform, and since those platforms weren't in the derivation "spec" of the needing package, they cannot be relevant. From a capability perspective, we can imagine that the host and target platforms of a package are the capabilities a package requires, and the depending package must provide the capability to the dependency. </para> <variablelist> @@ -389,23 +260,10 @@ let f(h, h + 1, i) = i + h </term> <listitem> <para> - A list of dependencies whose host and target platforms are the new - derivation's build platform. This means a <literal>-1</literal> host and - <literal>-1</literal> target offset from the new derivation's platforms. - These are programs and libraries used at build time that produce programs - and libraries also used at build time. If the dependency doesn't care - about the target platform (i.e. isn't a compiler or similar tool), put it - in <varname>nativeBuildInputs</varname> instead. The most common use of - this <literal>buildPackages.stdenv.cc</literal>, the default C compiler - for this role. That example crops up more than one might think in old - commonly used C libraries. + A list of dependencies whose host and target platforms are the new derivation's build platform. This means a <literal>-1</literal> host and <literal>-1</literal> target offset from the new derivation's platforms. These are programs and libraries used at build time that produce programs and libraries also used at build time. If the dependency doesn't care about the target platform (i.e. isn't a compiler or similar tool), put it in <varname>nativeBuildInputs</varname> instead. The most common use of this <literal>buildPackages.stdenv.cc</literal>, the default C compiler for this role. That example crops up more than one might think in old commonly used C libraries. </para> <para> - Since these packages are able to be run at build-time, they are always - added to the <envar>PATH</envar>, as described above. But since these - packages are only guaranteed to be able to run then, they shouldn't - persist as run-time dependencies. This isn't currently enforced, but - could be in the future. + Since these packages are able to be run at build-time, they are always added to the <envar>PATH</envar>, as described above. But since these packages are only guaranteed to be able to run then, they shouldn't persist as run-time dependencies. This isn't currently enforced, but could be in the future. </para> </listitem> </varlistentry> @@ -415,24 +273,10 @@ let f(h, h + 1, i) = i + h </term> <listitem> <para> - A list of dependencies whose host platform is the new derivation's build - platform, and target platform is the new derivation's host platform. This - means a <literal>-1</literal> host offset and <literal>0</literal> target - offset from the new derivation's platforms. These are programs and - libraries used at build-time that, if they are a compiler or similar - tool, produce code to run at run-time—i.e. tools used to build the new - derivation. If the dependency doesn't care about the target platform - (i.e. isn't a compiler or similar tool), put it here, rather than in - <varname>depsBuildBuild</varname> or <varname>depsBuildTarget</varname>. - This could be called <varname>depsBuildHost</varname> but - <varname>nativeBuildInputs</varname> is used for historical continuity. - </para> - <para> - Since these packages are able to be run at build-time, they are added to - the <envar>PATH</envar>, as described above. But since these packages are - only guaranteed to be able to run then, they shouldn't persist as - run-time dependencies. This isn't currently enforced, but could be in the - future. + A list of dependencies whose host platform is the new derivation's build platform, and target platform is the new derivation's host platform. This means a <literal>-1</literal> host offset and <literal>0</literal> target offset from the new derivation's platforms. These are programs and libraries used at build-time that, if they are a compiler or similar tool, produce code to run at run-time—i.e. tools used to build the new derivation. If the dependency doesn't care about the target platform (i.e. isn't a compiler or similar tool), put it here, rather than in <varname>depsBuildBuild</varname> or <varname>depsBuildTarget</varname>. This could be called <varname>depsBuildHost</varname> but <varname>nativeBuildInputs</varname> is used for historical continuity. + </para> + <para> + Since these packages are able to be run at build-time, they are added to the <envar>PATH</envar>, as described above. But since these packages are only guaranteed to be able to run then, they shouldn't persist as run-time dependencies. This isn't currently enforced, but could be in the future. </para> </listitem> </varlistentry> @@ -442,39 +286,13 @@ let f(h, h + 1, i) = i + h </term> <listitem> <para> - A list of dependencies whose host platform is the new derivation's build - platform, and target platform is the new derivation's target platform. - This means a <literal>-1</literal> host offset and <literal>1</literal> - target offset from the new derivation's platforms. These are programs - used at build time that produce code to run with code produced by the - depending package. Most commonly, these are tools used to build the - runtime or standard library that the currently-being-built compiler will - inject into any code it compiles. In many cases, the - currently-being-built-compiler is itself employed for that task, but when - that compiler won't run (i.e. its build and host platform differ) this is - not possible. Other times, the compiler relies on some other tool, like - binutils, that is always built separately so that the dependency is - unconditional. - </para> - <para> - This is a somewhat confusing concept to wrap one’s head around, and for - good reason. As the only dependency type where the platform offsets are - not adjacent integers, it requires thinking of a bootstrapping stage - <emphasis>two</emphasis> away from the current one. It and its use-case - go hand in hand and are both considered poor form: try to not need this - sort of dependency, and try to avoid building standard libraries and - runtimes in the same derivation as the compiler produces code using them. - Instead strive to build those like a normal library, using the - newly-built compiler just as a normal library would. In short, do not use - this attribute unless you are packaging a compiler and are sure it is - needed. - </para> - <para> - Since these packages are able to run at build time, they are added to the - <envar>PATH</envar>, as described above. But since these packages are - only guaranteed to be able to run then, they shouldn't persist as - run-time dependencies. This isn't currently enforced, but could be in the - future. + A list of dependencies whose host platform is the new derivation's build platform, and target platform is the new derivation's target platform. This means a <literal>-1</literal> host offset and <literal>1</literal> target offset from the new derivation's platforms. These are programs used at build time that produce code to run with code produced by the depending package. Most commonly, these are tools used to build the runtime or standard library that the currently-being-built compiler will inject into any code it compiles. In many cases, the currently-being-built-compiler is itself employed for that task, but when that compiler won't run (i.e. its build and host platform differ) this is not possible. Other times, the compiler relies on some other tool, like binutils, that is always built separately so that the dependency is unconditional. + </para> + <para> + This is a somewhat confusing concept to wrap one’s head around, and for good reason. As the only dependency type where the platform offsets are not adjacent integers, it requires thinking of a bootstrapping stage <emphasis>two</emphasis> away from the current one. It and its use-case go hand in hand and are both considered poor form: try to not need this sort of dependency, and try to avoid building standard libraries and runtimes in the same derivation as the compiler produces code using them. Instead strive to build those like a normal library, using the newly-built compiler just as a normal library would. In short, do not use this attribute unless you are packaging a compiler and are sure it is needed. + </para> + <para> + Since these packages are able to run at build time, they are added to the <envar>PATH</envar>, as described above. But since these packages are only guaranteed to be able to run then, they shouldn't persist as run-time dependencies. This isn't currently enforced, but could be in the future. </para> </listitem> </varlistentry> @@ -484,16 +302,7 @@ let f(h, h + 1, i) = i + h </term> <listitem> <para> - A list of dependencies whose host and target platforms match the new - derivation's host platform. This means a <literal>0</literal> host offset - and <literal>0</literal> target offset from the new derivation's host - platform. These are packages used at run-time to generate code also used - at run-time. In practice, this would usually be tools used by compilers - for macros or a metaprogramming system, or libraries used by the macros - or metaprogramming code itself. It's always preferable to use a - <varname>depsBuildBuild</varname> dependency in the derivation being - built over a <varname>depsHostHost</varname> on the tool doing the - building for this purpose. + A list of dependencies whose host and target platforms match the new derivation's host platform. This means a <literal>0</literal> host offset and <literal>0</literal> target offset from the new derivation's host platform. These are packages used at run-time to generate code also used at run-time. In practice, this would usually be tools used by compilers for macros or a metaprogramming system, or libraries used by the macros or metaprogramming code itself. It's always preferable to use a <varname>depsBuildBuild</varname> dependency in the derivation being built over a <varname>depsHostHost</varname> on the tool doing the building for this purpose. </para> </listitem> </varlistentry> @@ -503,21 +312,10 @@ let f(h, h + 1, i) = i + h </term> <listitem> <para> - A list of dependencies whose host platform and target platform match the - new derivation's. This means a <literal>0</literal> host offset and a - <literal>1</literal> target offset from the new derivation's host - platform. This would be called <varname>depsHostTarget</varname> but for - historical continuity. If the dependency doesn't care about the target - platform (i.e. isn't a compiler or similar tool), put it here, rather - than in <varname>depsBuildBuild</varname>. + A list of dependencies whose host platform and target platform match the new derivation's. This means a <literal>0</literal> host offset and a <literal>1</literal> target offset from the new derivation's host platform. This would be called <varname>depsHostTarget</varname> but for historical continuity. If the dependency doesn't care about the target platform (i.e. isn't a compiler or similar tool), put it here, rather than in <varname>depsBuildBuild</varname>. </para> <para> - These are often programs and libraries used by the new derivation at - <emphasis>run</emphasis>-time, but that isn't always the case. For - example, the machine code in a statically-linked library is only used at - run-time, but the derivation containing the library is only needed at - build-time. Even in the dynamic case, the library may also be needed at - build-time to appease the linker. + These are often programs and libraries used by the new derivation at <emphasis>run</emphasis>-time, but that isn't always the case. For example, the machine code in a statically-linked library is only used at run-time, but the derivation containing the library is only needed at build-time. Even in the dynamic case, the library may also be needed at build-time to appease the linker. </para> </listitem> </varlistentry> @@ -527,14 +325,7 @@ let f(h, h + 1, i) = i + h </term> <listitem> <para> - A list of dependencies whose host platform matches the new derivation's - target platform. This means a <literal>1</literal> offset from the new - derivation's platforms. These are packages that run on the target - platform, e.g. the standard library or run-time deps of standard library - that a compiler insists on knowing about. It's poor form in almost all - cases for a package to depend on another from a future stage [future - stage corresponding to positive offset]. Do not use this attribute unless - you are packaging a compiler and are sure it is needed. + A list of dependencies whose host platform matches the new derivation's target platform. This means a <literal>1</literal> offset from the new derivation's platforms. These are packages that run on the target platform, e.g. the standard library or run-time deps of standard library that a compiler insists on knowing about. It's poor form in almost all cases for a package to depend on another from a future stage [future stage corresponding to positive offset]. Do not use this attribute unless you are packaging a compiler and are sure it is needed. </para> </listitem> </varlistentry> @@ -544,9 +335,7 @@ let f(h, h + 1, i) = i + h </term> <listitem> <para> - The propagated equivalent of <varname>depsBuildBuild</varname>. This - perhaps never ought to be used, but it is included for consistency [see - below for the others]. + The propagated equivalent of <varname>depsBuildBuild</varname>. This perhaps never ought to be used, but it is included for consistency [see below for the others]. </para> </listitem> </varlistentry> @@ -556,18 +345,7 @@ let f(h, h + 1, i) = i + h </term> <listitem> <para> - The propagated equivalent of <varname>nativeBuildInputs</varname>. This - would be called <varname>depsBuildHostPropagated</varname> but for - historical continuity. For example, if package <varname>Y</varname> has - <literal>propagatedNativeBuildInputs = [X]</literal>, and package - <varname>Z</varname> has <literal>buildInputs = [Y]</literal>, then - package <varname>Z</varname> will be built as if it included package - <varname>X</varname> in its <varname>nativeBuildInputs</varname>. If - instead, package <varname>Z</varname> has <literal>nativeBuildInputs = - [Y]</literal>, then <varname>Z</varname> will be built as if it included - <varname>X</varname> in the <varname>depsBuildBuild</varname> of package - <varname>Z</varname>, because of the sum of the two <literal>-1</literal> - host offsets. + The propagated equivalent of <varname>nativeBuildInputs</varname>. This would be called <varname>depsBuildHostPropagated</varname> but for historical continuity. For example, if package <varname>Y</varname> has <literal>propagatedNativeBuildInputs = [X]</literal>, and package <varname>Z</varname> has <literal>buildInputs = [Y]</literal>, then package <varname>Z</varname> will be built as if it included package <varname>X</varname> in its <varname>nativeBuildInputs</varname>. If instead, package <varname>Z</varname> has <literal>nativeBuildInputs = [Y]</literal>, then <varname>Z</varname> will be built as if it included <varname>X</varname> in the <varname>depsBuildBuild</varname> of package <varname>Z</varname>, because of the sum of the two <literal>-1</literal> host offsets. </para> </listitem> </varlistentry> @@ -577,8 +355,7 @@ let f(h, h + 1, i) = i + h </term> <listitem> <para> - The propagated equivalent of <varname>depsBuildTarget</varname>. This is - prefixed for the same reason of alerting potential users. + The propagated equivalent of <varname>depsBuildTarget</varname>. This is prefixed for the same reason of alerting potential users. </para> </listitem> </varlistentry> @@ -598,9 +375,7 @@ let f(h, h + 1, i) = i + h </term> <listitem> <para> - The propagated equivalent of <varname>buildInputs</varname>. This would - be called <varname>depsHostTargetPropagated</varname> but for historical - continuity. + The propagated equivalent of <varname>buildInputs</varname>. This would be called <varname>depsHostTargetPropagated</varname> but for historical continuity. </para> </listitem> </varlistentry> @@ -610,8 +385,7 @@ let f(h, h + 1, i) = i + h </term> <listitem> <para> - The propagated equivalent of <varname>depsTargetTarget</varname>. This is - prefixed for the same reason of alerting potential users. + The propagated equivalent of <varname>depsTargetTarget</varname>. This is prefixed for the same reason of alerting potential users. </para> </listitem> </varlistentry> @@ -628,15 +402,7 @@ let f(h, h + 1, i) = i + h </term> <listitem> <para> - A natural number indicating how much information to log. If set to 1 or - higher, <literal>stdenv</literal> will print moderate debugging - information during the build. In particular, the <command>gcc</command> - and <command>ld</command> wrapper scripts will print out the complete - command line passed to the wrapped tools. If set to 6 or higher, the - <literal>stdenv</literal> setup script will be run with <literal>set - -x</literal> tracing. If set to 7 or higher, the <command>gcc</command> - and <command>ld</command> wrapper scripts will also be run with - <literal>set -x</literal> tracing. + A natural number indicating how much information to log. If set to 1 or higher, <literal>stdenv</literal> will print moderate debugging information during the build. In particular, the <command>gcc</command> and <command>ld</command> wrapper scripts will print out the complete command line passed to the wrapped tools. If set to 6 or higher, the <literal>stdenv</literal> setup script will be run with <literal>set -x</literal> tracing. If set to 7 or higher, the <command>gcc</command> and <command>ld</command> wrapper scripts will also be run with <literal>set -x</literal> tracing. </para> </listitem> </varlistentry> @@ -650,15 +416,10 @@ let f(h, h + 1, i) = i + h </term> <listitem> <para> - If set to <literal>true</literal>, <literal>stdenv</literal> will pass - specific flags to <literal>make</literal> and other build tools to enable - parallel building with up to <literal>build-cores</literal> workers. + If set to <literal>true</literal>, <literal>stdenv</literal> will pass specific flags to <literal>make</literal> and other build tools to enable parallel building with up to <literal>build-cores</literal> workers. </para> <para> - Unless set to <literal>false</literal>, some build systems with good - support for parallel building including <literal>cmake</literal>, - <literal>meson</literal>, and <literal>qmake</literal> will set it to - <literal>true</literal>. + Unless set to <literal>false</literal>, some build systems with good support for parallel building including <literal>cmake</literal>, <literal>meson</literal>, and <literal>qmake</literal> will set it to <literal>true</literal>. </para> </listitem> </varlistentry> @@ -672,8 +433,7 @@ let f(h, h + 1, i) = i + h </term> <listitem> <para> - This is an attribute set which can be filled with arbitrary values. For - example: + This is an attribute set which can be filled with arbitrary values. For example: <programlisting> passthru = { foo = "bar"; @@ -685,29 +445,17 @@ passthru = { </programlisting> </para> <para> - Values inside it are not passed to the builder, so you can change them - without triggering a rebuild. However, they can be accessed outside of a - derivation directly, as if they were set inside a derivation itself, e.g. - <literal>hello.baz.value1</literal>. We don't specify any usage or schema - of <literal>passthru</literal> - it is meant for values that would be - useful outside the derivation in other parts of a Nix expression (e.g. in - other derivations). An example would be to convey some specific - dependency of your derivation which contains a program with plugins - support. Later, others who make derivations with plugins can use - passed-through dependency to ensure that their plugin would be - binary-compatible with built program. + Values inside it are not passed to the builder, so you can change them without triggering a rebuild. However, they can be accessed outside of a derivation directly, as if they were set inside a derivation itself, e.g. <literal>hello.baz.value1</literal>. We don't specify any usage or schema of <literal>passthru</literal> - it is meant for values that would be useful outside the derivation in other parts of a Nix expression (e.g. in other derivations). An example would be to convey some specific dependency of your derivation which contains a program with plugins support. Later, others who make derivations with plugins can use passed-through dependency to ensure that their plugin would be binary-compatible with built program. </para> </listitem> </varlistentry> - <varlistentry> + <varlistentry xml:id="var-passthru-updateScript"> <term> <varname>passthru.updateScript</varname> </term> <listitem> <para> - A script to be run by <filename>maintainers/scripts/update.nix</filename> - when the package is matched. It needs to be an executable file, either on - the file system: + A script to be run by <filename>maintainers/scripts/update.nix</filename> when the package is matched. It needs to be an executable file, either on the file system: <programlisting> passthru.updateScript = ./update.sh; </programlisting> @@ -723,21 +471,16 @@ passthru.updateScript = writeScript "update-zoom-us" '' update-source-version zoom-us "$version" ''; </programlisting> - The attribute can also contain a list, a script followed by arguments to - be passed to it: + The attribute can also contain a list, a script followed by arguments to be passed to it: <programlisting> passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ]; </programlisting> </para> <para> - The script will be usually run from the root of the Nixpkgs repository - but you should not rely on that. Also note that the update scripts will - be run in parallel by default; you should avoid running <command>git - commit</command> or any other commands that cannot handle that. + The script will be usually run from the root of the Nixpkgs repository but you should not rely on that. Also note that the update scripts will be run in parallel by default; you should avoid running <command>git commit</command> or any other commands that cannot handle that. </para> <para> - For information about how to run the updates, execute - <command>nix-shell maintainers/scripts/update.nix</command>. + For information about how to run the updates, execute <command>nix-shell maintainers/scripts/update.nix</command>. </para> </listitem> </varlistentry> @@ -747,32 +490,18 @@ passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ] <title>Phases</title> <para> - The generic builder has a number of <emphasis>phases</emphasis>. Package - builds are split into phases to make it easier to override specific parts of - the build (e.g., unpacking the sources or installing the binaries). - Furthermore, it allows a nicer presentation of build logs in the Nix build - farm. + The generic builder has a number of <emphasis>phases</emphasis>. Package builds are split into phases to make it easier to override specific parts of the build (e.g., unpacking the sources or installing the binaries). Furthermore, it allows a nicer presentation of build logs in the Nix build farm. </para> <para> - Each phase can be overridden in its entirety either by setting the - environment variable <varname><replaceable>name</replaceable>Phase</varname> - to a string containing some shell commands to be executed, or by redefining - the shell function <varname><replaceable>name</replaceable>Phase</varname>. - The former is convenient to override a phase from the derivation, while the - latter is convenient from a build script. However, typically one only wants - to <emphasis>add</emphasis> some commands to a phase, e.g. by defining - <literal>postInstall</literal> or <literal>preFixup</literal>, as skipping - some of the default actions may have unexpected consequences. The default - script for each phase is defined in the file <filename>pkgs/stdenv/generic/setup.sh</filename>. + Each phase can be overridden in its entirety either by setting the environment variable <varname><replaceable>name</replaceable>Phase</varname> to a string containing some shell commands to be executed, or by redefining the shell function <varname><replaceable>name</replaceable>Phase</varname>. The former is convenient to override a phase from the derivation, while the latter is convenient from a build script. However, typically one only wants to <emphasis>add</emphasis> some commands to a phase, e.g. by defining <literal>postInstall</literal> or <literal>preFixup</literal>, as skipping some of the default actions may have unexpected consequences. The default script for each phase is defined in the file <filename>pkgs/stdenv/generic/setup.sh</filename>. </para> <section xml:id="ssec-controlling-phases"> <title>Controlling phases</title> <para> - There are a number of variables that control what phases are executed and - in what order: + There are a number of variables that control what phases are executed and in what order: <variablelist> <title>Variables affecting phase control</title> <varlistentry> @@ -781,18 +510,10 @@ passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ] </term> <listitem> <para> - Specifies the phases. You can change the order in which phases are - executed, or add new phases, by setting this variable. If it’s not - set, the default value is used, which is <literal>$prePhases - unpackPhase patchPhase $preConfigurePhases configurePhase - $preBuildPhases buildPhase checkPhase $preInstallPhases installPhase - fixupPhase installCheckPhase $preDistPhases distPhase $postPhases</literal>. + Specifies the phases. You can change the order in which phases are executed, or add new phases, by setting this variable. If it’s not set, the default value is used, which is <literal>$prePhases unpackPhase patchPhase $preConfigurePhases configurePhase $preBuildPhases buildPhase checkPhase $preInstallPhases installPhase fixupPhase installCheckPhase $preDistPhases distPhase $postPhases</literal>. </para> <para> - Usually, if you just want to add a few phases, it’s more convenient - to set one of the variables below (such as - <varname>preInstallPhases</varname>), as you then don’t specify all - the normal phases. + Usually, if you just want to add a few phases, it’s more convenient to set one of the variables below (such as <varname>preInstallPhases</varname>), as you then don’t specify all the normal phases. </para> </listitem> </varlistentry> @@ -874,11 +595,7 @@ passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ] <title>The unpack phase</title> <para> - The unpack phase is responsible for unpacking the source code of the - package. The default implementation of <function>unpackPhase</function> - unpacks the source files listed in the <envar>src</envar> environment - variable to the current directory. It supports the following files by - default: + The unpack phase is responsible for unpacking the source code of the package. The default implementation of <function>unpackPhase</function> unpacks the source files listed in the <envar>src</envar> environment variable to the current directory. It supports the following files by default: <variablelist> <varlistentry> <term> @@ -886,13 +603,7 @@ passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ] </term> <listitem> <para> - These can optionally be compressed using <command>gzip</command> - (<filename>.tar.gz</filename>, <filename>.tgz</filename> or - <filename>.tar.Z</filename>), <command>bzip2</command> - (<filename>.tar.bz2</filename>, <filename>.tbz2</filename> or - <filename>.tbz</filename>) or <command>xz</command> - (<filename>.tar.xz</filename>, <filename>.tar.lzma</filename> or - <filename>.txz</filename>). + These can optionally be compressed using <command>gzip</command> (<filename>.tar.gz</filename>, <filename>.tgz</filename> or <filename>.tar.Z</filename>), <command>bzip2</command> (<filename>.tar.bz2</filename>, <filename>.tbz2</filename> or <filename>.tbz</filename>) or <command>xz</command> (<filename>.tar.xz</filename>, <filename>.tar.lzma</filename> or <filename>.txz</filename>). </para> </listitem> </varlistentry> @@ -902,9 +613,7 @@ passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ] </term> <listitem> <para> - Zip files are unpacked using <command>unzip</command>. However, - <command>unzip</command> is not in the standard environment, so you - should add it to <varname>nativeBuildInputs</varname> yourself. + Zip files are unpacked using <command>unzip</command>. However, <command>unzip</command> is not in the standard environment, so you should add it to <varname>nativeBuildInputs</varname> yourself. </para> </listitem> </varlistentry> @@ -914,16 +623,12 @@ passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ] </term> <listitem> <para> - These are simply copied to the current directory. The hash part of the - file name is stripped, e.g. - <filename>/nix/store/1wydxgby13cz...-my-sources</filename> would be - copied to <filename>my-sources</filename>. + These are simply copied to the current directory. The hash part of the file name is stripped, e.g. <filename>/nix/store/1wydxgby13cz...-my-sources</filename> would be copied to <filename>my-sources</filename>. </para> </listitem> </varlistentry> </variablelist> - Additional file types can be supported by setting the - <varname>unpackCmd</varname> variable (see below). + Additional file types can be supported by setting the <varname>unpackCmd</varname> variable (see below). </para> <para></para> @@ -936,8 +641,7 @@ passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ] </term> <listitem> <para> - The list of source files or directories to be unpacked or copied. One of - these must be set. + The list of source files or directories to be unpacked or copied. One of these must be set. </para> </listitem> </varlistentry> @@ -947,10 +651,7 @@ passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ] </term> <listitem> <para> - After running <function>unpackPhase</function>, the generic builder - changes the current directory to the directory created by unpacking the - sources. If there are multiple source directories, you should set - <varname>sourceRoot</varname> to the name of the intended directory. + After running <function>unpackPhase</function>, the generic builder changes the current directory to the directory created by unpacking the sources. If there are multiple source directories, you should set <varname>sourceRoot</varname> to the name of the intended directory. </para> </listitem> </varlistentry> @@ -960,10 +661,7 @@ passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ] </term> <listitem> <para> - Alternatively to setting <varname>sourceRoot</varname>, you can set - <varname>setSourceRoot</varname> to a shell command to be evaluated by - the unpack phase after the sources have been unpacked. This command must - set <varname>sourceRoot</varname>. + Alternatively to setting <varname>sourceRoot</varname>, you can set <varname>setSourceRoot</varname> to a shell command to be evaluated by the unpack phase after the sources have been unpacked. This command must set <varname>sourceRoot</varname>. </para> </listitem> </varlistentry> @@ -1003,10 +701,7 @@ passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ] </term> <listitem> <para> - If set to <literal>1</literal>, the unpacked sources are - <emphasis>not</emphasis> made writable. By default, they are made - writable to prevent problems with read-only sources. For example, copied - store directories would be read-only without this. + If set to <literal>1</literal>, the unpacked sources are <emphasis>not</emphasis> made writable. By default, they are made writable to prevent problems with read-only sources. For example, copied store directories would be read-only without this. </para> </listitem> </varlistentry> @@ -1016,9 +711,7 @@ passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ] </term> <listitem> <para> - The unpack phase evaluates the string <literal>$unpackCmd</literal> for - any unrecognised file. The path to the current source file is contained - in the <varname>curSrc</varname> variable. + The unpack phase evaluates the string <literal>$unpackCmd</literal> for any unrecognised file. The path to the current source file is contained in the <varname>curSrc</varname> variable. </para> </listitem> </varlistentry> @@ -1029,8 +722,7 @@ passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ] <title>The patch phase</title> <para> - The patch phase applies the list of patches defined in the - <varname>patches</varname> variable. + The patch phase applies the list of patches defined in the <varname>patches</varname> variable. </para> <variablelist> @@ -1041,11 +733,7 @@ passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ] </term> <listitem> <para> - The list of patches. They must be in the format accepted by the - <command>patch</command> command, and may optionally be compressed using - <command>gzip</command> (<filename>.gz</filename>), - <command>bzip2</command> (<filename>.bz2</filename>) or - <command>xz</command> (<filename>.xz</filename>). + The list of patches. They must be in the format accepted by the <command>patch</command> command, and may optionally be compressed using <command>gzip</command> (<filename>.gz</filename>), <command>bzip2</command> (<filename>.bz2</filename>) or <command>xz</command> (<filename>.xz</filename>). </para> </listitem> </varlistentry> @@ -1055,9 +743,7 @@ passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ] </term> <listitem> <para> - Flags to be passed to <command>patch</command>. If not set, the argument - <option>-p1</option> is used, which causes the leading directory - component to be stripped from the file names in each patch. + Flags to be passed to <command>patch</command>. If not set, the argument <option>-p1</option> is used, which causes the leading directory component to be stripped from the file names in each patch. </para> </listitem> </varlistentry> @@ -1088,9 +774,7 @@ passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ] <title>The configure phase</title> <para> - The configure phase prepares the source tree for building. The default - <function>configurePhase</function> runs <filename>./configure</filename> - (typically an Autoconf-generated script) if it exists. + The configure phase prepares the source tree for building. The default <function>configurePhase</function> runs <filename>./configure</filename> (typically an Autoconf-generated script) if it exists. </para> <variablelist> @@ -1101,10 +785,7 @@ passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ] </term> <listitem> <para> - The name of the configure script. It defaults to - <filename>./configure</filename> if it exists; otherwise, the configure - phase is skipped. This can actually be a command (like <literal>perl - ./Configure.pl</literal>). + The name of the configure script. It defaults to <filename>./configure</filename> if it exists; otherwise, the configure phase is skipped. This can actually be a command (like <literal>perl ./Configure.pl</literal>). </para> </listitem> </varlistentry> @@ -1114,8 +795,7 @@ passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ] </term> <listitem> <para> - A list of strings passed as additional arguments to the configure - script. + A list of strings passed as additional arguments to the configure script. </para> </listitem> </varlistentry> @@ -1135,9 +815,7 @@ passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ] </term> <listitem> <para> - A shell array containing additional arguments passed to the configure - script. You must use this instead of <varname>configureFlags</varname> - if the arguments contain spaces. + A shell array containing additional arguments passed to the configure script. You must use this instead of <varname>configureFlags</varname> if the arguments contain spaces. </para> </listitem> </varlistentry> @@ -1147,8 +825,7 @@ passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ] </term> <listitem> <para> - By default, the flag <literal>--prefix=$prefix</literal> is added to the - configure flags. If this is undesirable, set this variable to true. + By default, the flag <literal>--prefix=$prefix</literal> is added to the configure flags. If this is undesirable, set this variable to true. </para> </listitem> </varlistentry> @@ -1158,9 +835,7 @@ passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ] </term> <listitem> <para> - The prefix under which the package must be installed, passed via the - <option>--prefix</option> option to the configure script. It defaults to - <option>$out</option>. + The prefix under which the package must be installed, passed via the <option>--prefix</option> option to the configure script. It defaults to <option>$out</option>. </para> </listitem> </varlistentry> @@ -1170,8 +845,7 @@ passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ] </term> <listitem> <para> - The key to use when specifying the prefix. By default, this is set to - <option>--prefix=</option> as that is used by the majority of packages. + The key to use when specifying the prefix. By default, this is set to <option>--prefix=</option> as that is used by the majority of packages. </para> </listitem> </varlistentry> @@ -1181,9 +855,7 @@ passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ] </term> <listitem> <para> - By default, the flag <literal>--disable-dependency-tracking</literal> is - added to the configure flags to speed up Automake-based builds. If this - is undesirable, set this variable to true. + By default, the flag <literal>--disable-dependency-tracking</literal> is added to the configure flags to speed up Automake-based builds. If this is undesirable, set this variable to true. </para> </listitem> </varlistentry> @@ -1193,15 +865,10 @@ passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ] </term> <listitem> <para> - By default, the configure phase applies some special hackery to all - files called <filename>ltmain.sh</filename> before running the configure - script in order to improve the purity of Libtool-based packages + By default, the configure phase applies some special hackery to all files called <filename>ltmain.sh</filename> before running the configure script in order to improve the purity of Libtool-based packages <footnote xml:id="footnote-stdenv-sys-lib-search-path"> <para> - It clears the - <varname>sys_lib_<replaceable>*</replaceable>search_path</varname> - variables in the Libtool script to prevent Libtool from using - libraries in <filename>/usr/lib</filename> and such. + It clears the <varname>sys_lib_<replaceable>*</replaceable>search_path</varname> variables in the Libtool script to prevent Libtool from using libraries in <filename>/usr/lib</filename> and such. </para> </footnote> . If this is undesirable, set this variable to true. @@ -1214,9 +881,7 @@ passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ] </term> <listitem> <para> - By default, when the configure script has - <option>--enable-static</option>, the option - <option>--disable-static</option> is added to the configure flags. + By default, when the configure script has <option>--enable-static</option>, the option <option>--disable-static</option> is added to the configure flags. </para> <para> If this is undesirable, set this variable to true. @@ -1229,16 +894,10 @@ passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ] </term> <listitem> <para> - By default, when cross compiling, the configure script has - <option>--build=...</option> and <option>--host=...</option> passed. - Packages can instead pass <literal>[ "build" "host" "target" ]</literal> - or a subset to control exactly which platform flags are passed. - Compilers and other tools can use this to also pass the target platform. + By default, when cross compiling, the configure script has <option>--build=...</option> and <option>--host=...</option> passed. Packages can instead pass <literal>[ "build" "host" "target" ]</literal> or a subset to control exactly which platform flags are passed. Compilers and other tools can use this to also pass the target platform. <footnote xml:id="footnote-stdenv-build-time-guessing-impurity"> <para> - Eventually these will be passed building natively as well, to improve - determinism: build-time guessing, as is done today, is a risk of - impurity. + Eventually these will be passed building natively as well, to improve determinism: build-time guessing, as is done today, is a risk of impurity. </para> </footnote> </para> @@ -1271,12 +930,7 @@ passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ] <title>The build phase</title> <para> - The build phase is responsible for actually building the package (e.g. - compiling it). The default <function>buildPhase</function> simply calls - <command>make</command> if a file named <filename>Makefile</filename>, - <filename>makefile</filename> or <filename>GNUmakefile</filename> exists in - the current directory (or the <varname>makefile</varname> is explicitly - set); otherwise it does nothing. + The build phase is responsible for actually building the package (e.g. compiling it). The default <function>buildPhase</function> simply calls <command>make</command> if a file named <filename>Makefile</filename>, <filename>makefile</filename> or <filename>GNUmakefile</filename> exists in the current directory (or the <varname>makefile</varname> is explicitly set); otherwise it does nothing. </para> <variablelist> @@ -1307,17 +961,13 @@ passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ] </term> <listitem> <para> - A list of strings passed as additional flags to <command>make</command>. - These flags are also used by the default install and check phase. For - setting make flags specific to the build phase, use - <varname>buildFlags</varname> (see below). + A list of strings passed as additional flags to <command>make</command>. These flags are also used by the default install and check phase. For setting make flags specific to the build phase, use <varname>buildFlags</varname> (see below). <programlisting> makeFlags = [ "PREFIX=$(out)" ]; </programlisting> <note> <para> - The flags are quoted in bash, but environment variables can be - specified by using the make syntax. + The flags are quoted in bash, but environment variables can be specified by using the make syntax. </para> </note> </para> @@ -1329,18 +979,13 @@ makeFlags = [ "PREFIX=$(out)" ]; </term> <listitem> <para> - A shell array containing additional arguments passed to - <command>make</command>. You must use this instead of - <varname>makeFlags</varname> if the arguments contain spaces, e.g. + A shell array containing additional arguments passed to <command>make</command>. You must use this instead of <varname>makeFlags</varname> if the arguments contain spaces, e.g. <programlisting> preBuild = '' makeFlagsArray+=(CFLAGS="-O0 -g" LDFLAGS="-lfoo -lbar") ''; </programlisting> - Note that shell arrays cannot be passed through environment variables, - so you cannot set <varname>makeFlagsArray</varname> in a derivation - attribute (because those are passed through environment variables): you - have to define them in shell code. + Note that shell arrays cannot be passed through environment variables, so you cannot set <varname>makeFlagsArray</varname> in a derivation attribute (because those are passed through environment variables): you have to define them in shell code. </para> </listitem> </varlistentry> @@ -1350,9 +995,7 @@ preBuild = '' </term> <listitem> <para> - A list of strings passed as additional flags to <command>make</command>. - Like <varname>makeFlags</varname> and <varname>makeFlagsArray</varname>, - but only used by the build phase. + A list of strings passed as additional flags to <command>make</command>. Like <varname>makeFlags</varname> and <varname>makeFlagsArray</varname>, but only used by the build phase. </para> </listitem> </varlistentry> @@ -1379,14 +1022,11 @@ preBuild = '' </variablelist> <para> - You can set flags for <command>make</command> through the - <varname>makeFlags</varname> variable. + You can set flags for <command>make</command> through the <varname>makeFlags</varname> variable. </para> <para> - Before and after running <command>make</command>, the hooks - <varname>preBuild</varname> and <varname>postBuild</varname> are called, - respectively. + Before and after running <command>make</command>, the hooks <varname>preBuild</varname> and <varname>postBuild</varname> are called, respectively. </para> </section> @@ -1394,10 +1034,7 @@ preBuild = '' <title>The check phase</title> <para> - The check phase checks whether the package was built correctly by running - its test suite. The default <function>checkPhase</function> calls - <command>make check</command>, but only if the <varname>doCheck</varname> - variable is enabled. + The check phase checks whether the package was built correctly by running its test suite. The default <function>checkPhase</function> calls <command>make check</command>, but only if the <varname>doCheck</varname> variable is enabled. </para> <variablelist> @@ -1408,14 +1045,9 @@ preBuild = '' </term> <listitem> <para> - Controls whether the check phase is executed. By default it is skipped, - but if <varname>doCheck</varname> is set to true, the check phase is - usually executed. Thus you should set + Controls whether the check phase is executed. By default it is skipped, but if <varname>doCheck</varname> is set to true, the check phase is usually executed. Thus you should set <programlisting>doCheck = true;</programlisting> - in the derivation to enable checks. The exception is cross compilation. - Cross compiled builds never run tests, no matter how - <varname>doCheck</varname> is set, as the newly-built program won't run - on the platform used to build it. + in the derivation to enable checks. The exception is cross compilation. Cross compiled builds never run tests, no matter how <varname>doCheck</varname> is set, as the newly-built program won't run on the platform used to build it. </para> </listitem> </varlistentry> @@ -1435,8 +1067,7 @@ preBuild = '' </term> <listitem> <para> - The make target that runs the tests. Defaults to - <literal>check</literal>. + The make target that runs the tests. Defaults to <literal>check</literal>. </para> </listitem> </varlistentry> @@ -1446,9 +1077,7 @@ preBuild = '' </term> <listitem> <para> - A list of strings passed as additional flags to <command>make</command>. - Like <varname>makeFlags</varname> and <varname>makeFlagsArray</varname>, - but only used by the check phase. + A list of strings passed as additional flags to <command>make</command>. Like <varname>makeFlags</varname> and <varname>makeFlagsArray</varname>, but only used by the check phase. </para> </listitem> </varlistentry> @@ -1458,9 +1087,7 @@ preBuild = '' </term> <listitem> <para> - A list of dependencies used by the phase. This gets included in - <varname>nativeBuildInputs</varname> when <varname>doCheck</varname> is - set. + A list of dependencies used by the phase. This gets included in <varname>nativeBuildInputs</varname> when <varname>doCheck</varname> is set. </para> </listitem> </varlistentry> @@ -1491,10 +1118,7 @@ preBuild = '' <title>The install phase</title> <para> - The install phase is responsible for installing the package in the Nix - store under <envar>out</envar>. The default - <function>installPhase</function> creates the directory - <literal>$out</literal> and calls <command>make install</command>. + The install phase is responsible for installing the package in the Nix store under <envar>out</envar>. The default <function>installPhase</function> creates the directory <literal>$out</literal> and calls <command>make install</command>. </para> <variablelist> @@ -1515,8 +1139,7 @@ preBuild = '' </term> <listitem> <para> - The make targets that perform the installation. Defaults to - <literal>install</literal>. Example: + The make targets that perform the installation. Defaults to <literal>install</literal>. Example: <programlisting> installTargets = "install-bin install-doc";</programlisting> </para> @@ -1528,9 +1151,7 @@ installTargets = "install-bin install-doc";</programlisting> </term> <listitem> <para> - A list of strings passed as additional flags to <command>make</command>. - Like <varname>makeFlags</varname> and <varname>makeFlagsArray</varname>, - but only used by the install phase. + A list of strings passed as additional flags to <command>make</command>. Like <varname>makeFlags</varname> and <varname>makeFlagsArray</varname>, but only used by the install phase. </para> </listitem> </varlistentry> @@ -1561,15 +1182,11 @@ installTargets = "install-bin install-doc";</programlisting> <title>The fixup phase</title> <para> - The fixup phase performs some (Nix-specific) post-processing actions on the - files installed under <filename>$out</filename> by the install phase. The - default <function>fixupPhase</function> does the following: + The fixup phase performs some (Nix-specific) post-processing actions on the files installed under <filename>$out</filename> by the install phase. The default <function>fixupPhase</function> does the following: <itemizedlist> <listitem> <para> - It moves the <filename>man/</filename>, <filename>doc/</filename> and - <filename>info/</filename> subdirectories of <envar>$out</envar> to - <filename>share/</filename>. + It moves the <filename>man/</filename>, <filename>doc/</filename> and <filename>info/</filename> subdirectories of <envar>$out</envar> to <filename>share/</filename>. </para> </listitem> <listitem> @@ -1579,19 +1196,12 @@ installTargets = "install-bin install-doc";</programlisting> </listitem> <listitem> <para> - On Linux, it applies the <command>patchelf</command> command to ELF - executables and libraries to remove unused directories from the - <literal>RPATH</literal> in order to prevent unnecessary runtime - dependencies. + On Linux, it applies the <command>patchelf</command> command to ELF executables and libraries to remove unused directories from the <literal>RPATH</literal> in order to prevent unnecessary runtime dependencies. </para> </listitem> <listitem> <para> - It rewrites the interpreter paths of shell scripts to paths found in - <envar>PATH</envar>. E.g., <filename>/usr/bin/perl</filename> will be - rewritten to - <filename>/nix/store/<replaceable>some-perl</replaceable>/bin/perl</filename> - found in <envar>PATH</envar>. + It rewrites the interpreter paths of shell scripts to paths found in <envar>PATH</envar>. E.g., <filename>/usr/bin/perl</filename> will be rewritten to <filename>/nix/store/<replaceable>some-perl</replaceable>/bin/perl</filename> found in <envar>PATH</envar>. </para> </listitem> </itemizedlist> @@ -1605,7 +1215,7 @@ installTargets = "install-bin install-doc";</programlisting> </term> <listitem> <para> - Set to true to skip the fixup phase. + Set to true to skip the fixup phase. </para> </listitem> </varlistentry> @@ -1615,8 +1225,7 @@ installTargets = "install-bin install-doc";</programlisting> </term> <listitem> <para> - If set, libraries and executables are not stripped. By default, they - are. + If set, libraries and executables are not stripped. By default, they are. </para> </listitem> </varlistentry> @@ -1626,10 +1235,7 @@ installTargets = "install-bin install-doc";</programlisting> </term> <listitem> <para> - Like <varname>dontStrip</varname>, but only affects the - <command>strip</command> command targetting the package's host platform. - Useful when supporting cross compilation, but otherwise feel free to - ignore. + Like <varname>dontStrip</varname>, but only affects the <command>strip</command> command targetting the package's host platform. Useful when supporting cross compilation, but otherwise feel free to ignore. </para> </listitem> </varlistentry> @@ -1639,10 +1245,7 @@ installTargets = "install-bin install-doc";</programlisting> </term> <listitem> <para> - Like <varname>dontStrip</varname>, but only affects the - <command>strip</command> command targetting the packages' target - platform. Useful when supporting cross compilation, but otherwise feel - free to ignore. + Like <varname>dontStrip</varname>, but only affects the <command>strip</command> command targetting the packages' target platform. Useful when supporting cross compilation, but otherwise feel free to ignore. </para> </listitem> </varlistentry> @@ -1652,8 +1255,7 @@ installTargets = "install-bin install-doc";</programlisting> </term> <listitem> <para> - If set, files in <filename>$out/sbin</filename> are not moved to - <filename>$out/bin</filename>. By default, they are. + If set, files in <filename>$out/sbin</filename> are not moved to <filename>$out/bin</filename>. By default, they are. </para> </listitem> </varlistentry> @@ -1663,10 +1265,7 @@ installTargets = "install-bin install-doc";</programlisting> </term> <listitem> <para> - List of directories to search for libraries and executables from which - <emphasis>all</emphasis> symbols should be stripped. By default, it’s - empty. Stripping all symbols is risky, since it may remove not just - debug symbols but also ELF information necessary for normal execution. + List of directories to search for libraries and executables from which <emphasis>all</emphasis> symbols should be stripped. By default, it’s empty. Stripping all symbols is risky, since it may remove not just debug symbols but also ELF information necessary for normal execution. </para> </listitem> </varlistentry> @@ -1676,9 +1275,7 @@ installTargets = "install-bin install-doc";</programlisting> </term> <listitem> <para> - Flags passed to the <command>strip</command> command applied to the - files in the directories listed in <varname>stripAllList</varname>. - Defaults to <option>-s</option> (i.e. <option>--strip-all</option>). + Flags passed to the <command>strip</command> command applied to the files in the directories listed in <varname>stripAllList</varname>. Defaults to <option>-s</option> (i.e. <option>--strip-all</option>). </para> </listitem> </varlistentry> @@ -1688,9 +1285,7 @@ installTargets = "install-bin install-doc";</programlisting> </term> <listitem> <para> - List of directories to search for libraries and executables from which - only debugging-related symbols should be stripped. It defaults to - <literal>lib bin sbin</literal>. + List of directories to search for libraries and executables from which only debugging-related symbols should be stripped. It defaults to <literal>lib bin sbin</literal>. </para> </listitem> </varlistentry> @@ -1700,9 +1295,7 @@ installTargets = "install-bin install-doc";</programlisting> </term> <listitem> <para> - Flags passed to the <command>strip</command> command applied to the - files in the directories listed in <varname>stripDebugList</varname>. - Defaults to <option>-S</option> (i.e. <option>--strip-debug</option>). + Flags passed to the <command>strip</command> command applied to the files in the directories listed in <varname>stripDebugList</varname>. Defaults to <option>-S</option> (i.e. <option>--strip-debug</option>). </para> </listitem> </varlistentry> @@ -1712,8 +1305,7 @@ installTargets = "install-bin install-doc";</programlisting> </term> <listitem> <para> - If set, the <command>patchelf</command> command is not used to remove - unnecessary <literal>RPATH</literal> entries. Only applies to Linux. + If set, the <command>patchelf</command> command is not used to remove unnecessary <literal>RPATH</literal> entries. Only applies to Linux. </para> </listitem> </varlistentry> @@ -1723,8 +1315,7 @@ installTargets = "install-bin install-doc";</programlisting> </term> <listitem> <para> - If set, scripts starting with <literal>#!</literal> do not have their - interpreter paths rewritten to paths in the Nix store. + If set, scripts starting with <literal>#!</literal> do not have their interpreter paths rewritten to paths in the Nix store. </para> </listitem> </varlistentry> @@ -1734,9 +1325,7 @@ installTargets = "install-bin install-doc";</programlisting> </term> <listitem> <para> - If set, libtool <literal>.la</literal> files associated with shared - libraries won't have their <literal>dependency_libs</literal> field - cleared. + If set, libtool <literal>.la</literal> files associated with shared libraries won't have their <literal>dependency_libs</literal> field cleared. </para> </listitem> </varlistentry> @@ -1746,9 +1335,7 @@ installTargets = "install-bin install-doc";</programlisting> </term> <listitem> <para> - The list of directories that must be moved from - <filename>$out</filename> to <filename>$out/share</filename>. Defaults - to <literal>man doc info</literal>. + The list of directories that must be moved from <filename>$out</filename> to <filename>$out/share</filename>. Defaults to <literal>man doc info</literal>. </para> </listitem> </varlistentry> @@ -1758,11 +1345,7 @@ installTargets = "install-bin install-doc";</programlisting> </term> <listitem> <para> - A package can export a <link linkend="ssec-setup-hooks">setup - hook</link> by setting this variable. The setup hook, if defined, is - copied to <filename>$out/nix-support/setup-hook</filename>. Environment - variables are then substituted in it using - <function + A package can export a <link linkend="ssec-setup-hooks">setup hook</link> by setting this variable. The setup hook, if defined, is copied to <filename>$out/nix-support/setup-hook</filename>. Environment variables are then substituted in it using <function linkend="fun-substituteAll">substituteAll</function>. </para> </listitem> @@ -1793,25 +1376,14 @@ installTargets = "install-bin install-doc";</programlisting> </term> <listitem> <para> - If set to <literal>true</literal>, the standard environment will enable - debug information in C/C++ builds. After installation, the debug - information will be separated from the executables and stored in the - output named <literal>debug</literal>. (This output is enabled - automatically; you don’t need to set the <varname>outputs</varname> - attribute explicitly.) To be precise, the debug information is stored in - <filename><replaceable>debug</replaceable>/lib/debug/.build-id/<replaceable>XX</replaceable>/<replaceable>YYYY…</replaceable></filename>, - where <replaceable>XXYYYY…</replaceable> is the <replaceable>build - ID</replaceable> of the binary — a SHA-1 hash of the contents of the - binary. Debuggers like GDB use the build ID to look up the separated - debug information. + If set to <literal>true</literal>, the standard environment will enable debug information in C/C++ builds. After installation, the debug information will be separated from the executables and stored in the output named <literal>debug</literal>. (This output is enabled automatically; you don’t need to set the <varname>outputs</varname> attribute explicitly.) To be precise, the debug information is stored in <filename><replaceable>debug</replaceable>/lib/debug/.build-id/<replaceable>XX</replaceable>/<replaceable>YYYY…</replaceable></filename>, where <replaceable>XXYYYY…</replaceable> is the <replaceable>build ID</replaceable> of the binary — a SHA-1 hash of the contents of the binary. Debuggers like GDB use the build ID to look up the separated debug information. </para> <para> For example, with GDB, you can add <programlisting> set debug-file-directory ~/.nix-profile/lib/debug </programlisting> - to <filename>~/.gdbinit</filename>. GDB will then be able to find debug - information installed via <literal>nix-env -i</literal>. + to <filename>~/.gdbinit</filename>. GDB will then be able to find debug information installed via <literal>nix-env -i</literal>. </para> </listitem> </varlistentry> @@ -1822,10 +1394,7 @@ set debug-file-directory ~/.nix-profile/lib/debug <title>The installCheck phase</title> <para> - The installCheck phase checks whether the package was installed correctly - by running its test suite against the installed directories. The default - <function>installCheck</function> calls <command>make - installcheck</command>. + The installCheck phase checks whether the package was installed correctly by running its test suite against the installed directories. The default <function>installCheck</function> calls <command>make installcheck</command>. </para> <variablelist> @@ -1836,14 +1405,9 @@ set debug-file-directory ~/.nix-profile/lib/debug </term> <listitem> <para> - Controls whether the installCheck phase is executed. By default it is - skipped, but if <varname>doInstallCheck</varname> is set to true, the - installCheck phase is usually executed. Thus you should set + Controls whether the installCheck phase is executed. By default it is skipped, but if <varname>doInstallCheck</varname> is set to true, the installCheck phase is usually executed. Thus you should set <programlisting>doInstallCheck = true;</programlisting> - in the derivation to enable install checks. The exception is cross - compilation. Cross compiled builds never run tests, no matter how - <varname>doInstallCheck</varname> is set, as the newly-built program - won't run on the platform used to build it. + in the derivation to enable install checks. The exception is cross compilation. Cross compiled builds never run tests, no matter how <varname>doInstallCheck</varname> is set, as the newly-built program won't run on the platform used to build it. </para> </listitem> </varlistentry> @@ -1853,8 +1417,7 @@ set debug-file-directory ~/.nix-profile/lib/debug </term> <listitem> <para> - The make target that runs the install tests. Defaults to - <literal>installcheck</literal>. + The make target that runs the install tests. Defaults to <literal>installcheck</literal>. </para> </listitem> </varlistentry> @@ -1864,9 +1427,7 @@ set debug-file-directory ~/.nix-profile/lib/debug </term> <listitem> <para> - A list of strings passed as additional flags to <command>make</command>. - Like <varname>makeFlags</varname> and <varname>makeFlagsArray</varname>, - but only used by the installCheck phase. + A list of strings passed as additional flags to <command>make</command>. Like <varname>makeFlags</varname> and <varname>makeFlagsArray</varname>, but only used by the installCheck phase. </para> </listitem> </varlistentry> @@ -1876,9 +1437,7 @@ set debug-file-directory ~/.nix-profile/lib/debug </term> <listitem> <para> - A list of dependencies used by the phase. This gets included in - <varname>nativeBuildInputs</varname> when - <varname>doInstallCheck</varname> is set. + A list of dependencies used by the phase. This gets included in <varname>nativeBuildInputs</varname> when <varname>doInstallCheck</varname> is set. </para> </listitem> </varlistentry> @@ -1909,11 +1468,7 @@ set debug-file-directory ~/.nix-profile/lib/debug <title>The distribution phase</title> <para> - The distribution phase is intended to produce a source distribution of the - package. The default <function>distPhase</function> first calls - <command>make dist</command>, then it copies the resulting source tarballs - to <filename>$out/tarballs/</filename>. This phase is only executed if the - attribute <varname>doDist</varname> is set. + The distribution phase is intended to produce a source distribution of the package. The default <function>distPhase</function> first calls <command>make dist</command>, then it copies the resulting source tarballs to <filename>$out/tarballs/</filename>. This phase is only executed if the attribute <varname>doDist</varname> is set. </para> <variablelist> @@ -1924,8 +1479,7 @@ set debug-file-directory ~/.nix-profile/lib/debug </term> <listitem> <para> - The make target that produces the distribution. Defaults to - <literal>dist</literal>. + The make target that produces the distribution. Defaults to <literal>dist</literal>. </para> </listitem> </varlistentry> @@ -1945,9 +1499,7 @@ set debug-file-directory ~/.nix-profile/lib/debug </term> <listitem> <para> - The names of the source distribution files to be copied to - <filename>$out/tarballs/</filename>. It can contain shell wildcards. The - default is <filename>*.tar.gz</filename>. + The names of the source distribution files to be copied to <filename>$out/tarballs/</filename>. It can contain shell wildcards. The default is <filename>*.tar.gz</filename>. </para> </listitem> </varlistentry> @@ -1998,8 +1550,7 @@ set debug-file-directory ~/.nix-profile/lib/debug </term> <listitem> <para> - Constructs a wrapper for a program with various possible arguments. For - example: + Constructs a wrapper for a program with various possible arguments. For example: <programlisting> # adds `FOOBAR=baz` to `$out/bin/foo`’s environment makeWrapper $out/bin/foo $wrapperfile --set FOOBAR baz @@ -2009,12 +1560,10 @@ makeWrapper $out/bin/foo $wrapperfile --set FOOBAR baz # (via string replacements or in `configurePhase`). makeWrapper $out/bin/foo $wrapperfile --prefix PATH : ${lib.makeBinPath [ hello git ]} </programlisting> - There’s many more kinds of arguments, they are documented in - <literal>nixpkgs/pkgs/build-support/setup-hooks/make-wrapper.sh</literal>. + There’s many more kinds of arguments, they are documented in <literal>nixpkgs/pkgs/build-support/setup-hooks/make-wrapper.sh</literal>. </para> <para> - <literal>wrapProgram</literal> is a convenience function you probably - want to use most of the time. + <literal>wrapProgram</literal> is a convenience function you probably want to use most of the time. </para> </listitem> </varlistentry> @@ -2024,10 +1573,7 @@ makeWrapper $out/bin/foo $wrapperfile --prefix PATH : ${lib.makeBinPath [ hello </term> <listitem> <para> - Performs string substitution on the contents of - <replaceable>infile</replaceable>, writing the result to - <replaceable>outfile</replaceable>. The substitutions in - <replaceable>subs</replaceable> are of the following form: + Performs string substitution on the contents of <replaceable>infile</replaceable>, writing the result to <replaceable>outfile</replaceable>. The substitutions in <replaceable>subs</replaceable> are of the following form: <variablelist> <varlistentry> <term> @@ -2035,8 +1581,7 @@ makeWrapper $out/bin/foo $wrapperfile --prefix PATH : ${lib.makeBinPath [ hello </term> <listitem> <para> - Replace every occurrence of the string <replaceable>s1</replaceable> - by <replaceable>s2</replaceable>. + Replace every occurrence of the string <replaceable>s1</replaceable> by <replaceable>s2</replaceable>. </para> </listitem> </varlistentry> @@ -2046,13 +1591,7 @@ makeWrapper $out/bin/foo $wrapperfile --prefix PATH : ${lib.makeBinPath [ hello </term> <listitem> <para> - Replace every occurrence of - <literal>@<replaceable>varName</replaceable>@</literal> by the - contents of the environment variable - <replaceable>varName</replaceable>. This is useful for generating - files from templates, using - <literal>@<replaceable>...</replaceable>@</literal> in the template - as placeholders. + Replace every occurrence of <literal>@<replaceable>varName</replaceable>@</literal> by the contents of the environment variable <replaceable>varName</replaceable>. This is useful for generating files from templates, using <literal>@<replaceable>...</replaceable>@</literal> in the template as placeholders. </para> </listitem> </varlistentry> @@ -2062,9 +1601,7 @@ makeWrapper $out/bin/foo $wrapperfile --prefix PATH : ${lib.makeBinPath [ hello </term> <listitem> <para> - Replace every occurrence of - <literal>@<replaceable>varName</replaceable>@</literal> by the string - <replaceable>s</replaceable>. + Replace every occurrence of <literal>@<replaceable>varName</replaceable>@</literal> by the string <replaceable>s</replaceable>. </para> </listitem> </varlistentry> @@ -2080,14 +1617,8 @@ substitute ./foo.in ./foo.out \ </programlisting> </para> <para> - <function>substitute</function> is implemented using the - <command - xlink:href="http://replace.richardlloyd.org.uk/">replace</command> - command. Unlike with the <command>sed</command> command, you don’t have - to worry about escaping special characters. It supports performing - substitutions on binary files (such as executables), though there - you’ll probably want to make sure that the replacement string is as - long as the replaced string. + <function>substitute</function> is implemented using the <command + xlink:href="http://replace.richardlloyd.org.uk/">replace</command> command. Unlike with the <command>sed</command> command, you don’t have to worry about escaping special characters. It supports performing substitutions on binary files (such as executables), though there you’ll probably want to make sure that the replacement string is as long as the replaced string. </para> </listitem> </varlistentry> @@ -2097,8 +1628,7 @@ substitute ./foo.in ./foo.out \ </term> <listitem> <para> - Like <function>substitute</function>, but performs the substitutions in - place on the file <replaceable>file</replaceable>. + Like <function>substitute</function>, but performs the substitutions in place on the file <replaceable>file</replaceable>. </para> </listitem> </varlistentry> @@ -2108,22 +1638,13 @@ substitute ./foo.in ./foo.out \ </term> <listitem> <para> - Replaces every occurrence of - <literal>@<replaceable>varName</replaceable>@</literal>, where - <replaceable>varName</replaceable> is any environment variable, in - <replaceable>infile</replaceable>, writing the result to - <replaceable>outfile</replaceable>. For instance, if - <replaceable>infile</replaceable> has the contents + Replaces every occurrence of <literal>@<replaceable>varName</replaceable>@</literal>, where <replaceable>varName</replaceable> is any environment variable, in <replaceable>infile</replaceable>, writing the result to <replaceable>outfile</replaceable>. For instance, if <replaceable>infile</replaceable> has the contents <programlisting> #! @bash@/bin/sh PATH=@coreutils@/bin echo @foo@ </programlisting> - and the environment contains - <literal>bash=/nix/store/bmwp0q28cf21...-bash-3.2-p39</literal> and - <literal>coreutils=/nix/store/68afga4khv0w...-coreutils-6.12</literal>, - but does not contain the variable <varname>foo</varname>, then the output - will be + and the environment contains <literal>bash=/nix/store/bmwp0q28cf21...-bash-3.2-p39</literal> and <literal>coreutils=/nix/store/68afga4khv0w...-coreutils-6.12</literal>, but does not contain the variable <varname>foo</varname>, then the output will be <programlisting> #! /nix/store/bmwp0q28cf21...-bash-3.2-p39/bin/sh PATH=/nix/store/68afga4khv0w...-coreutils-6.12/bin @@ -2132,13 +1653,7 @@ echo @foo@ That is, no substitution is performed for undefined variables. </para> <para> - Environment variables that start with an uppercase letter or an - underscore are filtered out, to prevent global variables (like - <literal>HOME</literal>) or private variables (like - <literal>__ETC_PROFILE_DONE</literal>) from accidentally getting - substituted. The variables also have to be valid bash “names”, as - defined in the bash manpage (alphanumeric or <literal>_</literal>, must - not start with a number). + Environment variables that start with an uppercase letter or an underscore are filtered out, to prevent global variables (like <literal>HOME</literal>) or private variables (like <literal>__ETC_PROFILE_DONE</literal>) from accidentally getting substituted. The variables also have to be valid bash “names”, as defined in the bash manpage (alphanumeric or <literal>_</literal>, must not start with a number). </para> </listitem> </varlistentry> @@ -2148,8 +1663,7 @@ echo @foo@ </term> <listitem> <para> - Like <function>substituteAll</function>, but performs the substitutions - in place on the file <replaceable>file</replaceable>. + Like <function>substituteAll</function>, but performs the substitutions in place on the file <replaceable>file</replaceable>. </para> </listitem> </varlistentry> @@ -2159,14 +1673,12 @@ echo @foo@ </term> <listitem> <para> - Strips the directory and hash part of a store path, outputting the name - part to <literal>stdout</literal>. For example: + Strips the directory and hash part of a store path, outputting the name part to <literal>stdout</literal>. For example: <programlisting> # prints coreutils-8.24 stripHash "/nix/store/9s9r019176g7cvn2nvcw41gsp862y6b4-coreutils-8.24" </programlisting> - If you wish to store the result in another variable, then the following - idiom may be useful: + If you wish to store the result in another variable, then the following idiom may be useful: <programlisting> name="/nix/store/9s9r019176g7cvn2nvcw41gsp862y6b4-coreutils-8.24" someVar=$(stripHash $name) @@ -2180,13 +1692,10 @@ someVar=$(stripHash $name) </term> <listitem> <para> - Convenience function for <literal>makeWrapper</literal> that - automatically creates a sane wrapper file It takes all the same arguments - as <literal>makeWrapper</literal>, except for <literal>--argv0</literal>. + Convenience function for <literal>makeWrapper</literal> that automatically creates a sane wrapper file It takes all the same arguments as <literal>makeWrapper</literal>, except for <literal>--argv0</literal>. </para> <para> - It cannot be applied multiple times, since it will overwrite the wrapper - file. + It cannot be applied multiple times, since it will overwrite the wrapper file. </para> </listitem> </varlistentry> @@ -2196,85 +1705,34 @@ someVar=$(stripHash $name) <title>Package setup hooks</title> <para> - Nix itself considers a build-time dependency as merely something that should - previously be built and accessible at build time—packages themselves are - on their own to perform any additional setup. In most cases, that is fine, - and the downstream derivation can deal with its own dependencies. But for a - few common tasks, that would result in almost every package doing the same - sort of setup work—depending not on the package itself, but entirely on - which dependencies were used. + Nix itself considers a build-time dependency as merely something that should previously be built and accessible at build time—packages themselves are on their own to perform any additional setup. In most cases, that is fine, and the downstream derivation can deal with its own dependencies. But for a few common tasks, that would result in almost every package doing the same sort of setup work—depending not on the package itself, but entirely on which dependencies were used. </para> <para> - In order to alleviate this burden, the <firstterm>setup hook</firstterm> - mechanism was written, where any package can include a shell script that [by - convention rather than enforcement by Nix], any downstream - reverse-dependency will source as part of its build process. That allows the - downstream dependency to merely specify its dependencies, and lets those - dependencies effectively initialize themselves. No boilerplate mirroring the - list of dependencies is needed. + In order to alleviate this burden, the <firstterm>setup hook</firstterm> mechanism was written, where any package can include a shell script that [by convention rather than enforcement by Nix], any downstream reverse-dependency will source as part of its build process. That allows the downstream dependency to merely specify its dependencies, and lets those dependencies effectively initialize themselves. No boilerplate mirroring the list of dependencies is needed. </para> <para> - The setup hook mechanism is a bit of a sledgehammer though: a powerful - feature with a broad and indiscriminate area of effect. The combination of - its power and implicit use may be expedient, but isn't without costs. Nix - itself is unchanged, but the spirit of added dependencies being effect-free - is violated even if the letter isn't. For example, if a derivation path is - mentioned more than once, Nix itself doesn't care and simply makes sure the - dependency derivation is already built just the same—depending is just - needing something to exist, and needing is idempotent. However, a dependency - specified twice will have its setup hook run twice, and that could easily - change the build environment (though a well-written setup hook will - therefore strive to be idempotent so this is in fact not observable). More - broadly, setup hooks are anti-modular in that multiple dependencies, whether - the same or different, should not interfere and yet their setup hooks may - well do so. + The setup hook mechanism is a bit of a sledgehammer though: a powerful feature with a broad and indiscriminate area of effect. The combination of its power and implicit use may be expedient, but isn't without costs. Nix itself is unchanged, but the spirit of added dependencies being effect-free is violated even if the letter isn't. For example, if a derivation path is mentioned more than once, Nix itself doesn't care and simply makes sure the dependency derivation is already built just the same—depending is just needing something to exist, and needing is idempotent. However, a dependency specified twice will have its setup hook run twice, and that could easily change the build environment (though a well-written setup hook will therefore strive to be idempotent so this is in fact not observable). More broadly, setup hooks are anti-modular in that multiple dependencies, whether the same or different, should not interfere and yet their setup hooks may well do so. </para> <para> - The most typical use of the setup hook is actually to add other hooks which - are then run (i.e. after all the setup hooks) on each dependency. For - example, the C compiler wrapper's setup hook feeds itself flags for each - dependency that contains relevant libraries and headers. This is done by - defining a bash function, and appending its name to one of - <envar>envBuildBuildHooks</envar>`, <envar>envBuildHostHooks</envar>`, - <envar>envBuildTargetHooks</envar>`, <envar>envHostHostHooks</envar>`, - <envar>envHostTargetHooks</envar>`, or <envar>envTargetTargetHooks</envar>`. - These 6 bash variables correspond to the 6 sorts of dependencies by platform - (there's 12 total but we ignore the propagated/non-propagated axis). + The most typical use of the setup hook is actually to add other hooks which are then run (i.e. after all the setup hooks) on each dependency. For example, the C compiler wrapper's setup hook feeds itself flags for each dependency that contains relevant libraries and headers. This is done by defining a bash function, and appending its name to one of <envar>envBuildBuildHooks</envar>`, <envar>envBuildHostHooks</envar>`, <envar>envBuildTargetHooks</envar>`, <envar>envHostHostHooks</envar>`, <envar>envHostTargetHooks</envar>`, or <envar>envTargetTargetHooks</envar>`. These 6 bash variables correspond to the 6 sorts of dependencies by platform (there's 12 total but we ignore the propagated/non-propagated axis). </para> <para> - Packages adding a hook should not hard code a specific hook, but rather - choose a variable <emphasis>relative</emphasis> to how they are included. - Returning to the C compiler wrapper example, if the wrapper itself is an - <literal>n</literal> dependency, then it only wants to accumulate flags from - <literal>n + 1</literal> dependencies, as only those ones match the - compiler's target platform. The <envar>hostOffset</envar> variable is - defined with the current dependency's host offset - <envar>targetOffset</envar> with its target offset, before its setup hook is - sourced. Additionally, since most environment hooks don't care about the - target platform, that means the setup hook can append to the right bash - array by doing something like + Packages adding a hook should not hard code a specific hook, but rather choose a variable <emphasis>relative</emphasis> to how they are included. Returning to the C compiler wrapper example, if the wrapper itself is an <literal>n</literal> dependency, then it only wants to accumulate flags from <literal>n + 1</literal> dependencies, as only those ones match the compiler's target platform. The <envar>hostOffset</envar> variable is defined with the current dependency's host offset <envar>targetOffset</envar> with its target offset, before its setup hook is sourced. Additionally, since most environment hooks don't care about the target platform, that means the setup hook can append to the right bash array by doing something like <programlisting language="bash"> addEnvHooks "$hostOffset" myBashFunction </programlisting> </para> <para> - The <emphasis>existence</emphasis> of setups hooks has long been documented - and packages inside Nixpkgs are free to use this mechanism. Other packages, - however, should not rely on these mechanisms not changing between Nixpkgs - versions. Because of the existing issues with this system, there's little - benefit from mandating it be stable for any period of time. + The <emphasis>existence</emphasis> of setups hooks has long been documented and packages inside Nixpkgs are free to use this mechanism. Other packages, however, should not rely on these mechanisms not changing between Nixpkgs versions. Because of the existing issues with this system, there's little benefit from mandating it be stable for any period of time. </para> <para> - First, let’s cover some setup hooks that are part of Nixpkgs default - stdenv. This means that they are run for every package built using - <function>stdenv.mkDerivation</function>. Some of these are platform - specific, so they may run on Linux but not Darwin or vice-versa. + First, let’s cover some setup hooks that are part of Nixpkgs default stdenv. This means that they are run for every package built using <function>stdenv.mkDerivation</function>. Some of these are platform specific, so they may run on Linux but not Darwin or vice-versa. <variablelist> <varlistentry> <term> @@ -2282,10 +1740,7 @@ addEnvHooks "$hostOffset" myBashFunction </term> <listitem> <para> - This setup hook moves any installed documentation to the - <literal>/share</literal> subdirectory directory. This includes the man, - doc and info directories. This is needed for legacy programs that do not - know how to use the <literal>share</literal> subdirectory. + This setup hook moves any installed documentation to the <literal>/share</literal> subdirectory directory. This includes the man, doc and info directories. This is needed for legacy programs that do not know how to use the <literal>share</literal> subdirectory. </para> </listitem> </varlistentry> @@ -2295,9 +1750,7 @@ addEnvHooks "$hostOffset" myBashFunction </term> <listitem> <para> - This setup hook compresses any man pages that have been installed. The - compression is done using the gzip program. This helps to reduce the - installed size of packages. + This setup hook compresses any man pages that have been installed. The compression is done using the gzip program. This helps to reduce the installed size of packages. </para> </listitem> </varlistentry> @@ -2307,9 +1760,7 @@ addEnvHooks "$hostOffset" myBashFunction </term> <listitem> <para> - This runs the strip command on installed binaries and libraries. This - removes unnecessary information like debug symbols when they are not - needed. This also helps to reduce the installed size of packages. + This runs the strip command on installed binaries and libraries. This removes unnecessary information like debug symbols when they are not needed. This also helps to reduce the installed size of packages. </para> </listitem> </varlistentry> @@ -2319,12 +1770,7 @@ addEnvHooks "$hostOffset" myBashFunction </term> <listitem> <para> - This setup hook patches installed scripts to use the full path to the - shebang interpreter. A shebang interpreter is the first commented line - of a script telling the operating system which program will run the - script (e.g <literal>#!/bin/bash</literal>). In Nix, we want an exact - path to that interpreter to be used. This often replaces - <literal>/bin/sh</literal> with a path in the Nix store. + This setup hook patches installed scripts to use the full path to the shebang interpreter. A shebang interpreter is the first commented line of a script telling the operating system which program will run the script (e.g <literal>#!/bin/bash</literal>). In Nix, we want an exact path to that interpreter to be used. This often replaces <literal>/bin/sh</literal> with a path in the Nix store. </para> </listitem> </varlistentry> @@ -2334,10 +1780,7 @@ addEnvHooks "$hostOffset" myBashFunction </term> <listitem> <para> - This verifies that no references are left from the install binaries to - the directory used to build those binaries. This ensures that the - binaries do not need things outside the Nix store. This is currently - supported in Linux only. + This verifies that no references are left from the install binaries to the directory used to build those binaries. This ensures that the binaries do not need things outside the Nix store. This is currently supported in Linux only. </para> </listitem> </varlistentry> @@ -2347,12 +1790,7 @@ addEnvHooks "$hostOffset" myBashFunction </term> <listitem> <para> - This setup hook adds configure flags that tell packages to install files - into any one of the proper outputs listed in <literal>outputs</literal>. - This behavior can be turned off by setting - <literal>setOutputFlags</literal> to false in the derivation - environment. See <xref linkend="chap-multiple-output"/> for more - information. + This setup hook adds configure flags that tell packages to install files into any one of the proper outputs listed in <literal>outputs</literal>. This behavior can be turned off by setting <literal>setOutputFlags</literal> to false in the derivation environment. See <xref linkend="chap-multiple-output"/> for more information. </para> </listitem> </varlistentry> @@ -2362,9 +1800,7 @@ addEnvHooks "$hostOffset" myBashFunction </term> <listitem> <para> - This setup hook moves any binaries installed in the sbin subdirectory - into bin. In addition, a link is provided from sbin to bin for - compatibility. + This setup hook moves any binaries installed in the sbin subdirectory into bin. In addition, a link is provided from sbin to bin for compatibility. </para> </listitem> </varlistentry> @@ -2374,9 +1810,7 @@ addEnvHooks "$hostOffset" myBashFunction </term> <listitem> <para> - This setup hook moves any libraries installed in the lib64 subdirectory - into lib. In addition, a link is provided from lib64 to lib for - compatibility. + This setup hook moves any libraries installed in the lib64 subdirectory into lib. In addition, a link is provided from lib64 to lib for compatibility. </para> </listitem> </varlistentry> @@ -2386,8 +1820,7 @@ addEnvHooks "$hostOffset" myBashFunction </term> <listitem> <para> - This sets <literal>SOURCE_DATE_EPOCH</literal> to the modification time - of the most recent file. + This sets <literal>SOURCE_DATE_EPOCH</literal> to the modification time of the most recent file. </para> </listitem> </varlistentry> @@ -2397,70 +1830,22 @@ addEnvHooks "$hostOffset" myBashFunction </term> <listitem> <para> - The Bintools Wrapper wraps the binary utilities for a bunch of - miscellaneous purposes. These are GNU Binutils when targetting Linux, - and a mix of cctools and GNU binutils for Darwin. [The "Bintools" name - is supposed to be a compromise between "Binutils" and "cctools" not - denoting any specific implementation.] Specifically, the underlying - bintools package, and a C standard library (glibc or Darwin's libSystem, - just for the dynamic loader) are all fed in, and dependency finding, - hardening (see below), and purity checks for each are handled by the - Bintools Wrapper. Packages typically depend on CC Wrapper, which in turn - (at run time) depends on the Bintools Wrapper. - </para> - <para> - The Bintools Wrapper was only just recently split off from CC Wrapper, - so the division of labor is still being worked out. For example, it - shouldn't care about about the C standard library, but just take a - derivation with the dynamic loader (which happens to be the glibc on - linux). Dependency finding however is a task both wrappers will continue - to need to share, and probably the most important to understand. It is - currently accomplished by collecting directories of host-platform - dependencies (i.e. <varname>buildInputs</varname> and - <varname>nativeBuildInputs</varname>) in environment variables. The - Bintools Wrapper's setup hook causes any <filename>lib</filename> and - <filename>lib64</filename> subdirectories to be added to - <envar>NIX_LDFLAGS</envar>. Since the CC Wrapper and the Bintools - Wrapper use the same strategy, most of the Bintools Wrapper code is - sparsely commented and refers to the CC Wrapper. But the CC Wrapper's - code, by contrast, has quite lengthy comments. The Bintools Wrapper - merely cites those, rather than repeating them, to avoid falling out of - sync. - </para> - <para> - A final task of the setup hook is defining a number of standard - environment variables to tell build systems which executables fulfill - which purpose. They are defined to just be the base name of the tools, - under the assumption that the Bintools Wrapper's binaries will be on the - path. Firstly, this helps poorly-written packages, e.g. ones that look - for just <command>gcc</command> when <envar>CC</envar> isn't defined yet - <command>clang</command> is to be used. Secondly, this helps packages - not get confused when cross-compiling, in which case multiple Bintools - Wrappers may simultaneously be in use. + The Bintools Wrapper wraps the binary utilities for a bunch of miscellaneous purposes. These are GNU Binutils when targetting Linux, and a mix of cctools and GNU binutils for Darwin. [The "Bintools" name is supposed to be a compromise between "Binutils" and "cctools" not denoting any specific implementation.] Specifically, the underlying bintools package, and a C standard library (glibc or Darwin's libSystem, just for the dynamic loader) are all fed in, and dependency finding, hardening (see below), and purity checks for each are handled by the Bintools Wrapper. Packages typically depend on CC Wrapper, which in turn (at run time) depends on the Bintools Wrapper. + </para> + <para> + The Bintools Wrapper was only just recently split off from CC Wrapper, so the division of labor is still being worked out. For example, it shouldn't care about the C standard library, but just take a derivation with the dynamic loader (which happens to be the glibc on linux). Dependency finding however is a task both wrappers will continue to need to share, and probably the most important to understand. It is currently accomplished by collecting directories of host-platform dependencies (i.e. <varname>buildInputs</varname> and <varname>nativeBuildInputs</varname>) in environment variables. The Bintools Wrapper's setup hook causes any <filename>lib</filename> and <filename>lib64</filename> subdirectories to be added to <envar>NIX_LDFLAGS</envar>. Since the CC Wrapper and the Bintools Wrapper use the same strategy, most of the Bintools Wrapper code is sparsely commented and refers to the CC Wrapper. But the CC Wrapper's code, by contrast, has quite lengthy comments. The Bintools Wrapper merely cites those, rather than repeating them, to avoid falling out of sync. + </para> + <para> + A final task of the setup hook is defining a number of standard environment variables to tell build systems which executables fulfill which purpose. They are defined to just be the base name of the tools, under the assumption that the Bintools Wrapper's binaries will be on the path. Firstly, this helps poorly-written packages, e.g. ones that look for just <command>gcc</command> when <envar>CC</envar> isn't defined yet <command>clang</command> is to be used. Secondly, this helps packages not get confused when cross-compiling, in which case multiple Bintools Wrappers may simultaneously be in use. <footnote xml:id="footnote-stdenv-per-platform-wrapper"> <para> - Each wrapper targets a single platform, so if binaries for multiple - platforms are needed, the underlying binaries must be wrapped multiple - times. As this is a property of the wrapper itself, the multiple - wrappings are needed whether or not the same underlying binaries can - target multiple platforms. + Each wrapper targets a single platform, so if binaries for multiple platforms are needed, the underlying binaries must be wrapped multiple times. As this is a property of the wrapper itself, the multiple wrappings are needed whether or not the same underlying binaries can target multiple platforms. </para> </footnote> - <envar>BUILD_</envar>- and <envar>TARGET_</envar>-prefixed versions of - the normal environment variable are defined for additional Bintools - Wrappers, properly disambiguating them. + <envar>BUILD_</envar>- and <envar>TARGET_</envar>-prefixed versions of the normal environment variable are defined for additional Bintools Wrappers, properly disambiguating them. </para> <para> - A problem with this final task is that the Bintools Wrapper is honest - and defines <envar>LD</envar> as <command>ld</command>. Most packages, - however, firstly use the C compiler for linking, secondly use - <envar>LD</envar> anyways, defining it as the C compiler, and thirdly, - only so define <envar>LD</envar> when it is undefined as a fallback. - This triple-threat means Bintools Wrapper will break those packages, as - LD is already defined as the actual linker which the package won't - override yet doesn't want to use. The workaround is to define, just for - the problematic package, <envar>LD</envar> as the C compiler. A good way - to do this would be <command>preConfigure = "LD=$CC"</command>. + A problem with this final task is that the Bintools Wrapper is honest and defines <envar>LD</envar> as <command>ld</command>. Most packages, however, firstly use the C compiler for linking, secondly use <envar>LD</envar> anyways, defining it as the C compiler, and thirdly, only so define <envar>LD</envar> when it is undefined as a fallback. This triple-threat means Bintools Wrapper will break those packages, as LD is already defined as the actual linker which the package won't override yet doesn't want to use. The workaround is to define, just for the problematic package, <envar>LD</envar> as the C compiler. A good way to do this would be <command>preConfigure = "LD=$CC"</command>. </para> </listitem> </varlistentry> @@ -2470,31 +1855,13 @@ addEnvHooks "$hostOffset" myBashFunction </term> <listitem> <para> - The CC Wrapper wraps a C toolchain for a bunch of miscellaneous - purposes. Specifically, a C compiler (GCC or Clang), wrapped binary - tools, and a C standard library (glibc or Darwin's libSystem, just for - the dynamic loader) are all fed in, and dependency finding, hardening - (see below), and purity checks for each are handled by the CC Wrapper. - Packages typically depend on the CC Wrapper, which in turn (at run-time) - depends on the Bintools Wrapper. + The CC Wrapper wraps a C toolchain for a bunch of miscellaneous purposes. Specifically, a C compiler (GCC or Clang), wrapped binary tools, and a C standard library (glibc or Darwin's libSystem, just for the dynamic loader) are all fed in, and dependency finding, hardening (see below), and purity checks for each are handled by the CC Wrapper. Packages typically depend on the CC Wrapper, which in turn (at run-time) depends on the Bintools Wrapper. </para> <para> - Dependency finding is undoubtedly the main task of the CC Wrapper. This - works just like the Bintools Wrapper, except that any - <filename>include</filename> subdirectory of any relevant dependency is - added to <envar>NIX_CFLAGS_COMPILE</envar>. The setup hook itself - contains some lengthy comments describing the exact convoluted mechanism - by which this is accomplished. + Dependency finding is undoubtedly the main task of the CC Wrapper. This works just like the Bintools Wrapper, except that any <filename>include</filename> subdirectory of any relevant dependency is added to <envar>NIX_CFLAGS_COMPILE</envar>. The setup hook itself contains some lengthy comments describing the exact convoluted mechanism by which this is accomplished. </para> <para> - Similarly, the CC Wrapper follows the Bintools Wrapper in defining - standard environment variables with the names of the tools it wraps, for - the same reasons described above. Importantly, while it includes a - <command>cc</command> symlink to the c compiler for portability, the - <envar>CC</envar> will be defined using the compiler's "real name" (i.e. - <command>gcc</command> or <command>clang</command>). This helps lousy - build systems that inspect on the name of the compiler rather than run - it. + Similarly, the CC Wrapper follows the Bintools Wrapper in defining standard environment variables with the names of the tools it wraps, for the same reasons described above. Importantly, while it includes a <command>cc</command> symlink to the c compiler for portability, the <envar>CC</envar> will be defined using the compiler's "real name" (i.e. <command>gcc</command> or <command>clang</command>). This helps lousy build systems that inspect on the name of the compiler rather than run it. </para> </listitem> </varlistentry> @@ -2502,9 +1869,7 @@ addEnvHooks "$hostOffset" myBashFunction </para> <para> - Here are some more packages that provide a setup hook. Since the list of - hooks is extensible, this is not an exhaustive list the mechanism is only to - be used as a last resort, it might cover most uses. + Here are some more packages that provide a setup hook. Since the list of hooks is extensible, this is not an exhaustive list the mechanism is only to be used as a last resort, it might cover most uses. <variablelist> <varlistentry> <term> @@ -2512,11 +1877,7 @@ addEnvHooks "$hostOffset" myBashFunction </term> <listitem> <para> - Adds the <filename>lib/site_perl</filename> subdirectory of each build - input to the <envar>PERL5LIB</envar> environment variable. For instance, - if <varname>buildInputs</varname> contains Perl, then the - <filename>lib/site_perl</filename> subdirectory of each input is added - to the <envar>PERL5LIB</envar> environment variable. + Adds the <filename>lib/site_perl</filename> subdirectory of each build input to the <envar>PERL5LIB</envar> environment variable. For instance, if <varname>buildInputs</varname> contains Perl, then the <filename>lib/site_perl</filename> subdirectory of each input is added to the <envar>PERL5LIB</envar> environment variable. </para> </listitem> </varlistentry> @@ -2526,9 +1887,7 @@ addEnvHooks "$hostOffset" myBashFunction </term> <listitem> <para> - Adds the <filename>lib/${python.libPrefix}/site-packages</filename> - subdirectory of each build input to the <envar>PYTHONPATH</envar> - environment variable. + Adds the <filename>lib/${python.libPrefix}/site-packages</filename> subdirectory of each build input to the <envar>PYTHONPATH</envar> environment variable. </para> </listitem> </varlistentry> @@ -2538,9 +1897,7 @@ addEnvHooks "$hostOffset" myBashFunction </term> <listitem> <para> - Adds the <filename>lib/pkgconfig</filename> and - <filename>share/pkgconfig</filename> subdirectories of each build input - to the <envar>PKG_CONFIG_PATH</envar> environment variable. + Adds the <filename>lib/pkgconfig</filename> and <filename>share/pkgconfig</filename> subdirectories of each build input to the <envar>PKG_CONFIG_PATH</envar> environment variable. </para> </listitem> </varlistentry> @@ -2550,8 +1907,7 @@ addEnvHooks "$hostOffset" myBashFunction </term> <listitem> <para> - Adds the <filename>share/aclocal</filename> subdirectory of each build - input to the <envar>ACLOCAL_PATH</envar> environment variable. + Adds the <filename>share/aclocal</filename> subdirectory of each build input to the <envar>ACLOCAL_PATH</envar> environment variable. </para> </listitem> </varlistentry> @@ -2561,12 +1917,7 @@ addEnvHooks "$hostOffset" myBashFunction </term> <listitem> <para> - The <varname>autoreconfHook</varname> derivation adds - <varname>autoreconfPhase</varname>, which runs autoreconf, libtoolize - and automake, essentially preparing the configure script in - autotools-based builds. Most autotools-based packages come with the - configure script pre-generated, but this hook is necessary for a few - packages and when you need to patch the package’s configure scripts. + The <varname>autoreconfHook</varname> derivation adds <varname>autoreconfPhase</varname>, which runs autoreconf, libtoolize and automake, essentially preparing the configure script in autotools-based builds. Most autotools-based packages come with the configure script pre-generated, but this hook is necessary for a few packages and when you need to patch the package’s configure scripts. </para> </listitem> </varlistentry> @@ -2576,10 +1927,7 @@ addEnvHooks "$hostOffset" myBashFunction </term> <listitem> <para> - Adds every file named <filename>catalog.xml</filename> found under the - <filename>xml/dtd</filename> and <filename>xml/xsl</filename> - subdirectories of each build input to the - <envar>XML_CATALOG_FILES</envar> environment variable. + Adds every file named <filename>catalog.xml</filename> found under the <filename>xml/dtd</filename> and <filename>xml/xsl</filename> subdirectories of each build input to the <envar>XML_CATALOG_FILES</envar> environment variable. </para> </listitem> </varlistentry> @@ -2589,8 +1937,7 @@ addEnvHooks "$hostOffset" myBashFunction </term> <listitem> <para> - Adds the <filename>share/texmf-nix</filename> subdirectory of each build - input to the <envar>TEXINPUTS</envar> environment variable. + Adds the <filename>share/texmf-nix</filename> subdirectory of each build input to the <envar>TEXINPUTS</envar> environment variable. </para> </listitem> </varlistentry> @@ -2610,9 +1957,7 @@ addEnvHooks "$hostOffset" myBashFunction </term> <listitem> <para> - Exports <envar>GDK_PIXBUF_MODULE_FILE</envar> environment variable to - the builder. Add librsvg package to <varname>buildInputs</varname> to - get svg support. + Exports <envar>GDK_PIXBUF_MODULE_FILE</envar> environment variable to the builder. Add librsvg package to <varname>buildInputs</varname> to get svg support. </para> </listitem> </varlistentry> @@ -2622,20 +1967,17 @@ addEnvHooks "$hostOffset" myBashFunction </term> <listitem> <para> - Creates a temporary package database and registers every Haskell build - input in it (TODO: how?). + Creates a temporary package database and registers every Haskell build input in it (TODO: how?). </para> </listitem> </varlistentry> <varlistentry> <term> - GStreamer + GNOME platform </term> <listitem> <para> - Adds the GStreamer plugins subdirectory of each build input to the - <envar>GST_PLUGIN_SYSTEM_PATH_1_0</envar> or - <envar>GST_PLUGIN_SYSTEM_PATH</envar> environment variable. + Hooks related to GNOME platform and related libraries like GLib, GTK and GStreamer are described in <xref linkend="sec-language-gnome" />. </para> </listitem> </varlistentry> @@ -2645,15 +1987,10 @@ addEnvHooks "$hostOffset" myBashFunction </term> <listitem> <para> - This is a special setup hook which helps in packaging proprietary - software in that it automatically tries to find missing shared library - dependencies of ELF files based on the given - <varname>buildInputs</varname> and <varname>nativeBuildInputs</varname>. + This is a special setup hook which helps in packaging proprietary software in that it automatically tries to find missing shared library dependencies of ELF files based on the given <varname>buildInputs</varname> and <varname>nativeBuildInputs</varname>. </para> <para> - You can also specify a <envar>runtimeDependencies</envar> environment - variable which lists dependencies that are unconditionally added to all - executables. + You can also specify a <envar>runtimeDependencies</envar> environment variable which lists dependencies that are unconditionally added to all executables. </para> <para> This is useful for programs that use <citerefentry> @@ -2661,16 +1998,10 @@ addEnvHooks "$hostOffset" myBashFunction <manvolnum>3</manvolnum> </citerefentry> to load libraries at runtime. </para> <para> - In certain situations you may want to run the main command - (<command>autoPatchelf</command>) of the setup hook on a file or a set - of directories instead of unconditionally patching all outputs. This can - be done by setting the <envar>dontAutoPatchelf</envar> environment - variable to a non-empty value. + In certain situations you may want to run the main command (<command>autoPatchelf</command>) of the setup hook on a file or a set of directories instead of unconditionally patching all outputs. This can be done by setting the <envar>dontAutoPatchelf</envar> environment variable to a non-empty value. </para> <para> - The <command>autoPatchelf</command> command also recognizes a - <parameter class="command">--no-recurse</parameter> command line flag, - which prevents it from recursing into subdirectories. + The <command>autoPatchelf</command> command also recognizes a <parameter class="command">--no-recurse</parameter> command line flag, which prevents it from recursing into subdirectories. </para> </listitem> </varlistentry> @@ -2680,36 +2011,16 @@ addEnvHooks "$hostOffset" myBashFunction </term> <listitem> <para> - This hook will make a build pause instead of stopping when a failure - happens. It prevents nix from cleaning up the build environment - immediately and allows the user to attach to a build environment using - the <command>cntr</command> command. Upon build error it will print - instructions on how to use <command>cntr</command>, which can be used to - enter the environment for debugging. Installing cntr and running the - command will provide shell access to the build sandbox of failed build. - At <filename>/var/lib/cntr</filename> the sandboxed filesystem is - mounted. All commands and files of the system are still accessible - within the shell. To execute commands from the sandbox use the cntr exec - subcommand. <command>cntr</command> is only supported - on Linux-based platforms. To use it first add <literal>cntr</literal> to - your <literal>environment.systemPackages</literal> on NixOS or - alternatively to the root user on non-NixOS systems. Then in the package - that is supposed to be inspected, add <literal>breakpointHook</literal> - to <literal>nativeBuildInputs</literal>. + This hook will make a build pause instead of stopping when a failure happens. It prevents nix from cleaning up the build environment immediately and allows the user to attach to a build environment using the <command>cntr</command> command. Upon build error it will print instructions on how to use <command>cntr</command>, which can be used to enter the environment for debugging. Installing cntr and running the command will provide shell access to the build sandbox of failed build. At <filename>/var/lib/cntr</filename> the sandboxed filesystem is mounted. All commands and files of the system are still accessible within the shell. To execute commands from the sandbox use the cntr exec subcommand. <command>cntr</command> is only supported on Linux-based platforms. To use it first add <literal>cntr</literal> to your <literal>environment.systemPackages</literal> on NixOS or alternatively to the root user on non-NixOS systems. Then in the package that is supposed to be inspected, add <literal>breakpointHook</literal> to <literal>nativeBuildInputs</literal>. <programlisting> nativeBuildInputs = [ breakpointHook ]; </programlisting> - When a build failure happens there will be an instruction printed that - shows how to attach with <literal>cntr</literal> to the build sandbox. + When a build failure happens there will be an instruction printed that shows how to attach with <literal>cntr</literal> to the build sandbox. </para> <note> <title>Caution with remote builds</title> <para> - This won't work with remote builds as the build environment is on - a different machine and can't be accessed by <command>cntr</command>. - Remote builds can be turned off by setting <literal>--option builders ''</literal> - for <command>nix-build</command> or <literal>--builders ''</literal> for - <command>nix build</command>. + This won't work with remote builds as the build environment is on a different machine and can't be accessed by <command>cntr</command>. Remote builds can be turned off by setting <literal>--option builders ''</literal> for <command>nix-build</command> or <literal>--builders ''</literal> for <command>nix build</command>. </para> </note> </listitem> @@ -2720,28 +2031,13 @@ nativeBuildInputs = [ breakpointHook ]; </term> <listitem> <para> - This hook helps with installing manpages and shell completion files. It - exposes 2 shell functions <literal>installManPage</literal> and - <literal>installShellCompletion</literal> that can be used from your - <literal>postInstall</literal> hook. + This hook helps with installing manpages and shell completion files. It exposes 2 shell functions <literal>installManPage</literal> and <literal>installShellCompletion</literal> that can be used from your <literal>postInstall</literal> hook. </para> <para> - The <literal>installManPage</literal> function takes one or more paths - to manpages to install. The manpages must have a section suffix, and may - optionally be compressed (with <literal>.gz</literal> suffix). This - function will place them into the correct directory. + The <literal>installManPage</literal> function takes one or more paths to manpages to install. The manpages must have a section suffix, and may optionally be compressed (with <literal>.gz</literal> suffix). This function will place them into the correct directory. </para> <para> - The <literal>installShellCompletion</literal> function takes one or more - paths to shell completion files. By default it will autodetect the shell - type from the completion file extension, but you may also specify it by - passing one of <literal>--bash</literal>, <literal>--fish</literal>, or - <literal>--zsh</literal>. These flags apply to all paths listed after - them (up until another shell flag is given). Each path may also have a - custom installation name provided by providing a flag <literal>--name - NAME</literal> before the path. If this flag is not provided, zsh - completions will be renamed automatically such that - <literal>foobar.zsh</literal> becomes <literal>_foobar</literal>. + The <literal>installShellCompletion</literal> function takes one or more paths to shell completion files. By default it will autodetect the shell type from the completion file extension, but you may also specify it by passing one of <literal>--bash</literal>, <literal>--fish</literal>, or <literal>--zsh</literal>. These flags apply to all paths listed after them (up until another shell flag is given). Each path may also have a custom installation name provided by providing a flag <literal>--name NAME</literal> before the path. If this flag is not provided, zsh completions will be renamed automatically such that <literal>foobar.zsh</literal> becomes <literal>_foobar</literal>. <programlisting> nativeBuildInputs = [ installShellFiles ]; postInstall = '' @@ -2763,13 +2059,7 @@ postInstall = '' </term> <listitem> <para> - A few libraries automatically add to <literal>NIX_LDFLAGS</literal> - their library, making their symbols automatically available to the - linker. This includes libiconv and libintl (gettext). This is done to - provide compatibility between GNU Linux, where libiconv and libintl are - bundled in, and other systems where that might not be the case. - Sometimes, this behavior is not desired. To disable this behavior, set - <literal>dontAddExtraLibs</literal>. + A few libraries automatically add to <literal>NIX_LDFLAGS</literal> their library, making their symbols automatically available to the linker. This includes libiconv and libintl (gettext). This is done to provide compatibility between GNU Linux, where libiconv and libintl are bundled in, and other systems where that might not be the case. Sometimes, this behavior is not desired. To disable this behavior, set <literal>dontAddExtraLibs</literal>. </para> </listitem> </varlistentry> @@ -2779,16 +2069,7 @@ postInstall = '' </term> <listitem> <para> - Overrides the default configure phase to run the CMake command. By - default, we use the Make generator of CMake. In addition, dependencies - are added automatically to CMAKE_PREFIX_PATH so that packages are - correctly detected by CMake. Some additional flags are passed in to give - similar behavior to configure-based packages. You can disable this - hook’s behavior by setting configurePhase to a custom value, or by - setting dontUseCmakeConfigure. cmakeFlags controls flags passed only to - CMake. By default, parallel building is enabled as CMake supports - parallel building almost everywhere. When Ninja is also in use, CMake - will detect that and use the ninja generator. + Overrides the default configure phase to run the CMake command. By default, we use the Make generator of CMake. In addition, dependencies are added automatically to CMAKE_PREFIX_PATH so that packages are correctly detected by CMake. Some additional flags are passed in to give similar behavior to configure-based packages. You can disable this hook’s behavior by setting configurePhase to a custom value, or by setting dontUseCmakeConfigure. cmakeFlags controls flags passed only to CMake. By default, parallel building is enabled as CMake supports parallel building almost everywhere. When Ninja is also in use, CMake will detect that and use the ninja generator. </para> </listitem> </varlistentry> @@ -2798,27 +2079,74 @@ postInstall = '' </term> <listitem> <para> - Overrides the build and install phases to run the “xcbuild” command. - This hook is needed when a project only comes with build files for the - XCode build system. You can disable this behavior by setting buildPhase - and configurePhase to a custom value. xcbuildFlags controls flags passed - only to xcbuild. + Overrides the build and install phases to run the “xcbuild” command. This hook is needed when a project only comes with build files for the XCode build system. You can disable this behavior by setting buildPhase and configurePhase to a custom value. xcbuildFlags controls flags passed only to xcbuild. </para> </listitem> </varlistentry> <varlistentry> <term> - meson + Meson </term> <listitem> <para> - Overrides the configure phase to run meson to generate Ninja files. You - can disable this behavior by setting configurePhase to a custom value, - or by setting dontUseMesonConfigure. To run these files, you should - accompany meson with ninja. mesonFlags controls only the flags passed to - meson. By default, parallel building is enabled as Meson supports - parallel building almost everywhere. + Overrides the configure phase to run meson to generate Ninja files. To run these files, you should accompany Meson with ninja. By default, <varname>enableParallelBuilding</varname> is enabled as Meson supports parallel building almost everywhere. </para> + <variablelist> + <title>Variables controlling Meson</title> + <varlistentry> + <term> + <varname>mesonFlags</varname> + </term> + <listitem> + <para> + Controls the flags passed to meson. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <varname>mesonBuildType</varname> + </term> + <listitem> + <para> + Which <link + xlink:href="https://mesonbuild.com/Builtin-options.html#core-options"><command>--buildtype</command></link> to pass to Meson. We default to <literal>plain</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <varname>mesonAutoFeatures</varname> + </term> + <listitem> + <para> + What value to set <link + xlink:href="https://mesonbuild.com/Builtin-options.html#core-options"><command>-Dauto_features=</command></link> to. We default to <command>enabled</command>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <varname>mesonWrapMode</varname> + </term> + <listitem> + <para> + What value to set <link + xlink:href="https://mesonbuild.com/Builtin-options.html#core-options"><command>-Dwrap_mode=</command></link> to. We default to <command>nodownload</command> as we disallow network access. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <varname>dontUseMesonConfigure</varname> + </term> + <listitem> + <para> + Disables using Meson's <varname>configurePhase</varname>. + </para> + </listitem> + </varlistentry> + </variablelist> </listitem> </varlistentry> <varlistentry> @@ -2827,10 +2155,7 @@ postInstall = '' </term> <listitem> <para> - Overrides the build, install, and check phase to run ninja instead of - make. You can disable this behavior with the dontUseNinjaBuild, - dontUseNinjaInstall, and dontUseNinjaCheck, respectively. Parallel - building is enabled by default in Ninja. + Overrides the build, install, and check phase to run ninja instead of make. You can disable this behavior with the dontUseNinjaBuild, dontUseNinjaInstall, and dontUseNinjaCheck, respectively. Parallel building is enabled by default in Ninja. </para> </listitem> </varlistentry> @@ -2840,8 +2165,7 @@ postInstall = '' </term> <listitem> <para> - This setup hook will allow you to unzip .zip files specified in $src. - There are many similar packages like unrar, undmg, etc. + This setup hook will allow you to unzip .zip files specified in $src. There are many similar packages like unrar, undmg, etc. </para> </listitem> </varlistentry> @@ -2851,10 +2175,7 @@ postInstall = '' </term> <listitem> <para> - Overrides the configure, build, and install phases. This will run the - "waf" script used by many projects. If wafPath (default ./waf) doesn’t - exist, it will copy the version of waf available in Nixpkgs. wafFlags can - be used to pass flags to the waf script. + Overrides the configure, build, and install phases. This will run the "waf" script used by many projects. If wafPath (default ./waf) doesn’t exist, it will copy the version of waf available in Nixpkgs. wafFlags can be used to pass flags to the waf script. </para> </listitem> </varlistentry> @@ -2864,9 +2185,7 @@ postInstall = '' </term> <listitem> <para> - Overrides the build, install, and check phases. This uses the scons - build system as a replacement for make. scons does not provide a - configure phase, so everything is managed at build and install time. + Overrides the build, install, and check phases. This uses the scons build system as a replacement for make. scons does not provide a configure phase, so everything is managed at build and install time. </para> </listitem> </varlistentry> @@ -2877,40 +2196,26 @@ postInstall = '' <title>Purity in Nixpkgs</title> <para> - [measures taken to prevent dependencies on packages outside the store, and - what you can do to prevent them] + [measures taken to prevent dependencies on packages outside the store, and what you can do to prevent them] </para> <para> - GCC doesn't search in locations such as <filename>/usr/include</filename>. - In fact, attempts to add such directories through the <option>-I</option> - flag are filtered out. Likewise, the linker (from GNU binutils) doesn't - search in standard locations such as <filename>/usr/lib</filename>. Programs - built on Linux are linked against a GNU C Library that likewise doesn't - search in the default system locations. + GCC doesn't search in locations such as <filename>/usr/include</filename>. In fact, attempts to add such directories through the <option>-I</option> flag are filtered out. Likewise, the linker (from GNU binutils) doesn't search in standard locations such as <filename>/usr/lib</filename>. Programs built on Linux are linked against a GNU C Library that likewise doesn't search in the default system locations. </para> </section> <section xml:id="sec-hardening-in-nixpkgs"> <title>Hardening in Nixpkgs</title> <para> - There are flags available to harden packages at compile or link-time. These - can be toggled using the <varname>stdenv.mkDerivation</varname> parameters - <varname>hardeningDisable</varname> and <varname>hardeningEnable</varname>. + There are flags available to harden packages at compile or link-time. These can be toggled using the <varname>stdenv.mkDerivation</varname> parameters <varname>hardeningDisable</varname> and <varname>hardeningEnable</varname>. </para> <para> - Both parameters take a list of flags as strings. The special - <varname>"all"</varname> flag can be passed to - <varname>hardeningDisable</varname> to turn off all hardening. These flags - can also be used as environment variables for testing or development - purposes. + Both parameters take a list of flags as strings. The special <varname>"all"</varname> flag can be passed to <varname>hardeningDisable</varname> to turn off all hardening. These flags can also be used as environment variables for testing or development purposes. </para> <para> - The following flags are enabled by default and might require disabling with - <varname>hardeningDisable</varname> if the program to package is - incompatible. + The following flags are enabled by default and might require disabling with <varname>hardeningDisable</varname> if the program to package is incompatible. </para> <variablelist> @@ -2920,13 +2225,7 @@ postInstall = '' </term> <listitem> <para> - Adds the <option>-Wformat -Wformat-security - -Werror=format-security</option> compiler options. At present, this warns - about calls to <varname>printf</varname> and <varname>scanf</varname> - functions where the format string is not a string literal and there are - no format arguments, as in <literal>printf(foo);</literal>. This may be a - security hole if the format string came from untrusted input and contains - <literal>%n</literal>. + Adds the <option>-Wformat -Wformat-security -Werror=format-security</option> compiler options. At present, this warns about calls to <varname>printf</varname> and <varname>scanf</varname> functions where the format string is not a string literal and there are no format arguments, as in <literal>printf(foo);</literal>. This may be a security hole if the format string came from untrusted input and contains <literal>%n</literal>. </para> <para> This needs to be turned off or fixed for errors similar to: @@ -2945,12 +2244,7 @@ cc1plus: some warnings being treated as errors </term> <listitem> <para> - Adds the <option>-fstack-protector-strong --param - ssp-buffer-size=4</option> compiler options. This adds safety checks - against stack overwrites rendering many potential code injection attacks - into aborting situations. In the best case this turns code injection - vulnerabilities into denial of service or into non-issues (depending on - the application). + Adds the <option>-fstack-protector-strong --param ssp-buffer-size=4</option> compiler options. This adds safety checks against stack overwrites rendering many potential code injection attacks into aborting situations. In the best case this turns code injection vulnerabilities into denial of service or into non-issues (depending on the application). </para> <para> This needs to be turned off or fixed for errors similar to: @@ -2967,19 +2261,10 @@ bin/blib.a(bios_console.o): In function `bios_handle_cup': </term> <listitem> <para> - Adds the <option>-O2 -D_FORTIFY_SOURCE=2</option> compiler options. - During code generation the compiler knows a great deal of information - about buffer sizes (where possible), and attempts to replace insecure - unlimited length buffer function calls with length-limited ones. This is - especially useful for old, crufty code. Additionally, format strings in - writable memory that contain '%n' are blocked. If an application depends - on such a format string, it will need to be worked around. + Adds the <option>-O2 -D_FORTIFY_SOURCE=2</option> compiler options. During code generation the compiler knows a great deal of information about buffer sizes (where possible), and attempts to replace insecure unlimited length buffer function calls with length-limited ones. This is especially useful for old, crufty code. Additionally, format strings in writable memory that contain '%n' are blocked. If an application depends on such a format string, it will need to be worked around. </para> <para> - Additionally, some warnings are enabled which might trigger build - failures if compiler warnings are treated as errors in the package build. - In this case, set <option>NIX_CFLAGS_COMPILE</option> to - <option>-Wno-error=warning-type</option>. + Additionally, some warnings are enabled which might trigger build failures if compiler warnings are treated as errors in the package build. In this case, set <option>NIX_CFLAGS_COMPILE</option> to <option>-Wno-error=warning-type</option>. </para> <para> This needs to be turned off or fixed for errors similar to: @@ -3008,15 +2293,10 @@ fcntl2.h:50:4: error: call to '__open_missing_mode' declared with attribute erro </term> <listitem> <para> - Adds the <option>-fPIC</option> compiler options. This options adds - support for position independent code in shared libraries and thus making - ASLR possible. + Adds the <option>-fPIC</option> compiler options. This options adds support for position independent code in shared libraries and thus making ASLR possible. </para> <para> - Most notably, the Linux kernel, kernel modules and other code not running - in an operating system environment like boot loaders won't build with PIC - enabled. The compiler will is most cases complain that PIC is not - supported for a specific build. + Most notably, the Linux kernel, kernel modules and other code not running in an operating system environment like boot loaders won't build with PIC enabled. The compiler will is most cases complain that PIC is not supported for a specific build. </para> <para> This needs to be turned off or fixed for assembler errors similar to: @@ -3033,13 +2313,7 @@ ccbLfRgg.s:33: Error: missing or invalid displacement expression `private_key_le </term> <listitem> <para> - Signed integer overflow is undefined behaviour according to the C - standard. If it happens, it is an error in the program as it should check - for overflow before it can happen, not afterwards. GCC provides built-in - functions to perform arithmetic with overflow checking, which are correct - and faster than any custom implementation. As a workaround, the option - <option>-fno-strict-overflow</option> makes gcc behave as if signed - integer overflows were defined. + Signed integer overflow is undefined behaviour according to the C standard. If it happens, it is an error in the program as it should check for overflow before it can happen, not afterwards. GCC provides built-in functions to perform arithmetic with overflow checking, which are correct and faster than any custom implementation. As a workaround, the option <option>-fno-strict-overflow</option> makes gcc behave as if signed integer overflows were defined. </para> <para> This flag should not trigger any build or runtime errors. @@ -3052,18 +2326,10 @@ ccbLfRgg.s:33: Error: missing or invalid displacement expression `private_key_le </term> <listitem> <para> - Adds the <option>-z relro</option> linker option. During program load, - several ELF memory sections need to be written to by the linker, but can - be turned read-only before turning over control to the program. This - prevents some GOT (and .dtors) overwrite attacks, but at least the part - of the GOT used by the dynamic linker (.got.plt) is still vulnerable. + Adds the <option>-z relro</option> linker option. During program load, several ELF memory sections need to be written to by the linker, but can be turned read-only before turning over control to the program. This prevents some GOT (and .dtors) overwrite attacks, but at least the part of the GOT used by the dynamic linker (.got.plt) is still vulnerable. </para> <para> - This flag can break dynamic shared object loading. For instance, the - module systems of Xorg and OpenCV are incompatible with this flag. In - almost all cases the <varname>bindnow</varname> flag must also be - disabled and incompatible programs typically fail with similar errors at - runtime. + This flag can break dynamic shared object loading. For instance, the module systems of Xorg and OpenCV are incompatible with this flag. In almost all cases the <varname>bindnow</varname> flag must also be disabled and incompatible programs typically fail with similar errors at runtime. </para> </listitem> </varlistentry> @@ -3073,18 +2339,10 @@ ccbLfRgg.s:33: Error: missing or invalid displacement expression `private_key_le </term> <listitem> <para> - Adds the <option>-z bindnow</option> linker option. During program load, - all dynamic symbols are resolved, allowing for the complete GOT to be - marked read-only (due to <varname>relro</varname>). This prevents GOT - overwrite attacks. For very large applications, this can incur some - performance loss during initial load while symbols are resolved, but this - shouldn't be an issue for daemons. + Adds the <option>-z bindnow</option> linker option. During program load, all dynamic symbols are resolved, allowing for the complete GOT to be marked read-only (due to <varname>relro</varname>). This prevents GOT overwrite attacks. For very large applications, this can incur some performance loss during initial load while symbols are resolved, but this shouldn't be an issue for daemons. </para> <para> - This flag can break dynamic shared object loading. For instance, the - module systems of Xorg and PHP are incompatible with this flag. Programs - incompatible with this flag often fail at runtime due to missing symbols, - like: + This flag can break dynamic shared object loading. For instance, the module systems of Xorg and PHP are incompatible with this flag. Programs incompatible with this flag often fail at runtime due to missing symbols, like: </para> <programlisting> intel_drv.so: undefined symbol: vgaHWFreeHWRec @@ -3094,9 +2352,7 @@ intel_drv.so: undefined symbol: vgaHWFreeHWRec </variablelist> <para> - The following flags are disabled by default and should be enabled with - <varname>hardeningEnable</varname> for packages that take untrusted input - like network services. + The following flags are disabled by default and should be enabled with <varname>hardeningEnable</varname> for packages that take untrusted input like network services. </para> <variablelist> @@ -3106,31 +2362,14 @@ intel_drv.so: undefined symbol: vgaHWFreeHWRec </term> <listitem> <para> - Adds the <option>-fPIE</option> compiler and <option>-pie</option> linker - options. Position Independent Executables are needed to take advantage of - Address Space Layout Randomization, supported by modern kernel versions. - While ASLR can already be enforced for data areas in the stack and heap - (brk and mmap), the code areas must be compiled as position-independent. - Shared libraries already do this with the <varname>pic</varname> flag, so - they gain ASLR automatically, but binary .text regions need to be build - with <varname>pie</varname> to gain ASLR. When this happens, ROP attacks - are much harder since there are no static locations to bounce off of - during a memory corruption attack. + Adds the <option>-fPIE</option> compiler and <option>-pie</option> linker options. Position Independent Executables are needed to take advantage of Address Space Layout Randomization, supported by modern kernel versions. While ASLR can already be enforced for data areas in the stack and heap (brk and mmap), the code areas must be compiled as position-independent. Shared libraries already do this with the <varname>pic</varname> flag, so they gain ASLR automatically, but binary .text regions need to be build with <varname>pie</varname> to gain ASLR. When this happens, ROP attacks are much harder since there are no static locations to bounce off of during a memory corruption attack. </para> </listitem> </varlistentry> </variablelist> <para> - For more in-depth information on these hardening flags and hardening in - general, refer to the - <link xlink:href="https://wiki.debian.org/Hardening">Debian Wiki</link>, - <link xlink:href="https://wiki.ubuntu.com/Security/Features">Ubuntu - Wiki</link>, - <link xlink:href="https://wiki.gentoo.org/wiki/Project:Hardened">Gentoo - Wiki</link>, and the - <link xlink:href="https://wiki.archlinux.org/index.php/DeveloperWiki:Security"> - Arch Wiki</link>. + For more in-depth information on these hardening flags and hardening in general, refer to the <link xlink:href="https://wiki.debian.org/Hardening">Debian Wiki</link>, <link xlink:href="https://wiki.ubuntu.com/Security/Features">Ubuntu Wiki</link>, <link xlink:href="https://wiki.gentoo.org/wiki/Project:Hardened">Gentoo Wiki</link>, and the <link xlink:href="https://wiki.archlinux.org/index.php/DeveloperWiki:Security"> Arch Wiki</link>. </para> </section> </chapter> diff --git a/nixpkgs/doc/submitting-changes.xml b/nixpkgs/doc/submitting-changes.xml index a04ec08b0484..2c7defb81749 100644 --- a/nixpkgs/doc/submitting-changes.xml +++ b/nixpkgs/doc/submitting-changes.xml @@ -8,8 +8,7 @@ <itemizedlist> <listitem> <para> - Read <link xlink:href="https://nixos.org/nixpkgs/manual/">Manual (How to - write packages for Nix)</link>. + Read <link xlink:href="https://nixos.org/nixpkgs/manual/">Manual (How to write packages for Nix)</link>. </para> </listitem> <listitem> @@ -23,15 +22,11 @@ <itemizedlist> <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. + 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> <listitem> <para> - For example: <command>nixos-version</command> returns - <command>15.05.git.0998212 (Dingo)</command>. So you can do: + For example: <command>nixos-version</command> returns <command>15.05.git.0998212 (Dingo)</command>. So you can do: </para> </listitem> </itemizedlist> @@ -55,9 +50,7 @@ <itemizedlist> <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>. + 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> </itemizedlist> @@ -65,8 +58,7 @@ </listitem> <listitem> <para> - Check for unnecessary whitespace with <command>git diff --check</command> - before committing. + Check for unnecessary whitespace with <command>git diff --check</command> before committing. </para> </listitem> <listitem> @@ -121,8 +113,7 @@ Additional information. <itemizedlist> <listitem> <para> - <command>nix-env -i pkg-name -f <path to your local nixpkgs - folder></command> + <command>nix-env -i pkg-name -f <path to your local nixpkgs folder></command> </para> </listitem> </itemizedlist> @@ -134,14 +125,12 @@ Additional information. <itemizedlist> <listitem> <para> - Make sure it's in - <command>pkgs/top-level/all-packages.nix</command> + Make sure it's in <command>pkgs/top-level/all-packages.nix</command> </para> </listitem> <listitem> <para> - <command>nix-env -i pkg-name -f <path to your local nixpkgs - folder></command> + <command>nix-env -i pkg-name -f <path to your local nixpkgs folder></command> </para> </listitem> </itemizedlist> @@ -149,15 +138,11 @@ Additional information. </listitem> <listitem> <para> - <emphasis>If you don't want to install pkg in you - profile</emphasis>. + <emphasis>If you don't want to install pkg in you profile</emphasis>. <itemizedlist> <listitem> <para> - <command>nix-build -A pkg-attribute-name <path to your local - nixpkgs folder>/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>. + <command>nix-build -A pkg-attribute-name <path to your local nixpkgs folder>/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> @@ -165,9 +150,7 @@ Additional information. </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. + 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> @@ -179,10 +162,7 @@ Additional information. <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=<path to your local - nixpkgs folder> --fast</command>. + 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=<path to your local nixpkgs folder> --fast</command>. </para> </listitem> </itemizedlist> @@ -193,9 +173,7 @@ Additional information. </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>. + 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> @@ -220,8 +198,7 @@ Additional information. <itemizedlist> <listitem> <para> - Write the title in format <command>(pkg-name | nixos/<module>): - improvement</command>. + Write the title in format <command>(pkg-name | nixos/<module>): improvement</command>. <itemizedlist> <listitem> <para> @@ -233,8 +210,7 @@ Additional information. </listitem> <listitem> <para> - Write in comment if you have tested your patch. Do not rely much on - <command>TravisCI</command>. + Write in comment if you have tested your patch. Do not rely much on <command>TravisCI</command>. </para> </listitem> <listitem> @@ -244,8 +220,7 @@ Additional information. </listitem> <listitem> <para> - Notify maintainers of the package. For example add to the message: - <command>cc @jagajaga @domenkozar</command>. + Notify maintainers of the package. For example add to the message: <command>cc @jagajaga @domenkozar</command>. </para> </listitem> </itemizedlist> @@ -257,65 +232,40 @@ Additional information. <title>Pull Request Template</title> <para> - The pull request template helps determine what steps have been made for a - contribution so far, and will help guide maintainers on the status of a - change. The motivation section of the PR should include any extra details - the title does not address and link any existing issues related to the pull - request. + The pull request template helps determine what steps have been made for a contribution so far, and will help guide maintainers on the status of a change. The motivation section of the PR should include any extra details the title does not address and link any existing issues related to the pull request. </para> <para> - When a PR is created, it will be pre-populated with some checkboxes detailed - below: + When a PR is created, it will be pre-populated with some checkboxes detailed below: </para> <section xml:id="submitting-changes-tested-with-sandbox"> <title>Tested using sandboxing</title> <para> - When sandbox builds are enabled, Nix will setup an isolated environment for - each build process. It is used to remove further hidden dependencies set by - the build environment to improve reproducibility. This includes access to - the network during the build outside of <function>fetch*</function> - functions and files outside the Nix store. Depending on the operating - system access to other resources are blocked as well (ex. inter process - communication is isolated on Linux); see - <link - xlink:href="https://nixos.org/nix/manual/#description-45">build-use-sandbox</link> - in Nix manual for details. + When sandbox builds are enabled, Nix will setup an isolated environment for each build process. It is used to remove further hidden dependencies set by the build environment to improve reproducibility. This includes access to the network during the build outside of <function>fetch*</function> functions and files outside the Nix store. Depending on the operating system access to other resources are blocked as well (ex. inter process communication is isolated on Linux); see <link + xlink:href="https://nixos.org/nix/manual/#conf-sandbox">sandbox</link> in Nix manual for details. </para> <para> - Sandboxing is not enabled by default in Nix due to a small performance hit - on each build. In pull requests for - <link - xlink:href="https://github.com/NixOS/nixpkgs/">nixpkgs</link> - people are asked to test builds with sandboxing enabled (see - <literal>Tested using sandboxing</literal> in the pull request template) - because - in<link - xlink:href="https://nixos.org/hydra/">https://nixos.org/hydra/</link> - sandboxing is also used. + Sandboxing is not enabled by default in Nix due to a small performance hit on each build. In pull requests for <link + xlink:href="https://github.com/NixOS/nixpkgs/">nixpkgs</link> people are asked to test builds with sandboxing enabled (see <literal>Tested using sandboxing</literal> in the pull request template) because in<link + xlink:href="https://nixos.org/hydra/">https://nixos.org/hydra/</link> sandboxing is also used. </para> <para> - 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: + 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: <itemizedlist> <listitem> <para> - <emphasis role="bold">Globally enable sandboxing on NixOS</emphasis>: - add the following to <filename>configuration.nix</filename> + <emphasis role="bold">Globally enable sandboxing on NixOS</emphasis>: add the following to <filename>configuration.nix</filename> <screen>nix.useSandbox = true;</screen> </para> </listitem> <listitem> <para> - <emphasis role="bold">Globally enable sandboxing on non-NixOS - platforms</emphasis>: add the following to: - <filename>/etc/nix/nix.conf</filename> -<screen>build-use-sandbox = true</screen> + <emphasis role="bold">Globally enable sandboxing on non-NixOS platforms</emphasis>: add the following to: <filename>/etc/nix/nix.conf</filename> +<screen>sandbox = true</screen> </para> </listitem> </itemizedlist> @@ -326,11 +276,7 @@ Additional information. <title>Built on platform(s)</title> <para> - Many Nix packages are designed to run on multiple platforms. As such, it's - important to let the maintainer know which platforms your changes have been - tested on. It's not always practical to test a change on all platforms, and - is not required for a pull request to be merged. Only check the systems you - tested the build on in this section. + Many Nix packages are designed to run on multiple platforms. As such, it's important to let the maintainer know which platforms your changes have been tested on. It's not always practical to test a change on all platforms, and is not required for a pull request to be merged. Only check the systems you tested the build on in this section. </para> </section> @@ -338,15 +284,8 @@ Additional information. <title>Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)</title> <para> - Packages with automated tests are much more likely to be merged in a timely - fashion because it doesn't require as much manual testing by the maintainer - to verify the functionality of the package. If there are existing tests for - the package, they should be run to verify your changes do not break the - tests. Tests only apply to packages with NixOS modules defined and can only - be run on Linux. For more details on writing and running tests, see the - <link - xlink:href="https://nixos.org/nixos/manual/index.html#sec-nixos-tests">section - in the NixOS manual</link>. + Packages with automated tests are much more likely to be merged in a timely fashion because it doesn't require as much manual testing by the maintainer to verify the functionality of the package. If there are existing tests for the package, they should be run to verify your changes do not break the tests. Tests only apply to packages with NixOS modules defined and can only be run on Linux. For more details on writing and running tests, see the <link + xlink:href="https://nixos.org/nixos/manual/index.html#sec-nixos-tests">section in the NixOS manual</link>. </para> </section> @@ -354,11 +293,7 @@ Additional information. <title>Tested compilation of all pkgs that depend on this change using <command>nix-review</command></title> <para> - If you are updating a package's version, you can use nix-review to make - sure all packages that depend on the updated package still compile - correctly. The <command>nix-review</command> utility can look for and build - all dependencies either based on uncommited changes with the - <literal>wip</literal> option or specifying a github pull request number. + If you are updating a package's version, you can use nix-review to make sure all packages that depend on the updated package still compile correctly. The <command>nix-review</command> utility can look for and build all dependencies either based on uncommited changes with the <literal>wip</literal> option or specifying a github pull request number. </para> <para> @@ -376,13 +311,7 @@ Additional information. <title>Tested execution of all binary files (usually in <filename>./result/bin/</filename>)</title> <para> - It's important to test any executables generated by a build when you change - or create a package in nixpkgs. This can be done by looking in - <filename>./result/bin</filename> and running any files in there, or at a - minimum, the main executable for the package. For example, if you make a - change to <package>texlive</package>, you probably would only check the - binaries associated with the change you made rather than testing all of - them. + It's important to test any executables generated by a build when you change or create a package in nixpkgs. This can be done by looking in <filename>./result/bin</filename> and running any files in there, or at a minimum, the main executable for the package. For example, if you make a change to <package>texlive</package>, you probably would only check the binaries associated with the change you made rather than testing all of them. </para> </section> @@ -390,14 +319,8 @@ Additional information. <title>Meets Nixpkgs contribution standards</title> <para> - The last checkbox is fits - <link - xlink:href="https://github.com/NixOS/nixpkgs/blob/master/.github/CONTRIBUTING.md">CONTRIBUTING.md</link>. - The contributing document has detailed information on standards the Nix - community has for commit messages, reviews, licensing of contributions you - make to the project, etc... Everyone should read and understand the - standards the community has for contributing before submitting a pull - request. + The last checkbox is fits <link + xlink:href="https://github.com/NixOS/nixpkgs/blob/master/.github/CONTRIBUTING.md">CONTRIBUTING.md</link>. The contributing document has detailed information on standards the Nix community has for commit messages, reviews, licensing of contributions you make to the project, etc... Everyone should read and understand the standards the community has for contributing before submitting a pull request. </para> </section> </section> @@ -435,22 +358,17 @@ Additional information. <itemizedlist> <listitem> <para> - Commits must be sufficiently tested before being merged, both for the - master and staging branches. + Commits must be sufficiently tested before being merged, both for the master and staging branches. </para> </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. + 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> <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. + 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> </itemizedlist> @@ -473,20 +391,12 @@ Additional information. <itemizedlist> <listitem> <para> - It's only for non-breaking mass-rebuild commits. That means it's not to - be used for testing, and changes must have been well tested already. - <link xlink:href="https://web.archive.org/web/20160528180406/http://comments.gmane.org/gmane.linux.distributions.nixos/13447">Read - policy here</link>. + It's only for non-breaking mass-rebuild commits. That means it's not to be used for testing, and changes must have been well tested already. <link xlink:href="https://web.archive.org/web/20160528180406/http://comments.gmane.org/gmane.linux.distributions.nixos/13447">Read policy here</link>. </para> </listitem> <listitem> <para> - If the branch is already in a broken state, please refrain from adding - extra new breakages. Stabilize it for a few days, merge into master, then - resume development on staging. - <link xlink:href="http://hydra.nixos.org/jobset/nixpkgs/staging#tabs-evaluations">Keep - an eye on the staging evaluations here</link>. If any fixes for staging - happen to be already in master, then master can be merged into staging. + If the branch is already in a broken state, please refrain from adding extra new breakages. Stabilize it for a few days, merge into master, then resume development on staging. <link xlink:href="http://hydra.nixos.org/jobset/nixpkgs/staging#tabs-evaluations">Keep an eye on the staging evaluations here</link>. If any fixes for staging happen to be already in master, then master can be merged into staging. </para> </listitem> </itemizedlist> @@ -498,10 +408,7 @@ Additional information. <itemizedlist> <listitem> <para> - If you're cherry-picking a commit to a stable release branch, always use - <command>git cherry-pick -xe</command> and ensure the message contains a - clear description about why this needs to be included in the stable - branch. + If you're cherry-picking a commit to a stable release branch, always use <command>git cherry-pick -xe</command> and ensure the message contains a clear description about why this needs to be included in the stable branch. </para> <para> An example of a cherry-picked commit would look like this: |