diff options
author | Jan Tojnar <jtojnar@gmail.com> | 2021-06-05 21:22:45 +0200 |
---|---|---|
committer | Jan Tojnar <jtojnar@gmail.com> | 2021-06-07 06:34:59 +0200 |
commit | 6ecc641d087df8b8896ebd876bba592e981877c9 (patch) | |
tree | c3dc98e6b6a4a6474b21ad06e7bbc96d0e8abaf5 /doc/builders/images | |
parent | ce6b1a4f8f9cbbb7fd2d1c637bcc39fff1ef49df (diff) |
doc: prepare for commonmark
We are still using Pandoc’s Markdown parser, which differs from CommonMark spec slightly. Notably: - Line breaks in lists behave differently. - Admonitions do not support the simpler syntax https://github.com/jgm/commonmark-hs/issues/75 - The auto_identifiers uses a different algorithm – I made the previous ones explicit. - Languages (classes) of code blocks cannot contain whitespace so we have to use “pycon” alias instead of Python “console” as GitHub’s linguist While at it, I also fixed the following issues: - ShellSesssion was used - Removed some pointless docbook tags.
Diffstat (limited to 'doc/builders/images')
-rw-r--r-- | doc/builders/images/appimagetools.section.md | 2 | ||||
-rw-r--r-- | doc/builders/images/dockertools.section.md | 4 | ||||
-rw-r--r-- | doc/builders/images/snaptools.section.md | 4 |
3 files changed, 5 insertions, 5 deletions
diff --git a/doc/builders/images/appimagetools.section.md b/doc/builders/images/appimagetools.section.md index 7ab4e4e9d855f..67e63dc5f61af 100644 --- a/doc/builders/images/appimagetools.section.md +++ b/doc/builders/images/appimagetools.section.md @@ -2,7 +2,7 @@ `pkgs.appimageTools` is a set of functions for extracting and wrapping [AppImage](https://appimage.org/) files. They are meant to be used if traditional packaging from source is infeasible, or it would take too long. To quickly run an AppImage file, `pkgs.appimage-run` can be used as well. -::: warning +::: {.warning} The `appimageTools` API is unstable and may be subject to backwards-incompatible changes in the future. ::: diff --git a/doc/builders/images/dockertools.section.md b/doc/builders/images/dockertools.section.md index 2d21eb1c2e07e..bfe1d17a60674 100644 --- a/doc/builders/images/dockertools.section.md +++ b/doc/builders/images/dockertools.section.md @@ -1,6 +1,6 @@ # pkgs.dockerTools {#sec-pkgs-dockerTools} -`pkgs.dockerTools` is a set of functions for creating and manipulating Docker images according to the [ Docker Image Specification v1.2.0 ](https://github.com/moby/moby/blob/master/image/spec/v1.2.md#docker-image-specification-v120). Docker itself is not used to perform any of the operations done by these functions. +`pkgs.dockerTools` is a set of functions for creating and manipulating Docker images according to the [Docker Image Specification v1.2.0](https://github.com/moby/moby/blob/master/image/spec/v1.2.md#docker-image-specification-v120). Docker itself is not used to perform any of the operations done by these functions. ## buildImage {#ssec-pkgs-dockerTools-buildImage} @@ -52,7 +52,7 @@ The above example will build a Docker image `redis/latest` from the given base i > **_NOTE:_** Using this parameter requires the `kvm` device to be available. -- `config` is used to specify the configuration of the containers that will be started off the built image in Docker. The available options are listed in the [ Docker Image Specification v1.2.0 ](https://github.com/moby/moby/blob/master/image/spec/v1.2.md#image-json-field-descriptions). +- `config` is used to specify the configuration of the containers that will be started off the built image in Docker. The available options are listed in the [Docker Image Specification v1.2.0](https://github.com/moby/moby/blob/master/image/spec/v1.2.md#image-json-field-descriptions). After the new layer has been created, its closure (to which `contents`, `config` and `runAsRoot` contribute) will be copied in the layer itself. Only new dependencies that are not already in the existing layers will be copied. diff --git a/doc/builders/images/snaptools.section.md b/doc/builders/images/snaptools.section.md index 9e1403b88285a..5f710d2de7fe0 100644 --- a/doc/builders/images/snaptools.section.md +++ b/doc/builders/images/snaptools.section.md @@ -14,7 +14,7 @@ Currently, `makeSnap` does not support creating GUI stubs. The following expression packages GNU Hello as a Snapcraft snap. -```{#ex-snapTools-buildSnap-hello .nix} +``` {#ex-snapTools-buildSnap-hello .nix} let inherit (import <nixpkgs> { }) snapTools hello; in snapTools.makeSnap { @@ -35,7 +35,7 @@ in snapTools.makeSnap { Graphical programs require many more integrations with the host. This example uses Firefox as an example, because it is one of the most complicated programs we could package. -```{#ex-snapTools-buildSnap-firefox .nix} +``` {#ex-snapTools-buildSnap-firefox .nix} let inherit (import <nixpkgs> { }) snapTools firefox; in snapTools.makeSnap { |