diff options
152 files changed, 18347 insertions, 14898 deletions
diff --git a/doc/Makefile b/doc/Makefile index 952ef4bfcbb9..8a4612e95f19 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -1,12 +1,17 @@ MD_TARGETS=$(addsuffix .xml, $(basename $(wildcard ./*.md ./**/*.md))) .PHONY: all -all: validate out/html/index.html out/epub/manual.epub +all: validate format out/html/index.html out/epub/manual.epub .PHONY: debug debug: nix-shell --run "xmloscopy --docbook5 ./manual.xml ./manual-full.xml" +.PHONY: format +format: + find . -iname '*.xml' -type f -print0 | xargs -0 -I{} -n1 \ + xmlformat --config-file "$$XMLFORMAT_CONFIG" -i {} + .PHONY: clean clean: rm -f ${MD_TARGETS} .version manual-full.xml diff --git a/doc/coding-conventions.xml b/doc/coding-conventions.xml index d556c7ebe1ed..f244c11d4f20 100644 --- a/doc/coding-conventions.xml +++ b/doc/coding-conventions.xml @@ -1,56 +1,59 @@ <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="chap-conventions"> - -<title>Coding conventions</title> - - -<section xml:id="sec-syntax"><title>Syntax</title> - -<itemizedlist> - - <listitem><para>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.</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"/>.</para></listitem> - - <listitem><para>Function calls with attribute set arguments are - written as - + <title>Coding conventions</title> + <section xml:id="sec-syntax"> + <title>Syntax</title> + + <itemizedlist> + <listitem> + <para> + 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. + </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"/>. + </para> + </listitem> + <listitem> + <para> + Function calls with attribute set arguments are written as <programlisting> foo { arg = ...; } </programlisting> - - not - + not <programlisting> foo { arg = ...; } </programlisting> - - Also fine is - + Also fine is <programlisting> foo { arg = ...; } </programlisting> - - if it's a short call.</para></listitem> - - <listitem><para>In attribute sets or lists that span multiple lines, - the attribute names or list elements should be aligned: - + if it's a short call. + </para> + </listitem> + <listitem> + <para> + In attribute sets or lists that span multiple lines, the attribute names + or list elements should be aligned: <programlisting> # A long list. list = @@ -73,12 +76,11 @@ attrs = { if true then big_expr else big_expr; }; </programlisting> - - </para></listitem> - - <listitem><para>Short lists or attribute sets can be written on one - line: - + </para> + </listitem> + <listitem> + <para> + Short lists or attribute sets can be written on one line: <programlisting> # A short list. list = [ elem1 elem2 elem3 ]; @@ -86,66 +88,58 @@ list = [ elem1 elem2 elem3 ]; # A short set. attrs = { x = 1280; y = 1024; }; </programlisting> - - </para></listitem> - - <listitem><para>Breaking in the middle of a function argument can - give hard-to-read code, like - + </para> + </listitem> + <listitem> + <para> + Breaking in the middle of a function argument can give hard-to-read code, + like <programlisting> someFunction { x = 1280; y = 1024; } otherArg yetAnotherArg </programlisting> - - (especially if the argument is very large, spanning multiple - lines).</para> - - <para>Better: - + (especially if the argument is very large, spanning multiple lines). + </para> + <para> + Better: <programlisting> someFunction { x = 1280; y = 1024; } otherArg yetAnotherArg </programlisting> - - or - + or <programlisting> let res = { x = 1280; y = 1024; }; in someFunction res otherArg yetAnotherArg </programlisting> - - </para></listitem> - - <listitem><para>The bodies of functions, asserts, and withs are not - indented to prevent a lot of superfluous indentation levels, i.e. - + </para> + </listitem> + <listitem> + <para> + 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"; stdenv.mkDerivation { ... </programlisting> - - not - + not <programlisting> { arg1, arg2 }: assert system == "i686-linux"; stdenv.mkDerivation { ... </programlisting> - - </para></listitem> - - <listitem><para>Function formal arguments are written as: - + </para> + </listitem> + <listitem> + <para> + Function formal arguments are written as: <programlisting> { arg1, arg2, arg3 }: </programlisting> - - but if they don't fit on one line they're written as: - + but if they don't fit on one line they're written as: <programlisting> { arg1, arg2, arg3 , arg4, ... @@ -153,35 +147,28 @@ stdenv.mkDerivation { ... argN }: </programlisting> - - </para></listitem> - - <listitem><para>Functions should list their expected arguments as - precisely as possible. That is, write - + </para> + </listitem> + <listitem> + <para> + Functions should list their expected arguments as precisely as possible. + That is, write <programlisting> { stdenv, fetchurl, perl }: <replaceable>...</replaceable> </programlisting> - - instead of - + instead of <programlisting> args: with args; <replaceable>...</replaceable> </programlisting> - - or - + or <programlisting> { stdenv, fetchurl, perl, ... }: <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: - + </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: <programlisting> { stdenv, doCoverageAnalysis ? false, ... } @ args: @@ -189,9 +176,7 @@ stdenv.mkDerivation (args // { <replaceable>...</replaceable> if doCoverageAnalysis then "bla" else "" <replaceable>...</replaceable> }) </programlisting> - - instead of - + instead of <programlisting> args: @@ -199,432 +184,557 @@ args.stdenv.mkDerivation (args // { <replaceable>...</replaceable> if args ? doCoverageAnalysis && args.doCoverageAnalysis then "bla" else "" <replaceable>...</replaceable> }) </programlisting> + </para> + </listitem> + </itemizedlist> + </section> + <section xml:id="sec-package-naming"> + <title>Package naming</title> - </para></listitem> - -</itemizedlist> - -</section> - - -<section xml:id="sec-package-naming"><title>Package naming</title> - -<para>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>.</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>.</para></listitem> - - <listitem><para>The filename for (the directory containing) the Nix - expression.</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>. -</para> - -<para>There are a few naming guidelines: - -<itemizedlist> - - <listitem><para>Generally, try to stick to the upstream package - name.</para></listitem> - - <listitem><para>Don’t use uppercase letters in the - <literal>name</literal> attribute — 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>.</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 must 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 should 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 - should 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> - -</para> - -</section> - - -<section xml:id="sec-organisation"><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>.</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>.</para> - -<para>When in doubt, consider refactoring the -<filename>pkgs/</filename> tree, e.g. creating new categories or -splitting up an existing category.</para> - -<variablelist> - <varlistentry> - <term>If it’s used to support <emphasis>software development</emphasis>:</term> + <para> + In Nixpkgs, there are generally three different names associated with a + package: + <itemizedlist> <listitem> - <variablelist> - <varlistentry> - <term>If it’s a <emphasis>library</emphasis> used by other packages:</term> - <listitem> - <para><filename>development/libraries</filename> (e.g. <filename>libxml2</filename>)</para> - </listitem> - </varlistentry> - <varlistentry> - <term>If it’s a <emphasis>compiler</emphasis>:</term> - <listitem> - <para><filename>development/compilers</filename> (e.g. <filename>gcc</filename>)</para> - </listitem> - </varlistentry> - <varlistentry> - <term>If it’s an <emphasis>interpreter</emphasis>:</term> - <listitem> - <para><filename>development/interpreters</filename> (e.g. <filename>guile</filename>)</para> - </listitem> - </varlistentry> - <varlistentry> - <term>If it’s a (set of) development <emphasis>tool(s)</emphasis>:</term> - <listitem> - <variablelist> - <varlistentry> - <term>If it’s a <emphasis>parser generator</emphasis> (including lexers):</term> - <listitem> - <para><filename>development/tools/parsing</filename> (e.g. <filename>bison</filename>, <filename>flex</filename>)</para> - </listitem> - </varlistentry> - <varlistentry> - <term>If it’s a <emphasis>build manager</emphasis>:</term> - <listitem> - <para><filename>development/tools/build-managers</filename> (e.g. <filename>gnumake</filename>)</para> - </listitem> - </varlistentry> - <varlistentry> - <term>Else:</term> - <listitem> - <para><filename>development/tools/misc</filename> (e.g. <filename>binutils</filename>)</para> - </listitem> - </varlistentry> - </variablelist> - </listitem> - </varlistentry> - <varlistentry> - <term>Else:</term> - <listitem> - <para><filename>development/misc</filename></para> - </listitem> - </varlistentry> - </variablelist> + <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>. + </para> </listitem> - </varlistentry> - <varlistentry> - <term>If it’s a (set of) <emphasis>tool(s)</emphasis>:</term> <listitem> - <para>(A tool is a relatively small program, especially one intended - to be used non-interactively.)</para> - <variablelist> - <varlistentry> - <term>If it’s for <emphasis>networking</emphasis>:</term> - <listitem> - <para><filename>tools/networking</filename> (e.g. <filename>wget</filename>)</para> - </listitem> - </varlistentry> - <varlistentry> - <term>If it’s for <emphasis>text processing</emphasis>:</term> - <listitem> - <para><filename>tools/text</filename> (e.g. <filename>diffutils</filename>)</para> - </listitem> - </varlistentry> - <varlistentry> - <term>If it’s a <emphasis>system utility</emphasis>, i.e., - something related or essential to the operation of a - system:</term> - <listitem> - <para><filename>tools/system</filename> (e.g. <filename>cron</filename>)</para> - </listitem> - </varlistentry> - <varlistentry> - <term>If it’s an <emphasis>archiver</emphasis> (which may - include a compression function):</term> - <listitem> - <para><filename>tools/archivers</filename> (e.g. <filename>zip</filename>, <filename>tar</filename>)</para> - </listitem> - </varlistentry> - <varlistentry> - <term>If it’s a <emphasis>compression</emphasis> program:</term> - <listitem> - <para><filename>tools/compression</filename> (e.g. <filename>gzip</filename>, <filename>bzip2</filename>)</para> - </listitem> - </varlistentry> - <varlistentry> - <term>If it’s a <emphasis>security</emphasis>-related program:</term> - <listitem> - <para><filename>tools/security</filename> (e.g. <filename>nmap</filename>, <filename>gnupg</filename>)</para> - </listitem> - </varlistentry> - <varlistentry> - <term>Else:</term> - <listitem> - <para><filename>tools/misc</filename></para> - </listitem> - </varlistentry> - </variablelist> + <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>. + </para> </listitem> - </varlistentry> - <varlistentry> - <term>If it’s a <emphasis>shell</emphasis>:</term> <listitem> - <para><filename>shells</filename> (e.g. <filename>bash</filename>)</para> + <para> + The filename for (the directory containing) the Nix expression. + </para> </listitem> - </varlistentry> - <varlistentry> - <term>If it’s a <emphasis>server</emphasis>:</term> + </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>. + </para> + + <para> + There are a few naming guidelines: + <itemizedlist> <listitem> - <variablelist> - <varlistentry> - <term>If it’s a web server:</term> - <listitem> - <para><filename>servers/http</filename> (e.g. <filename>apache-httpd</filename>)</para> - </listitem> - </varlistentry> - <varlistentry> - <term>If it’s an implementation of the X Windowing System:</term> - <listitem> - <para><filename>servers/x11</filename> (e.g. <filename>xorg</filename> — this includes the client libraries and programs)</para> - </listitem> - </varlistentry> - <varlistentry> - <term>Else:</term> - <listitem> - <para><filename>servers/misc</filename></para> - </listitem> - </varlistentry> - </variablelist> + <para> + Generally, try to stick to the upstream package name. + </para> </listitem> - </varlistentry> - <varlistentry> - <term>If it’s a <emphasis>desktop environment</emphasis>:</term> <listitem> - <para><filename>desktops</filename> (e.g. <filename>kde</filename>, <filename>gnome</filename>, <filename>enlightenment</filename>)</para> + <para> + Don’t use uppercase letters in the <literal>name</literal> attribute + — e.g., <literal>"mplayer-1.0rc2"</literal> instead of + <literal>"MPlayer-1.0rc2"</literal>. + </para> </listitem> - </varlistentry> - <varlistentry> - <term>If it’s a <emphasis>window manager</emphasis>:</term> <listitem> - <para><filename>applications/window-managers</filename> (e.g. <filename>awesome</filename>, <filename>stumpwm</filename>)</para> + <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>. + </para> </listitem> - </varlistentry> - <varlistentry> - <term>If it’s an <emphasis>application</emphasis>:</term> <listitem> - <para>A (typically large) program with a distinct user - interface, primarily used interactively.</para> - <variablelist> - <varlistentry> - <term>If it’s a <emphasis>version management system</emphasis>:</term> - <listitem> - <para><filename>applications/version-management</filename> (e.g. <filename>subversion</filename>)</para> - </listitem> - </varlistentry> - <varlistentry> - <term>If it’s for <emphasis>video playback / editing</emphasis>:</term> - <listitem> - <para><filename>applications/video</filename> (e.g. <filename>vlc</filename>)</para> - </listitem> - </varlistentry> - <varlistentry> - <term>If it’s for <emphasis>graphics viewing / editing</emphasis>:</term> - <listitem> - <para><filename>applications/graphics</filename> (e.g. <filename>gimp</filename>)</para> - </listitem> - </varlistentry> - <varlistentry> - <term>If it’s for <emphasis>networking</emphasis>:</term> - <listitem> - <variablelist> - <varlistentry> - <term>If it’s a <emphasis>mailreader</emphasis>:</term> - <listitem> - <para><filename>applications/networking/mailreaders</filename> (e.g. <filename>thunderbird</filename>)</para> - </listitem> - </varlistentry> - <varlistentry> - <term>If it’s a <emphasis>newsreader</emphasis>:</term> - <listitem> - <para><filename>applications/networking/newsreaders</filename> (e.g. <filename>pan</filename>)</para> - </listitem> - </varlistentry> - <varlistentry> - <term>If it’s a <emphasis>web browser</emphasis>:</term> - <listitem> - <para><filename>applications/networking/browsers</filename> (e.g. <filename>firefox</filename>)</para> - </listitem> - </varlistentry> - <varlistentry> - <term>Else:</term> - <listitem> - <para><filename>applications/networking/misc</filename></para> - </listitem> - </varlistentry> - </variablelist> - </listitem> - </varlistentry> - <varlistentry> - <term>Else:</term> - <listitem> - <para><filename>applications/misc</filename></para> - </listitem> - </varlistentry> - </variablelist> + <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 must 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> - </varlistentry> - <varlistentry> - <term>If it’s <emphasis>data</emphasis> (i.e., does not have a - straight-forward executable semantics):</term> <listitem> - <variablelist> - <varlistentry> - <term>If it’s a <emphasis>font</emphasis>:</term> - <listitem> - <para><filename>data/fonts</filename></para> - </listitem> - </varlistentry> - <varlistentry> - <term>If it’s related to <emphasis>SGML/XML processing</emphasis>:</term> - <listitem> - <variablelist> - <varlistentry> - <term>If it’s an <emphasis>XML DTD</emphasis>:</term> - <listitem> - <para><filename>data/sgml+xml/schemas/xml-dtd</filename> (e.g. <filename>docbook</filename>)</para> - </listitem> - </varlistentry> - <varlistentry> - <term>If it’s an <emphasis>XSLT stylesheet</emphasis>:</term> - <listitem> - <para>(Okay, these are executable...)</para> - <para><filename>data/sgml+xml/stylesheets/xslt</filename> (e.g. <filename>docbook-xsl</filename>)</para> - </listitem> - </varlistentry> - </variablelist> - </listitem> - </varlistentry> - </variablelist> + <para> + Dashes in the package name should 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> - </varlistentry> - <varlistentry> - <term>If it’s a <emphasis>game</emphasis>:</term> <listitem> - <para><filename>games</filename></para> + <para> + If there are multiple versions of a package, this should 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> - </varlistentry> - <varlistentry> - <term>Else:</term> - <listitem> - <para><filename>misc</filename></para> - </listitem> - </varlistentry> -</variablelist> - -</section> - -<section xml:id="sec-versioning"><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.</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>.</para> + </itemizedlist> + </para> + </section> + <section xml:id="sec-organisation"> + <title>File naming and organisation</title> -<para>All versions of a package <emphasis>must</emphasis> be included -in <filename>all-packages.nix</filename> to make sure that they -evaluate correctly.</para> + <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>. + </para> -</section> + <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>. + </para> + + <para> + When in doubt, consider refactoring the <filename>pkgs/</filename> tree, + e.g. creating new categories or splitting up an existing category. + </para> + + <variablelist> + <varlistentry> + <term>If it’s used to support <emphasis>software development</emphasis>:</term> + <listitem> + <variablelist> + <varlistentry> + <term>If it’s a <emphasis>library</emphasis> used by other packages:</term> + <listitem> + <para> + <filename>development/libraries</filename> (e.g. + <filename>libxml2</filename>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>If it’s a <emphasis>compiler</emphasis>:</term> + <listitem> + <para> + <filename>development/compilers</filename> (e.g. + <filename>gcc</filename>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>If it’s an <emphasis>interpreter</emphasis>:</term> + <listitem> + <para> + <filename>development/interpreters</filename> (e.g. + <filename>guile</filename>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>If it’s a (set of) development <emphasis>tool(s)</emphasis>:</term> + <listitem> + <variablelist> + <varlistentry> + <term>If it’s a <emphasis>parser generator</emphasis> (including lexers):</term> + <listitem> + <para> + <filename>development/tools/parsing</filename> (e.g. + <filename>bison</filename>, <filename>flex</filename>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>If it’s a <emphasis>build manager</emphasis>:</term> + <listitem> + <para> + <filename>development/tools/build-managers</filename> (e.g. + <filename>gnumake</filename>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Else:</term> + <listitem> + <para> + <filename>development/tools/misc</filename> (e.g. + <filename>binutils</filename>) + </para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + <varlistentry> + <term>Else:</term> + <listitem> + <para> + <filename>development/misc</filename> + </para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + <varlistentry> + <term>If it’s a (set of) <emphasis>tool(s)</emphasis>:</term> + <listitem> + <para> + (A tool is a relatively small program, especially one intended to be + used non-interactively.) + </para> + <variablelist> + <varlistentry> + <term>If it’s for <emphasis>networking</emphasis>:</term> + <listitem> + <para> + <filename>tools/networking</filename> (e.g. + <filename>wget</filename>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>If it’s for <emphasis>text processing</emphasis>:</term> + <listitem> + <para> + <filename>tools/text</filename> (e.g. <filename>diffutils</filename>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>If it’s a <emphasis>system utility</emphasis>, i.e., + something related or essential to the operation of a + system:</term> + <listitem> + <para> + <filename>tools/system</filename> (e.g. <filename>cron</filename>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>If it’s an <emphasis>archiver</emphasis> (which may + include a compression function):</term> + <listitem> + <para> + <filename>tools/archivers</filename> (e.g. <filename>zip</filename>, + <filename>tar</filename>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>If it’s a <emphasis>compression</emphasis> program:</term> + <listitem> + <para> + <filename>tools/compression</filename> (e.g. + <filename>gzip</filename>, <filename>bzip2</filename>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>If it’s a <emphasis>security</emphasis>-related program:</term> + <listitem> + <para> + <filename>tools/security</filename> (e.g. <filename>nmap</filename>, + <filename>gnupg</filename>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Else:</term> + <listitem> + <para> + <filename>tools/misc</filename> + </para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + <varlistentry> + <term>If it’s a <emphasis>shell</emphasis>:</term> + <listitem> + <para> + <filename>shells</filename> (e.g. <filename>bash</filename>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>If it’s a <emphasis>server</emphasis>:</term> + <listitem> + <variablelist> + <varlistentry> + <term>If it’s a web server:</term> + <listitem> + <para> + <filename>servers/http</filename> (e.g. + <filename>apache-httpd</filename>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>If it’s an implementation of the X Windowing System:</term> + <listitem> + <para> + <filename>servers/x11</filename> (e.g. <filename>xorg</filename> — + this includes the client libraries and programs) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Else:</term> + <listitem> + <para> + <filename>servers/misc</filename> + </para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + <varlistentry> + <term>If it’s a <emphasis>desktop environment</emphasis>:</term> + <listitem> + <para> + <filename>desktops</filename> (e.g. <filename>kde</filename>, + <filename>gnome</filename>, <filename>enlightenment</filename>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>If it’s a <emphasis>window manager</emphasis>:</term> + <listitem> + <para> + <filename>applications/window-managers</filename> (e.g. + <filename>awesome</filename>, <filename>stumpwm</filename>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>If it’s an <emphasis>application</emphasis>:</term> + <listitem> + <para> + A (typically large) program with a distinct user interface, primarily + used interactively. + </para> + <variablelist> + <varlistentry> + <term>If it’s a <emphasis>version management system</emphasis>:</term> + <listitem> + <para> + <filename>applications/version-management</filename> (e.g. + <filename>subversion</filename>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>If it’s for <emphasis>video playback / editing</emphasis>:</term> + <listitem> + <para> + <filename>applications/video</filename> (e.g. + <filename>vlc</filename>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>If it’s for <emphasis>graphics viewing / editing</emphasis>:</term> + <listitem> + <para> + <filename>applications/graphics</filename> (e.g. + <filename>gimp</filename>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>If it’s for <emphasis>networking</emphasis>:</term> + <listitem> + <variablelist> + <varlistentry> + <term>If it’s a <emphasis>mailreader</emphasis>:</term> + <listitem> + <para> + <filename>applications/networking/mailreaders</filename> (e.g. + <filename>thunderbird</filename>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>If it’s a <emphasis>newsreader</emphasis>:</term> + <listitem> + <para> + <filename>applications/networking/newsreaders</filename> (e.g. + <filename>pan</filename>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>If it’s a <emphasis>web browser</emphasis>:</term> + <listitem> + <para> + <filename>applications/networking/browsers</filename> (e.g. + <filename>firefox</filename>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Else:</term> + <listitem> + <para> + <filename>applications/networking/misc</filename> + </para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + <varlistentry> + <term>Else:</term> + <listitem> + <para> + <filename>applications/misc</filename> + </para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + <varlistentry> + <term>If it’s <emphasis>data</emphasis> (i.e., does not have a + straight-forward executable semantics):</term> + <listitem> + <variablelist> + <varlistentry> + <term>If it’s a <emphasis>font</emphasis>:</term> + <listitem> + <para> + <filename>data/fonts</filename> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>If it’s related to <emphasis>SGML/XML processing</emphasis>:</term> + <listitem> + <variablelist> + <varlistentry> + <term>If it’s an <emphasis>XML DTD</emphasis>:</term> + <listitem> + <para> + <filename>data/sgml+xml/schemas/xml-dtd</filename> (e.g. + <filename>docbook</filename>) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>If it’s an <emphasis>XSLT stylesheet</emphasis>:</term> + <listitem> + <para> + (Okay, these are executable...) + </para> + <para> + <filename>data/sgml+xml/stylesheets/xslt</filename> (e.g. + <filename>docbook-xsl</filename>) + </para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + <varlistentry> + <term>If it’s a <emphasis>game</emphasis>:</term> + <listitem> + <para> + <filename>games</filename> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Else:</term> + <listitem> + <para> + <filename>misc</filename> + </para> + </listitem> + </varlistentry> + </variablelist> + </section> + + <section xml:id="sec-versioning"> + <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. + </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>. + </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. + </para> + </section> + </section> + <section xml:id="sec-sources"> + <title>Fetching Sources</title> -</section> -<section xml:id="sec-sources"><title>Fetching Sources</title> - <para>There are multiple ways to fetch a package source in nixpkgs. The - general guideline is that you should package 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> + There are multiple ways to fetch a package source in nixpkgs. The general + guideline is that you should package 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>. + + <para> + 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: - <itemizedlist> - <listitem> - <para>Bad: Uses <literal>git://</literal> which won't be proxied. + + <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: + <itemizedlist> + <listitem> + <para> + Bad: Uses <literal>git://</literal> which won't be proxied. <programlisting> src = fetchgit { url = "git://github.com/NixOS/nix.git"; @@ -632,10 +742,11 @@ src = fetchgit { sha256 = "1cw5fszffl5pkpa6s6wjnkiv6lm5k618s32sp60kvmvpy7a2v9kg"; } </programlisting> - </para> - </listitem> - <listitem> - <para>Better: This is ok, but an archive fetch will still be faster. + </para> + </listitem> + <listitem> + <para> + Better: This is ok, but an archive fetch will still be faster. <programlisting> src = fetchgit { url = "https://github.com/NixOS/nix.git"; @@ -643,10 +754,11 @@ src = fetchgit { sha256 = "1cw5fszffl5pkpa6s6wjnkiv6lm5k618s32sp60kvmvpy7a2v9kg"; } </programlisting> - </para> - </listitem> - <listitem> - <para>Best: Fetches a snapshot archive and you get the rev you want. + </para> + </listitem> + <listitem> + <para> + Best: Fetches a snapshot archive and you get the rev you want. <programlisting> src = fetchFromGitHub { owner = "NixOS"; @@ -655,15 +767,19 @@ src = fetchFromGitHub { sha256 = "04yri911rj9j19qqqn6m82266fl05pz98inasni0vxr1cf1gdgv9"; } </programlisting> - </para> - </listitem> - </itemizedlist> + </para> + </listitem> + </itemizedlist> + </para> + </section> + <section xml:id="sec-patches"> + <title>Patches</title> + + <para> + Patches available online should be retrieved using + <literal>fetchpatch</literal>. </para> -</section> -<section xml:id="sec-patches"><title>Patches</title> - <para>Patches available online should be retrieved using - <literal>fetchpatch</literal>.</para> <para> <programlisting> patches = [ @@ -675,30 +791,54 @@ patches = [ ]; </programlisting> </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.</para> -<para><programlisting> + + <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. + </para> + + <para> +<programlisting> patches = [ ./0001-changes.patch ]; -</programlisting></para> - <para>If you do need to do create this sort of patch file, - one way to do so is with git: - <orderedlist> - <listitem><para>Move to the root directory of the source code - you're patching.<screen> -$ cd the/program/source</screen></para></listitem> - <listitem><para>If a git repository is not already present, - create one and stage all of the source files.<screen> +</programlisting> + </para> + + <para> + If you do need to do create this sort of patch file, one way to do so is + with git: + <orderedlist> + <listitem> + <para> + Move to the root directory of the source code you're patching. +<screen> +$ cd the/program/source</screen> + </para> + </listitem> + <listitem> + <para> + If a git repository is not already present, create one and stage all of + the source files. +<screen> $ git init -$ git add .</screen></para></listitem> - <listitem><para>Edit some files to make whatever changes need - to be included in the patch.</para></listitem> - <listitem><para>Use git to create a diff, and pipe the output - to a patch file:<screen> +$ git add .</screen> + </para> + </listitem> + <listitem> + <para> + Edit some files to make whatever changes need to be included in the + patch. + </para> + </listitem> + <listitem> + <para> + Use git to create a diff, and pipe the output to a patch file: +<screen> $ git diff > nixpkgs/pkgs/the/package/0001-changes.patch</screen> - </para></listitem> - </orderedlist></para> -</section> - + </para> + </listitem> + </orderedlist> + </para> + </section> </chapter> diff --git a/doc/configuration.xml b/doc/configuration.xml index 5370265c53ad..4411b4844e99 100644 --- a/doc/configuration.xml +++ b/doc/configuration.xml @@ -1,42 +1,51 @@ <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" 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:</para> - -<itemizedlist> - <listitem><para>The package is thought to be broken, and has had - its <literal>meta.broken</literal> set to - <literal>true</literal>.</para></listitem> - - <listitem><para>The package isn't intended to run on the given system, as none of its <literal>meta.platforms</literal> match the given system.</para></listitem> - - <listitem><para>The package's <literal>meta.license</literal> is set - to a license which is considered to be unfree.</para></listitem> - - <listitem><para>The package has known security vulnerabilities but - has not or can not be updated for some reason, and a list of issues - has been entered in to the package's - <literal>meta.knownVulnerabilities</literal>.</para></listitem> -</itemizedlist> - -<para>Note that all this is checked during evaluation already, -and the check includes any package that is evaluated. -In particular, all build-time dependencies are checked. -<literal>nix-env -qa</literal> will (attempt to) hide any packages -that would be refused. -</para> - -<para>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: + <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: + </para> + <itemizedlist> + <listitem> + <para> + The package is thought to be broken, and has had its + <literal>meta.broken</literal> set to <literal>true</literal>. + </para> + </listitem> + <listitem> + <para> + The package isn't intended to run on the given system, as none of its + <literal>meta.platforms</literal> match the given system. + </para> + </listitem> + <listitem> + <para> + The package's <literal>meta.license</literal> is set to a license which is + considered to be unfree. + </para> + </listitem> + <listitem> + <para> + The package has known security vulnerabilities but has not or can not be + updated for some reason, and a list of issues has been entered in to the + package's <literal>meta.knownVulnerabilities</literal>. + </para> + </listitem> + </itemizedlist> + <para> + Note that all this is checked during evaluation already, and the check + includes any package that is evaluated. In particular, all build-time + dependencies are checked. <literal>nix-env -qa</literal> will (attempt to) + hide any packages that would be refused. + </para> + <para> + 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: <programlisting> { nixpkgs.config = { @@ -44,187 +53,197 @@ configuration.</para> }; } </programlisting> -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: + 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: <programlisting> { allowUnfree = true; } </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.</para> - -<section xml:id="sec-allow-broken"> + </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. + </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.</para> + <para> + 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: - - <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: - + <listitem> + <para> + For allowing the build of a broken package once, you can use an + environment variable for a single invocation of the nix tools: +<programlisting>$ export NIXPKGS_ALLOW_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: <programlisting> { allowBroken = true; } </programlisting> - </para></listitem> + </para> + </listitem> </itemizedlist> -</section> - -<section xml:id="sec-allow-unsupported-system"> + </section> + <section xml:id="sec-allow-unsupported-system"> <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: - - <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: - + <listitem> + <para> + For allowing the build of a broken package once, you can use an + environment variable for a single invocation of the nix tools: +<programlisting>$ export NIXPKGS_ALLOW_UNSUPPORTED_SYSTEM=1</programlisting> + </para> + </listitem> + <listitem> + <para> + For permanently allowing broken packages to be built, you may add + <literal>allowUnsupportedSystem = true;</literal> to your user's + configuration file, like this: <programlisting> { allowUnsupportedSystem = true; } </programlisting> - </para> - </listitem> + </para> + </listitem> </itemizedlist> <para> - The difference between an 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 an 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"> + </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.</para> + <para> + 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: - - <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.</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: + <listitem> + <para> + 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. + </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: <programlisting> { allowUnfreePredicate = (pkg: false); } </programlisting> - </para> - - <para>A more useful example, the following configuration allows - only allows flash player and visual studio code: - + </para> + <para> + A more useful example, the following configuration allows only allows + flash player and visual studio code: <programlisting> { allowUnfreePredicate = (pkg: elem (builtins.parseDrvName pkg.name).name [ "flashplayer" "vscode" ]); } </programlisting> - </para></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. - </para> - - <para>The following example configuration whitelists the - licenses <literal>amd</literal> and <literal>wtfpl</literal>: - + </para> + </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. + </para> + <para> + The following example configuration whitelists the licenses + <literal>amd</literal> and <literal>wtfpl</literal>: <programlisting> { whitelistedLicenses = with stdenv.lib.licenses; [ amd wtfpl ]; } </programlisting> - </para> - - <para>The following example configuration blacklists the - <literal>gpl3</literal> and <literal>agpl3</literal> licenses: - + </para> + <para> + The following example configuration blacklists the <literal>gpl3</literal> + and <literal>agpl3</literal> licenses: <programlisting> { blacklistedLicenses = with stdenv.lib.licenses; [ agpl3 gpl3 ]; } </programlisting> - </para> - </listitem> + </para> + </listitem> </itemizedlist> - <para>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> + 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.</para> + <para> + 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: - - <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.</para> - - <para>The following example configuration permits the - installation of the hypothetically insecure package - <literal>hello</literal>, version <literal>1.2.3</literal>: + <listitem> + <para> + 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. + </para> + <para> + The following example configuration permits the installation of the + hypothetically insecure package <literal>hello</literal>, version + <literal>1.2.3</literal>: <programlisting> { permittedInsecurePackages = [ @@ -232,47 +251,44 @@ distributing the software.</para> ]; } </programlisting> - </para> - </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.</para> - - <para>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: - + </para> + </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. + </para> + <para> + 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: <programlisting> { allowInsecurePredicate = (pkg: (builtins.stringLength (builtins.parseDrvName pkg.name).name) <= 5); } </programlisting> - </para> - - <para>Note that <literal>permittedInsecurePackages</literal> is - only checked if <literal>allowInsecurePredicate</literal> is not - specified. - </para></listitem> + </para> + <para> + Note that <literal>permittedInsecurePackages</literal> is only checked if + <literal>allowInsecurePredicate</literal> is not specified. + </para> + </listitem> </itemizedlist> -</section> - + </section> <!--============================================================--> + <section xml:id="sec-modify-via-packageOverrides"> + <title>Modify packages via <literal>packageOverrides</literal></title> -<section xml:id="sec-modify-via-packageOverrides"><title>Modify -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 return modified -set of packages. - + <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 return + modified set of packages. <programlisting> { packageOverrides = pkgs: rec { @@ -280,30 +296,27 @@ set of packages. }; } </programlisting> - -</para> - -</section> - -<section xml:id="sec-declarative-package-management"> + </para> + </section> + <section xml:id="sec-declarative-package-management"> <title>Declarative Package Management</title> <section xml:id="sec-building-environment"> - <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>: - </para> - - <screen> + <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>: + </para> + +<screen> { packageOverrides = pkgs: with pkgs; { myPackages = pkgs.buildEnv { @@ -314,17 +327,17 @@ set of packages. } </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: - </para> - - <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: + </para> + +<screen> { packageOverrides = pkgs: with pkgs; { myPackages = pkgs.buildEnv { @@ -336,31 +349,30 @@ set of packages. } </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. - </para> - + <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. + </para> </section> <section xml:id="sec-getting-documentation"> - <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. - </para> - - <screen> + <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. + </para> + +<screen> { packageOverrides = pkgs: with pkgs; { myPackages = pkgs.buildEnv { @@ -373,14 +385,13 @@ set of packages. } </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. - </para> + <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. + </para> - <screen> +<screen> { packageOverrides = pkgs: with pkgs; rec { myProfile = writeText "my-profile" '' @@ -412,13 +423,13 @@ cp ${myProfile} $out/etc/profile.d/my-profile.sh } </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: - </para> + <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: + </para> - <screen> +<screen> #!/bin/sh if [ -d $HOME/.nix-profile/etc/profile.d ]; then for i in $HOME/.nix-profile/etc/profile.d/*.sh; do @@ -429,23 +440,22 @@ if [ -d $HOME/.nix-profile/etc/profile.d ]; then fi </screen> - <para> - Now just run <literal>source $HOME/.profile</literal> and you can starting - loading man pages from your environent. - </para> - + <para> + Now just run <literal>source $HOME/.profile</literal> and you can starting + loading man pages from your environent. + </para> </section> <section xml:id="sec-gnu-info-setup"> - <title>GNU info setup</title> + <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. - </para> + <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. + </para> - <screen> +<screen> { packageOverrides = pkgs: with pkgs; rec { myProfile = writeText "my-profile" '' @@ -487,16 +497,13 @@ cp ${myProfile} $out/etc/profile.d/my-profile.sh } </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. - </para> - + <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. + </para> </section> - -</section> - + </section> </chapter> diff --git a/doc/contributing.xml b/doc/contributing.xml index 7aa0df271ff4..d28442b7a2c6 100644 --- a/doc/contributing.xml +++ b/doc/contributing.xml @@ -1,35 +1,35 @@ <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="chap-contributing"> - -<title>Contributing to this documentation</title> - -<para>The DocBook sources of the Nixpkgs manual are in the <filename + <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.</para> - -<para>You can quickly check your edits with <command>make</command>:</para> - + subdirectory of the Nixpkgs repository. + </para> + <para> + You can quickly check your edits with <command>make</command>: + </para> <screen> $ cd /path/to/nixpkgs/doc $ nix-shell [nix-shell]$ make </screen> - -<para>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: - + <para> + 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: <screen> $ cd /path/to/nixpkgs/doc $ nix-shell [nix-shell]$ make clean [nix-shell]$ nix-build . </screen> - -If the build succeeds, the manual will be in -<filename>./result/share/doc/nixpkgs/manual.html</filename>.</para> - + If the build succeeds, the manual will be in + <filename>./result/share/doc/nixpkgs/manual.html</filename>. + </para> </chapter> diff --git a/doc/cross-compilation.xml b/doc/cross-compilation.xml index 0b2b85aeeef6..fe0e0d88d30e 100644 --- a/doc/cross-compilation.xml +++ b/doc/cross-compilation.xml @@ -1,308 +1,469 @@ <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="chap-cross"> - -<title>Cross-compilation</title> - -<section xml:id="sec-cross-intro"> + <title>Cross-compilation</title> + <section xml:id="sec-cross-intro"> <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, but there are advantages to being rigorous about distinguishing build-time vs run-time environments even when one is developing and deploying on the same machine. - Nixpkgs is increasingly adopting the opinion that packages should be written with cross-compilation in mind, and nixpkgs should evaluate in a similar way (by minimizing cross-compilation-specific special cases) whether or not one is cross-compiling. + "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, but there are advantages + to being rigorous about distinguishing build-time vs run-time environments + even when one is developing and deploying on the same machine. Nixpkgs is + increasingly adopting the opinion that packages should be written with + cross-compilation in mind, and nixpkgs should evaluate in a similar way (by + minimizing cross-compilation-specific special cases) whether or not one is + cross-compiling. </para> <para> - 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> - + </section> <!--============================================================--> - -<section xml:id="sec-cross-packaging"> + <section xml:id="sec-cross-packaging"> <title>Packaging in a cross-friendly manner</title> <section> - <title>Platform parameters</title> - <para> - Nixpkgs follows the <link xlink:href="https://gcc.gnu.org/onlinedocs/gccint/Configure-Terms.html">common historical convention of GNU autoconf</link> of distinguishing between 3 types of platform: <wordasword>build</wordasword>, <wordasword>host</wordasword>, and <wordasword>target</wordasword>. + <title>Platform parameters</title> - In summary, <wordasword>build</wordasword> is the platform on which a package is being built, <wordasword>host</wordasword> is the platform on which it is to run. The third attribute, <wordasword>target</wordasword>, is relevant only for certain specific compilers and build tools. - </para> + <para> + Nixpkgs follows the + <link xlink:href="https://gcc.gnu.org/onlinedocs/gccint/Configure-Terms.html">common + historical convention of GNU autoconf</link> of distinguishing between 3 + types of platform: <wordasword>build</wordasword>, + <wordasword>host</wordasword>, and <wordasword>target</wordasword>. In + summary, <wordasword>build</wordasword> is the platform on which a package + is being built, <wordasword>host</wordasword> is the platform on which it + is to run. The third attribute, <wordasword>target</wordasword>, is + relevant only for certain specific compilers and build tools. + </para> - <para> - In Nixpkgs, these three platforms are defined as attribute sets under the names <literal>buildPlatform</literal>, <literal>hostPlatform</literal>, and <literal>targetPlatform</literal>. - All three are always defined as attributes in the standard environment, and at the top level. That means one can get at them just like a dependency in a function that is imported with <literal>callPackage</literal>: - <programlisting>{ stdenv, buildPlatform, hostPlatform, fooDep, barDep, .. }: ...buildPlatform...</programlisting>, or just off <varname>stdenv</varname>: - <programlisting>{ stdenv, fooDep, barDep, .. }: ...stdenv.buildPlatform...</programlisting>. - </para> - <variablelist> - <varlistentry> - <term><varname>buildPlatform</varname></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 be safe to ignore. - </para></listitem> - </varlistentry> - <varlistentry> - <term><varname>hostPlatform</varname></term> - <listitem><para> - The "host platform" is the platform on which a package will be run. - This is the simplest platform to understand, but also the one with the worst name. - </para></listitem> - </varlistentry> - <varlistentry> - <term><varname>targetPlatform</varname></term> - <listitem> - <para> - The "target platform" attribute is, unlike the other two attributes, not actually fundamental to the process of building software. - Instead, it is only relevant for compatibility with building certain specific compilers and build tools. - It can be safely ignored for all other packages. - </para> - <para> - 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 specifying this single "target platform" is thus pushed to build time of the compiler. - The root cause of this mistake is often that the compiler (which will be run on the host) and the the standard library/runtime (which will be run on the target) are built by a single build process. - </para> - <para> - 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. - </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: - </para> - <variablelist> - <varlistentry> - <term><varname>system</varname></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. - This format isn't very standard, but has built-in support in Nix, such as the <varname>builtins.currentSystem</varname> impure string. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>config</varname></term> - <listitem> - <para> - This is a 3- or 4- component shorthand for the platform. - Examples of this would be "x86_64-unknown-linux-gnu" and "aarch64-apple-darwin14". - This is a standard format called the "LLVM target triple", as they are pioneered by LLVM and traditionally just used for the <varname>targetPlatform</varname>. - This format is strictly more informative than the "Nix host double", as the previous format could analogously be termed. - This needs a better name than <varname>config</varname>! - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>parsed</varname></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>. - [Technically, only one need be specified and the others can be inferred, though the precision of inference may not be very good.] - See <literal>lib.systems.parse</literal> for the exact representation. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>libc</varname></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>. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>is*</varname></term> - <listitem> - <para> - These predicates are defined in <literal>lib.systems.inspect</literal>, and slapped on 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> - <varlistentry> - <term><varname>platform</varname></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! - </para> - </listitem> - </varlistentry> - </variablelist> + <para> + In Nixpkgs, these three platforms are defined as attribute sets under the + names <literal>buildPlatform</literal>, <literal>hostPlatform</literal>, + and <literal>targetPlatform</literal>. All three are always defined as + attributes in the standard environment, and at the top level. That means + one can get at them just like a dependency in a function that is imported + with <literal>callPackage</literal>: +<programlisting>{ stdenv, buildPlatform, hostPlatform, fooDep, barDep, .. }: ...buildPlatform...</programlisting> + , or just off <varname>stdenv</varname>: +<programlisting>{ stdenv, fooDep, barDep, .. }: ...stdenv.buildPlatform...</programlisting> + . + </para> + + <variablelist> + <varlistentry> + <term><varname>buildPlatform</varname> + </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 be safe to ignore. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>hostPlatform</varname> + </term> + <listitem> + <para> + The "host platform" is the platform on which a package will be run. This + is the simplest platform to understand, but also the one with the worst + name. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>targetPlatform</varname> + </term> + <listitem> + <para> + The "target platform" attribute is, unlike the other two attributes, not + actually fundamental to the process of building software. Instead, it is + only relevant for compatibility with building certain specific compilers + and build tools. It can be safely ignored for all other packages. + </para> + <para> + 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 specifying this single "target platform" + is thus pushed to build time of the compiler. The root cause of this + mistake is often that the compiler (which will be run on the host) and + the the standard library/runtime (which will be run on the target) are + built by a single build process. + </para> + <para> + 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. + </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: + </para> + + <variablelist> + <varlistentry> + <term><varname>system</varname> + </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. This format isn't very + standard, but has built-in support in Nix, such as the + <varname>builtins.currentSystem</varname> impure string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>config</varname> + </term> + <listitem> + <para> + This is a 3- or 4- component shorthand for the platform. Examples of + this would be "x86_64-unknown-linux-gnu" and "aarch64-apple-darwin14". + This is a standard format called the "LLVM target triple", as they are + pioneered by LLVM and traditionally just used for the + <varname>targetPlatform</varname>. This format is strictly more + informative than the "Nix host double", as the previous format could + analogously be termed. This needs a better name than + <varname>config</varname>! + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>parsed</varname> + </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>. [Technically, only one need + be specified and the others can be inferred, though the precision of + inference may not be very good.] See + <literal>lib.systems.parse</literal> for the exact representation. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>libc</varname> + </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>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>is*</varname> + </term> + <listitem> + <para> + These predicates are defined in <literal>lib.systems.inspect</literal>, + and slapped on 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> + <varlistentry> + <term><varname>platform</varname> + </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! + </para> + </listitem> + </varlistentry> + </variablelist> </section> <section> - <title>Specifying Dependencies</title> - <para> - In this section we explore the relationship between both runtime and buildtime dependencies and the 3 Autoconf platforms. - </para> - <para> - A runtime dependency between 2 packages implies that between them both the host and target 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, implies a shift in platforms between the depending package and the depended-on package. - The meaning of a build time dependency is that to build the depending package we need to be able to run the depended-on's package. - The depending package's build platform is therefore equal to the depended-on package's host platform. - Analogously, the depending package's host platform is equal to the depended-on package's target platform. - </para> - <para> - In this manner, given the 3 platforms for one package, we can determine the three platforms for all its transitive dependencies. - This is the most important guiding principle behind cross-compilation with Nixpkgs, and will be called the <wordasword>sliding window principle</wordasword>. - </para> + <title>Specifying Dependencies</title> + + <para> + In this section we explore the relationship between both runtime and + buildtime dependencies and the 3 Autoconf platforms. + </para> + + <para> + A runtime dependency between 2 packages implies that between them both the + host and target 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, implies a shift in platforms between the + depending package and the depended-on package. The meaning of a build time + dependency is that to build the depending package we need to be able to run + the depended-on's package. The depending package's build platform is + therefore equal to the depended-on package's host platform. Analogously, + the depending package's host platform is equal to the depended-on package's + target platform. + </para> + + <para> + In this manner, given the 3 platforms for one package, we can determine the + three platforms for all its transitive dependencies. This is the most + important guiding principle behind cross-compilation with Nixpkgs, and will + be called the <wordasword>sliding window principle</wordasword>. + </para> + + <para> + Some examples will probably make this clearer. If a package is being built + with a <literal>(build, host, target)</literal> platform triple of + <literal>(foo, bar, bar)</literal>, then its build-time dependencies would + have a triple of <literal>(foo, foo, bar)</literal>, and <emphasis>those + packages'</emphasis> build-time dependencies would have triple of + <literal>(foo, foo, foo)</literal>. In other words, it should take two + "rounds" of following build-time dependency edges before one reaches a + fixed point where, by the sliding window principle, the platform triple no + longer changes. Indeed, this happens with cross compilation, where only + rounds of native dependencies starting with the second necessarily coincide + with native packages. + </para> + + <note> <para> - Some examples will probably make this clearer. - If a package is being built with a <literal>(build, host, target)</literal> platform triple of <literal>(foo, bar, bar)</literal>, then its build-time dependencies would have a triple of <literal>(foo, foo, bar)</literal>, and <emphasis>those packages'</emphasis> build-time dependencies would have triple of <literal>(foo, foo, foo)</literal>. - In other words, it should take two "rounds" of following build-time dependency edges before one reaches a fixed point where, by the sliding window principle, the platform triple no longer changes. - Indeed, this happens with cross compilation, where only rounds of native dependencies starting with the second necessarily coincide with native packages. + The depending package's target platform is unconstrained by the sliding + window principle, which makes sense in that one can in principle build + cross compilers targeting arbitrary platforms. </para> - <note><para> - The depending package's target platform is unconstrained by the sliding window principle, which makes sense in that one can in principle build cross compilers targeting arbitrary platforms. - </para></note> + </note> + + <para> + How does this work in practice? Nixpkgs is now structured so that + build-time dependencies are taken from <varname>buildPackages</varname>, + whereas run-time dependencies are taken from the top level attribute set. + For example, <varname>buildPackages.gcc</varname> should be used at build + time, while <varname>gcc</varname> should be used at run time. Now, for + most of Nixpkgs's history, there was no <varname>buildPackages</varname>, + and most packages have not been refactored to use it explicitly. Instead, + one can use the six (<emphasis>gasp</emphasis>) attributes used for + specifying dependencies as documented in + <xref linkend="ssec-stdenv-dependencies"/>. We "splice" together the + run-time and build-time package sets with <varname>callPackage</varname>, + and then <varname>mkDerivation</varname> for each of four attributes pulls + the right derivation out. This splicing can be skipped when not cross + compiling as the package sets are the same, but is a bit slow for cross + compiling. Because of this, a best-of-both-worlds solution is in the works + with no splicing or explicit access of <varname>buildPackages</varname> + needed. For now, feel free to use either method. + </para> + + <note> <para> - How does this work in practice? Nixpkgs is now structured so that build-time dependencies are taken from <varname>buildPackages</varname>, whereas run-time dependencies are taken from the top level attribute set. - For example, <varname>buildPackages.gcc</varname> should be used at build time, while <varname>gcc</varname> should be used at run time. - Now, for most of Nixpkgs's history, there was no <varname>buildPackages</varname>, and most packages have not been refactored to use it explicitly. - Instead, one can use the six (<emphasis>gasp</emphasis>) attributes used for specifying dependencies as documented in <xref linkend="ssec-stdenv-dependencies"/>. - We "splice" together the run-time and build-time package sets with <varname>callPackage</varname>, and then <varname>mkDerivation</varname> for each of four attributes pulls the right derivation out. - This splicing can be skipped when not cross compiling as the package sets are the same, but is a bit slow for cross compiling. - Because of this, a best-of-both-worlds solution is in the works with no splicing or explicit access of <varname>buildPackages</varname> needed. - For now, feel free to use either method. + There is also a "backlink" <varname>targetPackages</varname>, yielding a + package set whose <varname>buildPackages</varname> is the current package + set. This is a hack, though, to accommodate compilers with lousy build + systems. Please do not use this unless you are absolutely sure you are + packaging such a compiler and there is no other way. </para> - <note><para> - There is also a "backlink" <varname>targetPackages</varname>, yielding a package set whose <varname>buildPackages</varname> is the current package set. - This is a hack, though, to accommodate compilers with lousy build systems. - Please do not use this unless you are absolutely sure you are packaging such a compiler and there is no other way. - </para></note> + </note> </section> <section> - <title>Cross packagaing cookbook</title> - <para> - Some frequently problems when packaging for cross compilation are good to just spell and answer. - Ideally the information above is exhaustive, so this section cannot provide any new information, - but its ludicrous and cruel to expect everyone to spend effort working through the interaction of many features just to figure out the same answer to the same common problem. - Feel free to add to this list! - </para> - <qandaset> - <qandaentry> - <question><para> - What if my package's build system needs to build a C program to be run under the build environment? - </para></question> - <answer><para> - <programlisting>depsBuildBuild = [ buildPackages.stdenv.cc ];</programlisting> - Add it to your <function>mkDerivation</function> invocation. - </para></answer> - </qandaentry> - <qandaentry> - <question><para> - My package fails to find <command>ar</command>. - </para></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`. - </para></answer> - </qandaentry> - <qandaentry> - <question><para> - My package's testsuite needs to run host platform code. - </para></question> - <answer><para> - <programlisting>doCheck = stdenv.hostPlatform != stdenv.buildPlatfrom;</programlisting> - Add it to your <function>mkDerivation</function> invocation. - </para></answer> - </qandaentry> - </qandaset> - </section> -</section> + <title>Cross packagaing cookbook</title> -<!--============================================================--> + <para> + Some frequently problems when packaging for cross compilation are good to + just spell and answer. Ideally the information above is exhaustive, so this + section cannot provide any new information, but its ludicrous and cruel to + expect everyone to spend effort working through the interaction of many + features just to figure out the same answer to the same common problem. + Feel free to add to this list! + </para> -<section xml:id="sec-cross-usage"> + <qandaset> + <qandaentry> + <question> + <para> + What if my package's build system needs to build a C program to be run + under the build environment? + </para> + </question> + <answer> + <para> +<programlisting>depsBuildBuild = [ buildPackages.stdenv.cc ];</programlisting> + Add it to your <function>mkDerivation</function> invocation. + </para> + </answer> + </qandaentry> + <qandaentry> + <question> + <para> + My package fails to find <command>ar</command>. + </para> + </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`. + </para> + </answer> + </qandaentry> + <qandaentry> + <question> + <para> + My package's testsuite needs to run host platform code. + </para> + </question> + <answer> + <para> +<programlisting>doCheck = stdenv.hostPlatform != stdenv.buildPlatfrom;</programlisting> + Add it to your <function>mkDerivation</function> invocation. + </para> + </answer> + </qandaentry> + </qandaset> + </section> + </section> +<!--============================================================--> + <section xml:id="sec-cross-usage"> <title>Cross-building packages</title> - <note><para> - More information needs to moved from the old wiki, especially <link xlink:href="https://nixos.org/wiki/CrossCompiling" />, for this section. - </para></note> + + <note> + <para> + More information needs to moved from the old wiki, especially + <link xlink:href="https://nixos.org/wiki/CrossCompiling" />, for this + section. + </para> + </note> + <para> - Nixpkgs can be instantiated with <varname>localSystem</varname> alone, in which case there is no cross compiling and everything is built by and for that system, - or also with <varname>crossSystem</varname>, in which case packages run on the latter, but all building happens on the former. - Both parameters take the same schema as the 3 (build, host, and target) platforms defined in the previous section. - As mentioned above, <literal>lib.systems.examples</literal> has some platforms which are used as arguments for these parameters in practice. - You can use them programmatically, or on the command line: <programlisting> + 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> </para> + <note> - <para> - Eventually we would like to make these platform examples an unnecessary convenience so that <programlisting> + <para> + 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. - </para> + 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. - </para> + <para> + Many sources (manual, wiki, etc) probably mention passing + <varname>system</varname>, <varname>platform</varname>, along with the + optional <varname>crossSystem</varname> to nixpkgs: <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 then is <varname>crossSystem</varname> should be null when one doesn't want to cross-compile, while the <varname>*Platform</varname>s are always non-null. - <varname>localSystem</varname> is always non-null. + 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 then is + <varname>crossSystem</varname> should be null when one doesn't want to + cross-compile, while the <varname>*Platform</varname>s are always non-null. + <varname>localSystem</varname> is always non-null. </para> -</section> - + </section> <!--============================================================--> - -<section xml:id="sec-cross-infra"> + <section xml:id="sec-cross-infra"> <title>Cross-compilation infrastructure</title> - <para>To be written.</para> - <note><para> - If one explores nixpkgs, they will see derivations with names like <literal>gccCross</literal>. - Such <literal>*Cross</literal> derivations is a holdover from before we properly distinguished between the host and target platforms - —the derivation with "Cross" in the name covered the <literal>build = host != target</literal> case, while the other covered the <literal>host = target</literal>, with build platform the same or not based on whether one was using its <literal>.nativeDrv</literal> or <literal>.crossDrv</literal>. - This ugliness will disappear soon. - </para></note> -</section> + <para> + To be written. + </para> + + <note> + <para> + If one explores nixpkgs, they will see derivations with names like + <literal>gccCross</literal>. Such <literal>*Cross</literal> derivations is + a holdover from before we properly distinguished between the host and + target platforms —the derivation with "Cross" in the name covered the + <literal>build = host != target</literal> case, while the other covered the + <literal>host = target</literal>, with build platform the same or not based + on whether one was using its <literal>.nativeDrv</literal> or + <literal>.crossDrv</literal>. This ugliness will disappear soon. + </para> + </note> + </section> </chapter> diff --git a/doc/default.nix b/doc/default.nix index e5be364506ff..0d95d3f04573 100644 --- a/doc/default.nix +++ b/doc/default.nix @@ -7,7 +7,7 @@ in pkgs.stdenv.mkDerivation { name = "nixpkgs-manual"; - buildInputs = with pkgs; [ pandoc libxml2 libxslt zip jing ]; + buildInputs = with pkgs; [ pandoc libxml2 libxslt zip jing xmlformat ]; src = ./.; @@ -18,6 +18,7 @@ pkgs.stdenv.mkDerivation { HIGHLIGHTJS = pkgs.documentation-highlighter; XSL = "${pkgs.docbook5_xsl}/xml/xsl"; RNG = "${pkgs.docbook5}/xml/rng/docbook/docbook.rng"; + XMLFORMAT_CONFIG = ../nixos/doc/xmlformat.conf; xsltFlags = lib.concatStringsSep " " [ "--param section.autolabel 1" "--param section.label.includes.component.label 1" diff --git a/doc/functions.xml b/doc/functions.xml index b2e450972947..155ea2bd0043 100644 --- a/doc/functions.xml +++ b/doc/functions.xml @@ -1,144 +1,139 @@ <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="chap-functions"> - -<title>Functions reference</title> - -<para> - The nixpkgs repository has several utility functions to manipulate Nix expressions. -</para> - -<section xml:id="sec-overrides"> + <title>Functions reference</title> + <para> + The nixpkgs repository has several utility functions to manipulate Nix + expressions. + </para> + <section xml:id="sec-overrides"> <title>Overriding</title> <para> - Sometimes one wants to override parts of - <literal>nixpkgs</literal>, e.g. derivation attributes, the results of - derivations or even the whole package set. + Sometimes one wants to override parts of <literal>nixpkgs</literal>, e.g. + derivation attributes, the results of derivations or even the whole package + set. </para> <section xml:id="sec-pkg-override"> - <title><pkg>.override</title> + <title><pkg>.override</title> - <para> - The function <varname>override</varname> is usually available for all the - derivations in the nixpkgs expression (<varname>pkgs</varname>). - </para> - <para> - It is used to override the arguments passed to a function. - </para> - <para> - Example usages: + <para> + The function <varname>override</varname> is usually available for all the + derivations in the nixpkgs expression (<varname>pkgs</varname>). + </para> + + <para> + It is used to override the arguments passed to a function. + </para> - <programlisting>pkgs.foo.override { arg1 = val1; arg2 = val2; ... }</programlisting> - <programlisting>import pkgs.path { overlays = [ (self: super: { + <para> + Example usages: +<programlisting>pkgs.foo.override { arg1 = val1; arg2 = val2; ... }</programlisting> +<programlisting>import pkgs.path { overlays = [ (self: super: { foo = super.foo.override { barSupport = true ; }; })]};</programlisting> - <programlisting>mypkg = pkgs.callPackage ./mypkg.nix { +<programlisting>mypkg = pkgs.callPackage ./mypkg.nix { mydep = pkgs.mydep.override { ... }; }</programlisting> - </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. - </para> - + </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. + </para> </section> <section xml:id="sec-pkg-overrideAttrs"> - <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>. - </para> - - <para> - Example usage: - - <programlisting>helloWithDebug = pkgs.hello.overrideAttrs (oldAttrs: rec { + <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>. + </para> + + <para> + Example usage: +<programlisting>helloWithDebug = pkgs.hello.overrideAttrs (oldAttrs: rec { separateDebugInfo = true; });</programlisting> - </para> + </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. - </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. + </para> + + <para> + The argument <varname>oldAttrs</varname> is conventionally used to refer to + the attr set originally passed to <varname>stdenv.mkDerivation</varname>. + </para> + <note> <para> - The argument <varname>oldAttrs</varname> is conventionally used to refer to - the attr set originally passed to <varname>stdenv.mkDerivation</varname>. + 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>sdenv.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 involves less typing. </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>sdenv.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 involves less typing. - </para> - </note> - + </note> </section> - <section xml:id="sec-pkg-overrideDerivation"> - <title><pkg>.overrideDerivation</title> - - <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>. - </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>. - </para> - </warning> + <title><pkg>.overrideDerivation</title> + <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. + 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> - Example usage: - - <programlisting>mySed = pkgs.gnused.overrideDerivation (oldAttrs: { + 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. + </para> + + <para> + Example usage: +<programlisting>mySed = pkgs.gnused.overrideDerivation (oldAttrs: { name = "sed-4.2.2-pre"; src = fetchurl { url = ftp://alpha.gnu.org/gnu/sed/sed-4.2.2-pre.tar.bz2; @@ -146,98 +141,90 @@ }; patches = []; });</programlisting> - </para> + </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. - </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. + </para> + + <para> + The argument <varname>oldAttrs</varname> is used to refer to the attribute + set of the original derivation. + </para> + <note> <para> - The argument <varname>oldAttrs</varname> is used to refer to the attribute set of - the original derivation. + 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> - <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. - </para> - </note> - + </note> </section> <section xml:id="sec-lib-makeOverridable"> - <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. - </para> + <title>lib.makeOverridable</title> - <para> - Example usage: + <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. + </para> - <programlisting>f = { a, b }: { result = a+b; } + <para> + Example usage: +<programlisting>f = { a, b }: { result = a+b; } c = lib.makeOverridable f { a = 1; b = 2; }</programlisting> - - </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. - </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. - </para> - + </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. + </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. + </para> </section> - -</section> - -<section xml:id="sec-generators"> + </section> + <section xml:id="sec-generators"> <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> @@ -270,7 +257,9 @@ in customToINI { } </programlisting> - <para>This will produce the following INI file as nix string:</para> + <para> + This will produce the following INI file as nix string: + </para> <programlisting> [main] @@ -284,111 +273,138 @@ str\:ange:"very::strange" merge:"diff3" </programlisting> - <note><para>Nix store paths can be converted to strings by enclosing a - derivation attribute like so: <code>"${drv}"</code>.</para></note> + <note> + <para> + 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> - -<section xml:id="sec-debug"> + </section> + <section xml:id="sec-debug"> <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.</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.</para> -</section> - + <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. + </para> -<section xml:id="sec-fhs-environments"> + <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. + </para> + </section> + <section xml:id="sec-fhs-environments"> <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> - <varlistentry> - <term><literal>name</literal></term> - - <listitem><para>Environment name.</para></listitem> - </varlistentry> - - <varlistentry> - <term><literal>targetPkgs</literal></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.</para></listitem> - </varlistentry> - - <varlistentry> - <term><literal>multiPkgs</literal></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.</para></listitem> - </varlistentry> - - <varlistentry> - <term><literal>extraBuildCommands</literal></term> - - <listitem><para>Additional commands to be executed for finalizing the - directory structure.</para></listitem> - </varlistentry> - - <varlistentry> - <term><literal>extraBuildCommandsMulti</literal></term> - - <listitem><para>Like <literal>extraBuildCommands</literal>, but - executed only on multilib architectures.</para></listitem> - </varlistentry> - - <varlistentry> - <term><literal>extraOutputsToInstall</literal></term> - - <listitem><para>Additional derivation outputs to be linked for both - target and multi-architecture packages.</para></listitem> - </varlistentry> - - <varlistentry> - <term><literal>extraInstallCommands</literal></term> - - <listitem><para>Additional commands to be executed for finalizing the - derivation with runner script.</para></listitem> - </varlistentry> - - <varlistentry> - <term><literal>runScript</literal></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>.</para></listitem> - </varlistentry> + <varlistentry> + <term><literal>name</literal> + </term> + <listitem> + <para> + Environment name. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>targetPkgs</literal> + </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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>multiPkgs</literal> + </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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>extraBuildCommands</literal> + </term> + <listitem> + <para> + Additional commands to be executed for finalizing the directory + structure. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>extraBuildCommandsMulti</literal> + </term> + <listitem> + <para> + Like <literal>extraBuildCommands</literal>, but executed only on multilib + architectures. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>extraOutputsToInstall</literal> + </term> + <listitem> + <para> + Additional derivation outputs to be linked for both target and + multi-architecture packages. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>extraInstallCommands</literal> + </term> + <listitem> + <para> + Additional commands to be executed for finalizing the derivation with + runner script. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>runScript</literal> + </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>. + </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[ @@ -413,50 +429,49 @@ merge:"diff3" ]]></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. - </para> -</section> - -<section xml:id="sec-pkgs-dockerTools"> -<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. -</para> - -<warning> - <para> - The <varname>dockerTools</varname> API is unstable and may be subject to - backwards-incompatible changes in the future. - </para> -</warning> - -<section xml:id="ssec-pkgs-dockerTools-buildImage"> - <title>buildImage</title> - - <para> - This function is analogous to the <command>docker build</command> command, - in that can 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>. + 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> + <section xml:id="sec-pkgs-dockerTools"> + <title>pkgs.dockerTools</title> <para> - The parameters of <varname>buildImage</varname> with relative example values are - described below: + <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> - <example xml:id='ex-dockerTools-buildImage'><title>Docker build</title> - <programlisting> + <warning> + <para> + The <varname>dockerTools</varname> API is unstable and may be subject to + backwards-incompatible changes in the future. + </para> + </warning> + + <section xml:id="ssec-pkgs-dockerTools-buildImage"> + <title>buildImage</title> + + <para> + This function is analogous to the <command>docker build</command> command, + in that can 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: + </para> + + <example xml:id='ex-dockerTools-buildImage'> + <title>Docker build</title> +<programlisting> buildImage { name = "redis"; <co xml:id='ex-dockerTools-buildImage-1' /> tag = "latest"; <co xml:id='ex-dockerTools-buildImage-2' /> @@ -480,154 +495,148 @@ merge:"diff3" }; } </programlisting> - </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. - </para> - - <calloutlist> - <callout arearefs='ex-dockerTools-buildImage-1'> + </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. + </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>. + </para> + </callout> + <callout arearefs='ex-dockerTools-buildImage-2'> + <para> + <varname>tag</varname> specifies the tag of the resulting image. By + default it's <literal>latest</literal>. + </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>. + </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. + </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. + </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>. + </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>. + <note> + <para> + 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>. + </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. + </para> + + <para> + 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>. + </para> + + <para> + It is possible to inspect the arguments with which an image was built using + its <varname>buildArgs</varname> attribute. + </para> + + <note> <para> - <varname>name</varname> specifies the name of the resulting image. - This is the only required argument for <varname>buildImage</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> - </callout> + </note> - <callout arearefs='ex-dockerTools-buildImage-2'> + <note> <para> - <varname>tag</varname> specifies the tag of the resulting image. - By default it's <literal>latest</literal>. + 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> - </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>. - </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. - </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. - </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>. - </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>. - - <note> - <para> - 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>. - </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. - </para> - - <para> - 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>. - </para> - - <para> - 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>. - </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>. - </para> - </note> - -</section> + </note> + </section> -<section xml:id="ssec-pkgs-dockerTools-fetchFromRegistry"> - <title>pullImage</title> + <section xml:id="ssec-pkgs-dockerTools-fetchFromRegistry"> + <title>pullImage</title> - <para> - This function is analogous to the <command>docker pull</command> command, - in that can be used to fetch a Docker image from a Docker registry. - Currently only registry <literal>v1</literal> is supported. - By default <link xlink:href="https://hub.docker.com/">Docker Hub</link> - is used to pull images. - </para> + <para> + This function is analogous to the <command>docker pull</command> command, + in that can be used to fetch a Docker image from a Docker registry. + Currently only registry <literal>v1</literal> is supported. By default + <link xlink:href="https://hub.docker.com/">Docker Hub</link> is used to + pull images. + </para> - <para> - Its parameters are described in the example below: - </para> + <para> + Its parameters are described in the example below: + </para> - <example xml:id='ex-dockerTools-pullImage'><title>Docker pull</title> - <programlisting> + <example xml:id='ex-dockerTools-pullImage'> + <title>Docker pull</title> +<programlisting> pullImage { imageName = "debian"; <co xml:id='ex-dockerTools-pullImage-1' /> imageTag = "jessie"; <co xml:id='ex-dockerTools-pullImage-2' /> @@ -638,80 +647,78 @@ merge:"diff3" registryVersion = "v1"; } </programlisting> - </example> - - <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>library/debian</literal>). - This argument is required. - </para> - </callout> - - <callout arearefs='ex-dockerTools-pullImage-2'> - <para> - <varname>imageTag</varname> specifies the tag of the image to be downloaded. - By default it's <literal>latest</literal>. - </para> - </callout> - - <callout arearefs='ex-dockerTools-pullImage-3'> - <para> - <varname>imageId</varname>, if specified this exact image will be fetched, instead - of <varname>imageName/imageTag</varname>. However, the resulting repository - will still be named <varname>imageName/imageTag</varname>. - By default it's <literal>null</literal>. - </para> - </callout> - - <callout arearefs='ex-dockerTools-pullImage-4'> - <para> - <varname>sha256</varname> is the checksum of the whole fetched image. - This argument is required. - </para> + </example> + + <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>library/debian</literal>). This argument is required. + </para> + </callout> + <callout arearefs='ex-dockerTools-pullImage-2'> + <para> + <varname>imageTag</varname> specifies the tag of the image to be + downloaded. By default it's <literal>latest</literal>. + </para> + </callout> + <callout arearefs='ex-dockerTools-pullImage-3'> + <para> + <varname>imageId</varname>, if specified this exact image will be + fetched, instead of <varname>imageName/imageTag</varname>. However, the + resulting repository will still be named + <varname>imageName/imageTag</varname>. By default it's + <literal>null</literal>. + </para> + </callout> + <callout arearefs='ex-dockerTools-pullImage-4'> + <para> + <varname>sha256</varname> is the checksum of the whole fetched image. + This argument is required. + </para> + <note> + <para> + The checksum is computed on the unpacked directory, not on the final + tarball. + </para> + </note> + </callout> + <callout arearefs='ex-dockerTools-pullImage-5'> + <para> + In the above example the default values are shown for the variables + <varname>indexUrl</varname> and <varname>registryVersion</varname>. Hence + by default the Docker.io registry is used to pull the images. + </para> + </callout> + </calloutlist> + </section> - <note> - <para>The checksum is computed on the unpacked directory, not on the final tarball.</para> - </note> + <section xml:id="ssec-pkgs-dockerTools-exportImage"> + <title>exportImage</title> - </callout> + <para> + This function is analogous to the <command>docker export</command> command, + in that can used to flatten a Docker image that contains multiple layers. + It is in fact the result of the merge of all the layers of the image. As + such, the result is suitable for being imported in Docker with + <command>docker import</command>. + </para> - <callout arearefs='ex-dockerTools-pullImage-5'> + <note> <para> - In the above example the default values are shown for the variables - <varname>indexUrl</varname> and <varname>registryVersion</varname>. - Hence by default the Docker.io registry is used to pull the images. + Using this function requires the <literal>kvm</literal> device to be + available. </para> - </callout> - </calloutlist> - -</section> - -<section xml:id="ssec-pkgs-dockerTools-exportImage"> - <title>exportImage</title> - - <para> - This function is analogous to the <command>docker export</command> command, - in that can used to flatten a Docker image that contains multiple layers. - It is in fact the result of the merge of all the layers of the image. - As such, the result is suitable for being imported in Docker - with <command>docker import</command>. - </para> + </note> - <note> - <para> - Using this function requires the <literal>kvm</literal> - device to be available. - </para> - </note> - - <para> - The parameters of <varname>exportImage</varname> are the following: - </para> + <para> + The parameters of <varname>exportImage</varname> are the following: + </para> - <example xml:id='ex-dockerTools-exportImage'><title>Docker export</title> - <programlisting> + <example xml:id='ex-dockerTools-exportImage'> + <title>Docker export</title> +<programlisting> exportImage { fromImage = someLayeredImage; fromImageName = null; @@ -720,33 +727,35 @@ merge:"diff3" name = someLayeredImage.name; } </programlisting> - </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. - </para> - - <para> - The <varname>name</varname> argument is the name of the derivation output, - which defaults to <varname>fromImage.name</varname>. - </para> -</section> + </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. + </para> + + <para> + The <varname>name</varname> argument is the name of the derivation output, + which defaults to <varname>fromImage.name</varname>. + </para> + </section> -<section xml:id="ssec-pkgs-dockerTools-shadowSetup"> - <title>shadowSetup</title> + <section xml:id="ssec-pkgs-dockerTools-shadowSetup"> + <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: - </para> + <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: + </para> - <example xml:id='ex-dockerTools-shadowSetup'><title>Shadow base files</title> - <programlisting> + <example xml:id='ex-dockerTools-shadowSetup'> + <title>Shadow base files</title> +<programlisting> buildImage { name = "shadow-basic"; @@ -760,16 +769,13 @@ merge:"diff3" ''; } </programlisting> - </example> - - <para> - Creating base files like <literal>/etc/passwd</literal> or - <literal>/etc/login.defs</literal> are necessary for shadow-utils to - manipulate users and groups. - </para> - -</section> - -</section> + </example> + <para> + Creating base files like <literal>/etc/passwd</literal> or + <literal>/etc/login.defs</literal> are necessary for shadow-utils to + manipulate users and groups. + </para> + </section> + </section> </chapter> diff --git a/doc/languages-frameworks/beam.xml b/doc/languages-frameworks/beam.xml index 1a18ed27237c..ac7a83ed4265 100644 --- a/doc/languages-frameworks/beam.xml +++ b/doc/languages-frameworks/beam.xml @@ -1,124 +1,137 @@ <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-beam"> + <title>BEAM Languages (Erlang, Elixir & LFE)</title> - <title>BEAM Languages (Erlang, Elixir & LFE)</title> - <section xml:id="beam-introduction"> - <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. - </para> - </section> - <section xml:id="beam-structure"> - <title>Structure</title> - <para> - 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>). - </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>. - </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>. - </para> + <section xml:id="beam-introduction"> + <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. + </para> + </section> + + <section xml:id="beam-structure"> + <title>Structure</title> + + <para> + All BEAM-related expressions are available via the top-level + <literal>beam</literal> attribute, which includes: + </para> + + <itemizedlist> + <listitem> <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>. + <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> - Many Erlang/OTP distributions available in - <literal>beam.interpreters</literal> have versions with ODBC and/or Java - enabled. For example, there's - <literal>beam.interpreters.erlangR19_odbc_javac</literal>, which - corresponds to <literal>beam.interpreters.erlangR19</literal>. + <literal>packages</literal>: a set of package sets, each compiled with a + specific Erlang/OTP version, e.g. + <literal>beam.packages.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. - </para> - </section> - <section xml:id="build-tools"> + </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>. + </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>. + </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>. + </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. + </para> + </section> + + <section xml:id="build-tools"> <title>Build Tools</title> + <section xml:id="build-tools-rebar3"> - <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: - <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. - </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 + <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: + <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. + </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 linkend="rebar3-packages"/>. - </para> - </listitem> - </itemizedlist> - </para> + </para> + </listitem> + </itemizedlist> + </para> </section> + <section xml:id="build-tools-other"> - <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. - </para> + <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. + </para> </section> -</section> + </section> -<section xml:id="how-to-install-beam-packages"> + <section xml:id="how-to-install-beam-packages"> <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> - <programlisting> +<programlisting> $ nix-env -f "<nixpkgs>" -qaP -A beamPackages beamPackages.esqlite esqlite-0.2.1 beamPackages.goldrush goldrush-0.1.7 @@ -128,34 +141,43 @@ beamPackages.lager lager-3.0.2 beamPackages.meck meck-0.8.3 beamPackages.rebar3-pc pc-1.1.0 </programlisting> + <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> - <programlisting> + +<programlisting> $ nix-env -f "<nixpkgs>" -iA beamPackages.ibrowse </programlisting> + <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> -<section xml:id="packaging-beam-applications"> + </section> + + <section xml:id="packaging-beam-applications"> <title>Packaging BEAM Applications</title> + <section xml:id="packaging-erlang-applications"> - <title>Erlang Applications</title> - <section xml:id="rebar3-packages"> - <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: - </para> - <programlisting> + <title>Erlang Applications</title> + + <section xml:id="rebar3-packages"> + <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: + </para> + +<programlisting> { stdenv, fetchFromGitHub, buildRebar3, ibrowse, jsx, erlware_commons }: buildRebar3 rec { @@ -172,33 +194,40 @@ $ nix-env -f "<nixpkgs>" -iA beamPackages.ibrowse beamDeps = [ ibrowse jsx erlware_commons ]; } </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>. - </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. - </para> - <para> - If a package needs to compile native code via Rebar3's port compilation - mechanism, add <literal>compilePort = true;</literal> to the derivation. - </para> - </section> - <section xml:id="erlang-mk-packages"> - <title>Erlang.mk Packages</title> - <para> - Erlang.mk functions similarly to Rebar3, except we use - <literal>buildErlangMk</literal> instead of - <literal>buildRebar3</literal>. - </para> - <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>. + </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. + </para> + + <para> + If a package needs to compile native code via Rebar3's port compilation + mechanism, add <literal>compilePort = true;</literal> to the derivation. + </para> + </section> + + <section xml:id="erlang-mk-packages"> + <title>Erlang.mk Packages</title> + + <para> + Erlang.mk functions similarly to Rebar3, except we use + <literal>buildErlangMk</literal> instead of + <literal>buildRebar3</literal>. + </para> + +<programlisting> { buildErlangMk, fetchHex, cowlib, ranch }: buildErlangMk { @@ -222,14 +251,17 @@ $ nix-env -f "<nixpkgs>" -iA beamPackages.ibrowse }; } </programlisting> - </section> - <section xml:id="mix-packages"> - <title>Mix Packages</title> - <para> - Mix functions similarly to Rebar3, except we use - <literal>buildMix</literal> instead of <literal>buildRebar3</literal>. - </para> - <programlisting> + </section> + + <section xml:id="mix-packages"> + <title>Mix Packages</title> + + <para> + Mix functions similarly to Rebar3, except we use + <literal>buildMix</literal> instead of <literal>buildRebar3</literal>. + </para> + +<programlisting> { buildMix, fetchHex, plug, absinthe }: buildMix { @@ -253,10 +285,12 @@ $ nix-env -f "<nixpkgs>" -iA beamPackages.ibrowse }; } </programlisting> - <para> - Alternatively, we can use <literal>buildHex</literal> as a shortcut: - </para> - <programlisting> + + <para> + Alternatively, we can use <literal>buildHex</literal> as a shortcut: + </para> + +<programlisting> { buildHex, buildMix, plug, absinthe }: buildHex { @@ -278,21 +312,25 @@ $ nix-env -f "<nixpkgs>" -iA beamPackages.ibrowse }; } </programlisting> - </section> + </section> </section> -</section> -<section xml:id="how-to-develop"> + </section> + + <section xml:id="how-to-develop"> <title>How to Develop</title> + <section xml:id="accessing-an-environment"> - <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: - </para> - <programlisting> + <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: + </para> + +<programlisting> $ nix-shell -A beamPackages.ibrowse.env --run "erl" Erlang/OTP 18 [erts-7.0] [source] [64-bit] [smp:4:4] [async-threads:10] [hipe] [kernel-poll:false] @@ -333,22 +371,25 @@ $ nix-env -f "<nixpkgs>" -iA beamPackages.ibrowse ok 2> </programlisting> - <para> - Notice the <literal>-A beamPackages.ibrowse.env</literal>. That is the key - to this functionality. - </para> + + <para> + Notice the <literal>-A beamPackages.ibrowse.env</literal>. That is the key + to this functionality. + </para> </section> + <section xml:id="creating-a-shell"> - <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. - </para> - <programlisting> + <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. + </para> + +<programlisting> { pkgs ? import "<nixpkgs"> {} }: with pkgs; @@ -368,13 +409,16 @@ in drv </programlisting> - <section xml:id="building-in-a-shell"> + + <section xml:id="building-in-a-shell"> <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> + +<programlisting> # ============================================================================= # Variables # ============================================================================= @@ -431,44 +475,54 @@ analyze: build plt $(NIX_SHELL) --run "mix dialyzer --no-compile" </programlisting> + <para> - Using a <literal>shell.nix</literal> as described (see <xref + Using a <literal>shell.nix</literal> as described (see + <xref linkend="creating-a-shell"/>) should just work. Aside from - <literal>test</literal>, <literal>plt</literal>, and - <literal>analyze</literal>, the Make targets work just fine for all of the - build derivations. + <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> -</section> -</section> -<section xml:id="generating-packages-from-hex-with-hex2nix"> + </section> + + <section xml:id="generating-packages-from-hex-with-hex2nix"> <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. - </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: - </para> - <programlisting> + 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: + </para> + +<programlisting> $ nix-build -A beamPackages </programlisting> - <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. - </para> -</section> + + <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. + </para> + </section> </section> diff --git a/doc/languages-frameworks/bower.xml b/doc/languages-frameworks/bower.xml index 742d3c2e9fe5..db7536cdc14e 100644 --- a/doc/languages-frameworks/bower.xml +++ b/doc/languages-frameworks/bower.xml @@ -1,40 +1,37 @@ <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-bower"> - -<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. -</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. -</para> - -<para> + <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. + </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. + </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>. -</para> + </para> -<section xml:id="ssec-bower2nix-usage"> + <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: - - -<example xml:id="ex-bowerJson"><title><filename>bower.json</filename></title> + <para> + 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"> <![CDATA[{ "name": "my-web-app", @@ -44,14 +41,12 @@ } }]]> </programlisting> -</example> -</para> - - -<para> - Running <command>bower2nix</command> will produce something like the - following output: + </example> + </para> + <para> + Running <command>bower2nix</command> will produce something like the + following output: <programlisting language="nix"> <![CDATA[{ fetchbower, buildEnv }: buildEnv { name = "bower-env"; ignoreCollisions = true; paths = [ @@ -60,31 +55,31 @@ buildEnv { name = "bower-env"; ignoreCollisions = true; paths = [ (fetchbower "jquery" "2.2.2" "1.9.1 - 2" "10sp5h98sqwk90y4k6hbdviwqzvzwqf47r3r51pakch5ii2y7js1") ]; }]]> </programlisting> -</para> - + </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. -</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. + </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. -</para> -</section> + <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. + </para> + </section> -<section xml:id="ssec-build-bower-components"><title><varname>buildBowerComponents</varname> function</title> + <section xml:id="ssec-build-bower-components"> + <title><varname>buildBowerComponents</varname> function</title> <para> - 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> + 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"> bowerComponents = buildBowerComponents { name = "my-web-app"; @@ -92,42 +87,42 @@ bowerComponents = buildBowerComponents { src = myWebApp; <co xml:id="ex-buildBowerComponents-2" /> }; </programlisting> -</example> + </example> </para> -<para> -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>. - </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. - </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. -</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. -</para> - -<example xml:id="ex-bowerGulpFile"><title>Example build script (<filename>gulpfile.js</filename>)</title> + <para> + 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>. + </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. + </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. + </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. + </para> + + <example xml:id="ex-bowerGulpFile"> + <title>Example build script (<filename>gulpfile.js</filename>)</title> <programlisting language="javascript"> <![CDATA[var gulp = require('gulp'); @@ -142,10 +137,10 @@ gulp.task('build', [], function () { .pipe(gulp.dest("./gulpdist/")); });]]> </programlisting> -</example> + </example> -<example xml:id="ex-buildBowerComponentsDefaultNix"> - <title>Full example — <filename>default.nix</filename></title> + <example xml:id="ex-buildBowerComponentsDefaultNix"> + <title>Full example — <filename>default.nix</filename></title> <programlisting language="nix"> { myWebApp ? { outPath = ./.; name = "myWebApp"; } , pkgs ? import <nixpkgs> {} @@ -172,73 +167,63 @@ pkgs.stdenv.mkDerivation { installPhase = "mv gulpdist $out"; } </programlisting> -</example> - -<para> -A few notes about <xref linkend="ex-buildBowerComponentsDefaultNix" />: - -<calloutlist> - <callout arearefs="ex-buildBowerComponentsDefault-1"> - <para> - 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. - </para> - </callout> - - <callout arearefs="ex-buildBowerComponentsDefault-3"> - <para> - <command>gulp</command> requires <varname>HOME</varname> to - refer to a writeable directory. - </para> - </callout> - - <callout arearefs="ex-buildBowerComponentsDefault-4"> - <para> + </example> + + <para> + A few notes about <xref linkend="ex-buildBowerComponentsDefaultNix" />: + <calloutlist> + <callout arearefs="ex-buildBowerComponentsDefault-1"> + <para> + 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. + </para> + </callout> + <callout arearefs="ex-buildBowerComponentsDefault-3"> + <para> + <command>gulp</command> requires <varname>HOME</varname> to refer to a + writeable directory. + </para> + </callout> + <callout arearefs="ex-buildBowerComponentsDefault-4"> + <para> The actual build command. Other tools could be used. - </para> - </callout> -</calloutlist> -</para> -</section> + </para> + </callout> + </calloutlist> + </para> + </section> -<section xml:id="ssec-bower2nix-troubleshooting"> + <section xml:id="ssec-bower2nix-troubleshooting"> <title>Troubleshooting</title> -<variablelist> - - <varlistentry> - <term> - <literal>ENOCACHE</literal> errors from + <variablelist> + <varlistentry> + <term><literal>ENOCACHE</literal> errors from <varname>buildBowerComponents</varname> </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>. - </para> - <para> - 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>. - </para> + <para> + 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. + </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>. + </para> </listitem> - </varlistentry> -</variablelist> - -</section> - + </varlistentry> + </variablelist> + </section> </section> diff --git a/doc/languages-frameworks/coq.xml b/doc/languages-frameworks/coq.xml index 0ce1abd6194c..d5f2574039f2 100644 --- a/doc/languages-frameworks/coq.xml +++ b/doc/languages-frameworks/coq.xml @@ -1,36 +1,38 @@ <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-language-coq"> + <title>Coq</title> -<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. - </para> - <para> - Some libraries require OCaml and sometimes also Camlp5 or findlib. - The exact versions that were used to build Coq are saved in the - <literal>coq.ocaml</literal> and <literal>coq.camlp5</literal> - and <literal>coq.findlib</literal> attributes. - </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. - </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. - </para> - <programlisting> + <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. + </para> + + <para> + Some libraries require OCaml and sometimes also Camlp5 or findlib. The exact + versions that were used to build Coq are saved in the + <literal>coq.ocaml</literal> and <literal>coq.camlp5</literal> and + <literal>coq.findlib</literal> attributes. + </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. + </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. + </para> + +<programlisting> { stdenv, fetchFromGitHub, coq, mathcomp }: stdenv.mkDerivation rec { diff --git a/doc/languages-frameworks/go.xml b/doc/languages-frameworks/go.xml index 54ea60c90212..ab4c9f0f7c88 100644 --- a/doc/languages-frameworks/go.xml +++ b/doc/languages-frameworks/go.xml @@ -1,14 +1,14 @@ <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-language-go"> + <title>Go</title> -<title>Go</title> + <para> + The function <varname>buildGoPackage</varname> builds standard Go programs. + </para> -<para>The function <varname>buildGoPackage</varname> builds -standard Go programs. -</para> - -<example xml:id='ex-buildGoPackage'><title>buildGoPackage</title> + <example xml:id='ex-buildGoPackage'> + <title>buildGoPackage</title> <programlisting> deis = buildGoPackage rec { name = "deis-${version}"; @@ -29,55 +29,56 @@ deis = buildGoPackage rec { buildFlags = "--tags release"; <co xml:id='ex-buildGoPackage-4' /> } </programlisting> -</example> - -<para><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'> + </example> + + <para> + <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'> + </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'> + </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'> + </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>. -</para> - -<example xml:id='ex-goDeps'><title>deps.nix</title> + </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>. + </para> + + <example xml:id='ex-goDeps'> + <title>deps.nix</title> <programlisting> [ <co xml:id='ex-goDeps-1' /> { @@ -100,67 +101,60 @@ the following arguments are of special significance to the function: } ] </programlisting> -</example> + </example> -<para> - -<calloutlist> - - <callout arearefs='ex-goDeps-1'> + <para> + <calloutlist> + <callout arearefs='ex-goDeps-1'> <para> - <varname>goDeps</varname> is a list of Go dependencies. + <varname>goDeps</varname> is a list of Go dependencies. </para> - </callout> - - <callout arearefs='ex-goDeps-2'> + </callout> + <callout arearefs='ex-goDeps-2'> <para> - <varname>goPackagePath</varname> specifies Go package import path. + <varname>goPackagePath</varname> specifies Go package import path. </para> - </callout> - - <callout arearefs='ex-goDeps-3'> + </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.</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: - - <screen> + </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. + </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: +<screen> $ nix-build -A deis.bin </screen> - or build all outputs with: - - <screen> +<screen> $ 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>. + </para> - <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: - + <para> + 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" done </screen> -</para> - + </para> </section> diff --git a/doc/languages-frameworks/index.xml b/doc/languages-frameworks/index.xml index a1c265f67484..f22984cb56b0 100644 --- a/doc/languages-frameworks/index.xml +++ b/doc/languages-frameworks/index.xml @@ -1,36 +1,31 @@ <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" 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.</para> - - -<xi:include href="beam.xml" /> -<xi:include href="bower.xml" /> -<xi:include href="coq.xml" /> -<xi:include href="go.xml" /> -<xi:include href="haskell.section.xml" /> -<xi:include href="idris.section.xml" /> -<xi:include href="java.xml" /> -<xi:include href="lua.xml" /> -<xi:include href="node.section.xml" /> -<xi:include href="perl.xml" /> -<xi:include href="python.section.xml" /> -<xi:include href="qt.xml" /> -<xi:include href="r.section.xml" /> -<xi:include href="ruby.xml" /> -<xi:include href="rust.section.xml" /> -<xi:include href="texlive.xml" /> -<xi:include href="vim.section.xml" /> -<xi:include href="emscripten.section.xml" /> - - + <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. + </para> + <xi:include href="beam.xml" /> + <xi:include href="bower.xml" /> + <xi:include href="coq.xml" /> + <xi:include href="go.xml" /> + <xi:include href="haskell.section.xml" /> + <xi:include href="idris.section.xml" /> + <xi:include href="java.xml" /> + <xi:include href="lua.xml" /> + <xi:include href="node.section.xml" /> + <xi:include href="perl.xml" /> + <xi:include href="python.section.xml" /> + <xi:include href="qt.xml" /> + <xi:include href="r.section.xml" /> + <xi:include href="ruby.xml" /> + <xi:include href="rust.section.xml" /> + <xi:include href="texlive.xml" /> + <xi:include href="vim.section.xml" /> + <xi:include href="emscripten.section.xml" /> </chapter> diff --git a/doc/languages-frameworks/java.xml b/doc/languages-frameworks/java.xml index 2507cc2c469a..dcf4d17fa57d 100644 --- a/doc/languages-frameworks/java.xml +++ b/doc/languages-frameworks/java.xml @@ -1,11 +1,10 @@ <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-language-java"> + <title>Java</title> -<title>Java</title> - -<para>Ant-based Java packages are typically built from source as follows: - + <para> + Ant-based Java packages are typically built from source as follows: <programlisting> stdenv.mkDerivation { name = "..."; @@ -16,33 +15,33 @@ stdenv.mkDerivation { buildPhase = "ant"; } </programlisting> - -Note that <varname>jdk</varname> is an alias for the OpenJDK.</para> - -<para>JAR files that are intended to be used by other packages should -be installed in <filename>$out/share/java</filename>. The OpenJDK has -a stdenv setup hook that adds 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 - + Note that <varname>jdk</varname> is an alias for the OpenJDK. + </para> + + <para> + JAR files that are intended to be used by other packages should be installed + in <filename>$out/share/java</filename>. The OpenJDK has a stdenv setup hook + that adds 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 = [ jdk libfoo ]; </programlisting> - -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>.</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: - + 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>. + </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: <programlisting> buildInputs = [ makeWrapper ]; @@ -53,23 +52,20 @@ 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.</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: - + 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> + 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> buildInputs = [ gcj ant ]; </programlisting> - -Here, Ant will automatically use <command>gij</command> (the GNU Java -Runtime) instead of the OpenJRE.</para> - + Here, Ant will automatically use <command>gij</command> (the GNU Java + Runtime) instead of the OpenJRE. + </para> </section> - diff --git a/doc/languages-frameworks/lua.xml b/doc/languages-frameworks/lua.xml index 39b086af4cb1..210140299960 100644 --- a/doc/languages-frameworks/lua.xml +++ b/doc/languages-frameworks/lua.xml @@ -1,24 +1,22 @@ <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-language-lua"> + <title>Lua</title> -<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"> + <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.) -</para> + </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>. + <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: - - <programlisting> +<programlisting> fileSystem = buildLuaPackage { name = "filesystem-1.6.2"; src = fetchurl { @@ -32,20 +30,19 @@ fileSystem = buildLuaPackage { }; }; </programlisting> -</para> + </para> -<para> + <para> 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. -</para> + </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. + </para> </section> - diff --git a/doc/languages-frameworks/perl.xml b/doc/languages-frameworks/perl.xml index 149fcb275a09..2fe64999e139 100644 --- a/doc/languages-frameworks/perl.xml +++ b/doc/languages-frameworks/perl.xml @@ -1,24 +1,27 @@ <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-language-perl"> - -<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 -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 + <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 +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: - + 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"; @@ -28,74 +31,72 @@ 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> $ 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> $ 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>.)</para> - -<para>So what does <varname>buildPerlPackage</varname> do? It does -the following: - -<orderedlist> - - <listitem><para>In the configure phase, it calls <literal>perl - Makefile.PL</literal> to generate a Makefile. You can set the - variable <varname>makeMakerFlags</varname> to pass flags to - <filename>Makefile.PL</filename></para></listitem> - - <listitem><para>It adds the contents of the <envar>PERL5LIB</envar> - environment variable to <literal>#! .../bin/perl</literal> line of - Perl scripts as <literal>-I<replaceable>dir</replaceable></literal> - flags. This ensures that a script can find its - dependencies.</para></listitem> - - <listitem><para>In the fixup phase, it writes the propagated build - inputs (<varname>propagatedBuildInputs</varname>) to the file - <filename>$out/nix-support/propagated-user-env-packages</filename>. - <command>nix-env</command> recursively installs all packages listed - in this file when you install a package that has it. This ensures - that a Perl package can find its dependencies.</para></listitem> - -</orderedlist> - -</para> - -<para><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>: - + (Of course you can also install using the attribute name: <literal>nix-env -i + -A perlPackages.ClassC3</literal>.) + </para> + + <para> + So what does <varname>buildPerlPackage</varname> do? It does the following: + <orderedlist> + <listitem> + <para> + In the configure phase, it calls <literal>perl Makefile.PL</literal> to + generate a Makefile. You can set the variable + <varname>makeMakerFlags</varname> to pass flags to + <filename>Makefile.PL</filename> + </para> + </listitem> + <listitem> + <para> + It adds the contents of the <envar>PERL5LIB</envar> environment variable + to <literal>#! .../bin/perl</literal> line of Perl scripts as + <literal>-I<replaceable>dir</replaceable></literal> flags. This ensures + that a script can find its dependencies. + </para> + </listitem> + <listitem> + <para> + In the fixup phase, it writes the propagated build inputs + (<varname>propagatedBuildInputs</varname>) to the file + <filename>$out/nix-support/propagated-user-env-packages</filename>. + <command>nix-env</command> recursively installs all packages listed in + this file when you install a package that has it. This ensures that a Perl + package can find its dependencies. + </para> + </listitem> + </orderedlist> + </para> + + <para> + <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 }: @@ -113,18 +114,15 @@ buildPerlPackage rec { ''; } </programlisting> - -</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: - + </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: <programlisting> ClassC3Componentised = buildPerlPackage rec { name = "Class-C3-Componentised-1.0004"; @@ -137,24 +135,26 @@ ClassC3Componentised = buildPerlPackage rec { ]; }; </programlisting> + </para> -</para> - -<section xml:id="ssec-generation-from-CPAN"><title>Generation from CPAN</title> + <section xml:id="ssec-generation-from-CPAN"> + <title>Generation from CPAN</title> -<para>Nix expressions for Perl packages can be generated (almost) -automatically from CPAN. This is done by the program -<command>nix-generate-from-cpan</command>, which can be installed -as follows:</para> + <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: + </para> <screen> $ nix-env -i nix-generate-from-cpan </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: - + <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: <screen> $ nix-generate-from-cpan XML::Simple XMLSimple = buildPerlPackage rec { @@ -170,26 +170,23 @@ $ nix-generate-from-cpan XML::Simple }; }; </screen> - -The output can be pasted into -<filename>pkgs/top-level/perl-packages.nix</filename> or wherever else -you need it.</para> - -</section> - -<section xml:id="ssec-perl-cross-compilation"><title>Cross-compiling modules</title> - -<para>Nixpkgs has experimental support for cross-compiling Perl -modules. In many cases, it will just work out of the box, even for -modules with native extensions. Sometimes, however, the Makefile.PL -for a module may (indirectly) import a native module. In that case, -you will need to make a stub for that module that will satisfy the -Makefile.PL and install it into -<filename>lib/perl5/site_perl/cross_perl/${perl.version}</filename>. -See the <varname>postInstall</varname> for <varname>DBI</varname> for -an example.</para> - -</section> - + The output can be pasted into + <filename>pkgs/top-level/perl-packages.nix</filename> or wherever else you + need it. + </para> + </section> + + <section xml:id="ssec-perl-cross-compilation"> + <title>Cross-compiling modules</title> + + <para> + Nixpkgs has experimental support for cross-compiling Perl modules. In many + cases, it will just work out of the box, even for modules with native + extensions. Sometimes, however, the Makefile.PL for a module may + (indirectly) import a native module. In that case, you will need to make a + stub for that module that will satisfy the Makefile.PL and install it into + <filename>lib/perl5/site_perl/cross_perl/${perl.version}</filename>. See the + <varname>postInstall</varname> for <varname>DBI</varname> for an example. + </para> + </section> </section> - diff --git a/doc/languages-frameworks/qt.xml b/doc/languages-frameworks/qt.xml index 1dbbb5341ba3..b9b605b81da1 100644 --- a/doc/languages-frameworks/qt.xml +++ b/doc/languages-frameworks/qt.xml @@ -1,58 +1,74 @@ <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-language-qt"> + <title>Qt</title> -<title>Qt</title> - -<para> -Qt is a comprehensive desktop and mobile application development toolkit for C++. -Legacy support is available for Qt 3 and Qt 4, but all current development uses Qt 5. -The Qt 5 packages in Nixpkgs are updated frequently to take advantage of new features, -but older versions are typically retained until their support window ends. -The most important consideration in packaging Qt-based software is ensuring that each package and all its dependencies use the same version of Qt 5; -this consideration motivates most of the tools described below. -</para> - -<section xml:id="ssec-qt-libraries"><title>Packaging Libraries for Nixpkgs</title> - -<para> -Whenever possible, libraries that use Qt 5 should be built with each available version. -Packages providing libraries should be added to the top-level function <varname>mkLibsForQt5</varname>, -which is used to build a set of libraries for every Qt 5 version. -A special <varname>callPackage</varname> function is used in this scope to ensure that the entire dependency tree uses the same Qt 5 version. -Import dependencies unqualified, i.e., <literal>qtbase</literal> not <literal>qt5.qtbase</literal>. -<emphasis>Do not</emphasis> import a package set such as <literal>qt5</literal> or <literal>libsForQt5</literal>. -</para> - -<para> -If a library does not support a particular version of Qt 5, it is best to mark it as broken by setting its <literal>meta.broken</literal> attribute. -A package may be marked broken for certain versions by testing the <literal>qtbase.version</literal> attribute, which will always give the current Qt 5 version. -</para> + <para> + Qt is a comprehensive desktop and mobile application development toolkit for + C++. Legacy support is available for Qt 3 and Qt 4, but all current + development uses Qt 5. The Qt 5 packages in Nixpkgs are updated frequently to + take advantage of new features, but older versions are typically retained + until their support window ends. The most important consideration in + packaging Qt-based software is ensuring that each package and all its + dependencies use the same version of Qt 5; this consideration motivates most + of the tools described below. + </para> -</section> + <section xml:id="ssec-qt-libraries"> + <title>Packaging Libraries for Nixpkgs</title> -<section xml:id="ssec-qt-applications"><title>Packaging Applications for Nixpkgs</title> + <para> + Whenever possible, libraries that use Qt 5 should be built with each + available version. Packages providing libraries should be added to the + top-level function <varname>mkLibsForQt5</varname>, which is used to build a + set of libraries for every Qt 5 version. A special + <varname>callPackage</varname> function is used in this scope to ensure that + the entire dependency tree uses the same Qt 5 version. Import dependencies + unqualified, i.e., <literal>qtbase</literal> not + <literal>qt5.qtbase</literal>. <emphasis>Do not</emphasis> import a package + set such as <literal>qt5</literal> or <literal>libsForQt5</literal>. + </para> -<para> -Call your application expression using <literal>libsForQt5.callPackage</literal> instead of <literal>callPackage</literal>. -Import dependencies unqualified, i.e., <literal>qtbase</literal> not <literal>qt5.qtbase</literal>. -<emphasis>Do not</emphasis> import a package set such as <literal>qt5</literal> or <literal>libsForQt5</literal>. -</para> + <para> + If a library does not support a particular version of Qt 5, it is best to + mark it as broken by setting its <literal>meta.broken</literal> attribute. A + package may be marked broken for certain versions by testing the + <literal>qtbase.version</literal> attribute, which will always give the + current Qt 5 version. + </para> + </section> -<para> -Qt 5 maintains strict backward compatibility, so it is generally best to build an application package against the latest version using the <varname>libsForQt5</varname> library set. -In case a package does not build with the latest Qt version, it is possible to pick a set pinned to a particular version, e.g. <varname>libsForQt55</varname> for Qt 5.5, if that is the latest version the package supports. -If a package must be pinned to an older Qt version, be sure to file a bug upstream; -because Qt is strictly backwards-compatible, any incompatibility is by definition a bug in the application. -</para> + <section xml:id="ssec-qt-applications"> + <title>Packaging Applications for Nixpkgs</title> -<para> -When testing applications in Nixpkgs, it is a common practice to build the package with <literal>nix-build</literal> and run it using the created symbolic link. -This will not work with Qt applications, however, because they have many hard runtime requirements that can only be guaranteed if the package is actually installed. -To test a Qt application, install it with <literal>nix-env</literal> or run it inside <literal>nix-shell</literal>. -</para> + <para> + Call your application expression using + <literal>libsForQt5.callPackage</literal> instead of + <literal>callPackage</literal>. Import dependencies unqualified, i.e., + <literal>qtbase</literal> not <literal>qt5.qtbase</literal>. <emphasis>Do + not</emphasis> import a package set such as <literal>qt5</literal> or + <literal>libsForQt5</literal>. + </para> -</section> + <para> + Qt 5 maintains strict backward compatibility, so it is generally best to + build an application package against the latest version using the + <varname>libsForQt5</varname> library set. In case a package does not build + with the latest Qt version, it is possible to pick a set pinned to a + particular version, e.g. <varname>libsForQt55</varname> for Qt 5.5, if that + is the latest version the package supports. If a package must be pinned to + an older Qt version, be sure to file a bug upstream; because Qt is strictly + backwards-compatible, any incompatibility is by definition a bug in the + application. + </para> + <para> + When testing applications in Nixpkgs, it is a common practice to build the + package with <literal>nix-build</literal> and run it using the created + symbolic link. This will not work with Qt applications, however, because + they have many hard runtime requirements that can only be guaranteed if the + package is actually installed. To test a Qt application, install it with + <literal>nix-env</literal> or run it inside <literal>nix-shell</literal>. + </para> + </section> </section> - diff --git a/doc/languages-frameworks/ruby.xml b/doc/languages-frameworks/ruby.xml index 6bb809192f89..c52a72a3df4a 100644 --- a/doc/languages-frameworks/ruby.xml +++ b/doc/languages-frameworks/ruby.xml @@ -1,17 +1,19 @@ <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-language-ruby"> + <title>Ruby</title> -<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. + </para> -<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. -</para> - -<para>For example, to package sensu, we did:</para> + <para> + For example, to package sensu, we did: + </para> <screen> <![CDATA[$ cd pkgs/servers/monitoring @@ -42,17 +44,18 @@ 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. -</para> + <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. + </para> -<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: -</para> + <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: + </para> <screen> <![CDATA[{ lib, bundlerApp }: @@ -72,31 +75,31 @@ 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. -</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: -</para> + <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. + </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: + </para> <programlisting> <![CDATA[let env = bundlerEnv { @@ -118,5 +121,4 @@ in stdenv.mkDerivation { ''; }]]> </programlisting> - </section> diff --git a/doc/languages-frameworks/texlive.xml b/doc/languages-frameworks/texlive.xml index 4515e17ec09e..af0b07166e3e 100644 --- a/doc/languages-frameworks/texlive.xml +++ b/doc/languages-frameworks/texlive.xml @@ -1,27 +1,42 @@ <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-language-texlive"> + <title>TeX Live</title> -<title>TeX Live</title> + <para> + Since release 15.09 there is a new TeX Live packaging that lives entirely + under attribute <varname>texlive</varname>. + </para> + + <section> + <title>User's guide</title> -<para>Since release 15.09 there is a new TeX Live packaging that lives entirely under attribute <varname>texlive</varname>.</para> -<section><title>User's guide</title> <itemizedlist> - <listitem><para> - For basic usage just pull <varname>texlive.combined.scheme-basic</varname> for an environment with basic LaTeX support.</para></listitem> - <listitem><para> - It typically won't work to use separately installed packages together. - Instead, you can build a custom set of packages like this: - <programlisting> + <listitem> + <para> + For basic usage just pull <varname>texlive.combined.scheme-basic</varname> + for an environment with basic LaTeX support. + </para> + </listitem> + <listitem> + <para> + It typically won't work to use separately installed packages together. + 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). - </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>. - <programlisting> + 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>. +<programlisting> texlive.combine { # inherit (texlive) whatever-you-want; pkgFilter = pkg: @@ -30,34 +45,55 @@ texlive.combine { # there are also other attributes: version, name } </programlisting> - </para></listitem> - <listitem><para> - You can list packages e.g. by <command>nix-repl</command>. - <programlisting> + </para> + </listitem> + <listitem> + <para> + You can list packages e.g. by <command>nix-repl</command>. +<programlisting> $ nix-repl nix-repl> :l <nixpkgs> nix-repl> texlive.collection-<TAB> </programlisting> - </para></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. - </para></listitem> + </para> + </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. + </para> + </listitem> </itemizedlist> -</section> + </section> + + <section> + <title>Known problems</title> -<section><title>Known problems</title> <itemizedlist> - <listitem><para> - Some tools are still missing, e.g. luajittex;</para></listitem> - <listitem><para> - some apps aren't packaged/tested yet (asymptote, biber, etc.);</para></listitem> - <listitem><para> - feature/bug: when a package is rejected by <varname>pkgFilter</varname>, its dependencies are still propagated;</para></listitem> - <listitem><para> - in case of any bugs or feature requests, file a github issue or better a pull request and /cc @vcunat.</para></listitem> + <listitem> + <para> + Some tools are still missing, e.g. luajittex; + </para> + </listitem> + <listitem> + <para> + some apps aren't packaged/tested yet (asymptote, biber, etc.); + </para> + </listitem> + <listitem> + <para> + feature/bug: when a package is rejected by <varname>pkgFilter</varname>, + its dependencies are still propagated; + </para> + </listitem> + <listitem> + <para> + in case of any bugs or feature requests, file a github issue or better a + pull request and /cc @vcunat. + </para> + </listitem> </itemizedlist> + </section> </section> - - -</section> - diff --git a/doc/manual.xml b/doc/manual.xml index 385079eb5785..f31897aed039 100644 --- a/doc/manual.xml +++ b/doc/manual.xml @@ -1,29 +1,24 @@ <book xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"> - - <info> - - <title>Nixpkgs Contributors Guide</title> - - <subtitle>Version <xi:include href=".version" parse="text" /></subtitle> - - </info> - - <xi:include href="introduction.chapter.xml" /> - <xi:include href="quick-start.xml" /> - <xi:include href="stdenv.xml" /> - <xi:include href="multiple-output.xml" /> - <xi:include href="cross-compilation.xml" /> - <xi:include href="configuration.xml" /> - <xi:include href="functions.xml" /> - <xi:include href="meta.xml" /> - <xi:include href="languages-frameworks/index.xml" /> - <xi:include href="platform-notes.xml" /> - <xi:include href="package-notes.xml" /> - <xi:include href="overlays.xml" /> - <xi:include href="coding-conventions.xml" /> - <xi:include href="submitting-changes.xml" /> - <xi:include href="reviewing-contributions.xml" /> - <xi:include href="contributing.xml" /> - + <info> + <title>Nixpkgs Contributors Guide</title> + <subtitle>Version <xi:include href=".version" parse="text" /> + </subtitle> + </info> + <xi:include href="introduction.chapter.xml" /> + <xi:include href="quick-start.xml" /> + <xi:include href="stdenv.xml" /> + <xi:include href="multiple-output.xml" /> + <xi:include href="cross-compilation.xml" /> + <xi:include href="configuration.xml" /> + <xi:include href="functions.xml" /> + <xi:include href="meta.xml" /> + <xi:include href="languages-frameworks/index.xml" /> + <xi:include href="platform-notes.xml" /> + <xi:include href="package-notes.xml" /> + <xi:include href="overlays.xml" /> + <xi:include href="coding-conventions.xml" /> + <xi:include href="submitting-changes.xml" /> + <xi:include href="reviewing-contributions.xml" /> + <xi:include href="contributing.xml" /> </book> diff --git a/doc/meta.xml b/doc/meta.xml index 5dbe810810d1..ad16e7683f58 100644 --- a/doc/meta.xml +++ b/doc/meta.xml @@ -1,14 +1,12 @@ <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" 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: - + <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: <programlisting> meta = { description = "A program that produces a familiar, friendly greeting"; @@ -22,16 +20,15 @@ meta = { platforms = stdenv.lib.platforms.all; }; </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.</para> - -<para>The meta-attributes of a package can be queried from the -command-line using <command>nix-env</command>: - + </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. + </para> + <para> + The meta-attributes of a package can be queried from the command-line using + <command>nix-env</command>: <screen> $ nix-env -qa hello --json { @@ -70,252 +67,299 @@ $ nix-env -qa hello --json </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> $ nix-env -qa hello --description hello-2.3 A program that produces a familiar, friendly greeting </screen> - -</para> - - -<section xml:id="sec-standard-meta-attributes"><title>Standard -meta-attributes</title> - -<para>It is expected that each meta-attribute is one of the following:</para> - -<variablelist> - - <varlistentry> - <term><varname>description</varname></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.</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.</para> - - <para>Wrong: <literal>"libpng is a library that allows you to decode PNG images."</literal></para> - - <para>Right: <literal>"A library for decoding PNG images"</literal></para> - + </para> + <section xml:id="sec-standard-meta-attributes"> + <title>Standard meta-attributes</title> + + <para> + It is expected that each meta-attribute is one of the following: + </para> + + <variablelist> + <varlistentry> + <term><varname>description</varname> + </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. + </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. + </para> + <para> + Wrong: <literal>"libpng is a library that allows you to decode PNG + images."</literal> + </para> + <para> + Right: <literal>"A library for decoding PNG images"</literal> + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><varname>longDescription</varname></term> - <listitem><para>An arbitrarily long description of the - package.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>branch</varname></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.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>homepage</varname></term> - <listitem><para>The package’s homepage. Example: - <literal>http://www.gnu.org/software/hello/manual/</literal></para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>downloadPage</varname></term> - <listitem><para>The page where a link to the current version can be found. Example: - <literal>http://ftp.gnu.org/gnu/hello/</literal></para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>license</varname></term> + </varlistentry> + <varlistentry> + <term><varname>longDescription</varname> + </term> <listitem> - <para> - The license, or licenses, for the package. One from the attribute set - defined in <link + <para> + An arbitrarily long description of the package. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>branch</varname> + </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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>homepage</varname> + </term> + <listitem> + <para> + The package’s homepage. Example: + <literal>http://www.gnu.org/software/hello/manual/</literal> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>downloadPage</varname> + </term> + <listitem> + <para> + The page where a link to the current version can be found. Example: + <literal>http://ftp.gnu.org/gnu/hello/</literal> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>license</varname> + </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: - <itemizedlist> - <listitem><para>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>. - </para></listitem> - <listitem><para>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>. - </para></listitem> - <listitem><para>Multiple licenses referenced as a space delimited string of attribute shortNames (frowned upon) - <literal>"asl20 free ofl"</literal>. - </para></listitem> - </itemizedlist> - For details, see <xref linkend='sec-meta-license'/>. - </para> + <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>. + </para> + </listitem> + <listitem> + <para> + 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>. + </para> + </listitem> + <listitem> + <para> + 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>. + </para> + </listitem> + </itemizedlist> + For details, see <xref linkend='sec-meta-license'/>. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><varname>maintainers</varname></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 + </varlistentry> + <varlistentry> + <term><varname>maintainers</varname> + </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>.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>priority</varname></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).</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>platforms</varname></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: - + and write something like <literal>[ stdenv.lib.maintainers.alice + stdenv.lib.maintainers.bob ]</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>priority</varname> + </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). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>platforms</varname> + </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: <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.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>hydraPlatforms</varname></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. - + 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> + <varlistentry> + <term><varname>hydraPlatforms</varname> + </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. <programlisting> meta.platforms = stdenv.lib.platforms.linux; meta.hydraPlatforms = []; </programlisting> - - </para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>broken</varname></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.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>updateWalker</varname></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.</para></listitem> - </varlistentry> - -</variablelist> - - -</section> - - -<section xml:id="sec-meta-license"><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.</para> - -<para>Although it's typically better to indicate the specific license, -a few generic options are available: - -<variablelist> - - <varlistentry> - <term><varname>stdenv.lib.licenses.free</varname>, - <varname>"free"</varname></term> - - <listitem><para>Catch-all for free software licenses not listed - above.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>stdenv.lib.licenses.unfreeRedistributable</varname>, - <varname>"unfree-redistributable"</varname></term> - - <listitem><para>Unfree package that can be redistributed in binary - form. That is, it’s legal to redistribute the - <emphasis>output</emphasis> of the derivation. This means that - the package can be included in the Nixpkgs - channel.</para> - - <para>Sometimes proprietary software can only be redistributed - unmodified. Make sure the builder doesn’t actually modify the - original binaries; otherwise we’re breaking the license. For - instance, the NVIDIA X11 drivers can be redistributed unmodified, - but our builder applies <command>patchelf</command> to make them - work. Thus, its license is <varname>"unfree"</varname> and it - cannot be included in the Nixpkgs channel.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>stdenv.lib.licenses.unfree</varname>, - <varname>"unfree"</varname></term> - - <listitem><para>Unfree package that cannot be redistributed. You - can build it yourself, but you cannot redistribute the output of - the derivation. Thus it cannot be included in the Nixpkgs - channel.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>stdenv.lib.licenses.unfreeRedistributableFirmware</varname>, - <varname>"unfree-redistributable-firmware"</varname></term> - - <listitem><para>This package supplies unfree, redistributable - firmware. This is a separate value from - <varname>unfree-redistributable</varname> because not everybody - cares whether firmware is free.</para></listitem> - </varlistentry> - -</variablelist> - -</para> - - -</section> - - + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>broken</varname> + </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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>updateWalker</varname> + </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. + </para> + </listitem> + </varlistentry> + </variablelist> + </section> + <section xml:id="sec-meta-license"> + <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. + </para> + + <para> + Although it's typically better to indicate the specific license, a few + generic options are available: + <variablelist> + <varlistentry> + <term><varname>stdenv.lib.licenses.free</varname>, + <varname>"free"</varname> + </term> + <listitem> + <para> + Catch-all for free software licenses not listed above. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>stdenv.lib.licenses.unfreeRedistributable</varname>, + <varname>"unfree-redistributable"</varname> + </term> + <listitem> + <para> + Unfree package that can be redistributed in binary form. That is, it’s + legal to redistribute the <emphasis>output</emphasis> of the derivation. + This means that the package can be included in the Nixpkgs channel. + </para> + <para> + Sometimes proprietary software can only be redistributed unmodified. + Make sure the builder doesn’t actually modify the original binaries; + otherwise we’re breaking the license. For instance, the NVIDIA X11 + drivers can be redistributed unmodified, but our builder applies + <command>patchelf</command> to make them work. Thus, its license is + <varname>"unfree"</varname> and it cannot be included in the Nixpkgs + channel. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>stdenv.lib.licenses.unfree</varname>, + <varname>"unfree"</varname> + </term> + <listitem> + <para> + Unfree package that cannot be redistributed. You can build it yourself, + but you cannot redistribute the output of the derivation. Thus it cannot + be included in the Nixpkgs channel. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>stdenv.lib.licenses.unfreeRedistributableFirmware</varname>, + <varname>"unfree-redistributable-firmware"</varname> + </term> + <listitem> + <para> + This package supplies unfree, redistributable firmware. This is a + separate value from <varname>unfree-redistributable</varname> because + not everybody cares whether firmware is free. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </section> </chapter> diff --git a/doc/multiple-output.xml b/doc/multiple-output.xml index 277d3d814136..040c12c92913 100644 --- a/doc/multiple-output.xml +++ b/doc/multiple-output.xml @@ -5,105 +5,319 @@ <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="chap-multiple-output"> + <title>Multiple-output packages</title> + <section> + <title>Introduction</title> -<title>Multiple-output packages</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. + </para> -<section><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.</para> - <para>The main motivation is to save disk space by reducing runtime closure sizes; consequently also sizes of substituted binaries get reduced. Splitting can be used to have more granular runtime dependencies, for example the typical reduction is to split away development-only files, as those are typically not needed during runtime. As a result, closure sizes of many packages can get reduced to a half or even much less.</para> - <note><para>The reduction effects could be instead achieved by building the parts in completely separate derivations. That would often additionally reduce build-time closures, but it tends to be much harder to write such derivations, as build systems typically assume all parts are being built at once. This compromise approach of single source package producing multiple binary packages is also utilized often by rpm and deb.</para></note> -</section> + <para> + The main motivation is to save disk space by reducing runtime closure sizes; + consequently also sizes of substituted binaries get reduced. Splitting can + be used to have more granular runtime dependencies, for example the typical + reduction is to split away development-only files, as those are typically + not needed during runtime. As a result, closure sizes of many packages can + get reduced to a half or even much less. + </para> + + <note> + <para> + The reduction effects could be instead achieved by building the parts in + completely separate derivations. That would often additionally reduce + build-time closures, but it tends to be much harder to write such + derivations, as build systems typically assume all parts are being built at + once. This compromise approach of single source package producing multiple + binary packages is also utilized often by rpm and deb. + </para> + </note> + </section> + <section> + <title>Installing a split package</title> + + <para> + When installing a package via <varname>systemPackages</varname> or + <command>nix-env</command> you have several options: + </para> -<section><title>Installing a split package</title> - <para>When installing a package via <varname>systemPackages</varname> or <command>nix-env</command> you have several options:</para> <itemizedlist> - <listitem><para>You can install particular outputs explicitly, as each is available in the Nix language as an attribute of the package. The <varname>outputs</varname> attribute contains a list of output names.</para></listitem> - <listitem><para>You can let it use the default outputs. These are handled by <varname>meta.outputsToInstall</varname> attribute that contains a list of output names.</para> - <para>TODO: more about tweaking the attribute, etc.</para></listitem> - <listitem><para>NixOS provides configuration option <varname>environment.extraOutputsToInstall</varname> that allows adding extra outputs of <varname>environment.systemPackages</varname> atop the default ones. It's mainly meant for documentation and debug symbols, and it's also modified by specific options.</para> - <note><para>At this moment there is no similar configurability for packages installed by <command>nix-env</command>. You can still use approach from <xref linkend="sec-modify-via-packageOverrides" /> to override <varname>meta.outputsToInstall</varname> attributes, but that's a rather inconvenient way.</para></note> - </listitem> + <listitem> + <para> + You can install particular outputs explicitly, as each is available in the + Nix language as an attribute of the package. The + <varname>outputs</varname> attribute contains a list of output names. + </para> + </listitem> + <listitem> + <para> + You can let it use the default outputs. These are handled by + <varname>meta.outputsToInstall</varname> attribute that contains a list of + output names. + </para> + <para> + TODO: more about tweaking the attribute, etc. + </para> + </listitem> + <listitem> + <para> + NixOS provides configuration option + <varname>environment.extraOutputsToInstall</varname> that allows adding + extra outputs of <varname>environment.systemPackages</varname> atop the + default ones. It's mainly meant for documentation and debug symbols, and + it's also modified by specific options. + </para> + <note> + <para> + At this moment there is no similar configurability for packages installed + by <command>nix-env</command>. You can still use approach from + <xref linkend="sec-modify-via-packageOverrides" /> to override + <varname>meta.outputsToInstall</varname> attributes, but that's a rather + inconvenient way. + </para> + </note> + </listitem> </itemizedlist> -</section> + </section> + <section> + <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. + </para> + + <para> + When a multiple-output derivation gets into a build input of another + derivation, the <varname>dev</varname> output is added if it exists, + otherwise the first output is added. In addition to that, + <varname>propagatedBuildOutputs</varname> of that package which by default + contain <varname>$outputBin</varname> and <varname>$outputLib</varname> are + also added. (See <xref linkend="multiple-output-file-type-groups" />.) + </para> + </section> + <section> + <title>Writing a split derivation</title> -<section><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.</para> - <para>When a multiple-output derivation gets into a build input of another derivation, the <varname>dev</varname> output is added if it exists, otherwise the first output is added. In addition to that, <varname>propagatedBuildOutputs</varname> of that package which by default contain <varname>$outputBin</varname> and <varname>$outputLib</varname> are also added. (See <xref linkend="multiple-output-file-type-groups" />.)</para> -</section> + <para> + Here you find how to write a derivation that produces multiple outputs. + </para> + <para> + In nixpkgs there is a framework supporting multiple-output derivations. It + tries to cover most cases by default behavior. You can find the source + separated in + <<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> -<section><title>Writing a split derivation</title> - <para>Here you find how to write a derivation that produces multiple outputs.</para> - <para>In nixpkgs there is a framework supporting multiple-output derivations. It tries to cover most cases by default behavior. You can find the source separated in <<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.</para> - <note><para>There is a special handling of the <varname>debug</varname> output, described at <xref linkend="stdenv-separateDebugInfo" />.</para></note> +<programlisting>outputs = [ "bin" "dev" "out" "doc" ];</programlisting> + + <para> + Often such a single line is enough. For each output an equally named + environment variable is passed to the builder and contains the path in nix + store for that output. Typically you also want to have the main + <varname>out</varname> output, as it catches any files that didn't get + elsewhere. + </para> + + <note> + <para> + There is a special handling of the <varname>debug</varname> output, + described at <xref linkend="stdenv-separateDebugInfo" />. + </para> + </note> <section xml:id="multiple-output-file-binaries-first-convention"> - <title><quote>Binaries first</quote></title> - <para>A commonly adopted convention in <literal>nixpkgs</literal> is that executables provided by the package are contained within its first output. This convention allows the dependent packages to reference the executables provided by packages in a uniform manner. For instance, provided with the knowledge that the <literal>perl</literal> package contains a <literal>perl</literal> executable it can be referenced as <literal>${pkgs.perl}/bin/perl</literal> within a Nix derivation that needs to execute a Perl script.</para> - <para>The <literal>glibc</literal> package is a deliberate single exception to the <quote>binaries first</quote> convention. The <literal>glibc</literal> has <literal>libs</literal> as its first output allowing the libraries provided by <literal>glibc</literal> to be referenced directly (e.g. <literal>${stdenv.glibc}/lib/ld-linux-x86-64.so.2</literal>). The executables provided by <literal>glibc</literal> can be accessed via its <literal>bin</literal> attribute (e.g. <literal>${stdenv.glibc.bin}/bin/ldd</literal>).</para> - <para>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> + <title><quote>Binaries first</quote></title> + + <para> + A commonly adopted convention in <literal>nixpkgs</literal> is that + executables provided by the package are contained within its first output. + This convention allows the dependent packages to reference the executables + provided by packages in a uniform manner. For instance, provided with the + knowledge that the <literal>perl</literal> package contains a + <literal>perl</literal> executable it can be referenced as + <literal>${pkgs.perl}/bin/perl</literal> within a Nix derivation that needs + to execute a Perl script. + </para> + + <para> + The <literal>glibc</literal> package is a deliberate single exception to + the <quote>binaries first</quote> convention. The <literal>glibc</literal> + has <literal>libs</literal> as its first output allowing the libraries + provided by <literal>glibc</literal> to be referenced directly (e.g. + <literal>${stdenv.glibc}/lib/ld-linux-x86-64.so.2</literal>). The + executables provided by <literal>glibc</literal> can be accessed via its + <literal>bin</literal> attribute (e.g. + <literal>${stdenv.glibc.bin}/bin/ldd</literal>). + </para> + + <para> + The reason for why <literal>glibc</literal> deviates from the convention is + because referencing a library provided by <literal>glibc</literal> is a + very common operation among Nix packages. For instance, third-party + executables packaged by Nix are typically patched and relinked with the + relevant version of <literal>glibc</literal> libraries from Nix packages + (please see the documentation on + <link xlink:href="https://nixos.org/patchelf.html">patchelf</link> for more + details). + </para> </section> <section xml:id="multiple-output-file-type-groups"> - <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.</para> - <variablelist> - - <varlistentry><term><varname> - $outputDev</varname></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. - </para></listitem> - </varlistentry> - - <varlistentry><term><varname> - $outputBin</varname></term><listitem><para> - is meant for user-facing binaries, typically residing in bin/. They go to <varname>bin</varname> or <varname>out</varname> by default. - </para></listitem></varlistentry> - - <varlistentry><term><varname> - $outputLib</varname></term><listitem><para> - is meant for libraries, typically residing in <filename>lib/</filename> and <filename>libexec/</filename>. They go to <varname>lib</varname> or <varname>out</varname> by default. - </para></listitem></varlistentry> - - <varlistentry><term><varname> - $outputDoc</varname></term><listitem><para> - is for user documentation, typically residing in <filename>share/doc/</filename>. It goes to <varname>doc</varname> or <varname>out</varname> by default. - </para></listitem></varlistentry> - - <varlistentry><term><varname> - $outputDevdoc</varname></term><listitem><para> - is for <emphasis>developer</emphasis> documentation. Currently we count gtk-doc and devhelp books in there. It goes to <varname>devdoc</varname> or is removed (!) by default. This is because e.g. gtk-doc tends to be rather large and completely unused by nixpkgs users. - </para></listitem></varlistentry> - - <varlistentry><term><varname> - $outputMan</varname></term><listitem><para> - is for man pages (except for section 3). They go to <varname>man</varname> or <varname>$outputBin</varname> by default. - </para></listitem></varlistentry> - - <varlistentry><term><varname> - $outputDevman</varname></term><listitem><para> - is for section 3 man pages. They go to <varname>devman</varname> or <varname>$outputMan</varname> by default. - </para></listitem></varlistentry> - - <varlistentry><term><varname> - $outputInfo</varname></term><listitem><para> - is for info pages. They go to <varname>info</varname> or <varname>$outputBin</varname> by default. - </para></listitem></varlistentry> - - </variablelist> - </section> + <title>File type groups</title> - <section><title>Common caveats</title> - <itemizedlist> - <listitem><para>Some configure scripts don't like some of the parameters passed by default by the framework, e.g. <literal>--docdir=/foo/bar</literal>. You can disable this by setting <literal>setOutputFlags = false;</literal>.</para></listitem> - <listitem><para>The outputs of a single derivation can retain references to each other, but note that circular references are not allowed. (And each strongly-connected component would act as a single output anyway.)</para></listitem> - <listitem><para>Most of split packages contain their core functionality in libraries. These libraries tend to refer to various kind of data that typically gets into <varname>out</varname>, e.g. locale strings, so there is often no advantage in separating the libraries into <varname>lib</varname>, as keeping them in <varname>out</varname> is easier.</para></listitem> - <listitem><para>Some packages have hidden assumptions on install paths, which complicates splitting.</para></listitem> - </itemizedlist> + <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. + </para> + + <variablelist> + <varlistentry> + <term><varname> + $outputDev</varname> + </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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname> + $outputBin</varname> + </term> + <listitem> + <para> + is meant for user-facing binaries, typically residing in bin/. They go + to <varname>bin</varname> or <varname>out</varname> by default. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname> + $outputLib</varname> + </term> + <listitem> + <para> + is meant for libraries, typically residing in <filename>lib/</filename> + and <filename>libexec/</filename>. They go to <varname>lib</varname> or + <varname>out</varname> by default. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname> + $outputDoc</varname> + </term> + <listitem> + <para> + is for user documentation, typically residing in + <filename>share/doc/</filename>. It goes to <varname>doc</varname> or + <varname>out</varname> by default. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname> + $outputDevdoc</varname> + </term> + <listitem> + <para> + is for <emphasis>developer</emphasis> documentation. Currently we count + gtk-doc and devhelp books in there. It goes to <varname>devdoc</varname> + or is removed (!) by default. This is because e.g. gtk-doc tends to be + rather large and completely unused by nixpkgs users. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname> + $outputMan</varname> + </term> + <listitem> + <para> + is for man pages (except for section 3). They go to + <varname>man</varname> or <varname>$outputBin</varname> by default. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname> + $outputDevman</varname> + </term> + <listitem> + <para> + is for section 3 man pages. They go to <varname>devman</varname> or + <varname>$outputMan</varname> by default. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname> + $outputInfo</varname> + </term> + <listitem> + <para> + is for info pages. They go to <varname>info</varname> or + <varname>$outputBin</varname> by default. + </para> + </listitem> + </varlistentry> + </variablelist> </section> -</section><!--Writing a split derivation--> + <section> + <title>Common caveats</title> + <itemizedlist> + <listitem> + <para> + Some configure scripts don't like some of the parameters passed by + default by the framework, e.g. <literal>--docdir=/foo/bar</literal>. You + can disable this by setting <literal>setOutputFlags = false;</literal>. + </para> + </listitem> + <listitem> + <para> + The outputs of a single derivation can retain references to each other, + but note that circular references are not allowed. (And each + strongly-connected component would act as a single output anyway.) + </para> + </listitem> + <listitem> + <para> + Most of split packages contain their core functionality in libraries. + These libraries tend to refer to various kind of data that typically gets + into <varname>out</varname>, e.g. locale strings, so there is often no + advantage in separating the libraries into <varname>lib</varname>, as + keeping them in <varname>out</varname> is easier. + </para> + </listitem> + <listitem> + <para> + Some packages have hidden assumptions on install paths, which complicates + splitting. + </para> + </listitem> + </itemizedlist> + </section> + </section> +<!--Writing a split derivation--> </chapter> diff --git a/doc/overlays.xml b/doc/overlays.xml index cc0aef447d2d..2decf9febe80 100644 --- a/doc/overlays.xml +++ b/doc/overlays.xml @@ -1,95 +1,117 @@ <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="chap-overlays"> - -<title>Overlays</title> - -<para>This chapter describes how to extend and change Nixpkgs packages using -overlays. Overlays are used to add layers in the fix-point used by Nixpkgs -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.</para> - + <title>Overlays</title> + <para> + This chapter describes how to extend and change Nixpkgs packages using + overlays. Overlays are used to add layers in the fix-point used by Nixpkgs 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. + </para> <!--============================================================--> - -<section xml:id="sec-overlays-install"> -<title>Installing overlays</title> - -<para>The list of overlays is determined as follows.</para> - -<para>If the <varname>overlays</varname> argument is not provided explicitly, we look for overlays in a path. The path -is determined as follows: - -<orderedlist> - - <listitem> - <para>First, if an <varname>overlays</varname> argument to the nixpkgs function itself is given, - then that is used.</para> - - <para>This can be passed explicitly when importing nipxkgs, for example - <literal>import <nixpkgs> { overlays = [ overlay1 overlay2 ]; }</literal>.</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.</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></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.</para> - </listitem> - -</orderedlist> -</para> - -<para>If we are looking for overlays at a path, then there are two cases: -<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.</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: - <itemizedlist> - <listitem> - <para>Importing the file, if it is a <literal>.nix</literal> file.</para> - </listitem> - <listitem> - <para>Importing a top-level <filename>default.nix</filename> file, if it is a directory.</para> - </listitem> - </itemizedlist> - </para> - </listitem> -</itemizedlist> -</para> - -<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 looked up independently.</para> - -<para>The <filename>overlays.nix</filename> option therefore provides a convenient way to use the same -overlays for a NixOS system configuration and user configuration: the same file can be used -as <filename>overlays.nix</filename> and imported as the value of <literal>nixpkgs.overlays</literal>.</para> - -</section> - + <section xml:id="sec-overlays-install"> + <title>Installing overlays</title> + + <para> + The list of overlays is determined as follows. + </para> + + <para> + If the <varname>overlays</varname> argument is not provided explicitly, we + look for overlays in a path. The path is determined as follows: + <orderedlist> + <listitem> + <para> + First, if an <varname>overlays</varname> argument to the nixpkgs function + itself is given, then that is used. + </para> + <para> + This can be passed explicitly when importing nipxkgs, for example + <literal>import <nixpkgs> { overlays = [ overlay1 overlay2 ]; + }</literal>. + </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. + </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> + </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. + </para> + </listitem> + </orderedlist> + </para> + + <para> + If we are looking for overlays at a path, then there are two cases: + <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. + </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: + <itemizedlist> + <listitem> + <para> + Importing the file, if it is a <literal>.nix</literal> file. + </para> + </listitem> + <listitem> + <para> + Importing a top-level <filename>default.nix</filename> file, if it is + a directory. + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + </itemizedlist> + </para> + + <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 looked up independently. + </para> + + <para> + The <filename>overlays.nix</filename> option therefore provides a convenient + way to use the same overlays for a NixOS system configuration and user + configuration: the same file can be used as + <filename>overlays.nix</filename> and imported as the value of + <literal>nixpkgs.overlays</literal>. + </para> + </section> <!--============================================================--> + <section xml:id="sec-overlays-definition"> + <title>Defining overlays</title> -<section xml:id="sec-overlays-definition"> -<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.</para> + <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. + </para> <programlisting> self: super: @@ -104,31 +126,39 @@ 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.</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.</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.</para> - -<para>Overlays are similar to other methods for customizing Nixpkgs, in particular -the <literal>packageOverrides</literal> attribute described in <xref linkend="sec-modify-via-packageOverrides"/>. -Indeed, <literal>packageOverrides</literal> acts as an overlay with only the -<varname>super</varname> argument. It is therefore appropriate for basic use, -but overlays are more powerful and easier to distribute.</para> - -</section> - + <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. + </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. + </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. + </para> + + <para> + Overlays are similar to other methods for customizing Nixpkgs, in particular + the <literal>packageOverrides</literal> attribute described in + <xref linkend="sec-modify-via-packageOverrides"/>. Indeed, + <literal>packageOverrides</literal> acts as an overlay with only the + <varname>super</varname> argument. It is therefore appropriate for basic + use, but overlays are more powerful and easier to distribute. + </para> + </section> </chapter> diff --git a/doc/package-notes.xml b/doc/package-notes.xml index 1fccfd5d329d..f16826ae6806 100644 --- a/doc/package-notes.xml +++ b/doc/package-notes.xml @@ -1,206 +1,185 @@ <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" 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.</para> - - + <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. + </para> <!--============================================================--> + <section xml:id="sec-linux-kernel"> + <title>Linux kernel</title> -<section xml:id="sec-linux-kernel"> - -<title>Linux kernel</title> - -<para>The Nix expressions to build the Linux kernel are in <link -xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/os-specific/linux/kernel"><filename>pkgs/os-specific/linux/kernel</filename></link>.</para> - -<para>The function that builds the kernel has an argument -<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 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 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: + <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>). + </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: <programlisting> modulesTree = [kernel] ++ pkgs.lib.optional (!kernel.features ? iwlwifi) kernelPackages.iwlwifi ++ ...; </programlisting> + </para> -</para> - -<para>How to add a new (major) version of the Linux kernel to Nixpkgs: - -<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.</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>).</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: - + <para> + How to add a new (major) version of the Linux kernel to Nixpkgs: + <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. + </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>). + </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: <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>).</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. - </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>). - </para> - </listitem> - - <listitem> - <para>If needed you can also run <literal>make - menuconfig</literal>: - - <screen> + <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>). + </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. + </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>). + </para> + </listitem> + <listitem> + <para> + If needed you can also run <literal>make menuconfig</literal>: +<screen> $ nix-env -i ncurses $ export NIX_CFLAGS_LINK=-lncurses $ make menuconfig ARCH=<replaceable>arch</replaceable></screen> - - </para> - </listitem> - - <listitem> - <para>Copy <filename>.config</filename> over the new config - file (e.g. <filename>config-2.6.22-i686-smp</filename>).</para> - </listitem> - + </para> + </listitem> + <listitem> + <para> + Copy <filename>.config</filename> over the new config file (e.g. + <filename>config-2.6.22-i686-smp</filename>). + </para> + </listitem> </orderedlist> - - </para> - - </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.</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.</para> - </listitem> - -</orderedlist> - -</para> - -</section> - - + </para> + </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. + </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. + </para> + </listitem> + </orderedlist> + </para> + </section> <!--============================================================--> + <section xml:id="sec-xorg"> + <title>X.org</title> -<section xml:id="sec-xorg"> - -<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.</para> - -<para>The generator is invoked as follows: + <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. + </para> + <para> + The generator is invoked as follows: <screen> $ cd pkgs/servers/x11/xorg $ 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.) + </para> -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: - + <para> + A file like <filename>tarballs-7.5.list</filename> contains all tarballs in + a X.org release. It can be generated like this: <screen> $ export i="mirror://xorg/X11R7.4/src/everything/" $ 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>). + </para> -<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>.</para> - -</section> - - - + <para> + If the expression for a package requires derivation attributes that the + generator cannot figure out automatically (say, <varname>patches</varname> + or a <varname>postInstall</varname> hook), you should modify + <filename>pkgs/servers/x11/xorg/overrides.nix</filename>. + </para> + </section> <!--============================================================--> - <!-- <section> <title>Gnome</title> @@ -208,65 +187,53 @@ you should modify <para>* How to update</para> </section> --> - - <!--============================================================--> - <!-- <section> <title>GCC</title> <para>…</para> </section> --> - <!--============================================================--> - -<section xml:id="sec-eclipse"> - + <section xml:id="sec-eclipse"> <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> $ 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 { @@ -276,42 +243,38 @@ 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> $ 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 { @@ -343,210 +306,214 @@ packageOverrides = pkgs: { } </screen> </para> + </section> + <section xml:id="sec-elm"> + <title>Elm</title> -</section> - -<section xml:id="sec-elm"> - -<title>Elm</title> - -<para> -The Nix expressions for Elm reside in -<filename>pkgs/development/compilers/elm</filename>. They are generated -automatically by <command>update-elm.rb</command> script. One should -specify versions of Elm packages inside the script, clear the -<filename>packages</filename> directory and run the script from inside it. -<literal>elm-reactor</literal> is special because it also has Elm package -dependencies. The process is not automated very much for now -- you should -get the <literal>elm-reactor</literal> source tree (e.g. with -<command>nix-shell</command>) and run <command>elm2nix.rb</command> inside -it. Place the resulting <filename>package.nix</filename> file into -<filename>packages/elm-reactor-elm.nix</filename>. -</para> - -</section> - -<section xml:id="sec-shell-helpers"> - -<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: + <para> + The Nix expressions for Elm reside in + <filename>pkgs/development/compilers/elm</filename>. They are generated + automatically by <command>update-elm.rb</command> script. One should specify + versions of Elm packages inside the script, clear the + <filename>packages</filename> directory and run the script from inside it. + <literal>elm-reactor</literal> is special because it also has Elm package + dependencies. The process is not automated very much for now -- you should + get the <literal>elm-reactor</literal> source tree (e.g. with + <command>nix-shell</command>) and run <command>elm2nix.rb</command> inside + it. Place the resulting <filename>package.nix</filename> file into + <filename>packages/elm-reactor-elm.nix</filename>. + </para> + </section> + <section xml:id="sec-shell-helpers"> + <title>Interactive shell helpers</title> - <itemizedlist> + <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: + <itemizedlist> <listitem> - <para> - <literal>autojump</literal>: <command>autojump-share</command> - </para> + <para> + <literal>autojump</literal>: <command>autojump-share</command> + </para> </listitem> <listitem> - <para> - <literal>fzf</literal>: <command>fzf-share</command> - </para> + <para> + <literal>fzf</literal>: <command>fzf-share</command> + </para> </listitem> - </itemizedlist> - - E.g. <literal>autojump</literal> can then used in the .bashrc like this: + </itemizedlist> + E.g. <literal>autojump</literal> can then used in the .bashrc like this: <screen> source "$(autojump-share)/autojump.bash" </screen> -</para> - -</section> - -<section xml:id="sec-steam"> - -<title>Steam</title> - -<section xml:id="sec-steam-nix"> - -<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. -</para> -<para> - Nix problems and constraints: -<itemizedlist> - <listitem><para>We don't have <filename>/bin/bash</filename> and many - scripts point there. Similarly for <filename>/usr/bin/python</filename> - .</para></listitem> - <listitem><para>We don't have the dynamic loader in <filename>/lib - </filename>.</para></listitem> - <listitem><para>The <filename>steam.sh</filename> script in $HOME can - not be patched, as it is checked and rewritten by steam.</para></listitem> - <listitem><para>The steam binary cannot be patched, it's also checked.</para></listitem> -</itemizedlist> -</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. -</para> - -</section> - -<section xml:id="sec-steam-play"> - -<title>How to play</title> - -<para> - For 64-bit systems it's important to have - <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, you need to add - <programlisting>services.udev.extraRules = '' + </para> + </section> + <section xml:id="sec-steam"> + <title>Steam</title> + + <section xml:id="sec-steam-nix"> + <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. + </para> + + <para> + Nix problems and constraints: + <itemizedlist> + <listitem> + <para> + We don't have <filename>/bin/bash</filename> and many scripts point + there. Similarly for <filename>/usr/bin/python</filename> . + </para> + </listitem> + <listitem> + <para> + We don't have the dynamic loader in <filename>/lib </filename>. + </para> + </listitem> + <listitem> + <para> + The <filename>steam.sh</filename> script in $HOME can not be patched, as + it is checked and rewritten by steam. + </para> + </listitem> + <listitem> + <para> + The steam binary cannot be patched, it's also checked. + </para> + </listitem> + </itemizedlist> + </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. + </para> + </section> + + <section xml:id="sec-steam-play"> + <title>How to play</title> + + <para> + For 64-bit systems it's important to have +<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, you need to add +<programlisting>services.udev.extraRules = '' SUBSYSTEM=="usb", ATTRS{idVendor}=="28de", MODE="0666" KERNEL=="uinput", MODE="0660", GROUP="users", OPTIONS+="static_node=uinput" '';</programlisting> - to your configuration. -</para> - -</section> - -<section xml:id="sec-steam-troub"> - -<title>Troubleshooting</title> - -<para> -<variablelist> - - <varlistentry> - <term>Steam fails to start. What do I do?</term> - <listitem><para>Try to run - <programlisting>strace steam</programlisting> - to see what is causing steam to fail.</para></listitem> - </varlistentry> - - <varlistentry> - <term>Using the FOSS Radeon or nouveau (nvidia) drivers</term> - <listitem><itemizedlist> - <listitem><para>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 - <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>. - </para></listitem> - - </itemizedlist></listitem></varlistentry> - - <varlistentry> - <term>Java</term> - <listitem><orderedlist> - <listitem><para> - There is no java in steam chrootenv by default. If you get a message like - <programlisting>/home/foo/.local/share/Steam/SteamApps/common/towns/towns.sh: line 1: java: command not found</programlisting> - You need to add - <programlisting> steam.override { withJava = true; };</programlisting> - to your configuration. - </para></listitem> - </orderedlist></listitem></varlistentry> - -</variablelist> -</para> - -</section> - -<section xml:id="sec-steam-run"> - -<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 + to your configuration. + </para> + </section> + + <section xml:id="sec-steam-troub"> + <title>Troubleshooting</title> + + <para> + <variablelist> + <varlistentry> + <term>Steam fails to start. What do I do?</term> + <listitem> + <para> + Try to run +<programlisting>strace steam</programlisting> + to see what is causing steam to fail. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Using the FOSS Radeon or nouveau (nvidia) drivers</term> + <listitem> + <itemizedlist> + <listitem> + <para> + 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 +<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>. + </para> + </listitem> + </itemizedlist> + </listitem> + </varlistentry> + <varlistentry> + <term>Java</term> + <listitem> + <orderedlist> + <listitem> + <para> + There is no java in steam chrootenv by default. If you get a message + like +<programlisting>/home/foo/.local/share/Steam/SteamApps/common/towns/towns.sh: line 1: java: command not found</programlisting> + You need to add +<programlisting> steam.override { withJava = true; };</programlisting> + to your configuration. + </para> + </listitem> + </orderedlist> + </listitem> + </varlistentry> + </variablelist> + </para> + </section> + + <section xml:id="sec-steam-run"> + <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 <programlisting>pkgs.(steam.override { nativeOnly = true; newStdcpp = true; }).run</programlisting> -to your configuration, rebuild, and run the game with + to your configuration, rebuild, and run the game with <programlisting>steam-run ./foo</programlisting> -</para> - -</section> - -</section> - -<section xml:id="sec-emacs"> - -<title>Emacs</title> - -<section xml:id="sec-emacs-config"> - -<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: -</para> + </para> + </section> + </section> + <section xml:id="sec-emacs"> + <title>Emacs</title> + + <section xml:id="sec-emacs-config"> + <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: + </para> <screen> { @@ -564,17 +531,17 @@ to your configuration, rebuild, and run the game with } </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. -</para> + <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. + </para> <screen> { @@ -654,25 +621,24 @@ 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. -</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>. -</para> + <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. + </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>. + </para> <screen> overrides = super: self: rec { @@ -685,34 +651,34 @@ overrides = super: self: rec { dante ]) </screen> + </section> + </section> + <section xml:id="sec-weechat"> + <title>Weechat</title> -</section> - -</section> - -<section xml:id="sec-weechat"> -<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 + <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 <programlisting>weechat.override {configure = {availablePlugins, ...}: { plugins = with availablePlugins; [ python perl ]; } }</programlisting> -</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>. -</para> -<para> -The python plugin 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 <literal>python</literal> -plugin's <literal>withPackages</literal> attribute: + </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>. + </para> + + <para> + The python plugin 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 <literal>python</literal> plugin's + <literal>withPackages</literal> attribute: <programlisting>weechat.override { configure = {availablePlugins, ...}: { plugins = with availablePlugins; [ (python.withPackages (ps: with ps; [ pycrypto python-dbus ])) @@ -720,16 +686,17 @@ plugin's <literal>withPackages</literal> attribute: } } </programlisting> -</para> -<para> -In order to also keep all default plugins installed, it is possible to use -the following method: + </para> + + <para> + 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 ]); }); }; } </programlisting> -</para> -</section> + </para> + </section> </chapter> diff --git a/doc/platform-notes.xml b/doc/platform-notes.xml index f4f6ec600294..b2c20c2d35c0 100644 --- a/doc/platform-notes.xml +++ b/doc/platform-notes.xml @@ -1,27 +1,25 @@ <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="chap-platform-nodes"> + <title>Platform Notes</title> + <section xml:id="sec-darwin"> + <title>Darwin (macOS)</title> -<title>Platform Notes</title> + <para> + Some common issues when packaging software for darwin: + </para> -<section xml:id="sec-darwin"> - -<title>Darwin (macOS)</title> -<para>Some common issues when packaging software for darwin:</para> - -<itemizedlist> - - <listitem> + <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> +<programlisting> stdenv.mkDerivation { name = "libfoo-1.2.3"; # ... @@ -30,36 +28,33 @@ ''; } </programlisting> - </listitem> - - <listitem> + </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> +<programlisting> stdenv.mkDerivation { name = "libfoo-1.2.3"; # ... makeFlags = stdenv.lib.optional stdenv.isDarwin "LDFLAGS=-Wl,-install_name,$(out)/lib/libfoo.dylib"; } </programlisting> - </listitem> - - <listitem> + </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> +<programlisting> stdenv.mkDerivation { name = "libfoo-1.2.3"; # ... @@ -69,15 +64,12 @@ ''; } </programlisting> - <para> - The package <literal>xcbuild</literal> can be used to build projects - that really depend on Xcode, however projects that build some kind of - graphical interface won't work without using Xcode in an impure way. + The package <literal>xcbuild</literal> can be used to build projects that + really depend on Xcode, however projects that build some kind of graphical + interface won't work without using Xcode in an impure way. </para> - </listitem> - -</itemizedlist> -</section> - + </listitem> + </itemizedlist> + </section> </chapter> diff --git a/doc/quick-start.xml b/doc/quick-start.xml index ca86e6c9519b..0cba3a4769c4 100644 --- a/doc/quick-start.xml +++ b/doc/quick-start.xml @@ -1,223 +1,219 @@ <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="chap-quick-start"> - -<title>Quick Start to Adding a Package</title> - -<para>To add a package to Nixpkgs: - -<orderedlist> - - <listitem> - <para>Checkout the Nixpkgs source tree: - + <title>Quick Start to Adding a Package</title> + <para> + To add a package to Nixpkgs: + <orderedlist> + <listitem> + <para> + Checkout the Nixpkgs source tree: <screen> $ git clone git://github.com/NixOS/nixpkgs.git $ cd nixpkgs</screen> - </para> - </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. - + </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. <screen> $ 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>. - + </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>. <screen> $ emacs pkgs/development/libraries/libfoo/default.nix $ 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: - - <itemizedlist> - - <listitem> - <para>GNU Hello: <link + <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: + <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.</para> - </listitem> - - <listitem> - <para>GNU cpio: <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>.</para> - </listitem> - - <listitem> - <para>GNU Multiple Precision arithmetic library (GMP): <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>.</para> - </listitem> - - <listitem> - <para>Pan, a GTK-based newsreader: <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>.</para> - </listitem> - - <listitem> - <para>Apache HTTPD: <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.</para> - </listitem> - - <listitem> - <para>Thunderbird: <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.</para> - </listitem> - - <listitem> - <para>JDiskReport, a Java utility: <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 + (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 + 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.</para> - </listitem> - - <listitem> - <para>Adobe Reader: <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 + 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> - + 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> </para> - - <para>Some notes: - - <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 - linkend="sec-meta-license">license</varname>.</para> - </listitem> - - <listitem> - <para>You can use <command>nix-prefetch-url</command> (or similar nix-prefetch-git, etc) - <replaceable>url</replaceable> to get the SHA-256 hash of - source distributions. There are similar commands as <command>nix-prefetch-git</command> and - <command>nix-prefetch-hg</command> available in <literal>nix-prefetch-scripts</literal> package.</para> - </listitem> - - <listitem> - <para>A list of schemes for <literal>mirror://</literal> - URLs can be found in <link - xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/build-support/fetchurl/mirrors.nix"><filename>pkgs/build-support/fetchurl/mirrors.nix</filename></link>.</para> - </listitem> - - </itemizedlist> - + <para> + Some notes: + <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 + linkend="sec-meta-license">license</varname>. + </para> + </listitem> + <listitem> + <para> + You can use <command>nix-prefetch-url</command> (or similar + nix-prefetch-git, etc) <replaceable>url</replaceable> to get the + SHA-256 hash of source distributions. There are similar commands as + <command>nix-prefetch-git</command> and + <command>nix-prefetch-hg</command> available in + <literal>nix-prefetch-scripts</literal> package. + </para> + </listitem> + <listitem> + <para> + A list of schemes for <literal>mirror://</literal> URLs can be found in + <link + xlink:href="https://github.com/NixOS/nixpkgs/blob/master/pkgs/build-support/fetchurl/mirrors.nix"><filename>pkgs/build-support/fetchurl/mirrors.nix</filename></link>. + </para> + </listitem> + </itemizedlist> </para> - - <para>The exact syntax and semantics of the Nix expression - language, including the built-in function, are described in the - Nix manual in the <link + <para> + The exact syntax and semantics of the Nix expression language, including + the built-in function, are described in the Nix manual in the + <link xlink:href="http://hydra.nixos.org/job/nix/trunk/tarball/latest/download-by-type/doc/manual/#chap-writing-nix-expressions">chapter - on writing Nix expressions</link>.</para> - - </listitem> - - <listitem> - <para>Add a call to the function defined in the previous step to - <link + 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>. - - <screen> + with some descriptive name for the variable, e.g. + <varname>libfoo</varname>. +<screen> $ 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.</para> - </listitem> - - <listitem> - <para>To test whether the package builds, run the following command - from the root of the nixpkgs source tree: - - <screen> + <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. + </para> + </listitem> + <listitem> + <para> + To test whether the package builds, run the following command from the + root of the nixpkgs source tree: +<screen> $ 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.</para> - </listitem> - - <listitem> - <para>If you want to install the package into your profile - (optional), do - - <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. + </para> + </listitem> + <listitem> + <para> + If you want to install the package into your profile (optional), do +<screen> $ nix-env -f . -iA libfoo</screen> - </para> - </listitem> - - <listitem> - <para>Optionally commit the new package and open a pull request, or send a patch to - <literal>https://groups.google.com/forum/#!forum/nix-devel</literal>.</para> - </listitem> - - -</orderedlist> - -</para> - + </listitem> + <listitem> + <para> + Optionally commit the new package and open a pull request, or send a patch + to <literal>https://groups.google.com/forum/#!forum/nix-devel</literal>. + </para> + </listitem> + </orderedlist> + </para> </chapter> diff --git a/doc/release-notes.xml b/doc/release-notes.xml index a50ee877acdd..6dae6ae5620e 100644 --- a/doc/release-notes.xml +++ b/doc/release-notes.xml @@ -1,164 +1,177 @@ <?xml version="1.0" encoding="UTF-8"?> <article xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <title>Nixpkgs Release Notes</title> + <section> + <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.) + </para> -<title>Nixpkgs Release Notes</title> - - -<section><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.)</para> - -<para>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><title>Release 0.13 (February 5, 2010)</title> - -<para>As always, there are many changes. Some of the most important -updates are: - -<itemizedlist> - - <listitem><para>Glibc 2.9.</para></listitem> - - <listitem><para>GCC 4.3.3.</para></listitem> - - <listitem><para>Linux 2.6.32.</para></listitem> - - <listitem><para>X.org 7.5.</para></listitem> - - <listitem><para>KDE 4.3.4.</para></listitem> - -</itemizedlist> - -</para> - - -</section> - - -<section><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: - -<itemizedlist> - - <listitem><para>Nixpkgs now has a manual. In particular, it - describes the standard build environment in - detail.</para></listitem> - - <listitem><para>Major new packages: - - <itemizedlist> - - <listitem><para>KDE 4.</para></listitem> - - <listitem><para>TeXLive.</para></listitem> - - <listitem><para>VirtualBox.</para></listitem> - - </itemizedlist> - - … and many others. - - </para></listitem> - - <listitem><para>Important updates: - - <itemizedlist> - - <listitem><para>Glibc 2.7.</para></listitem> - - <listitem><para>GCC 4.2.4.</para></listitem> - - <listitem><para>Linux 2.6.25 — 2.6.28.</para></listitem> - - <listitem><para>Firefox 3.</para></listitem> - - <listitem><para>X.org 7.3.</para></listitem> - - </itemizedlist> - - </para></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.</para></listitem> - - <listitem><para>Improved support for building Haskell - packages.</para></listitem> - -</itemizedlist> - -</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.</para> - -</section> - - -<section><title>Release 0.11 (September 11, 2007)</title> - -<para>This release has the following improvements: - -<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.</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: + <para> + 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> + <title>Release 0.13 (February 5, 2010)</title> + + <para> + As always, there are many changes. Some of the most important updates are: + <itemizedlist> + <listitem> + <para> + Glibc 2.9. + </para> + </listitem> + <listitem> + <para> + GCC 4.3.3. + </para> + </listitem> + <listitem> + <para> + Linux 2.6.32. + </para> + </listitem> + <listitem> + <para> + X.org 7.5. + </para> + </listitem> + <listitem> + <para> + KDE 4.3.4. + </para> + </listitem> + </itemizedlist> + </para> + </section> + <section> + <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: + <itemizedlist> + <listitem> + <para> + Nixpkgs now has a manual. In particular, it describes the standard build + environment in detail. + </para> + </listitem> + <listitem> + <para> + Major new packages: + <itemizedlist> + <listitem> + <para> + KDE 4. + </para> + </listitem> + <listitem> + <para> + TeXLive. + </para> + </listitem> + <listitem> + <para> + VirtualBox. + </para> + </listitem> + </itemizedlist> + … and many others. + </para> + </listitem> + <listitem> + <para> + Important updates: + <itemizedlist> + <listitem> + <para> + Glibc 2.7. + </para> + </listitem> + <listitem> + <para> + GCC 4.2.4. + </para> + </listitem> + <listitem> + <para> + Linux 2.6.25 — 2.6.28. + </para> + </listitem> + <listitem> + <para> + Firefox 3. + </para> + </listitem> + <listitem> + <para> + X.org 7.3. + </para> + </listitem> + </itemizedlist> + </para> + </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. + </para> + </listitem> + <listitem> + <para> + Improved support for building Haskell packages. + </para> + </listitem> + </itemizedlist> + </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. + </para> + </section> + <section> + <title>Release 0.11 (September 11, 2007)</title> + + <para> + This release has the following improvements: + <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. + </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: <programlisting> source $stdenv/setup @@ -169,290 +182,311 @@ 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.</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, - + 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, <programlisting> configureFlags="CFLAGS=-O0"</programlisting> - - but not - + 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 - + 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>.</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., - + 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., <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 - + </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 <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 + <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 + 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: + 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: <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> + </listitem> + <listitem> + <para> + Important updates: + <itemizedlist> + <listitem> + <para> + Glibc 2.5. + </para> + </listitem> + <listitem> + <para> + GCC 4.1.2. + </para> + </listitem> + <listitem> + <para> + Gnome 2.16.3. + </para> + </listitem> + <listitem> + <para> + X11R7.2. + </para> + </listitem> + <listitem> + <para> + Linux 2.6.21.7 and 2.6.22.6. + </para> + </listitem> + <listitem> + <para> + Emacs 22.1. + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + <listitem> + <para> + Major new packages: + <itemizedlist> + <listitem> + <para> + KDE 3.5.6 Base. + </para> + </listitem> + <listitem> + <para> + Wine 0.9.43. + </para> + </listitem> + <listitem> + <para> + OpenOffice 2.2.1. + </para> + </listitem> + <listitem> + <para> + Many Linux system packages to support NixOS. + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + </itemizedlist> </para> - </listitem> - - - <listitem><para>Important updates: - - <itemizedlist> - - <listitem><para>Glibc 2.5.</para></listitem> - - <listitem><para>GCC 4.1.2.</para></listitem> - - <listitem><para>Gnome 2.16.3.</para></listitem> - - <listitem><para>X11R7.2.</para></listitem> - - <listitem><para>Linux 2.6.21.7 and 2.6.22.6.</para></listitem> - - <listitem><para>Emacs 22.1.</para></listitem> - - </itemizedlist> - - </para></listitem> - - - <listitem><para>Major new packages: - - <itemizedlist> - - <listitem><para>KDE 3.5.6 Base.</para></listitem> - - <listitem><para>Wine 0.9.43.</para></listitem> - - <listitem><para>OpenOffice 2.2.1.</para></listitem> - - <listitem><para>Many Linux system packages to support - NixOS.</para></listitem> - - </itemizedlist> - - </para></listitem> - -</itemizedlist> - -</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. - -</para> - -</section> - - -<section><title>Release 0.10 (October 12, 2006)</title> - -<note><para>This release of Nixpkgs requires <link -xlink:href='http://nixos.org/releases/nix/nix-0.10/'>Nix -0.10</link> or higher.</para></note> - -<para>This release has the following improvements:</para> - -<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.</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.</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: + <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. + </para> + </section> + <section> + <title>Release 0.10 (October 12, 2006)</title> + + <note> + <para> + This release of Nixpkgs requires + <link +xlink:href='http://nixos.org/releases/nix/nix-0.10/'>Nix 0.10</link> + or higher. + </para> + </note> + + <para> + This release has the following improvements: + </para> + <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. + </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. + </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: <programlisting> { firefox = { enableRealPlayer = true; }; }</programlisting> - - 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.)</para></listitem> - - <listitem><para>Support for new platforms: - - <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>.</para></listitem> - - <listitem><para><literal>i686-darwin</literal>, i.e., Mac OS X - on Intel CPUs.</para></listitem> - - <listitem><para><literal>powerpc-linux</literal>.</para></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.</para></listitem> - - </itemizedlist> - + persistently enables RealPlayer support in the Firefox build. </para> - - </listitem> - - <listitem><para>The default compiler is now GCC 4.1.1.</para></listitem> - - <listitem><para>X11 updated to X.org’s X11R7.1.</para></listitem> - - <listitem><para>Notable new packages: - - <itemizedlist> - - <listitem><para>Opera.</para></listitem> - - <listitem><para>Microsoft Visual C++ 2005 Express Edition and - the Windows SDK.</para></listitem> - - </itemizedlist> - - In total there are now around 809 packages in Nixpkgs.</para> - - </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.</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: - + <para> + (Actually, <literal>firefox.enableRealPlayer</literal> is the + <emphasis>only</emphasis> configuration option currently available, but + more are sure to be added.) + </para> + </listitem> + <listitem> + <para> + Support for new platforms: + <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>. + </para> + </listitem> + <listitem> + <para> + <literal>i686-darwin</literal>, i.e., Mac OS X on Intel CPUs. + </para> + </listitem> + <listitem> + <para> + <literal>powerpc-linux</literal>. + </para> + </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. + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + <listitem> + <para> + The default compiler is now GCC 4.1.1. + </para> + </listitem> + <listitem> + <para> + X11 updated to X.org’s X11R7.1. + </para> + </listitem> + <listitem> + <para> + Notable new packages: + <itemizedlist> + <listitem> + <para> + Opera. + </para> + </listitem> + <listitem> + <para> + Microsoft Visual C++ 2005 Express Edition and the Windows SDK. + </para> + </listitem> + </itemizedlist> + In total there are now around 809 packages in Nixpkgs. + </para> + </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. + </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: <programlisting> strategoxt = (import ../development/compilers/strategoxt) { inherit fetchurl pkgconfig sdf aterm; @@ -460,44 +494,37 @@ 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; stdenv = overrideGCC stdenv gcc34; };</programlisting> - - </para></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: - + </para> + </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: <programlisting> pkg = import <replaceable>...</replaceable> { stdenv = stdenv.regenerate ./my-setup.sh; <replaceable>...</replaceable> }</programlisting> - - </para></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: - + </para> + </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: <programlisting> stdenv.mkDerivation { name = "exult-1.2"; @@ -506,228 +533,268 @@ 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.).</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. - -</para> - -</section> - - -<section><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:</para> - -<itemizedlist> - - <listitem><para>Distribution files have been moved to <link - xlink:href="http://nixos.org/" />.</para></listitem> - - <listitem><para>The C library on Linux, Glibc, has been updated to - version 2.3.6.</para></listitem> - - <listitem><para>The default compiler is now GCC 3.4.5. GCC 4.0.2 is - also available.</para></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.</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.</para></listitem> - - <listitem><para>Hardware-accelerated OpenGL support, used by games - like Quake 3 (which is now built from source).</para></listitem> - - <listitem><para>Improved support for FreeBSD on - x86.</para></listitem> - - <listitem><para>Improved Haskell support; e.g., the GHC build is now - pure.</para></listitem> - - <listitem><para>Some support for cross-compilation: cross-compiling - builds of GCC and Binutils, and cross-compiled builds of the C - library uClibc.</para></listitem> - - <listitem><para>Notable new packages: - - <itemizedlist> - - <listitem><para>teTeX, including support for building LaTeX - documents using Nix (with automatic dependency - determination).</para></listitem> - - <listitem><para>Ruby.</para></listitem> - - <listitem><para>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.</para></listitem> - - <listitem><para><literal>php</literal>.</para></listitem> - - <listitem><para>The GIMP.</para></listitem> - - <listitem><para>Inkscape.</para></listitem> - - <listitem><para>GAIM.</para></listitem> - - <listitem><para><literal>kdelibs</literal>. This allows us to - add KDE-based packages (such as - <literal>kcachegrind</literal>).</para></listitem> - - </itemizedlist> - - </para></listitem> - -</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. - -</para> - -</section> - - -<section><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.</para> - -<para>Notable updates: - -<itemizedlist> - - <listitem><para>Adobe Reader 7.0</para></listitem> - - <listitem><para>Various security updates (zlib 1.2.2, etc.)</para></listitem> - -</itemizedlist> - -</para> - -</section> - - -<section><title>Release 0.7 (March 14, 2005)</title> - -<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.</para> - - <para>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.)</para> - -</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.</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.</para> - -</listitem> - -<listitem> - - <para>Notable new packages: - - <itemizedlist> - - <listitem><para>Qt 3</para></listitem> - <listitem><para>MySQL</para></listitem> - <listitem><para>MythTV</para></listitem> - <listitem><para>Mono</para></listitem> - <listitem><para>MonoDevelop (alpha)</para></listitem> - <listitem><para>Xine</para></listitem> - + 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. + </para> + </section> + <section> + <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: </para> - -</listitem> - -<listitem> - - <para>Notable updates: <itemizedlist> - - <listitem><para>GCC 3.4.3</para></listitem> - <listitem><para>Glibc 2.3.4</para></listitem> - <listitem><para>GTK 2.6</para></listitem> - + <listitem> + <para> + Distribution files have been moved to + <link + xlink:href="http://nixos.org/" />. + </para> + </listitem> + <listitem> + <para> + The C library on Linux, Glibc, has been updated to version 2.3.6. + </para> + </listitem> + <listitem> + <para> + The default compiler is now GCC 3.4.5. GCC 4.0.2 is also available. + </para> + </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. + </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. + </para> + </listitem> + <listitem> + <para> + Hardware-accelerated OpenGL support, used by games like Quake 3 (which is + now built from source). + </para> + </listitem> + <listitem> + <para> + Improved support for FreeBSD on x86. + </para> + </listitem> + <listitem> + <para> + Improved Haskell support; e.g., the GHC build is now pure. + </para> + </listitem> + <listitem> + <para> + Some support for cross-compilation: cross-compiling builds of GCC and + Binutils, and cross-compiled builds of the C library uClibc. + </para> + </listitem> + <listitem> + <para> + Notable new packages: + <itemizedlist> + <listitem> + <para> + teTeX, including support for building LaTeX documents using Nix (with + automatic dependency determination). + </para> + </listitem> + <listitem> + <para> + Ruby. + </para> + </listitem> + <listitem> + <para> + 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. + </para> + </listitem> + <listitem> + <para> + <literal>php</literal>. + </para> + </listitem> + <listitem> + <para> + The GIMP. + </para> + </listitem> + <listitem> + <para> + Inkscape. + </para> + </listitem> + <listitem> + <para> + GAIM. + </para> + </listitem> + <listitem> + <para> + <literal>kdelibs</literal>. This allows us to add KDE-based packages + (such as <literal>kcachegrind</literal>). + </para> + </listitem> + </itemizedlist> + </para> + </listitem> </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. </para> + </section> + <section> + <title>Release 0.8 (April 11, 2005)</title> -</listitem> - -</itemizedlist> + <para> + This release is mostly to remain synchronised with the changed hashing + scheme in Nix 0.8. + </para> -</section> + <para> + Notable updates: + <itemizedlist> + <listitem> + <para> + Adobe Reader 7.0 + </para> + </listitem> + <listitem> + <para> + Various security updates (zlib 1.2.2, etc.) + </para> + </listitem> + </itemizedlist> + </para> + </section> + <section> + <title>Release 0.7 (March 14, 2005)</title> - + <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. + </para> + <para> + 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.) + </para> + </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. + </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. + </para> + </listitem> + <listitem> + <para> + Notable new packages: + <itemizedlist> + <listitem> + <para> + Qt 3 + </para> + </listitem> + <listitem> + <para> + MySQL + </para> + </listitem> + <listitem> + <para> + MythTV + </para> + </listitem> + <listitem> + <para> + Mono + </para> + </listitem> + <listitem> + <para> + MonoDevelop (alpha) + </para> + </listitem> + <listitem> + <para> + Xine + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + <listitem> + <para> + Notable updates: + <itemizedlist> + <listitem> + <para> + GCC 3.4.3 + </para> + </listitem> + <listitem> + <para> + Glibc 2.3.4 + </para> + </listitem> + <listitem> + <para> + GTK 2.6 + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + </itemizedlist> + </section> </article> diff --git a/doc/reviewing-contributions.xml b/doc/reviewing-contributions.xml index 7b017f0a8cc4..b648691183b8 100644 --- a/doc/reviewing-contributions.xml +++ b/doc/reviewing-contributions.xml @@ -3,95 +3,148 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-reviewing-contributions"> - -<title>Reviewing contributions</title> - -<warning> - <para>The following section is a draft and reviewing policy is still being - discussed.</para> -</warning> - -<para>The nixpkgs projects 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 make any pull request that is open for - long enough subject to conflicts that will require extra work from the - submitter or the merger. Reviewing pull requests in a timely manner and being + <title>Reviewing contributions</title> + <warning> + <para> + The following section is a draft and reviewing policy is still being + discussed. + </para> + </warning> + <para> + The nixpkgs projects 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 make any pull request that is open for long + enough subject to conflicts that will require extra work from the submitter + or the merger. Reviewing pull requests in a timely manner and being responsive to the comments is the key to avoid these. GitHub provides sort - filters that can be used to see the <link + filters that can be used to see the + <link xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc">most - recently</link> and the <link + recently</link> and the + <link xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-asc">least - 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. + 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 members and their work.</para> - -<para>GitHub provides reactions, they are a simple and quick way to provide + to respect every community members and their work. + </para> + <para> + GitHub provides reactions, they are a simple and quick way to provide feedback to pull-requests or any comments. The thumb-down reaction should be used with care and if possible accompanied with some explanations so the - submitter has directions to improve his contribution.</para> - -<para>Pull-requests 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 + submitter has directions to improve his contribution. + </para> + <para> + Pull-requests 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 his liking.</para> - -<section><title>Package updates</title> - -<para>A package update is the most trivial and common type of pull-request. - These pull-requests mainly consist in updating the version part of the package - name and the source hash.</para> -<para>It can happen that non trivial updates include patches or more complex - changes.</para> - -<para>Reviewing process:</para> - -<itemizedlist> - <listitem><para>Add labels to the pull-request. (Requires commit - rights)</para> + them to his liking. + </para> + <section> + <title>Package updates</title> + + <para> + A package update is the most trivial and common type of pull-request. These + pull-requests mainly consist in updating the version part of the package + name and the source hash. + </para> + + <para> + It can happen that non trivial updates include patches or more complex + changes. + </para> + + <para> + Reviewing process: + </para> + + <itemizedlist> + <listitem> + <para> + Add labels to the pull-request. (Requires commit rights) + </para> <itemizedlist> - <listitem><para><literal>8.has: package (update)</literal> and any topic - label that fit the updated package.</para></listitem> + <listitem> + <para> + <literal>8.has: package (update)</literal> and any topic label that fit + the updated package. + </para> + </listitem> </itemizedlist> - </listitem> - <listitem><para>Ensure that the package versioning is fitting the - guidelines.</para></listitem> - <listitem><para>Ensure that the commit text is fitting the - guidelines.</para></listitem> - <listitem><para>Ensure that the package maintainers are notified.</para> + </listitem> + <listitem> + <para> + Ensure that the package versioning is fitting the guidelines. + </para> + </listitem> + <listitem> + <para> + Ensure that the commit text is fitting the guidelines. + </para> + </listitem> + <listitem> + <para> + Ensure that the package maintainers are notified. + </para> <itemizedlist> - <listitem><para>mention-bot usually notify GitHub users based on the - submitted changes, but it can happen that it misses some of the - package maintainers.</para></listitem> + <listitem> + <para> + mention-bot usually notify GitHub users based on the submitted changes, + but it can happen that it misses some of the package maintainers. + </para> + </listitem> </itemizedlist> - </listitem> - <listitem><para>Ensure that the meta field contains correct - information.</para> + </listitem> + <listitem> + <para> + Ensure that the meta field contains correct information. + </para> <itemizedlist> - <listitem><para>License can change with version updates, so it should be - checked to be fitting 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.</para></listitem> + <listitem> + <para> + License can change with version updates, so it should be checked to be + fitting 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. + </para> + </listitem> </itemizedlist> - </listitem> - <listitem><para>Ensure that the code contains no typos.</para></listitem> - <listitem><para>Building the package locally.</para> + </listitem> + <listitem> + <para> + Ensure that the code contains no typos. + </para> + </listitem> + <listitem> + <para> + Building the package locally. + </para> <itemizedlist> - <listitem><para>Pull-requests are often targeted to the master or staging - branch so building the pull-request locally as it is submitted can - trigger a large amount of source builds.</para> - <para>It is possible to rebase the changes on nixos-unstable or - nixpkgs-unstable for easier review by running the following commands - from a nixpkgs clone. + <listitem> + <para> + Pull-requests are often targeted to the master or staging branch so + building the pull-request locally as it is submitted can trigger a large + amount of source builds. + </para> + <para> + It is possible to rebase the changes on nixos-unstable or + nixpkgs-unstable for easier review by running the following commands + from a nixpkgs clone. <screen> $ git remote add channels https://github.com/NixOS/nixpkgs-channels.git <co xml:id='reviewing-rebase-1' /> @@ -100,43 +153,56 @@ $ git fetch origin pull/PRNUMBER/head <co xml:id='reviewing-rebase-3' /> $ git rebase --onto nixos-unstable BASEBRANCH FETCH_HEAD <co xml:id='reviewing-rebase-4' /> </screen> - <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.</para> - </callout> - <callout arearefs='reviewing-rebase-2'> - <para>Fetching the nixos-unstable branch.</para> - </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.</para> - </callout> - <callout arearefs='reviewing-rebase-4'> - <para>Rebasing the pull-request changes to the nixos-unstable - branch.</para> - </callout> - </calloutlist> - </para> - </listitem> - <listitem> - <para>The <link xlink:href="https://github.com/madjar/nox">nox</link> - tool can be used to review a pull-request content in a single command. - It doesn't rebase on a channel branch so it might trigger multiple - source builds. <varname>PRNUMBER</varname> should be replaced by the - number at the end of the pull-request title.</para> + <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. + </para> + </callout> + <callout arearefs='reviewing-rebase-2'> + <para> + Fetching the nixos-unstable branch. + </para> + </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. + </para> + </callout> + <callout arearefs='reviewing-rebase-4'> + <para> + Rebasing the pull-request changes to the nixos-unstable branch. + </para> + </callout> + </calloutlist> + </para> + </listitem> + <listitem> + <para> + The <link xlink:href="https://github.com/madjar/nox">nox</link> tool can + be used to review a pull-request content in a single command. It doesn't + rebase on a channel branch so it might trigger multiple source builds. + <varname>PRNUMBER</varname> should be replaced by the number at the end + of the pull-request title. + </para> <screen> $ nix-shell -p nox --run "nox-review -k pr PRNUMBER" </screen> - </listitem> + </listitem> </itemizedlist> - </listitem> - <listitem><para>Running every binary.</para></listitem> -</itemizedlist> - -<example><title>Sample template for a package update review</title> + </listitem> + <listitem> + <para> + Running every binary. + </para> + </listitem> + </itemizedlist> + + <example> + <title>Sample template for a package update review</title> <screen> ##### Reviewed points @@ -150,55 +216,105 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER" ##### Comments -</screen></example> -</section> - -<section><title>New packages</title> - -<para>New packages are a common type of pull-requests. These pull requests - consists in adding a new nix-expression for a package.</para> - -<para>Reviewing process:</para> - -<itemizedlist> - <listitem><para>Add labels to the pull-request. (Requires commit - rights)</para> +</screen> + </example> + </section> + <section> + <title>New packages</title> + + <para> + New packages are a common type of pull-requests. These pull requests + consists in adding a new nix-expression for a package. + </para> + + <para> + Reviewing process: + </para> + + <itemizedlist> + <listitem> + <para> + Add labels to the pull-request. (Requires commit rights) + </para> <itemizedlist> - <listitem><para><literal>8.has: package (new)</literal> and any topic - label that fit the new package.</para></listitem> + <listitem> + <para> + <literal>8.has: package (new)</literal> and any topic label that fit the + new package. + </para> + </listitem> </itemizedlist> - </listitem> - <listitem><para>Ensure that the package versioning is fitting the - guidelines.</para></listitem> - <listitem><para>Ensure that the commit name is fitting the - guidelines.</para></listitem> - <listitem><para>Ensure that the meta field contains correct - information.</para> + </listitem> + <listitem> + <para> + Ensure that the package versioning is fitting the guidelines. + </para> + </listitem> + <listitem> + <para> + Ensure that the commit name is fitting the guidelines. + </para> + </listitem> + <listitem> + <para> + Ensure that the meta field contains correct information. + </para> <itemizedlist> - <listitem><para>License must be checked to be fitting upstream - license.</para></listitem> - <listitem><para>Platforms should be set or the package will not get binary - substitutes.</para></listitem> - <listitem><para>A maintainer must be set, this can be the package - submitter or a community member that accepts to take maintainership of - the package.</para></listitem> + <listitem> + <para> + License must be checked to be fitting upstream license. + </para> + </listitem> + <listitem> + <para> + Platforms should be set or the package will not get binary substitutes. + </para> + </listitem> + <listitem> + <para> + A maintainer must be set, this can be the package submitter or a + community member that accepts to take maintainership of the package. + </para> + </listitem> </itemizedlist> - </listitem> - <listitem><para>Ensure that the code contains no typos.</para></listitem> - <listitem><para>Ensure the package source.</para> + </listitem> + <listitem> + <para> + Ensure that the code contains no typos. + </para> + </listitem> + <listitem> + <para> + Ensure the package source. + </para> <itemizedlist> - <listitem><para>Mirrors urls should be used when - available.</para></listitem> - <listitem><para>The most appropriate function should be used (e.g. - packages from GitHub should use - <literal>fetchFromGitHub</literal>).</para></listitem> + <listitem> + <para> + Mirrors urls should be used when available. + </para> + </listitem> + <listitem> + <para> + The most appropriate function should be used (e.g. packages from GitHub + should use <literal>fetchFromGitHub</literal>). + </para> + </listitem> </itemizedlist> - </listitem> - <listitem><para>Building the package locally.</para></listitem> - <listitem><para>Running every binary.</para></listitem> -</itemizedlist> - -<example><title>Sample template for a new package review</title> + </listitem> + <listitem> + <para> + Building the package locally. + </para> + </listitem> + <listitem> + <para> + Running every binary. + </para> + </listitem> + </itemizedlist> + + <example> + <title>Sample template for a new package review</title> <screen> ##### Reviewed points @@ -220,58 +336,107 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER" ##### Comments -</screen></example> -</section> - -<section><title>Module updates</title> - -<para>Module updates are submissions changing modules in some ways. These often - contains changes to the options or introduce new options.</para> - -<para>Reviewing process</para> - -<itemizedlist> - <listitem><para>Add labels to the pull-request. (Requires commit - rights)</para> +</screen> + </example> + </section> + <section> + <title>Module updates</title> + + <para> + Module updates are submissions changing modules in some ways. These often + contains changes to the options or introduce new options. + </para> + + <para> + Reviewing process + </para> + + <itemizedlist> + <listitem> + <para> + Add labels to the pull-request. (Requires commit rights) + </para> <itemizedlist> - <listitem><para><literal>8.has: module (update)</literal> and any topic - label that fit the module.</para></listitem> + <listitem> + <para> + <literal>8.has: module (update)</literal> and any topic label that fit + the module. + </para> + </listitem> </itemizedlist> - </listitem> - <listitem><para>Ensure that the module maintainers are notified.</para> + </listitem> + <listitem> + <para> + Ensure that the module maintainers are notified. + </para> <itemizedlist> - <listitem><para>Mention-bot notify GitHub users based on the submitted - changes, but it can happen that it miss some of the package - maintainers.</para></listitem> + <listitem> + <para> + Mention-bot notify GitHub users based on the submitted changes, but it + can happen that it miss some of the package maintainers. + </para> + </listitem> </itemizedlist> - </listitem> - <listitem><para>Ensure that the module tests, if any, are - succeeding.</para></listitem> - <listitem><para>Ensure that the introduced options are correct.</para> + </listitem> + <listitem> + <para> + Ensure that the module tests, if any, are succeeding. + </para> + </listitem> + <listitem> + <para> + Ensure that the introduced options are correct. + </para> <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).</para></listitem> - <listitem><para>Description, default and example should be - provided.</para></listitem> + <listitem> + <para> + 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> + <para> + Description, default and example should be provided. + </para> + </listitem> </itemizedlist> - </listitem> - <listitem><para>Ensure that option changes are backward compatible.</para> + </listitem> + <listitem> + <para> + Ensure that option changes are backward compatible. + </para> <itemizedlist> - <listitem><para><literal>mkRenamedOptionModule</literal> and - <literal>mkAliasOptionModule</literal> functions provide way to make - option changes backward compatible.</para></listitem> + <listitem> + <para> + <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></para></listitem> - <listitem><para>Ensure that changes that are not backward compatible are - mentioned in release notes.</para></listitem> - <listitem><para>Ensure that documentations affected by the change is - updated.</para></listitem> -</itemizedlist> - -<example><title>Sample template for a module update review</title> + </listitem> + <listitem> + <para> + 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. + </para> + </listitem> + <listitem> + <para> + Ensure that documentations affected by the change is updated. + </para> + </listitem> + </itemizedlist> + + <example> + <title>Sample template for a module update review</title> <screen> ##### Reviewed points @@ -288,51 +453,89 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER" ##### Comments -</screen></example> -</section> - -<section><title>New modules</title> - -<para>New modules submissions introduce a new module to NixOS.</para> - -<itemizedlist> - <listitem><para>Add labels to the pull-request. (Requires commit - rights)</para> +</screen> + </example> + </section> + <section> + <title>New modules</title> + + <para> + New modules submissions introduce a new module to NixOS. + </para> + + <itemizedlist> + <listitem> + <para> + Add labels to the pull-request. (Requires commit rights) + </para> <itemizedlist> - <listitem><para><literal>8.has: module (new)</literal> and any topic label - that fit the module.</para></listitem> + <listitem> + <para> + <literal>8.has: module (new)</literal> and any topic label that fit the + module. + </para> + </listitem> </itemizedlist> - </listitem> - <listitem><para>Ensure that the module tests, if any, are - succeeding.</para></listitem> - <listitem><para>Ensure that the introduced options are correct.</para> + </listitem> + <listitem> + <para> + Ensure that the module tests, if any, are succeeding. + </para> + </listitem> + <listitem> + <para> + Ensure that the introduced options are correct. + </para> <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).</para></listitem> - <listitem><para>Description, default and example should be - provided.</para></listitem> + <listitem> + <para> + 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> + <para> + Description, default and example should be provided. + </para> + </listitem> </itemizedlist> - </listitem> - <listitem><para>Ensure that module <literal>meta</literal> field is - present</para> + </listitem> + <listitem> + <para> + Ensure that module <literal>meta</literal> field is present + </para> <itemizedlist> - <listitem><para>Maintainers should be declared in - <literal>meta.maintainers</literal>.</para></listitem> - <listitem><para>Module documentation should be declared with - <literal>meta.doc</literal>.</para></listitem> + <listitem> + <para> + Maintainers should be declared in <literal>meta.maintainers</literal>. + </para> + </listitem> + <listitem> + <para> + Module documentation should be declared with + <literal>meta.doc</literal>. + </para> + </listitem> </itemizedlist> - </listitem> - <listitem><para>Ensure that the module respect other modules - functionality.</para> + </listitem> + <listitem> + <para> + Ensure that the module respect other modules functionality. + </para> <itemizedlist> - <listitem><para>For example, enabling a module should not open firewall - ports by default.</para></listitem> + <listitem> + <para> + For example, enabling a module should not open firewall ports by + default. + </para> + </listitem> </itemizedlist> - </listitem> -</itemizedlist> + </listitem> + </itemizedlist> -<example><title>Sample template for a new module review</title> + <example> + <title>Sample template for a new module review</title> <screen> ##### Reviewed points @@ -350,32 +553,41 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER" ##### Comments -</screen></example> -</section> - -<section><title>Other submissions</title> - -<para>Other type of submissions requires different reviewing steps.</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.</para> - -<para>Container system, boot system and library changes are some examples of the - pull requests fitting this category.</para> - -</section> - -<section><title>Merging pull-requests</title> - -<para>It is possible for community members that have enough knowledge and - experience on a special topic to contribute by merging pull requests.</para> - -<para>TODO: add the procedure to request merging rights.</para> +</screen> + </example> + </section> + <section> + <title>Other submissions</title> + + <para> + Other type of submissions requires different reviewing steps. + </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. + </para> + + <para> + Container system, boot system and library changes are some examples of the + pull requests fitting this category. + </para> + </section> + <section> + <title>Merging pull-requests</title> + + <para> + It is possible for community members that have enough knowledge and + experience on a special topic to contribute by merging pull requests. + </para> + + <para> + TODO: add the procedure to request merging rights. + </para> <!-- The following paragraph about how to deal with unactive contributors is just a @@ -386,10 +598,11 @@ policy. three months will have their commit rights revoked.</para> --> -<para>In a case a contributor leaves definitively the Nix community, he should - create an issue or notify the mailing list with references of packages and - modules he maintains so the maintainership can be taken over by other - contributors.</para> - -</section> + <para> + In a case a contributor leaves definitively the Nix community, he should + create an issue or notify the mailing list with references of packages and + modules he maintains so the maintainership can be taken over by other + contributors. + </para> + </section> </chapter> diff --git a/doc/shell.nix b/doc/shell.nix index 22590142ee1a..e8da2eaf16be 100644 --- a/doc/shell.nix +++ b/doc/shell.nix @@ -1,4 +1,5 @@ { pkgs ? import ../. {} }: (import ./default.nix).overrideAttrs (x: { buildInputs = x.buildInputs ++ [ pkgs.xmloscopy ]; + }) diff --git a/doc/stdenv.xml b/doc/stdenv.xml index 2a3316b8d018..d5028c51cd51 100644 --- a/doc/stdenv.xml +++ b/doc/stdenv.xml @@ -1,27 +1,24 @@ <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" 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.</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. - + <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. + </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. <programlisting> stdenv.mkDerivation { name = "libfoo-1.2.3"; @@ -30,39 +27,35 @@ 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 you need to do. 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: - + (<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 + you need to do. 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.)</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: - + 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: <programlisting> stdenv.mkDerivation { name = "fnord-4.5"; @@ -75,35 +68,33 @@ 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.)</para> - -<para>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: - + (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"/>. + </para> + + <para> + While the standard environment provides a generic builder, you can still + supply your own build script: <programlisting> stdenv.mkDerivation { name = "libfoo-1.2.3"; ... builder = ./builder.sh; }</programlisting> - -where the builder can do anything it wants, but typically starts with - + where the builder can do anything it wants, but typically starts with <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 @@ -119,116 +110,186 @@ installPhase() { genericBuild </programlisting> - -</para> - -</section> - - -<section xml:id="sec-tools-of-stdenv"><title>Tools provided by -<literal>stdenv</literal></title> - -<para>The standard environment provides the following packages: - -<itemizedlist> - - <listitem><para>The GNU C Compiler, configured with C and C++ - support.</para></listitem> - - <listitem><para>GNU coreutils (contains a few dozen standard Unix - commands).</para></listitem> - - <listitem><para>GNU findutils (contains - <command>find</command>).</para></listitem> - - <listitem><para>GNU diffutils (contains <command>diff</command>, - <command>cmp</command>).</para></listitem> - - <listitem><para>GNU <command>sed</command>.</para></listitem> - - <listitem><para>GNU <command>grep</command>.</para></listitem> - - <listitem><para>GNU <command>awk</command>.</para></listitem> - - <listitem><para>GNU <command>tar</command>.</para></listitem> - - <listitem><para><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.</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.</para></listitem> - - <listitem><para>The <command>patch</command> - command.</para></listitem> - -</itemizedlist> - -</para> - -<para>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. -</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. - <footnote><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. - </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. - For now, the run-time/build-time distinction is just a hint for mental clarity, but in the future it perhaps could be enforced. -</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. which run on the platform where the new derivation will be built. - <footnote><para> - Currently, that 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>nativeBuildDependencies</varname> dependencies would affect 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. -</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. -</para> -<para> - It is important to note dependencies are not necessary 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 each sort of dependency two integers based one how it's host and target platforms are offset from the depending derivation's platforms. - Those offsets are given are given below in the descriptions of each dependency list attribute. - Algorithmically, we traverse propagated inputs, accumulating every propagated dep's propagated deps and adjusting them to account for the "shift in perspective" described by the current dep'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 deps 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! - <footnote><para> - 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 does in the other! - <programlisting> + </para> + </section> + <section xml:id="sec-tools-of-stdenv"> + <title>Tools provided by <literal>stdenv</literal></title> + + <para> + The standard environment provides the following packages: + <itemizedlist> + <listitem> + <para> + The GNU C Compiler, configured with C and C++ support. + </para> + </listitem> + <listitem> + <para> + GNU coreutils (contains a few dozen standard Unix commands). + </para> + </listitem> + <listitem> + <para> + GNU findutils (contains <command>find</command>). + </para> + </listitem> + <listitem> + <para> + GNU diffutils (contains <command>diff</command>, <command>cmp</command>). + </para> + </listitem> + <listitem> + <para> + GNU <command>sed</command>. + </para> + </listitem> + <listitem> + <para> + GNU <command>grep</command>. + </para> + </listitem> + <listitem> + <para> + GNU <command>awk</command>. + </para> + </listitem> + <listitem> + <para> + GNU <command>tar</command>. + </para> + </listitem> + <listitem> + <para> + <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. + </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. + </para> + </listitem> + <listitem> + <para> + The <command>patch</command> command. + </para> + </listitem> + </itemizedlist> + </para> + + <para> + 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. + </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. + <footnote> + <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. + </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. For now, the run-time/build-time + distinction is just a hint for mental clarity, but in the future it perhaps + could be enforced. + </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. which run on the platform where the new derivation + will be built. + <footnote> + <para> + Currently, that 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>nativeBuildDependencies</varname> dependencies would affect 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. + </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. + </para> + + <para> + It is important to note dependencies are not necessary 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 each sort of dependency + two integers based one how it's host and target platforms are offset from + the depending derivation's platforms. Those offsets are given are given + below in the descriptions of each dependency list attribute. + Algorithmically, we traverse propagated inputs, accumulating every + propagated dep's propagated deps and adjusting them to account for the + "shift in perspective" described by the current dep'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 deps 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! + <footnote> + <para> + 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 does in the other! +<programlisting> let mapOffset(h, t, i) = i + (if i <= 0 then h else t - 1) propagated-dep(h0, t0, A, B) @@ -239,7 +300,7 @@ h0 + t1 in {-1, 0, 1} propagated-dep(mapOffset(h0, t0, h1), mapOffset(h0, t0, t1), A, C)</programlisting> - <programlisting> +<programlisting> let mapOffset(h, t, i) = i + (if i <= 0 then h else t - 1) dep(h0, _, A, B) @@ -250,1139 +311,1450 @@ h0 + t1 in {-1, 0, -1} propagated-dep(mapOffset(h0, t0, h1), mapOffset(h0, t0, t1), A, C)</programlisting> - <programlisting> +<programlisting> propagated-dep(h, t, A, B) -------------------------------------- Propagated deps count as deps 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: - <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: +<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 the "sum-like" comes from above: - We can just sum all the host offset to get the host offset of the transitive dependency. - The target offset is the transitive dep 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 dep 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 needing package is unaware of. -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> - <title>Variables specifying dependencies</title> - + This is where the "sum-like" comes from above: We can just sum all the host + offset to get the host offset of the transitive dependency. The target + offset is the transitive dep 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 dep 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 needing package + is unaware of. 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> + <title>Variables specifying dependencies</title> <varlistentry> - <term><varname>depsBuildBuild</varname></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. - They are programs/libraries used at build time that furthermore produce programs/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 for 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, that 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> - - <varlistentry> - <term><varname>nativeBuildInputs</varname></term> + <term><varname>depsBuildBuild</varname> + </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. - They are programs/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 would be called <varname>depsBuildHost</varname> but for historical continuity. - </para> - <para> - Since these packages are able to be run at build time, that are added to the <envar>PATH</envar>, as described above. - But since these packages only are 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> + <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. + They are programs/libraries used at build time that furthermore produce + programs/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 for 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, that 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> - - <varlistentry> - <term><varname>depsBuildTarget</varname></term> + </varlistentry> + <varlistentry> + <term><varname>nativeBuildInputs</varname> + </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. - They are programs used at build time that produce code to run at run with code produced by the depending package. - Most commonly, these would tools used to build the runtime or standard library 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 the dependency is unconditional. - </para> - <para> - This is a somewhat confusing dependency to wrap ones head around, and for good reason. - As the only one 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 it's use-case go hand in hand and are both considered poor form: - try not to need this sort dependency, and try not avoid building standard libraries / 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> + 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. They are programs/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 would be called <varname>depsBuildHost</varname> but for historical + continuity. </para> <para> - Since these packages are able to be run at build time, that are added to the <envar>PATH</envar>, as described above. - But since these packages only are 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, that are added to + the <envar>PATH</envar>, as described above. But since these packages + only are 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> - - <varlistentry> - <term><varname>depsHostHost</varname></term> - <listitem><para> - A list of dependencies whose host and target platforms match the new derivation's host platform. - This means a both <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, that would usually be tools used by compilers for metaprogramming/macro systems, or libraries used by the macros/metaprogramming code itself. - It's always preferable to use a <varname>depsBuildBuild</varname> dependency in the derivation being built than a <varname>depsHostHost</varname> on the tool doing the building for this purpose. - </para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>buildInputs</varname></term> + </varlistentry> + <varlistentry> + <term><varname>depsBuildTarget</varname> + </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 <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 often are programs/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> + <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. They are programs used + at build time that produce code to run at run with code produced by the + depending package. Most commonly, these would tools used to build the + runtime or standard library 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 the dependency is unconditional. + </para> + <para> + This is a somewhat confusing dependency to wrap ones head around, and for + good reason. As the only one 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 it's use-case + go hand in hand and are both considered poor form: try not to need this + sort dependency, and try not avoid building standard libraries / 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 be run at build time, that are added to + the <envar>PATH</envar>, as described above. But since these packages + only are 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> - - <varlistentry> - <term><varname>depsTargetTarget</varname></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. - </para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>depsBuildBuildPropagated</varname></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]. - </para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>propagatedNativeBuildInputs</varname></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. - </para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>depsBuildTargetPropagated</varname></term> - <listitem><para> - The propagated equivalent of <varname>depsBuildTarget</varname>. - This is prefixed for the same reason of alerting potential users. - </para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>depsHostHostPropagated</varname></term> - <listitem><para> - The propagated equivalent of <varname>depsHostHost</varname>. - </para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>propagatedBuildInputs</varname></term> - <listitem><para> - The propagated equivalent of <varname>buildInputs</varname>. - This would be called <varname>depsHostTargetPropagated</varname> but for historical continuity. - </para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>depsTargetTarget</varname></term> - <listitem><para> - The propagated equivalent of <varname>depsTargetTarget</varname>. - This is prefixed for the same reason of alerting potential users. - </para></listitem> - </varlistentry> - -</variablelist> - -</section> - - -<section xml:id="ssec-stdenv-attributes"><title>Attributes</title> - -<variablelist> - <title>Variables affecting <literal>stdenv</literal> - initialisation</title> - - <varlistentry> - <term><varname>NIX_DEBUG</varname></term> - <listitem><para> - A natural number indicating how much information to log. - If set to 1 or higher, <literal>stdenv</literal> will print moderate debug 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> - -</variablelist> - -<variablelist> - <title>Variables affecting build properties</title> - - <varlistentry> - <term><varname>enableParallelBuilding</varname></term> + </varlistentry> + <varlistentry> + <term><varname>depsHostHost</varname> + </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.</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>.</para> + <para> + A list of dependencies whose host and target platforms match the new + derivation's host platform. This means a both <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, that would usually be tools used by + compilers for metaprogramming/macro systems, or libraries used by the + macros/metaprogramming code itself. It's always preferable to use a + <varname>depsBuildBuild</varname> dependency in the derivation being + built than a <varname>depsHostHost</varname> on the tool doing the + building for this purpose. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><varname>preferLocalBuild</varname></term> - <listitem><para>If set, specifies that the package is so lightweight - in terms of build operations (e.g. write a text file from a Nix string - to the store) that there's no need to look for it in binary caches -- - it's faster to just build it locally. It also tells Hydra and other - facilities that this package doesn't need to be exported in binary - caches (noone would use it, after all).</para></listitem> - </varlistentry> - -</variablelist> - -<variablelist> - <title>Special variables</title> - - <varlistentry> - <term><varname>passthru</varname></term> - <listitem><para>This is an attribute set which can be filled with arbitrary - values. For example: - -<programlisting> -passthru = { - foo = "bar"; - baz = { - value1 = 4; - value2 = 5; - }; -} -</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.</para></listitem> - </varlistentry> - -</variablelist> - -</section> - - -<section xml:id="sec-stdenv-phases"><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.</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. -</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: - -<variablelist> - <title>Variables affecting phase control</title> - - <varlistentry> - <term><varname>phases</varname></term> + </varlistentry> + <varlistentry> + <term><varname>buildInputs</varname> + </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 $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.</para> + <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 + <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 often are programs/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> - - <varlistentry> - <term><varname>prePhases</varname></term> + </varlistentry> + <varlistentry> + <term><varname>depsTargetTarget</varname> + </term> <listitem> - <para>Additional phases executed before any of the default phases.</para> + <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. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><varname>preConfigurePhases</varname></term> + </varlistentry> + <varlistentry> + <term><varname>depsBuildBuildPropagated</varname> + </term> <listitem> - <para>Additional phases executed just before the configure phase.</para> + <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]. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><varname>preBuildPhases</varname></term> + </varlistentry> + <varlistentry> + <term><varname>propagatedNativeBuildInputs</varname> + </term> <listitem> - <para>Additional phases executed just before the build phase.</para> + <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. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><varname>preInstallPhases</varname></term> + </varlistentry> + <varlistentry> + <term><varname>depsBuildTargetPropagated</varname> + </term> <listitem> - <para>Additional phases executed just before the install phase.</para> + <para> + The propagated equivalent of <varname>depsBuildTarget</varname>. This is + prefixed for the same reason of alerting potential users. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><varname>preFixupPhases</varname></term> + </varlistentry> + <varlistentry> + <term><varname>depsHostHostPropagated</varname> + </term> + <listitem> + <para> + The propagated equivalent of <varname>depsHostHost</varname>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>propagatedBuildInputs</varname> + </term> <listitem> - <para>Additional phases executed just before the fixup phase.</para> + <para> + The propagated equivalent of <varname>buildInputs</varname>. This would + be called <varname>depsHostTargetPropagated</varname> but for historical + continuity. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><varname>preDistPhases</varname></term> + </varlistentry> + <varlistentry> + <term><varname>depsTargetTarget</varname> + </term> + <listitem> + <para> + The propagated equivalent of <varname>depsTargetTarget</varname>. This is + prefixed for the same reason of alerting potential users. + </para> + </listitem> + </varlistentry> + </variablelist> + </section> + <section xml:id="ssec-stdenv-attributes"> + <title>Attributes</title> + + <variablelist> + <title>Variables affecting <literal>stdenv</literal> initialisation</title> + <varlistentry> + <term><varname>NIX_DEBUG</varname> + </term> <listitem> - <para>Additional phases executed just before the distribution phase.</para> + <para> + A natural number indicating how much information to log. If set to 1 or + higher, <literal>stdenv</literal> will print moderate debug 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> + </varlistentry> + </variablelist> - <varlistentry> - <term><varname>postPhases</varname></term> + <variablelist> + <title>Variables affecting build properties</title> + <varlistentry> + <term><varname>enableParallelBuilding</varname> + </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. + </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>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>preferLocalBuild</varname> + </term> <listitem> - <para>Additional phases executed after any of the default - phases.</para> + <para> + If set, specifies that the package is so lightweight in terms of build + operations (e.g. write a text file from a Nix string to the store) that + there's no need to look for it in binary caches -- it's faster to just + build it locally. It also tells Hydra and other facilities that this + package doesn't need to be exported in binary caches (noone would use it, + after all). + </para> </listitem> - </varlistentry> - -</variablelist> - -</para> - -</section> - - -<section xml:id="ssec-unpack-phase"><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: - -<variablelist> - - <varlistentry> - <term>Tar files</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> or - <filename>.tbz2</filename>) or <command>xz</command> - (<filename>.tar.xz</filename> or - <filename>.tar.lzma</filename>).</para></listitem> - </varlistentry> - - <varlistentry> - <term>Zip files</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>buildInputs</varname> yourself.</para></listitem> - </varlistentry> - - <varlistentry> - <term>Directories in the Nix store</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>.</para></listitem> - </varlistentry> - -</variablelist> - -Additional file types can be supported by setting the -<varname>unpackCmd</varname> variable (see below).</para> - -<para></para> - -<variablelist> - <title>Variables controlling the unpack phase</title> - - <varlistentry> - <term><varname>srcs</varname> / <varname>src</varname></term> - <listitem><para>The list of source files or directories to be - unpacked or copied. One of these must be set.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>sourceRoot</varname></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.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>setSourceRoot</varname></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>.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>preUnpack</varname></term> - <listitem><para>Hook executed at the start of the unpack - phase.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>postUnpack</varname></term> - <listitem><para>Hook executed at the end of the unpack - phase.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>dontMakeSourcesWritable</varname></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.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>unpackCmd</varname></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.</para></listitem> - </varlistentry> - -</variablelist> - -</section> - - -<section xml:id="ssec-patch-phase"><title>The patch phase</title> - -<para>The patch phase applies the list of patches defined in the -<varname>patches</varname> variable.</para> - -<variablelist> - <title>Variables controlling the patch phase</title> - - <varlistentry> - <term><varname>patches</varname></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>).</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>patchFlags</varname></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.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>prePatch</varname></term> - <listitem><para>Hook executed at the start of the patch - phase.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>postPatch</varname></term> - <listitem><para>Hook executed at the end of the patch - phase.</para></listitem> - </varlistentry> - -</variablelist> - -</section> - - -<section xml:id="ssec-configure-phase"><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.</para> - -<variablelist> - <title>Variables controlling the configure phase</title> - - <varlistentry> - <term><varname>configureScript</varname></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>).</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>configureFlags</varname></term> - <listitem><para>A list of strings passed as additional arguments to the - configure script.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>configureFlagsArray</varname></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.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>dontAddPrefix</varname></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.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>prefix</varname></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>.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>dontAddDisableDepTrack</varname></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.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>dontFixLibtool</varname></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<footnote><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.</para></footnote>. If this is undesirable, set this - variable to true.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>dontDisableStatic</varname></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.</para> - <para>If this is undesirable, set this variable to - true.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>configurePlatforms</varname></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 should use this to also pass the target platform, for example. - <footnote><para>Eventually these will be passed when in native builds too, to improve determinism: build-time guessing, as is done today, is a risk of impurity.</para></footnote> - </para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>preConfigure</varname></term> - <listitem><para>Hook executed at the start of the configure - phase.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>postConfigure</varname></term> - <listitem><para>Hook executed at the end of the configure - phase.</para></listitem> - </varlistentry> - -</variablelist> - - -</section> - - -<section xml:id="build-phase"><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.</para> - -<variablelist> - <title>Variables controlling the build phase</title> - - <varlistentry> - <term><varname>dontBuild</varname></term> - <listitem><para>Set to true to skip the build phase.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>makefile</varname></term> - <listitem><para>The file name of the Makefile.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>makeFlags</varname></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). + </varlistentry> + </variablelist> + <variablelist> + <title>Special variables</title> + <varlistentry> + <term><varname>passthru</varname> + </term> + <listitem> + <para> + This is an attribute set which can be filled with arbitrary values. For + example: +<programlisting> +passthru = { + foo = "bar"; + baz = { + value1 = 4; + value2 = 5; + }; +} +</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. + </para> + </listitem> + </varlistentry> + </variablelist> + </section> + <section xml:id="sec-stdenv-phases"> + <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. + </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. + </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: + <variablelist> + <title>Variables affecting phase control</title> + <varlistentry> + <term><varname>phases</varname> + </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 $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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>prePhases</varname> + </term> + <listitem> + <para> + Additional phases executed before any of the default phases. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>preConfigurePhases</varname> + </term> + <listitem> + <para> + Additional phases executed just before the configure phase. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>preBuildPhases</varname> + </term> + <listitem> + <para> + Additional phases executed just before the build phase. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>preInstallPhases</varname> + </term> + <listitem> + <para> + Additional phases executed just before the install phase. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>preFixupPhases</varname> + </term> + <listitem> + <para> + Additional phases executed just before the fixup phase. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>preDistPhases</varname> + </term> + <listitem> + <para> + Additional phases executed just before the distribution phase. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>postPhases</varname> + </term> + <listitem> + <para> + Additional phases executed after any of the default phases. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </section> + + <section xml:id="ssec-unpack-phase"> + <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: + <variablelist> + <varlistentry> + <term>Tar files</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> or <filename>.tbz2</filename>) or + <command>xz</command> (<filename>.tar.xz</filename> or + <filename>.tar.lzma</filename>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Zip files</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>buildInputs</varname> yourself. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Directories in the Nix store</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>. + </para> + </listitem> + </varlistentry> + </variablelist> + Additional file types can be supported by setting the + <varname>unpackCmd</varname> variable (see below). + </para> + + <para></para> + + <variablelist> + <title>Variables controlling the unpack phase</title> + <varlistentry> + <term><varname>srcs</varname> / <varname>src</varname> + </term> + <listitem> + <para> + The list of source files or directories to be unpacked or copied. One of + these must be set. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>sourceRoot</varname> + </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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>setSourceRoot</varname> + </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>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>preUnpack</varname> + </term> + <listitem> + <para> + Hook executed at the start of the unpack phase. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>postUnpack</varname> + </term> + <listitem> + <para> + Hook executed at the end of the unpack phase. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>dontMakeSourcesWritable</varname> + </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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>unpackCmd</varname> + </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. + </para> + </listitem> + </varlistentry> + </variablelist> + </section> + + <section xml:id="ssec-patch-phase"> + <title>The patch phase</title> + + <para> + The patch phase applies the list of patches defined in the + <varname>patches</varname> variable. + </para> + + <variablelist> + <title>Variables controlling the patch phase</title> + <varlistentry> + <term><varname>patches</varname> + </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>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>patchFlags</varname> + </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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>prePatch</varname> + </term> + <listitem> + <para> + Hook executed at the start of the patch phase. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>postPatch</varname> + </term> + <listitem> + <para> + Hook executed at the end of the patch phase. + </para> + </listitem> + </varlistentry> + </variablelist> + </section> + + <section xml:id="ssec-configure-phase"> + <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. + </para> + + <variablelist> + <title>Variables controlling the configure phase</title> + <varlistentry> + <term><varname>configureScript</varname> + </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>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>configureFlags</varname> + </term> + <listitem> + <para> + A list of strings passed as additional arguments to the configure + script. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>configureFlagsArray</varname> + </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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>dontAddPrefix</varname> + </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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>prefix</varname> + </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>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>dontAddDisableDepTrack</varname> + </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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>dontFixLibtool</varname> + </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 + <footnote> + <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. + </para> + </footnote> + . If this is undesirable, set this variable to true. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>dontDisableStatic</varname> + </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. + </para> + <para> + If this is undesirable, set this variable to true. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>configurePlatforms</varname> + </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 should use this to also pass the target + platform, for example. + <footnote> + <para> + Eventually these will be passed when in native builds too, to improve + determinism: build-time guessing, as is done today, is a risk of + impurity. + </para> + </footnote> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>preConfigure</varname> + </term> + <listitem> + <para> + Hook executed at the start of the configure phase. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>postConfigure</varname> + </term> + <listitem> + <para> + Hook executed at the end of the configure phase. + </para> + </listitem> + </varlistentry> + </variablelist> + </section> + + <section xml:id="build-phase"> + <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. + </para> + + <variablelist> + <title>Variables controlling the build phase</title> + <varlistentry> + <term><varname>dontBuild</varname> + </term> + <listitem> + <para> + Set to true to skip the build phase. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>makefile</varname> + </term> + <listitem> + <para> + The file name of the Makefile. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>makeFlags</varname> + </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). <programlisting> makeFlags = [ "PREFIX=$(out)" ]; </programlisting> - - <note><para>The flags are quoted in bash, but environment variables can - be specified by using the make syntax.</para></note></para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>makeFlagsArray</varname></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. - + <note> + <para> + The flags are quoted in bash, but environment variables can be + specified by using the make syntax. + </para> + </note> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>makeFlagsArray</varname> + </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. <programlisting> 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.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>buildFlags</varname> / <varname>buildFlagsArray</varname></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.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>preBuild</varname></term> - <listitem><para>Hook executed at the start of the build - phase.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>postBuild</varname></term> - <listitem><para>Hook executed at the end of the build - phase.</para></listitem> - </varlistentry> - -</variablelist> - - -<para> -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.</para> - -</section> - - -<section xml:id="ssec-check-phase"><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.</para> - -<variablelist> - <title>Variables controlling the check phase</title> - - <varlistentry> - <term><varname>doCheck</varname></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 <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. - </para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>makeFlags</varname> / + 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> + <varlistentry> + <term><varname>buildFlags</varname> / <varname>buildFlagsArray</varname> + </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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>preBuild</varname> + </term> + <listitem> + <para> + Hook executed at the start of the build phase. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>postBuild</varname> + </term> + <listitem> + <para> + Hook executed at the end of the build phase. + </para> + </listitem> + </varlistentry> + </variablelist> + + <para> + 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. + </para> + </section> + + <section xml:id="ssec-check-phase"> + <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. + </para> + + <variablelist> + <title>Variables controlling the check phase</title> + <varlistentry> + <term><varname>doCheck</varname> + </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 +<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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>makeFlags</varname> / <varname>makeFlagsArray</varname> / - <varname>makefile</varname></term> - <listitem><para>See the build phase for details.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>checkTarget</varname></term> - <listitem><para>The make target that runs the tests. Defaults to - <literal>check</literal>.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>checkFlags</varname> / <varname>checkFlagsArray</varname></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.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>preCheck</varname></term> - <listitem><para>Hook executed at the start of the check - phase.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>postCheck</varname></term> - <listitem><para>Hook executed at the end of the check - phase.</para></listitem> - </varlistentry> - -</variablelist> - - -</section> - - -<section xml:id="ssec-install-phase"><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>.</para> - -<variablelist> - <title>Variables controlling the install phase</title> - - <varlistentry> - <term><varname>makeFlags</varname> / + <varname>makefile</varname> + </term> + <listitem> + <para> + See the build phase for details. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>checkTarget</varname> + </term> + <listitem> + <para> + The make target that runs the tests. Defaults to + <literal>check</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>checkFlags</varname> / <varname>checkFlagsArray</varname> + </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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>preCheck</varname> + </term> + <listitem> + <para> + Hook executed at the start of the check phase. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>postCheck</varname> + </term> + <listitem> + <para> + Hook executed at the end of the check phase. + </para> + </listitem> + </varlistentry> + </variablelist> + </section> + + <section xml:id="ssec-install-phase"> + <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>. + </para> + + <variablelist> + <title>Variables controlling the install phase</title> + <varlistentry> + <term><varname>makeFlags</varname> / <varname>makeFlagsArray</varname> / - <varname>makefile</varname></term> - <listitem><para>See the build phase for details.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>installTargets</varname></term> - <listitem><para>The make targets that perform the installation. - Defaults to <literal>install</literal>. Example: - + <varname>makefile</varname> + </term> + <listitem> + <para> + See the build phase for details. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>installTargets</varname> + </term> + <listitem> + <para> + The make targets that perform the installation. Defaults to + <literal>install</literal>. Example: <programlisting> installTargets = "install-bin install-doc";</programlisting> - - </para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>installFlags</varname> / <varname>installFlagsArray</varname></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.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>preInstall</varname></term> - <listitem><para>Hook executed at the start of the install - phase.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>postInstall</varname></term> - <listitem><para>Hook executed at the end of the install - phase.</para></listitem> - </varlistentry> - -</variablelist> - - -</section> - - -<section xml:id="ssec-fixup-phase"><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: - -<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>.</para></listitem> - - <listitem><para>It strips libraries and executables of debug - information.</para></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.</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>.</para></listitem> - -</itemizedlist> - -</para> - -<variablelist> - <title>Variables controlling the fixup phase</title> - - <varlistentry> - <term><varname>dontStrip</varname></term> - <listitem><para>If set, libraries and executables are not - stripped. By default, they are.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>dontStripHost</varname></term> - <listitem><para> - Like <varname>dontStripHost</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> - <varlistentry> - <term><varname>dontStripTarget</varname></term> - <listitem><para> - Like <varname>dontStripHost</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> - - <varlistentry> - <term><varname>dontMoveSbin</varname></term> - <listitem><para>If set, files in <filename>$out/sbin</filename> are not moved - to <filename>$out/bin</filename>. By default, they are.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>stripAllList</varname></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.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>stripAllFlags</varname></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>).</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>stripDebugList</varname></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>.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>stripDebugFlags</varname></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>).</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>dontPatchELF</varname></term> - <listitem><para>If set, the <command>patchelf</command> command is - not used to remove unnecessary <literal>RPATH</literal> entries. - Only applies to Linux.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>dontPatchShebangs</varname></term> - <listitem><para>If set, scripts starting with - <literal>#!</literal> do not have their interpreter paths - rewritten to paths in the Nix store.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>forceShare</varname></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>.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>setupHook</varname></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 - linkend="fun-substituteAll">substituteAll</function>.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>preFixup</varname></term> - <listitem><para>Hook executed at the start of the fixup - phase.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>postFixup</varname></term> - <listitem><para>Hook executed at the end of the fixup - phase.</para></listitem> - </varlistentry> - - <varlistentry xml:id="stdenv-separateDebugInfo"> - <term><varname>separateDebugInfo</varname></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.</para> - - <para>For example, with GDB, you can add - + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>installFlags</varname> / <varname>installFlagsArray</varname> + </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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>preInstall</varname> + </term> + <listitem> + <para> + Hook executed at the start of the install phase. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>postInstall</varname> + </term> + <listitem> + <para> + Hook executed at the end of the install phase. + </para> + </listitem> + </varlistentry> + </variablelist> + </section> + + <section xml:id="ssec-fixup-phase"> + <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: + <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>. + </para> + </listitem> + <listitem> + <para> + It strips libraries and executables of debug information. + </para> + </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. + </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>. + </para> + </listitem> + </itemizedlist> + </para> + + <variablelist> + <title>Variables controlling the fixup phase</title> + <varlistentry> + <term><varname>dontStrip</varname> + </term> + <listitem> + <para> + If set, libraries and executables are not stripped. By default, they + are. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>dontStripHost</varname> + </term> + <listitem> + <para> + Like <varname>dontStripHost</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> + <varlistentry> + <term><varname>dontStripTarget</varname> + </term> + <listitem> + <para> + Like <varname>dontStripHost</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> + <varlistentry> + <term><varname>dontMoveSbin</varname> + </term> + <listitem> + <para> + If set, files in <filename>$out/sbin</filename> are not moved to + <filename>$out/bin</filename>. By default, they are. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>stripAllList</varname> + </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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>stripAllFlags</varname> + </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>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>stripDebugList</varname> + </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>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>stripDebugFlags</varname> + </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>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>dontPatchELF</varname> + </term> + <listitem> + <para> + If set, the <command>patchelf</command> command is not used to remove + unnecessary <literal>RPATH</literal> entries. Only applies to Linux. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>dontPatchShebangs</varname> + </term> + <listitem> + <para> + If set, scripts starting with <literal>#!</literal> do not have their + interpreter paths rewritten to paths in the Nix store. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>forceShare</varname> + </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>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>setupHook</varname> + </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 + linkend="fun-substituteAll">substituteAll</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>preFixup</varname> + </term> + <listitem> + <para> + Hook executed at the start of the fixup phase. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>postFixup</varname> + </term> + <listitem> + <para> + Hook executed at the end of the fixup phase. + </para> + </listitem> + </varlistentry> + <varlistentry xml:id="stdenv-separateDebugInfo"> + <term><varname>separateDebugInfo</varname> + </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. + </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>.</para> - - </listitem> - </varlistentry> - -</variablelist> - -</section> - -<section xml:id="ssec-installCheck-phase"><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>.</para> - -<variablelist> - <title>Variables controlling the installCheck phase</title> - - <varlistentry> - <term><varname>doInstallCheck</varname></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 <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. - </para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>preInstallCheck</varname></term> - <listitem><para>Hook executed at the start of the installCheck - phase.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>postInstallCheck</varname></term> - <listitem><para>Hook executed at the end of the installCheck - phase.</para></listitem> - </varlistentry> - -</variablelist> - -</section> - -<section xml:id="ssec-distribution-phase"><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.</para> - -<variablelist> - <title>Variables controlling the distribution phase</title> - - <varlistentry> - <term><varname>distTarget</varname></term> - <listitem><para>The make target that produces the distribution. - Defaults to <literal>dist</literal>.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>distFlags</varname> / <varname>distFlagsArray</varname></term> - <listitem><para>Additional flags passed to - <command>make</command>.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>tarballs</varname></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>.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>dontCopyDist</varname></term> - <listitem><para>If set, no files are copied to - <filename>$out/tarballs/</filename>.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>preDist</varname></term> - <listitem><para>Hook executed at the start of the distribution - phase.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>postDist</varname></term> - <listitem><para>Hook executed at the end of the distribution - phase.</para></listitem> - </varlistentry> - -</variablelist> - - -</section> - - -</section> - - -<section xml:id="ssec-stdenv-functions"><title>Shell functions</title> - -<para>The standard environment provides a number of useful -functions.</para> - -<variablelist> - - - <varlistentry xml:id='fun-makeWrapper'> - <term><function>makeWrapper</function> - <replaceable>executable</replaceable> - <replaceable>wrapperfile</replaceable> - <replaceable>args</replaceable></term> - <listitem><para>Constructs a wrapper for a program with various - possible arguments. For example: - + to <filename>~/.gdbinit</filename>. GDB will then be able to find debug + information installed via <literal>nix-env -i</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> + </section> + + <section xml:id="ssec-installCheck-phase"> + <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>. + </para> + + <variablelist> + <title>Variables controlling the installCheck phase</title> + <varlistentry> + <term><varname>doInstallCheck</varname> + </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 +<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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>preInstallCheck</varname> + </term> + <listitem> + <para> + Hook executed at the start of the installCheck phase. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>postInstallCheck</varname> + </term> + <listitem> + <para> + Hook executed at the end of the installCheck phase. + </para> + </listitem> + </varlistentry> + </variablelist> + </section> + + <section xml:id="ssec-distribution-phase"> + <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. + </para> + + <variablelist> + <title>Variables controlling the distribution phase</title> + <varlistentry> + <term><varname>distTarget</varname> + </term> + <listitem> + <para> + The make target that produces the distribution. Defaults to + <literal>dist</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>distFlags</varname> / <varname>distFlagsArray</varname> + </term> + <listitem> + <para> + Additional flags passed to <command>make</command>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>tarballs</varname> + </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>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>dontCopyDist</varname> + </term> + <listitem> + <para> + If set, no files are copied to <filename>$out/tarballs/</filename>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>preDist</varname> + </term> + <listitem> + <para> + Hook executed at the start of the distribution phase. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>postDist</varname> + </term> + <listitem> + <para> + Hook executed at the end of the distribution phase. + </para> + </listitem> + </varlistentry> + </variablelist> + </section> + </section> + <section xml:id="ssec-stdenv-functions"> + <title>Shell functions</title> + + <para> + The standard environment provides a number of useful functions. + </para> + + <variablelist> + <varlistentry xml:id='fun-makeWrapper'> + <term><function>makeWrapper</function><replaceable>executable</replaceable><replaceable>wrapperfile</replaceable><replaceable>args</replaceable> + </term> + <listitem> + <para> + 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 @@ -1392,662 +1764,763 @@ 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>.</para> - - <para><literal>wrapProgram</literal> is a convenience function you probably - want to use most of the time.</para> - + 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. + </para> </listitem> - </varlistentry> - - - <varlistentry xml:id='fun-substitute'> - <term><function>substitute</function> - <replaceable>infile</replaceable> - <replaceable>outfile</replaceable> - <replaceable>subs</replaceable></term> - + </varlistentry> + <varlistentry xml:id='fun-substitute'> + <term><function>substitute</function><replaceable>infile</replaceable><replaceable>outfile</replaceable><replaceable>subs</replaceable> + </term> <listitem> - <para>Performs string substitution on the contents of + <para> + Performs string substitution on the contents of <replaceable>infile</replaceable>, writing the result to - <replaceable>outfile</replaceable>. The substitutions in + <replaceable>outfile</replaceable>. The substitutions in <replaceable>subs</replaceable> are of the following form: - - <variablelist> - <varlistentry> - <term><option>--replace</option> - <replaceable>s1</replaceable> - <replaceable>s2</replaceable></term> - <listitem><para>Replace every occurrence of the string - <replaceable>s1</replaceable> by - <replaceable>s2</replaceable>.</para></listitem> - </varlistentry> - - <varlistentry> - <term><option>--subst-var</option> - <replaceable>varName</replaceable></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.</para></listitem> - </varlistentry> - - <varlistentry> - <term><option>--subst-var-by</option> - <replaceable>varName</replaceable> - <replaceable>s</replaceable></term> - <listitem><para>Replace every occurrence of - <literal>@<replaceable>varName</replaceable>@</literal> by - the string <replaceable>s</replaceable>.</para></listitem> - </varlistentry> - - </variablelist> - - </para> - - <para>Example: - + <variablelist> + <varlistentry> + <term><option>--replace</option><replaceable>s1</replaceable><replaceable>s2</replaceable> + </term> + <listitem> + <para> + Replace every occurrence of the string <replaceable>s1</replaceable> + by <replaceable>s2</replaceable>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>--subst-var</option><replaceable>varName</replaceable> + </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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>--subst-var-by</option><replaceable>varName</replaceable><replaceable>s</replaceable> + </term> + <listitem> + <para> + Replace every occurrence of + <literal>@<replaceable>varName</replaceable>@</literal> by the string + <replaceable>s</replaceable>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + Example: <programlisting> substitute ./foo.in ./foo.out \ --replace /usr/bin/bar $bar/bin/bar \ --replace "a string containing spaces" "some other text" \ --subst-var someVar </programlisting> - - </para> - - <para><function>substitute</function> is implemented using the + </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.</para> - + 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> - - - <varlistentry xml:id='fun-substituteInPlace'> - <term><function>substituteInPlace</function> - <replaceable>file</replaceable> - <replaceable>subs</replaceable></term> - <listitem><para>Like <function>substitute</function>, but performs - the substitutions in place on the file - <replaceable>file</replaceable>.</para></listitem> - </varlistentry> - - - <varlistentry xml:id='fun-substituteAll'> - <term><function>substituteAll</function> - <replaceable>infile</replaceable> - <replaceable>outfile</replaceable></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 - + </varlistentry> + <varlistentry xml:id='fun-substituteInPlace'> + <term><function>substituteInPlace</function><replaceable>file</replaceable><replaceable>subs</replaceable> + </term> + <listitem> + <para> + Like <function>substitute</function>, but performs the substitutions in + place on the file <replaceable>file</replaceable>. + </para> + </listitem> + </varlistentry> + <varlistentry xml:id='fun-substituteAll'> + <term><function>substituteAll</function><replaceable>infile</replaceable><replaceable>outfile</replaceable> + </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 <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 echo @foo@ </programlisting> - - 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).</para> - </listitem> - </varlistentry> - - - <varlistentry xml:id='fun-substituteAllInPlace'> - <term><function>substituteAllInPlace</function> - <replaceable>file</replaceable></term> - <listitem><para>Like <function>substituteAll</function>, but performs - the substitutions in place on the file - <replaceable>file</replaceable>.</para></listitem> - </varlistentry> - - - <varlistentry xml:id='fun-stripHash'> - <term><function>stripHash</function> - <replaceable>path</replaceable></term> - <listitem><para>Strips the directory and hash part of a store - path, outputting the name part to <literal>stdout</literal>. - For example: - + 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). + </para> + </listitem> + </varlistentry> + <varlistentry xml:id='fun-substituteAllInPlace'> + <term><function>substituteAllInPlace</function><replaceable>file</replaceable> + </term> + <listitem> + <para> + Like <function>substituteAll</function>, but performs the substitutions + in place on the file <replaceable>file</replaceable>. + </para> + </listitem> + </varlistentry> + <varlistentry xml:id='fun-stripHash'> + <term><function>stripHash</function><replaceable>path</replaceable> + </term> + <listitem> + <para> + 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) </programlisting> - - </para></listitem> - </varlistentry> - - - <varlistentry xml:id='fun-wrapProgram'> - <term><function>wrapProgram</function> - <replaceable>executable</replaceable> - <replaceable>makeWrapperArgs</replaceable></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>.</para> - - <para>It cannot be applied multiple times, since it will overwrite the wrapper - file.</para> + </para> + </listitem> + </varlistentry> + <varlistentry xml:id='fun-wrapProgram'> + <term><function>wrapProgram</function><replaceable>executable</replaceable><replaceable>makeWrapperArgs</replaceable> + </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>. + </para> + <para> + It cannot be applied multiple times, since it will overwrite the wrapper + file. + </para> </listitem> - </varlistentry> - - -</variablelist> - -</section> - - -<section xml:id="ssec-setup-hooks"><title>Package setup hooks</title> - -<para> - Nix itself considers a build-time dependency 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 it's 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. -</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 adding 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 libaries 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 it 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 it's 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"> + </varlistentry> + </variablelist> + </section> + <section xml:id="ssec-setup-hooks"> + <title>Package setup hooks</title> + + <para> + Nix itself considers a build-time dependency 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 it's 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. + </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 adding 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 libaries 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 it 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 it's 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 these 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> - Here are some packages that provide a setup hook. - Since the mechanism is modular, this probably isn't an exhaustive list. - Then again, since the mechanism is only to be used as a last resort, it might be. -<variablelist> - - <varlistentry> - <term>Bintools Wrapper</term> - <listitem> + </para> + + <para> + The <emphasis>existence</emphasis> of setups hooks has long been documented + and packages inside Nixpkgs are free to use these 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> + Here are some packages that provide a setup hook. Since the mechanism is + modular, this probably isn't an exhaustive list. Then again, since the + mechanism is only to be used as a last resort, it might be. + <variablelist> + <varlistentry> + <term>Bintools Wrapper</term> + <listitem> <para> - 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 Bintools Wrapper. - Packages typically depend on CC Wrapper, which in turn (at run time) depends on Bintools Wrapper. + 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 Bintools Wrapper. + Packages typically depend on CC Wrapper, which in turn (at run time) + depends on Bintools Wrapper. </para> <para> - 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. - Bintools Wrapper's setup hook causes any <filename>lib</filename> and <filename>lib64</filename> subdirectories to be added to <envar>NIX_LDFLAGS</envar>. - Since CC Wrapper and Bintools Wrapper use the same strategy, most of the Bintools Wrapper code is sparsely commented and refers to CC Wrapper. - But CC Wrapper's code, by contrast, has quite lengthy comments. - Bintools Wrapper merely cites those, rather than repeating them, to avoid falling out of sync. + 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. Bintools + Wrapper's setup hook causes any <filename>lib</filename> and + <filename>lib64</filename> subdirectories to be added to + <envar>NIX_LDFLAGS</envar>. Since CC Wrapper and Bintools Wrapper use + the same strategy, most of the Bintools Wrapper code is sparsely + commented and refers to CC Wrapper. But CC Wrapper's code, by contrast, + has quite lengthy comments. 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 full-fill which purpose. - They are defined to just be the base name of the tools, under the assumption that 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><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. - </para></footnote> - <envar>BUILD_</envar>- and <envar>TARGET_</envar>-prefixed versions of the normal environment variable are defined for the additional Bintools Wrappers, properly disambiguating them. + A final task of the setup hook is defining a number of standard + environment variables to tell build systems which executables full-fill + which purpose. They are defined to just be the base name of the tools, + under the assumption that 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> + <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. + </para> + </footnote> + <envar>BUILD_</envar>- and <envar>TARGET_</envar>-prefixed versions of + the normal environment variable are defined for the additional Bintools + Wrappers, properly disambiguating them. </para> <para> - A problem with this final task is that 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 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> - - <varlistentry> - <term>CC Wrapper</term> - <listitem> + </listitem> + </varlistentry> + <varlistentry> + <term>CC Wrapper</term> + <listitem> <para> - 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 CC Wrapper. - Packages typically depend on CC Wrapper, which in turn (at run time) depends on Bintools Wrapper. + 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 CC Wrapper. Packages typically + depend on CC Wrapper, which in turn (at run time) depends on Bintools + Wrapper. </para> <para> - Dependency finding is undoubtedly the main task of CC Wrapper. - This works just like 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 CC Wrapper. This + works just like 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> - CC Wrapper also like Bintools Wrapper defines 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. + CC Wrapper also like Bintools Wrapper defines 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> - - <varlistentry> - <term>Perl</term> - <listitem> + </listitem> + </varlistentry> + <varlistentry> + <term>Perl</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> - - <varlistentry> - <term>Python</term> - <listitem><para>Adds the - <filename>lib/${python.libPrefix}/site-packages</filename> subdirectory of - each build input to the <envar>PYTHONPATH</envar> environment - variable.</para></listitem> - </varlistentry> - - <varlistentry> - <term>pkg-config</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.</para></listitem> - </varlistentry> - - <varlistentry> - <term>Automake</term> - <listitem><para>Adds the <filename>share/aclocal</filename> - subdirectory of each build input to the <envar>ACLOCAL_PATH</envar> - environment variable.</para></listitem> - </varlistentry> - - <varlistentry> - <term>Autoconf</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.</para></listitem> - </varlistentry> - - <varlistentry> - <term>libxml2</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.</para></listitem> - </varlistentry> - - <varlistentry> - <term>teTeX / TeX Live</term> - <listitem><para>Adds the <filename>share/texmf-nix</filename> - subdirectory of each build input to the <envar>TEXINPUTS</envar> - environment variable.</para></listitem> - </varlistentry> - - <varlistentry> - <term>Qt 4</term> - <listitem><para>Sets the <envar>QTDIR</envar> environment variable - to Qt’s path.</para></listitem> - </varlistentry> - - <varlistentry> - <term>gdk-pixbuf</term> - <listitem><para>Exports <envar>GDK_PIXBUF_MODULE_FILE</envar> - environment variable the the builder. Add librsvg package - to <varname>buildInputs</varname> to get svg support.</para></listitem> - </varlistentry> - - <varlistentry> - <term>GHC</term> - <listitem><para>Creates a temporary package database and registers - every Haskell build input in it (TODO: how?).</para></listitem> - </varlistentry> - - <varlistentry> - <term>GStreamer</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.</para></listitem> - </varlistentry> - - <varlistentry> - <term>paxctl</term> - <listitem><para>Defines the <varname>paxmark</varname> helper for - setting per-executable PaX flags on Linux (where it is available by - default; on all other platforms, <varname>paxmark</varname> is a no-op). - For example, to disable secure memory protections on the executable - <replaceable>foo</replaceable>: - <programlisting> + </listitem> + </varlistentry> + <varlistentry> + <term>Python</term> + <listitem> + <para> + Adds the <filename>lib/${python.libPrefix}/site-packages</filename> + subdirectory of each build input to the <envar>PYTHONPATH</envar> + environment variable. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>pkg-config</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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Automake</term> + <listitem> + <para> + Adds the <filename>share/aclocal</filename> subdirectory of each build + input to the <envar>ACLOCAL_PATH</envar> environment variable. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Autoconf</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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>libxml2</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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>teTeX / TeX Live</term> + <listitem> + <para> + Adds the <filename>share/texmf-nix</filename> subdirectory of each build + input to the <envar>TEXINPUTS</envar> environment variable. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Qt 4</term> + <listitem> + <para> + Sets the <envar>QTDIR</envar> environment variable to Qt’s path. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>gdk-pixbuf</term> + <listitem> + <para> + Exports <envar>GDK_PIXBUF_MODULE_FILE</envar> environment variable the + the builder. Add librsvg package to <varname>buildInputs</varname> to + get svg support. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>GHC</term> + <listitem> + <para> + Creates a temporary package database and registers every Haskell build + input in it (TODO: how?). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>GStreamer</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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>paxctl</term> + <listitem> + <para> + Defines the <varname>paxmark</varname> helper for setting per-executable + PaX flags on Linux (where it is available by default; on all other + platforms, <varname>paxmark</varname> is a no-op). For example, to + disable secure memory protections on the executable + <replaceable>foo</replaceable>: +<programlisting> postFixup = '' paxmark m $out/bin/<replaceable>foo</replaceable> ''; </programlisting> - The <literal>m</literal> flag is the most common flag and is typically - required for applications that employ JIT compilation or otherwise need to - execute code generated at run-time. Disabling PaX protections should be - considered a last resort: if possible, problematic features should be - disabled or patched to work with PaX.</para></listitem> - </varlistentry> - - <varlistentry> - <term>autoPatchelfHook</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. All packages within the - <envar>runtimeDependencies</envar> environment variable are unconditionally - added to executables, which is useful for programs that use - <citerefentry> - <refentrytitle>dlopen</refentrytitle> - <manvolnum>3</manvolnum> - </citerefentry> - to load libraries at runtime.</para></listitem> - </varlistentry> - -</variablelist> - -</para> - -</section> - - -<section xml:id="sec-purity-in-nixpkgs"><title>Purity in Nixpkgs</title> - -<para>[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.</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>. -</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. -</para> - -<para>The following flags are enabled by default and might require disabling with -<varname>hardeningDisable</varname> if the program to package is incompatible. -</para> - -<variablelist> - - <varlistentry> - <term><varname>format</varname></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>.</para> - - <para>This needs to be turned off or fixed for errors similar to:</para> - - <programlisting> + The <literal>m</literal> flag is the most common flag and is typically + required for applications that employ JIT compilation or otherwise need + to execute code generated at run-time. Disabling PaX protections should + be considered a last resort: if possible, problematic features should be + disabled or patched to work with PaX. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>autoPatchelfHook</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. All packages within the + <envar>runtimeDependencies</envar> environment variable are + unconditionally added to executables, which is useful for programs that + use <citerefentry> + <refentrytitle>dlopen</refentrytitle> + <manvolnum>3</manvolnum> </citerefentry> to load libraries at runtime. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </section> + <section xml:id="sec-purity-in-nixpkgs"> + <title>Purity in Nixpkgs</title> + + <para> + [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. + </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>. + </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. + </para> + + <para> + The following flags are enabled by default and might require disabling with + <varname>hardeningDisable</varname> if the program to package is + incompatible. + </para> + + <variablelist> + <varlistentry> + <term><varname>format</varname> + </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>. + </para> + <para> + This needs to be turned off or fixed for errors similar to: + </para> +<programlisting> /tmp/nix-build-zynaddsubfx-2.5.2.drv-0/zynaddsubfx-2.5.2/src/UI/guimain.cpp:571:28: error: format not a string literal and no format arguments [-Werror=format-security] printf(help_message); ^ cc1plus: some warnings being treated as errors - </programlisting></listitem> - </varlistentry> - - <varlistentry> - <term><varname>stackprotector</varname></term> + </programlisting> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>stackprotector</varname> + </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).</para> - - <para>This needs to be turned off or fixed for errors similar to:</para> - - <programlisting> + <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). + </para> + <para> + This needs to be turned off or fixed for errors similar to: + </para> +<programlisting> bin/blib.a(bios_console.o): In function `bios_handle_cup': /tmp/nix-build-ipxe-20141124-5cbdc41.drv-0/ipxe-5cbdc41/src/arch/i386/firmware/pcbios/bios_console.c:86: undefined reference to `__stack_chk_fail' - </programlisting></listitem> - </varlistentry> - - <varlistentry> - <term><varname>fortify</varname></term> + </programlisting> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>fortify</varname> + </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. - </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>.</para> - - <para>This needs to be turned off or fixed for errors similar to:</para> - - <programlisting> + <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. + </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>. + </para> + <para> + This needs to be turned off or fixed for errors similar to: + </para> +<programlisting> malloc.c:404:15: error: return type is an incomplete type malloc.c:410:19: error: storage size of 'ms' isn't known </programlisting> - <programlisting> +<programlisting> strdup.h:22:1: error: expected identifier or '(' before '__extension__' </programlisting> - <programlisting> +<programlisting> strsep.c:65:23: error: register name not specified for 'delim' </programlisting> - <programlisting> +<programlisting> installwatch.c:3751:5: error: conflicting types for '__open_2' </programlisting> - <programlisting> +<programlisting> fcntl2.h:50:4: error: call to '__open_missing_mode' declared with attribute error: open with O_CREAT or O_TMPFILE in second argument needs 3 arguments </programlisting> </listitem> - </varlistentry> - - <varlistentry> - <term><varname>pic</varname></term> + </varlistentry> + <varlistentry> + <term><varname>pic</varname> + </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.</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. - </para> - - <para>This needs to be turned off or fixed for assembler errors similar to:</para> - - <programlisting> + <para> + 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. + </para> + <para> + This needs to be turned off or fixed for assembler errors similar to: + </para> +<programlisting> ccbLfRgg.s: Assembler messages: ccbLfRgg.s:33: Error: missing or invalid displacement expression `private_key_len@GOTOFF' </programlisting> </listitem> - </varlistentry> - - <varlistentry> - <term><varname>strictoverflow</varname></term> + </varlistentry> + <varlistentry> + <term><varname>strictoverflow</varname> + </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. - </para> - - <para>This flag should not trigger any build or runtime errors.</para> + <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. + </para> + <para> + This flag should not trigger any build or runtime errors. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><varname>relro</varname></term> + </varlistentry> + <varlistentry> + <term><varname>relro</varname> + </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. - </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.</para> + <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. + </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. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><varname>bindnow</varname></term> + </varlistentry> + <varlistentry> + <term><varname>bindnow</varname> + </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. - </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:</para> - - <programlisting> + <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. + </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: + </para> +<programlisting> intel_drv.so: undefined symbol: vgaHWFreeHWRec </programlisting> </listitem> - </varlistentry> - -</variablelist> + </varlistentry> + </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. -</para> + <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. + </para> -<variablelist> - - <varlistentry> - <term><varname>pie</varname></term> + <variablelist> + <varlistentry> + <term><varname>pie</varname> + </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. - </para> + <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. + </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>. -</para> - -</section> - + </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>. + </para> + </section> </chapter> diff --git a/doc/submitting-changes.xml b/doc/submitting-changes.xml index d3cf221c9b69..ffa3a90b5eb6 100644 --- a/doc/submitting-changes.xml +++ b/doc/submitting-changes.xml @@ -1,447 +1,513 @@ <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="chap-submitting-changes"> + <title>Submitting changes</title> + <section> + <title>Making patches</title> -<title>Submitting changes</title> - -<section> -<title>Making patches</title> - -<itemizedlist> -<listitem> -<para>Read <link xlink:href="https://nixos.org/nixpkgs/manual/">Manual (How to write packages for Nix)</link>.</para> -</listitem> - -<listitem> -<para>Fork the repository on GitHub.</para> -</listitem> - -<listitem> -<para>Create a branch for your future fix. - -<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. - -<itemizedlist> -<listitem> -<para>For example: <command>nixos-version</command> returns <command>15.05.git.0998212 (Dingo)</command>. So you can do:</para> -</listitem> -</itemizedlist> - + <itemizedlist> + <listitem> + <para> + Read <link xlink:href="https://nixos.org/nixpkgs/manual/">Manual (How to + write packages for Nix)</link>. + </para> + </listitem> + <listitem> + <para> + Fork the repository on GitHub. + </para> + </listitem> + <listitem> + <para> + Create a branch for your future fix. + <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. + <itemizedlist> + <listitem> + <para> + For example: <command>nixos-version</command> returns + <command>15.05.git.0998212 (Dingo)</command>. So you can do: + </para> + </listitem> + </itemizedlist> <screen> $ git checkout 0998212 $ git checkout -b 'fix/pkg-name-update' </screen> -</para> -</listitem> - -<listitem> -<para>Please avoid working directly on the <command>master</command> branch.</para> -</listitem> -</itemizedlist> -</para> -</listitem> - -<listitem> -<para>Make commits of logical units. - -<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>.</para> -</listitem> -</itemizedlist> -</para> -</listitem> - -<listitem> -<para>Check for unnecessary whitespace with <command>git diff --check</command> before committing.</para> -</listitem> - -<listitem> -<para>Format the commit in a following way:</para> -<programlisting> -(pkg-name | nixos/<module>): (from -> to | init at version | refactor | etc) -Additional information. -</programlisting> - -<itemizedlist> -<listitem> -<para>Examples: - -<itemizedlist> -<listitem> -<para> -<command>nginx: init at 2.0.1</command> -</para> -</listitem> - -<listitem> -<para> -<command>firefox: 54.0.1 -> 55.0</command> -</para> -</listitem> - -<listitem> -<para> -<command>nixos/hydra: add bazBaz option</command> -</para> -</listitem> - -<listitem> -<para> -<command>nixos/nginx: refactor config generation</command> -</para> -</listitem> -</itemizedlist> -</para> -</listitem> -</itemizedlist> -</listitem> - -<listitem> -<para>Test your changes. If you work with - -<itemizedlist> -<listitem> -<para>nixpkgs: - -<itemizedlist> -<listitem> -<para>update pkg -> - -<itemizedlist> -<listitem> -<para> -<command>nix-env -i pkg-name -f <path to your local nixpkgs folder></command> -</para> -</listitem> -</itemizedlist> -</para> -</listitem> - -<listitem> -<para>add pkg -> - -<itemizedlist> -<listitem> -<para>Make sure it's in <command>pkgs/top-level/all-packages.nix</command> -</para> -</listitem> - -<listitem> -<para> -<command>nix-env -i pkg-name -f <path to your local nixpkgs folder></command> -</para> -</listitem> -</itemizedlist> -</para> -</listitem> - -<listitem> -<para> -<emphasis>If you don't want to install pkg in you profile</emphasis>. - -<itemizedlist> -<listitem> -<para> -<command>nix-build -A pkg-attribute-name <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> -</para> -</listitem> - -<listitem> -<para>If you did <command>nix-env -i pkg-name</command> you can do <command>nix-env -e pkg-name</command> to uninstall it from your system.</para> -</listitem> -</itemizedlist> -</para> -</listitem> - -<listitem> -<para>NixOS and its modules: - -<itemizedlist> -<listitem> -<para>You can add new module to your NixOS configuration file (usually it's <command>/etc/nixos/configuration.nix</command>). - And do <command>sudo nixos-rebuild test -I nixpkgs=<path to your local nixpkgs folder> --fast</command>.</para> -</listitem> -</itemizedlist> -</para> -</listitem> -</itemizedlist> -</para> -</listitem> - -<listitem> -<para>If you have commits <command>pkg-name: oh, forgot to insert whitespace</command>: squash commits in this case. Use <command>git rebase -i</command>.</para> -</listitem> - -<listitem> -<para>Rebase you branch against current <command>master</command>.</para> -</listitem> -</itemizedlist> -</section> - -<section> -<title>Submitting changes</title> - -<itemizedlist> -<listitem> -<para>Push your changes to your fork of nixpkgs.</para> -</listitem> - -<listitem> -<para>Create pull request: - -<itemizedlist> -<listitem> -<para>Write the title in format <command>(pkg-name | nixos/<module>): improvement</command>. - -<itemizedlist> -<listitem> -<para>If you update the pkg, write versions <command>from -> to</command>.</para> -</listitem> -</itemizedlist> -</para> -</listitem> - -<listitem> -<para>Write in comment if you have tested your patch. Do not rely much on <command>TravisCI</command>.</para> -</listitem> - -<listitem> -<para>If you make an improvement, write about your motivation.</para> -</listitem> - -<listitem> -<para>Notify maintainers of the package. For example add to the message: <command>cc @jagajaga @domenkozar</command>.</para> -</listitem> -</itemizedlist> -</para> -</listitem> -</itemizedlist> -</section> - -<section> - <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. - </para> - <para>When a PR is created, it will be pre-populated with some checkboxes detailed below: - </para> - <section> - <title>Tested using sandboxing</title> + </para> + </listitem> + <listitem> + <para> + Please avoid working directly on the <command>master</command> branch. + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + <listitem> <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. + Make commits of logical units. + <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>. + </para> + </listitem> + </itemizedlist> </para> + </listitem> + <listitem> <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. + Check for unnecessary whitespace with <command>git diff --check</command> + before committing. </para> + </listitem> + <listitem> <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: - <itemizedlist> + Format the commit in a following way: + </para> +<programlisting> +(pkg-name | nixos/<module>): (from -> to | init at version | refactor | etc) +Additional information. +</programlisting> + <itemizedlist> + <listitem> + <para> + Examples: + <itemizedlist> <listitem> - <para> - <emphasis role="bold">Globally enable sandboxing on NixOS</emphasis>: - add the following to - <filename>configuration.nix</filename> - <screen>nix.useSandbox = true;</screen> - </para> + <para> + <command>nginx: init at 2.0.1</command> + </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> - </para> + <para> + <command>firefox: 54.0.1 -> 55.0</command> + </para> </listitem> - </itemizedlist> - </para> - - </section> - <section> - <title>Built on platform(s)</title> + <listitem> + <para> + <command>nixos/hydra: add bazBaz option</command> + </para> + </listitem> + <listitem> + <para> + <command>nixos/nginx: refactor config generation</command> + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> <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. + Test your changes. If you work with + <itemizedlist> + <listitem> + <para> + nixpkgs: + <itemizedlist> + <listitem> + <para> + update pkg -> + <itemizedlist> + <listitem> + <para> + <command>nix-env -i pkg-name -f <path to your local nixpkgs + folder></command> + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + <listitem> + <para> + add pkg -> + <itemizedlist> + <listitem> + <para> + Make sure it's in + <command>pkgs/top-level/all-packages.nix</command> + </para> + </listitem> + <listitem> + <para> + <command>nix-env -i pkg-name -f <path to your local nixpkgs + folder></command> + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + <listitem> + <para> + <emphasis>If you don't want to install pkg in you + profile</emphasis>. + <itemizedlist> + <listitem> + <para> + <command>nix-build -A pkg-attribute-name <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> + </para> + </listitem> + <listitem> + <para> + If you did <command>nix-env -i pkg-name</command> you can do + <command>nix-env -e pkg-name</command> to uninstall it from your + system. + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + <listitem> + <para> + NixOS and its modules: + <itemizedlist> + <listitem> + <para> + You can add new module to your NixOS configuration file (usually + it's <command>/etc/nixos/configuration.nix</command>). And do + <command>sudo nixos-rebuild test -I nixpkgs=<path to your local + nixpkgs folder> --fast</command>. + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + </itemizedlist> </para> - </section> - <section> - <title>Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)</title> + </listitem> + <listitem> <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>. + 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> - </section> - <section> - <title>Tested compilation of all pkgs that depend on this change using <command>nox-review</command></title> + </listitem> + <listitem> <para> - If you are updating a package's version, you can use nox to make sure all - packages that depend on the updated package still compile correctly. This - can be done using the nox utility. The <command>nox-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. + Rebase you branch against current <command>master</command>. </para> + </listitem> + </itemizedlist> + </section> + <section> + <title>Submitting changes</title> + + <itemizedlist> + <listitem> <para> - review uncommitted changes: - <screen>nix-shell -p nox --run "nox-review wip"</screen> + Push your changes to your fork of nixpkgs. </para> + </listitem> + <listitem> <para> - review changes from pull request number 12345: - <screen>nix-shell -p nox --run "nox-review pr 12345"</screen> + Create pull request: + <itemizedlist> + <listitem> + <para> + Write the title in format <command>(pkg-name | nixos/<module>): + improvement</command>. + <itemizedlist> + <listitem> + <para> + If you update the pkg, write versions <command>from -> to</command>. + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + <listitem> + <para> + Write in comment if you have tested your patch. Do not rely much on + <command>TravisCI</command>. + </para> + </listitem> + <listitem> + <para> + If you make an improvement, write about your motivation. + </para> + </listitem> + <listitem> + <para> + Notify maintainers of the package. For example add to the message: + <command>cc @jagajaga @domenkozar</command>. + </para> + </listitem> + </itemizedlist> </para> - </section> + </listitem> + </itemizedlist> + </section> + <section> + <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. + </para> + + <para> + When a PR is created, it will be pre-populated with some checkboxes detailed + below: + </para> + <section> - <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. - </para> + <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. + </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. + </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: + <itemizedlist> + <listitem> + <para> + <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> + </para> + </listitem> + </itemizedlist> + </para> </section> + <section> - <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. - </para> - + <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. + </para> </section> -</section> - -<section> -<title>Hotfixing pull requests</title> -<itemizedlist> -<listitem> -<para>Make the appropriate changes in you branch.</para> -</listitem> - -<listitem> -<para>Don't create additional commits, do + <section> + <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>. + </para> + </section> -<itemizedlist> -<listitem> -<para><command>git rebase -i</command></para> -</listitem> -<listitem> -<para> -<command>git push --force</command> to your branch.</para> -</listitem> -</itemizedlist> -</para> -</listitem> + <section> + <title>Tested compilation of all pkgs that depend on this change using <command>nox-review</command></title> + + <para> + If you are updating a package's version, you can use nox to make sure all + packages that depend on the updated package still compile correctly. This + can be done using the nox utility. The <command>nox-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> + review uncommitted changes: +<screen>nix-shell -p nox --run "nox-review wip"</screen> + </para> + + <para> + review changes from pull request number 12345: +<screen>nix-shell -p nox --run "nox-review pr 12345"</screen> + </para> + </section> -</itemizedlist> -</section> + <section> + <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. + </para> + </section> -<section> -<title>Commit policy</title> + <section> + <title>Meets nixpkgs contribution standards</title> -<itemizedlist> -<listitem> -<para>Commits must be sufficiently tested before being merged, both for the master and staging branches.</para> -</listitem> + <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. + </para> + </section> + </section> + <section> + <title>Hotfixing pull requests</title> -<listitem> -<para>Hydra builds for master and staging should not be used as testing platform, it's a build farm for changes that have been already tested.</para> -</listitem> + <itemizedlist> + <listitem> + <para> + Make the appropriate changes in you branch. + </para> + </listitem> + <listitem> + <para> + Don't create additional commits, do + <itemizedlist> + <listitem> + <para> + <command>git rebase -i</command> + </para> + </listitem> + <listitem> + <para> + <command>git push --force</command> to your branch. + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + </itemizedlist> + </section> + <section> + <title>Commit policy</title> -<listitem> -<para>When changing the bootloader installation process, extra care must be taken. Grub installations cannot be rolled back, hence changes may break people's installations forever. For any non-trivial change to the bootloader please file a PR asking for review, especially from @edolstra.</para> -</listitem> -</itemizedlist> + <itemizedlist> + <listitem> + <para> + 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. + </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. + </para> + </listitem> + </itemizedlist> -<section> - <title>Master branch</title> + <section> + <title>Master branch</title> - <itemizedlist> + <itemizedlist> <listitem> - <para> - It should only see non-breaking commits that do not cause mass rebuilds. - </para> + <para> + It should only see non-breaking commits that do not cause mass rebuilds. + </para> </listitem> - </itemizedlist> -</section> + </itemizedlist> + </section> -<section> - <title>Staging branch</title> + <section> + <title>Staging branch</title> - <itemizedlist> + <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="http://comments.gmane.org/gmane.linux.distributions.nixos/13447">Read policy here</link>. - </para> + <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="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. - </para> + <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. + </para> </listitem> - </itemizedlist> -</section> + </itemizedlist> + </section> -<section> - <title>Stable release branches</title> + <section> + <title>Stable release branches</title> - <itemizedlist> + <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. - </para> - <para>An example of a cherry-picked commit would look like this:</para> - <screen> + <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. + </para> + <para> + An example of a cherry-picked commit would look like this: + </para> +<screen> nixos: Refactor the world. The original commit message describing the reason why the world was torn apart. @@ -451,9 +517,7 @@ Reason: I just had a gut feeling that this would also be wanted by people from the stone age. </screen> </listitem> - </itemizedlist> -</section> - -</section> + </itemizedlist> + </section> + </section> </chapter> - diff --git a/lib/systems/examples.nix b/lib/systems/examples.nix index e229cccb365c..fdb120ebb5cb 100644 --- a/lib/systems/examples.nix +++ b/lib/systems/examples.nix @@ -96,7 +96,7 @@ rec { }; iphone32 = { - config = "armv7-apple-ios"; + config = "armv7a-apple-ios"; # config = "arm-apple-darwin10"; sdkVer = "10.2"; useiOSPrebuilt = true; diff --git a/nixos/doc/manual/.gitignore b/nixos/doc/manual/.gitignore new file mode 100644 index 000000000000..879282624217 --- /dev/null +++ b/nixos/doc/manual/.gitignore @@ -0,0 +1,2 @@ +generated +manual-combined.xml diff --git a/nixos/doc/manual/Makefile b/nixos/doc/manual/Makefile index b15fbaa270fc..2e2322d5fb51 100644 --- a/nixos/doc/manual/Makefile +++ b/nixos/doc/manual/Makefile @@ -1,6 +1,22 @@ -debug: +.PHONY: all +all: manual-combined.xml format + +.PHONY: debug +debug: generated manual-combined.xml + +manual-combined.xml: generated *.xml + rm -f ./manual-combined.xml nix-shell --packages xmloscopy \ - --run 'xmloscopy --docbook5 ./manual.xml ./manual-combined.xml' + --run "xmloscopy --docbook5 ./manual.xml ./manual-combined.xml" + +.PHONY: format +format: + find . -iname '*.xml' -type f -print0 | xargs -0 -I{} -n1 \ + xmlformat --config-file "../xmlformat.conf" -i {} + +.PHONY: clean +clean: + rm -f manual-combined.xml generated generated: ./options-to-docbook.xsl nix-build ../../release.nix \ diff --git a/nixos/doc/manual/administration/boot-problems.xml b/nixos/doc/manual/administration/boot-problems.xml index be6ff3aac0fe..5f05ad261ef3 100644 --- a/nixos/doc/manual/administration/boot-problems.xml +++ b/nixos/doc/manual/administration/boot-problems.xml @@ -3,63 +3,83 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-boot-problems"> + <title>Boot Problems</title> -<title>Boot Problems</title> + <para> + If NixOS fails to boot, there are a number of kernel command line parameters + that may help you to identify or fix the issue. You can add these parameters + in the GRUB boot menu by pressing “e” to modify the selected boot entry + and editing the line starting with <literal>linux</literal>. The following + are some useful kernel command line parameters that are recognised by the + NixOS boot scripts or by systemd: + <variablelist> + <varlistentry> + <term><literal>boot.shell_on_fail</literal> + </term> + <listitem> + <para> + Start a root shell if something goes wrong in stage 1 of the boot process + (the initial ramdisk). This is disabled by default because there is no + authentication for the root shell. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>boot.debug1</literal> + </term> + <listitem> + <para> + Start an interactive shell in stage 1 before anything useful has been + done. That is, no modules have been loaded and no file systems have been + mounted, except for <filename>/proc</filename> and + <filename>/sys</filename>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>boot.trace</literal> + </term> + <listitem> + <para> + Print every shell command executed by the stage 1 and 2 boot scripts. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>single</literal> + </term> + <listitem> + <para> + Boot into rescue mode (a.k.a. single user mode). This will cause systemd + to start nothing but the unit <literal>rescue.target</literal>, which + runs <command>sulogin</command> to prompt for the root password and start + a root login shell. Exiting the shell causes the system to continue with + the normal boot process. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>systemd.log_level=debug systemd.log_target=console</literal> + </term> + <listitem> + <para> + Make systemd very verbose and send log messages to the console instead of + the journal. + </para> + </listitem> + </varlistentry> + </variablelist> + For more parameters recognised by systemd, see <citerefentry> + <refentrytitle>systemd</refentrytitle> + <manvolnum>1</manvolnum></citerefentry>. + </para> -<para>If NixOS fails to boot, there are a number of kernel command -line parameters that may help you to identify or fix the issue. You -can add these parameters in the GRUB boot menu by pressing “e” to -modify the selected boot entry and editing the line starting with -<literal>linux</literal>. The following are some useful kernel command -line parameters that are recognised by the NixOS boot scripts or by -systemd: - -<variablelist> - - <varlistentry><term><literal>boot.shell_on_fail</literal></term> - <listitem><para>Start a root shell if something goes wrong in - stage 1 of the boot process (the initial ramdisk). This is - disabled by default because there is no authentication for the - root shell.</para></listitem> - </varlistentry> - - <varlistentry><term><literal>boot.debug1</literal></term> - <listitem><para>Start an interactive shell in stage 1 before - anything useful has been done. That is, no modules have been - loaded and no file systems have been mounted, except for - <filename>/proc</filename> and - <filename>/sys</filename>.</para></listitem> - </varlistentry> - - <varlistentry><term><literal>boot.trace</literal></term> - <listitem><para>Print every shell command executed by the stage 1 - and 2 boot scripts.</para></listitem> - </varlistentry> - - <varlistentry><term><literal>single</literal></term> - <listitem><para>Boot into rescue mode (a.k.a. single user mode). - This will cause systemd to start nothing but the unit - <literal>rescue.target</literal>, which runs - <command>sulogin</command> to prompt for the root password and - start a root login shell. Exiting the shell causes the system to - continue with the normal boot process.</para></listitem> - </varlistentry> - - <varlistentry><term><literal>systemd.log_level=debug systemd.log_target=console</literal></term> - <listitem><para>Make systemd very verbose and send log messages to - the console instead of the journal.</para></listitem> - </varlistentry> - -</variablelist> - -For more parameters recognised by systemd, see -<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para> - -<para>If no login prompts or X11 login screens appear (e.g. due to -hanging dependencies), you can press Alt+ArrowUp. If you’re lucky, -this will start rescue mode (described above). (Also note that since -most units have a 90-second timeout before systemd gives up on them, -the <command>agetty</command> login prompts should appear eventually -unless something is very wrong.)</para> - -</section> \ No newline at end of file + <para> + If no login prompts or X11 login screens appear (e.g. due to hanging + dependencies), you can press Alt+ArrowUp. If you’re lucky, this will start + rescue mode (described above). (Also note that since most units have a + 90-second timeout before systemd gives up on them, the + <command>agetty</command> login prompts should appear eventually unless + something is very wrong.) + </para> +</section> diff --git a/nixos/doc/manual/administration/cleaning-store.xml b/nixos/doc/manual/administration/cleaning-store.xml index 52512b8f1270..ee201982a40b 100644 --- a/nixos/doc/manual/administration/cleaning-store.xml +++ b/nixos/doc/manual/administration/cleaning-store.xml @@ -3,60 +3,51 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-nix-gc"> - -<title>Cleaning the Nix Store</title> - -<para>Nix has a purely functional model, meaning that packages are -never upgraded in place. Instead new versions of packages end up in a -different location in the Nix store (<filename>/nix/store</filename>). -You should periodically run Nix’s <emphasis>garbage -collector</emphasis> to remove old, unreferenced packages. This is -easy: - + <title>Cleaning the Nix Store</title> + <para> + Nix has a purely functional model, meaning that packages are never upgraded + in place. Instead new versions of packages end up in a different location in + the Nix store (<filename>/nix/store</filename>). You should periodically run + Nix’s <emphasis>garbage collector</emphasis> to remove old, unreferenced + packages. This is easy: <screen> $ nix-collect-garbage </screen> - -Alternatively, you can use a systemd unit that does the same in the -background: - + Alternatively, you can use a systemd unit that does the same in the + background: <screen> # systemctl start nix-gc.service </screen> - -You can tell NixOS in <filename>configuration.nix</filename> to run -this unit automatically at certain points in time, for instance, every -night at 03:15: - + You can tell NixOS in <filename>configuration.nix</filename> to run this unit + automatically at certain points in time, for instance, every night at 03:15: <programlisting> <xref linkend="opt-nix.gc.automatic"/> = true; <xref linkend="opt-nix.gc.dates"/> = "03:15"; </programlisting> - -</para> - -<para>The commands above do not remove garbage collector roots, such -as old system configurations. Thus they do not remove the ability to -roll back to previous configurations. The following command deletes -old roots, removing the ability to roll back to them: + </para> + <para> + The commands above do not remove garbage collector roots, such as old system + configurations. Thus they do not remove the ability to roll back to previous + configurations. The following command deletes old roots, removing the ability + to roll back to them: <screen> $ nix-collect-garbage -d </screen> -You can also do this for specific profiles, e.g. + You can also do this for specific profiles, e.g. <screen> $ nix-env -p /nix/var/nix/profiles/per-user/eelco/profile --delete-generations old </screen> -Note that NixOS system configurations are stored in the profile -<filename>/nix/var/nix/profiles/system</filename>.</para> - -<para>Another way to reclaim disk space (often as much as 40% of the -size of the Nix store) is to run Nix’s store optimiser, which seeks -out identical files in the store and replaces them with hard links to -a single copy. + Note that NixOS system configurations are stored in the profile + <filename>/nix/var/nix/profiles/system</filename>. + </para> + <para> + Another way to reclaim disk space (often as much as 40% of the size of the + Nix store) is to run Nix’s store optimiser, which seeks out identical files + in the store and replaces them with hard links to a single copy. <screen> $ nix-store --optimise </screen> -Since this command needs to read the entire Nix store, it can take -quite a while to finish.</para> - + Since this command needs to read the entire Nix store, it can take quite a + while to finish. + </para> </chapter> diff --git a/nixos/doc/manual/administration/container-networking.xml b/nixos/doc/manual/administration/container-networking.xml index 2fc353059dfc..4b977d1d82eb 100644 --- a/nixos/doc/manual/administration/container-networking.xml +++ b/nixos/doc/manual/administration/container-networking.xml @@ -3,15 +3,13 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-container-networking"> + <title>Container Networking</title> - -<title>Container Networking</title> - -<para>When you create a container using <literal>nixos-container -create</literal>, it gets it own private IPv4 address in the range -<literal>10.233.0.0/16</literal>. You can get the container’s IPv4 -address as follows: - + <para> + When you create a container using <literal>nixos-container create</literal>, + it gets it own private IPv4 address in the range + <literal>10.233.0.0/16</literal>. You can get the container’s IPv4 address + as follows: <screen> # nixos-container show-ip foo 10.233.4.2 @@ -19,40 +17,39 @@ address as follows: $ ping -c1 10.233.4.2 64 bytes from 10.233.4.2: icmp_seq=1 ttl=64 time=0.106 ms </screen> - -</para> - -<para>Networking is implemented using a pair of virtual Ethernet -devices. The network interface in the container is called -<literal>eth0</literal>, while the matching interface in the host is -called <literal>ve-<replaceable>container-name</replaceable></literal> -(e.g., <literal>ve-foo</literal>). The container has its own network -namespace and the <literal>CAP_NET_ADMIN</literal> capability, so it -can perform arbitrary network configuration such as setting up -firewall rules, without affecting or having access to the host’s -network.</para> - -<para>By default, containers cannot talk to the outside network. If -you want that, you should set up Network Address Translation (NAT) -rules on the host to rewrite container traffic to use your external -IP address. This can be accomplished using the following configuration -on the host: - + </para> + + <para> + Networking is implemented using a pair of virtual Ethernet devices. The + network interface in the container is called <literal>eth0</literal>, while + the matching interface in the host is called + <literal>ve-<replaceable>container-name</replaceable></literal> (e.g., + <literal>ve-foo</literal>). The container has its own network namespace and + the <literal>CAP_NET_ADMIN</literal> capability, so it can perform arbitrary + network configuration such as setting up firewall rules, without affecting or + having access to the host’s network. + </para> + + <para> + By default, containers cannot talk to the outside network. If you want that, + you should set up Network Address Translation (NAT) rules on the host to + rewrite container traffic to use your external IP address. This can be + accomplished using the following configuration on the host: <programlisting> <xref linkend="opt-networking.nat.enable"/> = true; <xref linkend="opt-networking.nat.internalInterfaces"/> = ["ve-+"]; <xref linkend="opt-networking.nat.externalInterface"/> = "eth0"; </programlisting> -where <literal>eth0</literal> should be replaced with the desired -external interface. Note that <literal>ve-+</literal> is a wildcard -that matches all container interfaces.</para> - -<para>If you are using Network Manager, you need to explicitly prevent -it from managing container interfaces: - + where <literal>eth0</literal> should be replaced with the desired external + interface. Note that <literal>ve-+</literal> is a wildcard that matches all + container interfaces. + </para> + + <para> + If you are using Network Manager, you need to explicitly prevent it from + managing container interfaces: <programlisting> networking.networkmanager.unmanaged = [ "interface-name:ve-*" ]; </programlisting> -</para> - + </para> </section> diff --git a/nixos/doc/manual/administration/containers.xml b/nixos/doc/manual/administration/containers.xml index 4cd2c8ae5563..0d3355e56a58 100644 --- a/nixos/doc/manual/administration/containers.xml +++ b/nixos/doc/manual/administration/containers.xml @@ -3,32 +3,32 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="ch-containers"> - -<title>Container Management</title> - -<para>NixOS allows you to easily run other NixOS instances as -<emphasis>containers</emphasis>. Containers are a light-weight -approach to virtualisation that runs software in the container at the -same speed as in the host system. NixOS containers share the Nix store -of the host, making container creation very efficient.</para> - -<warning><para>Currently, NixOS containers are not perfectly isolated -from the host system. This means that a user with root access to the -container can do things that affect the host. So you should not give -container root access to untrusted users.</para></warning> - -<para>NixOS containers can be created in two ways: imperatively, using -the command <command>nixos-container</command>, and declaratively, by -specifying them in your <filename>configuration.nix</filename>. The -declarative approach implies that containers get upgraded along with -your host system when you run <command>nixos-rebuild</command>, which -is often not what you want. By contrast, in the imperative approach, -containers are configured and updated independently from the host -system.</para> - -<xi:include href="imperative-containers.xml" /> -<xi:include href="declarative-containers.xml" /> -<xi:include href="container-networking.xml" /> - + <title>Container Management</title> + <para> + NixOS allows you to easily run other NixOS instances as + <emphasis>containers</emphasis>. Containers are a light-weight approach to + virtualisation that runs software in the container at the same speed as in + the host system. NixOS containers share the Nix store of the host, making + container creation very efficient. + </para> + <warning> + <para> + Currently, NixOS containers are not perfectly isolated from the host system. + This means that a user with root access to the container can do things that + affect the host. So you should not give container root access to untrusted + users. + </para> + </warning> + <para> + NixOS containers can be created in two ways: imperatively, using the command + <command>nixos-container</command>, and declaratively, by specifying them in + your <filename>configuration.nix</filename>. The declarative approach implies + that containers get upgraded along with your host system when you run + <command>nixos-rebuild</command>, which is often not what you want. By + contrast, in the imperative approach, containers are configured and updated + independently from the host system. + </para> + <xi:include href="imperative-containers.xml" /> + <xi:include href="declarative-containers.xml" /> + <xi:include href="container-networking.xml" /> </chapter> - diff --git a/nixos/doc/manual/administration/control-groups.xml b/nixos/doc/manual/administration/control-groups.xml index 03db40a3bc52..bb8b7f83d9e0 100644 --- a/nixos/doc/manual/administration/control-groups.xml +++ b/nixos/doc/manual/administration/control-groups.xml @@ -3,20 +3,18 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-cgroups"> - -<title>Control Groups</title> - -<para>To keep track of the processes in a running system, systemd uses -<emphasis>control groups</emphasis> (cgroups). A control group is a -set of processes used to allocate resources such as CPU, memory or I/O -bandwidth. There can be multiple control group hierarchies, allowing -each kind of resource to be managed independently.</para> - -<para>The command <command>systemd-cgls</command> lists all control -groups in the <literal>systemd</literal> hierarchy, which is what -systemd uses to keep track of the processes belonging to each service -or user session: - + <title>Control Groups</title> + <para> + To keep track of the processes in a running system, systemd uses + <emphasis>control groups</emphasis> (cgroups). A control group is a set of + processes used to allocate resources such as CPU, memory or I/O bandwidth. + There can be multiple control group hierarchies, allowing each kind of + resource to be managed independently. + </para> + <para> + The command <command>systemd-cgls</command> lists all control groups in the + <literal>systemd</literal> hierarchy, which is what systemd uses to keep + track of the processes belonging to each service or user session: <screen> $ systemd-cgls ├─user @@ -34,40 +32,34 @@ $ systemd-cgls │ └─2376 dhcpcd --config /nix/store/f8dif8dsi2yaa70n03xir8r653776ka6-dhcpcd.conf └─ <replaceable>...</replaceable> </screen> - -Similarly, <command>systemd-cgls cpu</command> shows the cgroups in -the CPU hierarchy, which allows per-cgroup CPU scheduling priorities. -By default, every systemd service gets its own CPU cgroup, while all -user sessions are in the top-level CPU cgroup. This ensures, for -instance, that a thousand run-away processes in the -<literal>httpd.service</literal> cgroup cannot starve the CPU for one -process in the <literal>postgresql.service</literal> cgroup. (By -contrast, it they were in the same cgroup, then the PostgreSQL process -would get 1/1001 of the cgroup’s CPU time.) You can limit a service’s -CPU share in <filename>configuration.nix</filename>: - + Similarly, <command>systemd-cgls cpu</command> shows the cgroups in the CPU + hierarchy, which allows per-cgroup CPU scheduling priorities. By default, + every systemd service gets its own CPU cgroup, while all user sessions are in + the top-level CPU cgroup. This ensures, for instance, that a thousand + run-away processes in the <literal>httpd.service</literal> cgroup cannot + starve the CPU for one process in the <literal>postgresql.service</literal> + cgroup. (By contrast, it they were in the same cgroup, then the PostgreSQL + process would get 1/1001 of the cgroup’s CPU time.) You can limit a + service’s CPU share in <filename>configuration.nix</filename>: <programlisting> <link linkend="opt-systemd.services._name_.serviceConfig">systemd.services.httpd.serviceConfig</link>.CPUShares = 512; </programlisting> - -By default, every cgroup has 1024 CPU shares, so this will halve the -CPU allocation of the <literal>httpd.service</literal> cgroup.</para> - -<para>There also is a <literal>memory</literal> hierarchy that -controls memory allocation limits; by default, all processes are in -the top-level cgroup, so any service or session can exhaust all -available memory. Per-cgroup memory limits can be specified in -<filename>configuration.nix</filename>; for instance, to limit -<literal>httpd.service</literal> to 512 MiB of RAM (excluding swap): - + By default, every cgroup has 1024 CPU shares, so this will halve the CPU + allocation of the <literal>httpd.service</literal> cgroup. + </para> + <para> + There also is a <literal>memory</literal> hierarchy that controls memory + allocation limits; by default, all processes are in the top-level cgroup, so + any service or session can exhaust all available memory. Per-cgroup memory + limits can be specified in <filename>configuration.nix</filename>; for + instance, to limit <literal>httpd.service</literal> to 512 MiB of RAM + (excluding swap): <programlisting> <link linkend="opt-systemd.services._name_.serviceConfig">systemd.services.httpd.serviceConfig</link>.MemoryLimit = "512M"; </programlisting> - -</para> - -<para>The command <command>systemd-cgtop</command> shows a -continuously updated list of all cgroups with their CPU and memory -usage.</para> - + </para> + <para> + The command <command>systemd-cgtop</command> shows a continuously updated + list of all cgroups with their CPU and memory usage. + </para> </chapter> diff --git a/nixos/doc/manual/administration/declarative-containers.xml b/nixos/doc/manual/administration/declarative-containers.xml index 79b230e5fc7f..2a98fb126231 100644 --- a/nixos/doc/manual/administration/declarative-containers.xml +++ b/nixos/doc/manual/administration/declarative-containers.xml @@ -3,14 +3,13 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-declarative-containers"> + <title>Declarative Container Specification</title> -<title>Declarative Container Specification</title> - -<para>You can also specify containers and their configuration in the -host’s <filename>configuration.nix</filename>. For example, the -following specifies that there shall be a container named -<literal>database</literal> running PostgreSQL: - + <para> + You can also specify containers and their configuration in the host’s + <filename>configuration.nix</filename>. For example, the following specifies + that there shall be a container named <literal>database</literal> running + PostgreSQL: <programlisting> containers.database = { config = @@ -20,18 +19,18 @@ containers.database = }; }; </programlisting> - -If you run <literal>nixos-rebuild switch</literal>, the container will -be built. If the container was already running, it will be -updated in place, without rebooting. The container can be configured to -start automatically by setting <literal>containers.database.autoStart = true</literal> -in its configuration.</para> - -<para>By default, declarative containers share the network namespace -of the host, meaning that they can listen on (privileged) -ports. However, they cannot change the network configuration. You can -give a container its own network as follows: - + If you run <literal>nixos-rebuild switch</literal>, the container will be + built. If the container was already running, it will be updated in place, + without rebooting. The container can be configured to start automatically by + setting <literal>containers.database.autoStart = true</literal> in its + configuration. + </para> + + <para> + By default, declarative containers share the network namespace of the host, + meaning that they can listen on (privileged) ports. However, they cannot + change the network configuration. You can give a container its own network as + follows: <programlisting> containers.database = { <link linkend="opt-containers._name_.privateNetwork">privateNetwork</link> = true; @@ -39,22 +38,23 @@ containers.database = { <link linkend="opt-containers._name_.localAddress">localAddress</link> = "192.168.100.11"; }; </programlisting> - -This gives the container a private virtual Ethernet interface with IP -address <literal>192.168.100.11</literal>, which is hooked up to a -virtual Ethernet interface on the host with IP address -<literal>192.168.100.10</literal>. (See the next section for details -on container networking.)</para> - -<para>To disable the container, just remove it from -<filename>configuration.nix</filename> and run <literal>nixos-rebuild -switch</literal>. Note that this will not delete the root directory of -the container in <literal>/var/lib/containers</literal>. Containers can be -destroyed using the imperative method: <literal>nixos-container destroy - foo</literal>.</para> - -<para>Declarative containers can be started and stopped using the -corresponding systemd service, e.g. <literal>systemctl start -container@database</literal>.</para> - + This gives the container a private virtual Ethernet interface with IP address + <literal>192.168.100.11</literal>, which is hooked up to a virtual Ethernet + interface on the host with IP address <literal>192.168.100.10</literal>. (See + the next section for details on container networking.) + </para> + + <para> + To disable the container, just remove it from + <filename>configuration.nix</filename> and run <literal>nixos-rebuild + switch</literal>. Note that this will not delete the root directory of the + container in <literal>/var/lib/containers</literal>. Containers can be + destroyed using the imperative method: <literal>nixos-container destroy + foo</literal>. + </para> + + <para> + Declarative containers can be started and stopped using the corresponding + systemd service, e.g. <literal>systemctl start container@database</literal>. + </para> </section> diff --git a/nixos/doc/manual/administration/imperative-containers.xml b/nixos/doc/manual/administration/imperative-containers.xml index d39ac7f8bef4..9cc7ca3e672a 100644 --- a/nixos/doc/manual/administration/imperative-containers.xml +++ b/nixos/doc/manual/administration/imperative-containers.xml @@ -3,101 +3,85 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-imperative-containers"> + <title>Imperative Container Management</title> -<title>Imperative Container Management</title> - -<para>We’ll cover imperative container management using -<command>nixos-container</command> first. -Be aware that container management is currently only possible -as <literal>root</literal>.</para> - -<para>You create a container with -identifier <literal>foo</literal> as follows: + <para> + We’ll cover imperative container management using + <command>nixos-container</command> first. Be aware that container management + is currently only possible as <literal>root</literal>. + </para> + <para> + You create a container with identifier <literal>foo</literal> as follows: <screen> # nixos-container create foo </screen> - -This creates the container’s root directory in -<filename>/var/lib/containers/foo</filename> and a small configuration -file in <filename>/etc/containers/foo.conf</filename>. It also builds -the container’s initial system configuration and stores it in -<filename>/nix/var/nix/profiles/per-container/foo/system</filename>. You -can modify the initial configuration of the container on the command -line. For instance, to create a container that has -<command>sshd</command> running, with the given public key for -<literal>root</literal>: - + This creates the container’s root directory in + <filename>/var/lib/containers/foo</filename> and a small configuration file + in <filename>/etc/containers/foo.conf</filename>. It also builds the + container’s initial system configuration and stores it in + <filename>/nix/var/nix/profiles/per-container/foo/system</filename>. You can + modify the initial configuration of the container on the command line. For + instance, to create a container that has <command>sshd</command> running, + with the given public key for <literal>root</literal>: <screen> # nixos-container create foo --config ' <xref linkend="opt-services.openssh.enable"/> = true; <link linkend="opt-users.users._name__.openssh.authorizedKeys.keys">users.extraUsers.root.openssh.authorizedKeys.keys</link> = ["ssh-dss AAAAB3N…"]; ' </screen> + </para> -</para> - -<para>Creating a container does not start it. To start the container, -run: - + <para> + Creating a container does not start it. To start the container, run: <screen> # nixos-container start foo </screen> - -This command will return as soon as the container has booted and has -reached <literal>multi-user.target</literal>. On the host, the -container runs within a systemd unit called -<literal>container@<replaceable>container-name</replaceable>.service</literal>. -Thus, if something went wrong, you can get status info using -<command>systemctl</command>: - + This command will return as soon as the container has booted and has reached + <literal>multi-user.target</literal>. On the host, the container runs within + a systemd unit called + <literal>container@<replaceable>container-name</replaceable>.service</literal>. + Thus, if something went wrong, you can get status info using + <command>systemctl</command>: <screen> # systemctl status container@foo </screen> + </para> -</para> - -<para>If the container has started successfully, you can log in as -root using the <command>root-login</command> operation: - + <para> + If the container has started successfully, you can log in as root using the + <command>root-login</command> operation: <screen> # nixos-container root-login foo [root@foo:~]# </screen> - -Note that only root on the host can do this (since there is no -authentication). You can also get a regular login prompt using the -<command>login</command> operation, which is available to all users on -the host: - + Note that only root on the host can do this (since there is no + authentication). You can also get a regular login prompt using the + <command>login</command> operation, which is available to all users on the + host: <screen> # nixos-container login foo foo login: alice Password: *** </screen> - -With <command>nixos-container run</command>, you can execute arbitrary -commands in the container: - + With <command>nixos-container run</command>, you can execute arbitrary + commands in the container: <screen> # nixos-container run foo -- uname -a Linux foo 3.4.82 #1-NixOS SMP Thu Mar 20 14:44:05 UTC 2014 x86_64 GNU/Linux </screen> + </para> -</para> - -<para>There are several ways to change the configuration of the -container. First, on the host, you can edit -<literal>/var/lib/container/<replaceable>name</replaceable>/etc/nixos/configuration.nix</literal>, -and run - + <para> + There are several ways to change the configuration of the container. First, + on the host, you can edit + <literal>/var/lib/container/<replaceable>name</replaceable>/etc/nixos/configuration.nix</literal>, + and run <screen> # nixos-container update foo </screen> - -This will build and activate the new configuration. You can also -specify a new configuration on the command line: - + This will build and activate the new configuration. You can also specify a + new configuration on the command line: <screen> # nixos-container update foo --config ' <xref linkend="opt-services.httpd.enable"/> = true; @@ -108,26 +92,25 @@ specify a new configuration on the command line: # curl http://$(nixos-container show-ip foo)/ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">… </screen> - -However, note that this will overwrite the container’s -<filename>/etc/nixos/configuration.nix</filename>.</para> - -<para>Alternatively, you can change the configuration from within the -container itself by running <command>nixos-rebuild switch</command> -inside the container. Note that the container by default does not have -a copy of the NixOS channel, so you should run <command>nix-channel ---update</command> first.</para> - -<para>Containers can be stopped and started using -<literal>nixos-container stop</literal> and <literal>nixos-container -start</literal>, respectively, or by using -<command>systemctl</command> on the container’s service unit. To -destroy a container, including its file system, do - + However, note that this will overwrite the container’s + <filename>/etc/nixos/configuration.nix</filename>. + </para> + + <para> + Alternatively, you can change the configuration from within the container + itself by running <command>nixos-rebuild switch</command> inside the + container. Note that the container by default does not have a copy of the + NixOS channel, so you should run <command>nix-channel --update</command> + first. + </para> + + <para> + Containers can be stopped and started using <literal>nixos-container + stop</literal> and <literal>nixos-container start</literal>, respectively, or + by using <command>systemctl</command> on the container’s service unit. To + destroy a container, including its file system, do <screen> # nixos-container destroy foo </screen> - -</para> - + </para> </section> diff --git a/nixos/doc/manual/administration/logging.xml b/nixos/doc/manual/administration/logging.xml index 1d5df7770e29..a41936b373d6 100644 --- a/nixos/doc/manual/administration/logging.xml +++ b/nixos/doc/manual/administration/logging.xml @@ -3,26 +3,20 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-logging"> - -<title>Logging</title> - -<para>System-wide logging is provided by systemd’s -<emphasis>journal</emphasis>, which subsumes traditional logging -daemons such as syslogd and klogd. Log entries are kept in binary -files in <filename>/var/log/journal/</filename>. The command -<literal>journalctl</literal> allows you to see the contents of the -journal. For example, - + <title>Logging</title> + <para> + System-wide logging is provided by systemd’s <emphasis>journal</emphasis>, + which subsumes traditional logging daemons such as syslogd and klogd. Log + entries are kept in binary files in <filename>/var/log/journal/</filename>. + The command <literal>journalctl</literal> allows you to see the contents of + the journal. For example, <screen> $ journalctl -b </screen> - -shows all journal entries since the last reboot. (The output of -<command>journalctl</command> is piped into <command>less</command> by -default.) You can use various options and match operators to restrict -output to messages of interest. For instance, to get all messages -from PostgreSQL: - + shows all journal entries since the last reboot. (The output of + <command>journalctl</command> is piped into <command>less</command> by + default.) You can use various options and match operators to restrict output + to messages of interest. For instance, to get all messages from PostgreSQL: <screen> $ journalctl -u postgresql.service -- Logs begin at Mon, 2013-01-07 13:28:01 CET, end at Tue, 2013-01-08 01:09:57 CET. -- @@ -32,21 +26,18 @@ Jan 07 15:44:14 hagbard postgres[2681]: [2-1] LOG: database system is shut down Jan 07 15:45:10 hagbard postgres[2532]: [1-1] LOG: database system was shut down at 2013-01-07 15:44:14 CET Jan 07 15:45:13 hagbard postgres[2500]: [1-1] LOG: database system is ready to accept connections </screen> - -Or to get all messages since the last reboot that have at least a -“critical” severity level: - + Or to get all messages since the last reboot that have at least a + “critical” severity level: <screen> $ journalctl -b -p crit Dec 17 21:08:06 mandark sudo[3673]: pam_unix(sudo:auth): auth could not identify password for [alice] Dec 29 01:30:22 mandark kernel[6131]: [1053513.909444] CPU6: Core temperature above threshold, cpu clock throttled (total events = 1) </screen> - -</para> - -<para>The system journal is readable by root and by users in the -<literal>wheel</literal> and <literal>systemd-journal</literal> -groups. All users have a private journal that can be read using -<command>journalctl</command>.</para> - -</chapter> \ No newline at end of file + </para> + <para> + The system journal is readable by root and by users in the + <literal>wheel</literal> and <literal>systemd-journal</literal> groups. All + users have a private journal that can be read using + <command>journalctl</command>. + </para> +</chapter> diff --git a/nixos/doc/manual/administration/maintenance-mode.xml b/nixos/doc/manual/administration/maintenance-mode.xml index 17a1609e5579..71e3f9ea665d 100644 --- a/nixos/doc/manual/administration/maintenance-mode.xml +++ b/nixos/doc/manual/administration/maintenance-mode.xml @@ -3,16 +3,14 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-maintenance-mode"> + <title>Maintenance Mode</title> -<title>Maintenance Mode</title> - -<para>You can enter rescue mode by running: - + <para> + You can enter rescue mode by running: <screen> # systemctl rescue</screen> - -This will eventually give you a single-user root shell. Systemd will -stop (almost) all system services. To get out of maintenance mode, -just exit from the rescue shell.</para> - + This will eventually give you a single-user root shell. Systemd will stop + (almost) all system services. To get out of maintenance mode, just exit from + the rescue shell. + </para> </section> diff --git a/nixos/doc/manual/administration/network-problems.xml b/nixos/doc/manual/administration/network-problems.xml index 91f9eb4e22c6..570f58358845 100644 --- a/nixos/doc/manual/administration/network-problems.xml +++ b/nixos/doc/manual/administration/network-problems.xml @@ -3,31 +3,25 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-nix-network-issues"> + <title>Network Problems</title> -<title>Network Problems</title> - -<para>Nix uses a so-called <emphasis>binary cache</emphasis> to -optimise building a package from source into downloading it as a -pre-built binary. That is, whenever a command like -<command>nixos-rebuild</command> needs a path in the Nix store, Nix -will try to download that path from the Internet rather than build it -from source. The default binary cache is -<uri>https://cache.nixos.org/</uri>. If this cache is unreachable, -Nix operations may take a long time due to HTTP connection timeouts. -You can disable the use of the binary cache by adding <option>--option -use-binary-caches false</option>, e.g. - + <para> + Nix uses a so-called <emphasis>binary cache</emphasis> to optimise building a + package from source into downloading it as a pre-built binary. That is, + whenever a command like <command>nixos-rebuild</command> needs a path in the + Nix store, Nix will try to download that path from the Internet rather than + build it from source. The default binary cache is + <uri>https://cache.nixos.org/</uri>. If this cache is unreachable, Nix + operations may take a long time due to HTTP connection timeouts. You can + disable the use of the binary cache by adding <option>--option + use-binary-caches false</option>, e.g. <screen> # nixos-rebuild switch --option use-binary-caches false </screen> - -If you have an alternative binary cache at your disposal, you can use -it instead: - + If you have an alternative binary cache at your disposal, you can use it + instead: <screen> # nixos-rebuild switch --option binary-caches http://my-cache.example.org/ </screen> - -</para> - + </para> </section> diff --git a/nixos/doc/manual/administration/rebooting.xml b/nixos/doc/manual/administration/rebooting.xml index 23f3a3219c6a..a5abd6f02588 100644 --- a/nixos/doc/manual/administration/rebooting.xml +++ b/nixos/doc/manual/administration/rebooting.xml @@ -3,42 +3,33 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-rebooting"> - -<title>Rebooting and Shutting Down</title> - -<para>The system can be shut down (and automatically powered off) by -doing: - + <title>Rebooting and Shutting Down</title> + <para> + The system can be shut down (and automatically powered off) by doing: <screen> # shutdown </screen> - -This is equivalent to running <command>systemctl -poweroff</command>.</para> - -<para>To reboot the system, run - + This is equivalent to running <command>systemctl poweroff</command>. + </para> + <para> + To reboot the system, run <screen> # reboot </screen> - -which is equivalent to <command>systemctl reboot</command>. -Alternatively, you can quickly reboot the system using -<literal>kexec</literal>, which bypasses the BIOS by directly loading -the new kernel into memory: - + which is equivalent to <command>systemctl reboot</command>. Alternatively, + you can quickly reboot the system using <literal>kexec</literal>, which + bypasses the BIOS by directly loading the new kernel into memory: <screen> # systemctl kexec </screen> - -</para> - -<para>The machine can be suspended to RAM (if supported) using -<command>systemctl suspend</command>, and suspended to disk using -<command>systemctl hibernate</command>.</para> - -<para>These commands can be run by any user who is logged in locally, -i.e. on a virtual console or in X11; otherwise, the user is asked for -authentication.</para> - + </para> + <para> + The machine can be suspended to RAM (if supported) using <command>systemctl + suspend</command>, and suspended to disk using <command>systemctl + hibernate</command>. + </para> + <para> + These commands can be run by any user who is logged in locally, i.e. on a + virtual console or in X11; otherwise, the user is asked for authentication. + </para> </chapter> diff --git a/nixos/doc/manual/administration/rollback.xml b/nixos/doc/manual/administration/rollback.xml index ae621f33de2c..07c6acaa469c 100644 --- a/nixos/doc/manual/administration/rollback.xml +++ b/nixos/doc/manual/administration/rollback.xml @@ -3,46 +3,39 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-rollback"> - -<title>Rolling Back Configuration Changes</title> - -<para>After running <command>nixos-rebuild</command> to switch to a -new configuration, you may find that the new configuration doesn’t -work very well. In that case, there are several ways to return to a -previous configuration.</para> - -<para>First, the GRUB boot manager allows you to boot into any -previous configuration that hasn’t been garbage-collected. These -configurations can be found under the GRUB submenu “NixOS - All -configurations”. This is especially useful if the new configuration -fails to boot. After the system has booted, you can make the selected -configuration the default for subsequent boots: - + <title>Rolling Back Configuration Changes</title> + + <para> + After running <command>nixos-rebuild</command> to switch to a new + configuration, you may find that the new configuration doesn’t work very + well. In that case, there are several ways to return to a previous + configuration. + </para> + + <para> + First, the GRUB boot manager allows you to boot into any previous + configuration that hasn’t been garbage-collected. These configurations can + be found under the GRUB submenu “NixOS - All configurations”. This is + especially useful if the new configuration fails to boot. After the system + has booted, you can make the selected configuration the default for + subsequent boots: <screen> # /run/current-system/bin/switch-to-configuration boot</screen> + </para> -</para> - -<para>Second, you can switch to the previous configuration in a running -system: - + <para> + Second, you can switch to the previous configuration in a running system: <screen> # nixos-rebuild switch --rollback</screen> - -This is equivalent to running: - + This is equivalent to running: <screen> # /nix/var/nix/profiles/system-<replaceable>N</replaceable>-link/bin/switch-to-configuration switch</screen> - -where <replaceable>N</replaceable> is the number of the NixOS system -configuration. To get a list of the available configurations, do: - + where <replaceable>N</replaceable> is the number of the NixOS system + configuration. To get a list of the available configurations, do: <screen> $ ls -l /nix/var/nix/profiles/system-*-link <replaceable>...</replaceable> lrwxrwxrwx 1 root root 78 Aug 12 13:54 /nix/var/nix/profiles/system-268-link -> /nix/store/202b...-nixos-13.07pre4932_5a676e4-4be1055 </screen> - -</para> - + </para> </section> diff --git a/nixos/doc/manual/administration/running.xml b/nixos/doc/manual/administration/running.xml index 9091511ed527..786dd5e2390d 100644 --- a/nixos/doc/manual/administration/running.xml +++ b/nixos/doc/manual/administration/running.xml @@ -3,22 +3,19 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="ch-running"> - -<title>Administration</title> - -<partintro> -<para>This chapter describes various aspects of managing a running -NixOS system, such as how to use the <command>systemd</command> -service manager.</para> -</partintro> - -<xi:include href="service-mgmt.xml" /> -<xi:include href="rebooting.xml" /> -<xi:include href="user-sessions.xml" /> -<xi:include href="control-groups.xml" /> -<xi:include href="logging.xml" /> -<xi:include href="cleaning-store.xml" /> -<xi:include href="containers.xml" /> -<xi:include href="troubleshooting.xml" /> - + <title>Administration</title> + <partintro> + <para> + This chapter describes various aspects of managing a running NixOS system, + such as how to use the <command>systemd</command> service manager. + </para> + </partintro> + <xi:include href="service-mgmt.xml" /> + <xi:include href="rebooting.xml" /> + <xi:include href="user-sessions.xml" /> + <xi:include href="control-groups.xml" /> + <xi:include href="logging.xml" /> + <xi:include href="cleaning-store.xml" /> + <xi:include href="containers.xml" /> + <xi:include href="troubleshooting.xml" /> </part> diff --git a/nixos/doc/manual/administration/service-mgmt.xml b/nixos/doc/manual/administration/service-mgmt.xml index 1627c7a2fdeb..0c2085c81559 100644 --- a/nixos/doc/manual/administration/service-mgmt.xml +++ b/nixos/doc/manual/administration/service-mgmt.xml @@ -3,26 +3,23 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-systemctl"> - -<title>Service Management</title> - -<para>In NixOS, all system services are started and monitored using -the systemd program. Systemd is the “init” process of the system -(i.e. PID 1), the parent of all other processes. It manages a set of -so-called “units”, which can be things like system services -(programs), but also mount points, swap files, devices, targets -(groups of units) and more. Units can have complex dependencies; for -instance, one unit can require that another unit must be successfully -started before the first unit can be started. When the system boots, -it starts a unit named <literal>default.target</literal>; the -dependencies of this unit cause all system services to be started, -file systems to be mounted, swap files to be activated, and so -on.</para> - -<para>The command <command>systemctl</command> is the main way to -interact with <command>systemd</command>. Without any arguments, it -shows the status of active units: - + <title>Service Management</title> + <para> + In NixOS, all system services are started and monitored using the systemd + program. Systemd is the “init” process of the system (i.e. PID 1), the + parent of all other processes. It manages a set of so-called “units”, + which can be things like system services (programs), but also mount points, + swap files, devices, targets (groups of units) and more. Units can have + complex dependencies; for instance, one unit can require that another unit + must be successfully started before the first unit can be started. When the + system boots, it starts a unit named <literal>default.target</literal>; the + dependencies of this unit cause all system services to be started, file + systems to be mounted, swap files to be activated, and so on. + </para> + <para> + The command <command>systemctl</command> is the main way to interact with + <command>systemd</command>. Without any arguments, it shows the status of + active units: <screen> $ systemctl -.mount loaded active mounted / @@ -31,12 +28,10 @@ sshd.service loaded active running SSH Daemon graphical.target loaded active active Graphical Interface <replaceable>...</replaceable> </screen> - -</para> - -<para>You can ask for detailed status information about a unit, for -instance, the PostgreSQL database service: - + </para> + <para> + You can ask for detailed status information about a unit, for instance, the + PostgreSQL database service: <screen> $ systemctl status postgresql.service postgresql.service - PostgreSQL Server @@ -56,28 +51,22 @@ Jan 07 15:55:57 hagbard postgres[2390]: [1-1] LOG: database system is ready to Jan 07 15:55:57 hagbard postgres[2420]: [1-1] LOG: autovacuum launcher started Jan 07 15:55:57 hagbard systemd[1]: Started PostgreSQL Server. </screen> - -Note that this shows the status of the unit (active and running), all -the processes belonging to the service, as well as the most recent log -messages from the service. - -</para> - -<para>Units can be stopped, started or restarted: - + Note that this shows the status of the unit (active and running), all the + processes belonging to the service, as well as the most recent log messages + from the service. + </para> + <para> + Units can be stopped, started or restarted: <screen> # systemctl stop postgresql.service # systemctl start postgresql.service # systemctl restart postgresql.service </screen> - -These operations are synchronous: they wait until the service has -finished starting or stopping (or has failed). Starting a unit will -cause the dependencies of that unit to be started as well (if -necessary).</para> - + These operations are synchronous: they wait until the service has finished + starting or stopping (or has failed). Starting a unit will cause the + dependencies of that unit to be started as well (if necessary). + </para> <!-- - cgroups: each service and user session is a cgroup - cgroup resource management --> - </chapter> diff --git a/nixos/doc/manual/administration/store-corruption.xml b/nixos/doc/manual/administration/store-corruption.xml index 9f567042b727..a4ca3b651e20 100644 --- a/nixos/doc/manual/administration/store-corruption.xml +++ b/nixos/doc/manual/administration/store-corruption.xml @@ -3,35 +3,34 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-nix-store-corruption"> - -<title>Nix Store Corruption</title> - -<para>After a system crash, it’s possible for files in the Nix store -to become corrupted. (For instance, the Ext4 file system has the -tendency to replace un-synced files with zero bytes.) NixOS tries -hard to prevent this from happening: it performs a -<command>sync</command> before switching to a new configuration, and -Nix’s database is fully transactional. If corruption still occurs, -you may be able to fix it automatically.</para> - -<para>If the corruption is in a path in the closure of the NixOS -system configuration, you can fix it by doing - + <title>Nix Store Corruption</title> + + <para> + After a system crash, it’s possible for files in the Nix store to become + corrupted. (For instance, the Ext4 file system has the tendency to replace + un-synced files with zero bytes.) NixOS tries hard to prevent this from + happening: it performs a <command>sync</command> before switching to a new + configuration, and Nix’s database is fully transactional. If corruption + still occurs, you may be able to fix it automatically. + </para> + + <para> + If the corruption is in a path in the closure of the NixOS system + configuration, you can fix it by doing <screen> # nixos-rebuild switch --repair </screen> + This will cause Nix to check every path in the closure, and if its + cryptographic hash differs from the hash recorded in Nix’s database, the + path is rebuilt or redownloaded. + </para> -This will cause Nix to check every path in the closure, and if its -cryptographic hash differs from the hash recorded in Nix’s database, -the path is rebuilt or redownloaded.</para> - -<para>You can also scan the entire Nix store for corrupt paths: - + <para> + You can also scan the entire Nix store for corrupt paths: <screen> # nix-store --verify --check-contents --repair </screen> - -Any corrupt paths will be redownloaded if they’re available in a -binary cache; otherwise, they cannot be repaired.</para> - + Any corrupt paths will be redownloaded if they’re available in a binary + cache; otherwise, they cannot be repaired. + </para> </section> diff --git a/nixos/doc/manual/administration/troubleshooting.xml b/nixos/doc/manual/administration/troubleshooting.xml index 351fb1883310..6496e7bde387 100644 --- a/nixos/doc/manual/administration/troubleshooting.xml +++ b/nixos/doc/manual/administration/troubleshooting.xml @@ -3,16 +3,14 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="ch-troubleshooting"> - -<title>Troubleshooting</title> - -<para>This chapter describes solutions to common problems you might -encounter when you manage your NixOS system.</para> - -<xi:include href="boot-problems.xml" /> -<xi:include href="maintenance-mode.xml" /> -<xi:include href="rollback.xml" /> -<xi:include href="store-corruption.xml" /> -<xi:include href="network-problems.xml" /> - + <title>Troubleshooting</title> + <para> + This chapter describes solutions to common problems you might encounter when + you manage your NixOS system. + </para> + <xi:include href="boot-problems.xml" /> + <xi:include href="maintenance-mode.xml" /> + <xi:include href="rollback.xml" /> + <xi:include href="store-corruption.xml" /> + <xi:include href="network-problems.xml" /> </chapter> diff --git a/nixos/doc/manual/administration/user-sessions.xml b/nixos/doc/manual/administration/user-sessions.xml index 0a7eb8cd123c..1d95cfb22b69 100644 --- a/nixos/doc/manual/administration/user-sessions.xml +++ b/nixos/doc/manual/administration/user-sessions.xml @@ -3,14 +3,12 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-user-sessions"> - -<title>User Sessions</title> - -<para>Systemd keeps track of all users who are logged into the system -(e.g. on a virtual console or remotely via SSH). The command -<command>loginctl</command> allows querying and manipulating user -sessions. For instance, to list all user sessions: - + <title>User Sessions</title> + <para> + Systemd keeps track of all users who are logged into the system (e.g. on a + virtual console or remotely via SSH). The command <command>loginctl</command> + allows querying and manipulating user sessions. For instance, to list all + user sessions: <screen> $ loginctl SESSION UID USER SEAT @@ -18,12 +16,10 @@ $ loginctl c3 0 root seat0 c4 500 alice </screen> - -This shows that two users are logged in locally, while another is -logged in remotely. (“Seats” are essentially the combinations of -displays and input devices attached to the system; usually, there is -only one seat.) To get information about a session: - + This shows that two users are logged in locally, while another is logged in + remotely. (“Seats” are essentially the combinations of displays and input + devices attached to the system; usually, there is only one seat.) To get + information about a session: <screen> $ loginctl session-status c3 c3 - root (0) @@ -38,16 +34,12 @@ c3 - root (0) ├─10339 -bash └─10355 w3m nixos.org </screen> - -This shows that the user is logged in on virtual console 3. It also -lists the processes belonging to this session. Since systemd keeps -track of this, you can terminate a session in a way that ensures that -all the session’s processes are gone: - + This shows that the user is logged in on virtual console 3. It also lists the + processes belonging to this session. Since systemd keeps track of this, you + can terminate a session in a way that ensures that all the session’s + processes are gone: <screen> # loginctl terminate-session c3 </screen> - -</para> - + </para> </chapter> diff --git a/nixos/doc/manual/configuration/abstractions.xml b/nixos/doc/manual/configuration/abstractions.xml index f794085295cf..5bf0635cc1aa 100644 --- a/nixos/doc/manual/configuration/abstractions.xml +++ b/nixos/doc/manual/configuration/abstractions.xml @@ -3,12 +3,11 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-module-abstractions"> + <title>Abstractions</title> -<title>Abstractions</title> - -<para>If you find yourself repeating yourself over and over, it’s time -to abstract. Take, for instance, this Apache HTTP Server configuration: - + <para> + If you find yourself repeating yourself over and over, it’s time to + abstract. Take, for instance, this Apache HTTP Server configuration: <programlisting> { <xref linkend="opt-services.httpd.virtualHosts"/> = @@ -28,11 +27,9 @@ to abstract. Take, for instance, this Apache HTTP Server configuration: ]; } </programlisting> - -It defines two virtual hosts with nearly identical configuration; the -only difference is that the second one has SSL enabled. To prevent -this duplication, we can use a <literal>let</literal>: - + It defines two virtual hosts with nearly identical configuration; the only + difference is that the second one has SSL enabled. To prevent this + duplication, we can use a <literal>let</literal>: <programlisting> let exampleOrgCommon = @@ -53,17 +50,16 @@ in ]; } </programlisting> - -The <literal>let exampleOrgCommon = -<replaceable>...</replaceable></literal> defines a variable named -<literal>exampleOrgCommon</literal>. The <literal>//</literal> -operator merges two attribute sets, so the configuration of the second -virtual host is the set <literal>exampleOrgCommon</literal> extended -with the SSL options.</para> - -<para>You can write a <literal>let</literal> wherever an expression is -allowed. Thus, you also could have written: - + The <literal>let exampleOrgCommon = <replaceable>...</replaceable></literal> + defines a variable named <literal>exampleOrgCommon</literal>. The + <literal>//</literal> operator merges two attribute sets, so the + configuration of the second virtual host is the set + <literal>exampleOrgCommon</literal> extended with the SSL options. + </para> + + <para> + You can write a <literal>let</literal> wherever an expression is allowed. + Thus, you also could have written: <programlisting> { <xref linkend="opt-services.httpd.virtualHosts"/> = @@ -73,17 +69,16 @@ allowed. Thus, you also could have written: ]; } </programlisting> - -but not <literal>{ let exampleOrgCommon = -<replaceable>...</replaceable>; in <replaceable>...</replaceable>; -}</literal> since attributes (as opposed to attribute values) are not -expressions.</para> - -<para><emphasis>Functions</emphasis> provide another method of -abstraction. For instance, suppose that we want to generate lots of -different virtual hosts, all with identical configuration except for -the host name. This can be done as follows: - + but not <literal>{ let exampleOrgCommon = <replaceable>...</replaceable>; in + <replaceable>...</replaceable>; }</literal> since attributes (as opposed to + attribute values) are not expressions. + </para> + + <para> + <emphasis>Functions</emphasis> provide another method of abstraction. For + instance, suppose that we want to generate lots of different virtual hosts, + all with identical configuration except for the host name. This can be done + as follows: <programlisting> { <xref linkend="opt-services.httpd.virtualHosts"/> = @@ -101,16 +96,15 @@ the host name. This can be done as follows: ]; } </programlisting> - -Here, <varname>makeVirtualHost</varname> is a function that takes a -single argument <literal>name</literal> and returns the configuration -for a virtual host. That function is then called for several names to -produce the list of virtual host configurations.</para> - -<para>We can further improve on this by using the function -<varname>map</varname>, which applies another function to every -element in a list: - + Here, <varname>makeVirtualHost</varname> is a function that takes a single + argument <literal>name</literal> and returns the configuration for a virtual + host. That function is then called for several names to produce the list of + virtual host configurations. + </para> + + <para> + We can further improve on this by using the function <varname>map</varname>, + which applies another function to every element in a list: <programlisting> { <xref linkend="opt-services.httpd.virtualHosts"/> = @@ -120,16 +114,15 @@ element in a list: [ "example.org" "example.com" "example.gov" "example.nl" ]; } </programlisting> - -(The function <literal>map</literal> is called a -<emphasis>higher-order function</emphasis> because it takes another -function as an argument.)</para> - -<para>What if you need more than one argument, for instance, if we -want to use a different <literal>documentRoot</literal> for each -virtual host? Then we can make <varname>makeVirtualHost</varname> a -function that takes a <emphasis>set</emphasis> as its argument, like this: - + (The function <literal>map</literal> is called a <emphasis>higher-order + function</emphasis> because it takes another function as an argument.) + </para> + + <para> + What if you need more than one argument, for instance, if we want to use a + different <literal>documentRoot</literal> for each virtual host? Then we can + make <varname>makeVirtualHost</varname> a function that takes a + <emphasis>set</emphasis> as its argument, like this: <programlisting> { <xref linkend="opt-services.httpd.virtualHosts"/> = @@ -147,10 +140,9 @@ function that takes a <emphasis>set</emphasis> as its argument, like this: ]; } </programlisting> - -But in this case (where every root is a subdirectory of -<filename>/sites</filename> named after the virtual host), it would -have been shorter to define <varname>makeVirtualHost</varname> as + But in this case (where every root is a subdirectory of + <filename>/sites</filename> named after the virtual host), it would have been + shorter to define <varname>makeVirtualHost</varname> as <programlisting> makeVirtualHost = name: { hostName = name; @@ -158,9 +150,7 @@ makeVirtualHost = name: adminAddr = "alice@example.org"; }; </programlisting> - -Here, the construct -<literal>${<replaceable>...</replaceable>}</literal> allows the result -of an expression to be spliced into a string.</para> - + Here, the construct <literal>${<replaceable>...</replaceable>}</literal> + allows the result of an expression to be spliced into a string. + </para> </section> diff --git a/nixos/doc/manual/configuration/ad-hoc-network-config.xml b/nixos/doc/manual/configuration/ad-hoc-network-config.xml index c53b9598109c..00e595c7cb7f 100644 --- a/nixos/doc/manual/configuration/ad-hoc-network-config.xml +++ b/nixos/doc/manual/configuration/ad-hoc-network-config.xml @@ -3,22 +3,18 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="ad-hoc-network-config"> + <title>Ad-Hoc Configuration</title> -<title>Ad-Hoc Configuration</title> - -<para>You can use <xref linkend="opt-networking.localCommands"/> to specify -shell commands to be run at the end of -<literal>network-setup.service</literal>. This is useful for doing -network configuration not covered by the existing NixOS modules. For -instance, to statically configure an IPv6 address: - + <para> + You can use <xref linkend="opt-networking.localCommands"/> to specify shell + commands to be run at the end of <literal>network-setup.service</literal>. + This is useful for doing network configuration not covered by the existing + NixOS modules. For instance, to statically configure an IPv6 address: <programlisting> <xref linkend="opt-networking.localCommands"/> = '' ip -6 addr add 2001:610:685:1::1/64 dev eth0 ''; </programlisting> - -</para> - + </para> </section> diff --git a/nixos/doc/manual/configuration/ad-hoc-packages.xml b/nixos/doc/manual/configuration/ad-hoc-packages.xml index a147291c4f3d..19159d8db5b6 100644 --- a/nixos/doc/manual/configuration/ad-hoc-packages.xml +++ b/nixos/doc/manual/configuration/ad-hoc-packages.xml @@ -3,61 +3,59 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-ad-hoc-packages"> + <title>Ad-Hoc Package Management</title> -<title>Ad-Hoc Package Management</title> - -<para>With the command <command>nix-env</command>, you can install and -uninstall packages from the command line. For instance, to install -Mozilla Thunderbird: - + <para> + With the command <command>nix-env</command>, you can install and uninstall + packages from the command line. For instance, to install Mozilla Thunderbird: <screen> $ nix-env -iA nixos.thunderbird</screen> - -If you invoke this as root, the package is installed in the Nix -profile <filename>/nix/var/nix/profiles/default</filename> and visible -to all users of the system; otherwise, the package ends up in -<filename>/nix/var/nix/profiles/per-user/<replaceable>username</replaceable>/profile</filename> -and is not visible to other users. The <option>-A</option> flag -specifies the package by its attribute name; without it, the package -is installed by matching against its package name -(e.g. <literal>thunderbird</literal>). The latter is slower because -it requires matching against all available Nix packages, and is -ambiguous if there are multiple matching packages.</para> - -<para>Packages come from the NixOS channel. You typically upgrade a -package by updating to the latest version of the NixOS channel: + If you invoke this as root, the package is installed in the Nix profile + <filename>/nix/var/nix/profiles/default</filename> and visible to all users + of the system; otherwise, the package ends up in + <filename>/nix/var/nix/profiles/per-user/<replaceable>username</replaceable>/profile</filename> + and is not visible to other users. The <option>-A</option> flag specifies the + package by its attribute name; without it, the package is installed by + matching against its package name (e.g. <literal>thunderbird</literal>). The + latter is slower because it requires matching against all available Nix + packages, and is ambiguous if there are multiple matching packages. + </para> + + <para> + Packages come from the NixOS channel. You typically upgrade a package by + updating to the latest version of the NixOS channel: <screen> $ nix-channel --update nixos </screen> -and then running <literal>nix-env -i</literal> again. Other packages -in the profile are <emphasis>not</emphasis> affected; this is the -crucial difference with the declarative style of package management, -where running <command>nixos-rebuild switch</command> causes all -packages to be updated to their current versions in the NixOS channel. -You can however upgrade all packages for which there is a newer -version by doing: + and then running <literal>nix-env -i</literal> again. Other packages in the + profile are <emphasis>not</emphasis> affected; this is the crucial difference + with the declarative style of package management, where running + <command>nixos-rebuild switch</command> causes all packages to be updated to + their current versions in the NixOS channel. You can however upgrade all + packages for which there is a newer version by doing: <screen> $ nix-env -u '*' </screen> -</para> + </para> -<para>A package can be uninstalled using the <option>-e</option> -flag: + <para> + A package can be uninstalled using the <option>-e</option> flag: <screen> $ nix-env -e thunderbird </screen> -</para> + </para> -<para>Finally, you can roll back an undesirable -<command>nix-env</command> action: + <para> + Finally, you can roll back an undesirable <command>nix-env</command> action: <screen> $ nix-env --rollback </screen> -</para> - -<para><command>nix-env</command> has many more flags. For details, -see the -<citerefentry><refentrytitle>nix-env</refentrytitle><manvolnum>1</manvolnum></citerefentry> -manpage or the Nix manual.</para> - + </para> + + <para> + <command>nix-env</command> has many more flags. For details, see the + <citerefentry> + <refentrytitle>nix-env</refentrytitle> + <manvolnum>1</manvolnum></citerefentry> manpage or the Nix manual. + </para> </section> diff --git a/nixos/doc/manual/configuration/adding-custom-packages.xml b/nixos/doc/manual/configuration/adding-custom-packages.xml index ae58f61d73ed..b59287a622e6 100644 --- a/nixos/doc/manual/configuration/adding-custom-packages.xml +++ b/nixos/doc/manual/configuration/adding-custom-packages.xml @@ -3,43 +3,36 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-custom-packages"> + <title>Adding Custom Packages</title> -<title>Adding Custom Packages</title> - -<para>It’s possible that a package you need is not available in NixOS. -In that case, you can do two things. First, you can clone the Nixpkgs -repository, add the package to your clone, and (optionally) submit a -patch or pull request to have it accepted into the main Nixpkgs -repository. This is described in detail in the <link -xlink:href="http://nixos.org/nixpkgs/manual">Nixpkgs manual</link>. -In short, you clone Nixpkgs: - + <para> + It’s possible that a package you need is not available in NixOS. In that + case, you can do two things. First, you can clone the Nixpkgs repository, add + the package to your clone, and (optionally) submit a patch or pull request to + have it accepted into the main Nixpkgs repository. This is described in + detail in the <link +xlink:href="http://nixos.org/nixpkgs/manual">Nixpkgs + manual</link>. In short, you clone Nixpkgs: <screen> $ git clone git://github.com/NixOS/nixpkgs.git $ cd nixpkgs </screen> - -Then you write and test the package as described in the Nixpkgs -manual. Finally, you add it to -<literal>environment.systemPackages</literal>, e.g. - + Then you write and test the package as described in the Nixpkgs manual. + Finally, you add it to <literal>environment.systemPackages</literal>, e.g. <programlisting> <xref linkend="opt-environment.systemPackages"/> = [ pkgs.my-package ]; </programlisting> - -and you run <command>nixos-rebuild</command>, specifying your own -Nixpkgs tree: - + and you run <command>nixos-rebuild</command>, specifying your own Nixpkgs + tree: <screen> # nixos-rebuild switch -I nixpkgs=/path/to/my/nixpkgs</screen> + </para> -</para> - -<para>The second possibility is to add the package outside of the -Nixpkgs tree. For instance, here is how you specify a build of the -<link xlink:href="http://www.gnu.org/software/hello/">GNU Hello</link> -package directly in <filename>configuration.nix</filename>: - + <para> + The second possibility is to add the package outside of the Nixpkgs tree. For + instance, here is how you specify a build of the + <link xlink:href="http://www.gnu.org/software/hello/">GNU Hello</link> + package directly in <filename>configuration.nix</filename>: <programlisting> <xref linkend="opt-environment.systemPackages"/> = let @@ -53,13 +46,12 @@ package directly in <filename>configuration.nix</filename>: in [ my-hello ]; </programlisting> - -Of course, you can also move the definition of -<literal>my-hello</literal> into a separate Nix expression, e.g. + Of course, you can also move the definition of <literal>my-hello</literal> + into a separate Nix expression, e.g. <programlisting> <xref linkend="opt-environment.systemPackages"/> = [ (import ./my-hello.nix) ]; </programlisting> -where <filename>my-hello.nix</filename> contains: + where <filename>my-hello.nix</filename> contains: <programlisting> with import <nixpkgs> {}; # bring all of Nixpkgs into scope @@ -71,14 +63,11 @@ stdenv.mkDerivation rec { }; } </programlisting> - -This allows testing the package easily: + This allows testing the package easily: <screen> $ nix-build my-hello.nix $ ./result/bin/hello Hello, world! </screen> - -</para> - + </para> </section> diff --git a/nixos/doc/manual/configuration/config-file.xml b/nixos/doc/manual/configuration/config-file.xml index d4ca15bb3e72..a9420b3fc921 100644 --- a/nixos/doc/manual/configuration/config-file.xml +++ b/nixos/doc/manual/configuration/config-file.xml @@ -3,28 +3,25 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-configuration-file"> + <title>NixOS Configuration File</title> -<title>NixOS Configuration File</title> - -<para>The NixOS configuration file generally looks like this: - + <para> + The NixOS configuration file generally looks like this: <programlisting> { config, pkgs, ... }: { <replaceable>option definitions</replaceable> } </programlisting> - -The first line (<literal>{ config, pkgs, ... }:</literal>) denotes -that this is actually a function that takes at least the two arguments - <varname>config</varname> and <varname>pkgs</varname>. (These are -explained later.) The function returns a <emphasis>set</emphasis> of -option definitions (<literal>{ <replaceable>...</replaceable> }</literal>). These definitions have the -form <literal><replaceable>name</replaceable> = -<replaceable>value</replaceable></literal>, where -<replaceable>name</replaceable> is the name of an option and -<replaceable>value</replaceable> is its value. For example, - + The first line (<literal>{ config, pkgs, ... }:</literal>) denotes that this + is actually a function that takes at least the two arguments + <varname>config</varname> and <varname>pkgs</varname>. (These are explained + later.) The function returns a <emphasis>set</emphasis> of option definitions + (<literal>{ <replaceable>...</replaceable> }</literal>). These definitions + have the form <literal><replaceable>name</replaceable> = + <replaceable>value</replaceable></literal>, where + <replaceable>name</replaceable> is the name of an option and + <replaceable>value</replaceable> is its value. For example, <programlisting> { config, pkgs, ... }: @@ -33,19 +30,19 @@ form <literal><replaceable>name</replaceable> = <xref linkend="opt-services.httpd.documentRoot"/> = "/webroot"; } </programlisting> - -defines a configuration with three option definitions that together -enable the Apache HTTP Server with <filename>/webroot</filename> as -the document root.</para> - -<para>Sets can be nested, and in fact dots in option names are -shorthand for defining a set containing another set. For instance, -<xref linkend="opt-services.httpd.enable"/> defines a set named -<varname>services</varname> that contains a set named -<varname>httpd</varname>, which in turn contains an option definition -named <varname>enable</varname> with value <literal>true</literal>. -This means that the example above can also be written as: - + defines a configuration with three option definitions that together enable + the Apache HTTP Server with <filename>/webroot</filename> as the document + root. + </para> + + <para> + Sets can be nested, and in fact dots in option names are shorthand for + defining a set containing another set. For instance, + <xref linkend="opt-services.httpd.enable"/> defines a set named + <varname>services</varname> that contains a set named + <varname>httpd</varname>, which in turn contains an option definition named + <varname>enable</varname> with value <literal>true</literal>. This means that + the example above can also be written as: <programlisting> { config, pkgs, ... }: @@ -58,46 +55,44 @@ This means that the example above can also be written as: }; } </programlisting> - -which may be more convenient if you have lots of option definitions -that share the same prefix (such as -<literal>services.httpd</literal>).</para> - -<para>NixOS checks your option definitions for correctness. For -instance, if you try to define an option that doesn’t exist (that is, -doesn’t have a corresponding <emphasis>option declaration</emphasis>), -<command>nixos-rebuild</command> will give an error like: + which may be more convenient if you have lots of option definitions that + share the same prefix (such as <literal>services.httpd</literal>). + </para> + + <para> + NixOS checks your option definitions for correctness. For instance, if you + try to define an option that doesn’t exist (that is, doesn’t have a + corresponding <emphasis>option declaration</emphasis>), + <command>nixos-rebuild</command> will give an error like: <screen> The option `services.httpd.enable' defined in `/etc/nixos/configuration.nix' does not exist. </screen> -Likewise, values in option definitions must have a correct type. For -instance, <option>services.httpd.enable</option> must be a Boolean -(<literal>true</literal> or <literal>false</literal>). Trying to give -it a value of another type, such as a string, will cause an error: + Likewise, values in option definitions must have a correct type. For + instance, <option>services.httpd.enable</option> must be a Boolean + (<literal>true</literal> or <literal>false</literal>). Trying to give it a + value of another type, such as a string, will cause an error: <screen> The option value `services.httpd.enable' in `/etc/nixos/configuration.nix' is not a boolean. </screen> + </para> -</para> - -<para>Options have various types of values. The most important are: - -<variablelist> - <varlistentry> + <para> + Options have various types of values. The most important are: + <variablelist> + <varlistentry> <term>Strings</term> <listitem> - <para>Strings are enclosed in double quotes, e.g. - + <para> + Strings are enclosed in double quotes, e.g. <programlisting> <xref linkend="opt-networking.hostName"/> = "dexter"; </programlisting> - - Special characters can be escaped by prefixing them with a - backslash (e.g. <literal>\"</literal>).</para> - - <para>Multi-line strings can be enclosed in <emphasis>double - single quotes</emphasis>, e.g. - + Special characters can be escaped by prefixing them with a backslash + (e.g. <literal>\"</literal>). + </para> + <para> + Multi-line strings can be enclosed in <emphasis>double single + quotes</emphasis>, e.g. <programlisting> <xref linkend="opt-networking.extraHosts"/> = '' @@ -105,58 +100,52 @@ The option value `services.httpd.enable' in `/etc/nixos/configuration.nix' is no 10.0.0.1 server ''; </programlisting> - - The main difference is that it strips from each line - a number of spaces equal to the minimal indentation of - the string as a whole (disregarding the indentation of - empty lines), and that characters like - <literal>"</literal> and <literal>\</literal> are not special - (making it more convenient for including things like shell - code). - See more info about this in the Nix manual <link - xlink:href="https://nixos.org/nix/manual/#ssec-values">here</link>.</para> + The main difference is that it strips from each line a number of spaces + equal to the minimal indentation of the string as a whole (disregarding + the indentation of empty lines), and that characters like + <literal>"</literal> and <literal>\</literal> are not special (making it + more convenient for including things like shell code). See more info + about this in the Nix manual + <link + xlink:href="https://nixos.org/nix/manual/#ssec-values">here</link>. + </para> </listitem> - </varlistentry> - - <varlistentry> + </varlistentry> + <varlistentry> <term>Booleans</term> <listitem> - <para>These can be <literal>true</literal> or - <literal>false</literal>, e.g. - + <para> + These can be <literal>true</literal> or <literal>false</literal>, e.g. <programlisting> <xref linkend="opt-networking.firewall.enable"/> = true; <xref linkend="opt-networking.firewall.allowPing"/> = false; </programlisting> - </para> + </para> </listitem> - </varlistentry> - - <varlistentry> + </varlistentry> + <varlistentry> <term>Integers</term> <listitem> - <para>For example, - + <para> + For example, <programlisting> <xref linkend="opt-boot.kernel.sysctl"/>."net.ipv4.tcp_keepalive_time" = 60; </programlisting> - (Note that here the attribute name - <literal>net.ipv4.tcp_keepalive_time</literal> is enclosed in - quotes to prevent it from being interpreted as a set named - <literal>net</literal> containing a set named - <literal>ipv4</literal>, and so on. This is because it’s not a - NixOS option but the literal name of a Linux kernel - setting.)</para> + <literal>net.ipv4.tcp_keepalive_time</literal> is enclosed in quotes to + prevent it from being interpreted as a set named <literal>net</literal> + containing a set named <literal>ipv4</literal>, and so on. This is + because it’s not a NixOS option but the literal name of a Linux kernel + setting.) + </para> </listitem> - </varlistentry> - - <varlistentry> + </varlistentry> + <varlistentry> <term>Sets</term> <listitem> - <para>Sets were introduced above. They are name/value pairs - enclosed in braces, as in the option definition - + <para> + Sets were introduced above. They are name/value pairs enclosed in braces, + as in the option definition <programlisting> <xref linkend="opt-fileSystems"/>."/boot" = { device = "/dev/sda1"; @@ -164,36 +153,32 @@ The option value `services.httpd.enable' in `/etc/nixos/configuration.nix' is no options = [ "rw" "data=ordered" "relatime" ]; }; </programlisting> - </para> + </para> </listitem> - </varlistentry> - - <varlistentry> + </varlistentry> + <varlistentry> <term>Lists</term> <listitem> - <para>The important thing to note about lists is that list - elements are separated by whitespace, like this: - + <para> + The important thing to note about lists is that list elements are + separated by whitespace, like this: <programlisting> <xref linkend="opt-boot.kernelModules"/> = [ "fuse" "kvm-intel" "coretemp" ]; </programlisting> - List elements can be any other type, e.g. sets: - <programlisting> swapDevices = [ { device = "/dev/disk/by-label/swap"; } ]; </programlisting> - </para> + </para> </listitem> - </varlistentry> - - <varlistentry> + </varlistentry> + <varlistentry> <term>Packages</term> <listitem> - <para>Usually, the packages you need are already part of the Nix - Packages collection, which is a set that can be accessed through - the function argument <varname>pkgs</varname>. Typical uses: - + <para> + Usually, the packages you need are already part of the Nix Packages + collection, which is a set that can be accessed through the function + argument <varname>pkgs</varname>. Typical uses: <programlisting> <xref linkend="opt-environment.systemPackages"/> = [ pkgs.thunderbird @@ -202,16 +187,12 @@ swapDevices = [ { device = "/dev/disk/by-label/swap"; } ]; <xref linkend="opt-services.postgresql.package"/> = pkgs.postgresql90; </programlisting> - - The latter option definition changes the default PostgreSQL - package used by NixOS’s PostgreSQL service to 9.0. For more - information on packages, including how to add new ones, see - <xref linkend="sec-custom-packages"/>.</para> + The latter option definition changes the default PostgreSQL package used + by NixOS’s PostgreSQL service to 9.0. For more information on packages, + including how to add new ones, see <xref linkend="sec-custom-packages"/>. + </para> </listitem> - </varlistentry> - -</variablelist> - -</para> - + </varlistentry> + </variablelist> + </para> </section> diff --git a/nixos/doc/manual/configuration/config-syntax.xml b/nixos/doc/manual/configuration/config-syntax.xml index 87847f8451ec..5ef498cf9ae3 100644 --- a/nixos/doc/manual/configuration/config-syntax.xml +++ b/nixos/doc/manual/configuration/config-syntax.xml @@ -3,25 +3,23 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-configuration-syntax"> - -<title>Configuration Syntax</title> - -<para>The NixOS configuration file -<filename>/etc/nixos/configuration.nix</filename> is actually a -<emphasis>Nix expression</emphasis>, which is the Nix package -manager’s purely functional language for describing how to build -packages and configurations. This means you have all the expressive -power of that language at your disposal, including the ability to -abstract over common patterns, which is very useful when managing -complex systems. The syntax and semantics of the Nix language are -fully described in the <link + <title>Configuration Syntax</title> + <para> + The NixOS configuration file + <filename>/etc/nixos/configuration.nix</filename> is actually a <emphasis>Nix + expression</emphasis>, which is the Nix package manager’s purely functional + language for describing how to build packages and configurations. This means + you have all the expressive power of that language at your disposal, + including the ability to abstract over common patterns, which is very useful + when managing complex systems. The syntax and semantics of the Nix language + are fully described in the + <link xlink:href="http://nixos.org/nix/manual/#chap-writing-nix-expressions">Nix -manual</link>, but here we give a short overview of the most important -constructs useful in NixOS configuration files.</para> - -<xi:include href="config-file.xml" /> -<xi:include href="abstractions.xml" /> -<xi:include href="modularity.xml" /> -<xi:include href="summary.xml" /> - + manual</link>, but here we give a short overview of the most important + constructs useful in NixOS configuration files. + </para> + <xi:include href="config-file.xml" /> + <xi:include href="abstractions.xml" /> + <xi:include href="modularity.xml" /> + <xi:include href="summary.xml" /> </chapter> diff --git a/nixos/doc/manual/configuration/configuration.xml b/nixos/doc/manual/configuration/configuration.xml index f092c7e207ff..8d05dcd34b4d 100644 --- a/nixos/doc/manual/configuration/configuration.xml +++ b/nixos/doc/manual/configuration/configuration.xml @@ -3,30 +3,24 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="ch-configuration"> - -<title>Configuration</title> - -<partintro> - -<para>This chapter describes how to configure various aspects of a -NixOS machine through the configuration file -<filename>/etc/nixos/configuration.nix</filename>. As described in -<xref linkend="sec-changing-config" />, changes to this file only take -effect after you run <command>nixos-rebuild</command>.</para> - -</partintro> - -<xi:include href="config-syntax.xml" /> -<xi:include href="package-mgmt.xml" /> -<xi:include href="user-mgmt.xml" /> -<xi:include href="file-systems.xml" /> -<xi:include href="x-windows.xml" /> -<xi:include href="xfce.xml" /> -<xi:include href="networking.xml" /> -<xi:include href="linux-kernel.xml" /> - -<xi:include href="../generated/modules.xml" xpointer="xpointer(//section[@id='modules']/*)" /> - + <title>Configuration</title> + <partintro> + <para> + This chapter describes how to configure various aspects of a NixOS machine + through the configuration file + <filename>/etc/nixos/configuration.nix</filename>. As described in + <xref linkend="sec-changing-config" />, changes to this file only take + effect after you run <command>nixos-rebuild</command>. + </para> + </partintro> + <xi:include href="config-syntax.xml" /> + <xi:include href="package-mgmt.xml" /> + <xi:include href="user-mgmt.xml" /> + <xi:include href="file-systems.xml" /> + <xi:include href="x-windows.xml" /> + <xi:include href="xfce.xml" /> + <xi:include href="networking.xml" /> + <xi:include href="linux-kernel.xml" /> + <xi:include href="../generated/modules.xml" xpointer="xpointer(//section[@id='modules']/*)" /> <!-- Apache; libvirtd virtualisation --> - </part> diff --git a/nixos/doc/manual/configuration/customizing-packages.xml b/nixos/doc/manual/configuration/customizing-packages.xml index 8b7654e9b42e..03b5bb53197b 100644 --- a/nixos/doc/manual/configuration/customizing-packages.xml +++ b/nixos/doc/manual/configuration/customizing-packages.xml @@ -3,53 +3,50 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-customising-packages"> + <title>Customising Packages</title> -<title>Customising Packages</title> + <para> + Some packages in Nixpkgs have options to enable or disable optional + functionality or change other aspects of the package. For instance, the + Firefox wrapper package (which provides Firefox with a set of plugins such as + the Adobe Flash player) has an option to enable the Google Talk plugin. It + can be set in <filename>configuration.nix</filename> as follows: <filename> + nixpkgs.config.firefox.enableGoogleTalkPlugin = true; </filename> + </para> -<para>Some packages in Nixpkgs have options to enable or disable -optional functionality or change other aspects of the package. For -instance, the Firefox wrapper package (which provides Firefox with a -set of plugins such as the Adobe Flash player) has an option to enable -the Google Talk plugin. It can be set in -<filename>configuration.nix</filename> as follows: - -<filename> -nixpkgs.config.firefox.enableGoogleTalkPlugin = true; -</filename> -</para> - -<warning><para>Unfortunately, Nixpkgs currently lacks a way to query -available configuration options.</para></warning> - -<para>Apart from high-level options, it’s possible to tweak a package -in almost arbitrary ways, such as changing or disabling dependencies -of a package. For instance, the Emacs package in Nixpkgs by default -has a dependency on GTK+ 2. If you want to build it against GTK+ 3, -you can specify that as follows: + <warning> + <para> + Unfortunately, Nixpkgs currently lacks a way to query available + configuration options. + </para> + </warning> + <para> + Apart from high-level options, it’s possible to tweak a package in almost + arbitrary ways, such as changing or disabling dependencies of a package. For + instance, the Emacs package in Nixpkgs by default has a dependency on GTK+ 2. + If you want to build it against GTK+ 3, you can specify that as follows: <programlisting> <xref linkend="opt-environment.systemPackages"/> = [ (pkgs.emacs.override { gtk = pkgs.gtk3; }) ]; </programlisting> + The function <varname>override</varname> performs the call to the Nix + function that produces Emacs, with the original arguments amended by the set + of arguments specified by you. So here the function argument + <varname>gtk</varname> gets the value <literal>pkgs.gtk3</literal>, causing + Emacs to depend on GTK+ 3. (The parentheses are necessary because in Nix, + function application binds more weakly than list construction, so without + them, <xref linkend="opt-environment.systemPackages"/> would be a list with + two elements.) + </para> -The function <varname>override</varname> performs the call to the Nix -function that produces Emacs, with the original arguments amended by -the set of arguments specified by you. So here the function argument -<varname>gtk</varname> gets the value <literal>pkgs.gtk3</literal>, -causing Emacs to depend on GTK+ 3. (The parentheses are necessary -because in Nix, function application binds more weakly than list -construction, so without them, -<xref linkend="opt-environment.systemPackages"/> would be a list with two -elements.)</para> - -<para>Even greater customisation is possible using the function -<varname>overrideAttrs</varname>. While the -<varname>override</varname> mechanism above overrides the arguments of -a package function, <varname>overrideAttrs</varname> allows -changing the <emphasis>attributes</emphasis> passed to <literal>mkDerivation</literal>. -This permits changing any aspect of the package, such as the source code. -For instance, if you want to override the source code of Emacs, you -can say: - + <para> + Even greater customisation is possible using the function + <varname>overrideAttrs</varname>. While the <varname>override</varname> + mechanism above overrides the arguments of a package function, + <varname>overrideAttrs</varname> allows changing the + <emphasis>attributes</emphasis> passed to <literal>mkDerivation</literal>. + This permits changing any aspect of the package, such as the source code. For + instance, if you want to override the source code of Emacs, you can say: <programlisting> <xref linkend="opt-environment.systemPackages"/> = [ (pkgs.emacs.overrideAttrs (oldAttrs: { @@ -58,36 +55,32 @@ can say: })) ]; </programlisting> + Here, <varname>overrideAttrs</varname> takes the Nix derivation specified by + <varname>pkgs.emacs</varname> and produces a new derivation in which the + original’s <literal>name</literal> and <literal>src</literal> attribute + have been replaced by the given values by re-calling + <literal>stdenv.mkDerivation</literal>. The original attributes are + accessible via the function argument, which is conventionally named + <varname>oldAttrs</varname>. + </para> -Here, <varname>overrideAttrs</varname> takes the Nix derivation -specified by <varname>pkgs.emacs</varname> and produces a new -derivation in which the original’s <literal>name</literal> and -<literal>src</literal> attribute have been replaced by the given -values by re-calling <literal>stdenv.mkDerivation</literal>. -The original attributes are accessible via the function argument, -which is conventionally named <varname>oldAttrs</varname>.</para> - -<para>The overrides shown above are not global. They do not affect -the original package; other packages in Nixpkgs continue to depend on -the original rather than the customised package. This means that if -another package in your system depends on the original package, you -end up with two instances of the package. If you want to have -everything depend on your customised instance, you can apply a -<emphasis>global</emphasis> override as follows: - + <para> + The overrides shown above are not global. They do not affect the original + package; other packages in Nixpkgs continue to depend on the original rather + than the customised package. This means that if another package in your + system depends on the original package, you end up with two instances of the + package. If you want to have everything depend on your customised instance, + you can apply a <emphasis>global</emphasis> override as follows: <screen> nixpkgs.config.packageOverrides = pkgs: { emacs = pkgs.emacs.override { gtk = pkgs.gtk3; }; }; </screen> - -The effect of this definition is essentially equivalent to modifying -the <literal>emacs</literal> attribute in the Nixpkgs source tree. -Any package in Nixpkgs that depends on <literal>emacs</literal> will -be passed your customised instance. (However, the value -<literal>pkgs.emacs</literal> in -<varname>nixpkgs.config.packageOverrides</varname> refers to the -original rather than overridden instance, to prevent an infinite -recursion.)</para> - + The effect of this definition is essentially equivalent to modifying the + <literal>emacs</literal> attribute in the Nixpkgs source tree. Any package in + Nixpkgs that depends on <literal>emacs</literal> will be passed your + customised instance. (However, the value <literal>pkgs.emacs</literal> in + <varname>nixpkgs.config.packageOverrides</varname> refers to the original + rather than overridden instance, to prevent an infinite recursion.) + </para> </section> diff --git a/nixos/doc/manual/configuration/declarative-packages.xml b/nixos/doc/manual/configuration/declarative-packages.xml index 4c875e6f037f..be9884fe9dce 100644 --- a/nixos/doc/manual/configuration/declarative-packages.xml +++ b/nixos/doc/manual/configuration/declarative-packages.xml @@ -3,41 +3,41 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-declarative-package-mgmt"> - -<title>Declarative Package Management</title> - -<para>With declarative package management, you specify which packages -you want on your system by setting the option -<xref linkend="opt-environment.systemPackages"/>. For instance, adding the -following line to <filename>configuration.nix</filename> enables the -Mozilla Thunderbird email application: - + <title>Declarative Package Management</title> + + <para> + With declarative package management, you specify which packages you want on + your system by setting the option + <xref linkend="opt-environment.systemPackages"/>. For instance, adding the + following line to <filename>configuration.nix</filename> enables the Mozilla + Thunderbird email application: <programlisting> <xref linkend="opt-environment.systemPackages"/> = [ pkgs.thunderbird ]; </programlisting> + The effect of this specification is that the Thunderbird package from Nixpkgs + will be built or downloaded as part of the system when you run + <command>nixos-rebuild switch</command>. + </para> -The effect of this specification is that the Thunderbird package from -Nixpkgs will be built or downloaded as part of the system when you run -<command>nixos-rebuild switch</command>.</para> - -<para>You can get a list of the available packages as follows: + <para> + You can get a list of the available packages as follows: <screen> $ nix-env -qaP '*' --description nixos.firefox firefox-23.0 Mozilla Firefox - the browser, reloaded <replaceable>...</replaceable> </screen> + The first column in the output is the <emphasis>attribute name</emphasis>, + such as <literal>nixos.thunderbird</literal>. (The <literal>nixos</literal> + prefix allows distinguishing between different channels that you might have.) + </para> -The first column in the output is the <emphasis>attribute -name</emphasis>, such as -<literal>nixos.thunderbird</literal>. (The -<literal>nixos</literal> prefix allows distinguishing between -different channels that you might have.)</para> - -<para>To “uninstall” a package, simply remove it from -<xref linkend="opt-environment.systemPackages"/> and run -<command>nixos-rebuild switch</command>.</para> + <para> + To “uninstall” a package, simply remove it from + <xref linkend="opt-environment.systemPackages"/> and run + <command>nixos-rebuild switch</command>. + </para> -<xi:include href="customizing-packages.xml" /> -<xi:include href="adding-custom-packages.xml" /> + <xi:include href="customizing-packages.xml" /> + <xi:include href="adding-custom-packages.xml" /> </section> diff --git a/nixos/doc/manual/configuration/file-systems.xml b/nixos/doc/manual/configuration/file-systems.xml index 0ff37c38d8b0..e4c03de71b72 100644 --- a/nixos/doc/manual/configuration/file-systems.xml +++ b/nixos/doc/manual/configuration/file-systems.xml @@ -3,44 +3,44 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="ch-file-systems"> - -<title>File Systems</title> - -<para>You can define file systems using the -<option>fileSystems</option> configuration option. For instance, the -following definition causes NixOS to mount the Ext4 file system on -device <filename>/dev/disk/by-label/data</filename> onto the mount -point <filename>/data</filename>: - + <title>File Systems</title> + <para> + You can define file systems using the <option>fileSystems</option> + configuration option. For instance, the following definition causes NixOS to + mount the Ext4 file system on device + <filename>/dev/disk/by-label/data</filename> onto the mount point + <filename>/data</filename>: <programlisting> <xref linkend="opt-fileSystems"/>."/data" = { device = "/dev/disk/by-label/data"; fsType = "ext4"; }; </programlisting> - -Mount points are created automatically if they don’t already exist. -For <option><link linkend="opt-fileSystems._name__.device">device</link></option>, it’s best to use the topology-independent -device aliases in <filename>/dev/disk/by-label</filename> and -<filename>/dev/disk/by-uuid</filename>, as these don’t change if the -topology changes (e.g. if a disk is moved to another IDE -controller).</para> - -<para>You can usually omit the file system type -(<option><link linkend="opt-fileSystems._name__.fsType">fsType</link></option>), since <command>mount</command> can usually -detect the type and load the necessary kernel module automatically. -However, if the file system is needed at early boot (in the initial -ramdisk) and is not <literal>ext2</literal>, <literal>ext3</literal> -or <literal>ext4</literal>, then it’s best to specify -<option>fsType</option> to ensure that the kernel module is -available.</para> - -<note><para>System startup will fail if any of the filesystems fails to mount, -dropping you to the emergency shell. -You can make a mount asynchronous and non-critical by adding -<literal><link linkend="opt-fileSystems._name__.options">options</link> = [ "nofail" ];</literal>. -</para></note> - -<xi:include href="luks-file-systems.xml" /> - + Mount points are created automatically if they don’t already exist. For + <option><link linkend="opt-fileSystems._name__.device">device</link></option>, + it’s best to use the topology-independent device aliases in + <filename>/dev/disk/by-label</filename> and + <filename>/dev/disk/by-uuid</filename>, as these don’t change if the + topology changes (e.g. if a disk is moved to another IDE controller). + </para> + <para> + You can usually omit the file system type + (<option><link linkend="opt-fileSystems._name__.fsType">fsType</link></option>), + since <command>mount</command> can usually detect the type and load the + necessary kernel module automatically. However, if the file system is needed + at early boot (in the initial ramdisk) and is not <literal>ext2</literal>, + <literal>ext3</literal> or <literal>ext4</literal>, then it’s best to + specify <option>fsType</option> to ensure that the kernel module is + available. + </para> + <note> + <para> + System startup will fail if any of the filesystems fails to mount, dropping + you to the emergency shell. You can make a mount asynchronous and + non-critical by adding + <literal><link linkend="opt-fileSystems._name__.options">options</link> = [ + "nofail" ];</literal>. + </para> + </note> + <xi:include href="luks-file-systems.xml" /> </chapter> diff --git a/nixos/doc/manual/configuration/firewall.xml b/nixos/doc/manual/configuration/firewall.xml index ecc21a3bdf51..b66adcedce6e 100644 --- a/nixos/doc/manual/configuration/firewall.xml +++ b/nixos/doc/manual/configuration/firewall.xml @@ -3,49 +3,44 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-firewall"> + <title>Firewall</title> -<title>Firewall</title> - -<para>NixOS has a simple stateful firewall that blocks incoming -connections and other unexpected packets. The firewall applies to -both IPv4 and IPv6 traffic. It is enabled by default. It can be -disabled as follows: - + <para> + NixOS has a simple stateful firewall that blocks incoming connections and + other unexpected packets. The firewall applies to both IPv4 and IPv6 traffic. + It is enabled by default. It can be disabled as follows: <programlisting> <xref linkend="opt-networking.firewall.enable"/> = false; </programlisting> - -If the firewall is enabled, you can open specific TCP ports to the -outside world: - + If the firewall is enabled, you can open specific TCP ports to the outside + world: <programlisting> <xref linkend="opt-networking.firewall.allowedTCPPorts"/> = [ 80 443 ]; </programlisting> - -Note that TCP port 22 (ssh) is opened automatically if the SSH daemon -is enabled (<option><xref linkend="opt-services.openssh.enable"/> = true</option>). UDP -ports can be opened through -<xref linkend="opt-networking.firewall.allowedUDPPorts"/>.</para> - -<para>To open ranges of TCP ports: - + Note that TCP port 22 (ssh) is opened automatically if the SSH daemon is + enabled (<option><xref linkend="opt-services.openssh.enable"/> = + true</option>). UDP ports can be opened through + <xref linkend="opt-networking.firewall.allowedUDPPorts"/>. + </para> + + <para> + To open ranges of TCP ports: <programlisting> <xref linkend="opt-networking.firewall.allowedTCPPortRanges"/> = [ { from = 4000; to = 4007; } { from = 8000; to = 8010; } ]; </programlisting> + Similarly, UDP port ranges can be opened through + <xref linkend="opt-networking.firewall.allowedUDPPortRanges"/>. + </para> -Similarly, UDP port ranges can be opened through -<xref linkend="opt-networking.firewall.allowedUDPPortRanges"/>.</para> - -<para>Also of interest is - + <para> + Also of interest is <programlisting> <xref linkend="opt-networking.firewall.allowPing"/> = true; </programlisting> - -to allow the machine to respond to ping requests. (ICMPv6 pings are -always allowed.)</para> - + to allow the machine to respond to ping requests. (ICMPv6 pings are always + allowed.) + </para> </section> diff --git a/nixos/doc/manual/configuration/ipv4-config.xml b/nixos/doc/manual/configuration/ipv4-config.xml index fbc9695c6014..71ddf41491ba 100644 --- a/nixos/doc/manual/configuration/ipv4-config.xml +++ b/nixos/doc/manual/configuration/ipv4-config.xml @@ -3,45 +3,41 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-ipv4"> + <title>IPv4 Configuration</title> -<title>IPv4 Configuration</title> - -<para>By default, NixOS uses DHCP (specifically, -<command>dhcpcd</command>) to automatically configure network -interfaces. However, you can configure an interface manually as -follows: - + <para> + By default, NixOS uses DHCP (specifically, <command>dhcpcd</command>) to + automatically configure network interfaces. However, you can configure an + interface manually as follows: <programlisting> <link linkend="opt-networking.interfaces._name__.ipv4.addresses">networking.interfaces.eth0.ipv4.addresses</link> = [ { address = "192.168.1.2"; prefixLength = 24; } ]; </programlisting> - -Typically you’ll also want to set a default gateway and set of name -servers: - + Typically you’ll also want to set a default gateway and set of name + servers: <programlisting> <xref linkend="opt-networking.defaultGateway"/> = "192.168.1.1"; <xref linkend="opt-networking.nameservers"/> = [ "8.8.8.8" ]; </programlisting> - -</para> - -<note><para>Statically configured interfaces are set up by the systemd -service -<replaceable>interface-name</replaceable><literal>-cfg.service</literal>. -The default gateway and name server configuration is performed by -<literal>network-setup.service</literal>.</para></note> - -<para>The host name is set using <xref linkend="opt-networking.hostName"/>: - + </para> + + <note> + <para> + Statically configured interfaces are set up by the systemd service + <replaceable>interface-name</replaceable><literal>-cfg.service</literal>. + The default gateway and name server configuration is performed by + <literal>network-setup.service</literal>. + </para> + </note> + + <para> + The host name is set using <xref linkend="opt-networking.hostName"/>: <programlisting> <xref linkend="opt-networking.hostName"/> = "cartman"; </programlisting> - -The default host name is <literal>nixos</literal>. Set it to the -empty string (<literal>""</literal>) to allow the DHCP server to -provide the host name.</para> - + The default host name is <literal>nixos</literal>. Set it to the empty string + (<literal>""</literal>) to allow the DHCP server to provide the host name. + </para> </section> diff --git a/nixos/doc/manual/configuration/ipv6-config.xml b/nixos/doc/manual/configuration/ipv6-config.xml index e8960dc8930c..e9ab7cce4eb2 100644 --- a/nixos/doc/manual/configuration/ipv6-config.xml +++ b/nixos/doc/manual/configuration/ipv6-config.xml @@ -3,47 +3,48 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-ipv6"> + <title>IPv6 Configuration</title> -<title>IPv6 Configuration</title> - -<para>IPv6 is enabled by default. Stateless address autoconfiguration -is used to automatically assign IPv6 addresses to all interfaces. You -can disable IPv6 support globally by setting: - + <para> + IPv6 is enabled by default. Stateless address autoconfiguration is used to + automatically assign IPv6 addresses to all interfaces. You can disable IPv6 + support globally by setting: <programlisting> <xref linkend="opt-networking.enableIPv6"/> = false; -</programlisting></para> - -<para>You can disable IPv6 on a single interface using a normal sysctl (in this -example, we use interface <varname>eth0</varname>): +</programlisting> + </para> + <para> + You can disable IPv6 on a single interface using a normal sysctl (in this + example, we use interface <varname>eth0</varname>): <programlisting> <xref linkend="opt-boot.kernel.sysctl"/>."net.ipv6.conf.eth0.disable_ipv6" = true; </programlisting> -</para> - -<para>As with IPv4 networking interfaces are automatically configured via -DHCPv6. You can configure an interface manually: + </para> + <para> + As with IPv4 networking interfaces are automatically configured via DHCPv6. + You can configure an interface manually: <programlisting> <link linkend="opt-networking.interfaces._name__.ipv6.addresses">networking.interfaces.eth0.ipv6.addresses</link> = [ { address = "fe00:aa:bb:cc::2"; prefixLength = 64; } ]; </programlisting> -</para> - -<para>For configuring a gateway, optionally with explicitly specified interface: + </para> + <para> + For configuring a gateway, optionally with explicitly specified interface: <programlisting> <xref linkend="opt-networking.defaultGateway6"/> = { address = "fe00::1"; interface = "enp0s3"; } </programlisting> -</para> - -<para>See <xref linkend='sec-ipv4' /> for similar examples and additional information. -</para> + </para> + <para> + See <xref linkend='sec-ipv4' /> for similar examples and additional + information. + </para> </section> diff --git a/nixos/doc/manual/configuration/linux-kernel.xml b/nixos/doc/manual/configuration/linux-kernel.xml index b9325629256a..0990e9d932ba 100644 --- a/nixos/doc/manual/configuration/linux-kernel.xml +++ b/nixos/doc/manual/configuration/linux-kernel.xml @@ -3,29 +3,29 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-kernel-config"> - -<title>Linux Kernel</title> - -<para>You can override the Linux kernel and associated packages using -the option <option>boot.kernelPackages</option>. For instance, this -selects the Linux 3.10 kernel: + <title>Linux Kernel</title> + <para> + You can override the Linux kernel and associated packages using the option + <option>boot.kernelPackages</option>. For instance, this selects the Linux + 3.10 kernel: <programlisting> <xref linkend="opt-boot.kernelPackages"/> = pkgs.linuxPackages_3_10; </programlisting> -Note that this not only replaces the kernel, but also packages that -are specific to the kernel version, such as the NVIDIA video drivers. -This ensures that driver packages are consistent with the -kernel.</para> - -<para>The default Linux kernel configuration should be fine for most users. You can see the configuration of your current kernel with the following command: + Note that this not only replaces the kernel, but also packages that are + specific to the kernel version, such as the NVIDIA video drivers. This + ensures that driver packages are consistent with the kernel. + </para> + <para> + The default Linux kernel configuration should be fine for most users. You can + see the configuration of your current kernel with the following command: <programlisting> zcat /proc/config.gz </programlisting> -If you want to change the kernel configuration, you can use the -<option>packageOverrides</option> feature (see <xref -linkend="sec-customising-packages" />). For instance, to enable -support for the kernel debugger KGDB: - + If you want to change the kernel configuration, you can use the + <option>packageOverrides</option> feature (see + <xref +linkend="sec-customising-packages" />). For instance, to enable support + for the kernel debugger KGDB: <programlisting> nixpkgs.config.packageOverrides = pkgs: { linux_3_4 = pkgs.linux_3_4.override { @@ -36,47 +36,46 @@ nixpkgs.config.packageOverrides = pkgs: }; }; </programlisting> - -<varname>extraConfig</varname> takes a list of Linux kernel -configuration options, one per line. The name of the option should -not include the prefix <literal>CONFIG_</literal>. The option value -is typically <literal>y</literal>, <literal>n</literal> or -<literal>m</literal> (to build something as a kernel module).</para> - -<para>Kernel modules for hardware devices are generally loaded -automatically by <command>udev</command>. You can force a module to -be loaded via <xref linkend="opt-boot.kernelModules"/>, e.g. + <varname>extraConfig</varname> takes a list of Linux kernel configuration + options, one per line. The name of the option should not include the prefix + <literal>CONFIG_</literal>. The option value is typically + <literal>y</literal>, <literal>n</literal> or <literal>m</literal> (to build + something as a kernel module). + </para> + <para> + Kernel modules for hardware devices are generally loaded automatically by + <command>udev</command>. You can force a module to be loaded via + <xref linkend="opt-boot.kernelModules"/>, e.g. <programlisting> <xref linkend="opt-boot.kernelModules"/> = [ "fuse" "kvm-intel" "coretemp" ]; </programlisting> -If the module is required early during the boot (e.g. to mount the -root file system), you can use -<xref linkend="opt-boot.initrd.extraKernelModules"/>: + If the module is required early during the boot (e.g. to mount the root file + system), you can use <xref linkend="opt-boot.initrd.extraKernelModules"/>: <programlisting> <xref linkend="opt-boot.initrd.extraKernelModules"/> = [ "cifs" ]; </programlisting> -This causes the specified modules and their dependencies to be added -to the initial ramdisk.</para> - -<para>Kernel runtime parameters can be set through -<xref linkend="opt-boot.kernel.sysctl"/>, e.g. + This causes the specified modules and their dependencies to be added to the + initial ramdisk. + </para> + <para> + Kernel runtime parameters can be set through + <xref linkend="opt-boot.kernel.sysctl"/>, e.g. <programlisting> <xref linkend="opt-boot.kernel.sysctl"/>."net.ipv4.tcp_keepalive_time" = 120; </programlisting> -sets the kernel’s TCP keepalive time to 120 seconds. To see the -available parameters, run <command>sysctl -a</command>.</para> - -<section> + sets the kernel’s TCP keepalive time to 120 seconds. To see the available + parameters, run <command>sysctl -a</command>. + </para> + <section> <title>Developing kernel modules</title> - <para>When developing kernel modules it's often convenient to run - edit-compile-run loop as quickly as possible. - - See below snippet as an example of developing <literal>mellanox</literal> - drivers. + <para> + When developing kernel modules it's often convenient to run edit-compile-run + loop as quickly as possible. See below snippet as an example of developing + <literal>mellanox</literal> drivers. </para> - <screen><![CDATA[ +<screen><![CDATA[ $ nix-build '<nixpkgs>' -A linuxPackages.kernel.dev $ nix-shell '<nixpkgs>' -A linuxPackages.kernel $ unpackPhase @@ -84,7 +83,5 @@ $ cd linux-* $ make -C $dev/lib/modules/*/build M=$(pwd)/drivers/net/ethernet/mellanox modules # insmod ./drivers/net/ethernet/mellanox/mlx5/core/mlx5_core.ko ]]></screen> - -</section> - + </section> </chapter> diff --git a/nixos/doc/manual/configuration/luks-file-systems.xml b/nixos/doc/manual/configuration/luks-file-systems.xml index 6c2b4cc60b5b..8a2b107e0ee8 100644 --- a/nixos/doc/manual/configuration/luks-file-systems.xml +++ b/nixos/doc/manual/configuration/luks-file-systems.xml @@ -3,14 +3,13 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-luks-file-systems"> + <title>LUKS-Encrypted File Systems</title> -<title>LUKS-Encrypted File Systems</title> - -<para>NixOS supports file systems that are encrypted using -<emphasis>LUKS</emphasis> (Linux Unified Key Setup). For example, -here is how you create an encrypted Ext4 file system on the device -<filename>/dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d</filename>: - + <para> + NixOS supports file systems that are encrypted using + <emphasis>LUKS</emphasis> (Linux Unified Key Setup). For example, here is how + you create an encrypted Ext4 file system on the device + <filename>/dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d</filename>: <screen> # cryptsetup luksFormat /dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d @@ -27,20 +26,15 @@ Enter passphrase for /dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d: *** # mkfs.ext4 /dev/mapper/crypted </screen> - -To ensure that this file system is automatically mounted at boot time -as <filename>/</filename>, add the following to -<filename>configuration.nix</filename>: - + To ensure that this file system is automatically mounted at boot time as + <filename>/</filename>, add the following to + <filename>configuration.nix</filename>: <programlisting> <link linkend="opt-boot.initrd.luks.devices._name__.device">boot.initrd.luks.devices.crypted.device</link> = "/dev/disk/by-uuid/3f6b0024-3a44-4fde-a43a-767b872abe5d"; <xref linkend="opt-fileSystems"/>."/".device = "/dev/mapper/crypted"; </programlisting> - -Should grub be used as bootloader, and <filename>/boot</filename> is located -on an encrypted partition, it is necessary to add the following grub option: + Should grub be used as bootloader, and <filename>/boot</filename> is located + on an encrypted partition, it is necessary to add the following grub option: <programlisting><xref linkend="opt-boot.loader.grub.enableCryptodisk"/> = true;</programlisting> - -</para> - + </para> </section> diff --git a/nixos/doc/manual/configuration/modularity.xml b/nixos/doc/manual/configuration/modularity.xml index 2f76459a24e9..3ff96f719ec5 100644 --- a/nixos/doc/manual/configuration/modularity.xml +++ b/nixos/doc/manual/configuration/modularity.xml @@ -3,21 +3,21 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-modularity"> - -<title>Modularity</title> - -<para>The NixOS configuration mechanism is modular. If your -<filename>configuration.nix</filename> becomes too big, you can split -it into multiple files. Likewise, if you have multiple NixOS -configurations (e.g. for different computers) with some commonality, -you can move the common configuration into a shared file.</para> - -<para>Modules have exactly the same syntax as -<filename>configuration.nix</filename>. In fact, -<filename>configuration.nix</filename> is itself a module. You can -use other modules by including them from -<filename>configuration.nix</filename>, e.g.: - + <title>Modularity</title> + + <para> + The NixOS configuration mechanism is modular. If your + <filename>configuration.nix</filename> becomes too big, you can split it into + multiple files. Likewise, if you have multiple NixOS configurations (e.g. for + different computers) with some commonality, you can move the common + configuration into a shared file. + </para> + + <para> + Modules have exactly the same syntax as + <filename>configuration.nix</filename>. In fact, + <filename>configuration.nix</filename> is itself a module. You can use other + modules by including them from <filename>configuration.nix</filename>, e.g.: <programlisting> { config, pkgs, ... }: @@ -27,11 +27,9 @@ use other modules by including them from <replaceable>...</replaceable> } </programlisting> - -Here, we include two modules from the same directory, -<filename>vpn.nix</filename> and <filename>kde.nix</filename>. The -latter might look like this: - + Here, we include two modules from the same directory, + <filename>vpn.nix</filename> and <filename>kde.nix</filename>. The latter + might look like this: <programlisting> { config, pkgs, ... }: @@ -40,59 +38,55 @@ latter might look like this: <xref linkend="opt-services.xserver.desktopManager.plasma5.enable"/> = true; } </programlisting> - -Note that both <filename>configuration.nix</filename> and -<filename>kde.nix</filename> define the option -<xref linkend="opt-environment.systemPackages"/>. When multiple modules -define an option, NixOS will try to <emphasis>merge</emphasis> the -definitions. In the case of -<xref linkend="opt-environment.systemPackages"/>, that’s easy: the lists of -packages can simply be concatenated. The value in -<filename>configuration.nix</filename> is merged last, so for -list-type options, it will appear at the end of the merged list. If -you want it to appear first, you can use <varname>mkBefore</varname>: - + Note that both <filename>configuration.nix</filename> and + <filename>kde.nix</filename> define the option + <xref linkend="opt-environment.systemPackages"/>. When multiple modules + define an option, NixOS will try to <emphasis>merge</emphasis> the + definitions. In the case of <xref linkend="opt-environment.systemPackages"/>, + that’s easy: the lists of packages can simply be concatenated. The value in + <filename>configuration.nix</filename> is merged last, so for list-type + options, it will appear at the end of the merged list. If you want it to + appear first, you can use <varname>mkBefore</varname>: <programlisting> <xref linkend="opt-boot.kernelModules"/> = mkBefore [ "kvm-intel" ]; </programlisting> - -This causes the <literal>kvm-intel</literal> kernel module to be -loaded before any other kernel modules.</para> - -<para>For other types of options, a merge may not be possible. For -instance, if two modules define -<xref linkend="opt-services.httpd.adminAddr"/>, -<command>nixos-rebuild</command> will give an error: - + This causes the <literal>kvm-intel</literal> kernel module to be loaded + before any other kernel modules. + </para> + + <para> + For other types of options, a merge may not be possible. For instance, if two + modules define <xref linkend="opt-services.httpd.adminAddr"/>, + <command>nixos-rebuild</command> will give an error: <screen> The unique option `services.httpd.adminAddr' is defined multiple times, in `/etc/nixos/httpd.nix' and `/etc/nixos/configuration.nix'. </screen> - -When that happens, it’s possible to force one definition take -precedence over the others: - + When that happens, it’s possible to force one definition take precedence + over the others: <programlisting> <xref linkend="opt-services.httpd.adminAddr"/> = pkgs.lib.mkForce "bob@example.org"; </programlisting> - -</para> - -<para>When using multiple modules, you may need to access -configuration values defined in other modules. This is what the -<varname>config</varname> function argument is for: it contains the -complete, merged system configuration. That is, -<varname>config</varname> is the result of combining the -configurations returned by every module<footnote><para>If you’re -wondering how it’s possible that the (indirect) -<emphasis>result</emphasis> of a function is passed as an -<emphasis>input</emphasis> to that same function: that’s because Nix -is a “lazy” language — it only computes values when they are needed. -This works as long as no individual configuration value depends on -itself.</para></footnote>. For example, here is a module that adds -some packages to <xref linkend="opt-environment.systemPackages"/> only if -<xref linkend="opt-services.xserver.enable"/> is set to -<literal>true</literal> somewhere else: - + </para> + + <para> + When using multiple modules, you may need to access configuration values + defined in other modules. This is what the <varname>config</varname> function + argument is for: it contains the complete, merged system configuration. That + is, <varname>config</varname> is the result of combining the configurations + returned by every module + <footnote> + <para> + If you’re wondering how it’s possible that the (indirect) + <emphasis>result</emphasis> of a function is passed as an + <emphasis>input</emphasis> to that same function: that’s because Nix is a + “lazy” language — it only computes values when they are needed. This + works as long as no individual configuration value depends on itself. + </para> + </footnote> + . For example, here is a module that adds some packages to + <xref linkend="opt-environment.systemPackages"/> only if + <xref linkend="opt-services.xserver.enable"/> is set to + <literal>true</literal> somewhere else: <programlisting> { config, pkgs, ... }: @@ -105,13 +99,12 @@ some packages to <xref linkend="opt-environment.systemPackages"/> only if [ ]; } </programlisting> + </para> -</para> - -<para>With multiple modules, it may not be obvious what the final -value of a configuration option is. The command -<option>nixos-option</option> allows you to find out: - + <para> + With multiple modules, it may not be obvious what the final value of a + configuration option is. The command <option>nixos-option</option> allows you + to find out: <screen> $ nixos-option <xref linkend="opt-services.xserver.enable"/> true @@ -119,14 +112,11 @@ true $ nixos-option <xref linkend="opt-boot.kernelModules"/> [ "tun" "ipv6" "loop" <replaceable>...</replaceable> ] </screen> - -Interactive exploration of the configuration is possible using -<command + Interactive exploration of the configuration is possible using + <command xlink:href="https://github.com/edolstra/nix-repl">nix-repl</command>, -a read-eval-print loop for Nix expressions. It’s not installed by -default; run <literal>nix-env -i nix-repl</literal> to get it. A -typical use: - + a read-eval-print loop for Nix expressions. It’s not installed by default; + run <literal>nix-env -i nix-repl</literal> to get it. A typical use: <screen> $ nix-repl '<nixpkgs/nixos>' @@ -136,7 +126,5 @@ nix-repl> config.<xref linkend="opt-networking.hostName"/> nix-repl> map (x: x.hostName) config.<xref linkend="opt-services.httpd.virtualHosts"/> [ "example.org" "example.gov" ] </screen> - -</para> - + </para> </section> diff --git a/nixos/doc/manual/configuration/network-manager.xml b/nixos/doc/manual/configuration/network-manager.xml index bbbee3a52ed5..e217a99148b9 100644 --- a/nixos/doc/manual/configuration/network-manager.xml +++ b/nixos/doc/manual/configuration/network-manager.xml @@ -3,39 +3,42 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-networkmanager"> + <title>NetworkManager</title> -<title>NetworkManager</title> - -<para>To facilitate network configuration, some desktop environments -use NetworkManager. You can enable NetworkManager by setting: - + <para> + To facilitate network configuration, some desktop environments use + NetworkManager. You can enable NetworkManager by setting: <programlisting> <xref linkend="opt-networking.networkmanager.enable"/> = true; </programlisting> + some desktop managers (e.g., GNOME) enable NetworkManager automatically for + you. + </para> -some desktop managers (e.g., GNOME) enable NetworkManager -automatically for you.</para> - -<para>All users that should have permission to change network settings must -belong to the <code>networkmanager</code> group: - + <para> + All users that should have permission to change network settings must belong + to the <code>networkmanager</code> group: <programlisting> <link linkend="opt-users.users._name__.extraGroups">users.extraUsers.youruser.extraGroups</link> = [ "networkmanager" ]; </programlisting> -</para> - -<para>NetworkManager is controlled using either <command>nmcli</command> or -<command>nmtui</command> (curses-based terminal user interface). See their -manual pages for details on their usage. Some desktop environments (GNOME, KDE) -have their own configuration tools for NetworkManager. On XFCE, there is no -configuration tool for NetworkManager by default: by adding -<code>networkmanagerapplet</code> to the list of system packages, the graphical -applet will be installed and will launch automatically when XFCE is starting -(and will show in the status tray).</para> - -<note><para><code>networking.networkmanager</code> and -<code>networking.wireless</code> (WPA Supplicant) cannot be enabled at the same -time: you can still connect to the wireless networks using -NetworkManager.</para></note> - + </para> + + <para> + NetworkManager is controlled using either <command>nmcli</command> or + <command>nmtui</command> (curses-based terminal user interface). See their + manual pages for details on their usage. Some desktop environments (GNOME, + KDE) have their own configuration tools for NetworkManager. On XFCE, there is + no configuration tool for NetworkManager by default: by adding + <code>networkmanagerapplet</code> to the list of system packages, the + graphical applet will be installed and will launch automatically when XFCE is + starting (and will show in the status tray). + </para> + + <note> + <para> + <code>networking.networkmanager</code> and <code>networking.wireless</code> + (WPA Supplicant) cannot be enabled at the same time: you can still connect + to the wireless networks using NetworkManager. + </para> + </note> </section> diff --git a/nixos/doc/manual/configuration/networking.xml b/nixos/doc/manual/configuration/networking.xml index 5f08bc1f1275..02cf811e0bd3 100644 --- a/nixos/doc/manual/configuration/networking.xml +++ b/nixos/doc/manual/configuration/networking.xml @@ -3,20 +3,17 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-networking"> - -<title>Networking</title> - -<para>This section describes how to configure networking components on -your NixOS machine.</para> - -<xi:include href="network-manager.xml" /> -<xi:include href="ssh.xml" /> -<xi:include href="ipv4-config.xml" /> -<xi:include href="ipv6-config.xml" /> -<xi:include href="firewall.xml" /> -<xi:include href="wireless.xml" /> -<xi:include href="ad-hoc-network-config.xml" /> - + <title>Networking</title> + <para> + This section describes how to configure networking components on your NixOS + machine. + </para> + <xi:include href="network-manager.xml" /> + <xi:include href="ssh.xml" /> + <xi:include href="ipv4-config.xml" /> + <xi:include href="ipv6-config.xml" /> + <xi:include href="firewall.xml" /> + <xi:include href="wireless.xml" /> + <xi:include href="ad-hoc-network-config.xml" /> <!-- TODO: OpenVPN, NAT --> - </chapter> diff --git a/nixos/doc/manual/configuration/package-mgmt.xml b/nixos/doc/manual/configuration/package-mgmt.xml index 73c1722da02c..e8ac5d0681a9 100644 --- a/nixos/doc/manual/configuration/package-mgmt.xml +++ b/nixos/doc/manual/configuration/package-mgmt.xml @@ -3,32 +3,29 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-package-management"> - -<title>Package Management</title> - -<para>This section describes how to add additional packages to your -system. NixOS has two distinct styles of package management: - -<itemizedlist> - - <listitem><para><emphasis>Declarative</emphasis>, where you declare - what packages you want in your - <filename>configuration.nix</filename>. Every time you run - <command>nixos-rebuild</command>, NixOS will ensure that you get a - consistent set of binaries corresponding to your - specification.</para></listitem> - - <listitem><para><emphasis>Ad hoc</emphasis>, where you install, - upgrade and uninstall packages via the <command>nix-env</command> - command. This style allows mixing packages from different Nixpkgs - versions. It’s the only choice for non-root - users.</para></listitem> - -</itemizedlist> - -</para> - -<xi:include href="declarative-packages.xml" /> -<xi:include href="ad-hoc-packages.xml" /> - + <title>Package Management</title> + <para> + This section describes how to add additional packages to your system. NixOS + has two distinct styles of package management: + <itemizedlist> + <listitem> + <para> + <emphasis>Declarative</emphasis>, where you declare what packages you want + in your <filename>configuration.nix</filename>. Every time you run + <command>nixos-rebuild</command>, NixOS will ensure that you get a + consistent set of binaries corresponding to your specification. + </para> + </listitem> + <listitem> + <para> + <emphasis>Ad hoc</emphasis>, where you install, upgrade and uninstall + packages via the <command>nix-env</command> command. This style allows + mixing packages from different Nixpkgs versions. It’s the only choice + for non-root users. + </para> + </listitem> + </itemizedlist> + </para> + <xi:include href="declarative-packages.xml" /> + <xi:include href="ad-hoc-packages.xml" /> </chapter> diff --git a/nixos/doc/manual/configuration/ssh.xml b/nixos/doc/manual/configuration/ssh.xml index 7dbe598cffe2..6e883e3fbbc1 100644 --- a/nixos/doc/manual/configuration/ssh.xml +++ b/nixos/doc/manual/configuration/ssh.xml @@ -3,30 +3,25 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-ssh"> + <title>Secure Shell Access</title> -<title>Secure Shell Access</title> - -<para>Secure shell (SSH) access to your machine can be enabled by -setting: - + <para> + Secure shell (SSH) access to your machine can be enabled by setting: <programlisting> <xref linkend="opt-services.openssh.enable"/> = true; </programlisting> - -By default, root logins using a password are disallowed. They can be -disabled entirely by setting -<xref linkend="opt-services.openssh.permitRootLogin"/> to -<literal>"no"</literal>.</para> - -<para>You can declaratively specify authorised RSA/DSA public keys for -a user as follows: - + By default, root logins using a password are disallowed. They can be disabled + entirely by setting <xref linkend="opt-services.openssh.permitRootLogin"/> to + <literal>"no"</literal>. + </para> + + <para> + You can declaratively specify authorised RSA/DSA public keys for a user as + follows: <!-- FIXME: this might not work if the user is unmanaged. --> <programlisting> <link linkend="opt-users.users._name__.openssh.authorizedKeys.keys">users.extraUsers.alice.openssh.authorizedKeys.keys</link> = [ "ssh-dss AAAAB3NzaC1kc3MAAACBAPIkGWVEt4..." ]; </programlisting> - -</para> - + </para> </section> diff --git a/nixos/doc/manual/configuration/summary.xml b/nixos/doc/manual/configuration/summary.xml index 38032c5d9dc3..ea980254a8fc 100644 --- a/nixos/doc/manual/configuration/summary.xml +++ b/nixos/doc/manual/configuration/summary.xml @@ -3,190 +3,225 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-nix-syntax-summary"> + <title>Syntax Summary</title> -<title>Syntax Summary</title> - -<para>Below is a summary of the most important syntactic constructs in -the Nix expression language. It’s not complete. In particular, there -are many other built-in functions. See the <link + <para> + Below is a summary of the most important syntactic constructs in the Nix + expression language. It’s not complete. In particular, there are many other + built-in functions. See the + <link xlink:href="http://nixos.org/nix/manual/#chap-writing-nix-expressions">Nix -manual</link> for the rest.</para> + manual</link> for the rest. + </para> -<informaltable frame='none'> + <informaltable frame='none'> <tgroup cols='2'> - <colspec colname='c1' rowsep='1' colsep='1' /> - <colspec colname='c2' rowsep='1' /> - <thead> - <row> - <entry>Example</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - - <row> - <entry namest="c1" nameend="c2"><emphasis>Basic values</emphasis></entry> - </row> - <row> - <entry><literal>"Hello world"</literal></entry> - <entry>A string</entry> - </row> - <row> - <entry><literal>"${pkgs.bash}/bin/sh"</literal></entry> - <entry>A string containing an expression (expands to <literal>"/nix/store/<replaceable>hash</replaceable>-bash-<replaceable>version</replaceable>/bin/sh"</literal>)</entry> - </row> - <row> - <entry><literal>true</literal>, <literal>false</literal></entry> - <entry>Booleans</entry> - </row> - <row> - <entry><literal>123</literal></entry> - <entry>An integer</entry> - </row> - <row> - <entry><literal>./foo.png</literal></entry> - <entry>A path (relative to the containing Nix expression)</entry> - </row> - - <row> - <entry namest="c1" nameend="c2"><emphasis>Compound values</emphasis></entry> - </row> - <row> - <entry><literal>{ x = 1; y = 2; }</literal></entry> - <entry>A set with attributes named <literal>x</literal> and <literal>y</literal></entry> - </row> - <row> - <entry><literal>{ foo.bar = 1; }</literal></entry> - <entry>A nested set, equivalent to <literal>{ foo = { bar = 1; }; }</literal></entry> - </row> - <row> - <entry><literal>rec { x = "foo"; y = x + "bar"; }</literal></entry> - <entry>A recursive set, equivalent to <literal>{ x = "foo"; y = "foobar"; }</literal></entry> - </row> - <row> - <entry><literal>[ "foo" "bar" ]</literal></entry> - <entry>A list with two elements</entry> - </row> - - <row> - <entry namest="c1" nameend="c2"><emphasis>Operators</emphasis></entry> - </row> - <row> - <entry><literal>"foo" + "bar"</literal></entry> - <entry>String concatenation</entry> - </row> - <row> - <entry><literal>1 + 2</literal></entry> - <entry>Integer addition</entry> - </row> - <row> - <entry><literal>"foo" == "f" + "oo"</literal></entry> - <entry>Equality test (evaluates to <literal>true</literal>)</entry> - </row> - <row> - <entry><literal>"foo" != "bar"</literal></entry> - <entry>Inequality test (evaluates to <literal>true</literal>)</entry> - </row> - <row> - <entry><literal>!true</literal></entry> - <entry>Boolean negation</entry> - </row> - <row> - <entry><literal>{ x = 1; y = 2; }.x</literal></entry> - <entry>Attribute selection (evaluates to <literal>1</literal>)</entry> - </row> - <row> - <entry><literal>{ x = 1; y = 2; }.z or 3</literal></entry> - <entry>Attribute selection with default (evaluates to <literal>3</literal>)</entry> - </row> - <row> - <entry><literal>{ x = 1; y = 2; } // { z = 3; }</literal></entry> - <entry>Merge two sets (attributes in the right-hand set taking precedence)</entry> - </row> - - <row> - <entry namest="c1" nameend="c2"><emphasis>Control structures</emphasis></entry> - </row> - <row> - <entry><literal>if 1 + 1 == 2 then "yes!" else "no!"</literal></entry> - <entry>Conditional expression</entry> - </row> - <row> - <entry><literal>assert 1 + 1 == 2; "yes!"</literal></entry> - <entry>Assertion check (evaluates to <literal>"yes!"</literal>). See <xref + <colspec colname='c1' rowsep='1' colsep='1' /> + <colspec colname='c2' rowsep='1' /> + <thead> + <row> + <entry>Example</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry namest="c1" nameend="c2"><emphasis>Basic values</emphasis> + </entry> + </row> + <row> + <entry><literal>"Hello world"</literal> + </entry> + <entry>A string</entry> + </row> + <row> + <entry><literal>"${pkgs.bash}/bin/sh"</literal> + </entry> + <entry>A string containing an expression (expands to <literal>"/nix/store/<replaceable>hash</replaceable>-bash-<replaceable>version</replaceable>/bin/sh"</literal>)</entry> + </row> + <row> + <entry><literal>true</literal>, <literal>false</literal> + </entry> + <entry>Booleans</entry> + </row> + <row> + <entry><literal>123</literal> + </entry> + <entry>An integer</entry> + </row> + <row> + <entry><literal>./foo.png</literal> + </entry> + <entry>A path (relative to the containing Nix expression)</entry> + </row> + <row> + <entry namest="c1" nameend="c2"><emphasis>Compound values</emphasis> + </entry> + </row> + <row> + <entry><literal>{ x = 1; y = 2; }</literal> + </entry> + <entry>A set with attributes named <literal>x</literal> and <literal>y</literal> + </entry> + </row> + <row> + <entry><literal>{ foo.bar = 1; }</literal> + </entry> + <entry>A nested set, equivalent to <literal>{ foo = { bar = 1; }; }</literal> + </entry> + </row> + <row> + <entry><literal>rec { x = "foo"; y = x + "bar"; }</literal> + </entry> + <entry>A recursive set, equivalent to <literal>{ x = "foo"; y = "foobar"; }</literal> + </entry> + </row> + <row> + <entry><literal>[ "foo" "bar" ]</literal> + </entry> + <entry>A list with two elements</entry> + </row> + <row> + <entry namest="c1" nameend="c2"><emphasis>Operators</emphasis> + </entry> + </row> + <row> + <entry><literal>"foo" + "bar"</literal> + </entry> + <entry>String concatenation</entry> + </row> + <row> + <entry><literal>1 + 2</literal> + </entry> + <entry>Integer addition</entry> + </row> + <row> + <entry><literal>"foo" == "f" + "oo"</literal> + </entry> + <entry>Equality test (evaluates to <literal>true</literal>)</entry> + </row> + <row> + <entry><literal>"foo" != "bar"</literal> + </entry> + <entry>Inequality test (evaluates to <literal>true</literal>)</entry> + </row> + <row> + <entry><literal>!true</literal> + </entry> + <entry>Boolean negation</entry> + </row> + <row> + <entry><literal>{ x = 1; y = 2; }.x</literal> + </entry> + <entry>Attribute selection (evaluates to <literal>1</literal>)</entry> + </row> + <row> + <entry><literal>{ x = 1; y = 2; }.z or 3</literal> + </entry> + <entry>Attribute selection with default (evaluates to <literal>3</literal>)</entry> + </row> + <row> + <entry><literal>{ x = 1; y = 2; } // { z = 3; }</literal> + </entry> + <entry>Merge two sets (attributes in the right-hand set taking precedence)</entry> + </row> + <row> + <entry namest="c1" nameend="c2"><emphasis>Control structures</emphasis> + </entry> + </row> + <row> + <entry><literal>if 1 + 1 == 2 then "yes!" else "no!"</literal> + </entry> + <entry>Conditional expression</entry> + </row> + <row> + <entry><literal>assert 1 + 1 == 2; "yes!"</literal> + </entry> + <entry>Assertion check (evaluates to <literal>"yes!"</literal>). See <xref linkend="sec-assertions"/> for using assertions in modules</entry> - </row> - <row> - <entry><literal>let x = "foo"; y = "bar"; in x + y</literal></entry> - <entry>Variable definition</entry> - </row> - <row> - <entry><literal>with pkgs.lib; head [ 1 2 3 ]</literal></entry> - <entry>Add all attributes from the given set to the scope + </row> + <row> + <entry><literal>let x = "foo"; y = "bar"; in x + y</literal> + </entry> + <entry>Variable definition</entry> + </row> + <row> + <entry><literal>with pkgs.lib; head [ 1 2 3 ]</literal> + </entry> + <entry>Add all attributes from the given set to the scope (evaluates to <literal>1</literal>)</entry> - </row> - - <row> - <entry namest="c1" nameend="c2"><emphasis>Functions (lambdas)</emphasis></entry> - </row> - <row> - <entry><literal>x: x + 1</literal></entry> - <entry>A function that expects an integer and returns it increased by 1</entry> - </row> - <row> - <entry><literal>(x: x + 1) 100</literal></entry> - <entry>A function call (evaluates to 101)</entry> - </row> - <row> - <entry><literal>let inc = x: x + 1; in inc (inc (inc 100))</literal></entry> - <entry>A function bound to a variable and subsequently called by name (evaluates to 103)</entry> - </row> - <row> - <entry><literal>{ x, y }: x + y</literal></entry> - <entry>A function that expects a set with required attributes + </row> + <row> + <entry namest="c1" nameend="c2"><emphasis>Functions (lambdas)</emphasis> + </entry> + </row> + <row> + <entry><literal>x: x + 1</literal> + </entry> + <entry>A function that expects an integer and returns it increased by 1</entry> + </row> + <row> + <entry><literal>(x: x + 1) 100</literal> + </entry> + <entry>A function call (evaluates to 101)</entry> + </row> + <row> + <entry><literal>let inc = x: x + 1; in inc (inc (inc 100))</literal> + </entry> + <entry>A function bound to a variable and subsequently called by name (evaluates to 103)</entry> + </row> + <row> + <entry><literal>{ x, y }: x + y</literal> + </entry> + <entry>A function that expects a set with required attributes <literal>x</literal> and <literal>y</literal> and concatenates them</entry> - </row> - <row> - <entry><literal>{ x, y ? "bar" }: x + y</literal></entry> - <entry>A function that expects a set with required attribute + </row> + <row> + <entry><literal>{ x, y ? "bar" }: x + y</literal> + </entry> + <entry>A function that expects a set with required attribute <literal>x</literal> and optional <literal>y</literal>, using <literal>"bar"</literal> as default value for - <literal>y</literal></entry> - </row> - <row> - <entry><literal>{ x, y, ... }: x + y</literal></entry> - <entry>A function that expects a set with required attributes + <literal>y</literal> + </entry> + </row> + <row> + <entry><literal>{ x, y, ... }: x + y</literal> + </entry> + <entry>A function that expects a set with required attributes <literal>x</literal> and <literal>y</literal> and ignores any other attributes</entry> - </row> - <row> - <entry><literal>{ x, y } @ args: x + y</literal></entry> - <entry>A function that expects a set with required attributes + </row> + <row> + <entry><literal>{ x, y } @ args: x + y</literal> + </entry> + <entry>A function that expects a set with required attributes <literal>x</literal> and <literal>y</literal>, and binds the - whole set to <literal>args</literal></entry> - </row> - - <row> - <entry namest="c1" nameend="c2"><emphasis>Built-in functions</emphasis></entry> - </row> - <row> - <entry><literal>import ./foo.nix</literal></entry> - <entry>Load and return Nix expression in given file</entry> - </row> - <row> - <entry><literal>map (x: x + x) [ 1 2 3 ]</literal></entry> - <entry>Apply a function to every element of a list (evaluates to <literal>[ 2 4 6 ]</literal>)</entry> - </row> - <!-- + whole set to <literal>args</literal> + </entry> + </row> + <row> + <entry namest="c1" nameend="c2"><emphasis>Built-in functions</emphasis> + </entry> + </row> + <row> + <entry><literal>import ./foo.nix</literal> + </entry> + <entry>Load and return Nix expression in given file</entry> + </row> + <row> + <entry><literal>map (x: x + x) [ 1 2 3 ]</literal> + </entry> + <entry>Apply a function to every element of a list (evaluates to <literal>[ 2 4 6 ]</literal>)</entry> + </row> +<!-- <row> <entry><literal>throw "Urgh"</literal></entry> <entry>Raise an error condition</entry> </row> --> - - </tbody> + </tbody> </tgroup> -</informaltable> - + </informaltable> </section> diff --git a/nixos/doc/manual/configuration/user-mgmt.xml b/nixos/doc/manual/configuration/user-mgmt.xml index 1456a5894119..66c1c6eb3a11 100644 --- a/nixos/doc/manual/configuration/user-mgmt.xml +++ b/nixos/doc/manual/configuration/user-mgmt.xml @@ -3,14 +3,12 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-user-management"> - -<title>User Management</title> - -<para>NixOS supports both declarative and imperative styles of user -management. In the declarative style, users are specified in -<filename>configuration.nix</filename>. For instance, the following -states that a user account named <literal>alice</literal> shall exist: - + <title>User Management</title> + <para> + NixOS supports both declarative and imperative styles of user management. In + the declarative style, users are specified in + <filename>configuration.nix</filename>. For instance, the following states + that a user account named <literal>alice</literal> shall exist: <programlisting> <xref linkend="opt-users.users"/>.alice = { <link linkend="opt-users.users._name__.isNormalUser">isNormalUser</link> = true; @@ -20,81 +18,71 @@ states that a user account named <literal>alice</literal> shall exist: <link linkend="opt-users.users._name__.openssh.authorizedKeys.keys">openssh.authorizedKeys.keys</link> = [ "ssh-dss AAAAB3Nza... alice@foobar" ]; }; </programlisting> - -Note that <literal>alice</literal> is a member of the -<literal>wheel</literal> and <literal>networkmanager</literal> groups, -which allows her to use <command>sudo</command> to execute commands as -<literal>root</literal> and to configure the network, respectively. -Also note the SSH public key that allows remote logins with the -corresponding private key. Users created in this way do not have a -password by default, so they cannot log in via mechanisms that require -a password. However, you can use the <command>passwd</command> program -to set a password, which is retained across invocations of -<command>nixos-rebuild</command>.</para> - -<para>If you set <xref linkend="opt-users.mutableUsers"/> to false, then the contents of -<literal>/etc/passwd</literal> and <literal>/etc/group</literal> will be congruent to -your NixOS configuration. For instance, if you remove a user from <xref linkend="opt-users.users"/> -and run nixos-rebuild, the user account will cease to exist. Also, imperative commands for managing users -and groups, such as useradd, are no longer available. Passwords may still be -assigned by setting the user's <link linkend="opt-users.users._name__.hashedPassword">hashedPassword</link> -option. A hashed password can be generated using <command>mkpasswd -m sha-512</command> -after installing the <literal>mkpasswd</literal> package.</para> - -<para>A user ID (uid) is assigned automatically. You can also specify -a uid manually by adding - + Note that <literal>alice</literal> is a member of the + <literal>wheel</literal> and <literal>networkmanager</literal> groups, which + allows her to use <command>sudo</command> to execute commands as + <literal>root</literal> and to configure the network, respectively. Also note + the SSH public key that allows remote logins with the corresponding private + key. Users created in this way do not have a password by default, so they + cannot log in via mechanisms that require a password. However, you can use + the <command>passwd</command> program to set a password, which is retained + across invocations of <command>nixos-rebuild</command>. + </para> + <para> + If you set <xref linkend="opt-users.mutableUsers"/> to false, then the + contents of <literal>/etc/passwd</literal> and <literal>/etc/group</literal> + will be congruent to your NixOS configuration. For instance, if you remove a + user from <xref linkend="opt-users.users"/> and run nixos-rebuild, the user + account will cease to exist. Also, imperative commands for managing users and + groups, such as useradd, are no longer available. Passwords may still be + assigned by setting the user's + <link linkend="opt-users.users._name__.hashedPassword">hashedPassword</link> + option. A hashed password can be generated using <command>mkpasswd -m + sha-512</command> after installing the <literal>mkpasswd</literal> package. + </para> + <para> + A user ID (uid) is assigned automatically. You can also specify a uid + manually by adding <programlisting> uid = 1000; </programlisting> - -to the user specification.</para> - -<para>Groups can be specified similarly. The following states that a -group named <literal>students</literal> shall exist: - + to the user specification. + </para> + <para> + Groups can be specified similarly. The following states that a group named + <literal>students</literal> shall exist: <programlisting> <xref linkend="opt-users.groups"/>.students.gid = 1000; </programlisting> - -As with users, the group ID (gid) is optional and will be assigned -automatically if it’s missing.</para> - -<para>In the imperative style, users and groups are managed by -commands such as <command>useradd</command>, -<command>groupmod</command> and so on. For instance, to create a user -account named <literal>alice</literal>: - + As with users, the group ID (gid) is optional and will be assigned + automatically if it’s missing. + </para> + <para> + In the imperative style, users and groups are managed by commands such as + <command>useradd</command>, <command>groupmod</command> and so on. For + instance, to create a user account named <literal>alice</literal>: <screen> # useradd -m alice</screen> - -To make all nix tools available to this new user use `su - USER` which -opens a login shell (==shell that loads the profile) for given user. -This will create the ~/.nix-defexpr symlink. So run: - + To make all nix tools available to this new user use `su - USER` which opens + a login shell (==shell that loads the profile) for given user. This will + create the ~/.nix-defexpr symlink. So run: <screen> # su - alice -c "true"</screen> - - -The flag <option>-m</option> causes the creation of a home directory -for the new user, which is generally what you want. The user does not -have an initial password and therefore cannot log in. A password can -be set using the <command>passwd</command> utility: - + The flag <option>-m</option> causes the creation of a home directory for the + new user, which is generally what you want. The user does not have an initial + password and therefore cannot log in. A password can be set using the + <command>passwd</command> utility: <screen> # passwd alice Enter new UNIX password: *** Retype new UNIX password: *** </screen> - -A user can be deleted using <command>userdel</command>: - + A user can be deleted using <command>userdel</command>: <screen> # userdel -r alice</screen> - -The flag <option>-r</option> deletes the user’s home directory. -Accounts can be modified using <command>usermod</command>. Unix -groups can be managed using <command>groupadd</command>, -<command>groupmod</command> and <command>groupdel</command>.</para> - + The flag <option>-r</option> deletes the user’s home directory. Accounts + can be modified using <command>usermod</command>. Unix groups can be managed + using <command>groupadd</command>, <command>groupmod</command> and + <command>groupdel</command>. + </para> </chapter> diff --git a/nixos/doc/manual/configuration/wireless.xml b/nixos/doc/manual/configuration/wireless.xml index 6ce43a437009..999447234ad1 100644 --- a/nixos/doc/manual/configuration/wireless.xml +++ b/nixos/doc/manual/configuration/wireless.xml @@ -3,22 +3,20 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-wireless"> + <title>Wireless Networks</title> -<title>Wireless Networks</title> - -<para>For a desktop installation using NetworkManager (e.g., GNOME), -you just have to make sure the user is in the -<code>networkmanager</code> group and you can skip the rest of this -section on wireless networks.</para> - -<para> -NixOS will start wpa_supplicant for you if you enable this setting: + <para> + For a desktop installation using NetworkManager (e.g., GNOME), you just have + to make sure the user is in the <code>networkmanager</code> group and you can + skip the rest of this section on wireless networks. + </para> + <para> + NixOS will start wpa_supplicant for you if you enable this setting: <programlisting> <xref linkend="opt-networking.wireless.enable"/> = true; </programlisting> - -NixOS lets you specify networks for wpa_supplicant declaratively: + NixOS lets you specify networks for wpa_supplicant declaratively: <programlisting> <xref linkend="opt-networking.wireless.networks"/> = { echelon = { @@ -27,27 +25,21 @@ NixOS lets you specify networks for wpa_supplicant declaratively: "free.wifi" = {}; } </programlisting> - -Be aware that keys will be written to the nix store in plaintext! - -When no networks are set, it will default to using a configuration file at -<literal>/etc/wpa_supplicant.conf</literal>. You should edit this file -yourself to define wireless networks, WPA keys and so on (see -wpa_supplicant.conf(5)). -</para> - -<para> -If you are using WPA2 the <command>wpa_passphrase</command> tool might be useful -to generate the <literal>wpa_supplicant.conf</literal>. - + Be aware that keys will be written to the nix store in plaintext! When no + networks are set, it will default to using a configuration file at + <literal>/etc/wpa_supplicant.conf</literal>. You should edit this file + yourself to define wireless networks, WPA keys and so on (see + wpa_supplicant.conf(5)). + </para> + + <para> + If you are using WPA2 the <command>wpa_passphrase</command> tool might be + useful to generate the <literal>wpa_supplicant.conf</literal>. <screen> # wpa_passphrase ESSID PSK > /etc/wpa_supplicant.conf</screen> - -After you have edited the <literal>wpa_supplicant.conf</literal>, -you need to restart the wpa_supplicant service. - + After you have edited the <literal>wpa_supplicant.conf</literal>, you need to + restart the wpa_supplicant service. <screen> # systemctl restart wpa_supplicant.service</screen> -</para> - + </para> </section> diff --git a/nixos/doc/manual/configuration/x-windows.xml b/nixos/doc/manual/configuration/x-windows.xml index fd0daf6c6e57..9a0969ad6355 100644 --- a/nixos/doc/manual/configuration/x-windows.xml +++ b/nixos/doc/manual/configuration/x-windows.xml @@ -3,27 +3,25 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-x11"> - -<title>X Window System</title> - -<para>The X Window System (X11) provides the basis of NixOS’ graphical -user interface. It can be enabled as follows: + <title>X Window System</title> + <para> + The X Window System (X11) provides the basis of NixOS’ graphical user + interface. It can be enabled as follows: <programlisting> <xref linkend="opt-services.xserver.enable"/> = true; </programlisting> -The X server will automatically detect and use the appropriate video -driver from a set of X.org drivers (such as <literal>vesa</literal> -and <literal>intel</literal>). You can also specify a driver -manually, e.g. + The X server will automatically detect and use the appropriate video driver + from a set of X.org drivers (such as <literal>vesa</literal> and + <literal>intel</literal>). You can also specify a driver manually, e.g. <programlisting> <xref linkend="opt-services.xserver.videoDrivers"/> = [ "r128" ]; </programlisting> -to enable X.org’s <literal>xf86-video-r128</literal> driver.</para> - -<para>You also need to enable at least one desktop or window manager. -Otherwise, you can only log into a plain undecorated -<command>xterm</command> window. Thus you should pick one or more of -the following lines: + to enable X.org’s <literal>xf86-video-r128</literal> driver. + </para> + <para> + You also need to enable at least one desktop or window manager. Otherwise, + you can only log into a plain undecorated <command>xterm</command> window. + Thus you should pick one or more of the following lines: <programlisting> <xref linkend="opt-services.xserver.desktopManager.plasma5.enable"/> = true; <xref linkend="opt-services.xserver.desktopManager.xfce.enable"/> = true; @@ -33,108 +31,105 @@ the following lines: <xref linkend="opt-services.xserver.windowManager.icewm.enable"/> = true; <xref linkend="opt-services.xserver.windowManager.i3.enable"/> = true; </programlisting> -</para> - -<para>NixOS’s default <emphasis>display manager</emphasis> (the -program that provides a graphical login prompt and manages the X -server) is SLiM. You can select an alternative one by picking one -of the following lines: + </para> + <para> + NixOS’s default <emphasis>display manager</emphasis> (the program that + provides a graphical login prompt and manages the X server) is SLiM. You can + select an alternative one by picking one of the following lines: <programlisting> <xref linkend="opt-services.xserver.displayManager.sddm.enable"/> = true; <xref linkend="opt-services.xserver.displayManager.lightdm.enable"/> = true; </programlisting> -</para> - -<para>You can set the keyboard layout (and optionally the layout variant): + </para> + <para> + You can set the keyboard layout (and optionally the layout variant): <programlisting> <xref linkend="opt-services.xserver.layout"/> = "de"; <xref linkend="opt-services.xserver.xkbVariant"/> = "neo"; </programlisting> -</para> - -<para>The X server is started automatically at boot time. If you -don’t want this to happen, you can set: + </para> + <para> + The X server is started automatically at boot time. If you don’t want this + to happen, you can set: <programlisting> <xref linkend="opt-services.xserver.autorun"/> = false; </programlisting> -The X server can then be started manually: + The X server can then be started manually: <screen> # systemctl start display-manager.service </screen> -</para> - - -<simplesect><title>NVIDIA Graphics Cards</title> - -<para>NVIDIA provides a proprietary driver for its graphics cards that -has better 3D performance than the X.org drivers. It is not enabled -by default because it’s not free software. You can enable it as follows: + </para> + <simplesect> + <title>NVIDIA Graphics Cards</title> + <para> + NVIDIA provides a proprietary driver for its graphics cards that has better + 3D performance than the X.org drivers. It is not enabled by default because + it’s not free software. You can enable it as follows: <programlisting> <xref linkend="opt-services.xserver.videoDrivers"/> = [ "nvidia" ]; </programlisting> -Or if you have an older card, you may have to use one of the legacy drivers: + Or if you have an older card, you may have to use one of the legacy drivers: <programlisting> <xref linkend="opt-services.xserver.videoDrivers"/> = [ "nvidiaLegacy340" ]; <xref linkend="opt-services.xserver.videoDrivers"/> = [ "nvidiaLegacy304" ]; <xref linkend="opt-services.xserver.videoDrivers"/> = [ "nvidiaLegacy173" ]; </programlisting> -You may need to reboot after enabling this driver to prevent a clash -with other kernel modules.</para> - -<para>On 64-bit systems, if you want full acceleration for 32-bit -programs such as Wine, you should also set the following: + You may need to reboot after enabling this driver to prevent a clash with + other kernel modules. + </para> + <para> + On 64-bit systems, if you want full acceleration for 32-bit programs such as + Wine, you should also set the following: <programlisting> <xref linkend="opt-hardware.opengl.driSupport32Bit"/> = true; </programlisting> -</para> - -</simplesect> - -<simplesect><title>AMD Graphics Cards</title> - -<para>AMD provides a proprietary driver for its graphics cards that -has better 3D performance than the X.org drivers. It is not enabled -by default because it’s not free software. You can enable it as follows: + </para> + </simplesect> + <simplesect> + <title>AMD Graphics Cards</title> + <para> + AMD provides a proprietary driver for its graphics cards that has better 3D + performance than the X.org drivers. It is not enabled by default because + it’s not free software. You can enable it as follows: <programlisting> <xref linkend="opt-services.xserver.videoDrivers"/> = [ "ati_unfree" ]; </programlisting> -You will need to reboot after enabling this driver to prevent a clash -with other kernel modules.</para> - -<para>On 64-bit systems, if you want full acceleration for 32-bit -programs such as Wine, you should also set the following: + You will need to reboot after enabling this driver to prevent a clash with + other kernel modules. + </para> + <para> + On 64-bit systems, if you want full acceleration for 32-bit programs such as + Wine, you should also set the following: <programlisting> <xref linkend="opt-hardware.opengl.driSupport32Bit"/> = true; </programlisting> -</para> - -</simplesect> - -<simplesect><title>Touchpads</title> - -<para>Support for Synaptics touchpads (found in many laptops such as -the Dell Latitude series) can be enabled as follows: + </para> + </simplesect> + <simplesect> + <title>Touchpads</title> + <para> + Support for Synaptics touchpads (found in many laptops such as the Dell + Latitude series) can be enabled as follows: <programlisting> <xref linkend="opt-services.xserver.libinput.enable"/> = true; </programlisting> -The driver has many options (see <xref linkend="ch-options"/>). For -instance, the following disables tap-to-click behavior: + The driver has many options (see <xref linkend="ch-options"/>). For + instance, the following disables tap-to-click behavior: <programlisting> <xref linkend="opt-services.xserver.libinput.tapping"/> = false; </programlisting> -Note: the use of <literal>services.xserver.synaptics</literal> is deprecated since NixOS 17.09. -</para> - -</simplesect> - -<simplesect><title>GTK/Qt themes</title> - -<para>GTK themes can be installed either to user profile or system-wide (via -<literal>environment.systemPackages</literal>). To make Qt 5 applications look similar -to GTK2 ones, you can install <literal>qt5.qtbase.gtk</literal> package into your -system environment. It should work for all Qt 5 library versions. -</para> - -</simplesect> - + Note: the use of <literal>services.xserver.synaptics</literal> is deprecated + since NixOS 17.09. + </para> + </simplesect> + <simplesect> + <title>GTK/Qt themes</title> + <para> + GTK themes can be installed either to user profile or system-wide (via + <literal>environment.systemPackages</literal>). To make Qt 5 applications + look similar to GTK2 ones, you can install <literal>qt5.qtbase.gtk</literal> + package into your system environment. It should work for all Qt 5 library + versions. + </para> + </simplesect> </chapter> diff --git a/nixos/doc/manual/configuration/xfce.xml b/nixos/doc/manual/configuration/xfce.xml index 8cb592faed53..40e61d2bd691 100644 --- a/nixos/doc/manual/configuration/xfce.xml +++ b/nixos/doc/manual/configuration/xfce.xml @@ -3,23 +3,20 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-xfce"> - - <title>Xfce Desktop Environment</title> - - <para> - To enable the Xfce Desktop Environment, set - <programlisting> + <title>Xfce Desktop Environment</title> + <para> + To enable the Xfce Desktop Environment, set +<programlisting> <link linkend="opt-services.xserver.desktopManager.default">services.xserver.desktopManager</link> = { <link linkend="opt-services.xserver.desktopManager.xfce.enable">xfce.enable</link> = true; <link linkend="opt-services.xserver.desktopManager.default">default</link> = "xfce"; }; </programlisting> - </para> - - <para> - Optionally, <emphasis>compton</emphasis> - can be enabled for nice graphical effects, some example settings: - <programlisting> + </para> + <para> + Optionally, <emphasis>compton</emphasis> can be enabled for nice graphical + effects, some example settings: +<programlisting> <link linkend="opt-services.compton.enable">services.compton</link> = { <link linkend="opt-services.compton.enable">enable</link> = true; <link linkend="opt-services.compton.fade">fade</link> = true; @@ -28,67 +25,48 @@ <link linkend="opt-services.compton.fadeDelta">fadeDelta</link> = 4; }; </programlisting> - </para> - - <para> - Some Xfce programs are not installed automatically. - To install them manually (system wide), put them into your - <xref linkend="opt-environment.systemPackages"/>. - </para> - - <simplesect> - <title>Thunar Volume Support</title> - - <para> - To enable - <emphasis>Thunar</emphasis> - volume support, put - <programlisting> + </para> + <para> + Some Xfce programs are not installed automatically. To install them manually + (system wide), put them into your + <xref linkend="opt-environment.systemPackages"/>. + </para> + <simplesect> + <title>Thunar Volume Support</title> + <para> + To enable <emphasis>Thunar</emphasis> volume support, put +<programlisting> <xref linkend="opt-services.xserver.desktopManager.xfce.enable"/> = true; </programlisting> - into your <emphasis>configuration.nix</emphasis>. - </para> - - </simplesect> - - <simplesect> - <title>Polkit Authentication Agent</title> - - <para> - There is no authentication agent automatically installed alongside - Xfce. To allow mounting of local (non-removable) filesystems, you - will need to install one. - - Installing <emphasis>polkit_gnome</emphasis>, a rebuild, logout and - login did the trick. - </para> - - </simplesect> - - <simplesect> - <title>Troubleshooting</title> - - <para> - Even after enabling udisks2, volume management might not work. - Thunar and/or the desktop takes time to show up. - - Thunar will spit out this kind of message on start - (look at <command>journalctl --user -b</command>). - - <programlisting> + into your <emphasis>configuration.nix</emphasis>. + </para> + </simplesect> + <simplesect> + <title>Polkit Authentication Agent</title> + <para> + There is no authentication agent automatically installed alongside Xfce. To + allow mounting of local (non-removable) filesystems, you will need to + install one. Installing <emphasis>polkit_gnome</emphasis>, a rebuild, logout + and login did the trick. + </para> + </simplesect> + <simplesect> + <title>Troubleshooting</title> + <para> + Even after enabling udisks2, volume management might not work. Thunar and/or + the desktop takes time to show up. Thunar will spit out this kind of message + on start (look at <command>journalctl --user -b</command>). +<programlisting> Thunar:2410): GVFS-RemoteVolumeMonitor-WARNING **: remote volume monitor with dbus name org.gtk.Private.UDisks2VolumeMonitor is not supported </programlisting> - - This is caused by some needed GNOME services not running. - This is all fixed by enabling "Launch GNOME services on startup" in - the Advanced tab of the Session and Startup settings panel. - Alternatively, you can run this command to do the same thing. - <programlisting> + This is caused by some needed GNOME services not running. This is all fixed + by enabling "Launch GNOME services on startup" in the Advanced tab of the + Session and Startup settings panel. Alternatively, you can run this command + to do the same thing. +<programlisting> $ xfconf-query -c xfce4-session -p /compat/LaunchGNOME -s true </programlisting> - A log-out and re-log will be needed for this to take effect. - </para> - - </simplesect> - + A log-out and re-log will be needed for this to take effect. + </para> + </simplesect> </chapter> diff --git a/nixos/doc/manual/development/assertions.xml b/nixos/doc/manual/development/assertions.xml index d3434e1f112e..17c38ffcc717 100644 --- a/nixos/doc/manual/development/assertions.xml +++ b/nixos/doc/manual/development/assertions.xml @@ -3,30 +3,29 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-assertions"> + <title>Warnings and Assertions</title> -<title>Warnings and Assertions</title> + <para> + When configuration problems are detectable in a module, it is a good idea to + write an assertion or warning. Doing so provides clear feedback to the user + and prevents errors after the build. + </para> -<para> - When configuration problems are detectable in a module, it is a good - idea to write an assertion or warning. Doing so provides clear - feedback to the user and prevents errors after the build. -</para> - -<para> + <para> Although Nix has the <literal>abort</literal> and - <literal>builtins.trace</literal> <link xlink:href="https://nixos.org/nix/manual/#ssec-builtins">functions</link> to perform such tasks, - they are not ideally suited for NixOS modules. Instead of these - functions, you can declare your warnings and assertions using the + <literal>builtins.trace</literal> + <link xlink:href="https://nixos.org/nix/manual/#ssec-builtins">functions</link> + to perform such tasks, they are not ideally suited for NixOS modules. Instead + of these functions, you can declare your warnings and assertions using the NixOS module system. -</para> - -<section> + </para> -<title>Warnings</title> + <section> + <title>Warnings</title> -<para> - This is an example of using <literal>warnings</literal>. -</para> + <para> + This is an example of using <literal>warnings</literal>. + </para> <programlisting> <![CDATA[ @@ -43,22 +42,19 @@ } ]]> </programlisting> + </section> -</section> - -<section> - -<title>Assertions</title> + <section> + <title>Assertions</title> - -<para> - This example, extracted from the - <link xlink:href="https://github.com/NixOS/nixpkgs/blob/release-17.09/nixos/modules/services/logging/syslogd.nix"> - <literal>syslogd</literal> module - </link> shows how to use <literal>assertions</literal>. Since there - can only be one active syslog daemon at a time, an assertion is useful to - prevent such a broken system from being built. -</para> + <para> + This example, extracted from the + <link xlink:href="https://github.com/NixOS/nixpkgs/blob/release-17.09/nixos/modules/services/logging/syslogd.nix"> + <literal>syslogd</literal> module </link> shows how to use + <literal>assertions</literal>. Since there can only be one active syslog + daemon at a time, an assertion is useful to prevent such a broken system + from being built. + </para> <programlisting> <![CDATA[ @@ -74,7 +70,5 @@ } ]]> </programlisting> - -</section> - + </section> </section> diff --git a/nixos/doc/manual/development/building-nixos.xml b/nixos/doc/manual/development/building-nixos.xml index 2f963f8666f1..23d9ddf88a77 100644 --- a/nixos/doc/manual/development/building-nixos.xml +++ b/nixos/doc/manual/development/building-nixos.xml @@ -3,30 +3,25 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-building-cd"> - -<title>Building Your Own NixOS CD</title> - -<para>Building a NixOS CD is as easy as configuring your own computer. The -idea is to use another module which will replace -your <filename>configuration.nix</filename> to configure the system that -would be installed on the CD.</para> - -<para>Default CD/DVD configurations are available -inside <filename>nixos/modules/installer/cd-dvd</filename>. - + <title>Building Your Own NixOS CD</title> + <para> + Building a NixOS CD is as easy as configuring your own computer. The idea is + to use another module which will replace your + <filename>configuration.nix</filename> to configure the system that would be + installed on the CD. + </para> + <para> + Default CD/DVD configurations are available inside + <filename>nixos/modules/installer/cd-dvd</filename>. <screen> $ git clone https://github.com/NixOS/nixpkgs.git $ cd nixpkgs/nixos $ nix-build -A config.system.build.isoImage -I nixos-config=modules/installer/cd-dvd/installation-cd-minimal.nix default.nix</screen> - -</para> - -<para>Before burning your CD/DVD, you can check the content of the image by mounting anywhere like -suggested by the following command: - + </para> + <para> + Before burning your CD/DVD, you can check the content of the image by + mounting anywhere like suggested by the following command: <screen> # mount -o loop -t iso9660 ./result/iso/cd.iso /mnt/iso</screen> - -</para> - + </para> </chapter> diff --git a/nixos/doc/manual/development/building-parts.xml b/nixos/doc/manual/development/building-parts.xml index 09a40114f02e..031048aaa377 100644 --- a/nixos/doc/manual/development/building-parts.xml +++ b/nixos/doc/manual/development/building-parts.xml @@ -3,111 +3,110 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-building-parts"> - -<title>Building Specific Parts of NixOS</title> - -<para>With the command <command>nix-build</command>, you can build -specific parts of your NixOS configuration. This is done as follows: - + <title>Building Specific Parts of NixOS</title> + <para> + With the command <command>nix-build</command>, you can build specific parts + of your NixOS configuration. This is done as follows: <screen> $ cd <replaceable>/path/to/nixpkgs/nixos</replaceable> $ nix-build -A config.<replaceable>option</replaceable></screen> - -where <replaceable>option</replaceable> is a NixOS option with type -“derivation” (i.e. something that can be built). Attributes of -interest include: - -<variablelist> - - <varlistentry> - <term><varname>system.build.toplevel</varname></term> + where <replaceable>option</replaceable> is a NixOS option with type + “derivation” (i.e. something that can be built). Attributes of interest + include: + <variablelist> + <varlistentry> + <term><varname>system.build.toplevel</varname> + </term> <listitem> - <para>The top-level option that builds the entire NixOS system. - Everything else in your configuration is indirectly pulled in by - this option. This is what <command>nixos-rebuild</command> - builds and what <filename>/run/current-system</filename> points - to afterwards.</para> - - <para>A shortcut to build this is: - + <para> + The top-level option that builds the entire NixOS system. Everything else + in your configuration is indirectly pulled in by this option. This is + what <command>nixos-rebuild</command> builds and what + <filename>/run/current-system</filename> points to afterwards. + </para> + <para> + A shortcut to build this is: <screen> $ nix-build -A system</screen> - </para> + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><varname>system.build.manual.manual</varname></term> - <listitem><para>The NixOS manual.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>system.build.etc</varname></term> - <listitem><para>A tree of symlinks that form the static parts of - <filename>/etc</filename>.</para></listitem> - </varlistentry> - - <varlistentry> - <term><varname>system.build.initialRamdisk</varname></term> - <term><varname>system.build.kernel</varname></term> + </varlistentry> + <varlistentry> + <term><varname>system.build.manual.manual</varname> + </term> <listitem> - <para>The initial ramdisk and kernel of the system. This allows - a quick way to test whether the kernel and the initial ramdisk - boot correctly, by using QEMU’s <option>-kernel</option> and - <option>-initrd</option> options: - + <para> + The NixOS manual. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>system.build.etc</varname> + </term> + <listitem> + <para> + A tree of symlinks that form the static parts of + <filename>/etc</filename>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>system.build.initialRamdisk</varname> + </term> + <term><varname>system.build.kernel</varname> + </term> + <listitem> + <para> + The initial ramdisk and kernel of the system. This allows a quick way to + test whether the kernel and the initial ramdisk boot correctly, by using + QEMU’s <option>-kernel</option> and <option>-initrd</option> options: <screen> $ nix-build -A config.system.build.initialRamdisk -o initrd $ nix-build -A config.system.build.kernel -o kernel $ qemu-system-x86_64 -kernel ./kernel/bzImage -initrd ./initrd/initrd -hda /dev/null </screen> - - </para> + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><varname>system.build.nixos-rebuild</varname></term> - <term><varname>system.build.nixos-install</varname></term> - <term><varname>system.build.nixos-generate-config</varname></term> + </varlistentry> + <varlistentry> + <term><varname>system.build.nixos-rebuild</varname> + </term> + <term><varname>system.build.nixos-install</varname> + </term> + <term><varname>system.build.nixos-generate-config</varname> + </term> <listitem> - <para>These build the corresponding NixOS commands.</para> + <para> + These build the corresponding NixOS commands. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><varname>systemd.units.<replaceable>unit-name</replaceable>.unit</varname></term> + </varlistentry> + <varlistentry> + <term><varname>systemd.units.<replaceable>unit-name</replaceable>.unit</varname> + </term> <listitem> - <para>This builds the unit with the specified name. Note that - since unit names contain dots - (e.g. <literal>httpd.service</literal>), you need to put them - between quotes, like this: - + <para> + This builds the unit with the specified name. Note that since unit names + contain dots (e.g. <literal>httpd.service</literal>), you need to put + them between quotes, like this: <screen> $ nix-build -A 'config.systemd.units."httpd.service".unit' </screen> - - You can also test individual units, without rebuilding the whole - system, by putting them in - <filename>/run/systemd/system</filename>: - + You can also test individual units, without rebuilding the whole system, + by putting them in <filename>/run/systemd/system</filename>: <screen> $ cp $(nix-build -A 'config.systemd.units."httpd.service".unit')/httpd.service \ /run/systemd/system/tmp-httpd.service # systemctl daemon-reload # systemctl start tmp-httpd.service </screen> - Note that the unit must not have the same name as any unit in - <filename>/etc/systemd/system</filename> since those take - precedence over <filename>/run/systemd/system</filename>. - That’s why the unit is installed as - <filename>tmp-httpd.service</filename> here.</para> + <filename>/etc/systemd/system</filename> since those take precedence over + <filename>/run/systemd/system</filename>. That’s why the unit is + installed as <filename>tmp-httpd.service</filename> here. + </para> </listitem> - </varlistentry> - -</variablelist> - -</para> - + </varlistentry> + </variablelist> + </para> </chapter> diff --git a/nixos/doc/manual/development/development.xml b/nixos/doc/manual/development/development.xml index 47343d93cde9..03dee6ff09bb 100644 --- a/nixos/doc/manual/development/development.xml +++ b/nixos/doc/manual/development/development.xml @@ -3,21 +3,18 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="ch-development"> - -<title>Development</title> - -<partintro> -<para>This chapter describes how you can modify and extend -NixOS.</para> -</partintro> - -<xi:include href="sources.xml" /> -<xi:include href="writing-modules.xml" /> -<xi:include href="building-parts.xml" /> -<xi:include href="writing-documentation.xml" /> -<xi:include href="building-nixos.xml" /> -<xi:include href="nixos-tests.xml" /> -<xi:include href="testing-installer.xml" /> -<xi:include href="releases.xml" /> - + <title>Development</title> + <partintro> + <para> + This chapter describes how you can modify and extend NixOS. + </para> + </partintro> + <xi:include href="sources.xml" /> + <xi:include href="writing-modules.xml" /> + <xi:include href="building-parts.xml" /> + <xi:include href="writing-documentation.xml" /> + <xi:include href="building-nixos.xml" /> + <xi:include href="nixos-tests.xml" /> + <xi:include href="testing-installer.xml" /> + <xi:include href="releases.xml" /> </part> diff --git a/nixos/doc/manual/development/importing-modules.xml b/nixos/doc/manual/development/importing-modules.xml index ec1da09b9507..1c6a5671eda8 100644 --- a/nixos/doc/manual/development/importing-modules.xml +++ b/nixos/doc/manual/development/importing-modules.xml @@ -3,13 +3,12 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-importing-modules"> + <title>Importing Modules</title> -<title>Importing Modules</title> - -<para> - Sometimes NixOS modules need to be used in configuration but exist - outside of Nixpkgs. These modules can be imported: -</para> + <para> + Sometimes NixOS modules need to be used in configuration but exist outside of + Nixpkgs. These modules can be imported: + </para> <programlisting> { config, lib, pkgs, ... }: @@ -25,12 +24,11 @@ } </programlisting> -<para> - The environment variable <literal>NIXOS_EXTRA_MODULE_PATH</literal> is - an absolute path to a NixOS module that is included alongside the - Nixpkgs NixOS modules. Like any NixOS module, this module can import - additional modules: -</para> + <para> + The environment variable <literal>NIXOS_EXTRA_MODULE_PATH</literal> is an + absolute path to a NixOS module that is included alongside the Nixpkgs NixOS + modules. Like any NixOS module, this module can import additional modules: + </para> <programlisting> # ./module-list/default.nix @@ -55,5 +53,4 @@ services.exampleModule1.enable = true; } </programlisting> - </section> diff --git a/nixos/doc/manual/development/meta-attributes.xml b/nixos/doc/manual/development/meta-attributes.xml index de0870314dcb..3d019a4987e1 100644 --- a/nixos/doc/manual/development/meta-attributes.xml +++ b/nixos/doc/manual/development/meta-attributes.xml @@ -3,22 +3,26 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-meta-attributes"> + <title>Meta Attributes</title> -<title>Meta Attributes</title> - -<para>Like Nix packages, NixOS modules can declare meta-attributes to provide - extra information. Module meta attributes are defined in the + <para> + Like Nix packages, NixOS modules can declare meta-attributes to provide extra + information. Module meta attributes are defined in the <filename xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/misc/meta.nix">meta.nix</filename> - special module.</para> + special module. + </para> -<para><literal>meta</literal> is a top level attribute like + <para> + <literal>meta</literal> is a top level attribute like <literal>options</literal> and <literal>config</literal>. Available meta-attributes are <literal>maintainers</literal> and - <literal>doc</literal>.</para> + <literal>doc</literal>. + </para> -<para>Each of the meta-attributes must be defined at most once per module - file.</para> + <para> + Each of the meta-attributes must be defined at most once per module file. + </para> <programlisting> { config, lib, pkgs, ... }: @@ -39,24 +43,21 @@ } </programlisting> -<calloutlist> - <callout arearefs='modules-meta-1'> - <para> + <calloutlist> + <callout arearefs='modules-meta-1'> + <para> <varname>maintainers</varname> contains a list of the module maintainers. - </para> - </callout> - - <callout arearefs='modules-meta-2'> - <para> + </para> + </callout> + <callout arearefs='modules-meta-2'> + <para> <varname>doc</varname> points to a valid DocBook file containing the module - documentation. Its contents is automatically added to <xref - linkend="ch-configuration"/>. - Changes to a module documentation have to be checked to not break - building the NixOS manual: - </para> - <programlisting>$ nix-build nixos/release.nix -A manual</programlisting> - </callout> - -</calloutlist> - + documentation. Its contents is automatically added to + <xref + linkend="ch-configuration"/>. Changes to a module documentation + have to be checked to not break building the NixOS manual: + </para> +<programlisting>$ nix-build nixos/release.nix -A manual</programlisting> + </callout> + </calloutlist> </section> diff --git a/nixos/doc/manual/development/nixos-tests.xml b/nixos/doc/manual/development/nixos-tests.xml index c09c41ea3bdc..2695082e3867 100644 --- a/nixos/doc/manual/development/nixos-tests.xml +++ b/nixos/doc/manual/development/nixos-tests.xml @@ -3,18 +3,17 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-nixos-tests"> - -<title>NixOS Tests</title> - -<para>When you add some feature to NixOS, you should write a test for -it. NixOS tests are kept in the directory <filename + <title>NixOS Tests</title> + <para> + When you add some feature to NixOS, you should write a test for it. NixOS + tests are kept in the directory + <filename xlink:href="https://github.com/NixOS/nixpkgs/tree/master/nixos/tests">nixos/tests</filename>, -and are executed (using Nix) by a testing framework that automatically -starts one or more virtual machines containing the NixOS system(s) -required for the test.</para> - -<xi:include href="writing-nixos-tests.xml" /> -<xi:include href="running-nixos-tests.xml" /> -<xi:include href="running-nixos-tests-interactively.xml" /> - + and are executed (using Nix) by a testing framework that automatically starts + one or more virtual machines containing the NixOS system(s) required for the + test. + </para> + <xi:include href="writing-nixos-tests.xml" /> + <xi:include href="running-nixos-tests.xml" /> + <xi:include href="running-nixos-tests-interactively.xml" /> </chapter> diff --git a/nixos/doc/manual/development/option-declarations.xml b/nixos/doc/manual/development/option-declarations.xml index ed718c89eb77..a8f528a0a804 100644 --- a/nixos/doc/manual/development/option-declarations.xml +++ b/nixos/doc/manual/development/option-declarations.xml @@ -3,14 +3,12 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-option-declarations"> + <title>Option Declarations</title> -<title>Option Declarations</title> - -<para>An option declaration specifies the name, type and description -of a NixOS configuration option. It is invalid to define an option -that hasn’t been declared in any module. An option declaration -generally looks like this: - + <para> + An option declaration specifies the name, type and description of a NixOS + configuration option. It is invalid to define an option that hasn’t been + declared in any module. An option declaration generally looks like this: <programlisting> options = { <replaceable>name</replaceable> = mkOption { @@ -21,146 +19,177 @@ options = { }; }; </programlisting> - -The attribute names within the <replaceable>name</replaceable> -attribute path must be camel cased in general but should, as an -exception, match the -<link + The attribute names within the <replaceable>name</replaceable> attribute path + must be camel cased in general but should, as an exception, match the + <link xlink:href="https://nixos.org/nixpkgs/manual/#sec-package-naming"> -package attribute name</link> when referencing a Nixpkgs package. For -example, the option <varname>services.nix-serve.bindAddress</varname> -references the <varname>nix-serve</varname> Nixpkgs package. - -</para> - -<para>The function <varname>mkOption</varname> accepts the following arguments. - -<variablelist> - - <varlistentry> - <term><varname>type</varname></term> + package attribute name</link> when referencing a Nixpkgs package. For + example, the option <varname>services.nix-serve.bindAddress</varname> + references the <varname>nix-serve</varname> Nixpkgs package. + </para> + + <para> + The function <varname>mkOption</varname> accepts the following arguments. + <variablelist> + <varlistentry> + <term><varname>type</varname> + </term> <listitem> - <para>The type of the option (see <xref linkend='sec-option-types' />). - It may be omitted, but that’s not advisable since it may lead to errors - that are hard to diagnose.</para> + <para> + The type of the option (see <xref linkend='sec-option-types' />). It may + be omitted, but that’s not advisable since it may lead to errors that + are hard to diagnose. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><varname>default</varname></term> + </varlistentry> + <varlistentry> + <term><varname>default</varname> + </term> <listitem> - <para>The default value used if no value is defined by any - module. A default is not required; but if a default is not given, - then users of the module will have to define the value of the - option, otherwise an error will be thrown.</para> + <para> + The default value used if no value is defined by any module. A default is + not required; but if a default is not given, then users of the module + will have to define the value of the option, otherwise an error will be + thrown. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><varname>example</varname></term> + </varlistentry> + <varlistentry> + <term><varname>example</varname> + </term> <listitem> - <para>An example value that will be shown in the NixOS manual.</para> + <para> + An example value that will be shown in the NixOS manual. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><varname>description</varname></term> + </varlistentry> + <varlistentry> + <term><varname>description</varname> + </term> <listitem> - <para>A textual description of the option, in DocBook format, - that will be included in the NixOS manual.</para> + <para> + A textual description of the option, in DocBook format, that will be + included in the NixOS manual. + </para> </listitem> - </varlistentry> - -</variablelist> - -</para> - -<section xml:id="sec-option-declarations-eot"><title>Extensible Option - Types</title> - - <para>Extensible option types is a feature that allow to extend certain types - declaration through multiple module files. - This feature only work with a restricted set of types, namely - <literal>enum</literal> and <literal>submodules</literal> and any composed - forms of them.</para> - - <para>Extensible option types can be used for <literal>enum</literal> options - that affects multiple modules, or as an alternative to related - <literal>enable</literal> options.</para> + </varlistentry> + </variablelist> + </para> + + <section xml:id="sec-option-declarations-eot"> + <title>Extensible Option Types</title> + + <para> + Extensible option types is a feature that allow to extend certain types + declaration through multiple module files. This feature only work with a + restricted set of types, namely <literal>enum</literal> and + <literal>submodules</literal> and any composed forms of them. + </para> - <para>As an example, we will take the case of display managers. There is a - central display manager module for generic display manager options and a - module file per display manager backend (slim, sddm, gdm ...). + <para> + Extensible option types can be used for <literal>enum</literal> options that + affects multiple modules, or as an alternative to related + <literal>enable</literal> options. </para> - <para>There are two approach to this module structure: + <para> + As an example, we will take the case of display managers. There is a central + display manager module for generic display manager options and a module file + per display manager backend (slim, sddm, gdm ...). + </para> - <itemizedlist> - <listitem><para>Managing the display managers independently by adding an - enable option to every display manager module backend. (NixOS)</para> + <para> + There are two approach to this module structure: + <itemizedlist> + <listitem> + <para> + Managing the display managers independently by adding an enable option to + every display manager module backend. (NixOS) + </para> </listitem> - <listitem><para>Managing the display managers in the central module by - adding an option to select which display manager backend to use.</para> + <listitem> + <para> + Managing the display managers in the central module by adding an option + to select which display manager backend to use. + </para> </listitem> - </itemizedlist> + </itemizedlist> </para> - <para>Both approaches have problems.</para> + <para> + Both approaches have problems. + </para> - <para>Making backends independent can quickly become hard to manage. For - display managers, there can be only one enabled at a time, but the type - system can not enforce this restriction as there is no relation between - each backend <literal>enable</literal> option. As a result, this restriction - has to be done explicitely by adding assertions in each display manager - backend module.</para> + <para> + Making backends independent can quickly become hard to manage. For display + managers, there can be only one enabled at a time, but the type system can + not enforce this restriction as there is no relation between each backend + <literal>enable</literal> option. As a result, this restriction has to be + done explicitely by adding assertions in each display manager backend + module. + </para> - <para>On the other hand, managing the display managers backends in the - central module will require to change the central module option every time - a new backend is added or removed.</para> + <para> + On the other hand, managing the display managers backends in the central + module will require to change the central module option every time a new + backend is added or removed. + </para> - <para>By using extensible option types, it is possible to create a placeholder - option in the central module (<xref linkend='ex-option-declaration-eot-service' - />), and to extend it in each backend module (<xref - linkend='ex-option-declaration-eot-backend-slim' />, <xref - linkend='ex-option-declaration-eot-backend-sddm' />).</para> + <para> + By using extensible option types, it is possible to create a placeholder + option in the central module + (<xref linkend='ex-option-declaration-eot-service' + />), and to extend + it in each backend module + (<xref + linkend='ex-option-declaration-eot-backend-slim' />, + <xref + linkend='ex-option-declaration-eot-backend-sddm' />). + </para> - <para>As a result, <literal>displayManager.enable</literal> option values can - be added without changing the main service module file and the type system - automatically enforce that there can only be a single display manager - enabled.</para> + <para> + As a result, <literal>displayManager.enable</literal> option values can be + added without changing the main service module file and the type system + automatically enforce that there can only be a single display manager + enabled. + </para> -<example xml:id='ex-option-declaration-eot-service'><title>Extensible type - placeholder in the service module</title> + <example xml:id='ex-option-declaration-eot-service'> + <title>Extensible type placeholder in the service module</title> <screen> services.xserver.displayManager.enable = mkOption { description = "Display manager to use"; type = with types; nullOr (enum [ ]); -};</screen></example> +};</screen> + </example> -<example xml:id='ex-option-declaration-eot-backend-slim'><title>Extending - <literal>services.xserver.displayManager.enable</literal> in the - <literal>slim</literal> module</title> + <example xml:id='ex-option-declaration-eot-backend-slim'> + <title>Extending <literal>services.xserver.displayManager.enable</literal> in the <literal>slim</literal> module</title> <screen> services.xserver.displayManager.enable = mkOption { type = with types; nullOr (enum [ "slim" ]); -};</screen></example> +};</screen> + </example> -<example xml:id='ex-option-declaration-eot-backend-sddm'><title>Extending - <literal>services.xserver.displayManager.enable</literal> in the - <literal>sddm</literal> module</title> + <example xml:id='ex-option-declaration-eot-backend-sddm'> + <title>Extending <literal>services.xserver.displayManager.enable</literal> in the <literal>sddm</literal> module</title> <screen> services.xserver.displayManager.enable = mkOption { type = with types; nullOr (enum [ "sddm" ]); -};</screen></example> - -<para>The placeholder declaration is a standard <literal>mkOption</literal> - declaration, but it is important that extensible option declarations only use - the <literal>type</literal> argument.</para> +};</screen> + </example> -<para>Extensible option types work with any of the composed variants of - <literal>enum</literal> such as - <literal>with types; nullOr (enum [ "foo" "bar" ])</literal> - or <literal>with types; listOf (enum [ "foo" "bar" ])</literal>.</para> + <para> + The placeholder declaration is a standard <literal>mkOption</literal> + declaration, but it is important that extensible option declarations only + use the <literal>type</literal> argument. + </para> -</section> + <para> + Extensible option types work with any of the composed variants of + <literal>enum</literal> such as <literal>with types; nullOr (enum [ "foo" + "bar" ])</literal> or <literal>with types; listOf (enum [ "foo" "bar" + ])</literal>. + </para> + </section> </section> diff --git a/nixos/doc/manual/development/option-def.xml b/nixos/doc/manual/development/option-def.xml index 4e267ecfd1e3..580a5afd58cd 100644 --- a/nixos/doc/manual/development/option-def.xml +++ b/nixos/doc/manual/development/option-def.xml @@ -3,39 +3,36 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-option-definitions"> + <title>Option Definitions</title> -<title>Option Definitions</title> - -<para>Option definitions are generally straight-forward bindings of values to option names, like - + <para> + Option definitions are generally straight-forward bindings of values to + option names, like <programlisting> config = { services.httpd.enable = true; }; </programlisting> - -However, sometimes you need to wrap an option definition or set of -option definitions in a <emphasis>property</emphasis> to achieve -certain effects:</para> - -<simplesect><title>Delaying Conditionals</title> - -<para>If a set of option definitions is conditional on the value of -another option, you may need to use <varname>mkIf</varname>. -Consider, for instance: - + However, sometimes you need to wrap an option definition or set of option + definitions in a <emphasis>property</emphasis> to achieve certain effects: + </para> + + <simplesect> + <title>Delaying Conditionals</title> + <para> + If a set of option definitions is conditional on the value of another + option, you may need to use <varname>mkIf</varname>. Consider, for instance: <programlisting> config = if config.services.httpd.enable then { environment.systemPackages = [ <replaceable>...</replaceable> ]; <replaceable>...</replaceable> } else {}; </programlisting> - -This definition will cause Nix to fail with an “infinite recursion” -error. Why? Because the value of -<option>config.services.httpd.enable</option> depends on the value -being constructed here. After all, you could also write the clearly -circular and contradictory: + This definition will cause Nix to fail with an “infinite recursion” + error. Why? Because the value of + <option>config.services.httpd.enable</option> depends on the value being + constructed here. After all, you could also write the clearly circular and + contradictory: <programlisting> config = if config.services.httpd.enable then { services.httpd.enable = false; @@ -43,56 +40,49 @@ config = if config.services.httpd.enable then { services.httpd.enable = true; }; </programlisting> - -The solution is to write: - + The solution is to write: <programlisting> config = mkIf config.services.httpd.enable { environment.systemPackages = [ <replaceable>...</replaceable> ]; <replaceable>...</replaceable> }; </programlisting> - -The special function <varname>mkIf</varname> causes the evaluation of -the conditional to be “pushed down” into the individual definitions, -as if you had written: - + The special function <varname>mkIf</varname> causes the evaluation of the + conditional to be “pushed down” into the individual definitions, as if + you had written: <programlisting> config = { environment.systemPackages = if config.services.httpd.enable then [ <replaceable>...</replaceable> ] else []; <replaceable>...</replaceable> }; </programlisting> - -</para> - -</simplesect> - -<simplesect><title>Setting Priorities</title> - -<para>A module can override the definitions of an option in other -modules by setting a <emphasis>priority</emphasis>. All option -definitions that do not have the lowest priority value are discarded. -By default, option definitions have priority 1000. You can specify an -explicit priority by using <varname>mkOverride</varname>, e.g. - + </para> + </simplesect> + + <simplesect> + <title>Setting Priorities</title> + <para> + A module can override the definitions of an option in other modules by + setting a <emphasis>priority</emphasis>. All option definitions that do not + have the lowest priority value are discarded. By default, option definitions + have priority 1000. You can specify an explicit priority by using + <varname>mkOverride</varname>, e.g. <programlisting> services.openssh.enable = mkOverride 10 false; </programlisting> - -This definition causes all other definitions with priorities above 10 -to be discarded. The function <varname>mkForce</varname> is -equal to <varname>mkOverride 50</varname>.</para> - -</simplesect> - -<simplesect><title>Merging Configurations</title> - -<para>In conjunction with <literal>mkIf</literal>, it is sometimes -useful for a module to return multiple sets of option definitions, to -be merged together as if they were declared in separate modules. This -can be done using <varname>mkMerge</varname>: - + This definition causes all other definitions with priorities above 10 to be + discarded. The function <varname>mkForce</varname> is equal to + <varname>mkOverride 50</varname>. + </para> + </simplesect> + + <simplesect> + <title>Merging Configurations</title> + <para> + In conjunction with <literal>mkIf</literal>, it is sometimes useful for a + module to return multiple sets of option definitions, to be merged together + as if they were declared in separate modules. This can be done using + <varname>mkMerge</varname>: <programlisting> config = mkMerge [ # Unconditional stuff. @@ -104,9 +94,6 @@ config = mkMerge }) ]; </programlisting> - -</para> - -</simplesect> - -</section> \ No newline at end of file + </para> + </simplesect> +</section> diff --git a/nixos/doc/manual/development/option-types.xml b/nixos/doc/manual/development/option-types.xml index 13fa8d1e114c..7969d8124738 100644 --- a/nixos/doc/manual/development/option-types.xml +++ b/nixos/doc/manual/development/option-types.xml @@ -3,241 +3,346 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-option-types"> + <title>Options Types</title> -<title>Options Types</title> - - <para>Option types are a way to put constraints on the values a module option - can take. - Types are also responsible of how values are merged in case of multiple - value definitions.</para> - <section><title>Basic Types</title> - - <para>Basic types are the simplest available types in the module system. - Basic types include multiple string types that mainly differ in how - definition merging is handled.</para> - -<variablelist> - <varlistentry> - <term><varname>types.bool</varname></term> - <listitem><para>A boolean, its values can be <literal>true</literal> or - <literal>false</literal>.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>types.path</varname></term> - <listitem><para>A filesystem path, defined as anything that when coerced to - a string starts with a slash. Even if derivations can be considered as - path, the more specific <literal>types.package</literal> should be - preferred.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>types.package</varname></term> - <listitem><para>A derivation or a store path.</para></listitem> - </varlistentry> -</variablelist> - -<para>Integer-related types:</para> - -<variablelist> - <varlistentry> - <term><varname>types.int</varname></term> - <listitem><para>A signed integer.</para></listitem> - </varlistentry> - <varlistentry> - <term> - <varname>types.ints.{s8, s16, s32}</varname> - </term> - <listitem> - <para>Signed integers with a fixed length (8, 16 or 32 bits). - They go from - <inlineequation><mathphrase>−2<superscript>n</superscript>/2</mathphrase> - </inlineequation> to <inlineequation> - <mathphrase>2<superscript>n</superscript>/2−1</mathphrase> - </inlineequation> - respectively (e.g. <literal>−128</literal> to <literal>127</literal> - for 8 bits). - </para></listitem> - </varlistentry> - <varlistentry> - <term> - <varname>types.ints.unsigned</varname> - </term> - <listitem><para>An unsigned integer (that is >= 0). - </para></listitem> - </varlistentry> - <varlistentry> - <term> - <varname>types.ints.{u8, u16, u32}</varname> - </term> - <listitem> - <para>Unsigned integers with a fixed length (8, 16 or 32 bits). - They go from - <inlineequation><mathphrase>0</mathphrase></inlineequation> to <inlineequation> - <mathphrase>2<superscript>n</superscript>−1</mathphrase> - </inlineequation> - respectively (e.g. <literal>0</literal> to <literal>255</literal> - for 8 bits). - </para></listitem> - </varlistentry> - <varlistentry> - <term> - <varname>types.ints.positive</varname> - </term> - <listitem><para>A positive integer (that is > 0). - </para></listitem> - </varlistentry> -</variablelist> - -<para>String-related types:</para> - -<variablelist> - <varlistentry> - <term><varname>types.str</varname></term> - <listitem><para>A string. Multiple definitions cannot be - merged.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>types.lines</varname></term> - <listitem><para>A string. Multiple definitions are concatenated with a new - line <literal>"\n"</literal>.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>types.commas</varname></term> - <listitem><para>A string. Multiple definitions are concatenated with a comma - <literal>","</literal>.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>types.envVar</varname></term> - <listitem><para>A string. Multiple definitions are concatenated with a - collon <literal>":"</literal>.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>types.strMatching</varname></term> - <listitem><para>A string matching a specific regular expression. Multiple - definitions cannot be merged. The regular expression is processed using - <literal>builtins.match</literal>.</para></listitem> - </varlistentry> -</variablelist> + <para> + Option types are a way to put constraints on the values a module option can + take. Types are also responsible of how values are merged in case of multiple + value definitions. + </para> + <section> + <title>Basic Types</title> + + <para> + Basic types are the simplest available types in the module system. Basic + types include multiple string types that mainly differ in how definition + merging is handled. + </para> + + <variablelist> + <varlistentry> + <term><varname>types.bool</varname> + </term> + <listitem> + <para> + A boolean, its values can be <literal>true</literal> or + <literal>false</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>types.path</varname> + </term> + <listitem> + <para> + A filesystem path, defined as anything that when coerced to a string + starts with a slash. Even if derivations can be considered as path, the + more specific <literal>types.package</literal> should be preferred. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>types.package</varname> + </term> + <listitem> + <para> + A derivation or a store path. + </para> + </listitem> + </varlistentry> + </variablelist> + + <para> + Integer-related types: + </para> + + <variablelist> + <varlistentry> + <term><varname>types.int</varname> + </term> + <listitem> + <para> + A signed integer. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>types.ints.{s8, s16, s32}</varname> + </term> + <listitem> + <para> + Signed integers with a fixed length (8, 16 or 32 bits). They go from + <inlineequation><mathphrase>−2<superscript>n</superscript>/2</mathphrase> + </inlineequation> to <inlineequation> + <mathphrase>2<superscript>n</superscript>/2−1</mathphrase> + </inlineequation> respectively (e.g. <literal>−128</literal> to + <literal>127</literal> for 8 bits). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>types.ints.unsigned</varname> + </term> + <listitem> + <para> + An unsigned integer (that is >= 0). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>types.ints.{u8, u16, u32}</varname> + </term> + <listitem> + <para> + Unsigned integers with a fixed length (8, 16 or 32 bits). They go from + <inlineequation><mathphrase>0</mathphrase></inlineequation> to + <inlineequation> + <mathphrase>2<superscript>n</superscript>−1</mathphrase> + </inlineequation> respectively (e.g. <literal>0</literal> to + <literal>255</literal> for 8 bits). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>types.ints.positive</varname> + </term> + <listitem> + <para> + A positive integer (that is > 0). + </para> + </listitem> + </varlistentry> + </variablelist> + + <para> + String-related types: + </para> + + <variablelist> + <varlistentry> + <term><varname>types.str</varname> + </term> + <listitem> + <para> + A string. Multiple definitions cannot be merged. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>types.lines</varname> + </term> + <listitem> + <para> + A string. Multiple definitions are concatenated with a new line + <literal>"\n"</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>types.commas</varname> + </term> + <listitem> + <para> + A string. Multiple definitions are concatenated with a comma + <literal>","</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>types.envVar</varname> + </term> + <listitem> + <para> + A string. Multiple definitions are concatenated with a collon + <literal>":"</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>types.strMatching</varname> + </term> + <listitem> + <para> + A string matching a specific regular expression. Multiple definitions + cannot be merged. The regular expression is processed using + <literal>builtins.match</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> </section> - <section><title>Value Types</title> - - <para>Value types are types that take a value parameter.</para> - -<variablelist> - <varlistentry> - <term><varname>types.enum</varname> <replaceable>l</replaceable></term> - <listitem><para>One element of the list <replaceable>l</replaceable>, e.g. - <literal>types.enum [ "left" "right" ]</literal>. Multiple definitions - cannot be merged.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>types.separatedString</varname> - <replaceable>sep</replaceable></term> - <listitem><para>A string with a custom separator - <replaceable>sep</replaceable>, e.g. <literal>types.separatedString - "|"</literal>.</para></listitem> - </varlistentry> - <varlistentry> - <term> - <varname>types.ints.between</varname> - <replaceable>lowest</replaceable> - <replaceable>highest</replaceable> - </term> - <listitem><para>An integer between <replaceable>lowest</replaceable> - and <replaceable>highest</replaceable> (both inclusive). - Useful for creating types like <literal>types.port</literal>. - </para></listitem> - </varlistentry> - <varlistentry> - <term><varname>types.submodule</varname> <replaceable>o</replaceable></term> - <listitem><para>A set of sub options <replaceable>o</replaceable>. - <replaceable>o</replaceable> can be an attribute set or a function - returning an attribute set. Submodules are used in composed types to - create modular options. Submodule are detailed in <xref - linkend='section-option-types-submodule' />.</para></listitem> - </varlistentry> -</variablelist> + <section> + <title>Value Types</title> + + <para> + Value types are types that take a value parameter. + </para> + + <variablelist> + <varlistentry> + <term><varname>types.enum</varname><replaceable>l</replaceable> + </term> + <listitem> + <para> + One element of the list <replaceable>l</replaceable>, e.g. + <literal>types.enum [ "left" "right" ]</literal>. Multiple definitions + cannot be merged. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>types.separatedString</varname><replaceable>sep</replaceable> + </term> + <listitem> + <para> + A string with a custom separator <replaceable>sep</replaceable>, e.g. + <literal>types.separatedString "|"</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>types.ints.between</varname><replaceable>lowest</replaceable><replaceable>highest</replaceable> + </term> + <listitem> + <para> + An integer between <replaceable>lowest</replaceable> and + <replaceable>highest</replaceable> (both inclusive). Useful for creating + types like <literal>types.port</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>types.submodule</varname><replaceable>o</replaceable> + </term> + <listitem> + <para> + A set of sub options <replaceable>o</replaceable>. + <replaceable>o</replaceable> can be an attribute set or a function + returning an attribute set. Submodules are used in composed types to + create modular options. Submodule are detailed in + <xref + linkend='section-option-types-submodule' />. + </para> + </listitem> + </varlistentry> + </variablelist> </section> - <section><title>Composed Types</title> - - <para>Composed types are types that take a type as parameter. <literal>listOf - int</literal> and <literal>either int str</literal> are examples of - composed types.</para> - -<variablelist> - <varlistentry> - <term><varname>types.listOf</varname> <replaceable>t</replaceable></term> - <listitem><para>A list of <replaceable>t</replaceable> type, e.g. - <literal>types.listOf int</literal>. Multiple definitions are merged - with list concatenation.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>types.attrsOf</varname> <replaceable>t</replaceable></term> - <listitem><para>An attribute set of where all the values are of - <replaceable>t</replaceable> type. Multiple definitions result in the - joined attribute set.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>types.loaOf</varname> <replaceable>t</replaceable></term> - <listitem><para>An attribute set or a list of <replaceable>t</replaceable> - type. Multiple definitions are merged according to the - value.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>types.nullOr</varname> <replaceable>t</replaceable></term> - <listitem><para><literal>null</literal> or type - <replaceable>t</replaceable>. Multiple definitions are merged according - to type <replaceable>t</replaceable>.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>types.uniq</varname> <replaceable>t</replaceable></term> - <listitem><para>Ensures that type <replaceable>t</replaceable> cannot be - merged. It is used to ensure option definitions are declared only - once.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>types.either</varname> <replaceable>t1</replaceable> - <replaceable>t2</replaceable></term> - <listitem><para>Type <replaceable>t1</replaceable> or type - <replaceable>t2</replaceable>, e.g. <literal>with types; either int - str</literal>. Multiple definitions cannot be - merged.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>types.coercedTo</varname> <replaceable>from</replaceable> - <replaceable>f</replaceable> <replaceable>to</replaceable></term> - <listitem><para>Type <replaceable>to</replaceable> or type - <replaceable>from</replaceable> which will be coerced to - type <replaceable>to</replaceable> using function - <replaceable>f</replaceable> which takes an argument of type - <replaceable>from</replaceable> and return a value of type - <replaceable>to</replaceable>. Can be used to preserve backwards - compatibility of an option if its type was changed.</para></listitem> - </varlistentry> -</variablelist> + <section> + <title>Composed Types</title> -</section> + <para> + Composed types are types that take a type as parameter. <literal>listOf + int</literal> and <literal>either int str</literal> are examples of composed + types. + </para> + + <variablelist> + <varlistentry> + <term><varname>types.listOf</varname><replaceable>t</replaceable> + </term> + <listitem> + <para> + A list of <replaceable>t</replaceable> type, e.g. <literal>types.listOf + int</literal>. Multiple definitions are merged with list concatenation. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>types.attrsOf</varname><replaceable>t</replaceable> + </term> + <listitem> + <para> + An attribute set of where all the values are of + <replaceable>t</replaceable> type. Multiple definitions result in the + joined attribute set. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>types.loaOf</varname><replaceable>t</replaceable> + </term> + <listitem> + <para> + An attribute set or a list of <replaceable>t</replaceable> type. Multiple + definitions are merged according to the value. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>types.nullOr</varname><replaceable>t</replaceable> + </term> + <listitem> + <para> + <literal>null</literal> or type <replaceable>t</replaceable>. Multiple + definitions are merged according to type <replaceable>t</replaceable>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>types.uniq</varname><replaceable>t</replaceable> + </term> + <listitem> + <para> + Ensures that type <replaceable>t</replaceable> cannot be merged. It is + used to ensure option definitions are declared only once. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>types.either</varname><replaceable>t1</replaceable><replaceable>t2</replaceable> + </term> + <listitem> + <para> + Type <replaceable>t1</replaceable> or type <replaceable>t2</replaceable>, + e.g. <literal>with types; either int str</literal>. Multiple definitions + cannot be merged. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>types.coercedTo</varname><replaceable>from</replaceable><replaceable>f</replaceable><replaceable>to</replaceable> + </term> + <listitem> + <para> + Type <replaceable>to</replaceable> or type + <replaceable>from</replaceable> which will be coerced to type + <replaceable>to</replaceable> using function <replaceable>f</replaceable> + which takes an argument of type <replaceable>from</replaceable> and + return a value of type <replaceable>to</replaceable>. Can be used to + preserve backwards compatibility of an option if its type was changed. + </para> + </listitem> + </varlistentry> + </variablelist> + </section> -<section xml:id='section-option-types-submodule'><title>Submodule</title> + <section xml:id='section-option-types-submodule'> + <title>Submodule</title> - <para><literal>submodule</literal> is a very powerful type that defines a set - of sub-options that are handled like a separate module.</para> + <para> + <literal>submodule</literal> is a very powerful type that defines a set of + sub-options that are handled like a separate module. + </para> - <para>It takes a parameter <replaceable>o</replaceable>, that should be a set, - or a function returning a set with an <literal>options</literal> key - defining the sub-options. - Submodule option definitions are type-checked accordingly to the - <literal>options</literal> declarations. - Of course, you can nest submodule option definitons for even higher - modularity.</para> + <para> + It takes a parameter <replaceable>o</replaceable>, that should be a set, or + a function returning a set with an <literal>options</literal> key defining + the sub-options. Submodule option definitions are type-checked accordingly + to the <literal>options</literal> declarations. Of course, you can nest + submodule option definitons for even higher modularity. + </para> - <para>The option set can be defined directly - (<xref linkend='ex-submodule-direct' />) or as reference - (<xref linkend='ex-submodule-reference' />).</para> + <para> + The option set can be defined directly + (<xref linkend='ex-submodule-direct' />) or as reference + (<xref linkend='ex-submodule-reference' />). + </para> -<example xml:id='ex-submodule-direct'><title>Directly defined submodule</title> + <example xml:id='ex-submodule-direct'> + <title>Directly defined submodule</title> <screen> options.mod = mkOption { description = "submodule example"; @@ -251,10 +356,11 @@ options.mod = mkOption { }; }; }; -};</screen></example> +};</screen> + </example> -<example xml:id='ex-submodule-reference'><title>Submodule defined as a - reference</title> + <example xml:id='ex-submodule-reference'> + <title>Submodule defined as a reference</title> <screen> let modOptions = { @@ -271,19 +377,20 @@ in options.mod = mkOption { description = "submodule example"; type = with types; submodule modOptions; -};</screen></example> - - <para>The <literal>submodule</literal> type is especially interesting when - used with composed types like <literal>attrsOf</literal> or - <literal>listOf</literal>. - When composed with <literal>listOf</literal> - (<xref linkend='ex-submodule-listof-declaration' />), - <literal>submodule</literal> allows multiple definitions of the submodule - option set (<xref linkend='ex-submodule-listof-definition' />).</para> - - -<example xml:id='ex-submodule-listof-declaration'><title>Declaration of a list - of submodules</title> +};</screen> + </example> + + <para> + The <literal>submodule</literal> type is especially interesting when used + with composed types like <literal>attrsOf</literal> or + <literal>listOf</literal>. When composed with <literal>listOf</literal> + (<xref linkend='ex-submodule-listof-declaration' />), + <literal>submodule</literal> allows multiple definitions of the submodule + option set (<xref linkend='ex-submodule-listof-definition' />). + </para> + + <example xml:id='ex-submodule-listof-declaration'> + <title>Declaration of a list of submodules</title> <screen> options.mod = mkOption { description = "submodule example"; @@ -297,24 +404,27 @@ options.mod = mkOption { }; }; }); -};</screen></example> +};</screen> + </example> -<example xml:id='ex-submodule-listof-definition'><title>Definition of a list of - submodules</title> + <example xml:id='ex-submodule-listof-definition'> + <title>Definition of a list of submodules</title> <screen> config.mod = [ { foo = 1; bar = "one"; } { foo = 2; bar = "two"; } -];</screen></example> - - <para>When composed with <literal>attrsOf</literal> - (<xref linkend='ex-submodule-attrsof-declaration' />), - <literal>submodule</literal> allows multiple named definitions of the - submodule option set (<xref linkend='ex-submodule-attrsof-definition' />). +];</screen> + </example> + + <para> + When composed with <literal>attrsOf</literal> + (<xref linkend='ex-submodule-attrsof-declaration' />), + <literal>submodule</literal> allows multiple named definitions of the + submodule option set (<xref linkend='ex-submodule-attrsof-definition' />). </para> -<example xml:id='ex-submodule-attrsof-declaration'><title>Declaration of - attribute sets of submodules</title> + <example xml:id='ex-submodule-attrsof-declaration'> + <title>Declaration of attribute sets of submodules</title> <screen> options.mod = mkOption { description = "submodule example"; @@ -328,194 +438,281 @@ options.mod = mkOption { }; }; }); -};</screen></example> +};</screen> + </example> -<example xml:id='ex-submodule-attrsof-definition'><title>Declaration of - attribute sets of submodules</title> + <example xml:id='ex-submodule-attrsof-definition'> + <title>Declaration of attribute sets of submodules</title> <screen> config.mod.one = { foo = 1; bar = "one"; }; -config.mod.two = { foo = 2; bar = "two"; };</screen></example> - -</section> - -<section><title>Extending types</title> +config.mod.two = { foo = 2; bar = "two"; };</screen> + </example> + </section> - <para>Types are mainly characterized by their <literal>check</literal> and - <literal>merge</literal> functions.</para> + <section> + <title>Extending types</title> -<variablelist> - <varlistentry> - <term><varname>check</varname></term> - <listitem><para>The function to type check the value. Takes a value as - parameter and return a boolean. - It is possible to extend a type check with the - <literal>addCheck</literal> function (<xref - linkend='ex-extending-type-check-1' />), or to fully override the - check function (<xref linkend='ex-extending-type-check-2' />).</para> + <para> + Types are mainly characterized by their <literal>check</literal> and + <literal>merge</literal> functions. + </para> -<example xml:id='ex-extending-type-check-1'><title>Adding a type check</title> + <variablelist> + <varlistentry> + <term><varname>check</varname> + </term> + <listitem> + <para> + The function to type check the value. Takes a value as parameter and + return a boolean. It is possible to extend a type check with the + <literal>addCheck</literal> function + (<xref + linkend='ex-extending-type-check-1' />), or to fully + override the check function + (<xref linkend='ex-extending-type-check-2' />). + </para> + <example xml:id='ex-extending-type-check-1'> + <title>Adding a type check</title> <screen> byte = mkOption { description = "An integer between 0 and 255."; type = addCheck types.int (x: x >= 0 && x <= 255); -};</screen></example> - -<example xml:id='ex-extending-type-check-2'><title>Overriding a type - check</title> +};</screen> + </example> + <example xml:id='ex-extending-type-check-2'> + <title>Overriding a type check</title> <screen> nixThings = mkOption { description = "words that start with 'nix'"; type = types.str // { check = (x: lib.hasPrefix "nix" x) }; -};</screen></example> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>merge</varname></term> - <listitem><para>Function to merge the options values when multiple values - are set. -The function takes two parameters, <literal>loc</literal> the option path as a -list of strings, and <literal>defs</literal> the list of defined values as a -list. -It is possible to override a type merge function for custom -needs.</para></listitem> - </varlistentry> -</variablelist> +};</screen> + </example> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>merge</varname> + </term> + <listitem> + <para> + Function to merge the options values when multiple values are set. The + function takes two parameters, <literal>loc</literal> the option path as + a list of strings, and <literal>defs</literal> the list of defined values + as a list. It is possible to override a type merge function for custom + needs. + </para> + </listitem> + </varlistentry> + </variablelist> + </section> -</section> + <section> + <title>Custom Types</title> -<section><title>Custom Types</title> - -<para>Custom types can be created with the <literal>mkOptionType</literal> - function. -As type creation includes some more complex topics such as submodule handling, -it is recommended to get familiar with <filename - xlink:href="https://github.com/NixOS/nixpkgs/blob/master/lib/types.nix">types.nix</filename> -code before creating a new type.</para> - -<para>The only required parameter is <literal>name</literal>.</para> - -<variablelist> - <varlistentry> - <term><varname>name</varname></term> - <listitem><para>A string representation of the type function - name.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>definition</varname></term> - <listitem><para>Description of the type used in documentation. Give - information of the type and any of its arguments.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>check</varname></term> - <listitem><para>A function to type check the definition value. Takes the - definition value as a parameter and returns a boolean indicating the - type check result, <literal>true</literal> for success and - <literal>false</literal> for failure.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>merge</varname></term> - <listitem><para>A function to merge multiple definitions values. Takes two - parameters:</para> - <variablelist> - <varlistentry> - <term><replaceable>loc</replaceable></term> - <listitem><para>The option path as a list of strings, e.g. - <literal>["boot" "loader "grub" - "enable"]</literal>.</para></listitem> - </varlistentry> - <varlistentry> - <term><replaceable>defs</replaceable></term> - <listitem><para>The list of sets of defined <literal>value</literal> - and <literal>file</literal> where the value was defined, e.g. - <literal>[ { file = "/foo.nix"; value = 1; } { file = "/bar.nix"; - value = 2 } ]</literal>. The <literal>merge</literal> function - should return the merged value or throw an error in case the - values are impossible or not meant to be merged.</para></listitem> - </varlistentry> - </variablelist> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>getSubOptions</varname></term> - <listitem><para>For composed types that can take a submodule as type - parameter, this function generate sub-options documentation. It takes - the current option prefix as a list and return the set of sub-options. - Usually defined in a recursive manner by adding a term to the prefix, - e.g. <literal>prefix: elemType.getSubOptions (prefix ++ - [<replaceable>"prefix"</replaceable>])</literal> where - <replaceable>"prefix"</replaceable> is the newly added - prefix.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>getSubModules</varname></term> - <listitem><para>For composed types that can take a submodule as type - parameter, this function should return the type parameters submodules. - If the type parameter is called <literal>elemType</literal>, the - function should just recursively look into submodules by returning - <literal>elemType.getSubModules;</literal>.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>substSubModules</varname></term> - <listitem><para>For composed types that can take a submodule as type - parameter, this function can be used to substitute the parameter of a - submodule type. It takes a module as parameter and return the type with - the submodule options substituted. It is usually defined as a type - function call with a recursive call to - <literal>substSubModules</literal>, e.g for a type - <literal>composedType</literal> that take an <literal>elemtype</literal> - type parameter, this function should be defined as <literal>m: - composedType (elemType.substSubModules m)</literal>.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>typeMerge</varname></term> - <listitem><para>A function to merge multiple type declarations. Takes the - type to merge <literal>functor</literal> as parameter. A - <literal>null</literal> return value means that type cannot be - merged.</para> - <variablelist> - <varlistentry> - <term><replaceable>f</replaceable></term> - <listitem><para>The type to merge - <literal>functor</literal>.</para></listitem> - </varlistentry> - </variablelist> - <para>Note: There is a generic <literal>defaultTypeMerge</literal> that - work with most of value and composed types.</para> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>functor</varname></term> - <listitem><para>An attribute set representing the type. It is used for type - operations and has the following keys:</para> - <variablelist> - <varlistentry> - <term><varname>type</varname></term> - <listitem><para>The type function.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>wrapped</varname></term> - <listitem><para>Holds the type parameter for composed types.</para> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>payload</varname></term> - <listitem><para>Holds the value parameter for value types. - The types that have a <literal>payload</literal> are the - <literal>enum</literal>, <literal>separatedString</literal> and - <literal>submodule</literal> types.</para></listitem> - </varlistentry> - <varlistentry> - <term><varname>binOp</varname></term> - <listitem><para>A binary operation that can merge the payloads of two - same types. Defined as a function that take two payloads as - parameters and return the payloads merged.</para></listitem> - </varlistentry> - </variablelist> - </listitem> - </varlistentry> -</variablelist> + <para> + Custom types can be created with the <literal>mkOptionType</literal> + function. As type creation includes some more complex topics such as + submodule handling, it is recommended to get familiar with + <filename + xlink:href="https://github.com/NixOS/nixpkgs/blob/master/lib/types.nix">types.nix</filename> + code before creating a new type. + </para> -</section> + <para> + The only required parameter is <literal>name</literal>. + </para> + + <variablelist> + <varlistentry> + <term><varname>name</varname> + </term> + <listitem> + <para> + A string representation of the type function name. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>definition</varname> + </term> + <listitem> + <para> + Description of the type used in documentation. Give information of the + type and any of its arguments. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>check</varname> + </term> + <listitem> + <para> + A function to type check the definition value. Takes the definition value + as a parameter and returns a boolean indicating the type check result, + <literal>true</literal> for success and <literal>false</literal> for + failure. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>merge</varname> + </term> + <listitem> + <para> + A function to merge multiple definitions values. Takes two parameters: + </para> + <variablelist> + <varlistentry> + <term><replaceable>loc</replaceable> + </term> + <listitem> + <para> + The option path as a list of strings, e.g. <literal>["boot" "loader + "grub" "enable"]</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><replaceable>defs</replaceable> + </term> + <listitem> + <para> + The list of sets of defined <literal>value</literal> and + <literal>file</literal> where the value was defined, e.g. <literal>[ { + file = "/foo.nix"; value = 1; } { file = "/bar.nix"; value = 2 } + ]</literal>. The <literal>merge</literal> function should return the + merged value or throw an error in case the values are impossible or + not meant to be merged. + </para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>getSubOptions</varname> + </term> + <listitem> + <para> + For composed types that can take a submodule as type parameter, this + function generate sub-options documentation. It takes the current option + prefix as a list and return the set of sub-options. Usually defined in a + recursive manner by adding a term to the prefix, e.g. <literal>prefix: + elemType.getSubOptions (prefix ++ + [<replaceable>"prefix"</replaceable>])</literal> where + <replaceable>"prefix"</replaceable> is the newly added prefix. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>getSubModules</varname> + </term> + <listitem> + <para> + For composed types that can take a submodule as type parameter, this + function should return the type parameters submodules. If the type + parameter is called <literal>elemType</literal>, the function should just + recursively look into submodules by returning + <literal>elemType.getSubModules;</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>substSubModules</varname> + </term> + <listitem> + <para> + For composed types that can take a submodule as type parameter, this + function can be used to substitute the parameter of a submodule type. It + takes a module as parameter and return the type with the submodule + options substituted. It is usually defined as a type function call with a + recursive call to <literal>substSubModules</literal>, e.g for a type + <literal>composedType</literal> that take an <literal>elemtype</literal> + type parameter, this function should be defined as <literal>m: + composedType (elemType.substSubModules m)</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>typeMerge</varname> + </term> + <listitem> + <para> + A function to merge multiple type declarations. Takes the type to merge + <literal>functor</literal> as parameter. A <literal>null</literal> return + value means that type cannot be merged. + </para> + <variablelist> + <varlistentry> + <term><replaceable>f</replaceable> + </term> + <listitem> + <para> + The type to merge <literal>functor</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + Note: There is a generic <literal>defaultTypeMerge</literal> that work + with most of value and composed types. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>functor</varname> + </term> + <listitem> + <para> + An attribute set representing the type. It is used for type operations + and has the following keys: + </para> + <variablelist> + <varlistentry> + <term><varname>type</varname> + </term> + <listitem> + <para> + The type function. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>wrapped</varname> + </term> + <listitem> + <para> + Holds the type parameter for composed types. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>payload</varname> + </term> + <listitem> + <para> + Holds the value parameter for value types. The types that have a + <literal>payload</literal> are the <literal>enum</literal>, + <literal>separatedString</literal> and <literal>submodule</literal> + types. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>binOp</varname> + </term> + <listitem> + <para> + A binary operation that can merge the payloads of two same types. + Defined as a function that take two payloads as parameters and return + the payloads merged. + </para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + </variablelist> + </section> </section> diff --git a/nixos/doc/manual/development/releases.xml b/nixos/doc/manual/development/releases.xml index afcb970ed700..d4e5ff3f4312 100755 --- a/nixos/doc/manual/development/releases.xml +++ b/nixos/doc/manual/development/releases.xml @@ -3,252 +3,258 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="ch-releases"> - -<title>Releases</title> - -<section xml:id="release-process"> + <title>Releases</title> + <section xml:id="release-process"> <title>Release process</title> <para> - Going through an example of releasing NixOS 17.09: + Going through an example of releasing NixOS 17.09: </para> <section xml:id="one-month-before-the-beta"> - <title>One month before the beta</title> - <itemizedlist spacing="compact"> - <listitem> - <para> - Send an email to the nix-devel mailinglist as a warning about upcoming beta "feature freeze" in a month. - </para> - </listitem> - <listitem> - <para> - Discuss with Eelco Dolstra and the community (via IRC, ML) about what will reach the deadline. - Any issue or Pull Request targeting the release should be included in the release milestone. - </para> - </listitem> - </itemizedlist> + <title>One month before the beta</title> + + <itemizedlist spacing="compact"> + <listitem> + <para> + Send an email to the nix-devel mailinglist as a warning about upcoming + beta "feature freeze" in a month. + </para> + </listitem> + <listitem> + <para> + Discuss with Eelco Dolstra and the community (via IRC, ML) about what + will reach the deadline. Any issue or Pull Request targeting the release + should be included in the release milestone. + </para> + </listitem> + </itemizedlist> </section> + <section xml:id="at-beta-release-time"> - <title>At beta release time</title> - <itemizedlist spacing="compact"> - <listitem> - <para> - <link xlink:href="https://github.com/NixOS/nixpkgs/issues/13559">Create - an issue for tracking Zero Hydra Failures progress. ZHF is an effort - to get build failures down to zero.</link> - </para> - </listitem> - <listitem> - <para> - <literal>git tag -a -s -m "Release 17.09-beta" 17.09-beta && git push --tags</literal> - </para> - </listitem> - <listitem> - <para> - From the master branch run <literal>git checkout -B release-17.09</literal>. - </para> - </listitem> - <listitem> - <para> - <link xlink:href="https://github.com/NixOS/nixos-org-configurations/pull/18"> - Make sure a channel is created at http://nixos.org/channels/. - </link> - </para> - </listitem> - <listitem> - <para> - <link xlink:href="https://github.com/NixOS/nixpkgs/settings/branches"> - Let a GitHub nixpkgs admin lock the branch on github for you. - (so developers can’t force push) - </link> - </para> - </listitem> - <listitem> - <para> - <link xlink:href="https://github.com/NixOS/nixpkgs/compare/bdf161ed8d21...6b63c4616790"> - Bump the <literal>system.defaultChannel</literal> attribute in - <literal>nixos/modules/misc/version.nix</literal> - </link> - </para> - </listitem> - <listitem> - <para> - <link xlink:href="https://github.com/NixOS/nixpkgs/commit/d6b08acd1ccac0d9d502c4b635e00b04d3387f06"> - Update <literal>versionSuffix</literal> in - <literal>nixos/release.nix</literal></link>, use - <literal>git log --format=%an|wc -l</literal> to get the commit - count - </para> - </listitem> - <listitem> - <para> - <literal>echo -n "18.03" > .version</literal> on - master. - </para> - </listitem> - <listitem> - <para> - <link xlink:href="https://github.com/NixOS/nixpkgs/commit/b8a4095003e27659092892a4708bb3698231a842"> - Pick a new name for the unstable branch. - </link> - </para> - </listitem> - <listitem> - <para> - Create a new release notes file for the upcoming release + 1, in this - case <literal>rl-1803.xml</literal>. - </para> - </listitem> + <title>At beta release time</title> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <link xlink:href="https://github.com/NixOS/nixpkgs/issues/13559">Create + an issue for tracking Zero Hydra Failures progress. ZHF is an effort to + get build failures down to zero.</link> + </para> + </listitem> + <listitem> + <para> + <literal>git tag -a -s -m "Release 17.09-beta" 17.09-beta + && git push --tags</literal> + </para> + </listitem> + <listitem> + <para> + From the master branch run <literal>git checkout -B + release-17.09</literal>. + </para> + </listitem> + <listitem> + <para> + <link xlink:href="https://github.com/NixOS/nixos-org-configurations/pull/18"> + Make sure a channel is created at http://nixos.org/channels/. </link> + </para> + </listitem> + <listitem> + <para> + <link xlink:href="https://github.com/NixOS/nixpkgs/settings/branches"> + Let a GitHub nixpkgs admin lock the branch on github for you. (so + developers can’t force push) </link> + </para> + </listitem> + <listitem> + <para> + <link xlink:href="https://github.com/NixOS/nixpkgs/compare/bdf161ed8d21...6b63c4616790"> + Bump the <literal>system.defaultChannel</literal> attribute in + <literal>nixos/modules/misc/version.nix</literal> </link> + </para> + </listitem> + <listitem> + <para> + <link xlink:href="https://github.com/NixOS/nixpkgs/commit/d6b08acd1ccac0d9d502c4b635e00b04d3387f06"> + Update <literal>versionSuffix</literal> in + <literal>nixos/release.nix</literal></link>, use <literal>git log + --format=%an|wc -l</literal> to get the commit count + </para> + </listitem> + <listitem> + <para> + <literal>echo -n "18.03" > .version</literal> on master. + </para> + </listitem> + <listitem> + <para> + <link xlink:href="https://github.com/NixOS/nixpkgs/commit/b8a4095003e27659092892a4708bb3698231a842"> + Pick a new name for the unstable branch. </link> + </para> + </listitem> + <listitem> + <para> + Create a new release notes file for the upcoming release + 1, in this + case <literal>rl-1803.xml</literal>. + </para> + </listitem> + <listitem> + <para> + Create two Hydra jobsets: release-17.09 and release-17.09-small with + <literal>stableBranch</literal> set to false. + </para> + </listitem> + <listitem> + <para> + Edit changelog at + <literal>nixos/doc/manual/release-notes/rl-1709.xml</literal> (double + check desktop versions are noted) + </para> + <itemizedlist spacing="compact"> <listitem> - <para> - Create two Hydra jobsets: release-17.09 and release-17.09-small with <literal>stableBranch</literal> set to false. - </para> + <para> + Get all new NixOS modules <literal>git diff + release-17.03..release-17.09 nixos/modules/module-list.nix|grep + ^+</literal> + </para> </listitem> <listitem> - <para> - Edit changelog at - <literal>nixos/doc/manual/release-notes/rl-1709.xml</literal> - (double check desktop versions are noted) - </para> - <itemizedlist spacing="compact"> - <listitem> - <para> - Get all new NixOS modules - <literal>git diff release-17.03..release-17.09 nixos/modules/module-list.nix|grep ^+</literal> - </para> - </listitem> - <listitem> - <para> - Note systemd, kernel, glibc and Nix upgrades. - </para> - </listitem> - </itemizedlist> + <para> + Note systemd, kernel, glibc and Nix upgrades. + </para> </listitem> - </itemizedlist> + </itemizedlist> + </listitem> + </itemizedlist> </section> + <section xml:id="during-beta"> - <title>During Beta</title> - <itemizedlist spacing="compact"> - <listitem> - <para> - Monitor the master branch for bugfixes and minor updates - and cherry-pick them to the release branch. - </para> - </listitem> - </itemizedlist> + <title>During Beta</title> + + <itemizedlist spacing="compact"> + <listitem> + <para> + Monitor the master branch for bugfixes and minor updates and cherry-pick + them to the release branch. + </para> + </listitem> + </itemizedlist> </section> + <section xml:id="before-the-final-release"> - <title>Before the final release</title> - <itemizedlist spacing="compact"> - <listitem> - <para> - Re-check that the release notes are complete. - </para> - </listitem> - <listitem> - <para> - Release Nix (currently only Eelco Dolstra can do that). - <link xlink:href="https://github.com/NixOS/nixpkgs/commit/53710c752a85f00658882531bc90a23a3d1287e4"> - Make sure fallback is updated. - </link> - </para> - </listitem> - <listitem> - <para> - <link xlink:href="https://github.com/NixOS/nixpkgs/commit/40fd9ae3ac8048758abdcfc7d28a78b5f22fe97e"> - Update README.md with new stable NixOS version information. - </link> - </para> - </listitem> - <listitem> - <para> - Change <literal>stableBranch</literal> to true and wait for channel to update. - </para> - </listitem> - </itemizedlist> + <title>Before the final release</title> + + <itemizedlist spacing="compact"> + <listitem> + <para> + Re-check that the release notes are complete. + </para> + </listitem> + <listitem> + <para> + Release Nix (currently only Eelco Dolstra can do that). + <link xlink:href="https://github.com/NixOS/nixpkgs/commit/53710c752a85f00658882531bc90a23a3d1287e4"> + Make sure fallback is updated. </link> + </para> + </listitem> + <listitem> + <para> + <link xlink:href="https://github.com/NixOS/nixpkgs/commit/40fd9ae3ac8048758abdcfc7d28a78b5f22fe97e"> + Update README.md with new stable NixOS version information. </link> + </para> + </listitem> + <listitem> + <para> + Change <literal>stableBranch</literal> to true and wait for channel to + update. + </para> + </listitem> + </itemizedlist> </section> + <section xml:id="at-final-release-time"> - <title>At final release time</title> - <itemizedlist spacing="compact"> - <listitem> - <para> - <literal>git tag -s -a -m "Release 15.09" 15.09</literal> - </para> - </listitem> - <listitem> - <para> - Update http://nixos.org/nixos/download.html and http://nixos.org/nixos/manual in https://github.com/NixOS/nixos-org-configurations - </para> - </listitem> - <listitem> - <para> - Get number of commits for the release: - <literal>git log release-14.04..release-14.12 --format=%an|wc -l</literal> - </para> - </listitem> - <listitem> - <para> - Commits by contributor: - <literal>git log release-14.04..release-14.12 --format=%an|sort|uniq -c|sort -rn</literal> - </para> - </listitem> - <listitem> - <para> - Send an email to nix-dev to announce the release with above information. Best to check how previous email was formulated - to see what needs to be included. - </para> - </listitem> - </itemizedlist> - </section> -</section> + <title>At final release time</title> -<section xml:id="release-schedule"> + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>git tag -s -a -m "Release 15.09" 15.09</literal> + </para> + </listitem> + <listitem> + <para> + Update http://nixos.org/nixos/download.html and + http://nixos.org/nixos/manual in + https://github.com/NixOS/nixos-org-configurations + </para> + </listitem> + <listitem> + <para> + Get number of commits for the release: <literal>git log + release-14.04..release-14.12 --format=%an|wc -l</literal> + </para> + </listitem> + <listitem> + <para> + Commits by contributor: <literal>git log release-14.04..release-14.12 + --format=%an|sort|uniq -c|sort -rn</literal> + </para> + </listitem> + <listitem> + <para> + Send an email to nix-dev to announce the release with above information. + Best to check how previous email was formulated to see what needs to be + included. + </para> + </listitem> + </itemizedlist> + </section> + </section> + <section xml:id="release-schedule"> <title>Release schedule</title> <informaltable> - <tgroup cols="2"> - <colspec align="left" /> - <colspec align="left" /> - <thead> - <row> - <entry> + <tgroup cols="2"> + <colspec align="left" /> + <colspec align="left" /> + <thead> + <row> + <entry> Date </entry> - <entry> + <entry> Event </entry> - </row> - </thead> - <tbody> - <row> - <entry> + </row> + </thead> + <tbody> + <row> + <entry> 2016-07-25 </entry> - <entry> + <entry> Send email to nix-dev about upcoming branch-off </entry> - </row> - <row> - <entry> + </row> + <row> + <entry> 2016-09-01 </entry> - <entry> - <literal>release-16.09</literal> branch and corresponding jobsets are created, + <entry><literal>release-16.09</literal> branch and corresponding jobsets are created, change freeze </entry> - </row> - <row> - <entry> + </row> + <row> + <entry> 2016-09-30 </entry> - <entry> + <entry> NixOS 16.09 released </entry> - </row> - </tbody> - </tgroup> + </row> + </tbody> + </tgroup> </informaltable> -</section> - + </section> </chapter> diff --git a/nixos/doc/manual/development/replace-modules.xml b/nixos/doc/manual/development/replace-modules.xml index cc0539ec5109..7b103c36d907 100644 --- a/nixos/doc/manual/development/replace-modules.xml +++ b/nixos/doc/manual/development/replace-modules.xml @@ -3,27 +3,31 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-replace-modules"> + <title>Replace Modules</title> -<title>Replace Modules</title> + <para> + Modules that are imported can also be disabled. The option declarations and + config implementation of a disabled module will be ignored, allowing another + to take it's place. This can be used to import a set of modules from another + channel while keeping the rest of the system on a stable release. + </para> -<para>Modules that are imported can also be disabled. The option - declarations and config implementation of a disabled module will be - ignored, allowing another to take it's place. This can be used to - import a set of modules from another channel while keeping the rest - of the system on a stable release.</para> -<para><literal>disabledModules</literal> is a top level attribute like + <para> + <literal>disabledModules</literal> is a top level attribute like <literal>imports</literal>, <literal>options</literal> and - <literal>config</literal>. It contains a list of modules that will - be disabled. This can either be the full path to the module or a - string with the filename relative to the modules path - (eg. <nixpkgs/nixos/modules> for nixos). - </para> + <literal>config</literal>. It contains a list of modules that will be + disabled. This can either be the full path to the module or a string with the + filename relative to the modules path (eg. <nixpkgs/nixos/modules> for + nixos). + </para> -<para>This example will replace the existing postgresql module with - the version defined in the nixos-unstable channel while keeping the - rest of the modules and packages from the original nixos channel. - This only overrides the module definition, this won't use postgresql - from nixos-unstable unless explicitly configured to do so.</para> + <para> + This example will replace the existing postgresql module with the version + defined in the nixos-unstable channel while keeping the rest of the modules + and packages from the original nixos channel. This only overrides the module + definition, this won't use postgresql from nixos-unstable unless explicitly + configured to do so. + </para> <programlisting> { config, lib, pkgs, ... }: @@ -41,10 +45,11 @@ } </programlisting> -<para>This example shows how to define a custom module as a - replacement for an existing module. Importing this module will - disable the original module without having to know it's - implementation details.</para> + <para> + This example shows how to define a custom module as a replacement for an + existing module. Importing this module will disable the original module + without having to know it's implementation details. + </para> <programlisting> { config, lib, pkgs, ... }: @@ -71,5 +76,4 @@ in }; } </programlisting> - </section> diff --git a/nixos/doc/manual/development/running-nixos-tests-interactively.xml b/nixos/doc/manual/development/running-nixos-tests-interactively.xml index e47490777815..862b364a6d79 100644 --- a/nixos/doc/manual/development/running-nixos-tests-interactively.xml +++ b/nixos/doc/manual/development/running-nixos-tests-interactively.xml @@ -3,41 +3,38 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-running-nixos-tests"> -<title>Running Tests interactively</title> - -<para>The test itself can be run interactively. This is -particularly useful when developing or debugging a test: + <title>Running Tests interactively</title> + <para> + The test itself can be run interactively. This is particularly useful when + developing or debugging a test: <screen> $ nix-build nixos/tests/login.nix -A driver $ ./result/bin/nixos-test-driver starting VDE switch for network 1 > </screen> - -You can then take any Perl statement, e.g. - + You can then take any Perl statement, e.g. <screen> > startAll > testScript > $machine->succeed("touch /tmp/foo") </screen> - -The function <command>testScript</command> executes the entire test -script and drops you back into the test driver command line upon its -completion. This allows you to inspect the state of the VMs after the -test (e.g. to debug the test script).</para> - -<para>To just start and experiment with the VMs, run: - + The function <command>testScript</command> executes the entire test script + and drops you back into the test driver command line upon its completion. + This allows you to inspect the state of the VMs after the test (e.g. to debug + the test script). + </para> + + <para> + To just start and experiment with the VMs, run: <screen> $ nix-build nixos/tests/login.nix -A driver $ ./result/bin/nixos-run-vms </screen> - -The script <command>nixos-run-vms</command> starts the virtual -machines defined by test. The root file system of the VMs is created -on the fly and kept across VM restarts in -<filename>./</filename><varname>hostname</varname><filename>.qcow2</filename>.</para> - + The script <command>nixos-run-vms</command> starts the virtual machines + defined by test. The root file system of the VMs is created on the fly and + kept across VM restarts in + <filename>./</filename><varname>hostname</varname><filename>.qcow2</filename>. + </para> </section> diff --git a/nixos/doc/manual/development/running-nixos-tests.xml b/nixos/doc/manual/development/running-nixos-tests.xml index 908c0a66a32d..eadbe1ea4f26 100644 --- a/nixos/doc/manual/development/running-nixos-tests.xml +++ b/nixos/doc/manual/development/running-nixos-tests.xml @@ -3,20 +3,18 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-running-nixos-tests-interactively"> + <title>Running Tests</title> -<title>Running Tests</title> - -<para>You can run tests using <command>nix-build</command>. For -example, to run the test <filename + <para> + You can run tests using <command>nix-build</command>. For example, to run the + test + <filename xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/login.nix">login.nix</filename>, -you just do: - + you just do: <screen> $ nix-build '<nixpkgs/nixos/tests/login.nix>' </screen> - -or, if you don’t want to rely on <envar>NIX_PATH</envar>: - + or, if you don’t want to rely on <envar>NIX_PATH</envar>: <screen> $ cd /my/nixpkgs/nixos/tests $ nix-build login.nix @@ -26,16 +24,13 @@ machine: QEMU running (pid 8841) … 6 out of 6 tests succeeded </screen> - -After building/downloading all required dependencies, this will -perform a build that starts a QEMU/KVM virtual machine containing a -NixOS system. The virtual machine mounts the Nix store of the host; -this makes VM creation very fast, as no disk image needs to be -created. Afterwards, you can view a pretty-printed log of the test: - + After building/downloading all required dependencies, this will perform a + build that starts a QEMU/KVM virtual machine containing a NixOS system. The + virtual machine mounts the Nix store of the host; this makes VM creation very + fast, as no disk image needs to be created. Afterwards, you can view a + pretty-printed log of the test: <screen> $ firefox result/log.html </screen> - -</para> + </para> </section> diff --git a/nixos/doc/manual/development/sources.xml b/nixos/doc/manual/development/sources.xml index a2896cd7a135..c7b64cb84beb 100644 --- a/nixos/doc/manual/development/sources.xml +++ b/nixos/doc/manual/development/sources.xml @@ -3,101 +3,84 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-getting-sources"> - -<title>Getting the Sources</title> - -<para>By default, NixOS’s <command>nixos-rebuild</command> command -uses the NixOS and Nixpkgs sources provided by the -<literal>nixos</literal> channel (kept in -<filename>/nix/var/nix/profiles/per-user/root/channels/nixos</filename>). -To modify NixOS, however, you should check out the latest sources from -Git. This is as follows: - + <title>Getting the Sources</title> + <para> + By default, NixOS’s <command>nixos-rebuild</command> command uses the NixOS + and Nixpkgs sources provided by the <literal>nixos</literal> channel (kept in + <filename>/nix/var/nix/profiles/per-user/root/channels/nixos</filename>). To + modify NixOS, however, you should check out the latest sources from Git. This + is as follows: <screen> $ git clone git://github.com/NixOS/nixpkgs.git $ cd nixpkgs $ git remote add channels git://github.com/NixOS/nixpkgs-channels.git $ git remote update channels </screen> - -This will check out the latest Nixpkgs sources to -<filename>./nixpkgs</filename> the NixOS sources to -<filename>./nixpkgs/nixos</filename>. (The NixOS source tree lives in -a subdirectory of the Nixpkgs repository.) The remote -<literal>channels</literal> refers to a read-only repository that -tracks the Nixpkgs/NixOS channels (see <xref linkend="sec-upgrading"/> -for more information about channels). Thus, the Git branch -<literal>channels/nixos-17.03</literal> will contain the latest built -and tested version available in the <literal>nixos-17.03</literal> -channel.</para> - -<para>It’s often inconvenient to develop directly on the master -branch, since if somebody has just committed (say) a change to GCC, -then the binary cache may not have caught up yet and you’ll have to -rebuild everything from source. So you may want to create a local -branch based on your current NixOS version: - + This will check out the latest Nixpkgs sources to + <filename>./nixpkgs</filename> the NixOS sources to + <filename>./nixpkgs/nixos</filename>. (The NixOS source tree lives in a + subdirectory of the Nixpkgs repository.) The remote + <literal>channels</literal> refers to a read-only repository that tracks the + Nixpkgs/NixOS channels (see <xref linkend="sec-upgrading"/> for more + information about channels). Thus, the Git branch + <literal>channels/nixos-17.03</literal> will contain the latest built and + tested version available in the <literal>nixos-17.03</literal> channel. + </para> + <para> + It’s often inconvenient to develop directly on the master branch, since if + somebody has just committed (say) a change to GCC, then the binary cache may + not have caught up yet and you’ll have to rebuild everything from source. + So you may want to create a local branch based on your current NixOS version: <screen> $ nixos-version 17.09pre104379.6e0b727 (Hummingbird) $ git checkout -b local 6e0b727 </screen> - -Or, to base your local branch on the latest version available in a -NixOS channel: - + Or, to base your local branch on the latest version available in a NixOS + channel: <screen> $ git remote update channels $ git checkout -b local channels/nixos-17.03 </screen> - -(Replace <literal>nixos-17.03</literal> with the name of the channel -you want to use.) You can use <command>git merge</command> or -<command>git rebase</command> to keep your local branch in sync with -the channel, e.g. - + (Replace <literal>nixos-17.03</literal> with the name of the channel you want + to use.) You can use <command>git merge</command> or <command>git + rebase</command> to keep your local branch in sync with the channel, e.g. <screen> $ git remote update channels $ git merge channels/nixos-17.03 </screen> - -You can use <command>git cherry-pick</command> to copy commits from -your local branch to the upstream branch.</para> - -<para>If you want to rebuild your system using your (modified) -sources, you need to tell <command>nixos-rebuild</command> about them -using the <option>-I</option> flag: - + You can use <command>git cherry-pick</command> to copy commits from your + local branch to the upstream branch. + </para> + <para> + If you want to rebuild your system using your (modified) sources, you need to + tell <command>nixos-rebuild</command> about them using the + <option>-I</option> flag: <screen> # nixos-rebuild switch -I nixpkgs=<replaceable>/my/sources</replaceable>/nixpkgs </screen> - -</para> - -<para>If you want <command>nix-env</command> to use the expressions in -<replaceable>/my/sources</replaceable>, use <command>nix-env -f -<replaceable>/my/sources</replaceable>/nixpkgs</command>, or change -the default by adding a symlink in -<filename>~/.nix-defexpr</filename>: - + </para> + <para> + If you want <command>nix-env</command> to use the expressions in + <replaceable>/my/sources</replaceable>, use <command>nix-env -f + <replaceable>/my/sources</replaceable>/nixpkgs</command>, or change the + default by adding a symlink in <filename>~/.nix-defexpr</filename>: <screen> $ ln -s <replaceable>/my/sources</replaceable>/nixpkgs ~/.nix-defexpr/nixpkgs </screen> - -You may want to delete the symlink -<filename>~/.nix-defexpr/channels_root</filename> to prevent root’s -NixOS channel from clashing with your own tree (this may break the -command-not-found utility though). If you want to go back to the default -state, you may just remove the <filename>~/.nix-defexpr</filename> -directory completely, log out and log in again and it should have been -recreated with a link to the root channels.</para> - + You may want to delete the symlink + <filename>~/.nix-defexpr/channels_root</filename> to prevent root’s NixOS + channel from clashing with your own tree (this may break the + command-not-found utility though). If you want to go back to the default + state, you may just remove the <filename>~/.nix-defexpr</filename> directory + completely, log out and log in again and it should have been recreated with a + link to the root channels. + </para> <!-- FIXME: not sure what this means. <para>You should not pass the base directory <filename><replaceable>/my/sources</replaceable></filename> to <command>nix-env</command>, as it will break after interpreting expressions in <filename>nixos/</filename> as packages.</para> --> - </chapter> diff --git a/nixos/doc/manual/development/testing-installer.xml b/nixos/doc/manual/development/testing-installer.xml index 16bc8125d9ff..63f5f3de7f4d 100644 --- a/nixos/doc/manual/development/testing-installer.xml +++ b/nixos/doc/manual/development/testing-installer.xml @@ -3,27 +3,20 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="ch-testing-installer"> - -<title>Testing the Installer</title> - -<para>Building, burning, and booting from an installation CD is rather -tedious, so here is a quick way to see if the installer works -properly: - + <title>Testing the Installer</title> + <para> + Building, burning, and booting from an installation CD is rather tedious, so + here is a quick way to see if the installer works properly: <screen> # mount -t tmpfs none /mnt # nixos-generate-config --root /mnt $ nix-build '<nixpkgs/nixos>' -A config.system.build.nixos-install # ./result/bin/nixos-install</screen> - -To start a login shell in the new NixOS installation in -<filename>/mnt</filename>: - + To start a login shell in the new NixOS installation in + <filename>/mnt</filename>: <screen> $ nix-build '<nixpkgs/nixos>' -A config.system.build.nixos-enter # ./result/bin/nixos-enter </screen> - -</para> - + </para> </chapter> diff --git a/nixos/doc/manual/development/writing-documentation.xml b/nixos/doc/manual/development/writing-documentation.xml index 8b787fae1fe0..8ecdd1c770f2 100644 --- a/nixos/doc/manual/development/writing-documentation.xml +++ b/nixos/doc/manual/development/writing-documentation.xml @@ -3,157 +3,147 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-writing-documentation"> - -<title>Writing NixOS Documentation</title> - -<para> - As NixOS grows, so too does the need for a catalogue and explanation - of its extensive functionality. Collecting pertinent information - from disparate sources and presenting it in an accessible style - would be a worthy contribution to the project. -</para> - -<section> -<title>Building the Manual</title> -<para> - The DocBook sources of the <xref linkend="book-nixos-manual"/> are in the - <link xlink:href="https://github.com/NixOS/nixpkgs/tree/master/nixos/doc/manual"><filename>nixos/doc/manual</filename></link> - subdirectory of the Nixpkgs repository. -</para> - -<para> - You can quickly validate your edits with <command>make</command>: -</para> + <title>Writing NixOS Documentation</title> + <para> + As NixOS grows, so too does the need for a catalogue and explanation of its + extensive functionality. Collecting pertinent information from disparate + sources and presenting it in an accessible style would be a worthy + contribution to the project. + </para> + <section> + <title>Building the Manual</title> + + <para> + The DocBook sources of the <xref linkend="book-nixos-manual"/> are in the + <link xlink:href="https://github.com/NixOS/nixpkgs/tree/master/nixos/doc/manual"><filename>nixos/doc/manual</filename></link> + subdirectory of the Nixpkgs repository. + </para> + + <para> + You can quickly validate your edits with <command>make</command>: + </para> <screen> $ cd /path/to/nixpkgs/nixos/doc/manual $ make </screen> -<para> - Once you are done making modifications to the manual, it's important - to build it before committing. You can do that as follows: -</para> + <para> + Once you are done making modifications to the manual, it's important to + build it before committing. You can do that as follows: + </para> <screen>nix-build nixos/release.nix -A manual.x86_64-linux</screen> -<para> - When this command successfully finishes, it will tell you where the - manual got generated. The HTML will be accessible through the - <filename>result</filename> symlink at - <filename>./result/share/doc/nixos/index.html</filename>. -</para> -</section> - -<section> -<title>Editing DocBook XML</title> - -<para> - For general information on how to write in DocBook, see - <link xlink:href="http://www.docbook.org/tdg5/en/html/docbook.html"> - DocBook 5: The Definitive Guide</link>. -</para> - -<para> - Emacs nXML Mode is very helpful for editing DocBook XML because it - validates the document as you write, and precisely locates - errors. To use it, see <xref linkend="sec-emacs-docbook-xml"/>. -</para> - -<para> - <link xlink:href="http://pandoc.org">Pandoc</link> can generate - DocBook XML from a multitude of formats, which makes a good starting - point. - - <example xml:id="ex-pandoc-xml-conv"> + <para> + When this command successfully finishes, it will tell you where the manual + got generated. The HTML will be accessible through the + <filename>result</filename> symlink at + <filename>./result/share/doc/nixos/index.html</filename>. + </para> + </section> + <section> + <title>Editing DocBook XML</title> + + <para> + For general information on how to write in DocBook, see + <link xlink:href="http://www.docbook.org/tdg5/en/html/docbook.html"> DocBook + 5: The Definitive Guide</link>. + </para> + + <para> + Emacs nXML Mode is very helpful for editing DocBook XML because it validates + the document as you write, and precisely locates errors. To use it, see + <xref linkend="sec-emacs-docbook-xml"/>. + </para> + + <para> + <link xlink:href="http://pandoc.org">Pandoc</link> can generate DocBook XML + from a multitude of formats, which makes a good starting point. + <example xml:id="ex-pandoc-xml-conv"> <title>Pandoc invocation to convert GitHub-Flavoured MarkDown to DocBook 5 XML</title> - <screen>pandoc -f markdown_github -t docbook5 docs.md -o my-section.md</screen> - </example> - - Pandoc can also quickly convert a single - <filename>section.xml</filename> to HTML, which is helpful when - drafting. -</para> - -<para> - Sometimes writing valid DocBook is simply too difficult. In this - case, submit your documentation updates in a <link +<screen>pandoc -f markdown_github -t docbook5 docs.md -o my-section.md</screen> + </example> + Pandoc can also quickly convert a single <filename>section.xml</filename> to + HTML, which is helpful when drafting. + </para> + + <para> + Sometimes writing valid DocBook is simply too difficult. In this case, + submit your documentation updates in a + <link xlink:href="https://github.com/NixOS/nixpkgs/issues/new">GitHub - Issue</link> and someone will handle the conversion to XML for you. -</para> -</section> - -<section> -<title>Creating a Topic</title> - -<para> - You can use an existing topic as a basis for the new topic or create a topic from scratch. -</para> - -<para> -Keep the following guidelines in mind when you create and add a topic: - -<itemizedlist> - <listitem><para> - The NixOS <link xlink:href="http://www.docbook.org/tdg5/en/html/book.html"><tag>book</tag></link> - element is in <filename>nixos/doc/manual/manual.xml</filename>. - It includes several - <link xlink:href="http://www.docbook.org/tdg5/en/html/book.html"><tag>part</tag>s</link> - which are in subdirectories. - </para></listitem> - - <listitem><para> - Store the topic file in the same directory as the <tag>part</tag> - to which it belongs. If your topic is about configuring a NixOS - module, then the XML file can be stored alongside the module - definition <filename>nix</filename> file. - </para></listitem> - - <listitem><para> - If you include multiple words in the file name, separate the words - with a dash. For example: <filename>ipv6-config.xml</filename>. - </para></listitem> - - <listitem><para> - Make sure that the <tag>xml:id</tag> value is unique. You can use - abbreviations if the ID is too long. For example: - <varname>nixos-config</varname>. - </para></listitem> - - <listitem><para> - Determine whether your topic is a chapter or a section. If you are - unsure, open an existing topic file and check whether the main - element is chapter or section. - </para></listitem> - -</itemizedlist> - -</para> -</section> - -<section> -<title>Adding a Topic to the Book</title> - -<para> - Open the parent XML file and add an <varname>xi:include</varname> - element to the list of chapters with the file name of the topic that - you created. If you created a <tag>section</tag>, you add the file to - the <tag>chapter</tag> file. If you created a <tag>chapter</tag>, you - add the file to the <tag>part</tag> file. -</para> - -<para> - If the topic is about configuring a NixOS module, it can be - automatically included in the manual by using the - <varname>meta.doc</varname> attribute. See <xref + Issue</link> and someone will handle the conversion to XML for you. + </para> + </section> + <section> + <title>Creating a Topic</title> + + <para> + You can use an existing topic as a basis for the new topic or create a topic + from scratch. + </para> + + <para> + Keep the following guidelines in mind when you create and add a topic: + <itemizedlist> + <listitem> + <para> + The NixOS + <link xlink:href="http://www.docbook.org/tdg5/en/html/book.html"><tag>book</tag></link> + element is in <filename>nixos/doc/manual/manual.xml</filename>. It + includes several + <link xlink:href="http://www.docbook.org/tdg5/en/html/book.html"><tag>part</tag>s</link> + which are in subdirectories. + </para> + </listitem> + <listitem> + <para> + Store the topic file in the same directory as the <tag>part</tag> to + which it belongs. If your topic is about configuring a NixOS module, then + the XML file can be stored alongside the module definition + <filename>nix</filename> file. + </para> + </listitem> + <listitem> + <para> + If you include multiple words in the file name, separate the words with a + dash. For example: <filename>ipv6-config.xml</filename>. + </para> + </listitem> + <listitem> + <para> + Make sure that the <tag>xml:id</tag> value is unique. You can use + abbreviations if the ID is too long. For example: + <varname>nixos-config</varname>. + </para> + </listitem> + <listitem> + <para> + Determine whether your topic is a chapter or a section. If you are + unsure, open an existing topic file and check whether the main element is + chapter or section. + </para> + </listitem> + </itemizedlist> + </para> + </section> + <section> + <title>Adding a Topic to the Book</title> + + <para> + Open the parent XML file and add an <varname>xi:include</varname> element to + the list of chapters with the file name of the topic that you created. If + you created a <tag>section</tag>, you add the file to the <tag>chapter</tag> + file. If you created a <tag>chapter</tag>, you add the file to the + <tag>part</tag> file. + </para> + + <para> + If the topic is about configuring a NixOS module, it can be automatically + included in the manual by using the <varname>meta.doc</varname> attribute. + See <xref linkend="sec-meta-attributes"/> for an explanation. -</para> - -</section> - - - - - - + </para> + </section> </chapter> diff --git a/nixos/doc/manual/development/writing-modules.xml b/nixos/doc/manual/development/writing-modules.xml index a49f99cb2669..bbf793bb0be9 100644 --- a/nixos/doc/manual/development/writing-modules.xml +++ b/nixos/doc/manual/development/writing-modules.xml @@ -3,52 +3,54 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-writing-modules"> - -<title>Writing NixOS Modules</title> - -<para>NixOS has a modular system for declarative configuration. This -system combines multiple <emphasis>modules</emphasis> to produce the -full system configuration. One of the modules that constitute the -configuration is <filename>/etc/nixos/configuration.nix</filename>. -Most of the others live in the <link + <title>Writing NixOS Modules</title> + <para> + NixOS has a modular system for declarative configuration. This system + combines multiple <emphasis>modules</emphasis> to produce the full system + configuration. One of the modules that constitute the configuration is + <filename>/etc/nixos/configuration.nix</filename>. Most of the others live in + the + <link xlink:href="https://github.com/NixOS/nixpkgs/tree/master/nixos/modules"><filename>nixos/modules</filename></link> -subdirectory of the Nixpkgs tree.</para> - -<para>Each NixOS module is a file that handles one logical aspect of -the configuration, such as a specific kind of hardware, a service, or -network settings. A module configuration does not have to handle -everything from scratch; it can use the functionality provided by -other modules for its implementation. Thus a module can -<emphasis>declare</emphasis> options that can be used by other -modules, and conversely can <emphasis>define</emphasis> options -provided by other modules in its own implementation. For example, the -module <link + subdirectory of the Nixpkgs tree. + </para> + <para> + Each NixOS module is a file that handles one logical aspect of the + configuration, such as a specific kind of hardware, a service, or network + settings. A module configuration does not have to handle everything from + scratch; it can use the functionality provided by other modules for its + implementation. Thus a module can <emphasis>declare</emphasis> options that + can be used by other modules, and conversely can <emphasis>define</emphasis> + options provided by other modules in its own implementation. For example, the + module + <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/security/pam.nix"><filename>pam.nix</filename></link> -declares the option <option>security.pam.services</option> that allows -other modules (e.g. <link + declares the option <option>security.pam.services</option> that allows other + modules (e.g. + <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/services/networking/ssh/sshd.nix"><filename>sshd.nix</filename></link>) -to define PAM services; and it defines the option -<option>environment.etc</option> (declared by <link + to define PAM services; and it defines the option + <option>environment.etc</option> (declared by + <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/system/etc/etc.nix"><filename>etc.nix</filename></link>) -to cause files to be created in -<filename>/etc/pam.d</filename>.</para> - -<para xml:id="para-module-syn">In <xref + to cause files to be created in <filename>/etc/pam.d</filename>. + </para> + <para xml:id="para-module-syn"> + In <xref linkend="sec-configuration-syntax"/>, we saw the following structure -of NixOS modules: - + of NixOS modules: <programlisting> { config, pkgs, ... }: { <replaceable>option definitions</replaceable> } </programlisting> - -This is actually an <emphasis>abbreviated</emphasis> form of module -that only defines options, but does not declare any. The structure of -full NixOS modules is shown in <xref linkend='ex-module-syntax' />.</para> - -<example xml:id='ex-module-syntax'><title>Structure of NixOS Modules</title> + This is actually an <emphasis>abbreviated</emphasis> form of module that only + defines options, but does not declare any. The structure of full NixOS + modules is shown in <xref linkend='ex-module-syntax' />. + </para> + <example xml:id='ex-module-syntax'> + <title>Structure of NixOS Modules</title> <programlisting> { config, pkgs, ... }: <co xml:id='module-syntax-1' /> @@ -65,56 +67,56 @@ full NixOS modules is shown in <xref linkend='ex-module-syntax' />.</para> <replaceable>option definitions</replaceable> <co xml:id='module-syntax-4' /> }; }</programlisting> -</example> - -<para>The meaning of each part is as follows. - -<calloutlist> - <callout arearefs='module-syntax-1'> - <para>This line makes the current Nix expression a function. The - variable <varname>pkgs</varname> contains Nixpkgs, while - <varname>config</varname> contains the full system configuration. - This line can be omitted if there is no reference to - <varname>pkgs</varname> and <varname>config</varname> inside the - module.</para> - </callout> - - <callout arearefs='module-syntax-2'> - <para>This list enumerates the paths to other NixOS modules that - should be included in the evaluation of the system configuration. - A default set of modules is defined in the file - <filename>modules/module-list.nix</filename>. These don't need to - be added in the import list.</para> - </callout> - - <callout arearefs='module-syntax-3'> - <para>The attribute <varname>options</varname> is a nested set of - <emphasis>option declarations</emphasis> (described below).</para> - </callout> - - <callout arearefs='module-syntax-4'> - <para>The attribute <varname>config</varname> is a nested set of - <emphasis>option definitions</emphasis> (also described - below).</para> - </callout> -</calloutlist> - -</para> - -<para><xref linkend='locate-example' /> shows a module that handles -the regular update of the “locate” database, an index of all files in -the file system. This module declares two options that can be defined -by other modules (typically the user’s -<filename>configuration.nix</filename>): -<option>services.locate.enable</option> (whether the database should -be updated) and <option>services.locate.interval</option> (when the -update should be done). It implements its functionality by defining -two options declared by other modules: -<option>systemd.services</option> (the set of all systemd services) -and <option>systemd.timers</option> (the list of commands to be -executed periodically by <command>systemd</command>).</para> - -<example xml:id='locate-example'><title>NixOS Module for the “locate” Service</title> + </example> + <para> + The meaning of each part is as follows. + <calloutlist> + <callout arearefs='module-syntax-1'> + <para> + This line makes the current Nix expression a function. The variable + <varname>pkgs</varname> contains Nixpkgs, while <varname>config</varname> + contains the full system configuration. This line can be omitted if there + is no reference to <varname>pkgs</varname> and <varname>config</varname> + inside the module. + </para> + </callout> + <callout arearefs='module-syntax-2'> + <para> + This list enumerates the paths to other NixOS modules that should be + included in the evaluation of the system configuration. A default set of + modules is defined in the file + <filename>modules/module-list.nix</filename>. These don't need to be added + in the import list. + </para> + </callout> + <callout arearefs='module-syntax-3'> + <para> + The attribute <varname>options</varname> is a nested set of + <emphasis>option declarations</emphasis> (described below). + </para> + </callout> + <callout arearefs='module-syntax-4'> + <para> + The attribute <varname>config</varname> is a nested set of + <emphasis>option definitions</emphasis> (also described below). + </para> + </callout> + </calloutlist> + </para> + <para> + <xref linkend='locate-example' /> shows a module that handles the regular + update of the “locate” database, an index of all files in the file + system. This module declares two options that can be defined by other modules + (typically the user’s <filename>configuration.nix</filename>): + <option>services.locate.enable</option> (whether the database should be + updated) and <option>services.locate.interval</option> (when the update + should be done). It implements its functionality by defining two options + declared by other modules: <option>systemd.services</option> (the set of all + systemd services) and <option>systemd.timers</option> (the list of commands + to be executed periodically by <command>systemd</command>). + </para> + <example xml:id='locate-example'> + <title>NixOS Module for the “locate” Service</title> <programlisting> { config, lib, pkgs, ... }: @@ -173,14 +175,12 @@ in { }; } </programlisting> -</example> - -<xi:include href="option-declarations.xml" /> -<xi:include href="option-types.xml" /> -<xi:include href="option-def.xml" /> -<xi:include href="assertions.xml" /> -<xi:include href="meta-attributes.xml" /> -<xi:include href="importing-modules.xml" /> -<xi:include href="replace-modules.xml" /> - + </example> + <xi:include href="option-declarations.xml" /> + <xi:include href="option-types.xml" /> + <xi:include href="option-def.xml" /> + <xi:include href="assertions.xml" /> + <xi:include href="meta-attributes.xml" /> + <xi:include href="importing-modules.xml" /> + <xi:include href="replace-modules.xml" /> </chapter> diff --git a/nixos/doc/manual/development/writing-nixos-tests.xml b/nixos/doc/manual/development/writing-nixos-tests.xml index a8f6aa00858e..89a6a4423627 100644 --- a/nixos/doc/manual/development/writing-nixos-tests.xml +++ b/nixos/doc/manual/development/writing-nixos-tests.xml @@ -3,11 +3,10 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-writing-nixos-tests"> + <title>Writing Tests</title> -<title>Writing Tests</title> - -<para>A NixOS test is a Nix expression that has the following structure: - + <para> + A NixOS test is a Nix expression that has the following structure: <programlisting> import ./make-test.nix { @@ -32,277 +31,364 @@ import ./make-test.nix { ''; } </programlisting> - -The attribute <literal>testScript</literal> is a bit of Perl code that -executes the test (described below). During the test, it will start -one or more virtual machines, the configuration of which is described -by the attribute <literal>machine</literal> (if you need only one -machine in your test) or by the attribute <literal>nodes</literal> (if -you need multiple machines). For instance, <filename + The attribute <literal>testScript</literal> is a bit of Perl code that + executes the test (described below). During the test, it will start one or + more virtual machines, the configuration of which is described by the + attribute <literal>machine</literal> (if you need only one machine in your + test) or by the attribute <literal>nodes</literal> (if you need multiple + machines). For instance, + <filename xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/login.nix">login.nix</filename> -only needs a single machine to test whether users can log in on the -virtual console, whether device ownership is correctly maintained when -switching between consoles, and so on. On the other hand, <filename + only needs a single machine to test whether users can log in on the virtual + console, whether device ownership is correctly maintained when switching + between consoles, and so on. On the other hand, + <filename xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/nfs.nix">nfs.nix</filename>, -which tests NFS client and server functionality in the Linux kernel -(including whether locks are maintained across server crashes), -requires three machines: a server and two clients.</para> - -<para>There are a few special NixOS configuration options for test -VMs: + which tests NFS client and server functionality in the Linux kernel + (including whether locks are maintained across server crashes), requires + three machines: a server and two clients. + </para> + <para> + There are a few special NixOS configuration options for test VMs: <!-- FIXME: would be nice to generate this automatically. --> - -<variablelist> - - <varlistentry> - <term><option>virtualisation.memorySize</option></term> - <listitem><para>The memory of the VM in - megabytes.</para></listitem> - </varlistentry> - - <varlistentry> - <term><option>virtualisation.vlans</option></term> - <listitem><para>The virtual networks to which the VM is - connected. See <filename + <variablelist> + <varlistentry> + <term><option>virtualisation.memorySize</option> + </term> + <listitem> + <para> + The memory of the VM in megabytes. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>virtualisation.vlans</option> + </term> + <listitem> + <para> + The virtual networks to which the VM is connected. See + <filename xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/nat.nix">nat.nix</filename> - for an example.</para></listitem> - </varlistentry> - - <varlistentry> - <term><option>virtualisation.writableStore</option></term> - <listitem><para>By default, the Nix store in the VM is not - writable. If you enable this option, a writable union file system - is mounted on top of the Nix store to make it appear - writable. This is necessary for tests that run Nix operations that - modify the store.</para></listitem> - </varlistentry> - -</variablelist> - -For more options, see the module <filename -xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/virtualisation/qemu-vm.nix">qemu-vm.nix</filename>.</para> - -<para>The test script is a sequence of Perl statements that perform -various actions, such as starting VMs, executing commands in the VMs, -and so on. Each virtual machine is represented as an object stored in -the variable <literal>$<replaceable>name</replaceable></literal>, -where <replaceable>name</replaceable> is the identifier of the machine -(which is just <literal>machine</literal> if you didn’t specify -multiple machines using the <literal>nodes</literal> attribute). For -instance, the following starts the machine, waits until it has -finished booting, then executes a command and checks that the output -is more-or-less correct: - + for an example. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>virtualisation.writableStore</option> + </term> + <listitem> + <para> + By default, the Nix store in the VM is not writable. If you enable this + option, a writable union file system is mounted on top of the Nix store + to make it appear writable. This is necessary for tests that run Nix + operations that modify the store. + </para> + </listitem> + </varlistentry> + </variablelist> + For more options, see the module + <filename +xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/virtualisation/qemu-vm.nix">qemu-vm.nix</filename>. + </para> + + <para> + The test script is a sequence of Perl statements that perform various + actions, such as starting VMs, executing commands in the VMs, and so on. Each + virtual machine is represented as an object stored in the variable + <literal>$<replaceable>name</replaceable></literal>, where + <replaceable>name</replaceable> is the identifier of the machine (which is + just <literal>machine</literal> if you didn’t specify multiple machines + using the <literal>nodes</literal> attribute). For instance, the following + starts the machine, waits until it has finished booting, then executes a + command and checks that the output is more-or-less correct: <programlisting> $machine->start; $machine->waitForUnit("default.target"); $machine->succeed("uname") =~ /Linux/; </programlisting> - -The first line is actually unnecessary; machines are implicitly -started when you first execute an action on them (such as -<literal>waitForUnit</literal> or <literal>succeed</literal>). If you -have multiple machines, you can speed up the test by starting them in -parallel: - + The first line is actually unnecessary; machines are implicitly started when + you first execute an action on them (such as <literal>waitForUnit</literal> + or <literal>succeed</literal>). If you have multiple machines, you can speed + up the test by starting them in parallel: <programlisting> startAll; </programlisting> - -</para> - -<para>The following methods are available on machine objects: - -<variablelist> - - <varlistentry> - <term><methodname>start</methodname></term> - <listitem><para>Start the virtual machine. This method is - asynchronous — it does not wait for the machine to finish - booting.</para></listitem> - </varlistentry> - - <varlistentry> - <term><methodname>shutdown</methodname></term> - <listitem><para>Shut down the machine, waiting for the VM to - exit.</para></listitem> - </varlistentry> - - <varlistentry> - <term><methodname>crash</methodname></term> - <listitem><para>Simulate a sudden power failure, by telling the VM - to exit immediately.</para></listitem> - </varlistentry> - - <varlistentry> - <term><methodname>block</methodname></term> - <listitem><para>Simulate unplugging the Ethernet cable that - connects the machine to the other machines.</para></listitem> - </varlistentry> - - <varlistentry> - <term><methodname>unblock</methodname></term> - <listitem><para>Undo the effect of - <methodname>block</methodname>.</para></listitem> - </varlistentry> - - <varlistentry> - <term><methodname>screenshot</methodname></term> - <listitem><para>Take a picture of the display of the virtual - machine, in PNG format. The screenshot is linked from the HTML - log.</para></listitem> - </varlistentry> - - <varlistentry> - <term><methodname>getScreenText</methodname></term> - <listitem><para>Return a textual representation of what is currently - visible on the machine's screen using optical character - recognition.</para> - <note><para>This requires passing <option>enableOCR</option> to the test - attribute set.</para></note></listitem> - </varlistentry> - - <varlistentry> - <term><methodname>sendMonitorCommand</methodname></term> - <listitem><para>Send a command to the QEMU monitor. This is rarely - used, but allows doing stuff such as attaching virtual USB disks - to a running machine.</para></listitem> - </varlistentry> - - <varlistentry> - <term><methodname>sendKeys</methodname></term> - <listitem><para>Simulate pressing keys on the virtual keyboard, - e.g., <literal>sendKeys("ctrl-alt-delete")</literal>.</para></listitem> - </varlistentry> - - <varlistentry> - <term><methodname>sendChars</methodname></term> - <listitem><para>Simulate typing a sequence of characters on the - virtual keyboard, e.g., <literal>sendKeys("foobar\n")</literal> - will type the string <literal>foobar</literal> followed by the - Enter key.</para></listitem> - </varlistentry> - - <varlistentry> - <term><methodname>execute</methodname></term> - <listitem><para>Execute a shell command, returning a list - <literal>(<replaceable>status</replaceable>, - <replaceable>stdout</replaceable>)</literal>.</para></listitem> - </varlistentry> - - <varlistentry> - <term><methodname>succeed</methodname></term> - <listitem><para>Execute a shell command, raising an exception if - the exit status is not zero, otherwise returning the standard - output.</para></listitem> - </varlistentry> - - <varlistentry> - <term><methodname>fail</methodname></term> - <listitem><para>Like <methodname>succeed</methodname>, but raising - an exception if the command returns a zero status.</para></listitem> - </varlistentry> - - <varlistentry> - <term><methodname>waitUntilSucceeds</methodname></term> - <listitem><para>Repeat a shell command with 1-second intervals - until it succeeds.</para></listitem> - </varlistentry> - - <varlistentry> - <term><methodname>waitUntilFails</methodname></term> - <listitem><para>Repeat a shell command with 1-second intervals - until it fails.</para></listitem> - </varlistentry> - - <varlistentry> - <term><methodname>waitForUnit</methodname></term> - <listitem><para>Wait until the specified systemd unit has reached - the “active” state.</para></listitem> - </varlistentry> - - <varlistentry> - <term><methodname>waitForFile</methodname></term> - <listitem><para>Wait until the specified file - exists.</para></listitem> - </varlistentry> - - <varlistentry> - <term><methodname>waitForOpenPort</methodname></term> - <listitem><para>Wait until a process is listening on the given TCP - port (on <literal>localhost</literal>, at least).</para></listitem> - </varlistentry> - - <varlistentry> - <term><methodname>waitForClosedPort</methodname></term> - <listitem><para>Wait until nobody is listening on the given TCP - port.</para></listitem> - </varlistentry> - - <varlistentry> - <term><methodname>waitForX</methodname></term> - <listitem><para>Wait until the X11 server is accepting - connections.</para></listitem> - </varlistentry> - - <varlistentry> - <term><methodname>waitForText</methodname></term> - <listitem><para>Wait until the supplied regular expressions matches - the textual contents of the screen by using optical character recognition - (see <methodname>getScreenText</methodname>).</para> - <note><para>This requires passing <option>enableOCR</option> to the test - attribute set.</para></note></listitem> - </varlistentry> - - <varlistentry> - <term><methodname>waitForWindow</methodname></term> - <listitem><para>Wait until an X11 window has appeared whose name - matches the given regular expression, e.g., - <literal>waitForWindow(qr/Terminal/)</literal>.</para></listitem> - </varlistentry> - - <varlistentry> - <term><methodname>copyFileFromHost</methodname></term> - <listitem><para>Copies a file from host to machine, e.g., - <literal>copyFileFromHost("myfile", "/etc/my/important/file")</literal>.</para> - <para>The first argument is the file on the host. The file needs to be - accessible while building the nix derivation. The second argument is - the location of the file on the machine.</para> + </para> + + <para> + The following methods are available on machine objects: + <variablelist> + <varlistentry> + <term><methodname>start</methodname> + </term> + <listitem> + <para> + Start the virtual machine. This method is asynchronous — it does not + wait for the machine to finish booting. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><methodname>systemctl</methodname></term> + </varlistentry> + <varlistentry> + <term><methodname>shutdown</methodname> + </term> + <listitem> + <para> + Shut down the machine, waiting for the VM to exit. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><methodname>crash</methodname> + </term> <listitem> - <para>Runs <literal>systemctl</literal> commands with optional support for - <literal>systemctl --user</literal></para> - <para> - <programlisting> + <para> + Simulate a sudden power failure, by telling the VM to exit immediately. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><methodname>block</methodname> + </term> + <listitem> + <para> + Simulate unplugging the Ethernet cable that connects the machine to the + other machines. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><methodname>unblock</methodname> + </term> + <listitem> + <para> + Undo the effect of <methodname>block</methodname>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><methodname>screenshot</methodname> + </term> + <listitem> + <para> + Take a picture of the display of the virtual machine, in PNG format. The + screenshot is linked from the HTML log. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><methodname>getScreenText</methodname> + </term> + <listitem> + <para> + Return a textual representation of what is currently visible on the + machine's screen using optical character recognition. + </para> + <note> + <para> + This requires passing <option>enableOCR</option> to the test attribute + set. + </para> + </note> + </listitem> + </varlistentry> + <varlistentry> + <term><methodname>sendMonitorCommand</methodname> + </term> + <listitem> + <para> + Send a command to the QEMU monitor. This is rarely used, but allows doing + stuff such as attaching virtual USB disks to a running machine. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><methodname>sendKeys</methodname> + </term> + <listitem> + <para> + Simulate pressing keys on the virtual keyboard, e.g., + <literal>sendKeys("ctrl-alt-delete")</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><methodname>sendChars</methodname> + </term> + <listitem> + <para> + Simulate typing a sequence of characters on the virtual keyboard, e.g., + <literal>sendKeys("foobar\n")</literal> will type the string + <literal>foobar</literal> followed by the Enter key. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><methodname>execute</methodname> + </term> + <listitem> + <para> + Execute a shell command, returning a list + <literal>(<replaceable>status</replaceable>, + <replaceable>stdout</replaceable>)</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><methodname>succeed</methodname> + </term> + <listitem> + <para> + Execute a shell command, raising an exception if the exit status is not + zero, otherwise returning the standard output. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><methodname>fail</methodname> + </term> + <listitem> + <para> + Like <methodname>succeed</methodname>, but raising an exception if the + command returns a zero status. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><methodname>waitUntilSucceeds</methodname> + </term> + <listitem> + <para> + Repeat a shell command with 1-second intervals until it succeeds. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><methodname>waitUntilFails</methodname> + </term> + <listitem> + <para> + Repeat a shell command with 1-second intervals until it fails. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><methodname>waitForUnit</methodname> + </term> + <listitem> + <para> + Wait until the specified systemd unit has reached the “active” state. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><methodname>waitForFile</methodname> + </term> + <listitem> + <para> + Wait until the specified file exists. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><methodname>waitForOpenPort</methodname> + </term> + <listitem> + <para> + Wait until a process is listening on the given TCP port (on + <literal>localhost</literal>, at least). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><methodname>waitForClosedPort</methodname> + </term> + <listitem> + <para> + Wait until nobody is listening on the given TCP port. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><methodname>waitForX</methodname> + </term> + <listitem> + <para> + Wait until the X11 server is accepting connections. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><methodname>waitForText</methodname> + </term> + <listitem> + <para> + Wait until the supplied regular expressions matches the textual contents + of the screen by using optical character recognition (see + <methodname>getScreenText</methodname>). + </para> + <note> + <para> + This requires passing <option>enableOCR</option> to the test attribute + set. + </para> + </note> + </listitem> + </varlistentry> + <varlistentry> + <term><methodname>waitForWindow</methodname> + </term> + <listitem> + <para> + Wait until an X11 window has appeared whose name matches the given + regular expression, e.g., <literal>waitForWindow(qr/Terminal/)</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><methodname>copyFileFromHost</methodname> + </term> + <listitem> + <para> + Copies a file from host to machine, e.g., + <literal>copyFileFromHost("myfile", "/etc/my/important/file")</literal>. + </para> + <para> + The first argument is the file on the host. The file needs to be + accessible while building the nix derivation. The second argument is the + location of the file on the machine. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><methodname>systemctl</methodname> + </term> + <listitem> + <para> + Runs <literal>systemctl</literal> commands with optional support for + <literal>systemctl --user</literal> + </para> + <para> +<programlisting> $machine->systemctl("list-jobs --no-pager"); // runs `systemctl list-jobs --no-pager` $machine->systemctl("list-jobs --no-pager", "any-user"); // spawns a shell for `any-user` and runs `systemctl --user list-jobs --no-pager` </programlisting> - </para> + </para> </listitem> - </varlistentry> + </varlistentry> + </variablelist> + </para> -</variablelist> - -</para> - -<para> - To test user units declared by <literal>systemd.user.services</literal> the optional <literal>$user</literal> - argument can be used: - - <programlisting> + <para> + To test user units declared by <literal>systemd.user.services</literal> the + optional <literal>$user</literal> argument can be used: +<programlisting> $machine->start; $machine->waitForX; $machine->waitForUnit("xautolock.service", "x-session-user"); </programlisting> - This applies to <literal>systemctl</literal>, <literal>getUnitInfo</literal>, - <literal>waitForUnit</literal>, <literal>startJob</literal> - and <literal>stopJob</literal>. -</para> - + <literal>waitForUnit</literal>, <literal>startJob</literal> and + <literal>stopJob</literal>. + </para> </section> diff --git a/nixos/doc/manual/installation/changing-config.xml b/nixos/doc/manual/installation/changing-config.xml index 52d8a292f8be..680160a3cb7e 100644 --- a/nixos/doc/manual/installation/changing-config.xml +++ b/nixos/doc/manual/installation/changing-config.xml @@ -2,101 +2,84 @@ xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="sec-changing-config"> - -<title>Changing the Configuration</title> - -<para>The file <filename>/etc/nixos/configuration.nix</filename> -contains the current configuration of your machine. Whenever you’ve -<link linkend="ch-configuration">changed something</link> in that file, you should do - + <title>Changing the Configuration</title> + <para> + The file <filename>/etc/nixos/configuration.nix</filename> contains the + current configuration of your machine. Whenever you’ve + <link linkend="ch-configuration">changed something</link> in that file, you + should do <screen> # nixos-rebuild switch</screen> - -to build the new configuration, make it the default configuration for -booting, and try to realise the configuration in the running system -(e.g., by restarting system services).</para> - -<warning><para>These commands must be executed as root, so you should -either run them from a root shell or by prefixing them with -<literal>sudo -i</literal>.</para></warning> - -<para>You can also do - + to build the new configuration, make it the default configuration for + booting, and try to realise the configuration in the running system (e.g., by + restarting system services). + </para> + <warning> + <para> + These commands must be executed as root, so you should either run them from + a root shell or by prefixing them with <literal>sudo -i</literal>. + </para> + </warning> + <para> + You can also do <screen> # nixos-rebuild test</screen> - -to build the configuration and switch the running system to it, but -without making it the boot default. So if (say) the configuration -locks up your machine, you can just reboot to get back to a working -configuration.</para> - -<para>There is also - + to build the configuration and switch the running system to it, but without + making it the boot default. So if (say) the configuration locks up your + machine, you can just reboot to get back to a working configuration. + </para> + <para> + There is also <screen> # nixos-rebuild boot</screen> - -to build the configuration and make it the boot default, but not -switch to it now (so it will only take effect after the next -reboot).</para> - -<para>You can make your configuration show up in a different submenu -of the GRUB 2 boot screen by giving it a different <emphasis>profile -name</emphasis>, e.g. - + to build the configuration and make it the boot default, but not switch to it + now (so it will only take effect after the next reboot). + </para> + <para> + You can make your configuration show up in a different submenu of the GRUB 2 + boot screen by giving it a different <emphasis>profile name</emphasis>, e.g. <screen> # nixos-rebuild switch -p test </screen> - -which causes the new configuration (and previous ones created using -<literal>-p test</literal>) to show up in the GRUB submenu “NixOS - -Profile 'test'”. This can be useful to separate test configurations -from “stable” configurations.</para> - -<para>Finally, you can do - + which causes the new configuration (and previous ones created using + <literal>-p test</literal>) to show up in the GRUB submenu “NixOS - Profile + 'test'”. This can be useful to separate test configurations from + “stable” configurations. + </para> + <para> + Finally, you can do <screen> $ nixos-rebuild build</screen> - -to build the configuration but nothing more. This is useful to see -whether everything compiles cleanly.</para> - -<para>If you have a machine that supports hardware virtualisation, you -can also test the new configuration in a sandbox by building and -running a QEMU <emphasis>virtual machine</emphasis> that contains the -desired configuration. Just do - + to build the configuration but nothing more. This is useful to see whether + everything compiles cleanly. + </para> + <para> + If you have a machine that supports hardware virtualisation, you can also + test the new configuration in a sandbox by building and running a QEMU + <emphasis>virtual machine</emphasis> that contains the desired configuration. + Just do <screen> $ nixos-rebuild build-vm $ ./result/bin/run-*-vm </screen> - -The VM does not have any data from your host system, so your existing -user accounts and home directories will not be available unless you -have set <literal>mutableUsers = false</literal>. Another way is to -temporarily add the following to your configuration: - + The VM does not have any data from your host system, so your existing user + accounts and home directories will not be available unless you have set + <literal>mutableUsers = false</literal>. Another way is to temporarily add + the following to your configuration: <screen> <link linkend="opt-users.users._name__.initialHashedPassword">users.extraUsers.your-user.initialHashedPassword</link> = "test"; </screen> - -<emphasis>Important:</emphasis> delete the $hostname.qcow2 file if you -have started the virtual machine at least once without the right -users, otherwise the changes will not get picked up. - -You can forward ports on the host to the guest. For -instance, the following will forward host port 2222 to guest port 22 -(SSH): - + <emphasis>Important:</emphasis> delete the $hostname.qcow2 file if you have + started the virtual machine at least once without the right users, otherwise + the changes will not get picked up. You can forward ports on the host to the + guest. For instance, the following will forward host port 2222 to guest port + 22 (SSH): <screen> $ QEMU_NET_OPTS="hostfwd=tcp::2222-:22" ./result/bin/run-*-vm </screen> - -allowing you to log in via SSH (assuming you have set the appropriate -passwords or SSH authorized keys): - + allowing you to log in via SSH (assuming you have set the appropriate + passwords or SSH authorized keys): <screen> $ ssh -p 2222 localhost </screen> - -</para> - + </para> </chapter> diff --git a/nixos/doc/manual/installation/installation.xml b/nixos/doc/manual/installation/installation.xml index ee61bedc4183..d4276be95d68 100644 --- a/nixos/doc/manual/installation/installation.xml +++ b/nixos/doc/manual/installation/installation.xml @@ -3,19 +3,15 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="ch-installation"> - -<title>Installation</title> - -<partintro> - -<para>This section describes how to obtain, install, and configure -NixOS for first-time use.</para> - -</partintro> - -<xi:include href="obtaining.xml" /> -<xi:include href="installing.xml" /> -<xi:include href="changing-config.xml" /> -<xi:include href="upgrading.xml" /> - + <title>Installation</title> + <partintro> + <para> + This section describes how to obtain, install, and configure NixOS for + first-time use. + </para> + </partintro> + <xi:include href="obtaining.xml" /> + <xi:include href="installing.xml" /> + <xi:include href="changing-config.xml" /> + <xi:include href="upgrading.xml" /> </part> diff --git a/nixos/doc/manual/installation/installing-from-other-distro.xml b/nixos/doc/manual/installation/installing-from-other-distro.xml index e8afb97bcde5..8b0c350b064d 100644 --- a/nixos/doc/manual/installation/installing-from-other-distro.xml +++ b/nixos/doc/manual/installation/installing-from-other-distro.xml @@ -5,284 +5,325 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-installing-from-other-distro"> - - <title>Installing from another Linux distribution</title> - - <para> - Because Nix (the package manager) & Nixpkgs (the Nix packages - collection) can both be installed on any (most?) Linux distributions, - they can be used to install NixOS in various creative ways. You can, - for instance: - </para> - - <orderedlist> - <listitem><para>Install NixOS on another partition, from your existing - Linux distribution (without the use of a USB or optical - device!)</para></listitem> - - <listitem><para>Install NixOS on the same partition (in place!), from - your existing non-NixOS Linux distribution using - <literal>NIXOS_LUSTRATE</literal>.</para></listitem> - - <listitem><para>Install NixOS on your hard drive from the Live CD of - any Linux distribution.</para></listitem> - </orderedlist> - - <para>The first steps to all these are the same:</para> - - <orderedlist> - <listitem> - <para>Install the Nix package manager:</para> - - <para>Short version:</para> - - <screen> + <title>Installing from another Linux distribution</title> + + <para> + Because Nix (the package manager) & Nixpkgs (the Nix packages collection) + can both be installed on any (most?) Linux distributions, they can be used to + install NixOS in various creative ways. You can, for instance: + </para> + + <orderedlist> + <listitem> + <para> + Install NixOS on another partition, from your existing Linux distribution + (without the use of a USB or optical device!) + </para> + </listitem> + <listitem> + <para> + Install NixOS on the same partition (in place!), from your existing + non-NixOS Linux distribution using <literal>NIXOS_LUSTRATE</literal>. + </para> + </listitem> + <listitem> + <para> + Install NixOS on your hard drive from the Live CD of any Linux + distribution. + </para> + </listitem> + </orderedlist> + + <para> + The first steps to all these are the same: + </para> + + <orderedlist> + <listitem> + <para> + Install the Nix package manager: + </para> + <para> + Short version: + </para> +<screen> $ bash <(curl https://nixos.org/nix/install) $ . $HOME/.nix-profile/etc/profile.d/nix.sh # …or open a fresh shell</screen> - - <para>More details in the <link + <para> + More details in the + <link xlink:href="https://nixos.org/nix/manual/#chap-quick-start"> - Nix manual</link></para> - </listitem> - - <listitem> - <para>Switch to the NixOS channel:</para> - - <para>If you've just installed Nix on a non-NixOS distribution, you - will be on the <literal>nixpkgs</literal> channel by - default.</para> - - <screen> + Nix manual</link> + </para> + </listitem> + <listitem> + <para> + Switch to the NixOS channel: + </para> + <para> + If you've just installed Nix on a non-NixOS distribution, you will be on + the <literal>nixpkgs</literal> channel by default. + </para> +<screen> $ nix-channel --list nixpkgs https://nixos.org/channels/nixpkgs-unstable</screen> - - <para>As that channel gets released without running the NixOS - tests, it will be safer to use the <literal>nixos-*</literal> - channels instead:</para> - - <screen> + <para> + As that channel gets released without running the NixOS tests, it will be + safer to use the <literal>nixos-*</literal> channels instead: + </para> +<screen> $ nix-channel --add https://nixos.org/channels/nixos-<replaceable>version</replaceable> nixpkgs</screen> - - <para>You may want to throw in a <literal>nix-channel - --update</literal> for good measure.</para> - </listitem> - - <listitem> - <para>Install the NixOS installation tools:</para> - - <para>You'll need <literal>nixos-generate-config</literal> and - <literal>nixos-install</literal> and we'll throw in some man - pages and <literal>nixos-enter</literal> just in case you want - to chroot into your NixOS partition. They are installed by - default on NixOS, but you don't have NixOS yet..</para> - - <screen>$ nix-env -iE "_: with import <nixpkgs/nixos> { configuration = {}; }; with config.system.build; [ nixos-generate-config nixos-install nixos-enter manual.manpages ]"</screen> - </listitem> - - <listitem> - <note><para>The following 5 steps are only for installing NixOS to - another partition. For installing NixOS in place using - <literal>NIXOS_LUSTRATE</literal>, skip ahead.</para></note> - - <para>Prepare your target partition:</para> - - <para>At this point it is time to prepare your target partition. - Please refer to the partitioning, file-system creation, and - mounting steps of <xref linkend="sec-installation" /></para> - - <para>If you're about to install NixOS in place using - <literal>NIXOS_LUSTRATE</literal> there is nothing to do for - this step.</para> - </listitem> - - <listitem> - <para>Generate your NixOS configuration:</para> - - <screen>$ sudo `which nixos-generate-config` --root /mnt</screen> - - <para>You'll probably want to edit the configuration files. Refer - to the <literal>nixos-generate-config</literal> step in <xref - linkend="sec-installation" /> for more information.</para> - - <para>Consider setting up the NixOS bootloader to give you the - ability to boot on your existing Linux partition. For instance, - if you're using GRUB and your existing distribution is running - Ubuntu, you may want to add something like this to your - <literal>configuration.nix</literal>:</para> - - <programlisting> + <para> + You may want to throw in a <literal>nix-channel --update</literal> for good + measure. + </para> + </listitem> + <listitem> + <para> + Install the NixOS installation tools: + </para> + <para> + You'll need <literal>nixos-generate-config</literal> and + <literal>nixos-install</literal> and we'll throw in some man pages and + <literal>nixos-enter</literal> just in case you want to chroot into your + NixOS partition. They are installed by default on NixOS, but you don't have + NixOS yet.. + </para> +<screen>$ nix-env -iE "_: with import <nixpkgs/nixos> { configuration = {}; }; with config.system.build; [ nixos-generate-config nixos-install nixos-enter manual.manpages ]"</screen> + </listitem> + <listitem> + <note> + <para> + The following 5 steps are only for installing NixOS to another partition. + For installing NixOS in place using <literal>NIXOS_LUSTRATE</literal>, + skip ahead. + </para> + </note> + <para> + Prepare your target partition: + </para> + <para> + At this point it is time to prepare your target partition. Please refer to + the partitioning, file-system creation, and mounting steps of + <xref linkend="sec-installation" /> + </para> + <para> + If you're about to install NixOS in place using + <literal>NIXOS_LUSTRATE</literal> there is nothing to do for this step. + </para> + </listitem> + <listitem> + <para> + Generate your NixOS configuration: + </para> +<screen>$ sudo `which nixos-generate-config` --root /mnt</screen> + <para> + You'll probably want to edit the configuration files. Refer to the + <literal>nixos-generate-config</literal> step in + <xref + linkend="sec-installation" /> for more + information. + </para> + <para> + Consider setting up the NixOS bootloader to give you the ability to boot on + your existing Linux partition. For instance, if you're using GRUB and your + existing distribution is running Ubuntu, you may want to add something like + this to your <literal>configuration.nix</literal>: + </para> +<programlisting> <xref linkend="opt-boot.loader.grub.extraEntries"/> = '' menuentry "Ubuntu" { search --set=ubuntu --fs-uuid 3cc3e652-0c1f-4800-8451-033754f68e6e configfile "($ubuntu)/boot/grub/grub.cfg" } '';</programlisting> - - <para>(You can find the appropriate UUID for your partition in - <literal>/dev/disk/by-uuid</literal>)</para> - </listitem> - - <listitem> - <para>Create the <literal>nixbld</literal> group and user on your - original distribution:</para> - - <screen> + <para> + (You can find the appropriate UUID for your partition in + <literal>/dev/disk/by-uuid</literal>) + </para> + </listitem> + <listitem> + <para> + Create the <literal>nixbld</literal> group and user on your original + distribution: + </para> +<screen> $ sudo groupadd -g 30000 nixbld $ sudo useradd -u 30000 -g nixbld -G nixbld nixbld</screen> - </listitem> - - <listitem> - <para>Download/build/install NixOS:</para> - - <warning><para>Once you complete this step, you might no longer be - able to boot on existing systems without the help of a - rescue USB drive or similar.</para></warning> - - <screen>$ sudo PATH="$PATH" NIX_PATH="$NIX_PATH" `which nixos-install` --root /mnt</screen> - - <para>Again, please refer to the <literal>nixos-install</literal> - step in <xref linkend="sec-installation" /> for more - information.</para> - - <para>That should be it for installation to another partition!</para> - </listitem> - - <listitem> - <para>Optionally, you may want to clean up your non-NixOS distribution:</para> - - <screen> + </listitem> + <listitem> + <para> + Download/build/install NixOS: + </para> + <warning> + <para> + Once you complete this step, you might no longer be able to boot on + existing systems without the help of a rescue USB drive or similar. + </para> + </warning> +<screen>$ sudo PATH="$PATH" NIX_PATH="$NIX_PATH" `which nixos-install` --root /mnt</screen> + <para> + Again, please refer to the <literal>nixos-install</literal> step in + <xref linkend="sec-installation" /> for more information. + </para> + <para> + That should be it for installation to another partition! + </para> + </listitem> + <listitem> + <para> + Optionally, you may want to clean up your non-NixOS distribution: + </para> +<screen> $ sudo userdel nixbld $ sudo groupdel nixbld</screen> - - <para>If you do not wish to keep the Nix package manager - installed either, run something like <literal>sudo rm -rv - ~/.nix-* /nix</literal> and remove the line that the Nix - installer added to your <literal>~/.profile</literal>.</para> - </listitem> - - <listitem> - <note><para>The following steps are only for installing NixOS in - place using - <literal>NIXOS_LUSTRATE</literal>:</para></note> - - <para>Generate your NixOS configuration:</para> - - <screen>$ sudo `which nixos-generate-config` --root /</screen> - - <para>Note that this will place the generated configuration files - in <literal>/etc/nixos</literal>. You'll probably want to edit - the configuration files. Refer to the - <literal>nixos-generate-config</literal> step in <xref - linkend="sec-installation" /> for more information.</para> - - <para>You'll likely want to set a root password for your first boot - using the configuration files because you won't have a chance - to enter a password until after you reboot. You can initalize - the root password to an empty one with this line: (and of course - don't forget to set one once you've rebooted or to lock the - account with <literal>sudo passwd -l root</literal> if you use - <literal>sudo</literal>)</para> - - <programlisting> + <para> + If you do not wish to keep the Nix package manager installed either, run + something like <literal>sudo rm -rv ~/.nix-* /nix</literal> and remove the + line that the Nix installer added to your <literal>~/.profile</literal>. + </para> + </listitem> + <listitem> + <note> + <para> + The following steps are only for installing NixOS in place using + <literal>NIXOS_LUSTRATE</literal>: + </para> + </note> + <para> + Generate your NixOS configuration: + </para> +<screen>$ sudo `which nixos-generate-config` --root /</screen> + <para> + Note that this will place the generated configuration files in + <literal>/etc/nixos</literal>. You'll probably want to edit the + configuration files. Refer to the <literal>nixos-generate-config</literal> + step in <xref + linkend="sec-installation" /> for more + information. + </para> + <para> + You'll likely want to set a root password for your first boot using the + configuration files because you won't have a chance to enter a password + until after you reboot. You can initalize the root password to an empty one + with this line: (and of course don't forget to set one once you've rebooted + or to lock the account with <literal>sudo passwd -l root</literal> if you + use <literal>sudo</literal>) + </para> +<programlisting> <link linkend="opt-users.users._name__.initialHashedPassword">users.extraUsers.root.initialHashedPassword</link> = ""; </programlisting> - </listitem> - - <listitem> - <para>Build the NixOS closure and install it in the - <literal>system</literal> profile:</para> - - <screen>$ nix-env -p /nix/var/nix/profiles/system -f '<nixpkgs/nixos>' -I nixos-config=/etc/nixos/configuration.nix -iA system</screen> - </listitem> - - <listitem> - <para>Change ownership of the <literal>/nix</literal> tree to root - (since your Nix install was probably single user):</para> - - <screen>$ sudo chown -R 0.0 /nix</screen> - </listitem> - - <listitem> - <para>Set up the <literal>/etc/NIXOS</literal> and - <literal>/etc/NIXOS_LUSTRATE</literal> files:</para> - - <para><literal>/etc/NIXOS</literal> officializes that this is now a - NixOS partition (the bootup scripts require its presence).</para> - - <para><literal>/etc/NIXOS_LUSTRATE</literal> tells the NixOS bootup - scripts to move <emphasis>everything</emphasis> that's in the - root partition to <literal>/old-root</literal>. This will move - your existing distribution out of the way in the very early - stages of the NixOS bootup. There are exceptions (we do need to - keep NixOS there after all), so the NixOS lustrate process will - not touch:</para> - - <itemizedlist> - <listitem><para>The <literal>/nix</literal> - directory</para></listitem> - - <listitem><para>The <literal>/boot</literal> - directory</para></listitem> - - <listitem><para>Any file or directory listed in - <literal>/etc/NIXOS_LUSTRATE</literal> (one per - line)</para></listitem> - </itemizedlist> - - <note><para>Support for <literal>NIXOS_LUSTRATE</literal> was added - in NixOS 16.09. The act of "lustrating" refers to the - wiping of the existing distribution. Creating - <literal>/etc/NIXOS_LUSTRATE</literal> can also be used on - NixOS to remove all mutable files from your root partition - (anything that's not in <literal>/nix</literal> or - <literal>/boot</literal> gets "lustrated" on the next - boot.</para> - <para>lustrate /ˈlʌstreɪt/ verb.</para> - <para>purify by expiatory sacrifice, ceremonial washing, or - some other ritual action.</para></note> - - <para>Let's create the files:</para> - - <screen> + </listitem> + <listitem> + <para> + Build the NixOS closure and install it in the <literal>system</literal> + profile: + </para> +<screen>$ nix-env -p /nix/var/nix/profiles/system -f '<nixpkgs/nixos>' -I nixos-config=/etc/nixos/configuration.nix -iA system</screen> + </listitem> + <listitem> + <para> + Change ownership of the <literal>/nix</literal> tree to root (since your + Nix install was probably single user): + </para> +<screen>$ sudo chown -R 0.0 /nix</screen> + </listitem> + <listitem> + <para> + Set up the <literal>/etc/NIXOS</literal> and + <literal>/etc/NIXOS_LUSTRATE</literal> files: + </para> + <para> + <literal>/etc/NIXOS</literal> officializes that this is now a NixOS + partition (the bootup scripts require its presence). + </para> + <para> + <literal>/etc/NIXOS_LUSTRATE</literal> tells the NixOS bootup scripts to + move <emphasis>everything</emphasis> that's in the root partition to + <literal>/old-root</literal>. This will move your existing distribution out + of the way in the very early stages of the NixOS bootup. There are + exceptions (we do need to keep NixOS there after all), so the NixOS + lustrate process will not touch: + </para> + <itemizedlist> + <listitem> + <para> + The <literal>/nix</literal> directory + </para> + </listitem> + <listitem> + <para> + The <literal>/boot</literal> directory + </para> + </listitem> + <listitem> + <para> + Any file or directory listed in <literal>/etc/NIXOS_LUSTRATE</literal> + (one per line) + </para> + </listitem> + </itemizedlist> + <note> + <para> + Support for <literal>NIXOS_LUSTRATE</literal> was added in NixOS 16.09. + The act of "lustrating" refers to the wiping of the existing distribution. + Creating <literal>/etc/NIXOS_LUSTRATE</literal> can also be used on NixOS + to remove all mutable files from your root partition (anything that's not + in <literal>/nix</literal> or <literal>/boot</literal> gets "lustrated" on + the next boot. + </para> + <para> + lustrate /ˈlʌstreɪt/ verb. + </para> + <para> + purify by expiatory sacrifice, ceremonial washing, or some other ritual + action. + </para> + </note> + <para> + Let's create the files: + </para> +<screen> $ sudo touch /etc/NIXOS $ sudo touch /etc/NIXOS_LUSTRATE </screen> - - <para>Let's also make sure the NixOS configuration files are kept - once we reboot on NixOS:</para> - - <screen> + <para> + Let's also make sure the NixOS configuration files are kept once we reboot + on NixOS: + </para> +<screen> $ echo etc/nixos | sudo tee -a /etc/NIXOS_LUSTRATE </screen> - </listitem> - - <listitem> - <para>Finally, move the <literal>/boot</literal> directory of your - current distribution out of the way (the lustrate process will - take care of the rest once you reboot, but this one must be - moved out now because NixOS needs to install its own boot - files:</para> - - <warning><para>Once you complete this step, your current - distribution will no longer be bootable! If you didn't get - all the NixOS configuration right, especially those - settings pertaining to boot loading and root partition, - NixOS may not be bootable either. Have a USB rescue device - ready in case this happens. </para></warning> - - <screen> + </listitem> + <listitem> + <para> + Finally, move the <literal>/boot</literal> directory of your current + distribution out of the way (the lustrate process will take care of the + rest once you reboot, but this one must be moved out now because NixOS + needs to install its own boot files: + </para> + <warning> + <para> + Once you complete this step, your current distribution will no longer be + bootable! If you didn't get all the NixOS configuration right, especially + those settings pertaining to boot loading and root partition, NixOS may + not be bootable either. Have a USB rescue device ready in case this + happens. + </para> + </warning> +<screen> $ sudo mv -v /boot /boot.bak && sudo /nix/var/nix/profiles/system/bin/switch-to-configuration boot</screen> - - <para>Cross your fingers, reboot, hopefully you should get a NixOS - prompt!</para> - </listitem> - <listitem> - <para>If for some reason you want to revert to the old - distribution, you'll need to boot on a USB rescue disk and do - something along these lines:</para> - - <screen> + <para> + Cross your fingers, reboot, hopefully you should get a NixOS prompt! + </para> + </listitem> + <listitem> + <para> + If for some reason you want to revert to the old distribution, you'll need + to boot on a USB rescue disk and do something along these lines: + </para> +<screen> # mkdir root # mount /dev/sdaX root # mkdir root/nixos-root @@ -291,23 +332,25 @@ $ sudo mv -v /boot /boot.bak && # mv -v root/boot.bak root/boot # We had renamed this by hand earlier # umount root # reboot</screen> - - <para>This may work as is or you might also need to reinstall the - boot loader</para> - - <para>And of course, if you're happy with NixOS and no longer need - the old distribution:</para> - - <screen>sudo rm -rf /old-root</screen> - </listitem> - - <listitem> - <para>It's also worth noting that this whole process can be - automated. This is especially useful for Cloud VMs, where - provider do not provide NixOS. For instance, <link + <para> + This may work as is or you might also need to reinstall the boot loader + </para> + <para> + And of course, if you're happy with NixOS and no longer need the old + distribution: + </para> +<screen>sudo rm -rf /old-root</screen> + </listitem> + <listitem> + <para> + It's also worth noting that this whole process can be automated. This is + especially useful for Cloud VMs, where provider do not provide NixOS. For + instance, + <link xlink:href="https://github.com/elitak/nixos-infect">nixos-infect</link> - uses the lustrate process to convert Digital Ocean droplets to - NixOS from other distributions automatically.</para> - </listitem> - </orderedlist> + uses the lustrate process to convert Digital Ocean droplets to NixOS from + other distributions automatically. + </para> + </listitem> + </orderedlist> </section> diff --git a/nixos/doc/manual/installation/installing-pxe.xml b/nixos/doc/manual/installation/installing-pxe.xml index 7b7597c91626..94199e5e028d 100644 --- a/nixos/doc/manual/installation/installing-pxe.xml +++ b/nixos/doc/manual/installation/installing-pxe.xml @@ -3,46 +3,48 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-booting-from-pxe"> + <title>Booting from the <quote>netboot</quote> media (PXE)</title> -<title>Booting from the <quote>netboot</quote> media (PXE)</title> -<para> - Advanced users may wish to install NixOS using an existing PXE or - iPXE setup. -</para> -<para> + <para> + Advanced users may wish to install NixOS using an existing PXE or iPXE setup. + </para> + + <para> These instructions assume that you have an existing PXE or iPXE - infrastructure and simply want to add the NixOS installer as another - option. To build the necessary files from a recent version of - nixpkgs, you can run: -</para> + infrastructure and simply want to add the NixOS installer as another option. + To build the necessary files from a recent version of nixpkgs, you can run: + </para> + <programlisting> nix-build -A netboot nixos/release.nix </programlisting> -<para> + + <para> This will create a <literal>result</literal> directory containing: * - <literal>bzImage</literal> – the Linux kernel * - <literal>initrd</literal> – the initrd file * - <literal>netboot.ipxe</literal> – an example ipxe script - demonstrating the appropriate kernel command line arguments for this + <literal>bzImage</literal> – the Linux kernel * <literal>initrd</literal> + – the initrd file * <literal>netboot.ipxe</literal> – an example ipxe + script demonstrating the appropriate kernel command line arguments for this image -</para> -<para> + </para> + + <para> If you’re using plain PXE, configure your boot loader to use the - <literal>bzImage</literal> and <literal>initrd</literal> files and - have it provide the same kernel command line arguments found in + <literal>bzImage</literal> and <literal>initrd</literal> files and have it + provide the same kernel command line arguments found in <literal>netboot.ipxe</literal>. -</para> -<para> + </para> + + <para> If you’re using iPXE, depending on how your HTTP/FTP/etc. server is - configured you may be able to use <literal>netboot.ipxe</literal> - unmodified, or you may need to update the paths to the files to - match your server’s directory layout -</para> -<para> - In the future we may begin making these files available as build - products from hydra at which point we will update this documentation - with instructions on how to obtain them either for placing on a - dedicated TFTP server or to boot them directly over the internet. -</para> + configured you may be able to use <literal>netboot.ipxe</literal> unmodified, + or you may need to update the paths to the files to match your server’s + directory layout + </para> + <para> + In the future we may begin making these files available as build products + from hydra at which point we will update this documentation with instructions + on how to obtain them either for placing on a dedicated TFTP server or to + boot them directly over the internet. + </para> </section> diff --git a/nixos/doc/manual/installation/installing-usb.xml b/nixos/doc/manual/installation/installing-usb.xml index d68cd6162632..c5934111749c 100644 --- a/nixos/doc/manual/installation/installing-usb.xml +++ b/nixos/doc/manual/installation/installing-usb.xml @@ -3,17 +3,19 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-booting-from-usb"> + <title>Booting from a USB Drive</title> -<title>Booting from a USB Drive</title> + <para> + For systems without CD drive, the NixOS live CD can be booted from a USB + stick. You can use the <command>dd</command> utility to write the image: + <command>dd if=<replaceable>path-to-image</replaceable> + of=<replaceable>/dev/sdb</replaceable></command>. Be careful about specifying + the correct drive; you can use the <command>lsblk</command> command to get a + list of block devices. + </para> -<para>For systems without CD drive, the NixOS live CD can be booted from -a USB stick. You can use the <command>dd</command> utility to write the image: -<command>dd if=<replaceable>path-to-image</replaceable> -of=<replaceable>/dev/sdb</replaceable></command>. Be careful about specifying the -correct drive; you can use the <command>lsblk</command> command to get a list of -block devices.</para> - -<para>On macOS: + <para> + On macOS: <programlisting> $ diskutil list [..] @@ -24,36 +26,43 @@ $ diskutil unmountDisk diskN Unmount of all volumes on diskN was successful $ sudo dd bs=1m if=nix.iso of=/dev/rdiskN </programlisting> -Using the 'raw' <command>rdiskN</command> device instead of <command>diskN</command> -completes in minutes instead of hours. After <command>dd</command> completes, a GUI -dialog "The disk you inserted was not readable by this computer" will pop up, which -can be ignored.</para> - -<para>The <command>dd</command> utility will write the image verbatim to the drive, -making it the recommended option for both UEFI and non-UEFI installations. For -non-UEFI installations, you can alternatively use -<link xlink:href="http://unetbootin.sourceforge.net/">unetbootin</link>. If you -cannot use <command>dd</command> for a UEFI installation, you can also mount the -ISO, copy its contents verbatim to your drive, then either: - -<itemizedlist> - <listitem> - <para>Change the label of the disk partition to the label of the ISO - (visible with the blkid command), or</para> - </listitem> - <listitem> - <para>Edit <filename>loader/entries/nixos-livecd.conf</filename> on the drive - and change the <literal>root=</literal> field in the <literal>options</literal> - line to point to your drive (see the documentation on <literal>root=</literal> - in <link xlink:href="https://www.kernel.org/doc/Documentation/admin-guide/kernel-parameters.txt"> - the kernel documentation</link> for more details).</para> - </listitem> - <listitem> - <para>If you want to load the contents of the ISO to ram after bootin - (So you can remove the stick after bootup) you can append the parameter - <literal>copytoram</literal> to the <literal>options</literal> field.</para> - </listitem> -</itemizedlist> -</para> + Using the 'raw' <command>rdiskN</command> device instead of + <command>diskN</command> completes in minutes instead of hours. After + <command>dd</command> completes, a GUI dialog "The disk you inserted was not + readable by this computer" will pop up, which can be ignored. + </para> + <para> + The <command>dd</command> utility will write the image verbatim to the drive, + making it the recommended option for both UEFI and non-UEFI installations. + For non-UEFI installations, you can alternatively use + <link xlink:href="http://unetbootin.sourceforge.net/">unetbootin</link>. If + you cannot use <command>dd</command> for a UEFI installation, you can also + mount the ISO, copy its contents verbatim to your drive, then either: + <itemizedlist> + <listitem> + <para> + Change the label of the disk partition to the label of the ISO (visible + with the blkid command), or + </para> + </listitem> + <listitem> + <para> + Edit <filename>loader/entries/nixos-livecd.conf</filename> on the drive + and change the <literal>root=</literal> field in the + <literal>options</literal> line to point to your drive (see the + documentation on <literal>root=</literal> in + <link xlink:href="https://www.kernel.org/doc/Documentation/admin-guide/kernel-parameters.txt"> + the kernel documentation</link> for more details). + </para> + </listitem> + <listitem> + <para> + If you want to load the contents of the ISO to ram after bootin (So you + can remove the stick after bootup) you can append the parameter + <literal>copytoram</literal> to the <literal>options</literal> field. + </para> + </listitem> + </itemizedlist> + </para> </section> diff --git a/nixos/doc/manual/installation/installing-virtualbox-guest.xml b/nixos/doc/manual/installation/installing-virtualbox-guest.xml index 2b31b7ed3152..da78b480f5aa 100644 --- a/nixos/doc/manual/installation/installing-virtualbox-guest.xml +++ b/nixos/doc/manual/installation/installing-virtualbox-guest.xml @@ -3,63 +3,82 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-instaling-virtualbox-guest"> + <title>Installing in a VirtualBox guest</title> -<title>Installing in a VirtualBox guest</title> -<para> + <para> Installing NixOS into a VirtualBox guest is convenient for users who want to try NixOS without installing it on bare metal. If you want to use a pre-made - VirtualBox appliance, it is available at <link - xlink:href="https://nixos.org/nixos/download.html">the downloads page</link>. - If you want to set up a VirtualBox guest manually, follow these instructions: -</para> - -<orderedlist> - - <listitem><para>Add a New Machine in VirtualBox with OS Type "Linux / Other - Linux"</para></listitem> - - <listitem><para>Base Memory Size: 768 MB or higher.</para></listitem> - - <listitem><para>New Hard Disk of 8 GB or higher.</para></listitem> - - <listitem><para>Mount the CD-ROM with the NixOS ISO (by clicking on - CD/DVD-ROM)</para></listitem> - - <listitem><para>Click on Settings / System / Processor and enable - PAE/NX</para></listitem> - - <listitem><para>Click on Settings / System / Acceleration and enable - "VT-x/AMD-V" acceleration</para></listitem> - - <listitem><para>Save the settings, start the virtual machine, and continue - installation like normal</para></listitem> - -</orderedlist> - -<para> - There are a few modifications you should make in configuration.nix. - Enable booting: -</para> + VirtualBox appliance, it is available at + <link + xlink:href="https://nixos.org/nixos/download.html">the downloads + page</link>. If you want to set up a VirtualBox guest manually, follow these + instructions: + </para> + + <orderedlist> + <listitem> + <para> + Add a New Machine in VirtualBox with OS Type "Linux / Other Linux" + </para> + </listitem> + <listitem> + <para> + Base Memory Size: 768 MB or higher. + </para> + </listitem> + <listitem> + <para> + New Hard Disk of 8 GB or higher. + </para> + </listitem> + <listitem> + <para> + Mount the CD-ROM with the NixOS ISO (by clicking on CD/DVD-ROM) + </para> + </listitem> + <listitem> + <para> + Click on Settings / System / Processor and enable PAE/NX + </para> + </listitem> + <listitem> + <para> + Click on Settings / System / Acceleration and enable "VT-x/AMD-V" + acceleration + </para> + </listitem> + <listitem> + <para> + Save the settings, start the virtual machine, and continue installation + like normal + </para> + </listitem> + </orderedlist> + + <para> + There are a few modifications you should make in configuration.nix. Enable + booting: + </para> <programlisting> <xref linkend="opt-boot.loader.grub.device"/> = "/dev/sda"; </programlisting> -<para> + <para> Also remove the fsck that runs at startup. It will always fail to run, stopping your boot until you press <literal>*</literal>. -</para> + </para> <programlisting> <xref linkend="opt-boot.initrd.checkJournalingFS"/> = false; </programlisting> -<para> + <para> Shared folders can be given a name and a path in the host system in the VirtualBox settings (Machine / Settings / Shared Folders, then click on the "Add" icon). Add the following to the <literal>/etc/nixos/configuration.nix</literal> to auto-mount them: -</para> + </para> <programlisting> { config, pkgs, ...} : @@ -74,8 +93,7 @@ } </programlisting> -<para> + <para> The folder will be available directly under the root directory. -</para> - + </para> </section> diff --git a/nixos/doc/manual/installation/installing.xml b/nixos/doc/manual/installation/installing.xml index 6b08bdb318bc..4e1fde662d6e 100644 --- a/nixos/doc/manual/installation/installing.xml +++ b/nixos/doc/manual/installation/installing.xml @@ -3,66 +3,92 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-installation"> - -<title>Installing NixOS</title> - -<para>NixOS can be installed on BIOS or UEFI systems. The procedure -for a UEFI installation is by and large the same as a BIOS installation. The differences are mentioned in the steps that follow.</para> - -<orderedlist> - - <listitem><para>Boot from the CD.</para> - <variablelist> - <varlistentry><term>UEFI systems</term> - <listitem><para>You should boot the live CD in UEFI mode - (consult your specific hardware's documentation for instructions). - You may find the <link xlink:href="http://www.rodsbooks.com/refind">rEFInd boot - manager</link> useful.</para></listitem></varlistentry></variablelist></listitem> - - <listitem><para>The CD contains a basic NixOS installation. (It - also contains Memtest86+, useful if you want to test new hardware). - When it’s finished booting, it should have detected most of your - hardware.</para></listitem> - - <listitem><para>The NixOS manual is available on virtual console 8 - (press Alt+F8 to access) or by running <command>nixos-help</command>. - </para></listitem> - - <listitem><para>You get logged in as <literal>root</literal> - (with empty password).</para></listitem> - - <listitem><para>If you downloaded the graphical ISO image, you can - run <command>systemctl start display-manager</command> to start KDE. If you - want to continue on the terminal, you can use - <command>loadkeys</command> to switch to your preferred keyboard layout. - (We even provide neo2 via <command>loadkeys de neo</command>!)</para></listitem> - - <listitem><para>The boot process should have brought up networking (check - <command>ip a</command>). Networking is necessary for the - installer, since it will download lots of stuff (such as source - tarballs or Nixpkgs channel binaries). It’s best if you have a DHCP - server on your network. Otherwise configure networking manually - using <command>ifconfig</command>.</para> - <para>To manually configure the network on the graphical installer, - first disable network-manager with - <command>systemctl stop network-manager</command>.</para> - <para>To manually configure the wifi on the minimal installer, run - <command>wpa_supplicant -B -i interface -c <(wpa_passphrase 'SSID' 'key')</command>.</para></listitem> - - - <listitem><para>If you would like to continue the installation from a different - machine you need to activate the SSH daemon via <literal>systemctl start sshd</literal>. - In order to be able to login you also need to set a password for - <literal>root</literal> using <literal>passwd</literal>.</para></listitem> - - <listitem><para>The NixOS installer doesn’t do any partitioning or - formatting yet, so you need to do that yourself. Use the following - commands: - - <itemizedlist> - - <listitem><para>For partitioning: - <command>fdisk</command>. + <title>Installing NixOS</title> + <para> + NixOS can be installed on BIOS or UEFI systems. The procedure for a UEFI + installation is by and large the same as a BIOS installation. The differences + are mentioned in the steps that follow. + </para> + <orderedlist> + <listitem> + <para> + Boot from the CD. + </para> + <variablelist> + <varlistentry> + <term>UEFI systems</term> + <listitem> + <para> + You should boot the live CD in UEFI mode (consult your specific + hardware's documentation for instructions). You may find the + <link xlink:href="http://www.rodsbooks.com/refind">rEFInd boot + manager</link> useful. + </para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + <listitem> + <para> + The CD contains a basic NixOS installation. (It also contains Memtest86+, + useful if you want to test new hardware). When it’s finished booting, it + should have detected most of your hardware. + </para> + </listitem> + <listitem> + <para> + The NixOS manual is available on virtual console 8 (press Alt+F8 to access) + or by running <command>nixos-help</command>. + </para> + </listitem> + <listitem> + <para> + You get logged in as <literal>root</literal> (with empty password). + </para> + </listitem> + <listitem> + <para> + If you downloaded the graphical ISO image, you can run <command>systemctl + start display-manager</command> to start KDE. If you want to continue on + the terminal, you can use <command>loadkeys</command> to switch to your + preferred keyboard layout. (We even provide neo2 via <command>loadkeys de + neo</command>!) + </para> + </listitem> + <listitem> + <para> + The boot process should have brought up networking (check <command>ip + a</command>). Networking is necessary for the installer, since it will + download lots of stuff (such as source tarballs or Nixpkgs channel + binaries). It’s best if you have a DHCP server on your network. Otherwise + configure networking manually using <command>ifconfig</command>. + </para> + <para> + To manually configure the network on the graphical installer, first disable + network-manager with <command>systemctl stop network-manager</command>. + </para> + <para> + To manually configure the wifi on the minimal installer, run + <command>wpa_supplicant -B -i interface -c <(wpa_passphrase 'SSID' + 'key')</command>. + </para> + </listitem> + <listitem> + <para> + If you would like to continue the installation from a different machine you + need to activate the SSH daemon via <literal>systemctl start + sshd</literal>. In order to be able to login you also need to set a + password for <literal>root</literal> using <literal>passwd</literal>. + </para> + </listitem> + <listitem> + <para> + The NixOS installer doesn’t do any partitioning or formatting yet, so you + need to do that yourself. Use the following commands: + <itemizedlist> + <listitem> + <para> + For partitioning: <command>fdisk</command>. <screen> # fdisk /dev/sda # <lineannotation>(or whatever device you want to install on)</lineannotation> -- for UEFI systems only @@ -86,257 +112,266 @@ for a UEFI installation is by and large the same as a BIOS installation. The dif > x # <lineannotation>(enter expert mode)</lineannotation> > f # <lineannotation>(fix up the partition ordering)</lineannotation> > r # <lineannotation>(exit expert mode)</lineannotation> -> w # <lineannotation>(write the partition table to disk and exit)</lineannotation></screen></para></listitem> - - <listitem><para>For initialising Ext4 partitions: - <command>mkfs.ext4</command>. It is recommended that you assign a - unique symbolic label to the file system using the option - <option>-L <replaceable>label</replaceable></option>, since this - makes the file system configuration independent from device - changes. For example: - +> w # <lineannotation>(write the partition table to disk and exit)</lineannotation></screen> + </para> + </listitem> + <listitem> + <para> + For initialising Ext4 partitions: <command>mkfs.ext4</command>. It is + recommended that you assign a unique symbolic label to the file system + using the option <option>-L <replaceable>label</replaceable></option>, + since this makes the file system configuration independent from device + changes. For example: <screen> # mkfs.ext4 -L nixos /dev/sda1</screen> - - </para></listitem> - - <listitem><para>For creating swap partitions: - <command>mkswap</command>. Again it’s recommended to assign a - label to the swap partition: <option>-L - <replaceable>label</replaceable></option>. For example: - + </para> + </listitem> + <listitem> + <para> + For creating swap partitions: <command>mkswap</command>. Again it’s + recommended to assign a label to the swap partition: <option>-L + <replaceable>label</replaceable></option>. For example: <screen> # mkswap -L swap /dev/sda2</screen> - - </para></listitem> - - <listitem> - <variablelist> - <varlistentry><term>UEFI systems</term> - <listitem><para>For creating boot partitions: - <command>mkfs.fat</command>. Again it’s recommended to assign a - label to the boot partition: <option>-n - <replaceable>label</replaceable></option>. For example: - + </para> + </listitem> + <listitem> + <variablelist> + <varlistentry> + <term>UEFI systems</term> + <listitem> + <para> + For creating boot partitions: <command>mkfs.fat</command>. Again + it’s recommended to assign a label to the boot partition: + <option>-n <replaceable>label</replaceable></option>. For example: <screen> # mkfs.fat -F 32 -n boot /dev/sda3</screen> - - </para></listitem></varlistentry></variablelist></listitem> - - <listitem><para>For creating LVM volumes, the LVM commands, e.g., - <command>pvcreate</command>, <command>vgcreate</command>, and - <command>lvcreate</command>.</para></listitem> - - <listitem><para>For creating software RAID devices, use - <command>mdadm</command>.</para></listitem> - - </itemizedlist> - - </para></listitem> - - <listitem><para>Mount the target file system on which NixOS should - be installed on <filename>/mnt</filename>, e.g. - + </para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + <listitem> + <para> + For creating LVM volumes, the LVM commands, e.g., + <command>pvcreate</command>, <command>vgcreate</command>, and + <command>lvcreate</command>. + </para> + </listitem> + <listitem> + <para> + For creating software RAID devices, use <command>mdadm</command>. + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + <listitem> + <para> + Mount the target file system on which NixOS should be installed on + <filename>/mnt</filename>, e.g. <screen> # mount /dev/disk/by-label/nixos /mnt </screen> - - </para></listitem> - + </para> + </listitem> <listitem> - <variablelist> - <varlistentry><term>UEFI systems</term> - <listitem><para>Mount the boot file system on <filename>/mnt/boot</filename>, e.g. - + <variablelist> + <varlistentry> + <term>UEFI systems</term> + <listitem> + <para> + Mount the boot file system on <filename>/mnt/boot</filename>, e.g. <screen> # mkdir -p /mnt/boot # mount /dev/disk/by-label/boot /mnt/boot </screen> - - </para></listitem></varlistentry></variablelist></listitem> - - <listitem><para>If your machine has a limited amount of memory, you - may want to activate swap devices now (<command>swapon - <replaceable>device</replaceable></command>). The installer (or - rather, the build actions that it may spawn) may need quite a bit of - RAM, depending on your configuration. - + </para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + <listitem> + <para> + If your machine has a limited amount of memory, you may want to activate + swap devices now (<command>swapon + <replaceable>device</replaceable></command>). The installer (or rather, the + build actions that it may spawn) may need quite a bit of RAM, depending on + your configuration. <screen> # swapon /dev/sda2</screen> - - </para></listitem> - + </para> + </listitem> <listitem> - - <para>You now need to create a file - <filename>/mnt/etc/nixos/configuration.nix</filename> that - specifies the intended configuration of the system. This is - because NixOS has a <emphasis>declarative</emphasis> configuration - model: you create or edit a description of the desired - configuration of your system, and then NixOS takes care of making - it happen. The syntax of the NixOS configuration file is - described in <xref linkend="sec-configuration-syntax"/>, while a - list of available configuration options appears in <xref - linkend="ch-options"/>. A minimal example is shown in <xref - linkend="ex-config"/>.</para> - - <para>The command <command>nixos-generate-config</command> can - generate an initial configuration file for you: - + <para> + You now need to create a file + <filename>/mnt/etc/nixos/configuration.nix</filename> that specifies the + intended configuration of the system. This is because NixOS has a + <emphasis>declarative</emphasis> configuration model: you create or edit a + description of the desired configuration of your system, and then NixOS + takes care of making it happen. The syntax of the NixOS configuration file + is described in <xref linkend="sec-configuration-syntax"/>, while a list of + available configuration options appears in + <xref + linkend="ch-options"/>. A minimal example is shown in + <xref + linkend="ex-config"/>. + </para> + <para> + The command <command>nixos-generate-config</command> can generate an + initial configuration file for you: <screen> # nixos-generate-config --root /mnt</screen> - - You should then edit - <filename>/mnt/etc/nixos/configuration.nix</filename> to suit your - needs: - + You should then edit <filename>/mnt/etc/nixos/configuration.nix</filename> + to suit your needs: <screen> # nano /mnt/etc/nixos/configuration.nix </screen> - - If you’re using the graphical ISO image, other editors may be - available (such as <command>vim</command>). If you have network - access, you can also install other editors — for instance, you can - install Emacs by running <literal>nix-env -i - emacs</literal>.</para> - - <variablelist> - - <varlistentry><term>BIOS systems</term> - <listitem><para>You <emphasis>must</emphasis> set the option - <xref linkend="opt-boot.loader.grub.device"/> to specify on which disk - the GRUB boot loader is to be installed. Without it, NixOS cannot - boot.</para></listitem></varlistentry> - - <varlistentry><term>UEFI systems</term> - <listitem><para>You <emphasis>must</emphasis> set the option - <xref linkend="opt-boot.loader.systemd-boot.enable"/> to <literal>true</literal>. - <command>nixos-generate-config</command> should do this automatically for new - configurations when booted in - UEFI mode.</para> - <para>You may want to look at the options starting with - <option><link linkend="opt-boot.loader.efi.canTouchEfiVariables">boot.loader.efi</link></option> and - <option><link linkend="opt-boot.loader.systemd-boot.enable">boot.loader.systemd</link></option> as well. - </para> - </listitem> - </varlistentry> - - </variablelist> - - <para>If there are other operating systems running on the machine before - installing NixOS, the - <xref linkend="opt-boot.loader.grub.useOSProber"/> option can be set to - <literal>true</literal> to automatically add them to the grub menu.</para> - - <para>Another critical option is <option>fileSystems</option>, - specifying the file systems that need to be mounted by NixOS. - However, you typically don’t need to set it yourself, because + If you’re using the graphical ISO image, other editors may be available + (such as <command>vim</command>). If you have network access, you can also + install other editors — for instance, you can install Emacs by running + <literal>nix-env -i emacs</literal>. + </para> + <variablelist> + <varlistentry> + <term>BIOS systems</term> + <listitem> + <para> + You <emphasis>must</emphasis> set the option + <xref linkend="opt-boot.loader.grub.device"/> to specify on which disk + the GRUB boot loader is to be installed. Without it, NixOS cannot boot. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>UEFI systems</term> + <listitem> + <para> + You <emphasis>must</emphasis> set the option + <xref linkend="opt-boot.loader.systemd-boot.enable"/> to + <literal>true</literal>. <command>nixos-generate-config</command> should + do this automatically for new configurations when booted in UEFI mode. + </para> + <para> + You may want to look at the options starting with + <option><link linkend="opt-boot.loader.efi.canTouchEfiVariables">boot.loader.efi</link></option> + and + <option><link linkend="opt-boot.loader.systemd-boot.enable">boot.loader.systemd</link></option> + as well. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + If there are other operating systems running on the machine before + installing NixOS, the <xref linkend="opt-boot.loader.grub.useOSProber"/> + option can be set to <literal>true</literal> to automatically add them to + the grub menu. + </para> + <para> + Another critical option is <option>fileSystems</option>, specifying the + file systems that need to be mounted by NixOS. However, you typically + don’t need to set it yourself, because <command>nixos-generate-config</command> sets it automatically in - <filename>/mnt/etc/nixos/hardware-configuration.nix</filename> - from your currently mounted file systems. (The configuration file + <filename>/mnt/etc/nixos/hardware-configuration.nix</filename> from your + currently mounted file systems. (The configuration file <filename>hardware-configuration.nix</filename> is included from - <filename>configuration.nix</filename> and will be overwritten by - future invocations of <command>nixos-generate-config</command>; - thus, you generally should not modify it.)</para> - - <note><para>Depending on your hardware configuration or type of - file system, you may need to set the option - <option>boot.initrd.kernelModules</option> to include the kernel - modules that are necessary for mounting the root file system, - otherwise the installed system will not be able to boot. (If this - happens, boot from the CD again, mount the target file system on - <filename>/mnt</filename>, fix - <filename>/mnt/etc/nixos/configuration.nix</filename> and rerun - <filename>nixos-install</filename>.) In most cases, - <command>nixos-generate-config</command> will figure out the - required modules.</para></note> - + <filename>configuration.nix</filename> and will be overwritten by future + invocations of <command>nixos-generate-config</command>; thus, you + generally should not modify it.) + </para> + <note> + <para> + Depending on your hardware configuration or type of file system, you may + need to set the option <option>boot.initrd.kernelModules</option> to + include the kernel modules that are necessary for mounting the root file + system, otherwise the installed system will not be able to boot. (If this + happens, boot from the CD again, mount the target file system on + <filename>/mnt</filename>, fix + <filename>/mnt/etc/nixos/configuration.nix</filename> and rerun + <filename>nixos-install</filename>.) In most cases, + <command>nixos-generate-config</command> will figure out the required + modules. + </para> + </note> </listitem> - - <listitem><para>Do the installation: - + <listitem> + <para> + Do the installation: <screen> # nixos-install</screen> - - Cross fingers. If this fails due to a temporary problem (such as - a network issue while downloading binaries from the NixOS binary - cache), you can just re-run <command>nixos-install</command>. - Otherwise, fix your <filename>configuration.nix</filename> and - then re-run <command>nixos-install</command>.</para> - - <para>As the last step, <command>nixos-install</command> will ask - you to set the password for the <literal>root</literal> user, e.g. - - <screen> + Cross fingers. If this fails due to a temporary problem (such as a network + issue while downloading binaries from the NixOS binary cache), you can just + re-run <command>nixos-install</command>. Otherwise, fix your + <filename>configuration.nix</filename> and then re-run + <command>nixos-install</command>. + </para> + <para> + As the last step, <command>nixos-install</command> will ask you to set the + password for the <literal>root</literal> user, e.g. +<screen> setting root password... Enter new UNIX password: *** Retype new UNIX password: *** </screen> - <note> - <para> - To prevent the password prompt, set <code><xref linkend="opt-users.mutableUsers"/> = false;</code> in - <filename>configuration.nix</filename>, which allows unattended installation - necessary in automation. - </para> + <para> + To prevent the password prompt, set + <code><xref linkend="opt-users.mutableUsers"/> = false;</code> in + <filename>configuration.nix</filename>, which allows unattended + installation necessary in automation. + </para> </note> - - </para> - + </para> </listitem> - <listitem> - <para>If everything went well: - - <screen> + <para> + If everything went well: +<screen> # reboot</screen> - - </para></listitem> - + </para> + </listitem> <listitem> - - <para>You should now be able to boot into the installed NixOS. The - GRUB boot menu shows a list of <emphasis>available - configurations</emphasis> (initially just one). Every time you - change the NixOS configuration (see <link - linkend="sec-changing-config">Changing Configuration</link> ), a - new item is added to the menu. This allows you to easily roll back - to a previous configuration if something goes wrong.</para> - - <para>You should log in and change the <literal>root</literal> - password with <command>passwd</command>.</para> - - <para>You’ll probably want to create some user accounts as well, - which can be done with <command>useradd</command>: - + <para> + You should now be able to boot into the installed NixOS. The GRUB boot menu + shows a list of <emphasis>available configurations</emphasis> (initially + just one). Every time you change the NixOS configuration (see + <link + linkend="sec-changing-config">Changing Configuration</link> + ), a new item is added to the menu. This allows you to easily roll back to + a previous configuration if something goes wrong. + </para> + <para> + You should log in and change the <literal>root</literal> password with + <command>passwd</command>. + </para> + <para> + You’ll probably want to create some user accounts as well, which can be + done with <command>useradd</command>: <screen> $ useradd -c 'Eelco Dolstra' -m eelco $ passwd eelco</screen> - - </para> - - <para>You may also want to install some software. For instance, - + </para> + <para> + You may also want to install some software. For instance, <screen> $ nix-env -qa \*</screen> - shows what packages are available, and - <screen> $ nix-env -i w3m</screen> - - install the <literal>w3m</literal> browser.</para> - + install the <literal>w3m</literal> browser. + </para> </listitem> - -</orderedlist> - -<para>To summarise, <xref linkend="ex-install-sequence" /> shows a -typical sequence of commands for installing NixOS on an empty hard -drive (here <filename>/dev/sda</filename>). <xref linkend="ex-config" -/> shows a corresponding configuration Nix expression.</para> - -<example xml:id='ex-install-sequence'><title>Commands for Installing NixOS on <filename>/dev/sda</filename></title> + </orderedlist> + <para> + To summarise, <xref linkend="ex-install-sequence" /> shows a typical sequence + of commands for installing NixOS on an empty hard drive (here + <filename>/dev/sda</filename>). <xref linkend="ex-config" +/> shows a + corresponding configuration Nix expression. + </para> + <example xml:id='ex-install-sequence'> + <title>Commands for Installing NixOS on <filename>/dev/sda</filename></title> <screen> # fdisk /dev/sda # <lineannotation>(or whatever device you want to install on)</lineannotation> -- for UEFI systems only @@ -372,10 +407,10 @@ drive (here <filename>/dev/sda</filename>). <xref linkend="ex-config" # nano /mnt/etc/nixos/configuration.nix # nixos-install # reboot</screen> -</example> - -<example xml:id='ex-config'><title>NixOS Configuration</title> - <screen> + </example> + <example xml:id='ex-config'> + <title>NixOS Configuration</title> +<screen> { config, pkgs, ... }: { imports = [ # Include the results of the hardware scan. @@ -394,11 +429,9 @@ drive (here <filename>/dev/sda</filename>). <xref linkend="ex-config" services.sshd.enable = true; } </screen> -</example> - -<xi:include href="installing-usb.xml" /> -<xi:include href="installing-pxe.xml" /> -<xi:include href="installing-virtualbox-guest.xml" /> -<xi:include href="installing-from-other-distro.xml" /> - + </example> + <xi:include href="installing-usb.xml" /> + <xi:include href="installing-pxe.xml" /> + <xi:include href="installing-virtualbox-guest.xml" /> + <xi:include href="installing-from-other-distro.xml" /> </chapter> diff --git a/nixos/doc/manual/installation/obtaining.xml b/nixos/doc/manual/installation/obtaining.xml index 9b2b474c60ce..56af5c0e25a0 100644 --- a/nixos/doc/manual/installation/obtaining.xml +++ b/nixos/doc/manual/installation/obtaining.xml @@ -3,46 +3,52 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-obtaining"> - -<title>Obtaining NixOS</title> - -<para>NixOS ISO images can be downloaded from the <link -xlink:href="http://nixos.org/nixos/download.html">NixOS -download page</link>. There are a number of installation options. If -you happen to have an optical drive and a spare CD, burning the -image to CD and booting from that is probably the easiest option. -Most people will need to prepare a USB stick to boot from. -<xref linkend="sec-booting-from-usb"/> describes the preferred method -to prepare a USB stick. -A number of alternative methods are presented in the <link + <title>Obtaining NixOS</title> + <para> + NixOS ISO images can be downloaded from the + <link +xlink:href="http://nixos.org/nixos/download.html">NixOS download + page</link>. There are a number of installation options. If you happen to + have an optical drive and a spare CD, burning the image to CD and booting + from that is probably the easiest option. Most people will need to prepare a + USB stick to boot from. <xref linkend="sec-booting-from-usb"/> describes the + preferred method to prepare a USB stick. A number of alternative methods are + presented in the + <link xlink:href="https://nixos.wiki/wiki/NixOS_Installation_Guide#Making_the_installation_media">NixOS -Wiki</link>.</para> - -<para>As an alternative to installing NixOS yourself, you can get a -running NixOS system through several other means: - -<itemizedlist> - <listitem> - <para>Using virtual appliances in Open Virtualization Format (OVF) - that can be imported into VirtualBox. These are available from - the <link xlink:href="http://nixos.org/nixos/download.html">NixOS - download page</link>.</para> - </listitem> - <listitem> - <para>Using AMIs for Amazon’s EC2. To find one for your region - and instance type, please refer to the <link + Wiki</link>. + </para> + <para> + As an alternative to installing NixOS yourself, you can get a running NixOS + system through several other means: + <itemizedlist> + <listitem> + <para> + Using virtual appliances in Open Virtualization Format (OVF) that can be + imported into VirtualBox. These are available from the + <link xlink:href="http://nixos.org/nixos/download.html">NixOS download + page</link>. + </para> + </listitem> + <listitem> + <para> + Using AMIs for Amazon’s EC2. To find one for your region and instance + type, please refer to the + <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/virtualisation/ec2-amis.nix">list - of most recent AMIs</link>.</para> - </listitem> - <listitem> - <para>Using NixOps, the NixOS-based cloud deployment tool, which - allows you to provision VirtualBox and EC2 NixOS instances from - declarative specifications. Check out the <link + of most recent AMIs</link>. + </para> + </listitem> + <listitem> + <para> + Using NixOps, the NixOS-based cloud deployment tool, which allows you to + provision VirtualBox and EC2 NixOS instances from declarative + specifications. Check out the + <link xlink:href="https://nixos.org/nixops">NixOps homepage</link> for - details.</para> - </listitem> -</itemizedlist> - -</para> - + details. + </para> + </listitem> + </itemizedlist> + </para> </chapter> diff --git a/nixos/doc/manual/installation/upgrading.xml b/nixos/doc/manual/installation/upgrading.xml index 24881c8fec0f..20355812ec63 100644 --- a/nixos/doc/manual/installation/upgrading.xml +++ b/nixos/doc/manual/installation/upgrading.xml @@ -2,140 +2,130 @@ xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="sec-upgrading"> - -<title>Upgrading NixOS</title> - -<para>The best way to keep your NixOS installation up to date is to -use one of the NixOS <emphasis>channels</emphasis>. A channel is a -Nix mechanism for distributing Nix expressions and associated -binaries. The NixOS channels are updated automatically from NixOS’s -Git repository after certain tests have passed and all packages have -been built. These channels are: - -<itemizedlist> - <listitem> - <para><emphasis>Stable channels</emphasis>, such as <literal + <title>Upgrading NixOS</title> + <para> + The best way to keep your NixOS installation up to date is to use one of the + NixOS <emphasis>channels</emphasis>. A channel is a Nix mechanism for + distributing Nix expressions and associated binaries. The NixOS channels are + updated automatically from NixOS’s Git repository after certain tests have + passed and all packages have been built. These channels are: + <itemizedlist> + <listitem> + <para> + <emphasis>Stable channels</emphasis>, such as + <literal xlink:href="https://nixos.org/channels/nixos-17.03">nixos-17.03</literal>. - These only get conservative bug fixes and package upgrades. For - instance, a channel update may cause the Linux kernel on your - system to be upgraded from 4.9.16 to 4.9.17 (a minor bug fix), but - not from 4.9.<replaceable>x</replaceable> to - 4.11.<replaceable>x</replaceable> (a major change that has the - potential to break things). Stable channels are generally - maintained until the next stable branch is created.</para> + These only get conservative bug fixes and package upgrades. For instance, + a channel update may cause the Linux kernel on your system to be upgraded + from 4.9.16 to 4.9.17 (a minor bug fix), but not from + 4.9.<replaceable>x</replaceable> to 4.11.<replaceable>x</replaceable> (a + major change that has the potential to break things). Stable channels are + generally maintained until the next stable branch is created. + </para> <para></para> - </listitem> - <listitem> - <para>The <emphasis>unstable channel</emphasis>, <literal + </listitem> + <listitem> + <para> + The <emphasis>unstable channel</emphasis>, + <literal xlink:href="https://nixos.org/channels/nixos-unstable">nixos-unstable</literal>. - This corresponds to NixOS’s main development branch, and may thus - see radical changes between channel updates. It’s not recommended - for production systems.</para> - </listitem> - <listitem> - <para><emphasis>Small channels</emphasis>, such as <literal + This corresponds to NixOS’s main development branch, and may thus see + radical changes between channel updates. It’s not recommended for + production systems. + </para> + </listitem> + <listitem> + <para> + <emphasis>Small channels</emphasis>, such as + <literal xlink:href="https://nixos.org/channels/nixos-17.03-small">nixos-17.03-small</literal> - or <literal - xlink:href="https://nixos.org/channels/nixos-unstable-small">nixos-unstable-small</literal>. These - are identical to the stable and unstable channels described above, - except that they contain fewer binary packages. This means they - get updated faster than the regular channels (for instance, when a - critical security patch is committed to NixOS’s source tree), but - may require more packages to be built from source than - usual. They’re mostly intended for server environments and as such - contain few GUI applications.</para> - </listitem> -</itemizedlist> - -To see what channels are available, go to <link -xlink:href="https://nixos.org/channels"/>. (Note that the URIs of the -various channels redirect to a directory that contains the channel’s -latest version and includes ISO images and VirtualBox -appliances.)</para> - -<para>When you first install NixOS, you’re automatically subscribed to -the NixOS channel that corresponds to your installation source. For -instance, if you installed from a 17.03 ISO, you will be subscribed to -the <literal>nixos-17.03</literal> channel. To see which NixOS -channel you’re subscribed to, run the following as root: - + or + <literal + xlink:href="https://nixos.org/channels/nixos-unstable-small">nixos-unstable-small</literal>. + These are identical to the stable and unstable channels described above, + except that they contain fewer binary packages. This means they get + updated faster than the regular channels (for instance, when a critical + security patch is committed to NixOS’s source tree), but may require + more packages to be built from source than usual. They’re mostly + intended for server environments and as such contain few GUI applications. + </para> + </listitem> + </itemizedlist> + To see what channels are available, go to + <link +xlink:href="https://nixos.org/channels"/>. (Note that the URIs of the + various channels redirect to a directory that contains the channel’s latest + version and includes ISO images and VirtualBox appliances.) + </para> + <para> + When you first install NixOS, you’re automatically subscribed to the NixOS + channel that corresponds to your installation source. For instance, if you + installed from a 17.03 ISO, you will be subscribed to the + <literal>nixos-17.03</literal> channel. To see which NixOS channel you’re + subscribed to, run the following as root: <screen> # nix-channel --list | grep nixos nixos https://nixos.org/channels/nixos-unstable </screen> - -To switch to a different NixOS channel, do - + To switch to a different NixOS channel, do <screen> # nix-channel --add https://nixos.org/channels/<replaceable>channel-name</replaceable> nixos </screen> - -(Be sure to include the <literal>nixos</literal> parameter at the -end.) For instance, to use the NixOS 17.03 stable channel: - + (Be sure to include the <literal>nixos</literal> parameter at the end.) For + instance, to use the NixOS 17.03 stable channel: <screen> # nix-channel --add https://nixos.org/channels/nixos-17.03 nixos </screen> - -If you have a server, you may want to use the “small” channel instead: - + If you have a server, you may want to use the “small” channel instead: <screen> # nix-channel --add https://nixos.org/channels/nixos-17.03-small nixos </screen> - -And if you want to live on the bleeding edge: - + And if you want to live on the bleeding edge: <screen> # nix-channel --add https://nixos.org/channels/nixos-unstable nixos </screen> - -</para> - -<para>You can then upgrade NixOS to the latest version in your chosen -channel by running - + </para> + <para> + You can then upgrade NixOS to the latest version in your chosen channel by + running <screen> # nixos-rebuild switch --upgrade </screen> - -which is equivalent to the more verbose <literal>nix-channel --update -nixos; nixos-rebuild switch</literal>.</para> - -<note><para>Channels are set per user. This means that running <literal> -nix-channel --add</literal> as a non root user (or without sudo) will not -affect configuration in <literal>/etc/nixos/configuration.nix</literal> -</para></note> - -<warning><para>It is generally safe to switch back and forth between -channels. The only exception is that a newer NixOS may also have a -newer Nix version, which may involve an upgrade of Nix’s database -schema. This cannot be undone easily, so in that case you will not be -able to go back to your original channel.</para></warning> - - -<section><title>Automatic Upgrades</title> - -<para>You can keep a NixOS system up-to-date automatically by adding -the following to <filename>configuration.nix</filename>: - + which is equivalent to the more verbose <literal>nix-channel --update nixos; + nixos-rebuild switch</literal>. + </para> + <note> + <para> + Channels are set per user. This means that running <literal> nix-channel + --add</literal> as a non root user (or without sudo) will not affect + configuration in <literal>/etc/nixos/configuration.nix</literal> + </para> + </note> + <warning> + <para> + It is generally safe to switch back and forth between channels. The only + exception is that a newer NixOS may also have a newer Nix version, which may + involve an upgrade of Nix’s database schema. This cannot be undone easily, + so in that case you will not be able to go back to your original channel. + </para> + </warning> + <section> + <title>Automatic Upgrades</title> + + <para> + You can keep a NixOS system up-to-date automatically by adding the following + to <filename>configuration.nix</filename>: <programlisting> <xref linkend="opt-system.autoUpgrade.enable"/> = true; </programlisting> - -This enables a periodically executed systemd service named -<literal>nixos-upgrade.service</literal>. It runs -<command>nixos-rebuild switch --upgrade</command> to upgrade NixOS to -the latest version in the current channel. (To see when the service -runs, see <command>systemctl list-timers</command>.) You can also -specify a channel explicitly, e.g. - + This enables a periodically executed systemd service named + <literal>nixos-upgrade.service</literal>. It runs <command>nixos-rebuild + switch --upgrade</command> to upgrade NixOS to the latest version in the + current channel. (To see when the service runs, see <command>systemctl + list-timers</command>.) You can also specify a channel explicitly, e.g. <programlisting> <xref linkend="opt-system.autoUpgrade.channel"/> = https://nixos.org/channels/nixos-17.03; </programlisting> - -</para> - -</section> - - + </para> + </section> </chapter> diff --git a/nixos/doc/manual/man-configuration.xml b/nixos/doc/manual/man-configuration.xml index 37ffb9d648a9..9f30b7925101 100644 --- a/nixos/doc/manual/man-configuration.xml +++ b/nixos/doc/manual/man-configuration.xml @@ -1,39 +1,31 @@ <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"> - -<refmeta> - <refentrytitle><filename>configuration.nix</filename></refentrytitle> - <manvolnum>5</manvolnum> + <refmeta> + <refentrytitle><filename>configuration.nix</filename> + </refentrytitle><manvolnum>5</manvolnum> <refmiscinfo class="source">NixOS</refmiscinfo> - <!-- <refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo> --> -</refmeta> - -<refnamediv> - <refname><filename>configuration.nix</filename></refname> - <refpurpose>NixOS system configuration specification</refpurpose> -</refnamediv> - - -<refsection><title>Description</title> - -<para>The file <filename>/etc/nixos/configuration.nix</filename> -contains the declarative specification of your NixOS system -configuration. The command <command>nixos-rebuild</command> takes -this file and realises the system configuration specified -therein.</para> - -</refsection> - - -<refsection><title>Options</title> - -<para>You can use the following options in -<filename>configuration.nix</filename>.</para> - -<xi:include href="./generated/options-db.xml" +<!-- <refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo> --> + </refmeta> + <refnamediv> + <refname><filename>configuration.nix</filename> + </refname><refpurpose>NixOS system configuration specification</refpurpose> + </refnamediv> + <refsection> + <title>Description</title> + <para> + The file <filename>/etc/nixos/configuration.nix</filename> contains the + declarative specification of your NixOS system configuration. The command + <command>nixos-rebuild</command> takes this file and realises the system + configuration specified therein. + </para> + </refsection> + <refsection> + <title>Options</title> + <para> + You can use the following options in <filename>configuration.nix</filename>. + </para> + <xi:include href="./generated/options-db.xml" xpointer="configuration-variable-list" /> - -</refsection> - + </refsection> </refentry> diff --git a/nixos/doc/manual/man-nixos-build-vms.xml b/nixos/doc/manual/man-nixos-build-vms.xml index f4b59a7c6d4b..02dad4c548b8 100644 --- a/nixos/doc/manual/man-nixos-build-vms.xml +++ b/nixos/doc/manual/man-nixos-build-vms.xml @@ -1,40 +1,39 @@ <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"> - -<refmeta> - <refentrytitle><command>nixos-build-vms</command></refentrytitle> - <manvolnum>8</manvolnum> + <refmeta> + <refentrytitle><command>nixos-build-vms</command> + </refentrytitle><manvolnum>8</manvolnum> <refmiscinfo class="source">NixOS</refmiscinfo> - <!-- <refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo> --> -</refmeta> - -<refnamediv> - <refname><command>nixos-build-vms</command></refname> - <refpurpose>build a network of virtual machines from a network of NixOS configurations</refpurpose> -</refnamediv> - -<refsynopsisdiv> - <cmdsynopsis> - <command>nixos-build-vms</command> - <arg><option>--show-trace</option></arg> - <arg><option>--no-out-link</option></arg> - <arg><option>--help</option></arg> - <arg choice="plain"><replaceable>network.nix</replaceable></arg> +<!-- <refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo> --> + </refmeta> + <refnamediv> + <refname><command>nixos-build-vms</command> + </refname><refpurpose>build a network of virtual machines from a network of NixOS configurations</refpurpose> + </refnamediv> + <refsynopsisdiv> + <cmdsynopsis><command>nixos-build-vms</command> + <arg><option>--show-trace</option> + </arg> + <arg><option>--no-out-link</option> + </arg> + <arg><option>--help</option> + </arg> + <arg choice="plain"><replaceable>network.nix</replaceable> + </arg> </cmdsynopsis> -</refsynopsisdiv> - -<refsection><title>Description</title> - -<para>This command builds a network of QEMU-KVM virtual machines of a Nix expression -specifying a network of NixOS machines. The virtual network can be started by -executing the <filename>bin/run-vms</filename> shell script that is generated by -this command. By default, a <filename>result</filename> symlink is produced that -points to the generated virtual network. -</para> - -<para>A network Nix expression has the following structure: - + </refsynopsisdiv> + <refsection> + <title>Description</title> + <para> + This command builds a network of QEMU-KVM virtual machines of a Nix + expression specifying a network of NixOS machines. The virtual network can + be started by executing the <filename>bin/run-vms</filename> shell script + that is generated by this command. By default, a <filename>result</filename> + symlink is produced that points to the generated virtual network. + </para> + <para> + A network Nix expression has the following structure: <screen> { test1 = {pkgs, config, ...}: @@ -58,53 +57,53 @@ points to the generated virtual network. }; } </screen> - -Each attribute in the expression represents a machine in the network -(e.g. <varname>test1</varname> and <varname>test2</varname>) -referring to a function defining a NixOS configuration. -In each NixOS configuration, two attributes have a special meaning. -The <varname>deployment.targetHost</varname> specifies the address -(domain name or IP address) -of the system which is used by <command>ssh</command> to perform -remote deployment operations. The <varname>nixpkgs.localSystem.system</varname> -attribute can be used to specify an architecture for the target machine, -such as <varname>i686-linux</varname> which builds a 32-bit NixOS -configuration. Omitting this property will build the configuration -for the same architecture as the host system. -</para> - -</refsection> - -<refsection><title>Options</title> - -<para>This command accepts the following options:</para> - -<variablelist> - - <varlistentry> - <term><option>--show-trace</option></term> + Each attribute in the expression represents a machine in the network (e.g. + <varname>test1</varname> and <varname>test2</varname>) referring to a + function defining a NixOS configuration. In each NixOS configuration, two + attributes have a special meaning. The + <varname>deployment.targetHost</varname> specifies the address (domain name + or IP address) of the system which is used by <command>ssh</command> to + perform remote deployment operations. The + <varname>nixpkgs.localSystem.system</varname> attribute can be used to + specify an architecture for the target machine, such as + <varname>i686-linux</varname> which builds a 32-bit NixOS configuration. + Omitting this property will build the configuration for the same + architecture as the host system. + </para> + </refsection> + <refsection> + <title>Options</title> + <para> + This command accepts the following options: + </para> + <variablelist> + <varlistentry> + <term><option>--show-trace</option> + </term> <listitem> - <para>Shows a trace of the output.</para> + <para> + Shows a trace of the output. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><option>--no-out-link</option></term> + </varlistentry> + <varlistentry> + <term><option>--no-out-link</option> + </term> <listitem> - <para>Do not create a 'result' symlink.</para> + <para> + Do not create a 'result' symlink. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><option>-h</option>, <option>--help</option></term> + </varlistentry> + <varlistentry> + <term><option>-h</option>, <option>--help</option> + </term> <listitem> - <para>Shows the usage of this command to the user.</para> + <para> + Shows the usage of this command to the user. + </para> </listitem> - </varlistentry> - -</variablelist> - -</refsection> - - + </varlistentry> + </variablelist> + </refsection> </refentry> diff --git a/nixos/doc/manual/man-nixos-enter.xml b/nixos/doc/manual/man-nixos-enter.xml index a2fbe07961db..7db4b72ee36e 100644 --- a/nixos/doc/manual/man-nixos-enter.xml +++ b/nixos/doc/manual/man-nixos-enter.xml @@ -1,119 +1,119 @@ <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"> - -<refmeta> - <refentrytitle><command>nixos-enter</command></refentrytitle> - <manvolnum>8</manvolnum> + <refmeta> + <refentrytitle><command>nixos-enter</command> + </refentrytitle><manvolnum>8</manvolnum> <refmiscinfo class="source">NixOS</refmiscinfo> - <!-- <refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo> --> -</refmeta> - -<refnamediv> - <refname><command>nixos-enter</command></refname> - <refpurpose>run a command in a NixOS chroot environment</refpurpose> -</refnamediv> - -<refsynopsisdiv> - <cmdsynopsis> - <command>nixos-enter</command> - <arg> - <arg choice='plain'><option>--root</option></arg> - <replaceable>root</replaceable> - </arg> - <arg> - <arg choice='plain'><option>--system</option></arg> - <replaceable>system</replaceable> - </arg> - <arg> - <arg choice='plain'><option>-c</option></arg> - <replaceable>shell-command</replaceable> - </arg> - <arg> - <arg choice='plain'><option>--help</option></arg> - </arg> - <arg> - <arg choice='plain'><option>--</option></arg> - <replaceable>arguments</replaceable> +<!-- <refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo> --> + </refmeta> + <refnamediv> + <refname><command>nixos-enter</command> + </refname><refpurpose>run a command in a NixOS chroot environment</refpurpose> + </refnamediv> + <refsynopsisdiv> + <cmdsynopsis><command>nixos-enter</command> + <arg> + <arg choice='plain'><option>--root</option> + </arg><replaceable>root</replaceable> + </arg> + <arg> + <arg choice='plain'><option>--system</option> + </arg><replaceable>system</replaceable> + </arg> + <arg> + <arg choice='plain'><option>-c</option> + </arg><replaceable>shell-command</replaceable> + </arg> + <arg> + <arg choice='plain'><option>--help</option> </arg> + </arg> + <arg> + <arg choice='plain'><option>--</option> + </arg><replaceable>arguments</replaceable> + </arg> </cmdsynopsis> -</refsynopsisdiv> - - -<refsection><title>Description</title> - -<para>This command runs a command in a NixOS chroot environment, that -is, in a filesystem hierarchy previously prepared using -<command>nixos-install</command>.</para> - -</refsection> - -<refsection><title>Options</title> - -<para>This command accepts the following options:</para> - -<variablelist> - - <varlistentry> - <term><option>--root</option></term> + </refsynopsisdiv> + <refsection> + <title>Description</title> + <para> + This command runs a command in a NixOS chroot environment, that is, in a + filesystem hierarchy previously prepared using + <command>nixos-install</command>. + </para> + </refsection> + <refsection> + <title>Options</title> + <para> + This command accepts the following options: + </para> + <variablelist> + <varlistentry> + <term><option>--root</option> + </term> + <listitem> + <para> + The path to the NixOS system you want to enter. It defaults to + <filename>/mnt</filename>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>--system</option> + </term> <listitem> - <para>The path to the NixOS system you want to enter. It defaults to <filename>/mnt</filename>.</para> + <para> + The NixOS system configuration to use. It defaults to + <filename>/nix/var/nix/profiles/system</filename>. You can enter a + previous NixOS configuration by specifying a path such as + <filename>/nix/var/nix/profiles/system-106-link</filename>. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><option>--system</option></term> + </varlistentry> + <varlistentry> + <term><option>--command</option> + </term> + <term><option>-c</option> + </term> <listitem> - <para>The NixOS system configuration to use. It defaults to - <filename>/nix/var/nix/profiles/system</filename>. You can enter - a previous NixOS configuration by specifying a path such as - <filename>/nix/var/nix/profiles/system-106-link</filename>.</para> + <para> + The bash command to execute. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><option>--command</option></term> - <term><option>-c</option></term> + </varlistentry> + <varlistentry> + <term><option>--</option> + </term> <listitem> - <para>The bash command to execute.</para> + <para> + Interpret the remaining arguments as the program name and arguments to be + invoked. The program is not executed in a shell. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><option>--</option></term> - - <listitem><para>Interpret the remaining arguments as the program - name and arguments to be invoked. The program is not executed in a - shell.</para></listitem> - - </varlistentry> - -</variablelist> - -</refsection> - - -<refsection><title>Examples</title> - -<para>Start an interactive shell in the NixOS installation in -<filename>/mnt</filename>:</para> - + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Examples</title> + <para> + Start an interactive shell in the NixOS installation in + <filename>/mnt</filename>: + </para> <screen> # nixos-enter /mnt </screen> - -<para>Run a shell command:</para> - + <para> + Run a shell command: + </para> <screen> # nixos-enter -c 'ls -l /; cat /proc/mounts' </screen> - -<para>Run a non-shell command:</para> - + <para> + Run a non-shell command: + </para> <screen> # nixos-enter -- cat /proc/mounts </screen> - -</refsection> - + </refsection> </refentry> diff --git a/nixos/doc/manual/man-nixos-generate-config.xml b/nixos/doc/manual/man-nixos-generate-config.xml index 993a932ddfbe..8bf90f452db6 100644 --- a/nixos/doc/manual/man-nixos-generate-config.xml +++ b/nixos/doc/manual/man-nixos-generate-config.xml @@ -1,152 +1,149 @@ <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"> - -<refmeta> - <refentrytitle><command>nixos-generate-config</command></refentrytitle> - <manvolnum>8</manvolnum> + <refmeta> + <refentrytitle><command>nixos-generate-config</command> + </refentrytitle><manvolnum>8</manvolnum> <refmiscinfo class="source">NixOS</refmiscinfo> - <!-- <refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo> --> -</refmeta> - -<refnamediv> - <refname><command>nixos-generate-config</command></refname> - <refpurpose>generate NixOS configuration modules</refpurpose> -</refnamediv> - -<refsynopsisdiv> - <cmdsynopsis> - <command>nixos-generate-config</command> - <arg><option>--force</option></arg> - <arg> - <arg choice='plain'><option>--root</option></arg> - <replaceable>root</replaceable> - </arg> - <arg> - <arg choice='plain'><option>--dir</option></arg> - <replaceable>dir</replaceable> - </arg> +<!-- <refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo> --> + </refmeta> + <refnamediv> + <refname><command>nixos-generate-config</command> + </refname><refpurpose>generate NixOS configuration modules</refpurpose> + </refnamediv> + <refsynopsisdiv> + <cmdsynopsis><command>nixos-generate-config</command> + <arg><option>--force</option> + </arg> + <arg> + <arg choice='plain'><option>--root</option> + </arg><replaceable>root</replaceable> + </arg> + <arg> + <arg choice='plain'><option>--dir</option> + </arg><replaceable>dir</replaceable> + </arg> </cmdsynopsis> -</refsynopsisdiv> - - -<refsection><title>Description</title> - -<para>This command writes two NixOS configuration modules: - -<variablelist> - - <varlistentry> - <term><option>/etc/nixos/hardware-configuration.nix</option></term> + </refsynopsisdiv> + <refsection> + <title>Description</title> + <para> + This command writes two NixOS configuration modules: + <variablelist> + <varlistentry> + <term><option>/etc/nixos/hardware-configuration.nix</option> + </term> + <listitem> + <para> + This module sets NixOS configuration options based on your current + hardware configuration. In particular, it sets the + <option>fileSystem</option> option to reflect all currently mounted file + systems, the <option>swapDevices</option> option to reflect active swap + devices, and the <option>boot.initrd.*</option> options to ensure that + the initial ramdisk contains any kernel modules necessary for mounting + the root file system. + </para> + <para> + If this file already exists, it is overwritten. Thus, you should not + modify it manually. Rather, you should include it from your + <filename>/etc/nixos/configuration.nix</filename>, and re-run + <command>nixos-generate-config</command> to update it whenever your + hardware configuration changes. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>/etc/nixos/configuration.nix</option> + </term> + <listitem> + <para> + This is the main NixOS system configuration module. If it already + exists, it’s left unchanged. Otherwise, + <command>nixos-generate-config</command> will write a template for you + to customise. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsection> + <refsection> + <title>Options</title> + <para> + This command accepts the following options: + </para> + <variablelist> + <varlistentry> + <term><option>--root</option> + </term> <listitem> - <para>This module sets NixOS configuration options based on your - current hardware configuration. In particular, it sets the - <option>fileSystem</option> option to reflect all currently - mounted file systems, the <option>swapDevices</option> option to - reflect active swap devices, and the - <option>boot.initrd.*</option> options to ensure that the - initial ramdisk contains any kernel modules necessary for - mounting the root file system.</para> - - <para>If this file already exists, it is overwritten. Thus, you - should not modify it manually. Rather, you should include it - from your <filename>/etc/nixos/configuration.nix</filename>, and - re-run <command>nixos-generate-config</command> to update it - whenever your hardware configuration changes.</para> + <para> + If this option is given, treat the directory + <replaceable>root</replaceable> as the root of the file system. This + means that configuration files will be written to + <filename><replaceable>root</replaceable>/etc/nixos</filename>, and that + any file systems outside of <replaceable>root</replaceable> are ignored + for the purpose of generating the <option>fileSystems</option> option. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><option>/etc/nixos/configuration.nix</option></term> + </varlistentry> + <varlistentry> + <term><option>--dir</option> + </term> <listitem> - <para>This is the main NixOS system configuration module. If it - already exists, it’s left unchanged. Otherwise, - <command>nixos-generate-config</command> will write a template - for you to customise.</para> + <para> + If this option is given, write the configuration files to the directory + <replaceable>dir</replaceable> instead of + <filename>/etc/nixos</filename>. + </para> </listitem> - </varlistentry> - -</variablelist> - -</para> - -</refsection> - - -<refsection><title>Options</title> - -<para>This command accepts the following options:</para> - -<variablelist> - - <varlistentry> - <term><option>--root</option></term> + </varlistentry> + <varlistentry> + <term><option>--force</option> + </term> <listitem> - <para>If this option is given, treat the directory - <replaceable>root</replaceable> as the root of the file system. - This means that configuration files will be written to - <filename><replaceable>root</replaceable>/etc/nixos</filename>, - and that any file systems outside of - <replaceable>root</replaceable> are ignored for the purpose of - generating the <option>fileSystems</option> option.</para> + <para> + Overwrite <filename>/etc/nixos/configuration.nix</filename> if it already + exists. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><option>--dir</option></term> + </varlistentry> + <varlistentry> + <term><option>--no-filesystems</option> + </term> <listitem> - <para>If this option is given, write the configuration files to - the directory <replaceable>dir</replaceable> instead of - <filename>/etc/nixos</filename>.</para> + <para> + Omit everything concerning file systems and swap devices from the + hardware configuration. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><option>--force</option></term> + </varlistentry> + <varlistentry> + <term><option>--show-hardware-config</option> + </term> <listitem> - <para>Overwrite - <filename>/etc/nixos/configuration.nix</filename> if it already - exists.</para> + <para> + Don't generate <filename>configuration.nix</filename> or + <filename>hardware-configuration.nix</filename> and print the hardware + configuration to stdout only. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><option>--no-filesystems</option></term> - <listitem> - <para>Omit everything concerning file systems and swap devices - from the hardware configuration.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><option>--show-hardware-config</option></term> - <listitem> - <para>Don't generate <filename>configuration.nix</filename> or - <filename>hardware-configuration.nix</filename> and print the - hardware configuration to stdout only.</para> - </listitem> - </varlistentry> - -</variablelist> - -</refsection> - - -<refsection><title>Examples</title> - -<para>This command is typically used during NixOS installation to -write initial configuration modules. For example, if you created and -mounted the target file systems on <filename>/mnt</filename> and -<filename>/mnt/boot</filename>, you would run: - + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Examples</title> + <para> + This command is typically used during NixOS installation to write initial + configuration modules. For example, if you created and mounted the target + file systems on <filename>/mnt</filename> and + <filename>/mnt/boot</filename>, you would run: <screen> $ nixos-generate-config --root /mnt </screen> - -The resulting file -<filename>/mnt/etc/nixos/hardware-configuration.nix</filename> might -look like this: - + The resulting file + <filename>/mnt/etc/nixos/hardware-configuration.nix</filename> might look + like this: <programlisting> # Do not modify this file! It was generated by ‘nixos-generate-config’ # and may be overwritten by future invocations. Please make changes @@ -181,28 +178,22 @@ look like this: nix.maxJobs = 8; } </programlisting> - -It will also create a basic -<filename>/mnt/etc/nixos/configuration.nix</filename>, which you -should edit to customise the logical configuration of your system. -This file includes the result of the hardware scan as follows: - + It will also create a basic + <filename>/mnt/etc/nixos/configuration.nix</filename>, which you should edit + to customise the logical configuration of your system. This file includes + the result of the hardware scan as follows: <programlisting> imports = [ ./hardware-configuration.nix ]; </programlisting> -</para> - -<para>After installation, if your hardware configuration changes, you -can run: - + </para> + <para> + After installation, if your hardware configuration changes, you can run: <screen> $ nixos-generate-config </screen> - -to update <filename>/etc/nixos/hardware-configuration.nix</filename>. -Your <filename>/etc/nixos/configuration.nix</filename> will -<emphasis>not</emphasis> be overwritten.</para> - -</refsection> - + to update <filename>/etc/nixos/hardware-configuration.nix</filename>. Your + <filename>/etc/nixos/configuration.nix</filename> will + <emphasis>not</emphasis> be overwritten. + </para> + </refsection> </refentry> diff --git a/nixos/doc/manual/man-nixos-install.xml b/nixos/doc/manual/man-nixos-install.xml index d6e70d16098b..2d45e83a863f 100644 --- a/nixos/doc/manual/man-nixos-install.xml +++ b/nixos/doc/manual/man-nixos-install.xml @@ -1,201 +1,221 @@ <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"> - -<refmeta> - <refentrytitle><command>nixos-install</command></refentrytitle> - <manvolnum>8</manvolnum> + <refmeta> + <refentrytitle><command>nixos-install</command> + </refentrytitle><manvolnum>8</manvolnum> <refmiscinfo class="source">NixOS</refmiscinfo> - <!-- <refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo> --> -</refmeta> - -<refnamediv> - <refname><command>nixos-install</command></refname> - <refpurpose>install bootloader and NixOS</refpurpose> -</refnamediv> - -<refsynopsisdiv> - <cmdsynopsis> - <command>nixos-install</command> - <arg> - <arg choice='plain'><option>-I</option></arg> - <replaceable>path</replaceable> +<!-- <refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo> --> + </refmeta> + <refnamediv> + <refname><command>nixos-install</command> + </refname><refpurpose>install bootloader and NixOS</refpurpose> + </refnamediv> + <refsynopsisdiv> + <cmdsynopsis><command>nixos-install</command> + <arg> + <arg choice='plain'><option>-I</option> + </arg><replaceable>path</replaceable> + </arg> + <arg> + <arg choice='plain'><option>--root</option> + </arg><replaceable>root</replaceable> + </arg> + <arg> + <arg choice='plain'><option>--system</option> + </arg><replaceable>path</replaceable> + </arg> + <arg> + <arg choice='plain'><option>--no-channel-copy</option> </arg> - <arg> - <arg choice='plain'><option>--root</option></arg> - <replaceable>root</replaceable> + </arg> + <arg> + <arg choice='plain'><option>--no-root-passwd</option> </arg> - <arg> - <arg choice='plain'><option>--system</option></arg> - <replaceable>path</replaceable> + </arg> + <arg> + <arg choice='plain'><option>--no-bootloader</option> </arg> - <arg> - <arg choice='plain'><option>--no-channel-copy</option></arg> + </arg> + <arg><group choice='req'> + <arg choice='plain'><option>--max-jobs</option> </arg> - <arg> - <arg choice='plain'><option>--no-root-passwd</option></arg> + <arg choice='plain'><option>-j</option> + </arg></group><replaceable>number</replaceable> + </arg> + <arg><option>--cores</option><replaceable>number</replaceable> + </arg> + <arg><option>--option</option><replaceable>name</replaceable><replaceable>value</replaceable> + </arg> + <arg> + <arg choice='plain'><option>--show-trace</option> </arg> - <arg> - <arg choice='plain'><option>--no-bootloader</option></arg> - </arg> - <arg> - <group choice='req'> - <arg choice='plain'><option>--max-jobs</option></arg> - <arg choice='plain'><option>-j</option></arg> - </group> - <replaceable>number</replaceable> - </arg> - <arg> - <option>--cores</option> - <replaceable>number</replaceable> - </arg> - <arg> - <option>--option</option> - <replaceable>name</replaceable> - <replaceable>value</replaceable> - </arg> - <arg> - <arg choice='plain'><option>--show-trace</option></arg> - </arg> - <arg> - <arg choice='plain'><option>--help</option></arg> + </arg> + <arg> + <arg choice='plain'><option>--help</option> </arg> + </arg> </cmdsynopsis> -</refsynopsisdiv> - - -<refsection><title>Description</title> - -<para>This command installs NixOS in the file system mounted on -<filename>/mnt</filename>, based on the NixOS configuration specified -in <filename>/mnt/etc/nixos/configuration.nix</filename>. It performs -the following steps: - -<itemizedlist> - - <listitem><para>It copies Nix and its dependencies to - <filename>/mnt/nix/store</filename>.</para></listitem> - - <listitem><para>It runs Nix in <filename>/mnt</filename> to build - the NixOS configuration specified in - <filename>/mnt/etc/nixos/configuration.nix</filename>.</para></listitem> - - <listitem><para>It installs the GRUB boot loader on the device - specified in the option <option>boot.loader.grub.device</option> - (unless <option>--no-bootloader</option> is specified), - and generates a GRUB configuration file that boots into the NixOS - configuration just installed.</para></listitem> - - <listitem><para>It prompts you for a password for the root account - (unless <option>--no-root-passwd</option> is specified).</para></listitem> - -</itemizedlist> - -</para> - -<para>This command is idempotent: if it is interrupted or fails due to -a temporary problem (e.g. a network issue), you can safely re-run -it.</para> - -</refsection> - -<refsection><title>Options</title> - -<para>This command accepts the following options:</para> - -<variablelist> - - <varlistentry> - <term><option>--root</option></term> + </refsynopsisdiv> + <refsection> + <title>Description</title> + <para> + This command installs NixOS in the file system mounted on + <filename>/mnt</filename>, based on the NixOS configuration specified in + <filename>/mnt/etc/nixos/configuration.nix</filename>. It performs the + following steps: + <itemizedlist> + <listitem> + <para> + It copies Nix and its dependencies to + <filename>/mnt/nix/store</filename>. + </para> + </listitem> + <listitem> + <para> + It runs Nix in <filename>/mnt</filename> to build the NixOS configuration + specified in <filename>/mnt/etc/nixos/configuration.nix</filename>. + </para> + </listitem> + <listitem> + <para> + It installs the GRUB boot loader on the device specified in the option + <option>boot.loader.grub.device</option> (unless + <option>--no-bootloader</option> is specified), and generates a GRUB + configuration file that boots into the NixOS configuration just + installed. + </para> + </listitem> + <listitem> + <para> + It prompts you for a password for the root account (unless + <option>--no-root-passwd</option> is specified). + </para> + </listitem> + </itemizedlist> + </para> + <para> + This command is idempotent: if it is interrupted or fails due to a temporary + problem (e.g. a network issue), you can safely re-run it. + </para> + </refsection> + <refsection> + <title>Options</title> + <para> + This command accepts the following options: + </para> + <variablelist> + <varlistentry> + <term><option>--root</option> + </term> + <listitem> + <para> + Defaults to <filename>/mnt</filename>. If this option is given, treat the + directory <replaceable>root</replaceable> as the root of the NixOS + installation. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>--system</option> + </term> + <listitem> + <para> + If this option is provided, <command>nixos-install</command> will install + the specified closure rather than attempt to build one from + <filename>/mnt/etc/nixos/configuration.nix</filename>. + </para> + <para> + The closure must be an appropriately configured NixOS system, with boot + loader and partition configuration that fits the target host. Such a + closure is typically obtained with a command such as <command>nix-build + -I nixos-config=./configuration.nix '<nixos>' -A system + --no-out-link</command> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>-I</option> + </term> + <listitem> + <para> + Add a path to the Nix expression search path. This option may be given + multiple times. See the NIX_PATH environment variable for information on + the semantics of the Nix search path. Paths added through + <replaceable>-I</replaceable> take precedence over NIX_PATH. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>--max-jobs</option> + </term> + <term><option>-j</option> + </term> <listitem> - <para>Defaults to <filename>/mnt</filename>. If this option is given, treat the directory - <replaceable>root</replaceable> as the root of the NixOS installation. - </para> + <para> + Sets the maximum number of build jobs that Nix will perform in parallel + to the specified number. The default is <literal>1</literal>. A higher + value is useful on SMP systems or to exploit I/O latency. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><option>--system</option></term> + </varlistentry> + <varlistentry> + <term><option>--cores</option> + </term> <listitem> - <para>If this option is provided, <command>nixos-install</command> will install the specified closure - rather than attempt to build one from <filename>/mnt/etc/nixos/configuration.nix</filename>.</para> - - <para>The closure must be an appropriately configured NixOS system, with boot loader and partition - configuration that fits the target host. Such a closure is typically obtained with a command such as - <command>nix-build -I nixos-config=./configuration.nix '<nixos>' -A system --no-out-link</command> - </para> + <para> + Sets the value of the <envar>NIX_BUILD_CORES</envar> environment variable + in the invocation of builders. Builders can use this variable at their + discretion to control the maximum amount of parallelism. For instance, in + Nixpkgs, if the derivation attribute + <varname>enableParallelBuilding</varname> is set to + <literal>true</literal>, the builder passes the + <option>-j<replaceable>N</replaceable></option> flag to GNU Make. The + value <literal>0</literal> means that the builder should use all + available CPU cores in the system. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><option>-I</option></term> + </varlistentry> + <varlistentry> + <term><option>--option</option><replaceable>name</replaceable><replaceable>value</replaceable> + </term> <listitem> - <para>Add a path to the Nix expression search path. This option may be given multiple times. - See the NIX_PATH environment variable for information on the semantics of the Nix search path. - Paths added through <replaceable>-I</replaceable> take precedence over NIX_PATH.</para> + <para> + Set the Nix configuration option <replaceable>name</replaceable> to + <replaceable>value</replaceable>. + </para> </listitem> - </varlistentry> - - <varlistentry><term><option>--max-jobs</option></term> - <term><option>-j</option></term> - - <listitem><para>Sets the maximum number of build jobs that Nix will - perform in parallel to the specified number. The default is <literal>1</literal>. - A higher value is useful on SMP systems or to exploit I/O latency.</para></listitem> - - </varlistentry> - - - <varlistentry><term><option>--cores</option></term> - - <listitem><para>Sets the value of the <envar>NIX_BUILD_CORES</envar> - environment variable in the invocation of builders. Builders can - use this variable at their discretion to control the maximum amount - of parallelism. For instance, in Nixpkgs, if the derivation - attribute <varname>enableParallelBuilding</varname> is set to - <literal>true</literal>, the builder passes the - <option>-j<replaceable>N</replaceable></option> flag to GNU Make. - The value <literal>0</literal> means that the builder should use all - available CPU cores in the system.</para></listitem> - - </varlistentry> - - <varlistentry><term><option>--option</option> <replaceable>name</replaceable> <replaceable>value</replaceable></term> - - <listitem><para>Set the Nix configuration option - <replaceable>name</replaceable> to <replaceable>value</replaceable>.</para></listitem> - - </varlistentry> - - <varlistentry> - <term><option>--show-trace</option></term> + </varlistentry> + <varlistentry> + <term><option>--show-trace</option> + </term> <listitem> - <para>Causes Nix to print out a stack trace in case of Nix expression evaluation errors.</para> + <para> + Causes Nix to print out a stack trace in case of Nix expression + evaluation errors. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><option>--help</option></term> + </varlistentry> + <varlistentry> + <term><option>--help</option> + </term> <listitem> - <para>Synonym for <command>man nixos-install</command>.</para> + <para> + Synonym for <command>man nixos-install</command>. + </para> </listitem> - </varlistentry> - -</variablelist> - -</refsection> - - -<refsection><title>Examples</title> - -<para>A typical NixOS installation is done by creating and mounting a -file system on <filename>/mnt</filename>, generating a NixOS -configuration in -<filename>/mnt/etc/nixos/configuration.nix</filename>, and running -<command>nixos-install</command>. For instance, if we want to install -NixOS on an <literal>ext4</literal> file system created in -<filename>/dev/sda1</filename>: - + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Examples</title> + <para> + A typical NixOS installation is done by creating and mounting a file system + on <filename>/mnt</filename>, generating a NixOS configuration in + <filename>/mnt/etc/nixos/configuration.nix</filename>, and running + <command>nixos-install</command>. For instance, if we want to install NixOS + on an <literal>ext4</literal> file system created in + <filename>/dev/sda1</filename>: <screen> $ mkfs.ext4 /dev/sda1 $ mount /dev/sda1 /mnt @@ -204,9 +224,6 @@ $ # edit /mnt/etc/nixos/configuration.nix $ nixos-install $ reboot </screen> - -</para> - -</refsection> - + </para> + </refsection> </refentry> diff --git a/nixos/doc/manual/man-nixos-option.xml b/nixos/doc/manual/man-nixos-option.xml index d2b2d5b7965c..c22c3811dedf 100644 --- a/nixos/doc/manual/man-nixos-option.xml +++ b/nixos/doc/manual/man-nixos-option.xml @@ -1,103 +1,96 @@ <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"> - -<refmeta> - <refentrytitle><command>nixos-option</command></refentrytitle> - <manvolnum>8</manvolnum> + <refmeta> + <refentrytitle><command>nixos-option</command> + </refentrytitle><manvolnum>8</manvolnum> <refmiscinfo class="source">NixOS</refmiscinfo> - <!-- <refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo> --> -</refmeta> - -<refnamediv> - <refname><command>nixos-option</command></refname> - <refpurpose>inspect a NixOS configuration</refpurpose> -</refnamediv> - -<refsynopsisdiv> - <cmdsynopsis> - <command>nixos-option</command> - <arg> - <option>-I</option> - <replaceable>path</replaceable> - </arg> - <arg><option>--verbose</option></arg> - <arg><option>--xml</option></arg> - <arg choice="plain"><replaceable>option.name</replaceable></arg> +<!-- <refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo> --> + </refmeta> + <refnamediv> + <refname><command>nixos-option</command> + </refname><refpurpose>inspect a NixOS configuration</refpurpose> + </refnamediv> + <refsynopsisdiv> + <cmdsynopsis><command>nixos-option</command> + <arg><option>-I</option><replaceable>path</replaceable> + </arg> + <arg><option>--verbose</option> + </arg> + <arg><option>--xml</option> + </arg> + <arg choice="plain"><replaceable>option.name</replaceable> + </arg> </cmdsynopsis> -</refsynopsisdiv> - -<refsection><title>Description</title> - -<para>This command evaluates the configuration specified in -<filename>/etc/nixos/configuration.nix</filename> and returns the properties -of the option name given as argument.</para> - -<para>When the option name is not an option, the command prints the list of -attributes contained in the attribute set.</para> - -</refsection> - -<refsection><title>Options</title> - -<para>This command accepts the following options:</para> - -<variablelist> - - <varlistentry> - <term><option>-I</option> <replaceable>path</replaceable></term> + </refsynopsisdiv> + <refsection> + <title>Description</title> + <para> + This command evaluates the configuration specified in + <filename>/etc/nixos/configuration.nix</filename> and returns the properties + of the option name given as argument. + </para> + <para> + When the option name is not an option, the command prints the list of + attributes contained in the attribute set. + </para> + </refsection> + <refsection> + <title>Options</title> + <para> + This command accepts the following options: + </para> + <variablelist> + <varlistentry> + <term><option>-I</option><replaceable>path</replaceable> + </term> <listitem> - <para> - This option is passed to the underlying - <command>nix-instantiate</command> invocation. - </para> + <para> + This option is passed to the underlying + <command>nix-instantiate</command> invocation. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><option>--verbose</option></term> + </varlistentry> + <varlistentry> + <term><option>--verbose</option> + </term> <listitem> - <para> - This option enables verbose mode, which currently is just - the Bash <command>set</command> <option>-x</option> debug mode. - </para> + <para> + This option enables verbose mode, which currently is just the Bash + <command>set</command> <option>-x</option> debug mode. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><option>--xml</option></term> + </varlistentry> + <varlistentry> + <term><option>--xml</option> + </term> <listitem> - <para> - This option causes the output to be rendered as XML. - </para> + <para> + This option causes the output to be rendered as XML. + </para> </listitem> - </varlistentry> - -</variablelist> - -</refsection> - -<refsection><title>Environment</title> - -<variablelist> - - <varlistentry> - <term><envar>NIXOS_CONFIG</envar></term> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Environment</title> + <variablelist> + <varlistentry> + <term><envar>NIXOS_CONFIG</envar> + </term> <listitem> - <para>Path to the main NixOS configuration module. Defaults to - <filename>/etc/nixos/configuration.nix</filename>.</para> + <para> + Path to the main NixOS configuration module. Defaults to + <filename>/etc/nixos/configuration.nix</filename>. + </para> </listitem> - </varlistentry> - -</variablelist> - -</refsection> - - -<refsection><title>Examples</title> - -<para>Investigate option values: - + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Examples</title> + <para> + Investigate option values: <screen>$ nixos-option boot.loader This attribute set contains: generationsDir @@ -119,16 +112,14 @@ Declared by: Defined by: "/nix/var/nix/profiles/per-user/root/channels/nixos/nixpkgs/nixos/modules/system/boot/loader/grub/grub.nix" -</screen></para> - -</refsection> - -<refsection><title>Bugs</title> - -<para>The author listed in the following section is wrong. If there is any - other bug, please report to Nicolas Pierron.</para> - -</refsection> - - +</screen> + </para> + </refsection> + <refsection> + <title>Bugs</title> + <para> + The author listed in the following section is wrong. If there is any other + bug, please report to Nicolas Pierron. + </para> + </refsection> </refentry> diff --git a/nixos/doc/manual/man-nixos-rebuild.xml b/nixos/doc/manual/man-nixos-rebuild.xml index f74788353e67..e1a2c7108d18 100644 --- a/nixos/doc/manual/man-nixos-rebuild.xml +++ b/nixos/doc/manual/man-nixos-rebuild.xml @@ -1,399 +1,415 @@ <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"> - -<refmeta> - <refentrytitle><command>nixos-rebuild</command></refentrytitle> - <manvolnum>8</manvolnum> + <refmeta> + <refentrytitle><command>nixos-rebuild</command> + </refentrytitle><manvolnum>8</manvolnum> <refmiscinfo class="source">NixOS</refmiscinfo> - <!-- <refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo> --> -</refmeta> - -<refnamediv> - <refname><command>nixos-rebuild</command></refname> - <refpurpose>reconfigure a NixOS machine</refpurpose> -</refnamediv> - -<refsynopsisdiv> - <cmdsynopsis> - <command>nixos-rebuild</command> - <group choice='req'> - <arg choice='plain'><option>switch</option></arg> - <arg choice='plain'><option>boot</option></arg> - <arg choice='plain'><option>test</option></arg> - <arg choice='plain'><option>build</option></arg> - <arg choice='plain'><option>dry-build</option></arg> - <arg choice='plain'><option>dry-activate</option></arg> - <arg choice='plain'><option>build-vm</option></arg> - <arg choice='plain'><option>build-vm-with-bootloader</option></arg> - </group> - <sbr /> - <arg><option>--upgrade</option></arg> - <arg><option>--install-bootloader</option></arg> - <arg><option>--no-build-nix</option></arg> - <arg><option>--fast</option></arg> - <arg><option>--rollback</option></arg> - <sbr /> - <arg> - <group choice='req'> - <arg choice='plain'><option>--profile-name</option></arg> - <arg choice='plain'><option>-p</option></arg> - </group> - <replaceable>name</replaceable> +<!-- <refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo> --> + </refmeta> + <refnamediv> + <refname><command>nixos-rebuild</command> + </refname><refpurpose>reconfigure a NixOS machine</refpurpose> + </refnamediv> + <refsynopsisdiv> + <cmdsynopsis><command>nixos-rebuild</command><group choice='req'> + <arg choice='plain'><option>switch</option> + </arg> + <arg choice='plain'><option>boot</option> + </arg> + <arg choice='plain'><option>test</option> + </arg> + <arg choice='plain'><option>build</option> + </arg> + <arg choice='plain'><option>dry-build</option> + </arg> + <arg choice='plain'><option>dry-activate</option> + </arg> + <arg choice='plain'><option>build-vm</option> + </arg> + <arg choice='plain'><option>build-vm-with-bootloader</option> + </arg></group> + <sbr /> + <arg><option>--upgrade</option> + </arg> + <arg><option>--install-bootloader</option> + </arg> + <arg><option>--no-build-nix</option> + </arg> + <arg><option>--fast</option> + </arg> + <arg><option>--rollback</option> + </arg> + <sbr /> + <arg><group choice='req'> + <arg choice='plain'><option>--profile-name</option> </arg> - <sbr /> - <arg><option>--show-trace</option></arg> + <arg choice='plain'><option>-p</option> + </arg></group><replaceable>name</replaceable> + </arg> + <sbr /> + <arg><option>--show-trace</option> + </arg> </cmdsynopsis> -</refsynopsisdiv> - - -<refsection><title>Description</title> - -<para>This command updates the system so that it corresponds to the -configuration specified in -<filename>/etc/nixos/configuration.nix</filename>. Thus, every time -you modify <filename>/etc/nixos/configuration.nix</filename> or any -NixOS module, you must run <command>nixos-rebuild</command> to make -the changes take effect. It builds the new system in -<filename>/nix/store</filename>, runs its activation script, and stop -and (re)starts any system services if needed.</para> - -<para>This command has one required argument, which specifies the -desired operation. It must be one of the following: - -<variablelist> - - <varlistentry> - <term><option>switch</option></term> - <listitem> - <para>Build and activate the new configuration, and make it the - boot default. That is, the configuration is added to the GRUB - boot menu as the default menu entry, so that subsequent reboots - will boot the system into the new configuration. Previous - configurations activated with <command>nixos-rebuild - switch</command> or <command>nixos-rebuild boot</command> remain - available in the GRUB menu.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><option>boot</option></term> - <listitem> - <para>Build the new configuration and make it the boot default - (as with <command>nixos-rebuild switch</command>), but do not - activate it. That is, the system continues to run the previous - configuration until the next reboot.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><option>test</option></term> - <listitem> - <para>Build and activate the new configuration, but do not add - it to the GRUB boot menu. Thus, if you reboot the system (or if - it crashes), you will automatically revert to the default - configuration (i.e. the configuration resulting from the last - call to <command>nixos-rebuild switch</command> or - <command>nixos-rebuild boot</command>).</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><option>build</option></term> - <listitem> - <para>Build the new configuration, but neither activate it nor - add it to the GRUB boot menu. It leaves a symlink named - <filename>result</filename> in the current directory, which - points to the output of the top-level “system” derivation. This - is essentially the same as doing + </refsynopsisdiv> + <refsection> + <title>Description</title> + <para> + This command updates the system so that it corresponds to the configuration + specified in <filename>/etc/nixos/configuration.nix</filename>. Thus, every + time you modify <filename>/etc/nixos/configuration.nix</filename> or any + NixOS module, you must run <command>nixos-rebuild</command> to make the + changes take effect. It builds the new system in + <filename>/nix/store</filename>, runs its activation script, and stop and + (re)starts any system services if needed. + </para> + <para> + This command has one required argument, which specifies the desired + operation. It must be one of the following: + <variablelist> + <varlistentry> + <term><option>switch</option> + </term> + <listitem> + <para> + Build and activate the new configuration, and make it the boot default. + That is, the configuration is added to the GRUB boot menu as the default + menu entry, so that subsequent reboots will boot the system into the new + configuration. Previous configurations activated with + <command>nixos-rebuild switch</command> or <command>nixos-rebuild + boot</command> remain available in the GRUB menu. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>boot</option> + </term> + <listitem> + <para> + Build the new configuration and make it the boot default (as with + <command>nixos-rebuild switch</command>), but do not activate it. That + is, the system continues to run the previous configuration until the + next reboot. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>test</option> + </term> + <listitem> + <para> + Build and activate the new configuration, but do not add it to the GRUB + boot menu. Thus, if you reboot the system (or if it crashes), you will + automatically revert to the default configuration (i.e. the + configuration resulting from the last call to <command>nixos-rebuild + switch</command> or <command>nixos-rebuild boot</command>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>build</option> + </term> + <listitem> + <para> + Build the new configuration, but neither activate it nor add it to the + GRUB boot menu. It leaves a symlink named <filename>result</filename> in + the current directory, which points to the output of the top-level + “system” derivation. This is essentially the same as doing <screen> $ nix-build /path/to/nixpkgs/nixos -A system </screen> - Note that you do not need to be <literal>root</literal> to run - <command>nixos-rebuild build</command>.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><option>dry-build</option></term> - <listitem> - <para>Show what store paths would be built or downloaded by any - of the operations above, but otherwise do nothing.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><option>dry-activate</option></term> - <listitem> - <para>Build the new configuration, but instead of activating it, - show what changes would be performed by the activation (i.e. by - <command>nixos-rebuild test</command>). For - instance, this command will print which systemd units would be - restarted. The list of changes is not guaranteed to be - complete.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><option>build-vm</option></term> - <listitem> - <para>Build a script that starts a NixOS virtual machine with - the desired configuration. It leaves a symlink - <filename>result</filename> in the current directory that points - (under - <filename>result/bin/run-<replaceable>hostname</replaceable>-vm</filename>) - at the script that starts the VM. Thus, to test a NixOS - configuration in a virtual machine, you should do the following: + Note that you do not need to be <literal>root</literal> to run + <command>nixos-rebuild build</command>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>dry-build</option> + </term> + <listitem> + <para> + Show what store paths would be built or downloaded by any of the + operations above, but otherwise do nothing. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>dry-activate</option> + </term> + <listitem> + <para> + Build the new configuration, but instead of activating it, show what + changes would be performed by the activation (i.e. by + <command>nixos-rebuild test</command>). For instance, this command will + print which systemd units would be restarted. The list of changes is not + guaranteed to be complete. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>build-vm</option> + </term> + <listitem> + <para> + Build a script that starts a NixOS virtual machine with the desired + configuration. It leaves a symlink <filename>result</filename> in the + current directory that points (under + <filename>result/bin/run-<replaceable>hostname</replaceable>-vm</filename>) + at the script that starts the VM. Thus, to test a NixOS configuration in + a virtual machine, you should do the following: <screen> $ nixos-rebuild build-vm $ ./result/bin/run-*-vm -</screen></para> - - <para>The VM is implemented using the <literal>qemu</literal> - package. For best performance, you should load the - <literal>kvm-intel</literal> or <literal>kvm-amd</literal> - kernel modules to get hardware virtualisation.</para> - - <para>The VM mounts the Nix store of the host through the 9P - file system. The host Nix store is read-only, so Nix commands - that modify the Nix store will not work in the VM. This - includes commands such as <command>nixos-rebuild</command>; to - change the VM’s configuration, you must halt the VM and re-run - the commands above. +</screen> </para> - - <para>The VM has its own <literal>ext3</literal> root file - system, which is automatically created when the VM is first - started, and is persistent across reboots of the VM. It is - stored in - <literal>./<replaceable>hostname</replaceable>.qcow2</literal>. - <!-- The entire file system hierarchy of the host is available in - the VM under <filename>/hostfs</filename>.--></para> - </listitem> - </varlistentry> - - <varlistentry> - <term><option>build-vm-with-bootloader</option></term> - <listitem> - <para>Like <option>build-vm</option>, but boots using the - regular boot loader of your configuration (e.g., GRUB 1 or 2), - rather than booting directly into the kernel and initial ramdisk - of the system. This allows you to test whether the boot loader - works correctly. However, it does not guarantee that your NixOS - configuration will boot successfully on the host hardware (i.e., - after running <command>nixos-rebuild switch</command>), because - the hardware and boot loader configuration in the VM are - different. The boot loader is installed on an automatically - generated virtual disk containing a <filename>/boot</filename> - partition, which is mounted read-only in the VM.</para> - </listitem> - </varlistentry> - -</variablelist> - -</para> - - -</refsection> - - -<refsection><title>Options</title> - -<para>This command accepts the following options:</para> - -<variablelist> - - <varlistentry> - <term><option>--upgrade</option></term> + <para> + The VM is implemented using the <literal>qemu</literal> package. For + best performance, you should load the <literal>kvm-intel</literal> or + <literal>kvm-amd</literal> kernel modules to get hardware + virtualisation. + </para> + <para> + The VM mounts the Nix store of the host through the 9P file system. The + host Nix store is read-only, so Nix commands that modify the Nix store + will not work in the VM. This includes commands such as + <command>nixos-rebuild</command>; to change the VM’s configuration, + you must halt the VM and re-run the commands above. + </para> + <para> + The VM has its own <literal>ext3</literal> root file system, which is + automatically created when the VM is first started, and is persistent + across reboots of the VM. It is stored in + <literal>./<replaceable>hostname</replaceable>.qcow2</literal>. +<!-- The entire file system hierarchy of the host is available in + the VM under <filename>/hostfs</filename>.--> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>build-vm-with-bootloader</option> + </term> + <listitem> + <para> + Like <option>build-vm</option>, but boots using the regular boot loader + of your configuration (e.g., GRUB 1 or 2), rather than booting directly + into the kernel and initial ramdisk of the system. This allows you to + test whether the boot loader works correctly. However, it does not + guarantee that your NixOS configuration will boot successfully on the + host hardware (i.e., after running <command>nixos-rebuild + switch</command>), because the hardware and boot loader configuration in + the VM are different. The boot loader is installed on an automatically + generated virtual disk containing a <filename>/boot</filename> + partition, which is mounted read-only in the VM. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsection> + <refsection> + <title>Options</title> + <para> + This command accepts the following options: + </para> + <variablelist> + <varlistentry> + <term><option>--upgrade</option> + </term> <listitem> - <para>Fetch the latest version of NixOS from the NixOS - channel.</para> + <para> + Fetch the latest version of NixOS from the NixOS channel. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><option>--install-bootloader</option></term> + </varlistentry> + <varlistentry> + <term><option>--install-bootloader</option> + </term> <listitem> - <para>Causes the boot loader to be (re)installed on the - device specified by the relevant configuration options. - </para> + <para> + Causes the boot loader to be (re)installed on the device specified by the + relevant configuration options. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><option>--no-build-nix</option></term> + </varlistentry> + <varlistentry> + <term><option>--no-build-nix</option> + </term> <listitem> - <para>Normally, <command>nixos-rebuild</command> first builds - the <varname>nixUnstable</varname> attribute in Nixpkgs, and - uses the resulting instance of the Nix package manager to build - the new system configuration. This is necessary if the NixOS - modules use features not provided by the currently installed - version of Nix. This option disables building a new Nix.</para> + <para> + Normally, <command>nixos-rebuild</command> first builds the + <varname>nixUnstable</varname> attribute in Nixpkgs, and uses the + resulting instance of the Nix package manager to build the new system + configuration. This is necessary if the NixOS modules use features not + provided by the currently installed version of Nix. This option disables + building a new Nix. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><option>--fast</option></term> + </varlistentry> + <varlistentry> + <term><option>--fast</option> + </term> <listitem> - <para>Equivalent to <option>--no-build-nix</option> - <option>--show-trace</option>. This option is useful if you - call <command>nixos-rebuild</command> frequently (e.g. if you’re - hacking on a NixOS module).</para> + <para> + Equivalent to <option>--no-build-nix</option> + <option>--show-trace</option>. This option is useful if you call + <command>nixos-rebuild</command> frequently (e.g. if you’re hacking on + a NixOS module). + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><option>--rollback</option></term> + </varlistentry> + <varlistentry> + <term><option>--rollback</option> + </term> <listitem> - <para>Instead of building a new configuration as specified by - <filename>/etc/nixos/configuration.nix</filename>, roll back to - the previous configuration. (The previous configuration is - defined as the one before the “current” generation of the - Nix profile <filename>/nix/var/nix/profiles/system</filename>.)</para> + <para> + Instead of building a new configuration as specified by + <filename>/etc/nixos/configuration.nix</filename>, roll back to the + previous configuration. (The previous configuration is defined as the one + before the “current” generation of the Nix profile + <filename>/nix/var/nix/profiles/system</filename>.) + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><option>--profile-name</option></term> - <term><option>-p</option></term> + </varlistentry> + <varlistentry> + <term><option>--profile-name</option> + </term> + <term><option>-p</option> + </term> <listitem> - <para>Instead of using the Nix profile - <filename>/nix/var/nix/profiles/system</filename> to keep track - of the current and previous system configurations, use + <para> + Instead of using the Nix profile + <filename>/nix/var/nix/profiles/system</filename> to keep track of the + current and previous system configurations, use <filename>/nix/var/nix/profiles/system-profiles/<replaceable>name</replaceable></filename>. - When you use GRUB 2, for every system profile created with this - flag, NixOS will create a submenu named “NixOS - Profile - '<replaceable>name</replaceable>'” in GRUB’s boot menu, - containing the current and previous configurations of this - profile.</para> - - <para>For instance, if you want to test a configuration file - named <filename>test.nix</filename> without affecting the - default system profile, you would do: - + When you use GRUB 2, for every system profile created with this flag, + NixOS will create a submenu named “NixOS - Profile + '<replaceable>name</replaceable>'” in GRUB’s boot menu, containing + the current and previous configurations of this profile. + </para> + <para> + For instance, if you want to test a configuration file named + <filename>test.nix</filename> without affecting the default system + profile, you would do: <screen> $ nixos-rebuild switch -p test -I nixos-config=./test.nix </screen> - - The new configuration will appear in the GRUB 2 submenu “NixOS - Profile - 'test'”.</para> + The new configuration will appear in the GRUB 2 submenu “NixOS - + Profile 'test'”. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><option>--build-host</option></term> + </varlistentry> + <varlistentry> + <term><option>--build-host</option> + </term> <listitem> - <para>Instead of building the new configuration locally, use the - specified host to perform the build. The host needs to be accessible - with ssh, and must be able to perform Nix builds. If the option + <para> + Instead of building the new configuration locally, use the specified host + to perform the build. The host needs to be accessible with ssh, and must + be able to perform Nix builds. If the option <option>--target-host</option> is not set, the build will be copied back - to the local machine when done.</para> - - <para>Note that, if <option>--no-build-nix</option> is not specified, - Nix will be built both locally and remotely. This is because the - configuration will always be evaluated locally even though the building - might be performed remotely.</para> - - <para>You can include a remote user name in - the host name (<replaceable>user@host</replaceable>). You can also set - ssh options by defining the <envar>NIX_SSHOPTS</envar> environment - variable.</para> + to the local machine when done. + </para> + <para> + Note that, if <option>--no-build-nix</option> is not specified, Nix will + be built both locally and remotely. This is because the configuration + will always be evaluated locally even though the building might be + performed remotely. + </para> + <para> + You can include a remote user name in the host name + (<replaceable>user@host</replaceable>). You can also set ssh options by + defining the <envar>NIX_SSHOPTS</envar> environment variable. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><option>--target-host</option></term> + </varlistentry> + <varlistentry> + <term><option>--target-host</option> + </term> <listitem> - <para>Specifies the NixOS target host. By setting this to something other - than <replaceable>localhost</replaceable>, the system activation will - happen on the remote host instead of the local machine. The remote host - needs to be accessible over ssh, and for the commands - <option>switch</option>, <option>boot</option> and <option>test</option> - you need root access.</para> - - <para>If <option>--build-host</option> is not explicitly - specified, <option>--build-host</option> will implicitly be set to the - same value as <option>--target-host</option>. So, if you only specify + <para> + Specifies the NixOS target host. By setting this to something other than + <replaceable>localhost</replaceable>, the system activation will happen + on the remote host instead of the local machine. The remote host needs to + be accessible over ssh, and for the commands <option>switch</option>, + <option>boot</option> and <option>test</option> you need root access. + </para> + <para> + If <option>--build-host</option> is not explicitly specified, + <option>--build-host</option> will implicitly be set to the same value as + <option>--target-host</option>. So, if you only specify <option>--target-host</option> both building and activation will take place remotely (and no build artifacts will be copied to the local - machine).</para> - - <para>You can include a remote user name in - the host name (<replaceable>user@host</replaceable>). You can also set - ssh options by defining the <envar>NIX_SSHOPTS</envar> environment - variable.</para> + machine). + </para> + <para> + You can include a remote user name in the host name + (<replaceable>user@host</replaceable>). You can also set ssh options by + defining the <envar>NIX_SSHOPTS</envar> environment variable. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + In addition, <command>nixos-rebuild</command> accepts various Nix-related + flags, including <option>--max-jobs</option> / <option>-j</option>, + <option>--show-trace</option>, <option>--keep-failed</option>, + <option>--keep-going</option> and <option>--verbose</option> / + <option>-v</option>. See the Nix manual for details. + </para> + </refsection> + <refsection> + <title>Environment</title> + <variablelist> + <varlistentry> + <term><envar>NIXOS_CONFIG</envar> + </term> + <listitem> + <para> + Path to the main NixOS configuration module. Defaults to + <filename>/etc/nixos/configuration.nix</filename>. + </para> </listitem> - </varlistentry> - -</variablelist> - -<para>In addition, <command>nixos-rebuild</command> accepts various -Nix-related flags, including <option>--max-jobs</option> / -<option>-j</option>, <option>--show-trace</option>, -<option>--keep-failed</option>, <option>--keep-going</option> and -<option>--verbose</option> / <option>-v</option>. See -the Nix manual for details.</para> - -</refsection> - - -<refsection><title>Environment</title> - -<variablelist> - - <varlistentry> - <term><envar>NIXOS_CONFIG</envar></term> + </varlistentry> + <varlistentry> + <term><envar>NIX_SSHOPTS</envar> + </term> <listitem> - <para>Path to the main NixOS configuration module. Defaults to - <filename>/etc/nixos/configuration.nix</filename>.</para> + <para> + Additional options to be passed to <command>ssh</command> on the command + line. + </para> </listitem> - </varlistentry> - - <varlistentry><term><envar>NIX_SSHOPTS</envar></term> - - <listitem><para>Additional options to be passed to - <command>ssh</command> on the command line.</para></listitem> - - </varlistentry> - -</variablelist> - -</refsection> - - -<refsection><title>Files</title> - -<variablelist> - - <varlistentry> - <term><filename>/run/current-system</filename></term> + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Files</title> + <variablelist> + <varlistentry> + <term><filename>/run/current-system</filename> + </term> <listitem> - <para>A symlink to the currently active system configuration in - the Nix store.</para> + <para> + A symlink to the currently active system configuration in the Nix store. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><filename>/nix/var/nix/profiles/system</filename></term> + </varlistentry> + <varlistentry> + <term><filename>/nix/var/nix/profiles/system</filename> + </term> <listitem> - <para>The Nix profile that contains the current and previous - system configurations. Used to generate the GRUB boot - menu.</para> + <para> + The Nix profile that contains the current and previous system + configurations. Used to generate the GRUB boot menu. + </para> </listitem> - </varlistentry> - -</variablelist> - -</refsection> - - -<refsection><title>Bugs</title> - -<para>This command should be renamed to something more -descriptive.</para> - -</refsection> - - - + </varlistentry> + </variablelist> + </refsection> + <refsection> + <title>Bugs</title> + <para> + This command should be renamed to something more descriptive. + </para> + </refsection> </refentry> diff --git a/nixos/doc/manual/man-nixos-version.xml b/nixos/doc/manual/man-nixos-version.xml index 615d74f90908..c173bce19136 100644 --- a/nixos/doc/manual/man-nixos-version.xml +++ b/nixos/doc/manual/man-nixos-version.xml @@ -1,97 +1,102 @@ <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"> - -<refmeta> - <refentrytitle><command>nixos-version</command></refentrytitle> - <manvolnum>8</manvolnum> + <refmeta> + <refentrytitle><command>nixos-version</command> + </refentrytitle><manvolnum>8</manvolnum> <refmiscinfo class="source">NixOS</refmiscinfo> -</refmeta> - -<refnamediv> - <refname><command>nixos-version</command></refname> - <refpurpose>show the NixOS version</refpurpose> -</refnamediv> - -<refsynopsisdiv> - <cmdsynopsis> - <command>nixos-version</command> - <arg><option>--hash</option></arg> - <arg><option>--revision</option></arg> + </refmeta> + <refnamediv> + <refname><command>nixos-version</command> + </refname><refpurpose>show the NixOS version</refpurpose> + </refnamediv> + <refsynopsisdiv> + <cmdsynopsis><command>nixos-version</command> + <arg><option>--hash</option> + </arg> + <arg><option>--revision</option> + </arg> </cmdsynopsis> -</refsynopsisdiv> - -<refsection><title>Description</title> - -<para>This command shows the version of the currently active NixOS -configuration. For example: - + </refsynopsisdiv> + <refsection> + <title>Description</title> + <para> + This command shows the version of the currently active NixOS configuration. + For example: <screen>$ nixos-version 16.03.1011.6317da4 (Emu) </screen> - -The version consists of the following elements: - -<variablelist> - - <varlistentry> - <term><literal>16.03</literal></term> - <listitem><para>The NixOS release, indicating the year and month - in which it was released (e.g. March 2016).</para></listitem> - </varlistentry> - - <varlistentry> - <term><literal>1011</literal></term> - <listitem><para>The number of commits in the Nixpkgs Git - repository between the start of the release branch and the commit - from which this version was built. This ensures that NixOS - versions are monotonically increasing. It is - <literal>git</literal> when the current NixOS configuration was - built from a checkout of the Nixpkgs Git repository rather than - from a NixOS channel.</para></listitem> - </varlistentry> - - <varlistentry> - <term><literal>6317da4</literal></term> - <listitem><para>The first 7 characters of the commit in the - Nixpkgs Git repository from which this version was - built.</para></listitem> - </varlistentry> - - <varlistentry> - <term><literal>Emu</literal></term> - <listitem><para>The code name of the NixOS release. The first - letter of the code name indicates that this is the N'th stable - NixOS release; for example, Emu is the fifth - release.</para></listitem> - </varlistentry> - -</variablelist> - -</para> - -</refsection> - - -<refsection><title>Options</title> - -<para>This command accepts the following options:</para> - -<variablelist> - - <varlistentry> - <term><option>--hash</option></term> - <term><option>--revision</option></term> + The version consists of the following elements: + <variablelist> + <varlistentry> + <term><literal>16.03</literal> + </term> + <listitem> + <para> + The NixOS release, indicating the year and month in which it was + released (e.g. March 2016). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>1011</literal> + </term> + <listitem> + <para> + The number of commits in the Nixpkgs Git repository between the start of + the release branch and the commit from which this version was built. + This ensures that NixOS versions are monotonically increasing. It is + <literal>git</literal> when the current NixOS configuration was built + from a checkout of the Nixpkgs Git repository rather than from a NixOS + channel. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>6317da4</literal> + </term> + <listitem> + <para> + The first 7 characters of the commit in the Nixpkgs Git repository from + which this version was built. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>Emu</literal> + </term> + <listitem> + <para> + The code name of the NixOS release. The first letter of the code name + indicates that this is the N'th stable NixOS release; for example, Emu + is the fifth release. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsection> + <refsection> + <title>Options</title> + <para> + This command accepts the following options: + </para> + <variablelist> + <varlistentry> + <term><option>--hash</option> + </term> + <term><option>--revision</option> + </term> <listitem> - <para>Show the full SHA1 hash of the Git commit from which this - configuration was built, e.g. + <para> + Show the full SHA1 hash of the Git commit from which this configuration + was built, e.g. <screen>$ nixos-version --hash 6317da40006f6bc2480c6781999c52d88dde2acf </screen> - </para> + </para> </listitem> - </varlistentry> -</variablelist> - -</refsection> + </varlistentry> + </variablelist> + </refsection> </refentry> diff --git a/nixos/doc/manual/man-pages.xml b/nixos/doc/manual/man-pages.xml index 80a8458fbfec..0390dda6468f 100644 --- a/nixos/doc/manual/man-pages.xml +++ b/nixos/doc/manual/man-pages.xml @@ -1,33 +1,20 @@ <reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"> - - <title>NixOS Reference Pages</title> - - <info> - - <author> - <personname> - <firstname>Eelco</firstname> - <surname>Dolstra</surname> - </personname> - <contrib>Author</contrib> - </author> - - <copyright> - <year>2007-2018</year> - <holder>Eelco Dolstra</holder> - </copyright> - - </info> - - <xi:include href="man-configuration.xml" /> - <xi:include href="man-nixos-build-vms.xml" /> - <xi:include href="man-nixos-generate-config.xml" /> - <xi:include href="man-nixos-install.xml" /> - <xi:include href="man-nixos-enter.xml" /> - <xi:include href="man-nixos-option.xml" /> - <xi:include href="man-nixos-rebuild.xml" /> - <xi:include href="man-nixos-version.xml" /> - + <title>NixOS Reference Pages</title> + <info> + <author><personname><firstname>Eelco</firstname><surname>Dolstra</surname></personname> + <contrib>Author</contrib> + </author> + <copyright><year>2007-2018</year><holder>Eelco Dolstra</holder> + </copyright> + </info> + <xi:include href="man-configuration.xml" /> + <xi:include href="man-nixos-build-vms.xml" /> + <xi:include href="man-nixos-generate-config.xml" /> + <xi:include href="man-nixos-install.xml" /> + <xi:include href="man-nixos-enter.xml" /> + <xi:include href="man-nixos-option.xml" /> + <xi:include href="man-nixos-rebuild.xml" /> + <xi:include href="man-nixos-version.xml" /> </reference> diff --git a/nixos/doc/manual/manual.xml b/nixos/doc/manual/manual.xml index 676924e5c8b2..61b21203f500 100644 --- a/nixos/doc/manual/manual.xml +++ b/nixos/doc/manual/manual.xml @@ -3,46 +3,46 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="book-nixos-manual"> - - <info> - <title>NixOS Manual</title> - <subtitle>Version <xi:include href="./generated/version" parse="text" /></subtitle> - </info> - - <preface> - <title>Preface</title> - - <para>This manual describes how to install, use and extend NixOS, - a Linux distribution based on the purely functional package - management system Nix.</para> - - <para>If you encounter problems, please report them on the - <literal + <info> + <title>NixOS Manual</title> + <subtitle>Version <xi:include href="./generated/version" parse="text" /> + </subtitle> + </info> + <preface> + <title>Preface</title> + <para> + This manual describes how to install, use and extend NixOS, a Linux + distribution based on the purely functional package management system Nix. + </para> + <para> + If you encounter problems, please report them on the + <literal xlink:href="https://groups.google.com/forum/#!forum/nix-devel">nix-devel</literal> - mailing list or on the <link + mailing list or on the <link xlink:href="irc://irc.freenode.net/#nixos"> - <literal>#nixos</literal> channel on Freenode</link>. Bugs should - be reported in <link - xlink:href="https://github.com/NixOS/nixpkgs/issues">NixOS’ GitHub - issue tracker</link>.</para> - - <note><para>Commands prefixed with <literal>#</literal> have to be run as - root, either requiring to login as root user or temporarily switching - to it using <literal>sudo</literal> for example.</para></note> - </preface> - - <xi:include href="installation/installation.xml" /> - <xi:include href="configuration/configuration.xml" /> - <xi:include href="administration/running.xml" /> - <!-- <xi:include href="userconfiguration.xml" /> --> - <xi:include href="development/development.xml" /> - - <appendix xml:id="ch-options"> - <title>Configuration Options</title> - <xi:include href="./generated/options-db.xml" + <literal>#nixos</literal> channel on Freenode</link>. Bugs should be + reported in + <link + xlink:href="https://github.com/NixOS/nixpkgs/issues">NixOS’ + GitHub issue tracker</link>. + </para> + <note> + <para> + Commands prefixed with <literal>#</literal> have to be run as root, either + requiring to login as root user or temporarily switching to it using + <literal>sudo</literal> for example. + </para> + </note> + </preface> + <xi:include href="installation/installation.xml" /> + <xi:include href="configuration/configuration.xml" /> + <xi:include href="administration/running.xml" /> +<!-- <xi:include href="userconfiguration.xml" /> --> + <xi:include href="development/development.xml" /> + <appendix xml:id="ch-options"> + <title>Configuration Options</title> + <xi:include href="./generated/options-db.xml" xpointer="configuration-variable-list" /> - </appendix> - - <xi:include href="release-notes/release-notes.xml" /> - + </appendix> + <xi:include href="release-notes/release-notes.xml" /> </book> diff --git a/nixos/doc/manual/release-notes/release-notes.xml b/nixos/doc/manual/release-notes/release-notes.xml index b7f9fab44f3b..94f176186b6e 100644 --- a/nixos/doc/manual/release-notes/release-notes.xml +++ b/nixos/doc/manual/release-notes/release-notes.xml @@ -3,21 +3,19 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="ch-release-notes"> - -<title>Release Notes</title> - -<para>This section lists the release notes for each stable version of NixOS -and current unstable revision.</para> - -<xi:include href="rl-1809.xml" /> -<xi:include href="rl-1803.xml" /> -<xi:include href="rl-1709.xml" /> -<xi:include href="rl-1703.xml" /> -<xi:include href="rl-1609.xml" /> -<xi:include href="rl-1603.xml" /> -<xi:include href="rl-1509.xml" /> -<xi:include href="rl-1412.xml" /> -<xi:include href="rl-1404.xml" /> -<xi:include href="rl-1310.xml" /> - + <title>Release Notes</title> + <para> + This section lists the release notes for each stable version of NixOS and + current unstable revision. + </para> + <xi:include href="rl-1809.xml" /> + <xi:include href="rl-1803.xml" /> + <xi:include href="rl-1709.xml" /> + <xi:include href="rl-1703.xml" /> + <xi:include href="rl-1609.xml" /> + <xi:include href="rl-1603.xml" /> + <xi:include href="rl-1509.xml" /> + <xi:include href="rl-1412.xml" /> + <xi:include href="rl-1404.xml" /> + <xi:include href="rl-1310.xml" /> </appendix> diff --git a/nixos/doc/manual/release-notes/rl-1310.xml b/nixos/doc/manual/release-notes/rl-1310.xml index 583912d70738..248bab70c36b 100644 --- a/nixos/doc/manual/release-notes/rl-1310.xml +++ b/nixos/doc/manual/release-notes/rl-1310.xml @@ -3,9 +3,9 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-release-13.10"> + <title>Release 13.10 (“Aardvark”, 2013/10/31)</title> -<title>Release 13.10 (“Aardvark”, 2013/10/31)</title> - -<para>This is the first stable release branch of NixOS.</para> - + <para> + This is the first stable release branch of NixOS. + </para> </section> diff --git a/nixos/doc/manual/release-notes/rl-1404.xml b/nixos/doc/manual/release-notes/rl-1404.xml index 137caf14cba2..8d8cea4303a3 100644 --- a/nixos/doc/manual/release-notes/rl-1404.xml +++ b/nixos/doc/manual/release-notes/rl-1404.xml @@ -3,158 +3,177 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-release-14.04"> - -<title>Release 14.04 (“Baboon”, 2014/04/30)</title> - -<para>This is the second stable release branch of NixOS. In addition -to numerous new and upgraded packages and modules, this release has -the following highlights: - -<itemizedlist> - - <listitem><para>Installation on UEFI systems is now supported. See - <xref linkend="sec-installation"/> for - details.</para></listitem> - - <listitem><para>Systemd has been updated to version 212, which has - <link xlink:href="http://cgit.freedesktop.org/systemd/systemd/plain/NEWS?id=v212">numerous - improvements</link>. NixOS now automatically starts systemd user - instances when you log in. You can define global user units through - the <option>systemd.unit.*</option> options.</para></listitem> - - <listitem><para>NixOS is now based on Glibc 2.19 and GCC - 4.8.</para></listitem> - - <listitem><para>The default Linux kernel has been updated to - 3.12.</para></listitem> - - <listitem><para>KDE has been updated to 4.12.</para></listitem> - - <listitem><para>GNOME 3.10 experimental support has been added.</para></listitem> - - <listitem><para>Nix has been updated to 1.7 (<link - xlink:href="http://nixos.org/nix/manual/#ssec-relnotes-1.7">details</link>).</para></listitem> - - <listitem><para>NixOS now supports fully declarative management of - users and groups. If you set <option>users.mutableUsers</option> to - <literal>false</literal>, then the contents of - <filename>/etc/passwd</filename> and <filename>/etc/group</filename> - will be <link + <title>Release 14.04 (“Baboon”, 2014/04/30)</title> + + <para> + This is the second stable release branch of NixOS. In addition to numerous + new and upgraded packages and modules, this release has the following + highlights: + <itemizedlist> + <listitem> + <para> + Installation on UEFI systems is now supported. See + <xref linkend="sec-installation"/> for details. + </para> + </listitem> + <listitem> + <para> + Systemd has been updated to version 212, which has + <link xlink:href="http://cgit.freedesktop.org/systemd/systemd/plain/NEWS?id=v212">numerous + improvements</link>. NixOS now automatically starts systemd user instances + when you log in. You can define global user units through the + <option>systemd.unit.*</option> options. + </para> + </listitem> + <listitem> + <para> + NixOS is now based on Glibc 2.19 and GCC 4.8. + </para> + </listitem> + <listitem> + <para> + The default Linux kernel has been updated to 3.12. + </para> + </listitem> + <listitem> + <para> + KDE has been updated to 4.12. + </para> + </listitem> + <listitem> + <para> + GNOME 3.10 experimental support has been added. + </para> + </listitem> + <listitem> + <para> + Nix has been updated to 1.7 + (<link + xlink:href="http://nixos.org/nix/manual/#ssec-relnotes-1.7">details</link>). + </para> + </listitem> + <listitem> + <para> + NixOS now supports fully declarative management of users and groups. If + you set <option>users.mutableUsers</option> to <literal>false</literal>, + then the contents of <filename>/etc/passwd</filename> and + <filename>/etc/group</filename> will be + <link xlink:href="https://www.usenix.org/legacy/event/lisa02/tech/full_papers/traugott/traugott_html/">congruent</link> - to your NixOS configuration. For instance, if you remove a user from - <option>users.extraUsers</option> and run - <command>nixos-rebuild</command>, the user account will cease to - exist. Also, imperative commands for managing users and groups, such - as <command>useradd</command>, are no longer available. If - <option>users.mutableUsers</option> is <literal>true</literal> (the - default), then behaviour is unchanged from NixOS - 13.10.</para></listitem> - - <listitem><para>NixOS now has basic container support, meaning you - can easily run a NixOS instance as a container in a NixOS host - system. These containers are suitable for testing and - experimentation but not production use, since they’re not fully - isolated from the host. See <xref linkend="ch-containers"/> for - details.</para></listitem> - - <listitem><para>Systemd units provided by packages can now be - overridden from the NixOS configuration. For instance, if a package - <literal>foo</literal> provides systemd units, you can say: - + to your NixOS configuration. For instance, if you remove a user from + <option>users.extraUsers</option> and run + <command>nixos-rebuild</command>, the user account will cease to exist. + Also, imperative commands for managing users and groups, such as + <command>useradd</command>, are no longer available. If + <option>users.mutableUsers</option> is <literal>true</literal> (the + default), then behaviour is unchanged from NixOS 13.10. + </para> + </listitem> + <listitem> + <para> + NixOS now has basic container support, meaning you can easily run a NixOS + instance as a container in a NixOS host system. These containers are + suitable for testing and experimentation but not production use, since + they’re not fully isolated from the host. See + <xref linkend="ch-containers"/> for details. + </para> + </listitem> + <listitem> + <para> + Systemd units provided by packages can now be overridden from the NixOS + configuration. For instance, if a package <literal>foo</literal> provides + systemd units, you can say: <programlisting> systemd.packages = [ pkgs.foo ]; </programlisting> - - to enable those units. You can then set or override unit options in - the usual way, e.g. - + to enable those units. You can then set or override unit options in the + usual way, e.g. <programlisting> systemd.services.foo.wantedBy = [ "multi-user.target" ]; systemd.services.foo.serviceConfig.MemoryLimit = "512M"; </programlisting> - - </para></listitem> - -</itemizedlist> - -</para> - -<para>When upgrading from a previous release, please be aware of the -following incompatible changes: - -<itemizedlist> - - <listitem><para>Nixpkgs no longer exposes unfree packages by - default. If your NixOS configuration requires unfree packages from - Nixpkgs, you need to enable support for them explicitly by setting: - + </para> + </listitem> + </itemizedlist> + </para> + + <para> + When upgrading from a previous release, please be aware of the following + incompatible changes: + <itemizedlist> + <listitem> + <para> + Nixpkgs no longer exposes unfree packages by default. If your NixOS + configuration requires unfree packages from Nixpkgs, you need to enable + support for them explicitly by setting: <programlisting> nixpkgs.config.allowUnfree = true; </programlisting> - - Otherwise, you get an error message such as: - + Otherwise, you get an error message such as: <screen> error: package ‘nvidia-x11-331.49-3.12.17’ in ‘…/nvidia-x11/default.nix:56’ has an unfree license, refusing to evaluate </screen> - - </para></listitem> - - <listitem><para>The Adobe Flash player is no longer enabled by - default in the Firefox and Chromium wrappers. To enable it, you must - set: - + </para> + </listitem> + <listitem> + <para> + The Adobe Flash player is no longer enabled by default in the Firefox and + Chromium wrappers. To enable it, you must set: <programlisting> nixpkgs.config.allowUnfree = true; nixpkgs.config.firefox.enableAdobeFlash = true; # for Firefox nixpkgs.config.chromium.enableAdobeFlash = true; # for Chromium </programlisting> - - </para></listitem> - - <listitem><para>The firewall is now enabled by default. If you don’t - want this, you need to disable it explicitly: - + </para> + </listitem> + <listitem> + <para> + The firewall is now enabled by default. If you don’t want this, you need + to disable it explicitly: <programlisting> networking.firewall.enable = false; </programlisting> - - </para></listitem> - - <listitem><para>The option - <option>boot.loader.grub.memtest86</option> has been renamed to - <option>boot.loader.grub.memtest86.enable</option>.</para></listitem> - - <listitem><para>The <literal>mysql55</literal> service has been - merged into the <literal>mysql</literal> service, which no longer - sets a default for the option - <option>services.mysql.package</option>.</para></listitem> - - <listitem><para>Package variants are now differentiated by suffixing - the name, rather than the version. For instance, - <filename>sqlite-3.8.4.3-interactive</filename> is now called - <filename>sqlite-interactive-3.8.4.3</filename>. This ensures that - <literal>nix-env -i sqlite</literal> is unambiguous, and that - <literal>nix-env -u</literal> won’t “upgrade” - <literal>sqlite</literal> to <literal>sqlite-interactive</literal> - or vice versa. Notably, this change affects the Firefox wrapper - (which provides plugins), as it is now called - <literal>firefox-wrapper</literal>. So when using - <command>nix-env</command>, you should do <literal>nix-env -e - firefox; nix-env -i firefox-wrapper</literal> if you want to keep - using the wrapper. This change does not affect declarative package - management, since attribute names like - <literal>pkgs.firefoxWrapper</literal> were already - unambiguous.</para></listitem> - - <listitem><para>The symlink <filename>/etc/ca-bundle.crt</filename> - is gone. Programs should instead use the environment variable - <envar>OPENSSL_X509_CERT_FILE</envar> (which points to - <filename>/etc/ssl/certs/ca-bundle.crt</filename>).</para></listitem> - -</itemizedlist> - -</para> - + </para> + </listitem> + <listitem> + <para> + The option <option>boot.loader.grub.memtest86</option> has been renamed to + <option>boot.loader.grub.memtest86.enable</option>. + </para> + </listitem> + <listitem> + <para> + The <literal>mysql55</literal> service has been merged into the + <literal>mysql</literal> service, which no longer sets a default for the + option <option>services.mysql.package</option>. + </para> + </listitem> + <listitem> + <para> + Package variants are now differentiated by suffixing the name, rather than + the version. For instance, <filename>sqlite-3.8.4.3-interactive</filename> + is now called <filename>sqlite-interactive-3.8.4.3</filename>. This + ensures that <literal>nix-env -i sqlite</literal> is unambiguous, and that + <literal>nix-env -u</literal> won’t “upgrade” + <literal>sqlite</literal> to <literal>sqlite-interactive</literal> or vice + versa. Notably, this change affects the Firefox wrapper (which provides + plugins), as it is now called <literal>firefox-wrapper</literal>. So when + using <command>nix-env</command>, you should do <literal>nix-env -e + firefox; nix-env -i firefox-wrapper</literal> if you want to keep using + the wrapper. This change does not affect declarative package management, + since attribute names like <literal>pkgs.firefoxWrapper</literal> were + already unambiguous. + </para> + </listitem> + <listitem> + <para> + The symlink <filename>/etc/ca-bundle.crt</filename> is gone. Programs + should instead use the environment variable + <envar>OPENSSL_X509_CERT_FILE</envar> (which points to + <filename>/etc/ssl/certs/ca-bundle.crt</filename>). + </para> + </listitem> + </itemizedlist> + </para> </section> diff --git a/nixos/doc/manual/release-notes/rl-1412.xml b/nixos/doc/manual/release-notes/rl-1412.xml index 42b51cd4a8ef..4d93aa644c1d 100644 --- a/nixos/doc/manual/release-notes/rl-1412.xml +++ b/nixos/doc/manual/release-notes/rl-1412.xml @@ -3,175 +3,465 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-release-14.12"> + <title>Release 14.12 (“Caterpillar”, 2014/12/30)</title> -<title>Release 14.12 (“Caterpillar”, 2014/12/30)</title> + <para> + In addition to numerous new and upgraded packages, this release has the + following highlights: + <itemizedlist> + <listitem> + <para> + Systemd has been updated to version 217, which has numerous + <link xlink:href="http://lists.freedesktop.org/archives/systemd-devel/2014-October/024662.html">improvements.</link> + </para> + </listitem> + <listitem> + <para> + <link xlink:href="http://thread.gmane.org/gmane.linux.distributions.nixos/15165"> + Nix has been updated to 1.8.</link> + </para> + </listitem> + <listitem> + <para> + NixOS is now based on Glibc 2.20. + </para> + </listitem> + <listitem> + <para> + KDE has been updated to 4.14. + </para> + </listitem> + <listitem> + <para> + The default Linux kernel has been updated to 3.14. + </para> + </listitem> + <listitem> + <para> + If <option>users.mutableUsers</option> is enabled (the default), changes + made to the declaration of a user or group will be correctly realised when + running <command>nixos-rebuild</command>. For instance, removing a user + specification from <filename>configuration.nix</filename> will cause the + actual user account to be deleted. If <option>users.mutableUsers</option> + is disabled, it is no longer necessary to specify UIDs or GIDs; if + omitted, they are allocated dynamically. + </para> + </listitem> + </itemizedlist> + </para> -<para>In addition to numerous new and upgraded packages, this release has the following highlights: + <para> + Following new services were added since the last release: + <itemizedlist> + <listitem> + <para> + <literal>atftpd</literal> + </para> + </listitem> + <listitem> + <para> + <literal>bosun</literal> + </para> + </listitem> + <listitem> + <para> + <literal>bspwm</literal> + </para> + </listitem> + <listitem> + <para> + <literal>chronos</literal> + </para> + </listitem> + <listitem> + <para> + <literal>collectd</literal> + </para> + </listitem> + <listitem> + <para> + <literal>consul</literal> + </para> + </listitem> + <listitem> + <para> + <literal>cpuminer-cryptonight</literal> + </para> + </listitem> + <listitem> + <para> + <literal>crashplan</literal> + </para> + </listitem> + <listitem> + <para> + <literal>dnscrypt-proxy</literal> + </para> + </listitem> + <listitem> + <para> + <literal>docker-registry</literal> + </para> + </listitem> + <listitem> + <para> + <literal>docker</literal> + </para> + </listitem> + <listitem> + <para> + <literal>etcd</literal> + </para> + </listitem> + <listitem> + <para> + <literal>fail2ban</literal> + </para> + </listitem> + <listitem> + <para> + <literal>fcgiwrap</literal> + </para> + </listitem> + <listitem> + <para> + <literal>fleet</literal> + </para> + </listitem> + <listitem> + <para> + <literal>fluxbox</literal> + </para> + </listitem> + <listitem> + <para> + <literal>gdm</literal> + </para> + </listitem> + <listitem> + <para> + <literal>geoclue2</literal> + </para> + </listitem> + <listitem> + <para> + <literal>gitlab</literal> + </para> + </listitem> + <listitem> + <para> + <literal>gitolite</literal> + </para> + </listitem> + <listitem> + <para> + <literal>gnome3.gnome-documents</literal> + </para> + </listitem> + <listitem> + <para> + <literal>gnome3.gnome-online-miners</literal> + </para> + </listitem> + <listitem> + <para> + <literal>gnome3.gvfs</literal> + </para> + </listitem> + <listitem> + <para> + <literal>gnome3.seahorse</literal> + </para> + </listitem> + <listitem> + <para> + <literal>hbase</literal> + </para> + </listitem> + <listitem> + <para> + <literal>i2pd</literal> + </para> + </listitem> + <listitem> + <para> + <literal>influxdb</literal> + </para> + </listitem> + <listitem> + <para> + <literal>kubernetes</literal> + </para> + </listitem> + <listitem> + <para> + <literal>liquidsoap</literal> + </para> + </listitem> + <listitem> + <para> + <literal>lxc</literal> + </para> + </listitem> + <listitem> + <para> + <literal>mailpile</literal> + </para> + </listitem> + <listitem> + <para> + <literal>mesos</literal> + </para> + </listitem> + <listitem> + <para> + <literal>mlmmj</literal> + </para> + </listitem> + <listitem> + <para> + <literal>monetdb</literal> + </para> + </listitem> + <listitem> + <para> + <literal>mopidy</literal> + </para> + </listitem> + <listitem> + <para> + <literal>neo4j</literal> + </para> + </listitem> + <listitem> + <para> + <literal>nsd</literal> + </para> + </listitem> + <listitem> + <para> + <literal>openntpd</literal> + </para> + </listitem> + <listitem> + <para> + <literal>opentsdb</literal> + </para> + </listitem> + <listitem> + <para> + <literal>openvswitch</literal> + </para> + </listitem> + <listitem> + <para> + <literal>parallels-guest</literal> + </para> + </listitem> + <listitem> + <para> + <literal>peerflix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>phd</literal> + </para> + </listitem> + <listitem> + <para> + <literal>polipo</literal> + </para> + </listitem> + <listitem> + <para> + <literal>prosody</literal> + </para> + </listitem> + <listitem> + <para> + <literal>radicale</literal> + </para> + </listitem> + <listitem> + <para> + <literal>redmine</literal> + </para> + </listitem> + <listitem> + <para> + <literal>riemann</literal> + </para> + </listitem> + <listitem> + <para> + <literal>scollector</literal> + </para> + </listitem> + <listitem> + <para> + <literal>seeks</literal> + </para> + </listitem> + <listitem> + <para> + <literal>siproxd</literal> + </para> + </listitem> + <listitem> + <para> + <literal>strongswan</literal> + </para> + </listitem> + <listitem> + <para> + <literal>tcsd</literal> + </para> + </listitem> + <listitem> + <para> + <literal>teamspeak3</literal> + </para> + </listitem> + <listitem> + <para> + <literal>thermald</literal> + </para> + </listitem> + <listitem> + <para> + <literal>torque/mrom</literal> + </para> + </listitem> + <listitem> + <para> + <literal>torque/server</literal> + </para> + </listitem> + <listitem> + <para> + <literal>uhub</literal> + </para> + </listitem> + <listitem> + <para> + <literal>unifi</literal> + </para> + </listitem> + <listitem> + <para> + <literal>znc</literal> + </para> + </listitem> + <listitem> + <para> + <literal>zookeeper</literal> + </para> + </listitem> + </itemizedlist> + </para> -<itemizedlist> - -<listitem><para>Systemd has been updated to version 217, which has numerous -<link xlink:href="http://lists.freedesktop.org/archives/systemd-devel/2014-October/024662.html">improvements.</link></para></listitem> - -<listitem><para><link xlink:href="http://thread.gmane.org/gmane.linux.distributions.nixos/15165"> -Nix has been updated to 1.8.</link></para></listitem> - -<listitem><para>NixOS is now based on Glibc 2.20.</para></listitem> - -<listitem><para>KDE has been updated to 4.14.</para></listitem> - -<listitem><para>The default Linux kernel has been updated to 3.14.</para></listitem> - -<listitem><para>If <option>users.mutableUsers</option> is enabled (the -default), changes made to the declaration of a user or group will be -correctly realised when running <command>nixos-rebuild</command>. For -instance, removing a user specification from -<filename>configuration.nix</filename> will cause the actual user -account to be deleted. If <option>users.mutableUsers</option> is -disabled, it is no longer necessary to specify UIDs or GIDs; if -omitted, they are allocated dynamically.</para></listitem> - -</itemizedlist></para> - -<para>Following new services were added since the last release: - -<itemizedlist> -<listitem><para><literal>atftpd</literal></para></listitem> -<listitem><para><literal>bosun</literal></para></listitem> -<listitem><para><literal>bspwm</literal></para></listitem> -<listitem><para><literal>chronos</literal></para></listitem> -<listitem><para><literal>collectd</literal></para></listitem> -<listitem><para><literal>consul</literal></para></listitem> -<listitem><para><literal>cpuminer-cryptonight</literal></para></listitem> -<listitem><para><literal>crashplan</literal></para></listitem> -<listitem><para><literal>dnscrypt-proxy</literal></para></listitem> -<listitem><para><literal>docker-registry</literal></para></listitem> -<listitem><para><literal>docker</literal></para></listitem> -<listitem><para><literal>etcd</literal></para></listitem> -<listitem><para><literal>fail2ban</literal></para></listitem> -<listitem><para><literal>fcgiwrap</literal></para></listitem> -<listitem><para><literal>fleet</literal></para></listitem> -<listitem><para><literal>fluxbox</literal></para></listitem> -<listitem><para><literal>gdm</literal></para></listitem> -<listitem><para><literal>geoclue2</literal></para></listitem> -<listitem><para><literal>gitlab</literal></para></listitem> -<listitem><para><literal>gitolite</literal></para></listitem> -<listitem><para><literal>gnome3.gnome-documents</literal></para></listitem> -<listitem><para><literal>gnome3.gnome-online-miners</literal></para></listitem> -<listitem><para><literal>gnome3.gvfs</literal></para></listitem> -<listitem><para><literal>gnome3.seahorse</literal></para></listitem> -<listitem><para><literal>hbase</literal></para></listitem> -<listitem><para><literal>i2pd</literal></para></listitem> -<listitem><para><literal>influxdb</literal></para></listitem> -<listitem><para><literal>kubernetes</literal></para></listitem> -<listitem><para><literal>liquidsoap</literal></para></listitem> -<listitem><para><literal>lxc</literal></para></listitem> -<listitem><para><literal>mailpile</literal></para></listitem> -<listitem><para><literal>mesos</literal></para></listitem> -<listitem><para><literal>mlmmj</literal></para></listitem> -<listitem><para><literal>monetdb</literal></para></listitem> -<listitem><para><literal>mopidy</literal></para></listitem> -<listitem><para><literal>neo4j</literal></para></listitem> -<listitem><para><literal>nsd</literal></para></listitem> -<listitem><para><literal>openntpd</literal></para></listitem> -<listitem><para><literal>opentsdb</literal></para></listitem> -<listitem><para><literal>openvswitch</literal></para></listitem> -<listitem><para><literal>parallels-guest</literal></para></listitem> -<listitem><para><literal>peerflix</literal></para></listitem> -<listitem><para><literal>phd</literal></para></listitem> -<listitem><para><literal>polipo</literal></para></listitem> -<listitem><para><literal>prosody</literal></para></listitem> -<listitem><para><literal>radicale</literal></para></listitem> -<listitem><para><literal>redmine</literal></para></listitem> -<listitem><para><literal>riemann</literal></para></listitem> -<listitem><para><literal>scollector</literal></para></listitem> -<listitem><para><literal>seeks</literal></para></listitem> -<listitem><para><literal>siproxd</literal></para></listitem> -<listitem><para><literal>strongswan</literal></para></listitem> -<listitem><para><literal>tcsd</literal></para></listitem> -<listitem><para><literal>teamspeak3</literal></para></listitem> -<listitem><para><literal>thermald</literal></para></listitem> -<listitem><para><literal>torque/mrom</literal></para></listitem> -<listitem><para><literal>torque/server</literal></para></listitem> -<listitem><para><literal>uhub</literal></para></listitem> -<listitem><para><literal>unifi</literal></para></listitem> -<listitem><para><literal>znc</literal></para></listitem> -<listitem><para><literal>zookeeper</literal></para></listitem> -</itemizedlist> -</para> - -<para>When upgrading from a previous release, please be aware of the -following incompatible changes: - -<itemizedlist> - -<listitem><para>The default version of Apache httpd is now 2.4. If -you use the <option>extraConfig</option> option to pass literal -Apache configuration text, you may need to update it — see <link + <para> + When upgrading from a previous release, please be aware of the following + incompatible changes: + <itemizedlist> + <listitem> + <para> + The default version of Apache httpd is now 2.4. If you use the + <option>extraConfig</option> option to pass literal Apache configuration + text, you may need to update it — see + <link xlink:href="http://httpd.apache.org/docs/2.4/upgrading.html">Apache’s -documentation</link> for details. If you wish to continue to use -httpd 2.2, add the following line to your NixOS configuration: - + documentation</link> for details. If you wish to continue to use httpd + 2.2, add the following line to your NixOS configuration: <programlisting> services.httpd.package = pkgs.apacheHttpd_2_2; </programlisting> - -</para></listitem> - -<listitem><para>PHP 5.3 has been removed because it is no longer -supported by the PHP project. A <link -xlink:href="http://php.net/migration54">migration guide</link> is -available.</para></listitem> - -<listitem><para>The host side of a container virtual Ethernet pair -is now called <literal>ve-<replaceable>container-name</replaceable></literal> -rather than <literal>c-<replaceable>container-name</replaceable></literal>.</para></listitem> - -<listitem><para>GNOME 3.10 support has been dropped. The default GNOME version is now 3.12.</para></listitem> - -<listitem><para>VirtualBox has been upgraded to 4.3.20 release. Users -may be required to run <command>rm -rf /tmp/.vbox*</command>. The line -<literal>imports = [ <nixpkgs/nixos/modules/programs/virtualbox.nix> ]</literal> is -no longer necessary, use <literal>services.virtualboxHost.enable = -true</literal> instead. -</para> -<para>Also, hardening mode is now enabled by default, which means that unless you want to use -USB support, you no longer need to be a member of the <literal>vboxusers</literal> group. -</para></listitem> - -<listitem><para>Chromium has been updated to 39.0.2171.65. <option>enablePepperPDF</option> is now enabled by default. -<literal>chromium*Wrapper</literal> packages no longer exist, because upstream removed NSAPI support. -<literal>chromium-stable</literal> has been renamed to <literal>chromium</literal>. -</para></listitem> - -<listitem><para>Python packaging documentation is now part of nixpkgs manual. To override -the python packages available to a custom python you now use <literal>pkgs.pythonFull.buildEnv.override</literal> -instead of <literal>pkgs.pythonFull.override</literal>. -</para></listitem> - -<listitem><para><literal>boot.resumeDevice = "8:6"</literal> is no longer supported. Most users will -want to leave it undefined, which takes the swap partitions automatically. There is an evaluation -assertion to ensure that the string starts with a slash. -</para></listitem> - -<listitem><para>The system-wide default timezone for NixOS installations -changed from <literal>CET</literal> to <literal>UTC</literal>. To choose -a different timezone for your system, configure -<literal>time.timeZone</literal> in -<literal>configuration.nix</literal>. A fairly complete list of possible -values for that setting is available at <link -xlink:href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones"/>.</para></listitem> - -<listitem><para>GNU screen has been updated to 4.2.1, which breaks -the ability to connect to sessions created by older versions of -screen.</para></listitem> - -<listitem><para>The Intel GPU driver was updated to the 3.x prerelease -version (used by most distributions) and supports DRI3 -now.</para></listitem> - -</itemizedlist> - -</para> - + </para> + </listitem> + <listitem> + <para> + PHP 5.3 has been removed because it is no longer supported by the PHP + project. A <link +xlink:href="http://php.net/migration54">migration + guide</link> is available. + </para> + </listitem> + <listitem> + <para> + The host side of a container virtual Ethernet pair is now called + <literal>ve-<replaceable>container-name</replaceable></literal> rather + than <literal>c-<replaceable>container-name</replaceable></literal>. + </para> + </listitem> + <listitem> + <para> + GNOME 3.10 support has been dropped. The default GNOME version is now + 3.12. + </para> + </listitem> + <listitem> + <para> + VirtualBox has been upgraded to 4.3.20 release. Users may be required to + run <command>rm -rf /tmp/.vbox*</command>. The line <literal>imports = [ + <nixpkgs/nixos/modules/programs/virtualbox.nix> ]</literal> is no + longer necessary, use <literal>services.virtualboxHost.enable = + true</literal> instead. + </para> + <para> + Also, hardening mode is now enabled by default, which means that unless + you want to use USB support, you no longer need to be a member of the + <literal>vboxusers</literal> group. + </para> + </listitem> + <listitem> + <para> + Chromium has been updated to 39.0.2171.65. + <option>enablePepperPDF</option> is now enabled by default. + <literal>chromium*Wrapper</literal> packages no longer exist, because + upstream removed NSAPI support. <literal>chromium-stable</literal> has + been renamed to <literal>chromium</literal>. + </para> + </listitem> + <listitem> + <para> + Python packaging documentation is now part of nixpkgs manual. To override + the python packages available to a custom python you now use + <literal>pkgs.pythonFull.buildEnv.override</literal> instead of + <literal>pkgs.pythonFull.override</literal>. + </para> + </listitem> + <listitem> + <para> + <literal>boot.resumeDevice = "8:6"</literal> is no longer supported. Most + users will want to leave it undefined, which takes the swap partitions + automatically. There is an evaluation assertion to ensure that the string + starts with a slash. + </para> + </listitem> + <listitem> + <para> + The system-wide default timezone for NixOS installations changed from + <literal>CET</literal> to <literal>UTC</literal>. To choose a different + timezone for your system, configure <literal>time.timeZone</literal> in + <literal>configuration.nix</literal>. A fairly complete list of possible + values for that setting is available at + <link +xlink:href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones"/>. + </para> + </listitem> + <listitem> + <para> + GNU screen has been updated to 4.2.1, which breaks the ability to connect + to sessions created by older versions of screen. + </para> + </listitem> + <listitem> + <para> + The Intel GPU driver was updated to the 3.x prerelease version (used by + most distributions) and supports DRI3 now. + </para> + </listitem> + </itemizedlist> + </para> </section> diff --git a/nixos/doc/manual/release-notes/rl-1509.xml b/nixos/doc/manual/release-notes/rl-1509.xml index 6c1c46844ccb..e500c9d63422 100644 --- a/nixos/doc/manual/release-notes/rl-1509.xml +++ b/nixos/doc/manual/release-notes/rl-1509.xml @@ -3,375 +3,640 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-release-15.09"> + <title>Release 15.09 (“Dingo”, 2015/09/30)</title> -<title>Release 15.09 (“Dingo”, 2015/09/30)</title> - -<para>In addition to numerous new and upgraded packages, this release -has the following highlights:</para> - -<itemizedlist> + <para> + In addition to numerous new and upgraded packages, this release has the + following highlights: + </para> + <itemizedlist> <listitem> - <para>The <link xlink:href="http://haskell.org/">Haskell</link> - packages infrastructure has been re-designed from the ground up - ("Haskell NG"). NixOS now distributes the latest version - of every single package registered on <link - xlink:href="http://hackage.haskell.org/">Hackage</link> -- well in - excess of 8,000 Haskell packages. Detailed instructions on how to - use that infrastructure can be found in the <link + <para> + The <link xlink:href="http://haskell.org/">Haskell</link> packages + infrastructure has been re-designed from the ground up ("Haskell + NG"). NixOS now distributes the latest version of every single package + registered on + <link + xlink:href="http://hackage.haskell.org/">Hackage</link> -- well + in excess of 8,000 Haskell packages. Detailed instructions on how to use + that infrastructure can be found in the + <link xlink:href="http://nixos.org/nixpkgs/manual/#users-guide-to-the-haskell-infrastructure">User's - Guide to the Haskell Infrastructure</link>. Users migrating from an - earlier release may find helpful information below, in the list of - backwards-incompatible changes. Furthermore, we distribute 51(!) - additional Haskell package sets that provide every single <link + Guide to the Haskell Infrastructure</link>. Users migrating from an earlier + release may find helpful information below, in the list of + backwards-incompatible changes. Furthermore, we distribute 51(!) additional + Haskell package sets that provide every single + <link xlink:href="http://www.stackage.org/">LTS Haskell</link> release - since version 0.0 as well as the most recent <link + since version 0.0 as well as the most recent + <link xlink:href="http://www.stackage.org/">Stackage Nightly</link> - snapshot. The announcement <link + snapshot. The announcement + <link xlink:href="https://nixos.org/nix-dev/2015-September/018138.html">"Full - Stackage Support in Nixpkgs"</link> gives additional - details.</para> + Stackage Support in Nixpkgs"</link> gives additional details. + </para> </listitem> - <listitem> - <para>Nix has been updated to version 1.10, which among other - improvements enables cryptographic signatures on binary caches for - improved security.</para> + <para> + Nix has been updated to version 1.10, which among other improvements + enables cryptographic signatures on binary caches for improved security. + </para> </listitem> - <listitem> - <para>You can now keep your NixOS system up to date automatically - by setting - + <para> + You can now keep your NixOS system up to date automatically by setting <programlisting> system.autoUpgrade.enable = true; </programlisting> - - This will cause the system to periodically check for updates in - your current channel and run <command>nixos-rebuild</command>.</para> + This will cause the system to periodically check for updates in your + current channel and run <command>nixos-rebuild</command>. + </para> </listitem> - <listitem> - <para>This release is based on Glibc 2.21, GCC 4.9 and Linux - 3.18.</para> + <para> + This release is based on Glibc 2.21, GCC 4.9 and Linux 3.18. + </para> </listitem> - <listitem> - <para>GNOME has been upgraded to 3.16. - </para> + <para> + GNOME has been upgraded to 3.16. + </para> </listitem> - <listitem> - <para>Xfce has been upgraded to 4.12. - </para> + <para> + Xfce has been upgraded to 4.12. + </para> </listitem> - <listitem> - <para>KDE 5 has been upgraded to KDE Frameworks 5.10, - Plasma 5.3.2 and Applications 15.04.3. - KDE 4 has been updated to kdelibs-4.14.10. - </para> + <para> + KDE 5 has been upgraded to KDE Frameworks 5.10, Plasma 5.3.2 and + Applications 15.04.3. KDE 4 has been updated to kdelibs-4.14.10. + </para> </listitem> - <listitem> - <para>E19 has been upgraded to 0.16.8.15. - </para> + <para> + E19 has been upgraded to 0.16.8.15. + </para> </listitem> + </itemizedlist> -</itemizedlist> - - -<para>The following new services were added since the last release: - + <para> + The following new services were added since the last release: <itemizedlist> - <listitem><para><literal>services/mail/exim.nix</literal></para></listitem> - <listitem><para><literal>services/misc/apache-kafka.nix</literal></para></listitem> - <listitem><para><literal>services/misc/canto-daemon.nix</literal></para></listitem> - <listitem><para><literal>services/misc/confd.nix</literal></para></listitem> - <listitem><para><literal>services/misc/devmon.nix</literal></para></listitem> - <listitem><para><literal>services/misc/gitit.nix</literal></para></listitem> - <listitem><para><literal>services/misc/ihaskell.nix</literal></para></listitem> - <listitem><para><literal>services/misc/mbpfan.nix</literal></para></listitem> - <listitem><para><literal>services/misc/mediatomb.nix</literal></para></listitem> - <listitem><para><literal>services/misc/mwlib.nix</literal></para></listitem> - <listitem><para><literal>services/misc/parsoid.nix</literal></para></listitem> - <listitem><para><literal>services/misc/plex.nix</literal></para></listitem> - <listitem><para><literal>services/misc/ripple-rest.nix</literal></para></listitem> - <listitem><para><literal>services/misc/ripple-data-api.nix</literal></para></listitem> - <listitem><para><literal>services/misc/subsonic.nix</literal></para></listitem> - <listitem><para><literal>services/misc/sundtek.nix</literal></para></listitem> - <listitem><para><literal>services/monitoring/cadvisor.nix</literal></para></listitem> - <listitem><para><literal>services/monitoring/das_watchdog.nix</literal></para></listitem> - <listitem><para><literal>services/monitoring/grafana.nix</literal></para></listitem> - <listitem><para><literal>services/monitoring/riemann-tools.nix</literal></para></listitem> - <listitem><para><literal>services/monitoring/teamviewer.nix</literal></para></listitem> - <listitem><para><literal>services/network-filesystems/u9fs.nix</literal></para></listitem> - <listitem><para><literal>services/networking/aiccu.nix</literal></para></listitem> - <listitem><para><literal>services/networking/asterisk.nix</literal></para></listitem> - <listitem><para><literal>services/networking/bird.nix</literal></para></listitem> - <listitem><para><literal>services/networking/charybdis.nix</literal></para></listitem> - <listitem><para><literal>services/networking/docker-registry-server.nix</literal></para></listitem> - <listitem><para><literal>services/networking/fan.nix</literal></para></listitem> - <listitem><para><literal>services/networking/firefox/sync-server.nix</literal></para></listitem> - <listitem><para><literal>services/networking/gateone.nix</literal></para></listitem> - <listitem><para><literal>services/networking/heyefi.nix</literal></para></listitem> - <listitem><para><literal>services/networking/i2p.nix</literal></para></listitem> - <listitem><para><literal>services/networking/lambdabot.nix</literal></para></listitem> - <listitem><para><literal>services/networking/mstpd.nix</literal></para></listitem> - <listitem><para><literal>services/networking/nix-serve.nix</literal></para></listitem> - <listitem><para><literal>services/networking/nylon.nix</literal></para></listitem> - <listitem><para><literal>services/networking/racoon.nix</literal></para></listitem> - <listitem><para><literal>services/networking/skydns.nix</literal></para></listitem> - <listitem><para><literal>services/networking/shout.nix</literal></para></listitem> - <listitem><para><literal>services/networking/softether.nix</literal></para></listitem> - <listitem><para><literal>services/networking/sslh.nix</literal></para></listitem> - <listitem><para><literal>services/networking/tinc.nix</literal></para></listitem> - <listitem><para><literal>services/networking/tlsdated.nix</literal></para></listitem> - <listitem><para><literal>services/networking/tox-bootstrapd.nix</literal></para></listitem> - <listitem><para><literal>services/networking/tvheadend.nix</literal></para></listitem> - <listitem><para><literal>services/networking/zerotierone.nix</literal></para></listitem> - <listitem><para><literal>services/scheduling/marathon.nix</literal></para></listitem> - <listitem><para><literal>services/security/fprintd.nix</literal></para></listitem> - <listitem><para><literal>services/security/hologram.nix</literal></para></listitem> - <listitem><para><literal>services/security/munge.nix</literal></para></listitem> - <listitem><para><literal>services/system/cloud-init.nix</literal></para></listitem> - <listitem><para><literal>services/web-servers/shellinabox.nix</literal></para></listitem> - <listitem><para><literal>services/web-servers/uwsgi.nix</literal></para></listitem> - <listitem><para><literal>services/x11/unclutter.nix</literal></para></listitem> - <listitem><para><literal>services/x11/display-managers/sddm.nix</literal></para></listitem> - <listitem><para><literal>system/boot/coredump.nix</literal></para></listitem> - <listitem><para><literal>system/boot/loader/loader.nix</literal></para></listitem> - <listitem><para><literal>system/boot/loader/generic-extlinux-compatible</literal></para></listitem> - <listitem><para><literal>system/boot/networkd.nix</literal></para></listitem> - <listitem><para><literal>system/boot/resolved.nix</literal></para></listitem> - <listitem><para><literal>system/boot/timesyncd.nix</literal></para></listitem> - <listitem><para><literal>tasks/filesystems/exfat.nix</literal></para></listitem> - <listitem><para><literal>tasks/filesystems/ntfs.nix</literal></para></listitem> - <listitem><para><literal>tasks/filesystems/vboxsf.nix</literal></para></listitem> - <listitem><para><literal>virtualisation/virtualbox-host.nix</literal></para></listitem> - <listitem><para><literal>virtualisation/vmware-guest.nix</literal></para></listitem> - <listitem><para><literal>virtualisation/xen-dom0.nix</literal></para></listitem> + <listitem> + <para> + <literal>services/mail/exim.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/apache-kafka.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/canto-daemon.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/confd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/devmon.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/gitit.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/ihaskell.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/mbpfan.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/mediatomb.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/mwlib.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/parsoid.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/plex.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/ripple-rest.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/ripple-data-api.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/subsonic.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/sundtek.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/cadvisor.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/das_watchdog.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/grafana.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/riemann-tools.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/teamviewer.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/network-filesystems/u9fs.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/aiccu.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/asterisk.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/bird.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/charybdis.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/docker-registry-server.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/fan.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/firefox/sync-server.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/gateone.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/heyefi.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/i2p.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/lambdabot.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/mstpd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/nix-serve.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/nylon.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/racoon.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/skydns.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/shout.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/softether.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/sslh.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/tinc.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/tlsdated.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/tox-bootstrapd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/tvheadend.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/zerotierone.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/scheduling/marathon.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/security/fprintd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/security/hologram.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/security/munge.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/system/cloud-init.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/web-servers/shellinabox.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/web-servers/uwsgi.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/x11/unclutter.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/x11/display-managers/sddm.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>system/boot/coredump.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>system/boot/loader/loader.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>system/boot/loader/generic-extlinux-compatible</literal> + </para> + </listitem> + <listitem> + <para> + <literal>system/boot/networkd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>system/boot/resolved.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>system/boot/timesyncd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>tasks/filesystems/exfat.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>tasks/filesystems/ntfs.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>tasks/filesystems/vboxsf.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>virtualisation/virtualbox-host.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>virtualisation/vmware-guest.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>virtualisation/xen-dom0.nix</literal> + </para> + </listitem> </itemizedlist> -</para> - - -<para>When upgrading from a previous release, please be aware of the -following incompatible changes: - -<itemizedlist> - -<listitem><para><command>sshd</command> no longer supports DSA and ECDSA -host keys by default. If you have existing systems with such host keys -and want to continue to use them, please set + </para> + <para> + When upgrading from a previous release, please be aware of the following + incompatible changes: + <itemizedlist> + <listitem> + <para> + <command>sshd</command> no longer supports DSA and ECDSA host keys by + default. If you have existing systems with such host keys and want to + continue to use them, please set <programlisting> system.stateVersion = "14.12"; </programlisting> - -The new option <option>system.stateVersion</option> ensures that -certain configuration changes that could break existing systems (such -as the <command>sshd</command> host key setting) will maintain -compatibility with the specified NixOS release. NixOps sets the state -version of existing deployments automatically.</para></listitem> - -<listitem><para><command>cron</command> is no longer enabled by -default, unless you have a non-empty -<option>services.cron.systemCronJobs</option>. To force -<command>cron</command> to be enabled, set -<option>services.cron.enable = true</option>.</para></listitem> - -<listitem><para>Nix now requires binary caches to be cryptographically -signed. If you have unsigned binary caches that you want to continue -to use, you should set <option>nix.requireSignedBinaryCaches = -false</option>.</para></listitem> - -<listitem><para>Steam now doesn't need root rights to work. Instead of using -<literal>*-steam-chrootenv</literal>, you should now just run <literal>steam</literal>. -<literal>steamChrootEnv</literal> package was renamed to <literal>steam</literal>, -and old <literal>steam</literal> package -- to <literal>steamOriginal</literal>. -</para></listitem> - -<listitem><para>CMPlayer has been renamed to bomi upstream. Package -<literal>cmplayer</literal> was accordingly renamed to -<literal>bomi</literal> </para></listitem> - -<listitem><para>Atom Shell has been renamed to Electron upstream. Package <literal>atom-shell</literal> -was accordingly renamed to <literal>electron</literal> -</para></listitem> - -<listitem><para>Elm is not released on Hackage anymore. You should now use <literal>elmPackages.elm</literal> -which contains the latest Elm platform.</para></listitem> - -<listitem> - <para>The CUPS printing service has been updated to version - <literal>2.0.2</literal>. Furthermore its systemd service has been - renamed to <literal>cups.service</literal>.</para> - - <para>Local printers are no longer shared or advertised by - default. This behavior can be changed by enabling - <option>services.printing.defaultShared</option> or - <option>services.printing.browsing</option> respectively.</para> -</listitem> - -<listitem> - <para> - The VirtualBox host and guest options have been named more - consistently. They can now found in - <option>virtualisation.virtualbox.host.*</option> instead of - <option>services.virtualboxHost.*</option> and - <option>virtualisation.virtualbox.guest.*</option> instead of - <option>services.virtualboxGuest.*</option>. - </para> - - <para> - Also, there now is support for the <literal>vboxsf</literal> file - system using the <option>fileSystems</option> configuration - attribute. An example of how this can be used in a configuration: - + The new option <option>system.stateVersion</option> ensures that certain + configuration changes that could break existing systems (such as the + <command>sshd</command> host key setting) will maintain compatibility with + the specified NixOS release. NixOps sets the state version of existing + deployments automatically. + </para> + </listitem> + <listitem> + <para> + <command>cron</command> is no longer enabled by default, unless you have a + non-empty <option>services.cron.systemCronJobs</option>. To force + <command>cron</command> to be enabled, set <option>services.cron.enable = + true</option>. + </para> + </listitem> + <listitem> + <para> + Nix now requires binary caches to be cryptographically signed. If you have + unsigned binary caches that you want to continue to use, you should set + <option>nix.requireSignedBinaryCaches = false</option>. + </para> + </listitem> + <listitem> + <para> + Steam now doesn't need root rights to work. Instead of using + <literal>*-steam-chrootenv</literal>, you should now just run + <literal>steam</literal>. <literal>steamChrootEnv</literal> package was + renamed to <literal>steam</literal>, and old <literal>steam</literal> + package -- to <literal>steamOriginal</literal>. + </para> + </listitem> + <listitem> + <para> + CMPlayer has been renamed to bomi upstream. Package + <literal>cmplayer</literal> was accordingly renamed to + <literal>bomi</literal> + </para> + </listitem> + <listitem> + <para> + Atom Shell has been renamed to Electron upstream. Package + <literal>atom-shell</literal> was accordingly renamed to + <literal>electron</literal> + </para> + </listitem> + <listitem> + <para> + Elm is not released on Hackage anymore. You should now use + <literal>elmPackages.elm</literal> which contains the latest Elm platform. + </para> + </listitem> + <listitem> + <para> + The CUPS printing service has been updated to version + <literal>2.0.2</literal>. Furthermore its systemd service has been renamed + to <literal>cups.service</literal>. + </para> + <para> + Local printers are no longer shared or advertised by default. This + behavior can be changed by enabling + <option>services.printing.defaultShared</option> or + <option>services.printing.browsing</option> respectively. + </para> + </listitem> + <listitem> + <para> + The VirtualBox host and guest options have been named more consistently. + They can now found in <option>virtualisation.virtualbox.host.*</option> + instead of <option>services.virtualboxHost.*</option> and + <option>virtualisation.virtualbox.guest.*</option> instead of + <option>services.virtualboxGuest.*</option>. + </para> + <para> + Also, there now is support for the <literal>vboxsf</literal> file system + using the <option>fileSystems</option> configuration attribute. An example + of how this can be used in a configuration: <programlisting> fileSystems."/shiny" = { device = "myshinysharedfolder"; fsType = "vboxsf"; }; </programlisting> - - </para> -</listitem> - -<listitem> - <para> - "<literal>nix-env -qa</literal>" no longer discovers - Haskell packages by name. The only packages visible in the global - scope are <literal>ghc</literal>, <literal>cabal-install</literal>, - and <literal>stack</literal>, but all other packages are hidden. The - reason for this inconvenience is the sheer size of the Haskell - package set. Name-based lookups are expensive, and most - <literal>nix-env -qa</literal> operations would become much slower - if we'd add the entire Hackage database into the top level attribute - set. Instead, the list of Haskell packages can be displayed by - running: - </para> - <programlisting> + </para> + </listitem> + <listitem> + <para> + "<literal>nix-env -qa</literal>" no longer discovers Haskell + packages by name. The only packages visible in the global scope are + <literal>ghc</literal>, <literal>cabal-install</literal>, and + <literal>stack</literal>, but all other packages are hidden. The reason + for this inconvenience is the sheer size of the Haskell package set. + Name-based lookups are expensive, and most <literal>nix-env -qa</literal> + operations would become much slower if we'd add the entire Hackage + database into the top level attribute set. Instead, the list of Haskell + packages can be displayed by running: + </para> +<programlisting> nix-env -f "<nixpkgs>" -qaP -A haskellPackages </programlisting> - <para> - Executable programs written in Haskell can be installed with: - </para> - <programlisting> + <para> + Executable programs written in Haskell can be installed with: + </para> +<programlisting> nix-env -f "<nixpkgs>" -iA haskellPackages.pandoc </programlisting> - <para> - Installing Haskell <emphasis>libraries</emphasis> this way, however, is no - longer supported. See the next item for more details. - </para> -</listitem> - -<listitem> - <para> - Previous versions of NixOS came with a feature called - <literal>ghc-wrapper</literal>, a small script that allowed GHC to - transparently pick up on libraries installed in the user's profile. This - feature has been deprecated; <literal>ghc-wrapper</literal> was removed - from the distribution. The proper way to register Haskell libraries with - the compiler now is the <literal>haskellPackages.ghcWithPackages</literal> - function. The <link + <para> + Installing Haskell <emphasis>libraries</emphasis> this way, however, is no + longer supported. See the next item for more details. + </para> + </listitem> + <listitem> + <para> + Previous versions of NixOS came with a feature called + <literal>ghc-wrapper</literal>, a small script that allowed GHC to + transparently pick up on libraries installed in the user's profile. This + feature has been deprecated; <literal>ghc-wrapper</literal> was removed + from the distribution. The proper way to register Haskell libraries with + the compiler now is the <literal>haskellPackages.ghcWithPackages</literal> + function. The + <link xlink:href="http://nixos.org/nixpkgs/manual/#users-guide-to-the-haskell-infrastructure">User's - Guide to the Haskell Infrastructure</link> provides more information about - this subject. - </para> -</listitem> - -<listitem> - <para> - All Haskell builds that have been generated with version 1.x of - the <literal>cabal2nix</literal> utility are now invalid and need - to be re-generated with a current version of - <literal>cabal2nix</literal> to function. The most recent version - of this tool can be installed by running - <literal>nix-env -i cabal2nix</literal>. - </para> -</listitem> - -<listitem> - <para> - The <literal>haskellPackages</literal> set in Nixpkgs used to have a - function attribute called <literal>extension</literal> that users - could override in their <literal>~/.nixpkgs/config.nix</literal> - files to configure additional attributes, etc. That function still - exists, but it's now called <literal>overrides</literal>. - </para> -</listitem> - -<listitem> - <para> - The OpenBLAS library has been updated to version - <literal>0.2.14</literal>. Support for the - <literal>x86_64-darwin</literal> platform was added. Dynamic - architecture detection was enabled; OpenBLAS now selects - microarchitecture-optimized routines at runtime, so optimal - performance is achieved without the need to rebuild OpenBLAS - locally. OpenBLAS has replaced ATLAS in most packages which use an - optimized BLAS or LAPACK implementation. - </para> -</listitem> - -<listitem> - <para> - The <literal>phpfpm</literal> is now using the default PHP version - (<literal>pkgs.php</literal>) instead of PHP 5.4 (<literal>pkgs.php54</literal>). - </para> -</listitem> - -<listitem> - <para> - The <literal>locate</literal> service no longer indexes the Nix store - by default, preventing packages with potentially numerous versions from - cluttering the output. Indexing the store can be activated by setting - <option>services.locate.includeStore = true</option>. - </para> -</listitem> - -<listitem> - <para> - The Nix expression search path (<envar>NIX_PATH</envar>) no longer - contains <filename>/etc/nixos/nixpkgs</filename> by default. You - can override <envar>NIX_PATH</envar> by setting - <option>nix.nixPath</option>. - </para> -</listitem> - -<listitem> - <para> - Python 2.6 has been marked as broken (as it no longer receives - security updates from upstream). - </para> -</listitem> - -<listitem> - <para> - Any use of module arguments such as <varname>pkgs</varname> to access - library functions, or to define <literal>imports</literal> attributes - will now lead to an infinite loop at the time of the evaluation. - </para> - - <para> - In case of an infinite loop, use the <command>--show-trace</command> - command line argument and read the line just above the error message. - + Guide to the Haskell Infrastructure</link> provides more information about + this subject. + </para> + </listitem> + <listitem> + <para> + All Haskell builds that have been generated with version 1.x of the + <literal>cabal2nix</literal> utility are now invalid and need to be + re-generated with a current version of <literal>cabal2nix</literal> to + function. The most recent version of this tool can be installed by running + <literal>nix-env -i cabal2nix</literal>. + </para> + </listitem> + <listitem> + <para> + The <literal>haskellPackages</literal> set in Nixpkgs used to have a + function attribute called <literal>extension</literal> that users could + override in their <literal>~/.nixpkgs/config.nix</literal> files to + configure additional attributes, etc. That function still exists, but it's + now called <literal>overrides</literal>. + </para> + </listitem> + <listitem> + <para> + The OpenBLAS library has been updated to version + <literal>0.2.14</literal>. Support for the + <literal>x86_64-darwin</literal> platform was added. Dynamic architecture + detection was enabled; OpenBLAS now selects microarchitecture-optimized + routines at runtime, so optimal performance is achieved without the need + to rebuild OpenBLAS locally. OpenBLAS has replaced ATLAS in most packages + which use an optimized BLAS or LAPACK implementation. + </para> + </listitem> + <listitem> + <para> + The <literal>phpfpm</literal> is now using the default PHP version + (<literal>pkgs.php</literal>) instead of PHP 5.4 + (<literal>pkgs.php54</literal>). + </para> + </listitem> + <listitem> + <para> + The <literal>locate</literal> service no longer indexes the Nix store by + default, preventing packages with potentially numerous versions from + cluttering the output. Indexing the store can be activated by setting + <option>services.locate.includeStore = true</option>. + </para> + </listitem> + <listitem> + <para> + The Nix expression search path (<envar>NIX_PATH</envar>) no longer + contains <filename>/etc/nixos/nixpkgs</filename> by default. You can + override <envar>NIX_PATH</envar> by setting <option>nix.nixPath</option>. + </para> + </listitem> + <listitem> + <para> + Python 2.6 has been marked as broken (as it no longer receives security + updates from upstream). + </para> + </listitem> + <listitem> + <para> + Any use of module arguments such as <varname>pkgs</varname> to access + library functions, or to define <literal>imports</literal> attributes will + now lead to an infinite loop at the time of the evaluation. + </para> + <para> + In case of an infinite loop, use the <command>--show-trace</command> + command line argument and read the line just above the error message. <screen> $ nixos-rebuild build --show-trace … while evaluating the module argument `pkgs' in "/etc/nixos/my-module.nix": infinite recursion encountered </screen> - </para> - - - <para> - Any use of <literal>pkgs.lib</literal>, should be replaced by - <varname>lib</varname>, after adding it as argument of the module. The - following module - + </para> + <para> + Any use of <literal>pkgs.lib</literal>, should be replaced by + <varname>lib</varname>, after adding it as argument of the module. The + following module <programlisting> { config, pkgs, ... }: @@ -384,9 +649,7 @@ with pkgs.lib; config = mkIf config.foo { … }; } </programlisting> - - should be modified to look like: - + should be modified to look like: <programlisting> { config, pkgs, lib, ... }: @@ -399,13 +662,11 @@ with lib; config = mkIf config.foo { <replaceable>option definition</replaceable> }; } </programlisting> - </para> - - <para> - When <varname>pkgs</varname> is used to download other projects to - import their modules, and only in such cases, it should be replaced by - <literal>(import <nixpkgs> {})</literal>. The following module - + </para> + <para> + When <varname>pkgs</varname> is used to download other projects to import + their modules, and only in such cases, it should be replaced by + <literal>(import <nixpkgs> {})</literal>. The following module <programlisting> { config, pkgs, ... }: @@ -420,9 +681,7 @@ in imports = [ "${myProject}/module.nix" ]; } </programlisting> - - should be modified to look like: - + should be modified to look like: <programlisting> { config, pkgs, ... }: @@ -437,55 +696,55 @@ in imports = [ "${myProject}/module.nix" ]; } </programlisting> - </para> - -</listitem> - -</itemizedlist> -</para> - - -<para>Other notable improvements: - -<itemizedlist> - - <listitem><para>The nixos and nixpkgs channels were unified, - so one <emphasis>can</emphasis> use <literal>nix-env -iA nixos.bash</literal> - instead of <literal>nix-env -iA nixos.pkgs.bash</literal>. - See <link xlink:href="https://github.com/NixOS/nixpkgs/commit/2cd7c1f198">the commit</link> for details. - </para></listitem> + </para> + </listitem> + </itemizedlist> + </para> - <listitem> + <para> + Other notable improvements: + <itemizedlist> + <listitem> <para> - Users running an SSH server who worry about the quality of their - <literal>/etc/ssh/moduli</literal> file with respect to the - <link + The nixos and nixpkgs channels were unified, so one + <emphasis>can</emphasis> use <literal>nix-env -iA nixos.bash</literal> + instead of <literal>nix-env -iA nixos.pkgs.bash</literal>. See + <link xlink:href="https://github.com/NixOS/nixpkgs/commit/2cd7c1f198">the + commit</link> for details. + </para> + </listitem> + <listitem> + <para> + Users running an SSH server who worry about the quality of their + <literal>/etc/ssh/moduli</literal> file with respect to the + <link xlink:href="https://stribika.github.io/2015/01/04/secure-secure-shell.html">vulnerabilities - discovered in the Diffie-Hellman key exchange</link> can now - replace OpenSSH's default version with one they generated - themselves using the new - <option>services.openssh.moduliFile</option> option. - </para> - </listitem> - - <listitem> <para> - A newly packaged TeX Live 2015 is provided in <literal>pkgs.texlive</literal>, - split into 6500 nix packages. For basic user documentation see - <link xlink:href="https://github.com/NixOS/nixpkgs/blob/release-15.09/pkgs/tools/typesetting/tex/texlive/default.nix#L1" - >the source</link>. - Beware of <link xlink:href="https://github.com/NixOS/nixpkgs/issues/9757" - >an issue</link> when installing a too large package set. - - The plan is to deprecate and maybe delete the original TeX packages - until the next release. - </para> </listitem> - - <listitem><para> - <option>buildEnv.env</option> on all Python interpreters - is now available for nix-shell interoperability. - </para> </listitem> -</itemizedlist> - -</para> - + discovered in the Diffie-Hellman key exchange</link> can now replace + OpenSSH's default version with one they generated themselves using the new + <option>services.openssh.moduliFile</option> option. + </para> + </listitem> + <listitem> + <para> + A newly packaged TeX Live 2015 is provided in + <literal>pkgs.texlive</literal>, split into 6500 nix packages. For basic + user documentation see + <link xlink:href="https://github.com/NixOS/nixpkgs/blob/release-15.09/pkgs/tools/typesetting/tex/texlive/default.nix#L1" + >the + source</link>. Beware of + <link xlink:href="https://github.com/NixOS/nixpkgs/issues/9757" + >an + issue</link> when installing a too large package set. The plan is to + deprecate and maybe delete the original TeX packages until the next + release. + </para> + </listitem> + <listitem> + <para> + <option>buildEnv.env</option> on all Python interpreters is now available + for nix-shell interoperability. + </para> + </listitem> + </itemizedlist> + </para> </section> diff --git a/nixos/doc/manual/release-notes/rl-1603.xml b/nixos/doc/manual/release-notes/rl-1603.xml index 7279dd058270..9b512c4b1e58 100644 --- a/nixos/doc/manual/release-notes/rl-1603.xml +++ b/nixos/doc/manual/release-notes/rl-1603.xml @@ -3,250 +3,471 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-release-16.03"> + <title>Release 16.03 (“Emu”, 2016/03/31)</title> -<title>Release 16.03 (“Emu”, 2016/03/31)</title> - -<para>In addition to numerous new and upgraded packages, this release -has the following highlights:</para> - -<itemizedlist> + <para> + In addition to numerous new and upgraded packages, this release has the + following highlights: + </para> + <itemizedlist> <listitem> - <para>Systemd 229, bringing <link + <para> + Systemd 229, bringing + <link xlink:href="https://github.com/systemd/systemd/blob/v229/NEWS">numerous - improvements</link> over 217.</para> + improvements</link> over 217. + </para> </listitem> - <listitem> - <para>Linux 4.4 (was 3.18).</para> + <para> + Linux 4.4 (was 3.18). + </para> </listitem> - <listitem> - <para>GCC 5.3 (was 4.9). Note that GCC 5 <link + <para> + GCC 5.3 (was 4.9). Note that GCC 5 + <link xlink:href="https://gcc.gnu.org/onlinedocs/libstdc++/manual/using_dual_abi.html">changes - the C++ ABI in an incompatible way</link>; this may cause problems - if you try to link objects compiled with different versions of - GCC.</para> + the C++ ABI in an incompatible way</link>; this may cause problems if you + try to link objects compiled with different versions of GCC. + </para> </listitem> - <listitem> - <para>Glibc 2.23 (was 2.21).</para> + <para> + Glibc 2.23 (was 2.21). + </para> </listitem> - <listitem> - <para>Binutils 2.26 (was 2.23.1). See #909</para> + <para> + Binutils 2.26 (was 2.23.1). See #909 + </para> </listitem> - <listitem> - <para>Improved support for ensuring <link - xlink:href="https://reproducible-builds.org/">bitwise reproducible - builds</link>. For example, <literal>stdenv</literal> now sets the - environment variable <envar + <para> + Improved support for ensuring + <link + xlink:href="https://reproducible-builds.org/">bitwise + reproducible builds</link>. For example, <literal>stdenv</literal> now sets + the environment variable + <envar xlink:href="https://reproducible-builds.org/specs/source-date-epoch/">SOURCE_DATE_EPOCH</envar> - to a deterministic value, and Nix has <link + to a deterministic value, and Nix has + <link xlink:href="http://nixos.org/nix/manual/#ssec-relnotes-1.11">gained - an option</link> to repeat a build a number of times to test - determinism. An ongoing project, the goal of exact reproducibility - is to allow binaries to be verified independently (e.g., a user - might only trust binaries that appear in three independent binary - caches).</para> + an option</link> to repeat a build a number of times to test determinism. + An ongoing project, the goal of exact reproducibility is to allow binaries + to be verified independently (e.g., a user might only trust binaries that + appear in three independent binary caches). + </para> </listitem> - <listitem> - <para>Perl 5.22.</para> + <para> + Perl 5.22. + </para> </listitem> + </itemizedlist> -</itemizedlist> - -<para>The following new services were added since the last release: - + <para> + The following new services were added since the last release: <itemizedlist> - <listitem><para><literal>services/monitoring/longview.nix</literal></para></listitem> - <listitem><para><literal>hardware/video/webcam/facetimehd.nix</literal></para></listitem> - <listitem><para><literal>i18n/input-method/default.nix</literal></para></listitem> - <listitem><para><literal>i18n/input-method/fcitx.nix</literal></para></listitem> - <listitem><para><literal>i18n/input-method/ibus.nix</literal></para></listitem> - <listitem><para><literal>i18n/input-method/nabi.nix</literal></para></listitem> - <listitem><para><literal>i18n/input-method/uim.nix</literal></para></listitem> - <listitem><para><literal>programs/fish.nix</literal></para></listitem> - <listitem><para><literal>security/acme.nix</literal></para></listitem> - <listitem><para><literal>security/audit.nix</literal></para></listitem> - <listitem><para><literal>security/oath.nix</literal></para></listitem> - <listitem><para><literal>services/hardware/irqbalance.nix</literal></para></listitem> - <listitem><para><literal>services/mail/dspam.nix</literal></para></listitem> - <listitem><para><literal>services/mail/opendkim.nix</literal></para></listitem> - <listitem><para><literal>services/mail/postsrsd.nix</literal></para></listitem> - <listitem><para><literal>services/mail/rspamd.nix</literal></para></listitem> - <listitem><para><literal>services/mail/rmilter.nix</literal></para></listitem> - <listitem><para><literal>services/misc/autofs.nix</literal></para></listitem> - <listitem><para><literal>services/misc/bepasty.nix</literal></para></listitem> - <listitem><para><literal>services/misc/calibre-server.nix</literal></para></listitem> - <listitem><para><literal>services/misc/cfdyndns.nix</literal></para></listitem> - <listitem><para><literal>services/misc/gammu-smsd.nix</literal></para></listitem> - <listitem><para><literal>services/misc/mathics.nix</literal></para></listitem> - <listitem><para><literal>services/misc/matrix-synapse.nix</literal></para></listitem> - <listitem><para><literal>services/misc/octoprint.nix</literal></para></listitem> - <listitem><para><literal>services/monitoring/hdaps.nix</literal></para></listitem> - <listitem><para><literal>services/monitoring/heapster.nix</literal></para></listitem> - <listitem><para><literal>services/monitoring/longview.nix</literal></para></listitem> - <listitem><para><literal>services/network-filesystems/netatalk.nix</literal></para></listitem> - <listitem><para><literal>services/network-filesystems/xtreemfs.nix</literal></para></listitem> - <listitem><para><literal>services/networking/autossh.nix</literal></para></listitem> - <listitem><para><literal>services/networking/dnschain.nix</literal></para></listitem> - <listitem><para><literal>services/networking/gale.nix</literal></para></listitem> - <listitem><para><literal>services/networking/miniupnpd.nix</literal></para></listitem> - <listitem><para><literal>services/networking/namecoind.nix</literal></para></listitem> - <listitem><para><literal>services/networking/ostinato.nix</literal></para></listitem> - <listitem><para><literal>services/networking/pdnsd.nix</literal></para></listitem> - <listitem><para><literal>services/networking/shairport-sync.nix</literal></para></listitem> - <listitem><para><literal>services/networking/supplicant.nix</literal></para></listitem> - <listitem><para><literal>services/search/kibana.nix</literal></para></listitem> - <listitem><para><literal>services/security/haka.nix</literal></para></listitem> - <listitem><para><literal>services/security/physlock.nix</literal></para></listitem> - <listitem><para><literal>services/web-apps/pump.io.nix</literal></para></listitem> - <listitem><para><literal>services/x11/hardware/libinput.nix</literal></para></listitem> - <listitem><para><literal>services/x11/window-managers/windowlab.nix</literal></para></listitem> - <listitem><para><literal>system/boot/initrd-network.nix</literal></para></listitem> - <listitem><para><literal>system/boot/initrd-ssh.nix</literal></para></listitem> - <listitem><para><literal>system/boot/loader/loader.nix</literal></para></listitem> - <listitem><para><literal>system/boot/networkd.nix</literal></para></listitem> - <listitem><para><literal>system/boot/resolved.nix</literal></para></listitem> - <listitem><para><literal>virtualisation/lxd.nix</literal></para></listitem> - <listitem><para><literal>virtualisation/rkt.nix</literal></para></listitem> + <listitem> + <para> + <literal>services/monitoring/longview.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>hardware/video/webcam/facetimehd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>i18n/input-method/default.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>i18n/input-method/fcitx.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>i18n/input-method/ibus.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>i18n/input-method/nabi.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>i18n/input-method/uim.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>programs/fish.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>security/acme.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>security/audit.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>security/oath.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/hardware/irqbalance.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/mail/dspam.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/mail/opendkim.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/mail/postsrsd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/mail/rspamd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/mail/rmilter.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/autofs.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/bepasty.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/calibre-server.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/cfdyndns.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/gammu-smsd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/mathics.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/matrix-synapse.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/octoprint.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/hdaps.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/heapster.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/longview.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/network-filesystems/netatalk.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/network-filesystems/xtreemfs.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/autossh.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/dnschain.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/gale.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/miniupnpd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/namecoind.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/ostinato.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/pdnsd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/shairport-sync.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/supplicant.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/search/kibana.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/security/haka.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/security/physlock.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/web-apps/pump.io.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/x11/hardware/libinput.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/x11/window-managers/windowlab.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>system/boot/initrd-network.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>system/boot/initrd-ssh.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>system/boot/loader/loader.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>system/boot/networkd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>system/boot/resolved.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>virtualisation/lxd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>virtualisation/rkt.nix</literal> + </para> + </listitem> </itemizedlist> -</para> - -<para>When upgrading from a previous release, please be aware of the -following incompatible changes:</para> + </para> -<itemizedlist> + <para> + When upgrading from a previous release, please be aware of the following + incompatible changes: + </para> + <itemizedlist> <listitem> - <para>We no longer produce graphical ISO images and VirtualBox - images for <literal>i686-linux</literal>. A minimal ISO image is - still provided.</para> + <para> + We no longer produce graphical ISO images and VirtualBox images for + <literal>i686-linux</literal>. A minimal ISO image is still provided. + </para> </listitem> - <listitem> - <para>Firefox and similar browsers are now <emphasis>wrapped by default</emphasis>. - The package and attribute names are plain <literal>firefox</literal> - or <literal>midori</literal>, etc. Backward-compatibility attributes were set up, - but note that <command>nix-env -u</command> will <emphasis>not</emphasis> update - your current <literal>firefox-with-plugins</literal>; - you have to uninstall it and install <literal>firefox</literal> instead.</para> + <para> + Firefox and similar browsers are now <emphasis>wrapped by + default</emphasis>. The package and attribute names are plain + <literal>firefox</literal> or <literal>midori</literal>, etc. + Backward-compatibility attributes were set up, but note that + <command>nix-env -u</command> will <emphasis>not</emphasis> update your + current <literal>firefox-with-plugins</literal>; you have to uninstall it + and install <literal>firefox</literal> instead. + </para> </listitem> - <listitem> - <para><command>wmiiSnap</command> has been replaced with + <para> + <command>wmiiSnap</command> has been replaced with <command>wmii_hg</command>, but - <command>services.xserver.windowManager.wmii.enable</command> has - been updated respectively so this only affects you if you have - explicitly installed <command>wmiiSnap</command>. - </para> + <command>services.xserver.windowManager.wmii.enable</command> has been + updated respectively so this only affects you if you have explicitly + installed <command>wmiiSnap</command>. + </para> </listitem> - <listitem> - <para><literal>jobs</literal> NixOS option has been removed. It served as + <para> + <literal>jobs</literal> NixOS option has been removed. It served as compatibility layer between Upstart jobs and SystemD services. All services - have been rewritten to use <literal>systemd.services</literal></para> + have been rewritten to use <literal>systemd.services</literal> + </para> </listitem> - <listitem> - <para><command>wmiimenu</command> is removed, as it has been - removed by the developers upstream. Use <command>wimenu</command> - from the <command>wmii-hg</command> package.</para> + <para> + <command>wmiimenu</command> is removed, as it has been removed by the + developers upstream. Use <command>wimenu</command> from the + <command>wmii-hg</command> package. + </para> </listitem> - <listitem> - <para>Gitit is no longer automatically added to the module list in - NixOS and as such there will not be any manual entries for it. You - will need to add an import statement to your NixOS configuration - in order to use it, e.g. - + <para> + Gitit is no longer automatically added to the module list in NixOS and as + such there will not be any manual entries for it. You will need to add an + import statement to your NixOS configuration in order to use it, e.g. <programlisting><![CDATA[ { imports = [ <nixpkgs/nixos/modules/services/misc/gitit.nix> ]; } ]]></programlisting> - - will include the Gitit service configuration options.</para> + will include the Gitit service configuration options. + </para> </listitem> - <listitem> - <para><command>nginx</command> does not accept flags for enabling and - disabling modules anymore. Instead it accepts <literal>modules</literal> - argument, which is a list of modules to be built in. All modules now - reside in <literal>nginxModules</literal> set. Example configuration: - + <para> + <command>nginx</command> does not accept flags for enabling and disabling + modules anymore. Instead it accepts <literal>modules</literal> argument, + which is a list of modules to be built in. All modules now reside in + <literal>nginxModules</literal> set. Example configuration: <programlisting><![CDATA[ nginx.override { modules = [ nginxModules.rtmp nginxModules.dav nginxModules.moreheaders ]; } ]]></programlisting> - </para> + </para> </listitem> - <listitem> - <para><command>s3sync</command> is removed, as it hasn't been - developed by upstream for 4 years and only runs with ruby 1.8. - For an actively-developer alternative look at - <command>tarsnap</command> and others. - </para> + <para> + <command>s3sync</command> is removed, as it hasn't been developed by + upstream for 4 years and only runs with ruby 1.8. For an actively-developer + alternative look at <command>tarsnap</command> and others. + </para> </listitem> - <listitem> - <para><command>ruby_1_8</command> has been removed as it's not - supported from upstream anymore and probably contains security - issues. - </para> + <para> + <command>ruby_1_8</command> has been removed as it's not supported from + upstream anymore and probably contains security issues. + </para> </listitem> - <listitem> - <para><literal>tidy-html5</literal> package is removed. - Upstream only provided <literal>(lib)tidy5</literal> during development, - and now they went back to <literal>(lib)tidy</literal> to work as a drop-in - replacement of the original package that has been unmaintained for years. - You can (still) use the <literal>html-tidy</literal> package, which got updated - to a stable release from this new upstream.</para> + <para> + <literal>tidy-html5</literal> package is removed. Upstream only provided + <literal>(lib)tidy5</literal> during development, and now they went back to + <literal>(lib)tidy</literal> to work as a drop-in replacement of the + original package that has been unmaintained for years. You can (still) use + the <literal>html-tidy</literal> package, which got updated to a stable + release from this new upstream. + </para> </listitem> - <listitem> - <para><literal>extraDeviceOptions</literal> argument is removed - from <literal>bumblebee</literal> package. Instead there are - now two separate arguments: <literal>extraNvidiaDeviceOptions</literal> - and <literal>extraNouveauDeviceOptions</literal> for setting - extra X11 options for nvidia and nouveau drivers, respectively. - </para> + <para> + <literal>extraDeviceOptions</literal> argument is removed from + <literal>bumblebee</literal> package. Instead there are now two separate + arguments: <literal>extraNvidiaDeviceOptions</literal> and + <literal>extraNouveauDeviceOptions</literal> for setting extra X11 options + for nvidia and nouveau drivers, respectively. + </para> </listitem> - <listitem> - <para>The <literal>Ctrl+Alt+Backspace</literal> key combination - no longer kills the X server by default. - There's a new option <option>services.xserver.enableCtrlAltBackspace</option> - allowing to enable the combination again. - </para> + <para> + The <literal>Ctrl+Alt+Backspace</literal> key combination no longer kills + the X server by default. There's a new option + <option>services.xserver.enableCtrlAltBackspace</option> allowing to enable + the combination again. + </para> </listitem> - <listitem> - <para><literal>emacsPackagesNg</literal> now contains all packages - from the ELPA, MELPA, and MELPA Stable repositories. - </para> + <para> + <literal>emacsPackagesNg</literal> now contains all packages from the ELPA, + MELPA, and MELPA Stable repositories. + </para> </listitem> - <listitem> - <para>Data directory for Postfix MTA server is moved from + <para> + Data directory for Postfix MTA server is moved from <filename>/var/postfix</filename> to <filename>/var/lib/postfix</filename>. - Old configurations are migrated automatically. <literal>service.postfix</literal> - module has also received many improvements, such as correct directories' access - rights, new <literal>aliasFiles</literal> and <literal>mapFiles</literal> - options and more.</para> + Old configurations are migrated automatically. + <literal>service.postfix</literal> module has also received many + improvements, such as correct directories' access rights, new + <literal>aliasFiles</literal> and <literal>mapFiles</literal> options and + more. + </para> </listitem> - <listitem> - <para>Filesystem options should now be configured as a list of strings, not - a comma-separated string. The old style will continue to work, but print a + <para> + Filesystem options should now be configured as a list of strings, not a + comma-separated string. The old style will continue to work, but print a warning, until the 16.09 release. An example of the new style: - <programlisting> fileSystems."/example" = { device = "/dev/sdc"; @@ -254,103 +475,103 @@ fileSystems."/example" = { options = [ "noatime" "compress=lzo" "space_cache" "autodefrag" ]; }; </programlisting> - </para> + </para> </listitem> - <listitem> - <para>CUPS, installed by <literal>services.printing</literal> module, now - has its data directory in <filename>/var/lib/cups</filename>. Old - configurations from <filename>/etc/cups</filename> are moved there - automatically, but there might be problems. Also configuration options + <para> + CUPS, installed by <literal>services.printing</literal> module, now has its + data directory in <filename>/var/lib/cups</filename>. Old configurations + from <filename>/etc/cups</filename> are moved there automatically, but + there might be problems. Also configuration options <literal>services.printing.cupsdConf</literal> and - <literal>services.printing.cupsdFilesConf</literal> were removed - because they had been allowing one to override configuration variables - required for CUPS to work at all on NixOS. For most use cases, + <literal>services.printing.cupsdFilesConf</literal> were removed because + they had been allowing one to override configuration variables required for + CUPS to work at all on NixOS. For most use cases, <literal>services.printing.extraConf</literal> and new option - <literal>services.printing.extraFilesConf</literal> should be enough; - if you encounter a situation when they are not, please file a bug.</para> - - <para>There are also Gutenprint improvements; in particular, a new option - <literal>services.printing.gutenprint</literal> is added to enable automatic - updating of Gutenprint PPMs; it's greatly recommended to enable it instead - of adding <literal>gutenprint</literal> to the <literal>drivers</literal> list. - </para> - </listitem> - - <listitem> - <para><literal>services.xserver.vaapiDrivers</literal> has been removed. Use - <literal>hardware.opengl.extraPackages{,32}</literal> instead. You can - also specify VDPAU drivers there.</para> - </listitem> - - <listitem> - <para> - <literal>programs.ibus</literal> moved to <literal>i18n.inputMethod.ibus</literal>. - The option <literal>programs.ibus.plugins</literal> changed to <literal>i18n.inputMethod.ibus.engines</literal> - and the option to enable ibus changed from <literal>programs.ibus.enable</literal> to + <literal>services.printing.extraFilesConf</literal> should be enough; if + you encounter a situation when they are not, please file a bug. + </para> + <para> + There are also Gutenprint improvements; in particular, a new option + <literal>services.printing.gutenprint</literal> is added to enable + automatic updating of Gutenprint PPMs; it's greatly recommended to enable + it instead of adding <literal>gutenprint</literal> to the + <literal>drivers</literal> list. + </para> + </listitem> + <listitem> + <para> + <literal>services.xserver.vaapiDrivers</literal> has been removed. Use + <literal>hardware.opengl.extraPackages{,32}</literal> instead. You can also + specify VDPAU drivers there. + </para> + </listitem> + <listitem> + <para> + <literal>programs.ibus</literal> moved to + <literal>i18n.inputMethod.ibus</literal>. The option + <literal>programs.ibus.plugins</literal> changed to + <literal>i18n.inputMethod.ibus.engines</literal> and the option to enable + ibus changed from <literal>programs.ibus.enable</literal> to <literal>i18n.inputMethod.enabled</literal>. - <literal>i18n.inputMethod.enabled</literal> should be set to the used input method name, - <literal>"ibus"</literal> for ibus. - An example of the new style: - + <literal>i18n.inputMethod.enabled</literal> should be set to the used input + method name, <literal>"ibus"</literal> for ibus. An example of the new + style: <programlisting> i18n.inputMethod.enabled = "ibus"; i18n.inputMethod.ibus.engines = with pkgs.ibus-engines; [ anthy mozc ]; </programlisting> - -That is equivalent to the old version: - + That is equivalent to the old version: <programlisting> programs.ibus.enable = true; programs.ibus.plugins = with pkgs; [ ibus-anthy mozc ]; </programlisting> - - </para> + </para> </listitem> - <listitem> - <para><literal>services.udev.extraRules</literal> option now writes rules - to <filename>99-local.rules</filename> instead of <filename>10-local.rules</filename>. - This makes all the user rules apply after others, so their results wouldn't be - overriden by anything else.</para> + <para> + <literal>services.udev.extraRules</literal> option now writes rules to + <filename>99-local.rules</filename> instead of + <filename>10-local.rules</filename>. This makes all the user rules apply + after others, so their results wouldn't be overriden by anything else. + </para> </listitem> - <listitem> - <para>Large parts of the <literal>services.gitlab</literal> module has been - been rewritten. There are new configuration options available. The + <para> + Large parts of the <literal>services.gitlab</literal> module has been been + rewritten. There are new configuration options available. The <literal>stateDir</literal> option was renamned to - <literal>statePath</literal> and the <literal>satellitesDir</literal> option - was removed. Please review the currently available options.</para> + <literal>statePath</literal> and the <literal>satellitesDir</literal> + option was removed. Please review the currently available options. + </para> </listitem> - <listitem> - <para> - The option <option>services.nsd.zones.<name>.data</option> no - longer interpret the dollar sign ($) as a shell variable, as such it - should not be escaped anymore. Thus the following zone data: - </para> - <programlisting> + <para> + The option <option>services.nsd.zones.<name>.data</option> no longer + interpret the dollar sign ($) as a shell variable, as such it should not be + escaped anymore. Thus the following zone data: + </para> +<programlisting> \$ORIGIN example.com. \$TTL 1800 @ IN SOA ns1.vpn.nbp.name. admin.example.com. ( </programlisting> - <para> + <para> Should modified to look like the actual file expected by nsd: - </para> - <programlisting> + </para> +<programlisting> $ORIGIN example.com. $TTL 1800 @ IN SOA ns1.vpn.nbp.name. admin.example.com. ( </programlisting> </listitem> - <listitem> - <para> - <literal>service.syncthing.dataDir</literal> options now has to point - to exact folder where syncthing is writing to. Example configuration should + <para> + <literal>service.syncthing.dataDir</literal> options now has to point to + exact folder where syncthing is writing to. Example configuration should look something like: - </para> - <programlisting> + </para> +<programlisting> services.syncthing = { enable = true; dataDir = "/home/somebody/.syncthing"; @@ -358,76 +579,73 @@ services.syncthing = { }; </programlisting> </listitem> - - <listitem> - <para> - <literal>networking.firewall.allowPing</literal> is now enabled by - default. Users are encouraged to configure an appropriate rate limit for - their machines using the Kernel interface at - <filename>/proc/sys/net/ipv4/icmp_ratelimit</filename> and - <filename>/proc/sys/net/ipv6/icmp/ratelimit</filename> or using the - firewall itself, i.e. by setting the NixOS option - <literal>networking.firewall.pingLimit</literal>. - </para> - </listitem> - - <listitem> - <para> - Systems with some broadcom cards used to result into a generated config - that is no longer accepted. If you get errors like - <screen>error: path ‘/nix/store/*-broadcom-sta-*’ does not exist and cannot be created</screen> - you should either re-run <command>nixos-generate-config</command> or manually replace - <literal>"${config.boot.kernelPackages.broadcom_sta}"</literal> - by - <literal>config.boot.kernelPackages.broadcom_sta</literal> - in your <filename>/etc/nixos/hardware-configuration.nix</filename>. - More discussion is on <link xlink:href="https://github.com/NixOS/nixpkgs/pull/12595"> - the github issue</link>. - </para> - </listitem> - <listitem> - <para> - The <literal>services.xserver.startGnuPGAgent</literal> option has been removed. - GnuPG 2.1.x changed the way the gpg-agent works, and that new approach no - longer requires (or even supports) the "start everything as a child of the - agent" scheme we've implemented in NixOS for older versions. - To configure the gpg-agent for your X session, add the following code to - <filename>~/.bashrc</filename> or some file that’s sourced when your shell is started: - <programlisting> + <para> + <literal>networking.firewall.allowPing</literal> is now enabled by default. + Users are encouraged to configure an appropriate rate limit for their + machines using the Kernel interface at + <filename>/proc/sys/net/ipv4/icmp_ratelimit</filename> and + <filename>/proc/sys/net/ipv6/icmp/ratelimit</filename> or using the + firewall itself, i.e. by setting the NixOS option + <literal>networking.firewall.pingLimit</literal>. + </para> + </listitem> + <listitem> + <para> + Systems with some broadcom cards used to result into a generated config + that is no longer accepted. If you get errors like +<screen>error: path ‘/nix/store/*-broadcom-sta-*’ does not exist and cannot be created</screen> + you should either re-run <command>nixos-generate-config</command> or + manually replace + <literal>"${config.boot.kernelPackages.broadcom_sta}"</literal> by + <literal>config.boot.kernelPackages.broadcom_sta</literal> in your + <filename>/etc/nixos/hardware-configuration.nix</filename>. More discussion + is on <link xlink:href="https://github.com/NixOS/nixpkgs/pull/12595"> the + github issue</link>. + </para> + </listitem> + <listitem> + <para> + The <literal>services.xserver.startGnuPGAgent</literal> option has been + removed. GnuPG 2.1.x changed the way the gpg-agent works, and that new + approach no longer requires (or even supports) the "start everything as a + child of the agent" scheme we've implemented in NixOS for older versions. + To configure the gpg-agent for your X session, add the following code to + <filename>~/.bashrc</filename> or some file that’s sourced when your + shell is started: +<programlisting> GPG_TTY=$(tty) export GPG_TTY </programlisting> - If you want to use gpg-agent for SSH, too, add the following to your session - initialization (e.g. <literal>displayManager.sessionCommands</literal>) - <programlisting> + If you want to use gpg-agent for SSH, too, add the following to your + session initialization (e.g. + <literal>displayManager.sessionCommands</literal>) +<programlisting> gpg-connect-agent /bye unset SSH_AGENT_PID export SSH_AUTH_SOCK="''${HOME}/.gnupg/S.gpg-agent.ssh" </programlisting> - and make sure that - <programlisting> + and make sure that +<programlisting> enable-ssh-support </programlisting> - is included in your <filename>~/.gnupg/gpg-agent.conf</filename>. - You will need to use <command>ssh-add</command> to re-add your ssh keys. - If gpg’s automatic transformation of the private keys to the new format fails, - you will need to re-import your private keyring as well: - <programlisting> + is included in your <filename>~/.gnupg/gpg-agent.conf</filename>. You will + need to use <command>ssh-add</command> to re-add your ssh keys. If gpg’s + automatic transformation of the private keys to the new format fails, you + will need to re-import your private keyring as well: +<programlisting> gpg --import ~/.gnupg/secring.gpg </programlisting> - The <command>gpg-agent(1)</command> man page has more details about this subject, - i.e. in the "EXAMPLES" section. - </para> + The <command>gpg-agent(1)</command> man page has more details about this + subject, i.e. in the "EXAMPLES" section. + </para> </listitem> -</itemizedlist> - - -<para>Other notable improvements: + </itemizedlist> -<itemizedlist> - - <!-- + <para> + Other notable improvements: + <itemizedlist> +<!-- <listitem> <para>The <command>command-not-found</command> hook was extended. Apart from <literal>$NIX_AUTO_INSTALL</literal> variable, @@ -436,18 +654,18 @@ gpg --import ~/.gnupg/secring.gpg <command>nix-shell</command> (without installing anything).</para> </listitem> --> - - <listitem> - <para><literal>ejabberd</literal> module is brought back and now works on - NixOS.</para> - </listitem> - - <listitem> - <para>Input method support was improved. New NixOS modules (fcitx, nabi and uim), - fcitx engines (chewing, hangul, m17n, mozc and table-other) and ibus engines (hangul and m17n) - have been added.</para> - </listitem> - -</itemizedlist></para> - + <listitem> + <para> + <literal>ejabberd</literal> module is brought back and now works on NixOS. + </para> + </listitem> + <listitem> + <para> + Input method support was improved. New NixOS modules (fcitx, nabi and + uim), fcitx engines (chewing, hangul, m17n, mozc and table-other) and ibus + engines (hangul and m17n) have been added. + </para> + </listitem> + </itemizedlist> + </para> </section> diff --git a/nixos/doc/manual/release-notes/rl-1609.xml b/nixos/doc/manual/release-notes/rl-1609.xml index 893f894f42fe..4a2343edc970 100644 --- a/nixos/doc/manual/release-notes/rl-1609.xml +++ b/nixos/doc/manual/release-notes/rl-1609.xml @@ -3,237 +3,275 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-release-16.09"> + <title>Release 16.09 (“Flounder”, 2016/09/30)</title> -<title>Release 16.09 (“Flounder”, 2016/09/30)</title> - -<para>In addition to numerous new and upgraded packages, this release -has the following highlights: </para> - -<itemizedlist> + <para> + In addition to numerous new and upgraded packages, this release has the + following highlights: + </para> + <itemizedlist> <listitem> - <para>Many NixOS configurations and Nix packages now use - significantly less disk space, thanks to the <link + <para> + Many NixOS configurations and Nix packages now use significantly less disk + space, thanks to the + <link xlink:href="https://github.com/NixOS/nixpkgs/issues/7117">extensive - work on closure size reduction</link>. For example, the closure - size of a minimal NixOS container went down from ~424 MiB in 16.03 - to ~212 MiB in 16.09, while the closure size of Firefox went from - ~651 MiB to ~259 MiB.</para> + work on closure size reduction</link>. For example, the closure size of a + minimal NixOS container went down from ~424 MiB in 16.03 to ~212 MiB in + 16.09, while the closure size of Firefox went from ~651 MiB to ~259 MiB. + </para> </listitem> - <listitem> - <para>To improve security, packages are now <link + <para> + To improve security, packages are now + <link xlink:href="https://github.com/NixOS/nixpkgs/pull/12895">built - using various hardening features</link>. See the Nixpkgs manual - for more information.</para> + using various hardening features</link>. See the Nixpkgs manual for more + information. + </para> </listitem> - <listitem> - <para>Support for PXE netboot. See <xref - linkend="sec-booting-from-pxe" /> for documentation.</para> + <para> + Support for PXE netboot. See <xref + linkend="sec-booting-from-pxe" /> + for documentation. + </para> </listitem> - <listitem> - <para>X.org server 1.18. If you use the - <literal>ati_unfree</literal> driver, 1.17 is still used due to an - ABI incompatibility.</para> + <para> + X.org server 1.18. If you use the <literal>ati_unfree</literal> driver, + 1.17 is still used due to an ABI incompatibility. + </para> </listitem> - <listitem> - <para>This release is based on Glibc 2.24, GCC 5.4.0 and systemd - 231. The default Linux kernel remains 4.4.</para> + <para> + This release is based on Glibc 2.24, GCC 5.4.0 and systemd 231. The default + Linux kernel remains 4.4. + </para> </listitem> + </itemizedlist> -</itemizedlist> - -<para>The following new services were added since the last release:</para> + <para> + The following new services were added since the last release: + </para> -<itemizedlist> - <listitem><para><literal>(this will get automatically generated at release time)</literal></para></listitem> -</itemizedlist> - -<para>When upgrading from a previous release, please be aware of the -following incompatible changes:</para> + <itemizedlist> + <listitem> + <para> + <literal>(this will get automatically generated at release time)</literal> + </para> + </listitem> + </itemizedlist> -<itemizedlist> + <para> + When upgrading from a previous release, please be aware of the following + incompatible changes: + </para> + <itemizedlist> <listitem> - <para>A large number of packages have been converted to use the multiple outputs feature - of Nix to greatly reduce the amount of required disk space, as - mentioned above. This may require changes - to any custom packages to make them build again; see the relevant chapter in the - Nixpkgs manual for more information. (Additional caveat to packagers: some packaging conventions - related to multiple-output packages - <link xlink:href="https://github.com/NixOS/nixpkgs/pull/14766">were changed</link> - late (August 2016) in the release cycle and differ from the initial introduction of multiple outputs.) - </para> + <para> + A large number of packages have been converted to use the multiple outputs + feature of Nix to greatly reduce the amount of required disk space, as + mentioned above. This may require changes to any custom packages to make + them build again; see the relevant chapter in the Nixpkgs manual for more + information. (Additional caveat to packagers: some packaging conventions + related to multiple-output packages + <link xlink:href="https://github.com/NixOS/nixpkgs/pull/14766">were + changed</link> late (August 2016) in the release cycle and differ from the + initial introduction of multiple outputs.) + </para> </listitem> - <listitem> - <para>Previous versions of Nixpkgs had support for all versions of the LTS + <para> + Previous versions of Nixpkgs had support for all versions of the LTS Haskell package set. That support has been dropped. The previously provided <literal>haskell.packages.lts-x_y</literal> package sets still exist in name to aviod breaking user code, but these package sets don't actually contain the versions mandated by the corresponding LTS release. Instead, our package set it loosely based on the latest available LTS release, i.e. LTS 7.x at the time of this writing. New releases of NixOS and Nixpkgs will - drop those old names entirely. <link + drop those old names entirely. + <link xlink:href="https://nixos.org/nix-dev/2016-June/020585.html">The motivation for this change</link> has been discussed at length on the - <literal>nix-dev</literal> mailing list and in <link - xlink:href="https://github.com/NixOS/nixpkgs/issues/14897">Github issue - #14897</link>. Development strategies for Haskell hackers who want to rely - on Nix and NixOS have been described in <link + <literal>nix-dev</literal> mailing list and in + <link + xlink:href="https://github.com/NixOS/nixpkgs/issues/14897">Github + issue #14897</link>. Development strategies for Haskell hackers who want to + rely on Nix and NixOS have been described in + <link xlink:href="https://nixos.org/nix-dev/2016-June/020642.html">another - nix-dev article</link>.</para> + nix-dev article</link>. + </para> </listitem> - <listitem> - <para>Shell aliases for systemd sub-commands - <link xlink:href="https://github.com/NixOS/nixpkgs/pull/15598">were dropped</link>: - <command>start</command>, <command>stop</command>, - <command>restart</command>, <command>status</command>.</para> + <para> + Shell aliases for systemd sub-commands + <link xlink:href="https://github.com/NixOS/nixpkgs/pull/15598">were + dropped</link>: <command>start</command>, <command>stop</command>, + <command>restart</command>, <command>status</command>. + </para> </listitem> - <listitem> - <para>Redis now binds to 127.0.0.1 only instead of listening to all network interfaces. This is the default - behavior of Redis 3.2</para> + <para> + Redis now binds to 127.0.0.1 only instead of listening to all network + interfaces. This is the default behavior of Redis 3.2 + </para> </listitem> - <listitem> - <para> - <literal>/var/empty</literal> is now immutable. Activation script runs <command>chattr +i</command> - to forbid any modifications inside the folder. See <link xlink:href="https://github.com/NixOS/nixpkgs/pull/18365"> - the pull request</link> for what bugs this caused. - </para> + <para> + <literal>/var/empty</literal> is now immutable. Activation script runs + <command>chattr +i</command> to forbid any modifications inside the folder. + See <link xlink:href="https://github.com/NixOS/nixpkgs/pull/18365"> the + pull request</link> for what bugs this caused. + </para> </listitem> - <listitem> - <para>Gitlab's maintainance script - <command>gitlab-runner</command> was removed and split up into the - more clearer <command>gitlab-run</command> and + <para> + Gitlab's maintainance script <command>gitlab-runner</command> was removed + and split up into the more clearer <command>gitlab-run</command> and <command>gitlab-rake</command> scripts, because - <command>gitlab-runner</command> is a component of Gitlab - CI.</para> + <command>gitlab-runner</command> is a component of Gitlab CI. + </para> </listitem> - <listitem> - <para><literal>services.xserver.libinput.accelProfile</literal> default - changed from <literal>flat</literal> to <literal>adaptive</literal>, - as per <link xlink:href="https://wayland.freedesktop.org/libinput/doc/latest/group__config.html#gad63796972347f318b180e322e35cee79"> - official documentation</link>.</para> + <para> + <literal>services.xserver.libinput.accelProfile</literal> default changed + from <literal>flat</literal> to <literal>adaptive</literal>, as per + <link xlink:href="https://wayland.freedesktop.org/libinput/doc/latest/group__config.html#gad63796972347f318b180e322e35cee79"> + official documentation</link>. + </para> </listitem> - <listitem> - <para><literal>fonts.fontconfig.ultimate.rendering</literal> was removed - because our presets were obsolete for some time. New presets are hardcoded - into FreeType; you can select a preset via <literal>fonts.fontconfig.ultimate.preset</literal>. - You can customize those presets via ordinary environment variables, using - <literal>environment.variables</literal>.</para> + <para> + <literal>fonts.fontconfig.ultimate.rendering</literal> was removed because + our presets were obsolete for some time. New presets are hardcoded into + FreeType; you can select a preset via + <literal>fonts.fontconfig.ultimate.preset</literal>. You can customize + those presets via ordinary environment variables, using + <literal>environment.variables</literal>. + </para> </listitem> - <listitem> - <para>The <literal>audit</literal> service is no longer enabled by default. - Use <literal>security.audit.enable = true</literal> to explicitly enable it.</para> + <para> + The <literal>audit</literal> service is no longer enabled by default. Use + <literal>security.audit.enable = true</literal> to explicitly enable it. + </para> </listitem> - <listitem> - <para> - <literal>pkgs.linuxPackages.virtualbox</literal> now contains only the - kernel modules instead of the VirtualBox user space binaries. - If you want to reference the user space binaries, you have to use the new - <literal>pkgs.virtualbox</literal> instead. - </para> + <para> + <literal>pkgs.linuxPackages.virtualbox</literal> now contains only the + kernel modules instead of the VirtualBox user space binaries. If you want + to reference the user space binaries, you have to use the new + <literal>pkgs.virtualbox</literal> instead. + </para> </listitem> - <listitem> - <para><literal>goPackages</literal> was replaced with separated Go - applications in appropriate <literal>nixpkgs</literal> - categories. Each Go package uses its own dependency set. There's - also a new <literal>go2nix</literal> tool introduced to generate a - Go package definition from its Go source automatically.</para> + <para> + <literal>goPackages</literal> was replaced with separated Go applications + in appropriate <literal>nixpkgs</literal> categories. Each Go package uses + its own dependency set. There's also a new <literal>go2nix</literal> tool + introduced to generate a Go package definition from its Go source + automatically. + </para> </listitem> - <listitem> - <para><literal>services.mongodb.extraConfig</literal> configuration format - was changed to YAML.</para> + <para> + <literal>services.mongodb.extraConfig</literal> configuration format was + changed to YAML. + </para> </listitem> - <listitem> - <para> - PHP has been upgraded to 7.0 - </para> + <para> + PHP has been upgraded to 7.0 + </para> </listitem> -</itemizedlist> - - -<para>Other notable improvements:</para> - -<itemizedlist> + </itemizedlist> - <listitem><para>Revamped grsecurity/PaX support. There is now only a single - general-purpose distribution kernel and the configuration interface has been - streamlined. Desktop users should be able to simply set - <programlisting>security.grsecurity.enable = true</programlisting> to get - a reasonably secure system without having to sacrifice too much - functionality. - </para></listitem> + <para> + Other notable improvements: + </para> - <listitem><para>Special filesystems, like <literal>/proc</literal>, - <literal>/run</literal> and others, now have the same mount options - as recommended by systemd and are unified across different places in - NixOS. Mount options are updated during <command>nixos-rebuild - switch</command> if possible. One benefit from this is improved - security — most such filesystems are now mounted with - <literal>noexec</literal>, <literal>nodev</literal> and/or - <literal>nosuid</literal> options.</para></listitem> - - <listitem><para>The reverse path filter was interfering with DHCPv4 server - operation in the past. An exception for DHCPv4 and a new option to log - packets that were dropped due to the reverse path filter was added - (<literal>networking.firewall.logReversePathDrops</literal>) for easier - debugging.</para></listitem> - - <listitem><para>Containers configuration within - <literal>containers.<name>.config</literal> is <link + <itemizedlist> + <listitem> + <para> + Revamped grsecurity/PaX support. There is now only a single general-purpose + distribution kernel and the configuration interface has been streamlined. + Desktop users should be able to simply set +<programlisting>security.grsecurity.enable = true</programlisting> + to get a reasonably secure system without having to sacrifice too much + functionality. + </para> + </listitem> + <listitem> + <para> + Special filesystems, like <literal>/proc</literal>, <literal>/run</literal> + and others, now have the same mount options as recommended by systemd and + are unified across different places in NixOS. Mount options are updated + during <command>nixos-rebuild switch</command> if possible. One benefit + from this is improved security — most such filesystems are now mounted + with <literal>noexec</literal>, <literal>nodev</literal> and/or + <literal>nosuid</literal> options. + </para> + </listitem> + <listitem> + <para> + The reverse path filter was interfering with DHCPv4 server operation in the + past. An exception for DHCPv4 and a new option to log packets that were + dropped due to the reverse path filter was added + (<literal>networking.firewall.logReversePathDrops</literal>) for easier + debugging. + </para> + </listitem> + <listitem> + <para> + Containers configuration within + <literal>containers.<name>.config</literal> is + <link xlink:href="https://github.com/NixOS/nixpkgs/pull/17365">now - properly typed and checked</link>. In particular, partial - configurations are merged correctly.</para></listitem> - + properly typed and checked</link>. In particular, partial configurations + are merged correctly. + </para> + </listitem> <listitem> - <para>The directory container setuid wrapper programs, - <filename>/var/setuid-wrappers</filename>, <link + <para> + The directory container setuid wrapper programs, + <filename>/var/setuid-wrappers</filename>, + <link xlink:href="https://github.com/NixOS/nixpkgs/pull/18124">is now - updated atomically to prevent failures if the switch to a new - configuration is interrupted.</link></para> + updated atomically to prevent failures if the switch to a new configuration + is interrupted.</link> + </para> </listitem> - <listitem> - <para><literal>services.xserver.startGnuPGAgent</literal> - has been removed due to GnuPG 2.1.x bump. See <link + <para> + <literal>services.xserver.startGnuPGAgent</literal> has been removed due to + GnuPG 2.1.x bump. See + <link xlink:href="https://github.com/NixOS/nixpkgs/commit/5391882ebd781149e213e8817fba6ac3c503740c"> - how to achieve similar behavior</link>. You might need to - <literal>pkill gpg-agent</literal> after the upgrade - to prevent a stale agent being in the way. - </para> + how to achieve similar behavior</link>. You might need to <literal>pkill + gpg-agent</literal> after the upgrade to prevent a stale agent being in the + way. + </para> </listitem> - - <listitem><para> + <listitem> + <para> <link xlink:href="https://github.com/NixOS/nixpkgs/commit/e561edc322d275c3687fec431935095cfc717147"> - Declarative users could share the uid due to the bug in - the script handling conflict resolution. - </link> - </para></listitem> - - <listitem><para> + Declarative users could share the uid due to the bug in the script handling + conflict resolution. </link> + </para> + </listitem> + <listitem> + <para> Gummi boot has been replaced using systemd-boot. - </para></listitem> - - <listitem><para> + </para> + </listitem> + <listitem> + <para> Hydra package and NixOS module were added for convenience. - </para></listitem> - -</itemizedlist> - - + </para> + </listitem> + </itemizedlist> </section> diff --git a/nixos/doc/manual/release-notes/rl-1703.xml b/nixos/doc/manual/release-notes/rl-1703.xml index 6147b9830137..6ca79e2bc00d 100644 --- a/nixos/doc/manual/release-notes/rl-1703.xml +++ b/nixos/doc/manual/release-notes/rl-1703.xml @@ -3,259 +3,588 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-release-17.03"> + <title>Release 17.03 (“Gorilla”, 2017/03/31)</title> -<title>Release 17.03 (“Gorilla”, 2017/03/31)</title> - -<section xmlns="http://docbook.org/ns/docbook" + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-release-17.03-highlights"> + <title>Highlights</title> -<title>Highlights</title> + <para> + In addition to numerous new and upgraded packages, this release has the + following highlights: + </para> -<para>In addition to numerous new and upgraded packages, this release -has the following highlights: </para> - -<itemizedlist> - <listitem> - <para>Nixpkgs is now extensible through overlays. See the <link + <itemizedlist> + <listitem> + <para> + Nixpkgs is now extensible through overlays. See the + <link xlink:href="https://nixos.org/nixpkgs/manual/#sec-overlays-install">Nixpkgs - manual</link> for more information.</para> - </listitem> - - <listitem> - <para>This release is based on Glibc 2.25, GCC 5.4.0 and systemd - 232. The default Linux kernel is 4.9 and Nix is at 1.11.8.</para> - </listitem> - - <listitem> - <para>The default desktop environment now is KDE's Plasma 5. KDE 4 has been removed</para> - </listitem> - - <listitem> - <para>The setuid wrapper functionality now supports setting - capabilities.</para> - </listitem> - - <listitem> - <para>X.org server uses branch 1.19. Due to ABI incompatibilities, - <literal>ati_unfree</literal> keeps forcing 1.17 - and <literal>amdgpu-pro</literal> starts forcing 1.18.</para> - </listitem> - - <listitem> + manual</link> for more information. + </para> + </listitem> + <listitem> <para> - Cross compilation has been rewritten. See the nixpkgs manual for - details. The most obvious breaking change is that in derivations there is no - <literal>.nativeDrv</literal> nor <literal>.crossDrv</literal> are now - cross by default, not native. + This release is based on Glibc 2.25, GCC 5.4.0 and systemd 232. The + default Linux kernel is 4.9 and Nix is at 1.11.8. </para> - </listitem> - - <listitem> - <para>The <literal>overridePackages</literal> function has been rewritten - to be replaced by <link + </listitem> + <listitem> + <para> + The default desktop environment now is KDE's Plasma 5. KDE 4 has been + removed + </para> + </listitem> + <listitem> + <para> + The setuid wrapper functionality now supports setting capabilities. + </para> + </listitem> + <listitem> + <para> + X.org server uses branch 1.19. Due to ABI incompatibilities, + <literal>ati_unfree</literal> keeps forcing 1.17 and + <literal>amdgpu-pro</literal> starts forcing 1.18. + </para> + </listitem> + <listitem> + <para> + Cross compilation has been rewritten. See the nixpkgs manual for details. + The most obvious breaking change is that in derivations there is no + <literal>.nativeDrv</literal> nor <literal>.crossDrv</literal> are now + cross by default, not native. + </para> + </listitem> + <listitem> + <para> + The <literal>overridePackages</literal> function has been rewritten to be + replaced by + <link xlink:href="https://nixos.org/nixpkgs/manual/#sec-overlays-install"> - overlays</link></para> - </listitem> - - <listitem> - <para>Packages in nixpkgs can be marked as insecure through listed - vulnerabilities. See the <link + overlays</link> + </para> + </listitem> + <listitem> + <para> + Packages in nixpkgs can be marked as insecure through listed + vulnerabilities. See the + <link xlink:href="https://nixos.org/nixpkgs/manual/#sec-allow-insecure">Nixpkgs - manual</link> for more information.</para> - </listitem> - - <listitem> - <para>PHP now defaults to PHP 7.1</para> - </listitem> - -</itemizedlist> + manual</link> for more information. + </para> + </listitem> + <listitem> + <para> + PHP now defaults to PHP 7.1 + </para> + </listitem> + </itemizedlist> + </section> -</section> -<section xmlns="http://docbook.org/ns/docbook" + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-release-17.03-new-services"> + <title>New Services</title> -<title>New Services</title> + <para> + The following new services were added since the last release: + </para> -<para>The following new services were added since the last release:</para> - -<itemizedlist> - <listitem><para><literal>hardware/ckb.nix</literal></para></listitem> - <listitem><para><literal>hardware/mcelog.nix</literal></para></listitem> - <listitem><para><literal>hardware/usb-wwan.nix</literal></para></listitem> - <listitem><para><literal>hardware/video/capture/mwprocapture.nix</literal></para></listitem> - <listitem><para><literal>programs/adb.nix</literal></para></listitem> - <listitem><para><literal>programs/chromium.nix</literal></para></listitem> - <listitem><para><literal>programs/gphoto2.nix</literal></para></listitem> - <listitem><para><literal>programs/java.nix</literal></para></listitem> - <listitem><para><literal>programs/mtr.nix</literal></para></listitem> - <listitem><para><literal>programs/oblogout.nix</literal></para></listitem> - <listitem><para><literal>programs/vim.nix</literal></para></listitem> - <listitem><para><literal>programs/wireshark.nix</literal></para></listitem> - <listitem><para><literal>security/dhparams.nix</literal></para></listitem> - <listitem><para><literal>services/audio/ympd.nix</literal></para></listitem> - <listitem><para><literal>services/computing/boinc/client.nix</literal></para></listitem> - <listitem><para><literal>services/continuous-integration/buildbot/master.nix</literal></para></listitem> - <listitem><para><literal>services/continuous-integration/buildbot/worker.nix</literal></para></listitem> - <listitem><para><literal>services/continuous-integration/gitlab-runner.nix</literal></para></listitem> - <listitem><para><literal>services/databases/riak-cs.nix</literal></para></listitem> - <listitem><para><literal>services/databases/stanchion.nix</literal></para></listitem> - <listitem><para><literal>services/desktops/gnome3/gnome-terminal-server.nix</literal></para></listitem> - <listitem><para><literal>services/editors/infinoted.nix</literal></para></listitem> - <listitem><para><literal>services/hardware/illum.nix</literal></para></listitem> - <listitem><para><literal>services/hardware/trezord.nix</literal></para></listitem> - <listitem><para><literal>services/logging/journalbeat.nix</literal></para></listitem> - <listitem><para><literal>services/mail/offlineimap.nix</literal></para></listitem> - <listitem><para><literal>services/mail/postgrey.nix</literal></para></listitem> - <listitem><para><literal>services/misc/couchpotato.nix</literal></para></listitem> - <listitem><para><literal>services/misc/docker-registry.nix</literal></para></listitem> - <listitem><para><literal>services/misc/errbot.nix</literal></para></listitem> - <listitem><para><literal>services/misc/geoip-updater.nix</literal></para></listitem> - <listitem><para><literal>services/misc/gogs.nix</literal></para></listitem> - <listitem><para><literal>services/misc/leaps.nix</literal></para></listitem> - <listitem><para><literal>services/misc/nix-optimise.nix</literal></para></listitem> - <listitem><para><literal>services/misc/ssm-agent.nix</literal></para></listitem> - <listitem><para><literal>services/misc/sssd.nix</literal></para></listitem> - <listitem><para><literal>services/monitoring/arbtt.nix</literal></para></listitem> - <listitem><para><literal>services/monitoring/netdata.nix</literal></para></listitem> - <listitem><para><literal>services/monitoring/prometheus/default.nix</literal></para></listitem> - <listitem><para><literal>services/monitoring/prometheus/alertmanager.nix</literal></para></listitem> - <listitem><para><literal>services/monitoring/prometheus/blackbox-exporter.nix</literal></para></listitem> - <listitem><para><literal>services/monitoring/prometheus/json-exporter.nix</literal></para></listitem> - <listitem><para><literal>services/monitoring/prometheus/nginx-exporter.nix</literal></para></listitem> - <listitem><para><literal>services/monitoring/prometheus/node-exporter.nix</literal></para></listitem> - <listitem><para><literal>services/monitoring/prometheus/snmp-exporter.nix</literal></para></listitem> - <listitem><para><literal>services/monitoring/prometheus/unifi-exporter.nix</literal></para></listitem> - <listitem><para><literal>services/monitoring/prometheus/varnish-exporter.nix</literal></para></listitem> - <listitem><para><literal>services/monitoring/sysstat.nix</literal></para></listitem> - <listitem><para><literal>services/monitoring/telegraf.nix</literal></para></listitem> - <listitem><para><literal>services/monitoring/vnstat.nix</literal></para></listitem> - <listitem><para><literal>services/network-filesystems/cachefilesd.nix</literal></para></listitem> - <listitem><para><literal>services/network-filesystems/glusterfs.nix</literal></para></listitem> - <listitem><para><literal>services/network-filesystems/ipfs.nix</literal></para></listitem> - <listitem><para><literal>services/networking/dante.nix</literal></para></listitem> - <listitem><para><literal>services/networking/dnscrypt-wrapper.nix</literal></para></listitem> - <listitem><para><literal>services/networking/fakeroute.nix</literal></para></listitem> - <listitem><para><literal>services/networking/flannel.nix</literal></para></listitem> - <listitem><para><literal>services/networking/htpdate.nix</literal></para></listitem> - <listitem><para><literal>services/networking/miredo.nix</literal></para></listitem> - <listitem><para><literal>services/networking/nftables.nix</literal></para></listitem> - <listitem><para><literal>services/networking/powerdns.nix</literal></para></listitem> - <listitem><para><literal>services/networking/pdns-recursor.nix</literal></para></listitem> - <listitem><para><literal>services/networking/quagga.nix</literal></para></listitem> - <listitem><para><literal>services/networking/redsocks.nix</literal></para></listitem> - <listitem><para><literal>services/networking/wireguard.nix</literal></para></listitem> - <listitem><para><literal>services/system/cgmanager.nix</literal></para></listitem> - <listitem><para><literal>services/torrent/opentracker.nix</literal></para></listitem> - <listitem><para><literal>services/web-apps/atlassian/confluence.nix</literal></para></listitem> - <listitem><para><literal>services/web-apps/atlassian/crowd.nix</literal></para></listitem> - <listitem><para><literal>services/web-apps/atlassian/jira.nix</literal></para></listitem> - <listitem><para><literal>services/web-apps/frab.nix</literal></para></listitem> - <listitem><para><literal>services/web-apps/nixbot.nix</literal></para></listitem> - <listitem><para><literal>services/web-apps/selfoss.nix</literal></para></listitem> - <listitem><para><literal>services/web-apps/quassel-webserver.nix</literal></para></listitem> - <listitem><para><literal>services/x11/unclutter-xfixes.nix</literal></para></listitem> - <listitem><para><literal>services/x11/urxvtd.nix</literal></para></listitem> - <listitem><para><literal>system/boot/systemd-nspawn.nix</literal></para></listitem> - <listitem><para><literal>virtualisation/ecs-agent.nix</literal></para></listitem> - <listitem><para><literal>virtualisation/lxcfs.nix</literal></para></listitem> - <listitem><para><literal>virtualisation/openstack/keystone.nix</literal></para></listitem> - <listitem><para><literal>virtualisation/openstack/glance.nix</literal></para></listitem> -</itemizedlist> + <itemizedlist> + <listitem> + <para> + <literal>hardware/ckb.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>hardware/mcelog.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>hardware/usb-wwan.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>hardware/video/capture/mwprocapture.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>programs/adb.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>programs/chromium.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>programs/gphoto2.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>programs/java.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>programs/mtr.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>programs/oblogout.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>programs/vim.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>programs/wireshark.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>security/dhparams.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/audio/ympd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/computing/boinc/client.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/continuous-integration/buildbot/master.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/continuous-integration/buildbot/worker.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/continuous-integration/gitlab-runner.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/databases/riak-cs.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/databases/stanchion.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/desktops/gnome3/gnome-terminal-server.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/editors/infinoted.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/hardware/illum.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/hardware/trezord.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/logging/journalbeat.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/mail/offlineimap.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/mail/postgrey.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/couchpotato.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/docker-registry.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/errbot.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/geoip-updater.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/gogs.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/leaps.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/nix-optimise.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/ssm-agent.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/sssd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/arbtt.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/netdata.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/prometheus/default.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/prometheus/alertmanager.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/prometheus/blackbox-exporter.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/prometheus/json-exporter.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/prometheus/nginx-exporter.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/prometheus/node-exporter.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/prometheus/snmp-exporter.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/prometheus/unifi-exporter.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/prometheus/varnish-exporter.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/sysstat.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/telegraf.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/vnstat.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/network-filesystems/cachefilesd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/network-filesystems/glusterfs.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/network-filesystems/ipfs.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/dante.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/dnscrypt-wrapper.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/fakeroute.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/flannel.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/htpdate.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/miredo.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/nftables.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/powerdns.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/pdns-recursor.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/quagga.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/redsocks.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/wireguard.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/system/cgmanager.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/torrent/opentracker.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/web-apps/atlassian/confluence.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/web-apps/atlassian/crowd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/web-apps/atlassian/jira.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/web-apps/frab.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/web-apps/nixbot.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/web-apps/selfoss.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/web-apps/quassel-webserver.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/x11/unclutter-xfixes.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/x11/urxvtd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>system/boot/systemd-nspawn.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>virtualisation/ecs-agent.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>virtualisation/lxcfs.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>virtualisation/openstack/keystone.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>virtualisation/openstack/glance.nix</literal> + </para> + </listitem> + </itemizedlist> + </section> -</section> -<section xmlns="http://docbook.org/ns/docbook" + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-release-17.03-incompatibilities"> + <title>Backward Incompatibilities</title> -<title>Backward Incompatibilities</title> + <para> + When upgrading from a previous release, please be aware of the following + incompatible changes: + </para> -<para>When upgrading from a previous release, please be aware of the -following incompatible changes:</para> - -<itemizedlist> - <listitem> + <itemizedlist> + <listitem> <para> - Derivations have no <literal>.nativeDrv</literal> nor <literal>.crossDrv</literal> - and are now cross by default, not native. + Derivations have no <literal>.nativeDrv</literal> nor + <literal>.crossDrv</literal> and are now cross by default, not native. </para> - </listitem> - - <listitem> + </listitem> + <listitem> <para> - <literal>stdenv.overrides</literal> is now expected to take <literal>self</literal> - and <literal>super</literal> arguments. See <literal>lib.trivial.extends</literal> - for what those parameters represent. + <literal>stdenv.overrides</literal> is now expected to take + <literal>self</literal> and <literal>super</literal> arguments. See + <literal>lib.trivial.extends</literal> for what those parameters + represent. </para> - </listitem> - - <listitem> + </listitem> + <listitem> <para> - <literal>ansible</literal> now defaults to ansible version 2 as version 1 - has been removed due to a serious <link + <literal>ansible</literal> now defaults to ansible version 2 as version 1 + has been removed due to a serious + <link xlink:href="https://www.computest.nl/advisories/CT-2017-0109_Ansible.txt"> - vulnerability</link> unpatched by upstream. + vulnerability</link> unpatched by upstream. </para> - </listitem> - - <listitem> + </listitem> + <listitem> <para> - <literal>gnome</literal> alias has been removed along with - <literal>gtk</literal>, <literal>gtkmm</literal> and several others. - Now you need to use versioned attributes, like <literal>gnome3</literal>. + <literal>gnome</literal> alias has been removed along with + <literal>gtk</literal>, <literal>gtkmm</literal> and several others. Now + you need to use versioned attributes, like <literal>gnome3</literal>. </para> - </listitem> - - <listitem> + </listitem> + <listitem> <para> - The attribute name of the Radicale daemon has been changed from - <literal>pythonPackages.radicale</literal> to - <literal>radicale</literal>. + The attribute name of the Radicale daemon has been changed from + <literal>pythonPackages.radicale</literal> to <literal>radicale</literal>. </para> - </listitem> - - <listitem> + </listitem> + <listitem> <para> - The <literal>stripHash</literal> bash function in <literal>stdenv</literal> - changed according to its documentation; it now outputs the stripped name to - <literal>stdout</literal> instead of putting it in the variable - <literal>strippedName</literal>. + The <literal>stripHash</literal> bash function in + <literal>stdenv</literal> changed according to its documentation; it now + outputs the stripped name to <literal>stdout</literal> instead of putting + it in the variable <literal>strippedName</literal>. </para> - </listitem> - - <listitem> - <para>PHP now scans for extra configuration .ini files in /etc/php.d - instead of /etc. This prevents accidentally loading non-PHP .ini files - that may be in /etc. + </listitem> + <listitem> + <para> + PHP now scans for extra configuration .ini files in /etc/php.d instead of + /etc. This prevents accidentally loading non-PHP .ini files that may be in + /etc. </para> - </listitem> - - <listitem> + </listitem> + <listitem> <para> - Two lone top-level dict dbs moved into <literal>dictdDBs</literal>. This - affects: <literal>dictdWordnet</literal> which is now at - <literal>dictdDBs.wordnet</literal> and <literal>dictdWiktionary</literal> - which is now at <literal>dictdDBs.wiktionary</literal> + Two lone top-level dict dbs moved into <literal>dictdDBs</literal>. This + affects: <literal>dictdWordnet</literal> which is now at + <literal>dictdDBs.wordnet</literal> and <literal>dictdWiktionary</literal> + which is now at <literal>dictdDBs.wiktionary</literal> </para> - </listitem> - - <listitem> + </listitem> + <listitem> <para> - Parsoid service now uses YAML configuration format. + Parsoid service now uses YAML configuration format. <literal>service.parsoid.interwikis</literal> is now called <literal>service.parsoid.wikis</literal> and is a list of either API URLs or attribute sets as specified in parsoid's documentation. </para> - </listitem> - - <listitem> + </listitem> + <listitem> <para> <literal>Ntpd</literal> was replaced by <literal>systemd-timesyncd</literal> as the default service to synchronize @@ -263,14 +592,12 @@ following incompatible changes:</para> setting <literal>services.ntp.enable</literal> to <literal>true</literal>. Upstream time servers for all NTP implementations are now configured using <literal>networking.timeServers</literal>. - </para> - </listitem> - - <listitem> + </para> + </listitem> + <listitem> <para> - <literal>service.nylon</literal> is now declared using named instances. - As an example: - + <literal>service.nylon</literal> is now declared using named instances. As + an example: <programlisting> services.nylon = { enable = true; @@ -279,9 +606,7 @@ following incompatible changes:</para> port = 5912; }; </programlisting> - - should be replaced with: - + should be replaced with: <programlisting> services.nylon.myvpn = { enable = true; @@ -290,225 +615,203 @@ following incompatible changes:</para> port = 5912; }; </programlisting> - - this enables you to declare a SOCKS proxy for each uplink. - + this enables you to declare a SOCKS proxy for each uplink. </para> - </listitem> - - <listitem> - <para><literal>overridePackages</literal> function no longer exists. - It is replaced by <link + </listitem> + <listitem> + <para> + <literal>overridePackages</literal> function no longer exists. It is + replaced by + <link xlink:href="https://nixos.org/nixpkgs/manual/#sec-overlays-install"> - overlays</link>. For example, the following code: - + overlays</link>. For example, the following code: <programlisting> let pkgs = import <nixpkgs> {}; in pkgs.overridePackages (self: super: ...) </programlisting> - - should be replaced by: - + should be replaced by: <programlisting> let pkgs = import <nixpkgs> {}; in import pkgs.path { overlays = [(self: super: ...)]; } </programlisting> - </para> - </listitem> - - <listitem> + </listitem> + <listitem> <para> - Autoloading connection tracking helpers is now disabled by default. - This default was also changed in the Linux kernel and is considered - insecure if not configured properly in your firewall. If you need - connection tracking helpers (i.e. for active FTP) please enable - <literal>networking.firewall.autoLoadConntrackHelpers</literal> and - tune <literal>networking.firewall.connectionTrackingModules</literal> - to suit your needs. - </para> - </listitem> - - <listitem> + Autoloading connection tracking helpers is now disabled by default. This + default was also changed in the Linux kernel and is considered insecure if + not configured properly in your firewall. If you need connection tracking + helpers (i.e. for active FTP) please enable + <literal>networking.firewall.autoLoadConntrackHelpers</literal> and tune + <literal>networking.firewall.connectionTrackingModules</literal> to suit + your needs. + </para> + </listitem> + <listitem> <para> - <literal>local_recipient_maps</literal> is not set to empty value by - Postfix service. It's an insecure default as stated by Postfix - documentation. Those who want to retain this setting need to set it via - <literal>services.postfix.extraConfig</literal>. + <literal>local_recipient_maps</literal> is not set to empty value by + Postfix service. It's an insecure default as stated by Postfix + documentation. Those who want to retain this setting need to set it via + <literal>services.postfix.extraConfig</literal>. </para> - </listitem> - - <listitem> + </listitem> + <listitem> <para> - Iputils no longer provide ping6 and traceroute6. The functionality of - these tools has been integrated into ping and traceroute respectively. To - enforce an address family the new flags <literal>-4</literal> and - <literal>-6</literal> have been added. One notable incompatibility is that - specifying an interface (for link-local IPv6 for instance) is no longer done - with the <literal>-I</literal> flag, but by encoding the interface into the - address (<literal>ping fe80::1%eth0</literal>). - </para> - </listitem> - - <listitem> + Iputils no longer provide ping6 and traceroute6. The functionality of + these tools has been integrated into ping and traceroute respectively. To + enforce an address family the new flags <literal>-4</literal> and + <literal>-6</literal> have been added. One notable incompatibility is that + specifying an interface (for link-local IPv6 for instance) is no longer + done with the <literal>-I</literal> flag, but by encoding the interface + into the address (<literal>ping fe80::1%eth0</literal>). + </para> + </listitem> + <listitem> <para> - The socket handling of the <literal>services.rmilter</literal> module - has been fixed and refactored. As rmilter doesn't support binding to - more than one socket, the options <literal>bindUnixSockets</literal> - and <literal>bindInetSockets</literal> have been replaced by - <literal>services.rmilter.bindSocket.*</literal>. The default is still - a unix socket in <literal>/run/rmilter/rmilter.sock</literal>. Refer to - the options documentation for more information. - </para> - </listitem> - - <listitem> + The socket handling of the <literal>services.rmilter</literal> module has + been fixed and refactored. As rmilter doesn't support binding to more than + one socket, the options <literal>bindUnixSockets</literal> and + <literal>bindInetSockets</literal> have been replaced by + <literal>services.rmilter.bindSocket.*</literal>. The default is still a + unix socket in <literal>/run/rmilter/rmilter.sock</literal>. Refer to the + options documentation for more information. + </para> + </listitem> + <listitem> <para> - The <literal>fetch*</literal> functions no longer support md5, - please use sha256 instead. + The <literal>fetch*</literal> functions no longer support md5, please use + sha256 instead. </para> - </listitem> - - <listitem> + </listitem> + <listitem> <para> - The dnscrypt-proxy module interface has been streamlined around the - <option>extraArgs</option> option. Where possible, legacy option - declarations are mapped to <option>extraArgs</option> but will emit - warnings. The <option>resolverList</option> has been outright - removed: to use an unlisted resolver, use the - <option>customResolver</option> option. - </para> - </listitem> - - <listitem> + The dnscrypt-proxy module interface has been streamlined around the + <option>extraArgs</option> option. Where possible, legacy option + declarations are mapped to <option>extraArgs</option> but will emit + warnings. The <option>resolverList</option> has been outright removed: to + use an unlisted resolver, use the <option>customResolver</option> option. + </para> + </listitem> + <listitem> <para> - torbrowser now stores local state under - <filename>~/.local/share/tor-browser</filename> by default. Any - browser profile data from the old location, - <filename>~/.torbrowser4</filename>, must be migrated manually. + torbrowser now stores local state under + <filename>~/.local/share/tor-browser</filename> by default. Any browser + profile data from the old location, <filename>~/.torbrowser4</filename>, + must be migrated manually. </para> - </listitem> - - <listitem> + </listitem> + <listitem> <para> - The ihaskell, monetdb, offlineimap and sitecopy services have been removed. + The ihaskell, monetdb, offlineimap and sitecopy services have been + removed. </para> - </listitem> -</itemizedlist> + </listitem> + </itemizedlist> + </section> -</section> -<section xmlns="http://docbook.org/ns/docbook" + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-release-17.03-notable-changes"> + <title>Other Notable Changes</title> -<title>Other Notable Changes</title> - -<itemizedlist> - - <listitem> - <para>Module type system have a new extensible option types feature that - allow to extend certain types, such as enum, through multiple option - declarations of the same option across multiple modules. - </para> - </listitem> - - <listitem> + <itemizedlist> + <listitem> <para> - <literal>jre</literal> now defaults to GTK+ UI by default. This - improves visual consistency and makes Java follow system font style, - improving the situation on HighDPI displays. This has a cost of increased - closure size; for server and other headless workloads it's recommended to - use <literal>jre_headless</literal>. + Module type system have a new extensible option types feature that allow + to extend certain types, such as enum, through multiple option + declarations of the same option across multiple modules. </para> - </listitem> - - <listitem> - <para>Python 2.6 interpreter and package set have been removed.</para> - </listitem> - - <listitem> + </listitem> + <listitem> + <para> + <literal>jre</literal> now defaults to GTK+ UI by default. This improves + visual consistency and makes Java follow system font style, improving the + situation on HighDPI displays. This has a cost of increased closure size; + for server and other headless workloads it's recommended to use + <literal>jre_headless</literal>. + </para> + </listitem> + <listitem> <para> - The Python 2.7 interpreter does not use modules anymore. Instead, all - CPython interpreters now include the whole standard library except for `tkinter`, - which is available in the Python package set. + Python 2.6 interpreter and package set have been removed. </para> - </listitem> - - <listitem> + </listitem> + <listitem> <para> - Python 2.7, 3.5 and 3.6 are now built deterministically and 3.4 mostly. - Minor modifications had to be made to the interpreters in order to generate - deterministic bytecode. This has security implications and is relevant for - those using Python in a <literal>nix-shell</literal>. See the Nixpkgs manual - for details. + The Python 2.7 interpreter does not use modules anymore. Instead, all + CPython interpreters now include the whole standard library except for + `tkinter`, which is available in the Python package set. </para> - </listitem> - - <listitem> + </listitem> + <listitem> <para> - The Python package sets now use a fixed-point combinator and the sets are - available as attributes of the interpreters. + Python 2.7, 3.5 and 3.6 are now built deterministically and 3.4 mostly. + Minor modifications had to be made to the interpreters in order to + generate deterministic bytecode. This has security implications and is + relevant for those using Python in a <literal>nix-shell</literal>. See the + Nixpkgs manual for details. + </para> + </listitem> + <listitem> + <para> + The Python package sets now use a fixed-point combinator and the sets are + available as attributes of the interpreters. </para> - </listitem> - - <listitem> + </listitem> + <listitem> <para> - The Python function <literal>buildPythonPackage</literal> has been improved and can be - used to build from Setuptools source, Flit source, and precompiled Wheels. + The Python function <literal>buildPythonPackage</literal> has been + improved and can be used to build from Setuptools source, Flit source, and + precompiled Wheels. </para> - </listitem> - - <listitem> + </listitem> + <listitem> <para> - When adding new or updating current Python libraries, the expressions should be put - in separate files in <literal>pkgs/development/python-modules</literal> and - called from <literal>python-packages.nix</literal>. + When adding new or updating current Python libraries, the expressions + should be put in separate files in + <literal>pkgs/development/python-modules</literal> and called from + <literal>python-packages.nix</literal>. </para> - </listitem> - - <listitem> + </listitem> + <listitem> <para> - The dnscrypt-proxy service supports synchronizing the list of public - resolvers without working DNS resolution. This fixes issues caused by the - resolver list becoming outdated. It also improves the viability of - DNSCrypt only configurations. + The dnscrypt-proxy service supports synchronizing the list of public + resolvers without working DNS resolution. This fixes issues caused by the + resolver list becoming outdated. It also improves the viability of + DNSCrypt only configurations. </para> - </listitem> - - <listitem> + </listitem> + <listitem> <para> - Containers using bridged networking no longer lose their connection after - changes to the host networking. + Containers using bridged networking no longer lose their connection after + changes to the host networking. </para> - </listitem> - - <listitem> + </listitem> + <listitem> <para> - ZFS supports pool auto scrubbing. + ZFS supports pool auto scrubbing. </para> - </listitem> - - <listitem> + </listitem> + <listitem> <para> - The bind DNS utilities (e.g. dig) have been split into their own output and - are now also available in <literal>pkgs.dnsutils</literal> and it is no longer - necessary to pull in all of <literal>bind</literal> to use them. + The bind DNS utilities (e.g. dig) have been split into their own output + and are now also available in <literal>pkgs.dnsutils</literal> and it is + no longer necessary to pull in all of <literal>bind</literal> to use them. </para> - </listitem> - - <listitem> + </listitem> + <listitem> <para> - Per-user configuration was moved from <filename>~/.nixpkgs</filename> to - <filename>~/.config/nixpkgs</filename>. The former is still valid for - <filename>config.nix</filename> for backwards compatibility. + Per-user configuration was moved from <filename>~/.nixpkgs</filename> to + <filename>~/.config/nixpkgs</filename>. The former is still valid for + <filename>config.nix</filename> for backwards compatibility. </para> - </listitem> -</itemizedlist> -</section> + </listitem> + </itemizedlist> + </section> </section> diff --git a/nixos/doc/manual/release-notes/rl-1709.xml b/nixos/doc/manual/release-notes/rl-1709.xml index 66f7b01db72a..795c51d2923d 100644 --- a/nixos/doc/manual/release-notes/rl-1709.xml +++ b/nixos/doc/manual/release-notes/rl-1709.xml @@ -3,40 +3,40 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-release-17.09"> + <title>Release 17.09 (“Hummingbird”, 2017/09/??)</title> -<title>Release 17.09 (“Hummingbird”, 2017/09/??)</title> - -<section xmlns="http://docbook.org/ns/docbook" + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-release-17.09-highlights"> + <title>Highlights</title> -<title>Highlights</title> - -<para>In addition to numerous new and upgraded packages, this release -has the following highlights: </para> + <para> + In addition to numerous new and upgraded packages, this release has the + following highlights: + </para> -<itemizedlist> - <listitem> + <itemizedlist> + <listitem> <para> - The GNOME version is now 3.24. KDE Plasma was upgraded to 5.10, - KDE Applications to 17.08.1 and KDE Frameworks to 5.37. + The GNOME version is now 3.24. KDE Plasma was upgraded to 5.10, KDE + Applications to 17.08.1 and KDE Frameworks to 5.37. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - The user handling now keeps track of deallocated UIDs/GIDs. When a user - or group is revived, this allows it to be allocated the UID/GID it had before. - A consequence is that UIDs and GIDs are no longer reused. + The user handling now keeps track of deallocated UIDs/GIDs. When a user or + group is revived, this allows it to be allocated the UID/GID it had + before. A consequence is that UIDs and GIDs are no longer reused. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - The module option <option>services.xserver.xrandrHeads</option> now - causes the first head specified in this list to be set as the primary - head. Apart from that, it's now possible to also set additional options - by using an attribute set, for example: + The module option <option>services.xserver.xrandrHeads</option> now causes + the first head specified in this list to be set as the primary head. Apart + from that, it's now possible to also set additional options by using an + attribute set, for example: <programlisting> { services.xserver.xrandrHeads = [ "HDMI-0" @@ -50,365 +50,664 @@ has the following highlights: </para> ]; } </programlisting> - This will set the <literal>DVI-0</literal> output to be the primary head, - even though <literal>HDMI-0</literal> is the first head in the list. + This will set the <literal>DVI-0</literal> output to be the primary head, + even though <literal>HDMI-0</literal> is the first head in the list. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - The handling of SSL in the <literal>services.nginx</literal> module has - been cleaned up, renaming the misnamed <literal>enableSSL</literal> to - <literal>onlySSL</literal> which reflects its original intention. This - is not to be used with the already existing <literal>forceSSL</literal> - which creates a second non-SSL virtual host redirecting to the SSL - virtual host. This by chance had worked earlier due to specific - implementation details. In case you had specified both please remove - the <literal>enableSSL</literal> option to keep the previous behaviour. + The handling of SSL in the <literal>services.nginx</literal> module has + been cleaned up, renaming the misnamed <literal>enableSSL</literal> to + <literal>onlySSL</literal> which reflects its original intention. This is + not to be used with the already existing <literal>forceSSL</literal> which + creates a second non-SSL virtual host redirecting to the SSL virtual host. + This by chance had worked earlier due to specific implementation details. + In case you had specified both please remove the + <literal>enableSSL</literal> option to keep the previous behaviour. </para> <para> - Another <literal>addSSL</literal> option has been introduced to configure - both a non-SSL virtual host and an SSL virtual host with the same - configuration. + Another <literal>addSSL</literal> option has been introduced to configure + both a non-SSL virtual host and an SSL virtual host with the same + configuration. </para> <para> - Options to configure <literal>resolver</literal> options and - <literal>upstream</literal> blocks have been introduced. See their information - for further details. + Options to configure <literal>resolver</literal> options and + <literal>upstream</literal> blocks have been introduced. See their + information for further details. </para> <para> - The <literal>port</literal> option has been replaced by a more generic - <literal>listen</literal> option which makes it possible to specify - multiple addresses, ports and SSL configs dependant on the new SSL - handling mentioned above. + The <literal>port</literal> option has been replaced by a more generic + <literal>listen</literal> option which makes it possible to specify + multiple addresses, ports and SSL configs dependant on the new SSL + handling mentioned above. </para> - </listitem> -</itemizedlist> + </listitem> + </itemizedlist> + </section> -</section> -<section xmlns="http://docbook.org/ns/docbook" + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-release-17.09-new-services"> + <title>New Services</title> -<title>New Services</title> - -<para>The following new services were added since the last release:</para> + <para> + The following new services were added since the last release: + </para> -<itemizedlist> - <listitem><para><literal>config/fonts/fontconfig-penultimate.nix</literal></para></listitem> - <listitem><para><literal>config/fonts/fontconfig-ultimate.nix</literal></para></listitem> - <listitem><para><literal>config/terminfo.nix</literal></para></listitem> - <listitem><para><literal>hardware/sensor/iio.nix</literal></para></listitem> - <listitem><para><literal>hardware/nitrokey.nix</literal></para></listitem> - <listitem><para><literal>hardware/raid/hpsa.nix</literal></para></listitem> - <listitem><para><literal>programs/browserpass.nix</literal></para></listitem> - <listitem><para><literal>programs/gnupg.nix</literal></para></listitem> - <listitem><para><literal>programs/qt5ct.nix</literal></para></listitem> - <listitem><para><literal>programs/slock.nix</literal></para></listitem> - <listitem><para><literal>programs/thefuck.nix</literal></para></listitem> - <listitem><para><literal>security/auditd.nix</literal></para></listitem> - <listitem><para><literal>security/lock-kernel-modules.nix</literal></para></listitem> - <listitem><para><literal>service-managers/docker.nix</literal></para></listitem> - <listitem><para><literal>service-managers/trivial.nix</literal></para></listitem> - <listitem><para><literal>services/admin/salt/master.nix</literal></para></listitem> - <listitem><para><literal>services/admin/salt/minion.nix</literal></para></listitem> - <listitem><para><literal>services/audio/slimserver.nix</literal></para></listitem> - <listitem><para><literal>services/cluster/kubernetes/default.nix</literal></para></listitem> - <listitem><para><literal>services/cluster/kubernetes/dns.nix</literal></para></listitem> - <listitem><para><literal>services/cluster/kubernetes/dashboard.nix</literal></para></listitem> - <listitem><para><literal>services/continuous-integration/hail.nix</literal></para></listitem> - <listitem><para><literal>services/databases/clickhouse.nix</literal></para></listitem> - <listitem><para><literal>services/databases/postage.nix</literal></para></listitem> - <listitem><para><literal>services/desktops/gnome3/gnome-disks.nix</literal></para></listitem> - <listitem><para><literal>services/desktops/gnome3/gpaste.nix</literal></para></listitem> - <listitem><para><literal>services/logging/SystemdJournal2Gelf.nix</literal></para></listitem> - <listitem><para><literal>services/logging/heartbeat.nix</literal></para></listitem> - <listitem><para><literal>services/logging/journalwatch.nix</literal></para></listitem> - <listitem><para><literal>services/logging/syslogd.nix</literal></para></listitem> - <listitem><para><literal>services/mail/mailhog.nix</literal></para></listitem> - <listitem><para><literal>services/mail/nullmailer.nix</literal></para></listitem> - <listitem><para><literal>services/misc/airsonic.nix</literal></para></listitem> - <listitem><para><literal>services/misc/autorandr.nix</literal></para></listitem> - <listitem><para><literal>services/misc/exhibitor.nix</literal></para></listitem> - <listitem><para><literal>services/misc/fstrim.nix</literal></para></listitem> - <listitem><para><literal>services/misc/gollum.nix</literal></para></listitem> - <listitem><para><literal>services/misc/irkerd.nix</literal></para></listitem> - <listitem><para><literal>services/misc/jackett.nix</literal></para></listitem> - <listitem><para><literal>services/misc/radarr.nix</literal></para></listitem> - <listitem><para><literal>services/misc/snapper.nix</literal></para></listitem> - <listitem><para><literal>services/monitoring/osquery.nix</literal></para></listitem> - <listitem><para><literal>services/monitoring/prometheus/collectd-exporter.nix</literal></para></listitem> - <listitem><para><literal>services/monitoring/prometheus/fritzbox-exporter.nix</literal></para></listitem> - <listitem><para><literal>services/network-filesystems/kbfs.nix</literal></para></listitem> - <listitem><para><literal>services/networking/dnscache.nix</literal></para></listitem> - <listitem><para><literal>services/networking/fireqos.nix</literal></para></listitem> - <listitem><para><literal>services/networking/iwd.nix</literal></para></listitem> - <listitem><para><literal>services/networking/keepalived/default.nix</literal></para></listitem> - <listitem><para><literal>services/networking/keybase.nix</literal></para></listitem> - <listitem><para><literal>services/networking/lldpd.nix</literal></para></listitem> - <listitem><para><literal>services/networking/matterbridge.nix</literal></para></listitem> - <listitem><para><literal>services/networking/squid.nix</literal></para></listitem> - <listitem><para><literal>services/networking/tinydns.nix</literal></para></listitem> - <listitem><para><literal>services/networking/xrdp.nix</literal></para></listitem> - <listitem><para><literal>services/security/shibboleth-sp.nix</literal></para></listitem> - <listitem><para><literal>services/security/sks.nix</literal></para></listitem> - <listitem><para><literal>services/security/sshguard.nix</literal></para></listitem> - <listitem><para><literal>services/security/torify.nix</literal></para></listitem> - <listitem><para><literal>services/security/usbguard.nix</literal></para></listitem> - <listitem><para><literal>services/security/vault.nix</literal></para></listitem> - <listitem><para><literal>services/system/earlyoom.nix</literal></para></listitem> - <listitem><para><literal>services/system/saslauthd.nix</literal></para></listitem> - <listitem><para><literal>services/web-apps/nexus.nix</literal></para></listitem> - <listitem><para><literal>services/web-apps/pgpkeyserver-lite.nix</literal></para></listitem> - <listitem><para><literal>services/web-apps/piwik.nix</literal></para></listitem> - <listitem><para><literal>services/web-servers/lighttpd/collectd.nix</literal></para></listitem> - <listitem><para><literal>services/web-servers/minio.nix</literal></para></listitem> - <listitem><para><literal>services/x11/display-managers/xpra.nix</literal></para></listitem> - <listitem><para><literal>services/x11/xautolock.nix</literal></para></listitem> - <listitem><para><literal>tasks/filesystems/bcachefs.nix</literal></para></listitem> - <listitem><para><literal>tasks/powertop.nix</literal></para></listitem> -</itemizedlist> + <itemizedlist> + <listitem> + <para> + <literal>config/fonts/fontconfig-penultimate.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>config/fonts/fontconfig-ultimate.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>config/terminfo.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>hardware/sensor/iio.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>hardware/nitrokey.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>hardware/raid/hpsa.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>programs/browserpass.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>programs/gnupg.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>programs/qt5ct.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>programs/slock.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>programs/thefuck.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>security/auditd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>security/lock-kernel-modules.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>service-managers/docker.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>service-managers/trivial.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/admin/salt/master.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/admin/salt/minion.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/audio/slimserver.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/cluster/kubernetes/default.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/cluster/kubernetes/dns.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/cluster/kubernetes/dashboard.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/continuous-integration/hail.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/databases/clickhouse.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/databases/postage.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/desktops/gnome3/gnome-disks.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/desktops/gnome3/gpaste.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/logging/SystemdJournal2Gelf.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/logging/heartbeat.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/logging/journalwatch.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/logging/syslogd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/mail/mailhog.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/mail/nullmailer.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/airsonic.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/autorandr.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/exhibitor.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/fstrim.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/gollum.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/irkerd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/jackett.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/radarr.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/misc/snapper.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/osquery.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/prometheus/collectd-exporter.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/monitoring/prometheus/fritzbox-exporter.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/network-filesystems/kbfs.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/dnscache.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/fireqos.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/iwd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/keepalived/default.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/keybase.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/lldpd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/matterbridge.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/squid.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/tinydns.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/networking/xrdp.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/security/shibboleth-sp.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/security/sks.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/security/sshguard.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/security/torify.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/security/usbguard.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/security/vault.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/system/earlyoom.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/system/saslauthd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/web-apps/nexus.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/web-apps/pgpkeyserver-lite.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/web-apps/piwik.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/web-servers/lighttpd/collectd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/web-servers/minio.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/x11/display-managers/xpra.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>services/x11/xautolock.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>tasks/filesystems/bcachefs.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>tasks/powertop.nix</literal> + </para> + </listitem> + </itemizedlist> + </section> -</section> -<section xmlns="http://docbook.org/ns/docbook" + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-release-17.09-incompatibilities"> + <title>Backward Incompatibilities</title> -<title>Backward Incompatibilities</title> - -<para>When upgrading from a previous release, please be aware of the -following incompatible changes:</para> + <para> + When upgrading from a previous release, please be aware of the following + incompatible changes: + </para> -<itemizedlist> - <listitem> - <para> - <emphasis role="strong"> - In an Qemu-based virtualization environment, the network interface - names changed from i.e. <literal>enp0s3</literal> to - <literal>ens3</literal>. - </emphasis> - </para> - <para> - This is due to a kernel configuration change. The new naming - is consistent with those of other Linux distributions with - systemd. See - <link xlink:href="https://github.com/NixOS/nixpkgs/issues/29197">#29197</link> - for more information. - </para> - <para> - A machine is affected if the <literal>virt-what</literal> tool - either returns <literal>qemu</literal> or - <literal>kvm</literal> <emphasis>and</emphasis> has - interface names used in any part of its NixOS configuration, - in particular if a static network configuration with - <literal>networking.interfaces</literal> is used. - </para> - <para> - Before rebooting affected machines, please ensure: - <itemizedlist> - <listitem> - <para> - Change the interface names in your NixOS configuration. - The first interface will be called <literal>ens3</literal>, - the second one <literal>ens8</literal> and starting from there - incremented by 1. - </para> - </listitem> - <listitem> - <para> - After changing the interface names, rebuild your system with - <literal>nixos-rebuild boot</literal> to activate the new - configuration after a reboot. If you switch to the new - configuration right away you might lose network connectivity! - If using <literal>nixops</literal>, deploy with - <literal>nixops deploy --force-reboot</literal>. - </para> - </listitem> - </itemizedlist> - </para> - </listitem> - <listitem> - <para> - The following changes apply if the <literal>stateVersion</literal> is changed to 17.09 or higher. - For <literal>stateVersion = "17.03"</literal> or lower the old behavior is preserved. + <itemizedlist> + <listitem> + <para> + <emphasis role="strong"> In an Qemu-based virtualization environment, the + network interface names changed from i.e. <literal>enp0s3</literal> to + <literal>ens3</literal>. </emphasis> </para> - <itemizedlist> - <listitem> - <para> - The <literal>postgres</literal> default version was changed from 9.5 to 9.6. - </para> - </listitem> - <listitem> - <para> - The <literal>postgres</literal> superuser name has changed from <literal>root</literal> to <literal>postgres</literal> to more closely follow what other Linux distributions are doing. - </para> - </listitem> - <listitem> - <para> - The <literal>postgres</literal> default <literal>dataDir</literal> has changed from <literal>/var/db/postgres</literal> to <literal>/var/lib/postgresql/$psqlSchema</literal> where $psqlSchema is 9.6 for example. - </para> - </listitem> + <para> + This is due to a kernel configuration change. The new naming is consistent + with those of other Linux distributions with systemd. See + <link xlink:href="https://github.com/NixOS/nixpkgs/issues/29197">#29197</link> + for more information. + </para> + <para> + A machine is affected if the <literal>virt-what</literal> tool either + returns <literal>qemu</literal> or <literal>kvm</literal> + <emphasis>and</emphasis> has interface names used in any part of its NixOS + configuration, in particular if a static network configuration with + <literal>networking.interfaces</literal> is used. + </para> + <para> + Before rebooting affected machines, please ensure: + <itemizedlist> <listitem> - <para> - The <literal>mysql</literal> default <literal>dataDir</literal> has changed from <literal>/var/mysql</literal> to <literal>/var/lib/mysql</literal>. - </para> + <para> + Change the interface names in your NixOS configuration. The first + interface will be called <literal>ens3</literal>, the second one + <literal>ens8</literal> and starting from there incremented by 1. + </para> </listitem> <listitem> - <para> - Radicale's default package has changed from 1.x to 2.x. Instructions to migrate can be found <link xlink:href="http://radicale.org/1to2/"> here </link>. It is also possible to use the newer version by setting the <literal>package</literal> to <literal>radicale2</literal>, which is done automatically when <literal>stateVersion</literal> is 17.09 or higher. The <literal>extraArgs</literal> option has been added to allow passing the data migration arguments specified in the instructions; see the <filename xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/radicale.nix">radicale.nix</filename> NixOS test for an example migration. - </para> + <para> + After changing the interface names, rebuild your system with + <literal>nixos-rebuild boot</literal> to activate the new configuration + after a reboot. If you switch to the new configuration right away you + might lose network connectivity! If using <literal>nixops</literal>, + deploy with <literal>nixops deploy --force-reboot</literal>. + </para> </listitem> + </itemizedlist> + </para> + </listitem> + <listitem> + <para> + The following changes apply if the <literal>stateVersion</literal> is + changed to 17.09 or higher. For <literal>stateVersion = "17.03"</literal> + or lower the old behavior is preserved. + </para> + <itemizedlist> + <listitem> + <para> + The <literal>postgres</literal> default version was changed from 9.5 to + 9.6. + </para> + </listitem> + <listitem> + <para> + The <literal>postgres</literal> superuser name has changed from + <literal>root</literal> to <literal>postgres</literal> to more closely + follow what other Linux distributions are doing. + </para> + </listitem> + <listitem> + <para> + The <literal>postgres</literal> default <literal>dataDir</literal> has + changed from <literal>/var/db/postgres</literal> to + <literal>/var/lib/postgresql/$psqlSchema</literal> where $psqlSchema is + 9.6 for example. + </para> + </listitem> + <listitem> + <para> + The <literal>mysql</literal> default <literal>dataDir</literal> has + changed from <literal>/var/mysql</literal> to + <literal>/var/lib/mysql</literal>. + </para> + </listitem> + <listitem> + <para> + Radicale's default package has changed from 1.x to 2.x. Instructions to + migrate can be found <link xlink:href="http://radicale.org/1to2/"> here + </link>. It is also possible to use the newer version by setting the + <literal>package</literal> to <literal>radicale2</literal>, which is + done automatically when <literal>stateVersion</literal> is 17.09 or + higher. The <literal>extraArgs</literal> option has been added to allow + passing the data migration arguments specified in the instructions; see + the + <filename xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/radicale.nix">radicale.nix</filename> + NixOS test for an example migration. + </para> + </listitem> </itemizedlist> - </listitem> - <listitem> + </listitem> + <listitem> <para> - The <literal>aiccu</literal> package was removed. This is due to SixXS - <link xlink:href="https://www.sixxs.net/main/"> sunsetting</link> its IPv6 tunnel. + The <literal>aiccu</literal> package was removed. This is due to SixXS + <link xlink:href="https://www.sixxs.net/main/"> sunsetting</link> its IPv6 + tunnel. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - The <literal>fanctl</literal> package and <literal>fan</literal> module - have been removed due to the developers not upstreaming their iproute2 - patches and lagging with compatibility to recent iproute2 versions. + The <literal>fanctl</literal> package and <literal>fan</literal> module + have been removed due to the developers not upstreaming their iproute2 + patches and lagging with compatibility to recent iproute2 versions. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - Top-level <literal>idea</literal> package collection was renamed. - All JetBrains IDEs are now at <literal>jetbrains</literal>. + Top-level <literal>idea</literal> package collection was renamed. All + JetBrains IDEs are now at <literal>jetbrains</literal>. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - <literal>flexget</literal>'s state database cannot be upgraded to its - new internal format, requiring removal of any existing - <literal>db-config.sqlite</literal> which will be automatically recreated. + <literal>flexget</literal>'s state database cannot be upgraded to its new + internal format, requiring removal of any existing + <literal>db-config.sqlite</literal> which will be automatically recreated. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - The <literal>ipfs</literal> service now doesn't ignore the <literal>dataDir</literal> option anymore. If you've ever set this option to anything other than the default you'll have to either unset it (so the default gets used) or migrate the old data manually with + The <literal>ipfs</literal> service now doesn't ignore the + <literal>dataDir</literal> option anymore. If you've ever set this option + to anything other than the default you'll have to either unset it (so the + default gets used) or migrate the old data manually with <programlisting> dataDir=<valueOfDataDir> mv /var/lib/ipfs/.ipfs/* $dataDir rmdir /var/lib/ipfs/.ipfs </programlisting> </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - The <literal>caddy</literal> service was previously using an extra - <literal>.caddy</literal> directory in the data directory specified - with the <literal>dataDir</literal> option. The contents of the - <literal>.caddy</literal> directory are now expected to be in the - <literal>dataDir</literal>. + The <literal>caddy</literal> service was previously using an extra + <literal>.caddy</literal> directory in the data directory specified with + the <literal>dataDir</literal> option. The contents of the + <literal>.caddy</literal> directory are now expected to be in the + <literal>dataDir</literal>. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - The <literal>ssh-agent</literal> user service is not started by default - anymore. Use <literal>programs.ssh.startAgent</literal> to enable it if - needed. There is also a new <literal>programs.gnupg.agent</literal> - module that creates a <literal>gpg-agent</literal> user service. It can - also serve as a SSH agent if <literal>enableSSHSupport</literal> is set. + The <literal>ssh-agent</literal> user service is not started by default + anymore. Use <literal>programs.ssh.startAgent</literal> to enable it if + needed. There is also a new <literal>programs.gnupg.agent</literal> module + that creates a <literal>gpg-agent</literal> user service. It can also + serve as a SSH agent if <literal>enableSSHSupport</literal> is set. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - The <literal>services.tinc.networks.<name>.listenAddress</literal> - option had a misleading name that did not correspond to its behavior. It - now correctly defines the ip to listen for incoming connections on. To - keep the previous behaviour, use - <literal>services.tinc.networks.<name>.bindToAddress</literal> - instead. Refer to the description of the options for more details. + The <literal>services.tinc.networks.<name>.listenAddress</literal> + option had a misleading name that did not correspond to its behavior. It + now correctly defines the ip to listen for incoming connections on. To + keep the previous behaviour, use + <literal>services.tinc.networks.<name>.bindToAddress</literal> + instead. Refer to the description of the options for more details. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - <literal>tlsdate</literal> package and module were removed. This is due to the project - being dead and not building with openssl 1.1. + <literal>tlsdate</literal> package and module were removed. This is due to + the project being dead and not building with openssl 1.1. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - <literal>wvdial</literal> package and module were removed. This is due to the project - being dead and not building with openssl 1.1. + <literal>wvdial</literal> package and module were removed. This is due to + the project being dead and not building with openssl 1.1. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - <literal>cc-wrapper</literal>'s setup-hook now exports a number of - environment variables corresponding to binutils binaries, - (e.g. <envar>LD</envar>, <envar>STRIP</envar>, <envar>RANLIB</envar>, - etc). This is done to prevent packages' build systems guessing, which is - harder to predict, especially when cross-compiling. However, some packages - have broken due to this—their build systems either not supporting, or - claiming to support without adequate testing, taking such environment - variables as parameters. + <literal>cc-wrapper</literal>'s setup-hook now exports a number of + environment variables corresponding to binutils binaries, (e.g. + <envar>LD</envar>, <envar>STRIP</envar>, <envar>RANLIB</envar>, etc). This + is done to prevent packages' build systems guessing, which is harder to + predict, especially when cross-compiling. However, some packages have + broken due to this—their build systems either not supporting, or + claiming to support without adequate testing, taking such environment + variables as parameters. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - <literal>services.firefox.syncserver</literal> now runs by default as a - non-root user. To accomodate this change, the default sqlite database - location has also been changed. Migration should work automatically. - Refer to the description of the options for more details. + <literal>services.firefox.syncserver</literal> now runs by default as a + non-root user. To accomodate this change, the default sqlite database + location has also been changed. Migration should work automatically. Refer + to the description of the options for more details. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - The <literal>compiz</literal> window manager and package was - removed. The system support had been broken for several years. + The <literal>compiz</literal> window manager and package was removed. The + system support had been broken for several years. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - Touchpad support should now be enabled through - <literal>libinput</literal> as <literal>synaptics</literal> is - now deprecated. See the option - <literal>services.xserver.libinput.enable</literal>. + Touchpad support should now be enabled through <literal>libinput</literal> + as <literal>synaptics</literal> is now deprecated. See the option + <literal>services.xserver.libinput.enable</literal>. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - grsecurity/PaX support has been dropped, following upstream's - decision to cease free support. See - <link xlink:href="https://grsecurity.net/passing_the_baton.php"> - upstream's announcement</link> for more information. - No complete replacement for grsecurity/PaX is available presently. + grsecurity/PaX support has been dropped, following upstream's decision to + cease free support. See + <link xlink:href="https://grsecurity.net/passing_the_baton.php"> + upstream's announcement</link> for more information. No complete + replacement for grsecurity/PaX is available presently. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - <literal>services.mysql</literal> now has declarative - configuration of databases and users with the <literal>ensureDatabases</literal> and - <literal>ensureUsers</literal> options. + <literal>services.mysql</literal> now has declarative configuration of + databases and users with the <literal>ensureDatabases</literal> and + <literal>ensureUsers</literal> options. </para> - <para> - These options will never delete existing databases and users, - especially not when the value of the options are changed. + These options will never delete existing databases and users, especially + not when the value of the options are changed. </para> - <para> - The MySQL users will be identified using - <link xlink:href="https://mariadb.com/kb/en/library/authentication-plugin-unix-socket/"> - Unix socket authentication</link>. This authenticates the - Unix user with the same name only, and that without the need - for a password. + The MySQL users will be identified using + <link xlink:href="https://mariadb.com/kb/en/library/authentication-plugin-unix-socket/"> + Unix socket authentication</link>. This authenticates the Unix user with + the same name only, and that without the need for a password. </para> - <para> - If you have previously created a MySQL <literal>root</literal> - user <emphasis>with a password</emphasis>, you will need to add - <literal>root</literal> user for unix socket authentication - before using the new options. This can be done by running the - following SQL script: - + If you have previously created a MySQL <literal>root</literal> user + <emphasis>with a password</emphasis>, you will need to add + <literal>root</literal> user for unix socket authentication before using + the new options. This can be done by running the following SQL script: <programlisting language="sql"> CREATE USER 'root'@'%' IDENTIFIED BY ''; GRANT ALL PRIVILEGES ON *.* TO 'root'@'%' WITH GRANT OPTION; @@ -418,194 +717,183 @@ FLUSH PRIVILEGES; -- DROP USER 'root'@'localhost'; </programlisting> </para> - </listitem> - - <listitem> + </listitem> + <listitem> <para> - <literal>services.mysqlBackup</literal> now works by default - without any user setup, including for users other than - <literal>mysql</literal>. + <literal>services.mysqlBackup</literal> now works by default without any + user setup, including for users other than <literal>mysql</literal>. </para> - <para> - By default, the <literal>mysql</literal> user is no longer the - user which performs the backup. Instead a system account - <literal>mysqlbackup</literal> is used. + By default, the <literal>mysql</literal> user is no longer the user which + performs the backup. Instead a system account + <literal>mysqlbackup</literal> is used. </para> - <para> - The <literal>mysqlBackup</literal> service is also now using - systemd timers instead of <literal>cron</literal>. + The <literal>mysqlBackup</literal> service is also now using systemd + timers instead of <literal>cron</literal>. </para> - <para> - Therefore, the <literal>services.mysqlBackup.period</literal> - option no longer exists, and has been replaced with - <literal>services.mysqlBackup.calendar</literal>, which is in - the format of <link + Therefore, the <literal>services.mysqlBackup.period</literal> option no + longer exists, and has been replaced with + <literal>services.mysqlBackup.calendar</literal>, which is in the format + of + <link xlink:href="https://www.freedesktop.org/software/systemd/man/systemd.time.html#Calendar%20Events">systemd.time(7)</link>. </para> - <para> - If you expect to be sent an e-mail when the backup fails, - consider using a script which monitors the systemd journal for - errors. Regretfully, at present there is no built-in - functionality for this. + If you expect to be sent an e-mail when the backup fails, consider using a + script which monitors the systemd journal for errors. Regretfully, at + present there is no built-in functionality for this. </para> - <para> - You can check that backups still work by running - <command>systemctl start mysql-backup</command> then - <command>systemctl status mysql-backup</command>. + You can check that backups still work by running <command>systemctl start + mysql-backup</command> then <command>systemctl status + mysql-backup</command>. </para> - </listitem> - - <listitem> + </listitem> + <listitem> <para> - Templated systemd services e.g <literal>container@name</literal> are - now handled currectly when switching to a new configuration, resulting - in them being reloaded. + Templated systemd services e.g <literal>container@name</literal> are now + handled currectly when switching to a new configuration, resulting in them + being reloaded. </para> - </listitem> - - <listitem> - <para>Steam: the <literal>newStdcpp</literal> parameter - was removed and should not be needed anymore.</para> - </listitem> - - <listitem> + </listitem> + <listitem> <para> - Redis has been updated to version 4 which mandates a cluster - mass-restart, due to changes in the network handling, in order - to ensure compatibility with networks NATing traffic. + Steam: the <literal>newStdcpp</literal> parameter was removed and should + not be needed anymore. </para> - </listitem> -</itemizedlist> + </listitem> + <listitem> + <para> + Redis has been updated to version 4 which mandates a cluster mass-restart, + due to changes in the network handling, in order to ensure compatibility + with networks NATing traffic. + </para> + </listitem> + </itemizedlist> + </section> -</section> -<section xmlns="http://docbook.org/ns/docbook" + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-release-17.09-notable-changes"> + <title>Other Notable Changes</title> -<title>Other Notable Changes</title> - -<itemizedlist> - - <listitem> + <itemizedlist> + <listitem> <para> - Modules can now be disabled by using <link + Modules can now be disabled by using + <link xlink:href="https://nixos.org/nixpkgs/manual/#sec-replace-modules"> - disabledModules</link>, allowing another to take it's place. This can be - used to import a set of modules from another channel while keeping the - rest of the system on a stable release. + disabledModules</link>, allowing another to take it's place. This can be + used to import a set of modules from another channel while keeping the + rest of the system on a stable release. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - Updated to FreeType 2.7.1, including a new TrueType engine. - The new engine replaces the Infinality engine which was the default in - NixOS. The default font rendering settings are now provided by - fontconfig-penultimate, replacing fontconfig-ultimate; the new defaults - are less invasive and provide rendering that is more consistent with - other systems and hopefully with each font designer's intent. Some - system-wide configuration has been removed from the Fontconfig NixOS - module where user Fontconfig settings are available. + Updated to FreeType 2.7.1, including a new TrueType engine. The new engine + replaces the Infinality engine which was the default in NixOS. The default + font rendering settings are now provided by fontconfig-penultimate, + replacing fontconfig-ultimate; the new defaults are less invasive and + provide rendering that is more consistent with other systems and hopefully + with each font designer's intent. Some system-wide configuration has been + removed from the Fontconfig NixOS module where user Fontconfig settings + are available. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - ZFS/SPL have been updated to 0.7.0, <literal>zfsUnstable, splUnstable</literal> - have therefore been removed. + ZFS/SPL have been updated to 0.7.0, <literal>zfsUnstable, + splUnstable</literal> have therefore been removed. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - The <option>time.timeZone</option> option now allows the value - <literal>null</literal> in addition to timezone strings. This value - allows changing the timezone of a system imperatively using - <command>timedatectl set-timezone</command>. The default timezone - is still UTC. + The <option>time.timeZone</option> option now allows the value + <literal>null</literal> in addition to timezone strings. This value allows + changing the timezone of a system imperatively using <command>timedatectl + set-timezone</command>. The default timezone is still UTC. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - Nixpkgs overlays may now be specified with a file as well as a directory. The - value of <literal><nixpkgs-overlays></literal> may be a file, and - <filename>~/.config/nixpkgs/overlays.nix</filename> can be used instead of the - <filename>~/.config/nixpkgs/overlays</filename> directory. + Nixpkgs overlays may now be specified with a file as well as a directory. + The value of <literal><nixpkgs-overlays></literal> may be a file, and + <filename>~/.config/nixpkgs/overlays.nix</filename> can be used instead of + the <filename>~/.config/nixpkgs/overlays</filename> directory. </para> <para> - See the overlays chapter of the Nixpkgs manual for more details. + See the overlays chapter of the Nixpkgs manual for more details. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - Definitions for <filename>/etc/hosts</filename> can now be specified - declaratively with <literal>networking.hosts</literal>. + Definitions for <filename>/etc/hosts</filename> can now be specified + declaratively with <literal>networking.hosts</literal>. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - Two new options have been added to the installer loader, in addition - to the default having changed. The kernel log verbosity has been lowered - to the upstream default for the default options, in order to not spam - the console when e.g. joining a network. + Two new options have been added to the installer loader, in addition to + the default having changed. The kernel log verbosity has been lowered to + the upstream default for the default options, in order to not spam the + console when e.g. joining a network. </para> <para> - This therefore leads to adding a new <literal>debug</literal> option - to set the log level to the previous verbose mode, to make debugging - easier, but still accessible easily. + This therefore leads to adding a new <literal>debug</literal> option to + set the log level to the previous verbose mode, to make debugging easier, + but still accessible easily. </para> <para> - Additionally a <literal>copytoram</literal> option has been added, - which makes it possible to remove the install medium after booting. - This allows tethering from your phone after booting from it. + Additionally a <literal>copytoram</literal> option has been added, which + makes it possible to remove the install medium after booting. This allows + tethering from your phone after booting from it. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - <literal>services.gitlab-runner.configOptions</literal> has been added - to specify the configuration of gitlab-runners declaratively. + <literal>services.gitlab-runner.configOptions</literal> has been added to + specify the configuration of gitlab-runners declaratively. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - <literal>services.jenkins.plugins</literal> has been added - to install plugins easily, this can be generated with jenkinsPlugins2nix. + <literal>services.jenkins.plugins</literal> has been added to install + plugins easily, this can be generated with jenkinsPlugins2nix. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - <literal>services.postfix.config</literal> has been added - to specify the main.cf with NixOS options. Additionally other options - have been added to the postfix module and has been improved further. + <literal>services.postfix.config</literal> has been added to specify the + main.cf with NixOS options. Additionally other options have been added to + the postfix module and has been improved further. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - The GitLab package and module have been updated to the latest 10.0 - release. + The GitLab package and module have been updated to the latest 10.0 + release. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - The <literal>systemd-boot</literal> boot loader now lists the NixOS - version, kernel version and build date of all bootable generations. + The <literal>systemd-boot</literal> boot loader now lists the NixOS + version, kernel version and build date of all bootable generations. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - The dnscrypt-proxy service now defaults to using a random upstream resolver, - selected from the list of public non-logging resolvers with DNSSEC support. - Existing configurations can be migrated to this mode of operation by - omitting the <option>services.dnscrypt-proxy.resolverName</option> option - or setting it to <literal>"random"</literal>. + The dnscrypt-proxy service now defaults to using a random upstream + resolver, selected from the list of public non-logging resolvers with + DNSSEC support. Existing configurations can be migrated to this mode of + operation by omitting the + <option>services.dnscrypt-proxy.resolverName</option> option or setting it + to <literal>"random"</literal>. </para> - </listitem> - -</itemizedlist> - -</section> + </listitem> + </itemizedlist> + </section> </section> diff --git a/nixos/doc/manual/release-notes/rl-1803.xml b/nixos/doc/manual/release-notes/rl-1803.xml index 9221c2951ed2..c14679eea071 100644 --- a/nixos/doc/manual/release-notes/rl-1803.xml +++ b/nixos/doc/manual/release-notes/rl-1803.xml @@ -3,532 +3,822 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-release-18.03"> + <title>Release 18.03 (“Impala”, 2018/04/04)</title> -<title>Release 18.03 (“Impala”, 2018/04/04)</title> - -<section xmlns="http://docbook.org/ns/docbook" + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-release-18.03-highlights"> + <title>Highlights</title> -<title>Highlights</title> - -<para>In addition to numerous new and upgraded packages, this release -has the following highlights: </para> - -<itemizedlist> + <para> + In addition to numerous new and upgraded packages, this release has the + following highlights: + </para> - <listitem> + <itemizedlist> + <listitem> <para> - End of support is planned for end of October 2018, handing over to 18.09. + End of support is planned for end of October 2018, handing over to 18.09. </para> - </listitem> - - <listitem> + </listitem> + <listitem> <para> - Platform support: x86_64-linux and x86_64-darwin since release time (the latter isn't NixOS, really). - Binaries for aarch64-linux are available, but no channel exists yet, as it's waiting for some test fixes, etc. + Platform support: x86_64-linux and x86_64-darwin since release time (the + latter isn't NixOS, really). Binaries for aarch64-linux are available, but + no channel exists yet, as it's waiting for some test fixes, etc. </para> - </listitem> - - <listitem> + </listitem> + <listitem> <para> - Nix now defaults to 2.0; see its - <link xlink:href="https://nixos.org/nix/manual/#ssec-relnotes-2.0">release notes</link>. + Nix now defaults to 2.0; see its + <link xlink:href="https://nixos.org/nix/manual/#ssec-relnotes-2.0">release + notes</link>. </para> - </listitem> - - <listitem> + </listitem> + <listitem> <para> - Core version changes: linux: 4.9 -> 4.14, glibc: 2.25 -> 2.26, gcc: 6 -> 7, systemd: 234 -> 237. + Core version changes: linux: 4.9 -> 4.14, glibc: 2.25 -> 2.26, gcc: 6 -> + 7, systemd: 234 -> 237. </para> - </listitem> - - <listitem> + </listitem> + <listitem> <para> - Desktop version changes: gnome: 3.24 -> 3.26, (KDE) plasma-desktop: 5.10 -> 5.12. + Desktop version changes: gnome: 3.24 -> 3.26, (KDE) plasma-desktop: 5.10 + -> 5.12. </para> - </listitem> - - <listitem> - <para> - MariaDB 10.2, updated from 10.1, is now the default MySQL implementation. While upgrading a few changes - have been made to the infrastructure involved: - <itemizedlist> - <listitem> - <para> - <literal>libmysql</literal> has been deprecated, please use <literal>mysql.connector-c</literal> - instead, a compatibility passthru has been added to the MySQL packages. - </para> - </listitem> - <listitem> - <para> - The <literal>mysql57</literal> package has a new <literal>static</literal> output containing - the static libraries including <literal>libmysqld.a</literal> - </para> - </listitem> - </itemizedlist> - </para> - </listitem> - - <listitem> - <para>PHP now defaults to PHP 7.2, updated from 7.1.</para> - </listitem> -</itemizedlist> + </listitem> + <listitem> + <para> + MariaDB 10.2, updated from 10.1, is now the default MySQL implementation. + While upgrading a few changes have been made to the infrastructure + involved: + <itemizedlist> + <listitem> + <para> + <literal>libmysql</literal> has been deprecated, please use + <literal>mysql.connector-c</literal> instead, a compatibility passthru + has been added to the MySQL packages. + </para> + </listitem> + <listitem> + <para> + The <literal>mysql57</literal> package has a new + <literal>static</literal> output containing the static libraries + including <literal>libmysqld.a</literal> + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + <listitem> + <para> + PHP now defaults to PHP 7.2, updated from 7.1. + </para> + </listitem> + </itemizedlist> + </section> -</section> -<section xmlns="http://docbook.org/ns/docbook" + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-release-18.03-new-services"> + <title>New Services</title> -<title>New Services</title> - -<para>The following new services were added since the last release:</para> + <para> + The following new services were added since the last release: + </para> -<itemizedlist> - <listitem><para><literal>./config/krb5/default.nix</literal></para></listitem> - <listitem><para><literal>./hardware/digitalbitbox.nix</literal></para></listitem> - <listitem><para><literal>./misc/label.nix</literal></para></listitem> - <listitem><para><literal>./programs/ccache.nix</literal></para></listitem> - <listitem><para><literal>./programs/criu.nix</literal></para></listitem> - <listitem><para><literal>./programs/digitalbitbox/default.nix</literal></para></listitem> - <listitem><para><literal>./programs/less.nix</literal></para></listitem> - <listitem><para><literal>./programs/npm.nix</literal></para></listitem> - <listitem><para><literal>./programs/plotinus.nix</literal></para></listitem> - <listitem><para><literal>./programs/rootston.nix</literal></para></listitem> - <listitem><para><literal>./programs/systemtap.nix</literal></para></listitem> - <listitem><para><literal>./programs/sway.nix</literal></para></listitem> - <listitem><para><literal>./programs/udevil.nix</literal></para></listitem> - <listitem><para><literal>./programs/way-cooler.nix</literal></para></listitem> - <listitem><para><literal>./programs/yabar.nix</literal></para></listitem> - <listitem><para><literal>./programs/zsh/zsh-autoenv.nix</literal></para></listitem> - <listitem><para><literal>./services/backup/borgbackup.nix</literal></para></listitem> - <listitem><para><literal>./services/backup/crashplan-small-business.nix</literal></para></listitem> - <listitem><para><literal>./services/desktops/dleyna-renderer.nix</literal></para></listitem> - <listitem><para><literal>./services/desktops/dleyna-server.nix</literal></para></listitem> - <listitem><para><literal>./services/desktops/pipewire.nix</literal></para></listitem> - <listitem><para><literal>./services/desktops/gnome3/chrome-gnome-shell.nix</literal></para></listitem> - <listitem><para><literal>./services/desktops/gnome3/tracker-miners.nix</literal></para></listitem> - <listitem><para><literal>./services/hardware/fwupd.nix</literal></para></listitem> - <listitem><para><literal>./services/hardware/interception-tools.nix</literal></para></listitem> - <listitem><para><literal>./services/hardware/u2f.nix</literal></para></listitem> - <listitem><para><literal>./services/hardware/usbmuxd.nix</literal></para></listitem> - <listitem><para><literal>./services/mail/clamsmtp.nix</literal></para></listitem> - <listitem><para><literal>./services/mail/dkimproxy-out.nix</literal></para></listitem> - <listitem><para><literal>./services/mail/pfix-srsd.nix</literal></para></listitem> - <listitem><para><literal>./services/misc/gitea.nix</literal></para></listitem> - <listitem><para><literal>./services/misc/home-assistant.nix</literal></para></listitem> - <listitem><para><literal>./services/misc/ihaskell.nix</literal></para></listitem> - <listitem><para><literal>./services/misc/logkeys.nix</literal></para></listitem> - <listitem><para><literal>./services/misc/novacomd.nix</literal></para></listitem> - <listitem><para><literal>./services/misc/osrm.nix</literal></para></listitem> - <listitem><para><literal>./services/misc/plexpy.nix</literal></para></listitem> - <listitem><para><literal>./services/misc/pykms.nix</literal></para></listitem> - <listitem><para><literal>./services/misc/tzupdate.nix</literal></para></listitem> - <listitem><para><literal>./services/monitoring/fusion-inventory.nix</literal></para></listitem> - <listitem><para><literal>./services/monitoring/prometheus/exporters.nix</literal></para></listitem> - <listitem><para><literal>./services/network-filesystems/beegfs.nix</literal></para></listitem> - <listitem><para><literal>./services/network-filesystems/davfs2.nix</literal></para></listitem> - <listitem><para><literal>./services/network-filesystems/openafs/client.nix</literal></para></listitem> - <listitem><para><literal>./services/network-filesystems/openafs/server.nix</literal></para></listitem> - <listitem><para><literal>./services/network-filesystems/ceph.nix</literal></para></listitem> - <listitem><para><literal>./services/networking/aria2.nix</literal></para></listitem> - <listitem><para><literal>./services/networking/monero.nix</literal></para></listitem> - <listitem><para><literal>./services/networking/nghttpx/default.nix</literal></para></listitem> - <listitem><para><literal>./services/networking/nixops-dns.nix</literal></para></listitem> - <listitem><para><literal>./services/networking/rxe.nix</literal></para></listitem> - <listitem><para><literal>./services/networking/stunnel.nix</literal></para></listitem> - <listitem><para><literal>./services/web-apps/matomo.nix</literal></para></listitem> - <listitem><para><literal>./services/web-apps/restya-board.nix</literal></para></listitem> - <listitem><para><literal>./services/web-servers/mighttpd2.nix</literal></para></listitem> - <listitem><para><literal>./services/x11/fractalart.nix</literal></para></listitem> - <listitem><para><literal>./system/boot/binfmt.nix</literal></para></listitem> - <listitem><para><literal>./system/boot/grow-partition.nix</literal></para></listitem> - <listitem><para><literal>./tasks/filesystems/ecryptfs.nix</literal></para></listitem> - <listitem><para><literal>./virtualisation/hyperv-guest.nix</literal></para></listitem> -</itemizedlist> + <itemizedlist> + <listitem> + <para> + <literal>./config/krb5/default.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./hardware/digitalbitbox.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./misc/label.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/ccache.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/criu.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/digitalbitbox/default.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/less.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/npm.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/plotinus.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/rootston.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/systemtap.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/sway.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/udevil.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/way-cooler.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/yabar.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./programs/zsh/zsh-autoenv.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/backup/borgbackup.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/backup/crashplan-small-business.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/desktops/dleyna-renderer.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/desktops/dleyna-server.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/desktops/pipewire.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/desktops/gnome3/chrome-gnome-shell.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/desktops/gnome3/tracker-miners.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/hardware/fwupd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/hardware/interception-tools.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/hardware/u2f.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/hardware/usbmuxd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/mail/clamsmtp.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/mail/dkimproxy-out.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/mail/pfix-srsd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/misc/gitea.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/misc/home-assistant.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/misc/ihaskell.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/misc/logkeys.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/misc/novacomd.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/misc/osrm.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/misc/plexpy.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/misc/pykms.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/misc/tzupdate.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/monitoring/fusion-inventory.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/monitoring/prometheus/exporters.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/network-filesystems/beegfs.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/network-filesystems/davfs2.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/network-filesystems/openafs/client.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/network-filesystems/openafs/server.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/network-filesystems/ceph.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/networking/aria2.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/networking/monero.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/networking/nghttpx/default.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/networking/nixops-dns.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/networking/rxe.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/networking/stunnel.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/web-apps/matomo.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/web-apps/restya-board.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/web-servers/mighttpd2.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./services/x11/fractalart.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./system/boot/binfmt.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./system/boot/grow-partition.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./tasks/filesystems/ecryptfs.nix</literal> + </para> + </listitem> + <listitem> + <para> + <literal>./virtualisation/hyperv-guest.nix</literal> + </para> + </listitem> + </itemizedlist> + </section> -</section> -<section xmlns="http://docbook.org/ns/docbook" + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-release-18.03-incompatibilities"> + <title>Backward Incompatibilities</title> -<title>Backward Incompatibilities</title> - -<para>When upgrading from a previous release, please be aware of the -following incompatible changes:</para> - -<itemizedlist> - <listitem> - <para> - <literal>sound.enable</literal> now defaults to false. - </para> - </listitem> - <listitem> - <para> - Dollar signs in options under <option>services.postfix</option> are - passed verbatim to Postfix, which will interpret them as the beginning of - a parameter expression. This was already true for string-valued options - in the previous release, but not for list-valued options. If you need to - pass literal dollar signs through Postfix, double them. - </para> - </listitem> - <listitem> - <para> - The <literal>postage</literal> package (for web-based PostgreSQL - administration) has been renamed to <literal>pgmanage</literal>. The - corresponding module has also been renamed. To migrate please rename all - <option>services.postage</option> options to - <option>services.pgmanage</option>. - </para> - </listitem> - <listitem> - <para> - Package attributes starting with a digit have been prefixed with an - underscore sign. This is to avoid quoting in the configuration and - other issues with command-line tools like <literal>nix-env</literal>. - The change affects the following packages: - <itemizedlist> - <listitem> - <para><literal>2048-in-terminal</literal> → <literal>_2048-in-terminal</literal></para> - </listitem> - <listitem> - <para><literal>90secondportraits</literal> → <literal>_90secondportraits</literal></para> - </listitem> - <listitem> - <para><literal>2bwm</literal> → <literal>_2bwm</literal></para> - </listitem> - <listitem> - <para><literal>389-ds-base</literal> → <literal>_389-ds-base</literal></para> - </listitem> - </itemizedlist> - </para> - </listitem> - <listitem> - <para> - <emphasis role="strong"> - The OpenSSH service no longer enables support for DSA keys by default, - which could cause a system lock out. Update your keys or, unfavorably, - re-enable DSA support manually. - </emphasis> - </para> + <para> + When upgrading from a previous release, please be aware of the following + incompatible changes: + </para> + <itemizedlist> + <listitem> <para> - DSA support was - <link xlink:href="https://www.openssh.com/legacy.html">deprecated in OpenSSH 7.0</link>, - due to it being too weak. To re-enable support, add - <literal>PubkeyAcceptedKeyTypes +ssh-dss</literal> to the end of your - <option>services.openssh.extraConfig</option>. + <literal>sound.enable</literal> now defaults to false. </para> - + </listitem> + <listitem> <para> - After updating the keys to be stronger, anyone still on a pre-17.03 - version is safe to jump to 17.03, as vetted - <link xlink:href="https://search.nix.gsc.io/?q=stateVersion">here</link>. + Dollar signs in options under <option>services.postfix</option> are passed + verbatim to Postfix, which will interpret them as the beginning of a + parameter expression. This was already true for string-valued options in + the previous release, but not for list-valued options. If you need to pass + literal dollar signs through Postfix, double them. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - The <literal>openssh</literal> package - now includes Kerberos support by default; - the <literal>openssh_with_kerberos</literal> package - is now a deprecated alias. - If you do not want Kerberos support, - you can do <literal>openssh.override { withKerberos = false; }</literal>. - Note, this also applies to the <literal>openssh_hpn</literal> package. + The <literal>postage</literal> package (for web-based PostgreSQL + administration) has been renamed to <literal>pgmanage</literal>. The + corresponding module has also been renamed. To migrate please rename all + <option>services.postage</option> options to + <option>services.pgmanage</option>. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - <literal>cc-wrapper</literal> has been split in two; there is now also a <literal>bintools-wrapper</literal>. - The most commonly used files in <filename>nix-support</filename> are now split between the two wrappers. - Some commonly used ones, like <filename>nix-support/dynamic-linker</filename>, are duplicated for backwards compatability, even though they rightly belong only in <literal>bintools-wrapper</literal>. - Other more obscure ones are just moved. + Package attributes starting with a digit have been prefixed with an + underscore sign. This is to avoid quoting in the configuration and other + issues with command-line tools like <literal>nix-env</literal>. The change + affects the following packages: + <itemizedlist> + <listitem> + <para> + <literal>2048-in-terminal</literal> → + <literal>_2048-in-terminal</literal> + </para> + </listitem> + <listitem> + <para> + <literal>90secondportraits</literal> → + <literal>_90secondportraits</literal> + </para> + </listitem> + <listitem> + <para> + <literal>2bwm</literal> → <literal>_2bwm</literal> + </para> + </listitem> + <listitem> + <para> + <literal>389-ds-base</literal> → <literal>_389-ds-base</literal> + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + <listitem> + <para> + <emphasis role="strong"> The OpenSSH service no longer enables support for + DSA keys by default, which could cause a system lock out. Update your keys + or, unfavorably, re-enable DSA support manually. </emphasis> + </para> + <para> + DSA support was + <link xlink:href="https://www.openssh.com/legacy.html">deprecated in + OpenSSH 7.0</link>, due to it being too weak. To re-enable support, add + <literal>PubkeyAcceptedKeyTypes +ssh-dss</literal> to the end of your + <option>services.openssh.extraConfig</option>. + </para> + <para> + After updating the keys to be stronger, anyone still on a pre-17.03 + version is safe to jump to 17.03, as vetted + <link xlink:href="https://search.nix.gsc.io/?q=stateVersion">here</link>. + </para> + </listitem> + <listitem> + <para> + The <literal>openssh</literal> package now includes Kerberos support by + default; the <literal>openssh_with_kerberos</literal> package is now a + deprecated alias. If you do not want Kerberos support, you can do + <literal>openssh.override { withKerberos = false; }</literal>. Note, this + also applies to the <literal>openssh_hpn</literal> package. + </para> + </listitem> + <listitem> + <para> + <literal>cc-wrapper</literal> has been split in two; there is now also a + <literal>bintools-wrapper</literal>. The most commonly used files in + <filename>nix-support</filename> are now split between the two wrappers. + Some commonly used ones, like + <filename>nix-support/dynamic-linker</filename>, are duplicated for + backwards compatability, even though they rightly belong only in + <literal>bintools-wrapper</literal>. Other more obscure ones are just + moved. + </para> + </listitem> + <listitem> + <para> + The propagation logic has been changed. The new logic, along with new + types of dependencies that go with, is thoroughly documented in the + "Specifying dependencies" section of the "Standard Environment" chapter of + the nixpkgs manual. +<!-- That's <xref linkend="ssec-stdenv-attributes"> were we to merge the manuals. --> + The old logic isn't but is easy to describe: dependencies were propagated + as the same type of dependency no matter what. In practice, that means + that many <function>propagatedNativeBuildInputs</function> should instead + be <function>propagatedBuildInputs</function>. Thankfully, that was and is + the least used type of dependency. Also, it means that some + <function>propagatedBuildInputs</function> should instead be + <function>depsTargetTargetPropagated</function>. Other types dependencies + should be unaffected. + </para> + </listitem> + <listitem> + <para> + <literal>lib.addPassthru drv passthru</literal> is removed. Use + <literal>lib.extendDerivation true passthru drv</literal> instead. + </para> + </listitem> + <listitem> + <para> + The <literal>memcached</literal> service no longer accept dynamic socket + paths via <option>services.memcached.socket</option>. Unix sockets can be + still enabled by <option>services.memcached.enableUnixSocket</option> and + will be accessible at <literal>/run/memcached/memcached.sock</literal>. + </para> + </listitem> + <listitem> + <para> + The <varname>hardware.amdHybridGraphics.disable</varname> option was + removed for lack of a maintainer. If you still need this module, you may + wish to include a copy of it from an older version of nixos in your + imports. + </para> + </listitem> + <listitem> + <para> + The merging of config options for + <varname>services.postfix.config</varname> was buggy. Previously, if other + options in the Postfix module like + <varname>services.postfix.useSrs</varname> were set and the user set + config options that were also set by such options, the resulting config + wouldn't include all options that were needed. They are now merged + correctly. If config options need to be overridden, + <literal>lib.mkForce</literal> or <literal>lib.mkOverride</literal> can be + used. + </para> + </listitem> + <listitem> + <para> + The following changes apply if the <literal>stateVersion</literal> is + changed to 18.03 or higher. For <literal>stateVersion = "17.09"</literal> + or lower the old behavior is preserved. </para> - </listitem> - <listitem> + <itemizedlist> + <listitem> + <para> + <literal>matrix-synapse</literal> uses postgresql by default instead of + sqlite. Migration instructions can be found + <link xlink:href="https://github.com/matrix-org/synapse/blob/master/docs/postgres.rst#porting-from-sqlite"> + here </link>. + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> <para> - The propagation logic has been changed. - The new logic, along with new types of dependencies that go with, is thoroughly documented in the "Specifying dependencies" section of the "Standard Environment" chapter of the nixpkgs manual. - <!-- That's <xref linkend="ssec-stdenv-attributes"> were we to merge the manuals. --> - The old logic isn't but is easy to describe: dependencies were propagated as the same type of dependency no matter what. - In practice, that means that many <function>propagatedNativeBuildInputs</function> should instead be <function>propagatedBuildInputs</function>. - Thankfully, that was and is the least used type of dependency. - Also, it means that some <function>propagatedBuildInputs</function> should instead be <function>depsTargetTargetPropagated</function>. - Other types dependencies should be unaffected. + The <literal>jid</literal> package has been removed, due to maintenance + overhead of a go package having non-versioned dependencies. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - <literal>lib.addPassthru drv passthru</literal> is removed. Use <literal>lib.extendDerivation true passthru drv</literal> instead. + When using <option>services.xserver.libinput</option> (enabled by default + in GNOME), it now handles all input devices, not just touchpads. As a + result, you might need to re-evaluate any custom Xorg configuration. In + particular, <literal>Option "XkbRules" "base"</literal> may result in + broken keyboard layout. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - The <literal>memcached</literal> service no longer accept dynamic socket - paths via <option>services.memcached.socket</option>. Unix sockets can be - still enabled by <option>services.memcached.enableUnixSocket</option> and - will be accessible at <literal>/run/memcached/memcached.sock</literal>. + The <literal>attic</literal> package was removed. A maintained fork called + <link xlink:href="https://www.borgbackup.org/">Borg</link> should be used + instead. Migration instructions can be found + <link xlink:href="http://borgbackup.readthedocs.io/en/stable/usage/upgrade.html#attic-and-borg-0-xx-to-borg-1-x">here</link>. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - The <varname>hardware.amdHybridGraphics.disable</varname> option was removed for lack of a maintainer. If you still need this module, you may wish to include a copy of it from an older version of nixos in your imports. + The Piwik analytics software was renamed to Matomo: + <itemizedlist> + <listitem> + <para> + The package <literal>pkgs.piwik</literal> was renamed to + <literal>pkgs.matomo</literal>. + </para> + </listitem> + <listitem> + <para> + The service <literal>services.piwik</literal> was renamed to + <literal>services.matomo</literal>. + </para> + </listitem> + <listitem> + <para> + The data directory <filename>/var/lib/piwik</filename> was renamed to + <filename>/var/lib/matomo</filename>. All files will be moved + automatically on first startup, but you might need to adjust your + backup scripts. + </para> + </listitem> + <listitem> + <para> + The default <option>serverName</option> for the nginx configuration + changed from <literal>piwik.${config.networking.hostName}</literal> to + <literal>matomo.${config.networking.hostName}.${config.networking.domain}</literal> + if <option>config.networking.domain</option> is set, + <literal>matomo.${config.networking.hostName}</literal> if it is not + set. If you change your <option>serverName</option>, remember you'll + need to update the <literal>trustedHosts[]</literal> array in + <filename>/var/lib/matomo/config/config.ini.php</filename> as well. + </para> + </listitem> + <listitem> + <para> + The <literal>piwik</literal> user was renamed to + <literal>matomo</literal>. The service will adjust ownership + automatically for files in the data directory. If you use unix socket + authentication, remember to give the new <literal>matomo</literal> user + access to the database and to change the <literal>username</literal> to + <literal>matomo</literal> in the <literal>[database]</literal> section + of <filename>/var/lib/matomo/config/config.ini.php</filename>. + </para> + </listitem> + <listitem> + <para> + If you named your database `piwik`, you might want to rename it to + `matomo` to keep things clean, but this is neither enforced nor + required. + </para> + </listitem> + </itemizedlist> </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - The merging of config options for <varname>services.postfix.config</varname> - was buggy. Previously, if other options in the Postfix module like - <varname>services.postfix.useSrs</varname> were set and the user set config - options that were also set by such options, the resulting config wouldn't - include all options that were needed. They are now merged correctly. If - config options need to be overridden, <literal>lib.mkForce</literal> or - <literal>lib.mkOverride</literal> can be used. + <literal>nodejs-4_x</literal> is end-of-life. + <literal>nodejs-4_x</literal>, <literal>nodejs-slim-4_x</literal> and + <literal>nodePackages_4_x</literal> are removed. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - The following changes apply if the <literal>stateVersion</literal> is changed to 18.03 or higher. - For <literal>stateVersion = "17.09"</literal> or lower the old behavior is preserved. + The <literal>pump.io</literal> NixOS module was removed. It is now + maintained as an + <link xlink:href="https://github.com/rvl/pump.io-nixos">external + module</link>. </para> - <itemizedlist> + </listitem> + <listitem> + <para> + The Prosody XMPP server has received a major update. The following modules + were renamed: + <itemizedlist> <listitem> - <para> - <literal>matrix-synapse</literal> uses postgresql by default instead of sqlite. - Migration instructions can be found <link xlink:href="https://github.com/matrix-org/synapse/blob/master/docs/postgres.rst#porting-from-sqlite"> here </link>. - </para> + <para> + <option>services.prosody.modules.httpserver</option> is now + <option>services.prosody.modules.http_files</option> + </para> </listitem> - </itemizedlist> - </listitem> - <listitem> - <para> - The <literal>jid</literal> package has been removed, due to maintenance - overhead of a go package having non-versioned dependencies. - </para> - </listitem> - <listitem> - <para> - When using <option>services.xserver.libinput</option> (enabled by default in GNOME), - it now handles all input devices, not just touchpads. As a result, you might need to - re-evaluate any custom Xorg configuration. In particular, - <literal>Option "XkbRules" "base"</literal> may result in broken keyboard layout. - </para> - </listitem> - <listitem> - <para> - The <literal>attic</literal> package was removed. A maintained fork called - <link xlink:href="https://www.borgbackup.org/">Borg</link> should be used instead. - Migration instructions can be found - <link xlink:href="http://borgbackup.readthedocs.io/en/stable/usage/upgrade.html#attic-and-borg-0-xx-to-borg-1-x">here</link>. - </para> - </listitem> - <listitem> - <para> - The Piwik analytics software was renamed to Matomo: - <itemizedlist> - <listitem> - <para>The package <literal>pkgs.piwik</literal> was renamed to <literal>pkgs.matomo</literal>.</para> - </listitem> - <listitem> - <para>The service <literal>services.piwik</literal> was renamed to <literal>services.matomo</literal>.</para> - </listitem> - <listitem> - <para> - The data directory <filename>/var/lib/piwik</filename> was renamed to <filename>/var/lib/matomo</filename>. - All files will be moved automatically on first startup, but you might need to adjust your backup scripts. - </para> - </listitem> - <listitem> - <para> - The default <option>serverName</option> for the nginx configuration changed from - <literal>piwik.${config.networking.hostName}</literal> to - <literal>matomo.${config.networking.hostName}.${config.networking.domain}</literal> - if <option>config.networking.domain</option> is set, - <literal>matomo.${config.networking.hostName}</literal> if it is not set. - If you change your <option>serverName</option>, remember you'll need to update the - <literal>trustedHosts[]</literal> array in <filename>/var/lib/matomo/config/config.ini.php</filename> - as well. - </para> - </listitem> - <listitem> - <para> - The <literal>piwik</literal> user was renamed to <literal>matomo</literal>. - The service will adjust ownership automatically for files in the data directory. - If you use unix socket authentication, remember to give the new <literal>matomo</literal> user - access to the database and to change the <literal>username</literal> to <literal>matomo</literal> - in the <literal>[database]</literal> section of <filename>/var/lib/matomo/config/config.ini.php</filename>. - </para> - </listitem> - <listitem> - <para> - If you named your database `piwik`, you might want to rename it to `matomo` to keep things clean, - but this is neither enforced nor required. - </para> - </listitem> - </itemizedlist> - </para> - </listitem> - <listitem> - <para> - <literal>nodejs-4_x</literal> is end-of-life. - <literal>nodejs-4_x</literal>, <literal>nodejs-slim-4_x</literal> and <literal>nodePackages_4_x</literal> are removed. - </para> - </listitem> - <listitem> - <para> - The <literal>pump.io</literal> NixOS module was removed. - It is now maintained as an - <link xlink:href="https://github.com/rvl/pump.io-nixos">external module</link>. - </para> - </listitem> - <listitem> - <para> - The Prosody XMPP server has received a major update. The following modules were renamed: - <itemizedlist> - <listitem> - <para> - <option>services.prosody.modules.httpserver</option> is now <option>services.prosody.modules.http_files</option> - </para> - </listitem> - <listitem> - <para> - <option>services.prosody.modules.console</option> is now <option>services.prosody.modules.admin_telnet</option> - </para> - </listitem> - </itemizedlist> + <listitem> + <para> + <option>services.prosody.modules.console</option> is now + <option>services.prosody.modules.admin_telnet</option> + </para> + </listitem> + </itemizedlist> </para> - <para> - Many new modules are now core modules, most notably <option>services.prosody.modules.carbons</option> - and <option>services.prosody.modules.mam</option>. + Many new modules are now core modules, most notably + <option>services.prosody.modules.carbons</option> and + <option>services.prosody.modules.mam</option>. </para> - <para> - The better-performing <literal>libevent</literal> backend is now enabled by default. + The better-performing <literal>libevent</literal> backend is now enabled + by default. </para> - <para> - <literal>withCommunityModules</literal> now passes through the modules to <option>services.prosody.extraModules</option>. - Use <literal>withOnlyInstalledCommunityModules</literal> for modules that should not be enabled directly, e.g <literal>lib_ldap</literal>. + <literal>withCommunityModules</literal> now passes through the modules to + <option>services.prosody.extraModules</option>. Use + <literal>withOnlyInstalledCommunityModules</literal> for modules that + should not be enabled directly, e.g <literal>lib_ldap</literal>. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - All prometheus exporter modules are now defined as submodules. - The exporters are configured using <literal>services.prometheus.exporters</literal>. + All prometheus exporter modules are now defined as submodules. The + exporters are configured using + <literal>services.prometheus.exporters</literal>. </para> - </listitem> -</itemizedlist> + </listitem> + </itemizedlist> + </section> -</section> -<section xmlns="http://docbook.org/ns/docbook" + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-release-18.03-notable-changes"> + <title>Other Notable Changes</title> -<title>Other Notable Changes</title> - -<itemizedlist> - <listitem> - <para> - ZNC option <option>services.znc.mutable</option> now defaults to - <literal>true</literal>. That means that old configuration is not - overwritten by default when update to the znc options are made. - </para> - </listitem> - <listitem> - <para> - The option <option>networking.wireless.networks.<name>.auth</option> - has been added for wireless networks with WPA-Enterprise authentication. - There is also a new <option>extraConfig</option> option to directly - configure <literal>wpa_supplicant</literal> and <option>hidden</option> - to connect to hidden networks. - </para> - </listitem> - <listitem> - <para> - In the module <option>networking.interfaces.<name></option> the - following options have been removed: - <itemizedlist> - <listitem> - <para><option>ipAddress</option></para> - </listitem> - <listitem> - <para><option>ipv6Address</option></para> - </listitem> - <listitem> - <para><option>prefixLength</option></para> - </listitem> - <listitem> - <para><option>ipv6PrefixLength</option></para> - </listitem> - <listitem> - <para><option>subnetMask</option></para> - </listitem> - </itemizedlist> - To assign static addresses to an interface the options - <option>ipv4.addresses</option> and <option>ipv6.addresses</option> - should be used instead. - The options <option>ip4</option> and <option>ip6</option> have been - renamed to <option>ipv4.addresses</option> <option>ipv6.addresses</option> - respectively. - The new options <option>ipv4.routes</option> and <option>ipv6.routes</option> - have been added to set up static routing. - </para> - </listitem> - <listitem> - <para> - The option <option>services.logstash.listenAddress</option> is now <literal>127.0.0.1</literal> by default. - Previously the default behaviour was to listen on all interfaces. - </para> - </listitem> - <listitem> - <para> - <literal>services.btrfs.autoScrub</literal> has been added, to - periodically check btrfs filesystems for data corruption. - If there's a correct copy available, it will automatically repair - corrupted blocks. - </para> - </listitem> - <listitem> - <para> - <literal>displayManager.lightdm.greeters.gtk.clock-format.</literal> - has been added, the clock format string (as expected by - strftime, e.g. <literal>%H:%M</literal>) to use with the lightdm - gtk greeter panel. - </para> - <para> - If set to null the default clock format is used. - </para> - </listitem> - <listitem> - <para> - <literal>displayManager.lightdm.greeters.gtk.indicators</literal> - has been added, a list of allowed indicator modules to use with - the lightdm gtk greeter panel. - </para> - <para> - Built-in indicators include <literal>~a11y</literal>, - <literal>~language</literal>, <literal>~session</literal>, - <literal>~power</literal>, <literal>~clock</literal>, - <literal>~host</literal>, <literal>~spacer</literal>. Unity - indicators can be represented by short name - (e.g. <literal>sound</literal>, <literal>power</literal>), - service file name, or absolute path. - </para> - <para> - If set to <literal>null</literal> the default indicators are - used. - </para> - <para> - In order to have the previous default configuration add + <itemizedlist> + <listitem> + <para> + ZNC option <option>services.znc.mutable</option> now defaults to + <literal>true</literal>. That means that old configuration is not + overwritten by default when update to the znc options are made. + </para> + </listitem> + <listitem> + <para> + The option <option>networking.wireless.networks.<name>.auth</option> + has been added for wireless networks with WPA-Enterprise authentication. + There is also a new <option>extraConfig</option> option to directly + configure <literal>wpa_supplicant</literal> and <option>hidden</option> to + connect to hidden networks. + </para> + </listitem> + <listitem> + <para> + In the module <option>networking.interfaces.<name></option> the + following options have been removed: + <itemizedlist> + <listitem> + <para> + <option>ipAddress</option> + </para> + </listitem> + <listitem> + <para> + <option>ipv6Address</option> + </para> + </listitem> + <listitem> + <para> + <option>prefixLength</option> + </para> + </listitem> + <listitem> + <para> + <option>ipv6PrefixLength</option> + </para> + </listitem> + <listitem> + <para> + <option>subnetMask</option> + </para> + </listitem> + </itemizedlist> + To assign static addresses to an interface the options + <option>ipv4.addresses</option> and <option>ipv6.addresses</option> should + be used instead. The options <option>ip4</option> and <option>ip6</option> + have been renamed to <option>ipv4.addresses</option> + <option>ipv6.addresses</option> respectively. The new options + <option>ipv4.routes</option> and <option>ipv6.routes</option> have been + added to set up static routing. + </para> + </listitem> + <listitem> + <para> + The option <option>services.logstash.listenAddress</option> is now + <literal>127.0.0.1</literal> by default. Previously the default behaviour + was to listen on all interfaces. + </para> + </listitem> + <listitem> + <para> + <literal>services.btrfs.autoScrub</literal> has been added, to + periodically check btrfs filesystems for data corruption. If there's a + correct copy available, it will automatically repair corrupted blocks. + </para> + </listitem> + <listitem> + <para> + <literal>displayManager.lightdm.greeters.gtk.clock-format.</literal> has + been added, the clock format string (as expected by strftime, e.g. + <literal>%H:%M</literal>) to use with the lightdm gtk greeter panel. + </para> + <para> + If set to null the default clock format is used. + </para> + </listitem> + <listitem> + <para> + <literal>displayManager.lightdm.greeters.gtk.indicators</literal> has been + added, a list of allowed indicator modules to use with the lightdm gtk + greeter panel. + </para> + <para> + Built-in indicators include <literal>~a11y</literal>, + <literal>~language</literal>, <literal>~session</literal>, + <literal>~power</literal>, <literal>~clock</literal>, + <literal>~host</literal>, <literal>~spacer</literal>. Unity indicators can + be represented by short name (e.g. <literal>sound</literal>, + <literal>power</literal>), service file name, or absolute path. + </para> + <para> + If set to <literal>null</literal> the default indicators are used. + </para> + <para> + In order to have the previous default configuration add <programlisting> services.xserver.displayManager.lightdm.greeters.gtk.indicators = [ "~host" "~spacer" @@ -539,24 +829,27 @@ following incompatible changes:</para> "~power" ]; </programlisting> - to your <literal>configuration.nix</literal>. + to your <literal>configuration.nix</literal>. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - The NixOS test driver supports user services declared by <literal>systemd.user.services</literal>. - The methods <literal>waitForUnit</literal>, <literal>getUnitInfo</literal>, <literal>startJob</literal> - and <literal>stopJob</literal> provide an optional <literal>$user</literal> argument for that purpose. + The NixOS test driver supports user services declared by + <literal>systemd.user.services</literal>. The methods + <literal>waitForUnit</literal>, <literal>getUnitInfo</literal>, + <literal>startJob</literal> and <literal>stopJob</literal> provide an + optional <literal>$user</literal> argument for that purpose. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - Enabling bash completion on NixOS, <literal>programs.bash.enableCompletion</literal>, will now also enable - completion for the Nix command line tools by installing the - <link xlink:href="https://github.com/hedning/nix-bash-completions">nix-bash-completions</link> package. + Enabling bash completion on NixOS, + <literal>programs.bash.enableCompletion</literal>, will now also enable + completion for the Nix command line tools by installing the + <link xlink:href="https://github.com/hedning/nix-bash-completions">nix-bash-completions</link> + package. </para> - </listitem> -</itemizedlist> - -</section> + </listitem> + </itemizedlist> + </section> </section> diff --git a/nixos/doc/manual/release-notes/rl-1809.xml b/nixos/doc/manual/release-notes/rl-1809.xml index 0743a05ba38c..47b54a411efa 100644 --- a/nixos/doc/manual/release-notes/rl-1809.xml +++ b/nixos/doc/manual/release-notes/rl-1809.xml @@ -3,153 +3,158 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-release-18.09"> + <title>Release 18.09 (“Jellyfish”, 2018/09/??)</title> -<title>Release 18.09 (“Jellyfish”, 2018/09/??)</title> - -<section xmlns="http://docbook.org/ns/docbook" + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-release-18.09-highlights"> + <title>Highlights</title> -<title>Highlights</title> + <para> + In addition to numerous new and upgraded packages, this release has the + following highlights: + </para> -<para>In addition to numerous new and upgraded packages, this release -has the following highlights: </para> - -<itemizedlist> - <listitem> + <itemizedlist> + <listitem> + <para> + User channels are now in the default <literal>NIX_PATH</literal>, allowing + users to use their personal <command>nix-channel</command> defined + channels in <command>nix-build</command> and <command>nix-shell</command> + commands, as well as in imports like <code>import + <mychannel></code>. + </para> <para> - User channels are now in the default <literal>NIX_PATH</literal>, - allowing users to use their personal <command>nix-channel</command> - defined channels in <command>nix-build</command> and - <command>nix-shell</command> commands, as well as in imports like - <code>import <mychannel></code>. + For example </para> - <para>For example</para> - <programlisting> +<programlisting> $ nix-channel --add https://nixos.org/channels/nixpkgs-unstable nixpkgsunstable $ nix-channel --update $ nix-build '<nixpkgsunstable>' -A gitFull $ nix run -f '<nixpkgsunstable>' gitFull $ nix-instantiate -E '(import <nixpkgsunstable> {}).gitFull' </programlisting> - </listitem> -</itemizedlist> + </listitem> + </itemizedlist> + </section> -</section> -<section xmlns="http://docbook.org/ns/docbook" + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-release-18.09-new-services"> + <title>New Services</title> -<title>New Services</title> - -<para>The following new services were added since the last release:</para> + <para> + The following new services were added since the last release: + </para> -<itemizedlist> - <listitem> + <itemizedlist> + <listitem> <para></para> - </listitem> -</itemizedlist> + </listitem> + </itemizedlist> + </section> -</section> -<section xmlns="http://docbook.org/ns/docbook" + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-release-18.09-incompatibilities"> + <title>Backward Incompatibilities</title> -<title>Backward Incompatibilities</title> + <para> + When upgrading from a previous release, please be aware of the following + incompatible changes: + </para> -<para>When upgrading from a previous release, please be aware of the -following incompatible changes:</para> - -<itemizedlist> - <listitem> + <itemizedlist> + <listitem> <para> - <literal>lib.strict</literal> is removed. Use <literal>builtins.seq</literal> instead. + <literal>lib.strict</literal> is removed. Use + <literal>builtins.seq</literal> instead. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - The <literal>clementine</literal> package points now to the free derivation. - <literal>clementineFree</literal> is removed now and <literal>clementineUnfree</literal> - points to the package which is bundled with the unfree <literal>libspotify</literal> package. + The <literal>clementine</literal> package points now to the free + derivation. <literal>clementineFree</literal> is removed now and + <literal>clementineUnfree</literal> points to the package which is bundled + with the unfree <literal>libspotify</literal> package. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - The <literal>netcat</literal> package is now taken directly from OpenBSD's - <literal>libressl</literal>, instead of relying on Debian's fork. The new - version should be very close to the old version, but there are some minor - differences. Importantly, flags like -b, -q, -C, and -Z are no longer - accepted by the nc command. + The <literal>netcat</literal> package is now taken directly from OpenBSD's + <literal>libressl</literal>, instead of relying on Debian's fork. The new + version should be very close to the old version, but there are some minor + differences. Importantly, flags like -b, -q, -C, and -Z are no longer + accepted by the nc command. </para> - </listitem> -</itemizedlist> + </listitem> + </itemizedlist> + </section> -</section> -<section xmlns="http://docbook.org/ns/docbook" + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="sec-release-18.09-notable-changes"> + <title>Other Notable Changes</title> -<title>Other Notable Changes</title> - -<itemizedlist> - <listitem> + <itemizedlist> + <listitem> <para> - <literal>lib.attrNamesToStr</literal> has been deprecated. Use - more specific concatenation (<literal>lib.concat(Map)StringsSep</literal>) - instead. + <literal>lib.attrNamesToStr</literal> has been deprecated. Use more + specific concatenation (<literal>lib.concat(Map)StringsSep</literal>) + instead. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - <literal>lib.addErrorContextToAttrs</literal> has been deprecated. Use - <literal>builtins.addErrorContext</literal> directly. + <literal>lib.addErrorContextToAttrs</literal> has been deprecated. Use + <literal>builtins.addErrorContext</literal> directly. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - <literal>lib.showVal</literal> has been deprecated. Use - <literal>lib.traceSeqN</literal> instead. + <literal>lib.showVal</literal> has been deprecated. Use + <literal>lib.traceSeqN</literal> instead. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - <literal>lib.traceXMLVal</literal> has been deprecated. Use - <literal>lib.traceValFn builtins.toXml</literal> instead. + <literal>lib.traceXMLVal</literal> has been deprecated. Use + <literal>lib.traceValFn builtins.toXml</literal> instead. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - <literal>lib.traceXMLValMarked</literal> has been deprecated. Use - <literal>lib.traceValFn (x: str + builtins.toXML x)</literal> instead. + <literal>lib.traceXMLValMarked</literal> has been deprecated. Use + <literal>lib.traceValFn (x: str + builtins.toXML x)</literal> instead. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - <literal>lib.traceValIfNot</literal> has been deprecated. Use - <literal>if/then/else</literal> and <literal>lib.traceValSeq</literal> - instead. + <literal>lib.traceValIfNot</literal> has been deprecated. Use + <literal>if/then/else</literal> and <literal>lib.traceValSeq</literal> + instead. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - <literal>lib.traceCallXml</literal> has been deprecated. Please complain - if you use the function regularly. + <literal>lib.traceCallXml</literal> has been deprecated. Please complain + if you use the function regularly. </para> <para> - The attribute <literal>lib.nixpkgsVersion</literal> has been deprecated in favor of - <literal>lib.version</literal>. Please refer to the discussion in - <link xlink:href="https://github.com/NixOS/nixpkgs/pull/39416#discussion_r183845745">NixOS/nixpkgs#39416</link> for further reference. + The attribute <literal>lib.nixpkgsVersion</literal> has been deprecated in + favor of <literal>lib.version</literal>. Please refer to the discussion in + <link xlink:href="https://github.com/NixOS/nixpkgs/pull/39416#discussion_r183845745">NixOS/nixpkgs#39416</link> + for further reference. </para> - </listitem> -</itemizedlist> - -</section> + </listitem> + </itemizedlist> + </section> </section> diff --git a/nixos/doc/manual/shell.nix b/nixos/doc/manual/shell.nix new file mode 100644 index 000000000000..7f8422b4ec11 --- /dev/null +++ b/nixos/doc/manual/shell.nix @@ -0,0 +1,8 @@ +let + pkgs = import ../../.. { }; +in +pkgs.mkShell { + name = "nixos-manual"; + + buildInputs = with pkgs; [ xmlformat jing xmloscopy ]; +} diff --git a/nixos/doc/xmlformat.conf b/nixos/doc/xmlformat.conf new file mode 100644 index 000000000000..50255857b24a --- /dev/null +++ b/nixos/doc/xmlformat.conf @@ -0,0 +1,72 @@ +# +# DocBook Configuration file for "xmlformat" +# see http://www.kitebird.com/software/xmlformat/ +# 10 Sept. 2004 +# + +# Only block elements +ackno address appendix article biblioentry bibliography bibliomixed \ +biblioset blockquote book bridgehead callout calloutlist caption caution \ +chapter chapterinfo classsynopsis cmdsynopsis colophon constraintdef \ +constructorsynopsis dedication destructorsynopsis entry epigraph equation example \ +figure formalpara funcsynopsis glossary glossdef glossdiv glossentry glosslist \ +glosssee glossseealso graphic graphicco highlights imageobjectco important \ +index indexdiv indexentry indexinfo info informalequation informalexample \ +informalfigure informaltable legalnotice literallayout lot lotentry mediaobject \ +mediaobjectco msgmain msgset note orderedlist para part preface primaryie \ +procedure qandadiv qandaentry qandaset refentry refentrytitle reference \ +refnamediv refsect1 refsect2 refsect3 refsection revhistory screenshot sect1 \ +sect2 sect3 sect4 sect5 section seglistitem set setindex sidebar simpara \ +simplesect step substeps synopfragment synopsis table term title \ +toc variablelist varlistentry warning itemizedlist listitem \ +footnote colspec partintro row simplelist subtitle tbody tgroup thead tip + format block + normalize no + + +#appendix bibliography chapter glossary preface reference +# element-break 3 + +sect1 section + element-break 2 + + +# +para abstract + format block + entry-break 1 + exit-break 1 + normalize yes + wrap-length 79 + +title + format block + normalize = yes + entry-break = 0 + exit-break = 0 + +# Inline elements +abbrev accel acronym action application citation citebiblioid citerefentry citetitle \ +classname co code command computeroutput constant country database date email emphasis \ +envar errorcode errorname errortext errortype exceptionname fax filename \ +firstname firstterm footnoteref foreignphrase funcdef funcparams function \ +glossterm group guibutton guiicon guilabel guimenu guimenuitem guisubmenu \ +hardware holder honorific indexterm inlineequation inlinegraphic inlinemediaobject \ +interface interfacename \ +keycap keycode keycombo keysym lineage link literal manvolnum markup medialabel \ +menuchoice methodname methodparam modifier mousebutton olink ooclass ooexception \ +oointerface option optional otheraddr othername package paramdef parameter personname \ +phrase pob postcode productname prompt property quote refpurpose replaceable \ +returnvalue revnumber sgmltag state street structfield structname subscript \ +superscript surname symbol systemitem token trademark type ulink userinput \ +uri varargs varname void wordasword xref year mathphrase member tag + format inline + +programlisting screen + format verbatim + entry-break = 0 + exit-break = 0 + + +#term +# format inline diff --git a/pkgs/applications/misc/mupdf/default.nix b/pkgs/applications/misc/mupdf/default.nix index 000a916b737a..fbc7da070211 100644 --- a/pkgs/applications/misc/mupdf/default.nix +++ b/pkgs/applications/misc/mupdf/default.nix @@ -14,77 +14,19 @@ let in stdenv.mkDerivation rec { - version = "1.12.0"; + version = "1.13.0"; name = "mupdf-${version}"; src = fetchurl { url = "https://mupdf.com/downloads/archive/${name}-source.tar.gz"; - sha256 = "0mc7a92zri27lk17wdr2iffarbfi4lvrmxhc53sz84hm5yl56qsw"; + sha256 = "02faww5bnjw76k6igrjzwf0lnw4xd9ckc8d6ilc3c4gfrdi6j707"; }; patches = [ - # Compatibility with new openjpeg - (fetchpatch { - name = "mupdf-1.12-openjpeg-version.patch"; - url = "https://git.archlinux.org/svntogit/community.git/plain/trunk/0001-mupdf-openjpeg.patch?h=packages/mupdf&id=a910cd33a2b311712f83710dc042fbe80c104306"; - sha256 = "05i9v2ia586jyjqdb7g68ss4vkfwgp6cwhagc8zzggsba83azyqk"; - }) - (fetchpatch { - name = "CVE-2018-6544.1.patch"; - url = "http://git.ghostscript.com/?p=mupdf.git;a=commitdiff_plain;h=b03def134988da8c800adac1a38a41a1f09a1d89;hp=26527eef77b3e51c2258c8e40845bfbc015e405d"; - sha256 = "1rlmjibl73ls8xfpsz69axa3lw5l47vb0a1dsjqziszsld4lpj5i"; - }) - (fetchpatch { - name = "CVE-2018-6544.2.patch"; - url = "http://git.ghostscript.com/?p=mupdf.git;a=patch;h=26527eef77b3e51c2258c8e40845bfbc015e405d;hp=ab98356f959c7a6e94b1ec10f78dd2c33ed3f3e7"; - sha256 = "1brcc029s5zmd6ya0d9qk3mh9qwx5g6vhsf1j8h879092sya5627"; - }) - (fetchpatch { - # Bugs 698804/698810/698811, 698819: Keep PDF object numbers below limit. - name = "CVE-2017-17858.patch"; - url = "http://git.ghostscript.com/?p=mupdf.git;a=patch;h=55c3f68d638ac1263a386e0aaa004bb6e8bde731"; - sha256 = "1bf683d59i5009cv1hhmwmrp2rsb75cbf98qd44dk39cpvq8ydwv"; - }) - (fetchpatch { - # Bug 698825: Do not drop borrowed colorspaces. - name = "CVE-2018-1000051.patch"; - url = "http://git.ghostscript.com/?p=mupdf.git;a=patch;h=321ba1de287016b0036bf4a56ce774ad11763384"; - sha256 = "0jbcc9j565q5y305pi888qzlp83zww6nhkqbsmkk91gim958zikm"; - }) - (fetchpatch { - # Bug 698908 preprecondition: Add portable pseudo-random number generator based on the lrand48 family. - name = "CVE-2018-6187.0.1.patch"; - url = "http://git.ghostscript.com/?p=mupdf.git;a=patch;h=2d5b4683e912d6e6e1f1e2ca5aa0297beb3e6807"; - sha256 = "028bxinbjs5gg9myjr3vs366qxg9l2iyba2j3pxkxsh1851hj728"; - }) - (fetchpatch { - # Bug 698908 precondition: Fix "being able to search for redacted text" bug. - name = "CVE-2018-6187.0.2.patch"; - url = "http://git.ghostscript.com/?p=mupdf.git;a=patch;h=25593f4f9df0c4a9b9adaa84aaa33fe2a89087f6"; - sha256 = "195y69c3f8yqxcsa0bxrmxbdc3fx1dzvz8v66i56064mjj0mx04s"; - }) - (fetchpatch { - # Bug 698908: Resize object use and renumbering lists after repair. - name = "CVE-2018-6187.1.patch"; - url = "http://git.ghostscript.com/?p=mupdf.git;a=patch;h=3e30fbb7bf5efd88df431e366492356e7eb969ec"; - sha256 = "0wzbqj750h06q1wa6vxbpv5a5q9pfg0cxjdv88yggkrjb3vrkd9j"; - }) - (fetchpatch { - # Bug 698908: Plug PDF object leaks when decimating pages in pdfposter. - name = "CVE-2018-6187.2.patch"; - url = "http://git.ghostscript.com/?p=mupdf.git;a=patch;h=a71e7c85a9f2313cde20d4479cd727a5f5518ed2"; - sha256 = "1pcjkq8lg6l2m0186rl79lilg79crgdvz9hrmm3w60gy2gxkgksc"; - }) - (fetchpatch { - # Bug 698916: Indirect object numbers must be in range. - name = "CVE-2018-6192.patch"; - url = "http://git.ghostscript.com/?p=mupdf.git;a=patch;h=5e411a99604ff6be5db9e273ee84737204113299"; - sha256 = "134zc07fp0p1mwqa8xrkq3drg4crajzf1hjf4mdwmcy1jfj2pfhj"; - }) ] # Use shared libraries to decrease size - ++ stdenv.lib.optional (!stdenv.isDarwin) ./mupdf-1.12-shared_libs-1.patch + ++ stdenv.lib.optional (!stdenv.isDarwin) ./mupdf-1.13-shared_libs-1.patch ++ stdenv.lib.optional stdenv.isDarwin ./darwin.patch ; diff --git a/pkgs/applications/misc/mupdf/mupdf-1.12-shared_libs-1.patch b/pkgs/applications/misc/mupdf/mupdf-1.13-shared_libs-1.patch index b39f005ed74a..e29f1f52077c 100644 --- a/pkgs/applications/misc/mupdf/mupdf-1.12-shared_libs-1.patch +++ b/pkgs/applications/misc/mupdf/mupdf-1.13-shared_libs-1.patch @@ -9,22 +9,24 @@ LIBS += $(XLIBS) -lm LIBS += $(FREETYPE_LIBS) -@@ -312,9 +312,9 @@ +@@ -312,10 +312,10 @@ # --- Library --- -MUPDF_LIB = $(OUT)/libmupdf.a -THIRD_LIB = $(OUT)/libmupdfthird.a -THREAD_LIB = $(OUT)/libmuthreads.a +-PKCS7_LIB = $(OUT)/libmupkcs7.a +MUPDF_LIB = $(OUT)/libmupdf.so +THIRD_LIB = $(OUT)/libmupdfthird.so +THREAD_LIB = $(OUT)/libmuthreads.so ++PKCS7_LIB = $(OUT)/libmupkcs7.so MUPDF_OBJ := \ $(FITZ_OBJ) \ -@@ -343,11 +343,14 @@ - - THREAD_OBJ := $(THREAD_OBJ) +@@ -343,13 +343,17 @@ + $(ZLIB_OBJ) \ + $(LCMS2_OBJ) -$(MUPDF_LIB) : $(MUPDF_OBJ) +$(MUPDF_LIB) : $(MUPDF_OBJ) $(THIRD_LIB) $(THREAD_LIB) @@ -33,9 +35,11 @@ + $(LINK_CMD) -shared -Wl,-soname -Wl,libmupdfthird.so -Wl,--no-undefined $(THREAD_LIB) : $(THREAD_OBJ) + $(LINK_CMD) -shared -Wl,-soname -Wl,libmuthreads.so -Wl,--no-undefined -lpthread + $(PKCS7_LIB) : $(PKCS7_OBJ) ++ $(LINK_CMD) -shared -Wl,-soname -Wl,libmupkcs7.so -INSTALL_LIBS := $(MUPDF_LIB) $(THIRD_LIB) -+INSTALL_LIBS := $(MUPDF_LIB) $(THIRD_LIB) $(THREAD_LIB) ++INSTALL_LIBS := $(MUPDF_LIB) $(THIRD_LIB) $(THREAD_LIB) $(PKCS7_LIB) # --- Tools and Apps --- diff --git a/pkgs/applications/networking/browsers/chromium/common.nix b/pkgs/applications/networking/browsers/chromium/common.nix index 6403f5441f36..923084a57385 100644 --- a/pkgs/applications/networking/browsers/chromium/common.nix +++ b/pkgs/applications/networking/browsers/chromium/common.nix @@ -154,11 +154,6 @@ let (githubPatch "ba4141e451f4e0b1b19410b1b503bd32e150df06" "1cjxw1f9fin6z12b0mcxnxf2mdjb0n3chwz7mgvmp9yij8qhqnxj") (githubPatch "b34ed1e6524479d61ee944ebf6ca7389ea47e563" "1s13zw93nsyr259dzck6gbhg4x46qg5sg14djf4bvrrc6hlkiczw") (githubPatch "4f2b52281ce1649ea8347489443965ad33262ecc" "1g59izkicn9cpcphamdgrijs306h5b9i7i4pmy134asn1ifiax5z") - (fetchpatch { - ## see https://groups.google.com/a/chromium.org/forum/#!msg/chromium-packagers/So-ojMYOQdI/K66hndtdCAAJ - url = "https://bazaar.launchpad.net/~chromium-team/chromium-browser/bionic-stable/download/head:/addmissingblinktools-20180416203514-02f50sz15c2mn6ei-1/add-missing-blink-tools.patch"; - sha256 = "0dc4cmd05qjqyihrd4qb34kz0jlapjgah8bzgnvxf9m4791w062z"; - }) ] ++ optional enableWideVine ./patches/widevine.patch ++ optionals (stdenv.isAarch64 && versionRange "65" "67") [ ./patches/skia_buildfix.patch diff --git a/pkgs/applications/networking/browsers/chromium/upstream-info.nix b/pkgs/applications/networking/browsers/chromium/upstream-info.nix index d55cc12c165a..7be5d2591150 100644 --- a/pkgs/applications/networking/browsers/chromium/upstream-info.nix +++ b/pkgs/applications/networking/browsers/chromium/upstream-info.nix @@ -1,18 +1,18 @@ # This file is autogenerated from update.sh in the same directory. { beta = { - sha256 = "1mlfavs0m0lf60s42krqxqiyx73hdfd4r1mkjwv31p2gchsa7ibp"; - sha256bin64 = "067gpmiwnpdaqarkz740plg0ixpp7642xf4qqkq32w9v8flx3y57"; - version = "66.0.3359.117"; + sha256 = "136gx9qqbzfzaf19k0gxb8n4ypd4ycyr83i9v68nqdvy2k26vf4n"; + sha256bin64 = "0w628afj5k4xygizlznwxkljgc1prxqc3lanaz6gdmyrl7gk1s7n"; + version = "67.0.3396.18"; }; dev = { - sha256 = "0058g5dm5nfm7wdpd9y4fn0dmi8bq013l0ky5fsn4j7msm55rrg5"; - sha256bin64 = "1ag8kg3jjv6jsxdjq33h4ksqhhhfaz5aqw9jaaqhfma908c5mc9y"; - version = "67.0.3396.10"; + sha256 = "1yspf0n385ail9qxsmax58mfk5yi473ygsraqs83q30pfgxc5z2f"; + sha256bin64 = "1gi1xpnjwkg7sxv94ksv6fiymw13rxdq2hyvza8b9famvfcaz07j"; + version = "68.0.3409.2"; }; stable = { - sha256 = "1mlfavs0m0lf60s42krqxqiyx73hdfd4r1mkjwv31p2gchsa7ibp"; - sha256bin64 = "1ycfq6pqk7a9kyqf2112agcxav360rxbqqdc1yil0qkmz51i9zdg"; - version = "66.0.3359.117"; + sha256 = "1ck4wbi28702p1lfs4sz894ysbgm7fj79wrqj8srsy65z2ssaxdy"; + sha256bin64 = "1vgrgay3h0961vj96ql2p0pb16gzfr48r4hk25rxdqbflnz7njz0"; + version = "66.0.3359.139"; }; } diff --git a/pkgs/applications/networking/instant-messengers/gajim/default.nix b/pkgs/applications/networking/instant-messengers/gajim/default.nix index 3fd8b932283e..a1c81f3f0020 100644 --- a/pkgs/applications/networking/instant-messengers/gajim/default.nix +++ b/pkgs/applications/networking/instant-messengers/gajim/default.nix @@ -17,11 +17,11 @@ with lib; buildPythonApplication rec { name = "gajim-${version}"; majorVersion = "1.0"; - version = "${majorVersion}.1"; + version = "${majorVersion}.2"; src = fetchurl { url = "https://gajim.org/downloads/${majorVersion}/gajim-${version}.tar.bz2"; - sha256 = "16ynws10vhx6rhjjjmzw6iyb3hc19823xhx4gsb14hrc7l8vzd1c"; + sha256 = "0wyyy3wrk7ka5xrsbafnajzf7iacg8vg3hi16pl4c5p104hdhjdw"; }; postPatch = '' diff --git a/pkgs/applications/networking/syncthing/default.nix b/pkgs/applications/networking/syncthing/default.nix index 531a1d5d0a17..e1a2cf8d1716 100644 --- a/pkgs/applications/networking/syncthing/default.nix +++ b/pkgs/applications/networking/syncthing/default.nix @@ -3,14 +3,14 @@ let common = { stname, target, patches ? [], postInstall ? "" }: stdenv.mkDerivation rec { - version = "0.14.46"; + version = "0.14.47"; name = "${stname}-${version}"; src = fetchFromGitHub { owner = "syncthing"; repo = "syncthing"; rev = "v${version}"; - sha256 = "0lv8n5id40iy2gfccy8g45fjzlnbnvi7nlvj25pri22dq2bd5svm"; + sha256 = "1md835c13f3c9bknnm6pxn0r8k8g2wg56zfav96bpnpk4aqx41bh"; }; inherit patches; diff --git a/pkgs/applications/office/libreoffice/default-primary-src.nix b/pkgs/applications/office/libreoffice/default-primary-src.nix index f8742253c519..436558283e05 100644 --- a/pkgs/applications/office/libreoffice/default-primary-src.nix +++ b/pkgs/applications/office/libreoffice/default-primary-src.nix @@ -3,8 +3,8 @@ rec { major = "6"; minor = "0"; - patch = "2"; - tweak = "1"; + patch = "3"; + tweak = "2"; subdir = "${major}.${minor}.${patch}"; @@ -12,6 +12,6 @@ rec { src = fetchurl { url = "https://download.documentfoundation.org/libreoffice/src/${subdir}/libreoffice-${version}.tar.xz"; - sha256 = "0qga01lhh09jf2gx3czk66i5c854gzzjxgkrmj5d7m4ci2zaxfsd"; + sha256 = "16w5f8jbicby9jgsrpaj7g9c0wzymcmk1qk1fqdxaykrgpss5f0j"; }; } diff --git a/pkgs/applications/office/libreoffice/default.nix b/pkgs/applications/office/libreoffice/default.nix index 89af45814bff..c8897c87bd3c 100644 --- a/pkgs/applications/office/libreoffice/default.nix +++ b/pkgs/applications/office/libreoffice/default.nix @@ -42,14 +42,14 @@ let translations = fetchSrc { name = "translations"; - sha256 = "1fx9xkf1ppap77b8zdr8qawbikgp607z5w9b7jk3rilcqs7xbkwl"; + sha256 = "1cx537akvil4ci4lc9gnz83xmhxyjjrpv9xcibkif6vhdck539la"; }; # TODO: dictionaries help = fetchSrc { name = "help"; - sha256 = "0zphmhl4a8pd5l7ma4bzhrwgbv037j8p5m1ilvb1blgbqv53v38a"; + sha256 = "00a7iqknww28z0ifcjrx529p2nxqsa4gjavk75rwykvcfyn9x686"; }; }; @@ -184,7 +184,7 @@ in stdenv.mkDerivation rec { done cp -r sysui/desktop/icons "$out/share" - sed -re 's@Icon=libreofficedev[0-9.]*-?@Icon=@' -i "$out/share/applications/"*.desktop + sed -re 's@Icon=libreoffice(dev)?[0-9.]*-?@Icon=@' -i "$out/share/applications/"*.desktop ''; configureFlags = [ diff --git a/pkgs/applications/office/libreoffice/libreoffice-srcs.nix b/pkgs/applications/office/libreoffice/libreoffice-srcs.nix index 28c06b65869f..251aa44a2c58 100644 --- a/pkgs/applications/office/libreoffice/libreoffice-srcs.nix +++ b/pkgs/applications/office/libreoffice/libreoffice-srcs.nix @@ -532,11 +532,11 @@ md5name = "967ca83edf25ccb5b48a3c4a09ad3405a63365576503bf34290a42de1b92fcd2-xmlsec1-1.2.25.tar.gz"; } { - name = "libxml2-2.9.7.tar.gz"; - url = "http://dev-www.libreoffice.org/src/libxml2-2.9.7.tar.gz"; - sha256 = "f63c5e7d30362ed28b38bfa1ac6313f9a80230720b7fb6c80575eeab3ff5900c"; + name = "libxml2-2.9.8.tar.gz"; + url = "http://dev-www.libreoffice.org/src/libxml2-2.9.8.tar.gz"; + sha256 = "0b74e51595654f958148759cfef0993114ddccccbb6f31aee018f3558e8e2732"; md5 = ""; - md5name = "f63c5e7d30362ed28b38bfa1ac6313f9a80230720b7fb6c80575eeab3ff5900c-libxml2-2.9.7.tar.gz"; + md5name = "0b74e51595654f958148759cfef0993114ddccccbb6f31aee018f3558e8e2732-libxml2-2.9.8.tar.gz"; } { name = "libxslt-1.1.32.tar.gz"; @@ -651,11 +651,11 @@ md5name = "8c6ff15ec6b319b50788f42c7abc2890c08ba5a1cdcd3810eb9092deada37b0f-openssl-1.0.2m.tar.gz"; } { - name = "liborcus-0.13.1.tar.gz"; - url = "http://dev-www.libreoffice.org/src/liborcus-0.13.1.tar.gz"; - sha256 = "d7041ef455bb78db66b4ba7876af1b3d0fa377b9444e3ef72ceaccd2e8400937"; + name = "liborcus-0.13.3.tar.gz"; + url = "http://dev-www.libreoffice.org/src/liborcus-0.13.3.tar.gz"; + sha256 = "62e76de1fd3101e77118732b860354121b40a87bbb1ebfeb8203477fffac16e9"; md5 = ""; - md5name = "d7041ef455bb78db66b4ba7876af1b3d0fa377b9444e3ef72ceaccd2e8400937-liborcus-0.13.1.tar.gz"; + md5name = "62e76de1fd3101e77118732b860354121b40a87bbb1ebfeb8203477fffac16e9-liborcus-0.13.3.tar.gz"; } { name = "owncloud-android-library-0.9.4-no-binary-deps.tar.gz"; diff --git a/pkgs/applications/office/libreoffice/still.nix b/pkgs/applications/office/libreoffice/still.nix index b4139d54af50..52baed720c5f 100644 --- a/pkgs/applications/office/libreoffice/still.nix +++ b/pkgs/applications/office/libreoffice/still.nix @@ -183,7 +183,7 @@ in stdenv.mkDerivation rec { done cp -r sysui/desktop/icons "$out/share" - sed -re 's@Icon=libreofficedev[0-9.]*-?@Icon=@' -i "$out/share/applications/"*.desktop + sed -re 's@Icon=libreoffice(dev)?[0-9.]*-?@Icon=@' -i "$out/share/applications/"*.desktop ''; configureFlags = [ diff --git a/pkgs/development/compilers/sbcl/default.nix b/pkgs/development/compilers/sbcl/default.nix index 29a192fcff24..261a2fb6432c 100644 --- a/pkgs/development/compilers/sbcl/default.nix +++ b/pkgs/development/compilers/sbcl/default.nix @@ -9,11 +9,11 @@ stdenv.mkDerivation rec { name = "sbcl-${version}"; - version = "1.4.6"; + version = "1.4.7"; src = fetchurl { url = "mirror://sourceforge/project/sbcl/sbcl/${version}/${name}-source.tar.bz2"; - sha256 = "0y46zgg3lamaqqhxbqmbwzvdakzvc9j07d0ci8f57pfl549v04a4"; + sha256 = "1wmxly94pn8527092hyzg5mq58mg7qlc46nm31f268wb2dm67rvm"; }; patchPhase = '' diff --git a/pkgs/development/libraries/botan/2.0.nix b/pkgs/development/libraries/botan/2.0.nix index dec08d17177d..890f37897610 100644 --- a/pkgs/development/libraries/botan/2.0.nix +++ b/pkgs/development/libraries/botan/2.0.nix @@ -1,9 +1,9 @@ { callPackage, ... } @ args: callPackage ./generic.nix (args // { - baseVersion = "2.3"; + baseVersion = "2.6"; revision = "0"; - sha256 = "0z6lwv28hxnfkhd4s03cb4cdm1621bsswc2h88z4qslqwpz71y9r"; + sha256 = "1iawmymmnp5j2mcjj70slivn6bgg8gbpppldc1rjqw5sbdan3wn1"; postPatch = '' sed -e 's@lang_flags "@&--std=c++11 @' -i src/build-data/cc/{gcc,clang}.txt ''; diff --git a/pkgs/development/libraries/libe-book/default.nix b/pkgs/development/libraries/libe-book/default.nix index 3c900f86917e..6c52f2c0b1a6 100644 --- a/pkgs/development/libraries/libe-book/default.nix +++ b/pkgs/development/libraries/libe-book/default.nix @@ -1,21 +1,21 @@ { stdenv, fetchurl, gperf, pkgconfig, librevenge, libxml2, boost, icu -, cppunit, zlib +, cppunit, zlib, liblangtag }: let s = # Generated upstream information rec { baseName="libe-book"; - version="0.1.2"; + version="0.1.3"; name="${baseName}-${version}"; - hash="1v48pd32r2pfysr3a3igc4ivcf6vvb26jq4pdkcnq75p70alp2bz"; - url="mirror://sourceforge/project/libebook/libe-book-0.1.2/libe-book-0.1.2.tar.xz"; - sha256="1v48pd32r2pfysr3a3igc4ivcf6vvb26jq4pdkcnq75p70alp2bz"; + hash="1yg1vws1wggzhjw672bpgh2x541g5i9wryf67g51m0r79zrqz3by"; + url="https://kent.dl.sourceforge.net/project/libebook/libe-book-0.1.3/libe-book-0.1.3.tar.xz"; + sha256="1yg1vws1wggzhjw672bpgh2x541g5i9wryf67g51m0r79zrqz3by"; }; nativeBuildInputs = [ pkgconfig ]; buildInputs = [ - gperf librevenge libxml2 boost icu cppunit zlib + gperf librevenge libxml2 boost icu cppunit zlib liblangtag ]; # Boost 1.59 compatability fix diff --git a/pkgs/development/libraries/liblangtag/default.nix b/pkgs/development/libraries/liblangtag/default.nix new file mode 100644 index 000000000000..6d9085e1741b --- /dev/null +++ b/pkgs/development/libraries/liblangtag/default.nix @@ -0,0 +1,52 @@ +{stdenv, fetchurl, fetchFromBitbucket, autoreconfHook, gtkdoc, gettext +, pkgconfig, glib, libxml2, gobjectIntrospection, gnome-common, unzip +}: + +stdenv.mkDerivation rec { + name = "${pname}-${version}"; + pname = "liblangtag"; + version = "0.6.1"; + + src = fetchFromBitbucket { + owner = "tagoh"; + repo = "${pname}"; + rev = "${version}"; + sha256 = "19dk2qsg7f3ig9xz8d73jvikmf5kvrwi008wrz2psxinbdml442g"; + }; + + core_zip = fetchurl { + # please update if an update is available + url = "http://www.unicode.org/Public/cldr/33/core.zip"; + sha256 = "1faq1p5dmxpkczz6cjfsry7piksgym19cq2kf4jj2v885h490d7s"; + }; + + language_subtag_registry = fetchurl { + url = "http://www.iana.org/assignments/language-subtag-registry"; + sha256 = "1qfkvllyqcy40vmnvjn5w9fxw7g6ww46cb306vkgcfghnjjfhv3b"; + }; + + postPatch = '' + gtkdocize + cp "${core_zip}" data/core.zip + touch data/stamp-core-zip + cp "${language_subtag_registry}" data/language-subtag-registry + ''; + + configureFlags = [ + ''--with-locale-alias=${stdenv.cc.libc}/share/locale/locale.alias'' + ]; + + buildInputs = [ gettext glib libxml2 gobjectIntrospection gnome-common + unzip ]; + nativeBuildInputs = [ autoreconfHook gtkdoc gettext pkgconfig ]; + + meta = { + inherit version; + description = "An interface library to access tags for identifying languages"; + license = stdenv.lib.licenses.mpl20; + maintainers = [stdenv.lib.maintainers.raskin]; + platforms = stdenv.lib.platforms.linux; + # There are links to a homepage that are broken by a BitBucket change + homepage = "https://bitbucket.org/tagoh/liblangtag/overview"; + }; +} diff --git a/pkgs/development/python-modules/nbxmpp/default.nix b/pkgs/development/python-modules/nbxmpp/default.nix index b6f94536e2fa..cb7635522621 100644 --- a/pkgs/development/python-modules/nbxmpp/default.nix +++ b/pkgs/development/python-modules/nbxmpp/default.nix @@ -2,7 +2,7 @@ buildPythonPackage rec { pname = "nbxmpp"; - version = "0.6.4"; + version = "0.6.5"; name = "${pname}-${version}"; # Tests aren't included in PyPI tarball. @@ -10,7 +10,7 @@ buildPythonPackage rec { name = "${name}.tar.bz2"; url = "https://dev.gajim.org/gajim/python-nbxmpp/repository/archive.tar.bz2?" + "ref=${name}"; - sha256 = "0mikgksf01w82wnnm0phmzkijk2c93g24fzd59s71n3zy7f7dx3l"; + sha256 = "0b7jw07s4mnp20gcg8raw4bhw2h1hxf75cbn4f2ynj69fbpfr38h"; }; propagatedBuildInputs = [ pyopenssl ]; diff --git a/pkgs/development/tools/build-managers/buildbot/default.nix b/pkgs/development/tools/build-managers/buildbot/default.nix index 98adaf1c1aa1..ae540104df3a 100644 --- a/pkgs/development/tools/build-managers/buildbot/default.nix +++ b/pkgs/development/tools/build-managers/buildbot/default.nix @@ -76,6 +76,9 @@ let ./skip_test_linux_distro.patch ]; + # TimeoutErrors on slow machines -> aarch64 + doCheck = !stdenv.isAarch64; + postPatch = '' substituteInPlace buildbot/scripts/logwatcher.py --replace '/usr/bin/tail' "$(type -P tail)" ''; diff --git a/pkgs/development/tools/slimerjs/default.nix b/pkgs/development/tools/slimerjs/default.nix index b3049736b710..041aee7a1c5c 100644 --- a/pkgs/development/tools/slimerjs/default.nix +++ b/pkgs/development/tools/slimerjs/default.nix @@ -3,11 +3,11 @@ let s = # Generated upstream information rec { baseName="slimerjs"; - version="0.10.3"; + version="1.0.0"; name="${baseName}-${version}"; owner = "laurentj"; repo = "${baseName}"; - sha256="16v6a1kcq8il4snbrgsq5xmxs35alzf4qlmscr2yli95xq5fnl5y"; + sha256="1w4sfrv520isbs7r1rlzl5y3idrpad7znw9fc92yz40jlwz7sxs4"; rev = "${version}"; }; buildInputs = [ diff --git a/pkgs/games/sgt-puzzles/default.nix b/pkgs/games/sgt-puzzles/default.nix index 30e2bcfdf524..ce8d38ca5d1d 100644 --- a/pkgs/games/sgt-puzzles/default.nix +++ b/pkgs/games/sgt-puzzles/default.nix @@ -5,11 +5,11 @@ stdenv.mkDerivation rec { name = "sgt-puzzles-r${version}"; - version = "20180409.d95f476"; + version = "20180429.31384ca"; src = fetchurl { url = "http://www.chiark.greenend.org.uk/~sgtatham/puzzles/puzzles-${version}.tar.gz"; - sha256 = "1psml0abh3i577dns440h52568ggdny2wk1hhr30815nxibbribx"; + sha256 = "0r97kyy0rxgzw78lby2kwi8fg1yimw8a3biy5psgd983d0nwcf9l"; }; nativeBuildInputs = [ autoreconfHook makeWrapper pkgconfig perl wrapGAppsHook ]; diff --git a/pkgs/os-specific/darwin/ios-sdk-pkgs/default.nix b/pkgs/os-specific/darwin/ios-sdk-pkgs/default.nix index 5b9f30b62c39..f336b14ee37b 100644 --- a/pkgs/os-specific/darwin/ios-sdk-pkgs/default.nix +++ b/pkgs/os-specific/darwin/ios-sdk-pkgs/default.nix @@ -13,7 +13,7 @@ let minSdkVersion = "9.0"; iosPlatformArch = { parsed, ... }: { - "arm" = "armv7"; + "armv7a" = "armv7"; "aarch64" = "arm64"; "x86_64" = "x86_64"; }.${parsed.cpu.name}; diff --git a/pkgs/servers/http/nginx/mainline.nix b/pkgs/servers/http/nginx/mainline.nix index 2bfe03295958..71cb6fc72ab9 100644 --- a/pkgs/servers/http/nginx/mainline.nix +++ b/pkgs/servers/http/nginx/mainline.nix @@ -1,6 +1,6 @@ { callPackage, ... }@args: callPackage ./generic.nix (args // { - version = "1.13.9"; - sha256 = "0hpsyxpxj89p5vrzv9p1hp7xjbnj5c1w6fdy626ycvsiay4a3bjz"; + version = "1.13.12"; + sha256 = "1pl5ii1w2ycxprxk8zdnxlpdd1dia6hyrns7mnqkm3fv5ihgb4pv"; }) diff --git a/pkgs/servers/http/nginx/stable.nix b/pkgs/servers/http/nginx/stable.nix index 7bd74c3a3325..1b61cb87c9af 100644 --- a/pkgs/servers/http/nginx/stable.nix +++ b/pkgs/servers/http/nginx/stable.nix @@ -1,6 +1,6 @@ { callPackage, ... } @ args: callPackage ./generic.nix (args // { - version = "1.12.2"; - sha256 = "05h4rwja7170z0l979yjghy9i9ichllwhicylzpmmyyml6fkfprh"; + version = "1.14.0"; + sha256 = "1d9c0avfpbwvzyg53b59ks8shpnrxnbnshcd7ziizflsyv5vw5ax"; }) diff --git a/pkgs/servers/nosql/apache-jena/binary.nix b/pkgs/servers/nosql/apache-jena/binary.nix index b028fcdf37d5..f3d5d121c387 100644 --- a/pkgs/servers/nosql/apache-jena/binary.nix +++ b/pkgs/servers/nosql/apache-jena/binary.nix @@ -3,10 +3,10 @@ let s = # Generated upstream information rec { baseName="apache-jena"; - version = "3.5.0"; + version = "3.7.0"; name="${baseName}-${version}"; url="http://archive.apache.org/dist/jena/binaries/apache-jena-${version}.tar.gz"; - sha256 = "08hfn359l9s4lckba9xgghkn32r12gqzjjr5s5hn3fzkbsig7njy"; + sha256 = "12w125hlhcib23cckk77cx7p9rzs57dbmmn90f7v8107d437j4mq"; }; buildInputs = [ makeWrapper diff --git a/pkgs/tools/filesystems/hfsprogs/default.nix b/pkgs/tools/filesystems/hfsprogs/default.nix new file mode 100644 index 000000000000..25ec31ea698a --- /dev/null +++ b/pkgs/tools/filesystems/hfsprogs/default.nix @@ -0,0 +1,45 @@ +{ stdenv, fetchurl, openssl, libbsd }: + +let version = "332.25"; + package_name = "hfsprogs"; in +stdenv.mkDerivation rec { + name = "${package_name}-${version}"; + srcs = [ + (fetchurl { + url = "http://ftp.de.debian.org/debian/pool/main/h/hfsprogs/${package_name}_${version}-11.debian.tar.gz"; + sha256 = "62d9b8599c66ebffbc57ce5d776e20b41341130d9b27341d63bda08460ebde7c"; + }) + (fetchurl { + url = "https://opensource.apple.com/tarballs/diskdev_cmds/diskdev_cmds-${version}.tar.gz"; + sha256 = "74c9aeca899ed7f4bf155c65fc45bf0f250c0f6d57360ea953b1d536d9aa45e6"; + }) + ]; + + sourceRoot = "diskdev_cmds-" + version; + patches = [ "../debian/patches/*.patch" ]; + + buildInputs = [ openssl libbsd ]; + makefile = "Makefile.lnx"; + + # Inspired by PKGBUILD of https://www.archlinux.org/packages/community/x86_64/hfsprogs/ + installPhase = '' + # Create required package directories + install -m 755 -d "$out/bin" + install -m 755 -d "$out/share/${package_name}" + install -m 755 -d "$out/share/man/man8/" + # Copy executables + install -m 755 "newfs_hfs.tproj/newfs_hfs" "$out/bin/mkfs.hfsplus" + install -m 755 "fsck_hfs.tproj/fsck_hfs" "$out/bin/fsck.hfsplus" + # Copy shared data + install -m 644 "newfs_hfs.tproj/hfsbootdata.img" "$out/share/${package_name}/hfsbootdata" + # Copy man pages + install -m 644 "newfs_hfs.tproj/newfs_hfs.8" "$out/share/man/man8/mkfs.hfsplus.8" + install -m 644 "fsck_hfs.tproj/fsck_hfs.8" "$out/share/man/man8/fsck.hfsplus.8" + ''; + + meta = { + description = "HFS/HFS+ user space utils"; + license = stdenv.lib.licenses.apsl20; + platforms = stdenv.lib.platforms.linux; + }; +} diff --git a/pkgs/tools/filesystems/smbnetfs/default.nix b/pkgs/tools/filesystems/smbnetfs/default.nix index 7ff42c4d1f99..9c279f99b005 100644 --- a/pkgs/tools/filesystems/smbnetfs/default.nix +++ b/pkgs/tools/filesystems/smbnetfs/default.nix @@ -1,15 +1,15 @@ -{ stdenv, fetchurl, fuse, samba, pkgconfig, glib }: +{ stdenv, fetchurl, fuse, samba, pkgconfig, glib, autoconf, attr, libsecret }: stdenv.mkDerivation rec { name = "smbnetfs-${version}"; - version = "0.6.0"; + version = "0.6.1"; src = fetchurl { url = "mirror://sourceforge/project/smbnetfs/smbnetfs/SMBNetFS-${version}/${name}.tar.bz2"; - sha256 = "16sikr81ipn8v1a1zrqgnsy2as3zcaxbzkr0bm5vxy012bq0plkd"; + sha256 = "02iqjnm6pdwc1q38z56akiwdbp0xisr6qwrmxs1lrk5mq7j8x2w4"; }; - nativeBuildInputs = [ pkgconfig ]; - buildInputs = [ fuse samba glib ]; + nativeBuildInputs = [ pkgconfig autoconf ]; + buildInputs = [ fuse samba glib attr libsecret ]; meta = with stdenv.lib; { description = "A FUSE FS for mounting Samba shares"; diff --git a/pkgs/tools/system/dd_rescue/default.nix b/pkgs/tools/system/dd_rescue/default.nix index ee82af1a4707..1ea574dbe8ea 100644 --- a/pkgs/tools/system/dd_rescue/default.nix +++ b/pkgs/tools/system/dd_rescue/default.nix @@ -1,11 +1,11 @@ { stdenv, fetchurl, autoconf }: stdenv.mkDerivation rec { - version = "1.99.7"; + version = "1.99.8"; name = "dd_rescue-${version}"; src = fetchurl { - sha256 = "0d318i1i5d7hbj06wmb3xag14x542cv7fpkh5zjf5ccm64nyzir4"; + sha256 = "1gbxm8gr9sx5g1q9dycs21hkxikcy97q09lp1lvs59pnd9qpdnwh"; url="http://www.garloff.de/kurt/linux/ddrescue/${name}.tar.bz2"; }; diff --git a/pkgs/top-level/all-packages.nix b/pkgs/top-level/all-packages.nix index 11f0d4ae4239..3a327c8cd5c3 100644 --- a/pkgs/top-level/all-packages.nix +++ b/pkgs/top-level/all-packages.nix @@ -2917,6 +2917,8 @@ with pkgs; hiera-eyaml = callPackage ../tools/system/hiera-eyaml { }; + hfsprogs = callPackage ../tools/filesystems/hfsprogs { }; + highlight = callPackage ../tools/text/highlight ({ lua = lua5; } // lib.optionalAttrs stdenv.isDarwin { @@ -3466,6 +3468,11 @@ with pkgs; libite = callPackage ../development/libraries/libite { }; + liblangtag = callPackage ../development/libraries/liblangtag { + inherit (gnome2) gtkdoc; + inherit (gnome3) gnome-common; + }; + liblouis = callPackage ../development/libraries/liblouis { }; liboauth = callPackage ../development/libraries/liboauth { }; |