diff options
Diffstat (limited to 'doc/builders/images/ocitools.section.md')
| -rw-r--r-- | doc/builders/images/ocitools.section.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/builders/images/ocitools.section.md b/doc/builders/images/ocitools.section.md index d3dee57ebac68..d3ab8776786bd 100644 --- a/doc/builders/images/ocitools.section.md +++ b/doc/builders/images/ocitools.section.md @@ -1,10 +1,10 @@ # pkgs.ociTools {#sec-pkgs-ociTools} -`pkgs.ociTools` is a set of functions for creating containers according to the [OCI container specification v1.0.0](https://github.com/opencontainers/runtime-spec). Beyond that it makes no assumptions about the container runner you choose to use to run the created container. +`pkgs.ociTools` is a set of functions for creating containers according to the [OCI container specification v1.0.0](https://github.com/opencontainers/runtime-spec). Beyond that, it makes no assumptions about the container runner you choose to use to run the created container. ## buildContainer {#ssec-pkgs-ociTools-buildContainer} -This function creates a simple OCI container that runs a single command inside of it. An OCI container consists of a `config.json` and a rootfs directory.The nix store of the container will contain all referenced dependencies of the given command. +This function creates a simple OCI container that runs a single command inside of it. An OCI container consists of a `config.json` and a rootfs directory. The nix store of the container will contain all referenced dependencies of the given command. The parameters of `buildContainer` with an example value are described below: @@ -30,7 +30,7 @@ buildContainer { } ``` -- `args` specifies a set of arguments to run inside the container. This is the only required argument for `buildContainer`. All referenced packages inside the derivation will be made available inside the container +- `args` specifies a set of arguments to run inside the container. This is the only required argument for `buildContainer`. All referenced packages inside the derivation will be made available inside the container. - `mounts` specifies additional mount points chosen by the user. By default only a minimal set of necessary filesystems are mounted into the container (e.g procfs, cgroupfs) |