Merge pull request #4706 from thaJeztah/24.0_backport_docs

[24.0 backport] assorted documentation updates
docker · Dec 11, 2023 · fb2f337 · fb2f337
2 parents f5a9aab + a976e50
commit fb2f337
Show file tree

Hide file tree

Showing 10 changed files with 29 additions and 27 deletions.
diff --git 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
@@ -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
@@ -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
@@ -2,7 +2,7 @@
 title: "dockerd"
 description: "The daemon command description and usage"
 keywords: "container, daemon, runtime"
-redirect_from:
+aliases:
 - /engine/reference/commandline/daemon/
 ---
 
@@ -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

diff --git 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.

diff --git 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
 

diff --git 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/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 `<variable>=value` (which sets the variable to the given value) or
 `<variable>` (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

diff --git 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/
 ---
 

diff --git a/man/src/image/pull.md b/man/src/image/pull.md
@@ -27,30 +27,30 @@ 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:
 
     $ 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.