git.iko.soy/typeable/nixpkgs
on master help sign in
doc: remove unnecessary \ escapes in dockertools.section.md

These pollute the plain text and, after re-running `nix-build` and looking at the result, do not appear to have any impact on the rendered version.

commit9c4353833f9fb0ad70ccb817f64a5497a3b68636 authorBenjamin Hipple <bhipple@protonmail.com> dateTue 9 Mar 2021, 18:59 (6 years ago) parentcefc9a2
1 file changed+14−14
doc/builders/images/dockertools.section.md+14−14
doc/builders/images/dockertools.section.md+14−14
@@ -38,15 +38,15 @@ The above example will build a Docker image `redis/latest` from the given base i
3838
3939- `name` specifies the name of the resulting image. This is the only required argument for `buildImage`.
4040
41−- `tag` specifies the tag of the resulting image. By default it\'s `null`, which indicates that the nix output hash will be used as tag.
41+- `tag` specifies the tag of the resulting image. By default it's `null`, which indicates that the nix output hash will be used as tag.
4242
43−- `fromImage` is the repository tarball containing the base image. It must be a valid Docker image, such as exported by `docker save`. By default it\'s `null`, which can be seen as equivalent to `FROM scratch` of a `Dockerfile`.
43+- `fromImage` is the repository tarball containing the base image. It must be a valid Docker image, such as exported by `docker save`. By default it's `null`, which can be seen as equivalent to `FROM scratch` of a `Dockerfile`.
4444
45−- `fromImageName` can be used to further specify the base image within the repository, in case it contains multiple images. By default it\'s `null`, in which case `buildImage` will peek the first image available in the repository.
45+- `fromImageName` can be used to further specify the base image within the repository, in case it contains multiple images. By default it's `null`, in which case `buildImage` will peek the first image available in the repository.
4646
47−- `fromImageTag` 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 `null`, in which case `buildImage` will peek the first tag available for the base image.
47+- `fromImageTag` 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 `null`, in which case `buildImage` will peek the first tag available for the base image.
4848
49−- `contents` is a derivation that will be copied in the new layer of the resulting image. This can be similarly seen as `ADD contents/ /` in a `Dockerfile`. By default it\'s `null`.
49+- `contents` is a derivation that will be copied in the new layer of the resulting image. This can be similarly seen as `ADD contents/ /` in a `Dockerfile`. By default it's `null`.
5050
5151- `runAsRoot` 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 `contents` derivation. This can be similarly seen as `RUN ...` in a `Dockerfile`.
5252
@@ -109,7 +109,7 @@ Create a Docker image with many of the store paths being on their own layer to i
109109
110110: Tag of the generated image.
111111
112− *Default:* the output path\'s hash
112+ *Default:* the output path's hash
113113
114114`contents` _optional_
115115
@@ -139,7 +139,7 @@ Create a Docker image with many of the store paths being on their own layer to i
139139
140140`extraCommands` _optional_
141141
142−: 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.
142+: 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.
143143
144144### Behavior of `contents` in the final image {#dockerTools-buildLayeredImage-arg-contents}
145145
@@ -183,9 +183,9 @@ Modern Docker installations support up to 128 layers, however older versions sup
183183
184184If the produced image will not be extended by other Docker builds, it is safe to set `maxLayers` to `128`. However it will be impossible to extend the image further.
185185
186−The first (`maxLayers-2`) most \"popular\" paths will have their own individual layers, then layer \#`maxLayers-1` will contain all the remaining \"unpopular\" paths, and finally layer \#`maxLayers` will contain the Image configuration.
186+The first (`maxLayers-2`) most "popular" paths will have their own individual layers, then layer \#`maxLayers-1` will contain all the remaining "unpopular" paths, and finally layer \#`maxLayers` will contain the Image configuration.
187187
188−Docker\'s Layers are not inherently ordered, they are content-addressable and are not explicitly layered until they are composed in to an Image.
188+Docker's Layers are not inherently ordered, they are content-addressable and are not explicitly layered until they are composed in to an Image.
189189
190190## streamLayeredImage {#ssec-pkgs-dockerTools-streamLayeredImage}
191191
@@ -226,15 +226,15 @@ pullImage {
226226
227227- `imageDigest` specifies the digest of the image to be downloaded. This argument is required.
228228
229−- `finalImageName`, if specified, this is the name of the image to be created. Note it is never used to fetch the image since we prefer to rely on the immutable digest ID. By default it\'s equal to `imageName`.
229+- `finalImageName`, if specified, this is the name of the image to be created. Note it is never used to fetch the image since we prefer to rely on the immutable digest ID. By default it's equal to `imageName`.
230230
231−- `finalImageTag`, if specified, this is the tag of the image to be created. Note it is never used to fetch the image since we prefer to rely on the immutable digest ID. By default it\'s `latest`.
231+- `finalImageTag`, if specified, this is the tag of the image to be created. Note it is never used to fetch the image since we prefer to rely on the immutable digest ID. By default it's `latest`.
232232
233233- `sha256` is the checksum of the whole fetched image. This argument is required.
234234
235−- `os`, if specified, is the operating system of the fetched image. By default it\'s `linux`.
235+- `os`, if specified, is the operating system of the fetched image. By default it's `linux`.
236236
237−- `arch`, if specified, is the cpu architecture of the fetched image. By default it\'s `x86_64`.
237+- `arch`, if specified, is the cpu architecture of the fetched image. By default it's `x86_64`.
238238
239239`nix-prefetch-docker` command can be used to get required image parameters:
240240
@@ -278,7 +278,7 @@ The `name` argument is the name of the derivation output, which defaults to `fro
278278
279279## shadowSetup {#ssec-pkgs-dockerTools-shadowSetup}
280280
281−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 [`buildImage` `runAsRoot`](#ex-dockerTools-buildImage-runAsRoot) script for cases like in the example below:
281+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 [`buildImage` `runAsRoot`](#ex-dockerTools-buildImage-runAsRoot) script for cases like in the example below:
282282
283283```nix
284284buildImage {