summaryrefslogtreecommitdiffstats
path: root/doc/functions.xml
diff options
context:
space:
mode:
authorEelco Dolstra <edolstra@gmail.com>2018-09-03 17:13:02 +0200
committerEelco Dolstra <edolstra@gmail.com>2018-09-03 17:13:46 +0200
commiteac06ed0702638b7e9a058e5412940474ff872ca (patch)
tree975e084bef049bc23bc3e0c63368786a0aa18833 /doc/functions.xml
parent3db3ae3700f6e3ced14cf33da05ae91a06d8e5bf (diff)
Manual: Random indentation fixes
Diffstat (limited to 'doc/functions.xml')
-rw-r--r--doc/functions.xml158
1 files changed, 84 insertions, 74 deletions
diff --git a/doc/functions.xml b/doc/functions.xml
index ec188e234543..3cfc6884bd26 100644
--- a/doc/functions.xml
+++ b/doc/functions.xml
@@ -1,7 +1,7 @@
<chapter xmlns="http://docbook.org/ns/docbook"
- xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
- xml:id="chap-functions">
+ xml:id="chap-functions">
<title>Functions reference</title>
<para>
The nixpkgs repository has several utility functions to manipulate Nix
@@ -31,12 +31,16 @@
<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 {
- mydep = pkgs.mydep.override { ... };
- }</programlisting>
+<programlisting>
+import pkgs.path { overlays = [ (self: super: {
+ foo = super.foo.override { barSupport = true ; };
+ })]};
+</programlisting>
+<programlisting>
+mypkg = pkgs.callPackage ./mypkg.nix {
+ mydep = pkgs.mydep.override { ... };
+ }
+</programlisting>
</para>
<para>
@@ -61,9 +65,11 @@
<para>
Example usage:
-<programlisting>helloWithDebug = pkgs.hello.overrideAttrs (oldAttrs: rec {
- separateDebugInfo = true;
- });</programlisting>
+<programlisting>
+helloWithDebug = pkgs.hello.overrideAttrs (oldAttrs: rec {
+ separateDebugInfo = true;
+});
+</programlisting>
</para>
<para>
@@ -134,14 +140,16 @@
<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;
- sha256 = "11nq06d131y4wmf3drm0yk502d2xc6n5qy82cg88rb9nqd2lj41k";
- };
- patches = [];
- });</programlisting>
+<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;
+ sha256 = "11nq06d131y4wmf3drm0yk502d2xc6n5qy82cg88rb9nqd2lj41k";
+ };
+ patches = [];
+});
+</programlisting>
</para>
<para>
@@ -181,8 +189,10 @@
<para>
Example usage:
-<programlisting>f = { a, b }: { result = a+b; }
- c = lib.makeOverridable f { a = 1; b = 2; }</programlisting>
+<programlisting>
+f = { a, b }: { result = a+b; };
+c = lib.makeOverridable f { a = 1; b = 2; };
+</programlisting>
</para>
<para>
@@ -482,29 +492,29 @@ merge:"diff3"
<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' />
-
- fromImage = someBaseImage; <co xml:id='ex-dockerTools-buildImage-3' />
- fromImageName = null; <co xml:id='ex-dockerTools-buildImage-4' />
- fromImageTag = "latest"; <co xml:id='ex-dockerTools-buildImage-5' />
-
- contents = pkgs.redis; <co xml:id='ex-dockerTools-buildImage-6' />
- runAsRoot = '' <co xml:id='ex-dockerTools-buildImage-runAsRoot' />
- #!${stdenv.shell}
- mkdir -p /data
- '';
-
- config = { <co xml:id='ex-dockerTools-buildImage-8' />
- Cmd = [ "/bin/redis-server" ];
- WorkingDir = "/data";
- Volumes = {
- "/data" = {};
- };
+buildImage {
+ name = "redis"; <co xml:id='ex-dockerTools-buildImage-1' />
+ tag = "latest"; <co xml:id='ex-dockerTools-buildImage-2' />
+
+ fromImage = someBaseImage; <co xml:id='ex-dockerTools-buildImage-3' />
+ fromImageName = null; <co xml:id='ex-dockerTools-buildImage-4' />
+ fromImageTag = "latest"; <co xml:id='ex-dockerTools-buildImage-5' />
+
+ contents = pkgs.redis; <co xml:id='ex-dockerTools-buildImage-6' />
+ runAsRoot = '' <co xml:id='ex-dockerTools-buildImage-runAsRoot' />
+ #!${stdenv.shell}
+ mkdir -p /data
+ '';
+
+ config = { <co xml:id='ex-dockerTools-buildImage-8' />
+ Cmd = [ "/bin/redis-server" ];
+ WorkingDir = "/data";
+ Volumes = {
+ "/data" = {};
};
- }
- </programlisting>
+ };
+}
+</programlisting>
</example>
<para>
@@ -647,15 +657,15 @@ merge:"diff3"
<example xml:id='ex-dockerTools-pullImage'>
<title>Docker pull</title>
<programlisting>
- pullImage {
- imageName = "nixos/nix"; <co xml:id='ex-dockerTools-pullImage-1' />
- imageDigest = "sha256:20d9485b25ecfd89204e843a962c1bd70e9cc6858d65d7f5fadc340246e2116b"; <co xml:id='ex-dockerTools-pullImage-2' />
- finalImageTag = "1.11"; <co xml:id='ex-dockerTools-pullImage-3' />
- sha256 = "0mqjy3zq2v6rrhizgb9nvhczl87lcfphq9601wcprdika2jz7qh8"; <co xml:id='ex-dockerTools-pullImage-4' />
- os = "linux"; <co xml:id='ex-dockerTools-pullImage-5' />
- arch = "x86_64"; <co xml:id='ex-dockerTools-pullImage-6' />
- }
- </programlisting>
+pullImage {
+ imageName = "nixos/nix"; <co xml:id='ex-dockerTools-pullImage-1' />
+ imageDigest = "sha256:20d9485b25ecfd89204e843a962c1bd70e9cc6858d65d7f5fadc340246e2116b"; <co xml:id='ex-dockerTools-pullImage-2' />
+ finalImageTag = "1.11"; <co xml:id='ex-dockerTools-pullImage-3' />
+ sha256 = "0mqjy3zq2v6rrhizgb9nvhczl87lcfphq9601wcprdika2jz7qh8"; <co xml:id='ex-dockerTools-pullImage-4' />
+ os = "linux"; <co xml:id='ex-dockerTools-pullImage-5' />
+ arch = "x86_64"; <co xml:id='ex-dockerTools-pullImage-6' />
+}
+</programlisting>
</example>
<calloutlist>
@@ -677,9 +687,9 @@ merge:"diff3"
exactly which image you want. By default it will match the OS and
architecture of the host the command is run on.
<programlisting>
- $ nix-shell --packages skopeo jq --command "skopeo --override-os linux --override-arch x86_64 inspect docker://docker.io/nixos/nix:1.11 | jq -r '.Digest'"
- sha256:20d9485b25ecfd89204e843a962c1bd70e9cc6858d65d7f5fadc340246e2116b
- </programlisting>
+$ nix-shell --packages skopeo jq --command "skopeo --override-os linux --override-arch x86_64 inspect docker://docker.io/nixos/nix:1.11 | jq -r '.Digest'"
+sha256:20d9485b25ecfd89204e843a962c1bd70e9cc6858d65d7f5fadc340246e2116b
+</programlisting>
This argument is required.
</para>
</callout>
@@ -737,13 +747,13 @@ merge:"diff3"
<example xml:id='ex-dockerTools-exportImage'>
<title>Docker export</title>
<programlisting>
- exportImage {
- fromImage = someLayeredImage;
- fromImageName = null;
- fromImageTag = null;
+exportImage {
+ fromImage = someLayeredImage;
+ fromImageName = null;
+ fromImageTag = null;
- name = someLayeredImage.name;
- }
+ name = someLayeredImage.name;
+}
</programlisting>
</example>
@@ -774,19 +784,19 @@ merge:"diff3"
<example xml:id='ex-dockerTools-shadowSetup'>
<title>Shadow base files</title>
<programlisting>
- buildImage {
- name = "shadow-basic";
-
- runAsRoot = ''
- #!${stdenv.shell}
- ${shadowSetup}
- groupadd -r redis
- useradd -r -g redis redis
- mkdir /data
- chown redis:redis /data
- '';
- }
- </programlisting>
+buildImage {
+ name = "shadow-basic";
+
+ runAsRoot = ''
+ #!${stdenv.shell}
+ ${shadowSetup}
+ groupadd -r redis
+ useradd -r -g redis redis
+ mkdir /data
+ chown redis:redis /data
+ '';
+}
+</programlisting>
</example>
<para>