From 9df8eb2b9ccca0d1466d38605e050603de9dc51d Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Mon, 6 Nov 2023 18:25:49 +0100 Subject: [PATCH 1/6] docs: update redirect metadata for hugo docs.docker.com switched from Jekyll to Hugo, which uses "aliases" instead of "redirect_from". Signed-off-by: Sebastiaan van Stijn (cherry picked from commit 07338fe965a0ce35d2c821cc823f64f7b6dce66f) Signed-off-by: Sebastiaan van Stijn --- docs/extend/legacy_plugins.md | 2 +- docs/extend/plugins_authorization.md | 2 +- docs/reference/commandline/cli.md | 2 +- docs/reference/commandline/dockerd.md | 2 +- docs/reference/run.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/extend/legacy_plugins.md b/docs/extend/legacy_plugins.md index d3981bd076..6c842ac473 100644 --- a/docs/extend/legacy_plugins.md +++ b/docs/extend/legacy_plugins.md @@ -1,5 +1,5 @@ --- -redirect_from: +aliases: - "/engine/extend/plugins/" description: "How to add additional functionality to Docker with plugins extensions" keywords: "Examples, Usage, plugins, docker, documentation, user guide" diff --git a/docs/extend/plugins_authorization.md b/docs/extend/plugins_authorization.md index 2fc444e101..203c1bf2e2 100644 --- a/docs/extend/plugins_authorization.md +++ b/docs/extend/plugins_authorization.md @@ -1,7 +1,7 @@ --- description: "How to create authorization plugins to manage access control to your Docker daemon." keywords: "security, authorization, authentication, docker, documentation, plugin, extend" -redirect_from: +aliases: - "/engine/extend/authorization/" --- diff --git a/docs/reference/commandline/cli.md b/docs/reference/commandline/cli.md index dca3da8a11..8714cd6b70 100644 --- a/docs/reference/commandline/cli.md +++ b/docs/reference/commandline/cli.md @@ -2,7 +2,7 @@ title: "Use the Docker command line" description: "Docker's CLI command description and usage" keywords: "Docker, Docker documentation, CLI, command line, config.json, CLI configuration file" -redirect_from: +aliases: - /reference/commandline/cli/ - /engine/reference/commandline/engine/ - /engine/reference/commandline/engine_activate/ diff --git a/docs/reference/commandline/dockerd.md b/docs/reference/commandline/dockerd.md index 9a62bbf97d..64506e3542 100644 --- a/docs/reference/commandline/dockerd.md +++ b/docs/reference/commandline/dockerd.md @@ -2,7 +2,7 @@ title: "dockerd" description: "The daemon command description and usage" keywords: "container, daemon, runtime" -redirect_from: +aliases: - /engine/reference/commandline/daemon/ --- diff --git a/docs/reference/run.md b/docs/reference/run.md index a715c47c7a..200ef75f24 100644 --- a/docs/reference/run.md +++ b/docs/reference/run.md @@ -1,7 +1,7 @@ --- description: "Configure containers at runtime" keywords: "docker, run, configure, runtime" -redirect_from: +aliases: - /reference/run/ --- From 55cec698b7fe77e4270e30b7f19839c633e9dc79 Mon Sep 17 00:00:00 2001 From: saurabh Date: Tue, 7 Nov 2023 01:17:38 +0530 Subject: [PATCH 2/6] --env-file about comments doc updated Signed-off-by: Saurabh Kumar (cherry picked from commit efc9236794cfba97b62a6ef84723bdab5864b2a3) Signed-off-by: Sebastiaan van Stijn --- docs/reference/commandline/run.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/reference/commandline/run.md b/docs/reference/commandline/run.md index cb4703041e..44595c6e72 100644 --- a/docs/reference/commandline/run.md +++ b/docs/reference/commandline/run.md @@ -416,6 +416,8 @@ environment, the variable isn't set in the container. You can also load the environment variables from a file. This file should use the syntax `=value` (which sets the variable to the given value) or `` (which takes the value from the local environment), and `#` for comments. +Additionally, it's important to note that lines beginning with `#` are treated as line comments +and are ignored, whereas a `#` appearing anywhere else in a line is treated as part of the variable value. ```console $ cat env.list From 13a7d571a1449c1734ba82361c2c438ffd9d9153 Mon Sep 17 00:00:00 2001 From: Hugo Chastel Date: Mon, 20 Nov 2023 19:14:05 +0100 Subject: [PATCH 3/6] Add zstd as supported in load command doc Signed-off-by: Hugo Chastel (cherry picked from commit f387558b55811f50405000e9dcc697b3eff401f1) Signed-off-by: Sebastiaan van Stijn --- docs/reference/commandline/load.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/commandline/load.md b/docs/reference/commandline/load.md index c7e9316b1c..098af0a243 100644 --- a/docs/reference/commandline/load.md +++ b/docs/reference/commandline/load.md @@ -20,7 +20,7 @@ Load an image from a tar archive or STDIN ## Description Load an image or repository from a tar archive (even if compressed with gzip, -bzip2, or xz) from a file or STDIN. It restores both images and tags. +bzip2, xz or zstd) from a file or STDIN. It restores both images and tags. ## Examples From f9cdb6f96aa8900f5369d8385b9d649a0af0a58b Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Thu, 23 Nov 2023 23:21:07 +0100 Subject: [PATCH 4/6] docs: update debian examples to use bookworm "bullseye" is no longer the "latest" debian, so these examples were now incorrect. Signed-off-by: Sebastiaan van Stijn (cherry picked from commit 6468c63c81aa55c21e75076494f3ec11f1e09916) Signed-off-by: Sebastiaan van Stijn --- docs/reference/commandline/pull.md | 16 ++++++++-------- man/src/image/pull.md | 16 ++++++++-------- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/reference/commandline/pull.md b/docs/reference/commandline/pull.md index 8c90dc4e5d..c1465f8770 100644 --- a/docs/reference/commandline/pull.md +++ b/docs/reference/commandline/pull.md @@ -67,18 +67,18 @@ docker.io/library/debian:latest Docker images can consist of multiple layers. In the example above, the image consists of a single layer; `e756f3fdd6a3`. -Layers can be reused by images. For example, the `debian:bullseye` image shares -its layer with the `debian:latest`. Pulling the `debian:bullseye` image therefore +Layers can be reused by images. For example, the `debian:bookworm` image shares +its layer with the `debian:latest`. Pulling the `debian:bookworm` image therefore only pulls its metadata, but not its layers, because the layer is already present locally: ```console -$ docker image pull debian:bullseye +$ docker image pull debian:bookworm -bullseye: Pulling from library/debian +bookworm: Pulling from library/debian Digest: sha256:3f1d6c17773a45c97bd8f158d665c9709d7b29ed7917ac934086ad96f92e4510 -Status: Downloaded newer image for debian:bullseye -docker.io/library/debian:bullseye +Status: Downloaded newer image for debian:bookworm +docker.io/library/debian:bookworm ``` To see which images are present locally, use the [`docker images`](images.md) @@ -88,13 +88,13 @@ command: $ docker images REPOSITORY TAG IMAGE ID CREATED SIZE -debian bullseye 4eacea30377a 8 days ago 124MB +debian bookworm 4eacea30377a 8 days ago 124MB debian latest 4eacea30377a 8 days ago 124MB ``` Docker uses a content-addressable image store, and the image ID is a SHA256 digest covering the image's configuration and layers. In the example above, -`debian:bullseye` and `debian:latest` have the same image ID because they are +`debian:bookworm` and `debian:latest` have the same image ID because they are the *same* image tagged with different names. Because they are the same image, their layers are stored only once and do not consume extra disk space. diff --git a/man/src/image/pull.md b/man/src/image/pull.md index 7b6f1f2a40..8187ede1e8 100644 --- a/man/src/image/pull.md +++ b/man/src/image/pull.md @@ -27,17 +27,17 @@ Docker Engine uses the `:latest` tag as a default. This example pulls the Docker images can consist of multiple layers. In the example above, the image consists of a single layer; `e756f3fdd6a3`. -Layers can be reused by images. For example, the `debian:bullseye` image shares -its layer with the `debian:latest`. Pulling the `debian:bullseye` image therefore +Layers can be reused by images. For example, the `debian:bookworm` image shares +its layer with the `debian:latest`. Pulling the `debian:bookworm` image therefore only pulls its metadata, but not its layers, because the layer is already present locally: - $ docker image pull debian:bullseye + $ docker image pull debian:bookworm - bullseye: Pulling from library/debian + bookworm: Pulling from library/debian Digest: sha256:3f1d6c17773a45c97bd8f158d665c9709d7b29ed7917ac934086ad96f92e4510 - Status: Downloaded newer image for debian:bullseye - docker.io/library/debian:bullseye + Status: Downloaded newer image for debian:bookworm + docker.io/library/debian:bookworm To see which images are present locally, use the **docker-images(1)** command: @@ -45,12 +45,12 @@ command: $ docker images REPOSITORY TAG IMAGE ID CREATED SIZE - debian bullseye 4eacea30377a 8 days ago 124MB + debian bookworm 4eacea30377a 8 days ago 124MB debian latest 4eacea30377a 8 days ago 124MB Docker uses a content-addressable image store, and the image ID is a SHA256 digest covering the image's configuration and layers. In the example above, -`debian:bullseye` and `debian:latest` have the same image ID because they are +`debian:bookworm` and `debian:latest` have the same image ID because they are the *same* image tagged with different names. Because they are the same image, their layers are stored only once and do not consume extra disk space. From 3ab117e7cda4c34031556d7705d5209ebdc65dbb Mon Sep 17 00:00:00 2001 From: TheRealGramdalf <79593869+TheRealGramdalf@users.noreply.github.com> Date: Fri, 1 Dec 2023 05:17:22 +0000 Subject: [PATCH 5/6] Fix typo in dockerd reference documentation Signed-off-by: Graeme Wiebe (cherry picked from commit e93ec2f6a6147d7a57056f8f373d62162c2b9227) Signed-off-by: Sebastiaan van Stijn --- docs/reference/commandline/dockerd.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/commandline/dockerd.md b/docs/reference/commandline/dockerd.md index 64506e3542..1c9f8e1837 100644 --- a/docs/reference/commandline/dockerd.md +++ b/docs/reference/commandline/dockerd.md @@ -205,7 +205,7 @@ find examples of using Systemd socket activation with Docker and Systemd in the You can configure the Docker daemon to listen to multiple sockets at the same time using multiple `-H` options: -The example below runs the daemon listenin on the default unix socket, and +The example below runs the daemon listening on the default unix socket, and on 2 specific IP addresses on this host: ```console From a976e5084a994b4b74733b6dd6b4aa0b80402720 Mon Sep 17 00:00:00 2001 From: Per Lundberg Date: Fri, 1 Dec 2023 15:30:07 +0200 Subject: [PATCH 6/6] exec.md: remove misleading part "By default" implies that this is something which could be disabled for an individual `docker exec` call. This doesn't seem to be the case, so removing the "by default" part would make these docs clearer to me. Signed-off-by: Per Lundberg (cherry picked from commit a431b1dda6b3c67df82c7266efb992c28fa198ee) Signed-off-by: Sebastiaan van Stijn --- docs/reference/commandline/exec.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/reference/commandline/exec.md b/docs/reference/commandline/exec.md index ccc0b3f3d0..c9656b7ecd 100644 --- a/docs/reference/commandline/exec.md +++ b/docs/reference/commandline/exec.md @@ -77,10 +77,10 @@ This starts a new shell session in the container `mycontainer`. Next, set environment variables in the current bash session. -By default, the `docker exec` command, inherits the environment variables that -are set at the time the container is created. Use the `--env` (or the `-e` shorthand) -to override global environment variables, or to set additional environment variables -for the process started by `docker exec`. +The `docker exec` command inherits the environment variables that are set at the +time the container is created. Use the `--env` (or the `-e` shorthand) to +override global environment variables, or to set additional environment +variables for the process started by `docker exec`. The example below creates a new shell session in the container `mycontainer` with environment variables `$VAR_A` and `$VAR_B` set to "1" and "2" respectively.