diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/builders/images/dockertools.xml | 6 | ||||
-rw-r--r-- | doc/builders/trivial-builders.xml | 21 | ||||
-rw-r--r-- | doc/contributing/coding-conventions.xml | 21 | ||||
-rw-r--r-- | doc/languages-frameworks/gnome.xml | 12 | ||||
-rw-r--r-- | doc/languages-frameworks/go.xml | 4 | ||||
-rw-r--r-- | doc/stdenv/stdenv.xml | 10 |
6 files changed, 56 insertions, 18 deletions
diff --git a/doc/builders/images/dockertools.xml b/doc/builders/images/dockertools.xml index 2243453c3e9..e7f37fdaaf0 100644 --- a/doc/builders/images/dockertools.xml +++ b/doc/builders/images/dockertools.xml @@ -8,12 +8,6 @@ <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> diff --git a/doc/builders/trivial-builders.xml b/doc/builders/trivial-builders.xml index df0e38da1aa..94948c57b91 100644 --- a/doc/builders/trivial-builders.xml +++ b/doc/builders/trivial-builders.xml @@ -7,7 +7,7 @@ Nixpkgs provides a couple of functions that help with building derivations. The most important one, <function>stdenv.mkDerivation</function>, has already been documented above. The following functions wrap <function>stdenv.mkDerivation</function>, making it easier to use in certain cases. </para> <variablelist> - <varlistentry> + <varlistentry xml:id="trivial-builder-runCommand"> <term> <literal>runCommand</literal> </term> @@ -40,7 +40,7 @@ </programlisting> </listitem> </varlistentry> - <varlistentry> + <varlistentry xml:id="trivial-builder-runCommandCC"> <term> <literal>runCommandCC</literal> </term> @@ -50,7 +50,20 @@ </para> </listitem> </varlistentry> - <varlistentry> + <varlistentry xml:id="trivial-builder-runCommandLocal"> + <term> + <literal>runCommandLocal</literal> + </term> + <listitem> + <para> + Variant of <literal>runCommand</literal> that forces the derivation to be built locally, it is not substituted. This is intended for very cheap commands (<1s execution time). It saves on the network roundrip and can speed up a build. + </para> + <note><para> + This sets <link xlink:href="https://nixos.org/nix/manual/#adv-attr-allowSubstitutes"><literal>allowSubstitutes</literal> to <literal>false</literal></link>, so only use <literal>runCommandLocal</literal> if you are certain the user will always have a builder for the <literal>system</literal> of the derivation. This should be true for most trivial use cases (e.g. just copying some files to a different location or adding symlinks), because there the <literal>system</literal> is usually the same as <literal>builtins.currentSystem</literal>. + </para></note> + </listitem> + </varlistentry> + <varlistentry xml:id="trivial-builder-writeText"> <term> <literal>writeTextFile</literal>, <literal>writeText</literal>, <literal>writeTextDir</literal>, <literal>writeScript</literal>, <literal>writeScriptBin</literal> </term> @@ -63,7 +76,7 @@ </para> </listitem> </varlistentry> - <varlistentry> + <varlistentry xml:id="trivial-builder-symlinkJoin"> <term> <literal>symlinkJoin</literal> </term> diff --git a/doc/contributing/coding-conventions.xml b/doc/contributing/coding-conventions.xml index 799f1479467..fcb6501f615 100644 --- a/doc/contributing/coding-conventions.xml +++ b/doc/contributing/coding-conventions.xml @@ -622,6 +622,16 @@ args.stdenv.mkDerivation (args // { </varlistentry> <varlistentry> <term> + If it’s an <emphasis>icon theme</emphasis>: + </term> + <listitem> + <para> + <filename>data/icons</filename> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> If it’s related to <emphasis>SGML/XML processing</emphasis>: </term> <listitem> @@ -652,6 +662,17 @@ args.stdenv.mkDerivation (args // { </variablelist> </listitem> </varlistentry> + <varlistentry> + <term> + If it’s a <emphasis>theme</emphasis> for a <emphasis>desktop environment</emphasis>, + a <emphasis>window manager</emphasis> or a <emphasis>display manager</emphasis>: + </term> + <listitem> + <para> + <filename>data/themes</filename> + </para> + </listitem> + </varlistentry> </variablelist> </listitem> </varlistentry> diff --git a/doc/languages-frameworks/gnome.xml b/doc/languages-frameworks/gnome.xml index 9c3afe127a4..bb68d026ae2 100644 --- a/doc/languages-frameworks/gnome.xml +++ b/doc/languages-frameworks/gnome.xml @@ -199,9 +199,9 @@ python3.pkgs.buildPythonApplication { dontWrapGApps = true; # Arguments to be passed to `makeWrapper`, only used by buildPython* - makeWrapperArgs = [ - "\${gappsWrapperArgs[@]}" - ]; + preFixup = '' + makeWrapperArgs+=("''${gappsWrapperArgs[@]}") + ''; } </programlisting> And for a QT app like: @@ -219,9 +219,9 @@ mkDerivation { dontWrapGApps = true; # Arguments to be passed to `makeWrapper`, only used by qt5’s mkDerivation - qtWrapperArgs = [ - "\${gappsWrapperArgs[@]}" - ]; + preFixup = '' + qtWrapperArgs+=("''${gappsWrapperArgs[@]}") + ''; } </programlisting> </para> diff --git a/doc/languages-frameworks/go.xml b/doc/languages-frameworks/go.xml index 288a9029863..bd1ee8eba27 100644 --- a/doc/languages-frameworks/go.xml +++ b/doc/languages-frameworks/go.xml @@ -26,7 +26,7 @@ <title>buildGoModule</title> <programlisting> pet = buildGoModule rec { - name = "pet-${version}"; + pname = "pet"; version = "0.3.4"; src = fetchFromGitHub { @@ -79,7 +79,7 @@ pet = buildGoModule rec { <title>buildGoPackage</title> <programlisting> deis = buildGoPackage rec { - name = "deis-${version}"; + pname = "deis"; version = "1.13.0"; goPackagePath = "github.com/deis/deis"; <co xml:id='ex-buildGoPackage-1' /> diff --git a/doc/stdenv/stdenv.xml b/doc/stdenv/stdenv.xml index 49699d7168d..1e97bf6157b 100644 --- a/doc/stdenv/stdenv.xml +++ b/doc/stdenv/stdenv.xml @@ -1123,6 +1123,16 @@ preBuild = '' <variablelist> <title>Variables controlling the install phase</title> + <varlistentry> + <term> + <varname>dontInstall</varname> + </term> + <listitem> + <para> + Set to true to skip the install phase. + </para> + </listitem> + </varlistentry> <varlistentry> <term> <varname>makeFlags</varname> / <varname>makeFlagsArray</varname> / <varname>makefile</varname> |