diff options
author | worldofpeace <worldofpeace@protonmail.ch> | 2019-08-05 21:53:07 -0400 |
---|---|---|
committer | worldofpeace <worldofpeace@protonmail.ch> | 2019-09-17 21:30:09 -0400 |
commit | cd518845e2ca008f5a00b38ffa0f1c99f154f6cc (patch) | |
tree | cd655c01a8934ea529d71082412ced5dc7f89c7d /doc/functions | |
parent | 17fb9ffdda0eba2a613e29e135070df20578e768 (diff) |
doc/stdenv: document meson variables
Diffstat (limited to 'doc/functions')
-rw-r--r-- | doc/functions/dockertools.xml | 34 | ||||
-rw-r--r-- | doc/functions/ocitools.xml | 12 |
2 files changed, 20 insertions, 26 deletions
diff --git a/doc/functions/dockertools.xml b/doc/functions/dockertools.xml index a284182bb047..6b293a2e7787 100644 --- a/doc/functions/dockertools.xml +++ b/doc/functions/dockertools.xml @@ -325,10 +325,9 @@ hello latest de2bf4786de6 About a minute ago 25.2MB </term> <listitem> <para> - Shell commands to run while building the final layer, without access - to most of the layer contents. Changes to this layer are "on top" - of all the other layers, so can create additional directories - and files. + Shell commands to run while building the final layer, without access to + most of the layer contents. Changes to this layer are "on top" of all the + other layers, so can create additional directories and files. </para> </listitem> </varlistentry> @@ -493,28 +492,23 @@ pullImage { </calloutlist> <para> - <literal>nix-prefetch-docker</literal> command can be used to get required - image parameters: - + <literal>nix-prefetch-docker</literal> command can be used to get required + image parameters: <screen> <prompt>$ </prompt>nix run nixpkgs.nix-prefetch-docker -c nix-prefetch-docker --image-name mysql --image-tag 5 </screen> - - Since a given <varname>imageName</varname> may transparently refer to a - manifest list of images which support multiple architectures and/or - operating systems, you can supply the <option>--os</option> and - <option>--arch</option> arguments to specify exactly which image you want. - By default it will match the OS and architecture of the host the command is - run on. - + Since a given <varname>imageName</varname> may transparently refer to a + manifest list of images which support multiple architectures and/or + operating systems, you can supply the <option>--os</option> and + <option>--arch</option> arguments to specify exactly which image you want. + By default it will match the OS and architecture of the host the command is + run on. <screen> <prompt>$ </prompt>nix-prefetch-docker --image-name mysql --image-tag 5 --arch x86_64 --os linux </screen> - - Desired image name and tag can be set using - <option>--final-image-name</option> and <option>--final-image-tag</option> - arguments: - + Desired image name and tag can be set using + <option>--final-image-name</option> and <option>--final-image-tag</option> + arguments: <screen> <prompt>$ </prompt>nix-prefetch-docker --image-name mysql --image-tag 5 --final-image-name eu.gcr.io/my-project/mysql --final-image-tag prod </screen> diff --git a/doc/functions/ocitools.xml b/doc/functions/ocitools.xml index 163bee2382e6..56de0c22ec61 100644 --- a/doc/functions/ocitools.xml +++ b/doc/functions/ocitools.xml @@ -51,10 +51,10 @@ buildContainer { <calloutlist> <callout arearefs='ex-ociTools-buildContainer-1'> <para> - <varname>args</varname> specifies a set of arguments to run inside the container. - This is the only required argument for <varname>buildContainer</varname>. - All referenced packages inside the derivation will be made available - inside the container + <varname>args</varname> specifies a set of arguments to run inside the + container. This is the only required argument for + <varname>buildContainer</varname>. All referenced packages inside the + derivation will be made available inside the container </para> </callout> <callout arearefs='ex-ociTools-buildContainer-2'> @@ -66,8 +66,8 @@ buildContainer { </callout> <callout arearefs='ex-ociTools-buildContainer-3'> <para> - <varname>readonly</varname> makes the container's rootfs read-only if it is set to true. - The default value is false <literal>false</literal>. + <varname>readonly</varname> makes the container's rootfs read-only if it + is set to true. The default value is false <literal>false</literal>. </para> </callout> </calloutlist> |