vendor: github.com/docker/cli eb986ae71b

dvdksn · dvdksn · commit 426fe900dae1 · 2024-11-07T15:41:03.000+01:00
Signed-off-by: David Karlsson &lt;35727626+dvdksn@users.noreply.github.com&gt;
diff --git a/_vendor/github.com/docker/cli/docs/reference/run.md b/_vendor/github.com/docker/cli/docs/reference/run.md
diff --git a/_vendor/modules.txt b/_vendor/modules.txt
@@ -1,6 +1,6 @@
 # github.com/moby/moby v27.3.1+incompatible
 # github.com/moby/buildkit v0.17.0
 # github.com/docker/buildx v0.18.0
-# github.com/docker/cli v27.3.2-0.20241008150905-cb3048fbebb1+incompatible
+# github.com/docker/cli v27.3.2-0.20241107125754-eb986ae71b0c+incompatible
 # github.com/docker/compose/v2 v2.30.1
 # github.com/docker/scout-cli v1.15.0
diff --git a/data/engine-cli/docker_container_restart.yaml b/data/engine-cli/docker_container_restart.yaml
@@ -10,6 +10,7 @@ options:
       shorthand: s
       value_type: string
       description: Signal to send to the container
+      details_url: '#signal'
       deprecated: false
       hidden: false
       experimental: false
@@ -21,6 +22,7 @@ options:
       value_type: int
       default_value: "0"
       description: Seconds to wait before killing the container
+      details_url: '#time'
       deprecated: false
       hidden: false
       experimental: false
@@ -42,6 +44,37 @@ examples: |-
     ```console
     $ docker restart my_container
     ```
+
+
+    ### Stop container with signal (-s, --signal) {#signal}
+
+    The `--signal` flag sends the system call signal to the container to exit.
+    This signal can be a signal name in the format `SIG<NAME>`, for instance
+    `SIGKILL`, or an unsigned number that matches a position in the kernel's
+    syscall table, for instance `9`. Refer to [signal(7)](https://man7.org/linux/man-pages/man7/signal.7.html)
+    for available signals.
+
+    The default signal to use is defined by the image's [`StopSignal`](https://github.com/opencontainers/image-spec/blob/v1.1.0/config.md),
+    which can be set through the [`STOPSIGNAL`](/reference/dockerfile/#stopsignal)
+    Dockerfile instruction when building the image, or configured using the
+    [`--stop-signal`](/reference/cli/docker/container/run/#stop-signal)
+    option when creating the container. If no signal is configured for the
+    container, `SIGTERM` is used as default.
+
+    ### Stop container with timeout (-t, --timeout) {#time}
+
+    The `--time` flag sets the number of seconds to wait for the container
+    to stop after sending the pre-defined (see [`--signal`]{#signal)) system call signal.
+    If the container does not exit after the timeout elapses, it's forcibly killed
+    with a `SIGKILL` signal.
+
+    If you set `--time` to `-1`, no timeout is applied, and the daemon
+    waits indefinitely for the container to exit.
+
+    The default timeout can be specified using the [`--stop-timeout`](/reference/cli/docker/container/run/#stop-timeout)
+    option when creating the container. If no default is configured for the container,
+    the Daemon determines the default, and is 10 seconds for Linux containers, and
+    30 seconds for Windows containers.
 deprecated: false
 hidden: false
 experimental: false
diff --git a/data/engine-cli/docker_container_run.yaml b/data/engine-cli/docker_container_run.yaml
@@ -2126,12 +2126,12 @@ examples: |-
     policy controls whether the Docker daemon restarts a container after exit.
     Docker supports the following restart policies:
 
-    | Policy                     | Result                                                                                                                                                                                                                                                           |
-    |:---------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-    | `no`                       | Do not automatically restart the container when it exits. This is the default.                                                                                                                                                                                   |
-    | `on-failure[:max-retries]` | Restart only if the container exits with a non-zero exit status. Optionally, limit the number of restart retries the Docker daemon attempts.                                                                                                                     |
-    | `unless-stopped`           | Restart the container unless it's explicitly stopped or Docker itself is stopped or restarted.                                                                                                                                                                  |
-    | `always`                   | Always restart the container regardless of the exit status. When you specify always, the Docker daemon tries to restart the container indefinitely. The container always starts on daemon startup, regardless of the current state of the container. |
+    | Flag                       | Description                                                                                                                                                                                                                                                                                                                                                           |
+    | :------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+    | `no`                       | Don't automatically restart the container. (Default)                                                                                                                                                                                                                                                                                                                  |
+    | `on-failure[:max-retries]` | Restart the container if it exits due to an error, which manifests as a non-zero exit code. Optionally, limit the number of times the Docker daemon attempts to restart the container using the `:max-retries` option. The `on-failure` policy only prompts a restart if the container exits with a failure. It doesn't restart the container if the daemon restarts. |
+    | `always`                   | Always restart the container if it stops. If it's manually stopped, it's restarted only when Docker daemon restarts or the container itself is manually restarted.                                                                                                                                                                                                    |
+    | `unless-stopped`           | Similar to `always`, except that when the container is stopped (manually or otherwise), it isn't restarted even after Docker daemon restarts.                                                                                                                                                                                                                         |
 
     ```console
     $ docker run --restart=always redis
@@ -2252,7 +2252,7 @@ examples: |-
 
     It's conventional to use `host.docker.internal` as the hostname referring to
     `host-gateway`. Docker Desktop automatically resolves this hostname, see
-    [Explore networking features](/desktop/networking/#i-want-to-connect-from-a-container-to-a-service-on-the-host).
+    [Explore networking features](/desktop/features/networking/#i-want-to-connect-from-a-container-to-a-service-on-the-host).
 
     The following example shows how the special `host-gateway` value works. The
     example runs an HTTP server that serves a file from host to container over the
diff --git a/data/engine-cli/docker_container_stop.yaml b/data/engine-cli/docker_container_stop.yaml
@@ -5,7 +5,7 @@ long: |-
     The main process inside the container will receive `SIGTERM`, and after a grace
     period, `SIGKILL`. The first signal can be changed with the `STOPSIGNAL`
     instruction in the container's Dockerfile, or the `--stop-signal` option to
-    `docker run`.
+    `docker run` and `docker create`.
 usage: docker container stop [OPTIONS] CONTAINER [CONTAINER...]
 pname: docker container
 plink: docker_container.yaml
@@ -14,6 +14,7 @@ options:
       shorthand: s
       value_type: string
       description: Signal to send to the container
+      details_url: '#signal'
       deprecated: false
       hidden: false
       experimental: false
@@ -25,6 +26,7 @@ options:
       value_type: int
       default_value: "0"
       description: Seconds to wait before killing the container
+      details_url: '#time'
       deprecated: false
       hidden: false
       experimental: false
@@ -46,6 +48,36 @@ examples: |-
     ```console
     $ docker stop my_container
     ```
+
+    ### Stop container with signal (-s, --signal) {#signal}
+
+    The `--signal` flag sends the system call signal to the container to exit.
+    This signal can be a signal name in the format `SIG<NAME>`, for instance
+    `SIGKILL`, or an unsigned number that matches a position in the kernel's
+    syscall table, for instance `9`. Refer to [signal(7)](https://man7.org/linux/man-pages/man7/signal.7.html)
+    for available signals.
+
+    The default signal to use is defined by the image's [`StopSignal`](https://github.com/opencontainers/image-spec/blob/v1.1.0/config.md),
+    which can be set through the [`STOPSIGNAL`](/reference/dockerfile/#stopsignal)
+    Dockerfile instruction when building the image, or configured using the
+    [`--stop-signal`](/reference/cli/docker/container/run/#stop-signal)
+    option when creating the container. If no signal is configured for the
+    container, `SIGTERM` is used as default.
+
+    ### Stop container with timeout (-t, --timeout) {#time}
+
+    The `--time` flag sets the number of seconds to wait for the container
+    to stop after sending the pre-defined (see [`--signal`]{#signal)) system call signal.
+    If the container does not exit after the timeout elapses, it's forcibly killed
+    with a `SIGKILL` signal.
+
+    If you set `--time` to `-1`, no timeout is applied, and the daemon
+    waits indefinitely for the container to exit.
+
+    The default timeout can be specified using the [`--stop-timeout`](/reference/cli/docker/container/run/#stop-timeout)
+    option when creating the container. If no default is configured for the container,
+    the Daemon determines the default, and is 10 seconds for Linux containers, and
+    30 seconds for Windows containers.
 deprecated: false
 hidden: false
 experimental: false
diff --git a/data/engine-cli/docker_image_build.yaml b/data/engine-cli/docker_image_build.yaml
@@ -2,7 +2,7 @@ command: docker image build
 aliases: docker image build, docker build, docker builder build
 short: Build an image from a Dockerfile
 long: |-
-    > [!NOTE]
+    > [!IMPORTANT]
     > This page refers to the **legacy implementation** of `docker build`,
     > using the legacy (pre-BuildKit) build backend.
     > This configuration is only relevant if you're building Windows containers.
diff --git a/go.mod b/go.mod
@@ -4,7 +4,7 @@ go 1.23.1
 
 require (
 	github.com/docker/buildx v0.18.0 // indirect
-	github.com/docker/cli v27.3.2-0.20241008150905-cb3048fbebb1+incompatible // indirect
+	github.com/docker/cli v27.3.2-0.20241107125754-eb986ae71b0c+incompatible // indirect
 	github.com/docker/compose/v2 v2.30.1 // indirect
 	github.com/docker/scout-cli v1.15.0 // indirect
 	github.com/moby/buildkit v0.17.0 // indirect
@@ -13,7 +13,7 @@ require (
 
 replace (
 	github.com/docker/buildx => github.com/docker/buildx v0.18.0
-	github.com/docker/cli => github.com/docker/cli v27.3.1+incompatible
+	github.com/docker/cli => github.com/docker/cli v27.3.2-0.20241107125754-eb986ae71b0c+incompatible
 	github.com/docker/compose/v2 => github.com/docker/compose/v2 v2.30.1
 	github.com/docker/scout-cli => github.com/docker/scout-cli v1.15.0
 	github.com/moby/buildkit => github.com/moby/buildkit v0.17.0
diff --git a/go.sum b/go.sum
@@ -130,6 +130,8 @@ github.com/docker/cli v27.3.0+incompatible h1:h7J5eiGdUbH2Q4EcGr1mFb20qzS7Nrot3E
 github.com/docker/cli v27.3.0+incompatible/go.mod h1:JLrzqnKDaYBop7H2jaqPtU4hHvMKP+vjCwu2uszcLI8=
 github.com/docker/cli v27.3.1+incompatible h1:qEGdFBF3Xu6SCvCYhc7CzaQTlBmqDuzxPDpigSyeKQQ=
 github.com/docker/cli v27.3.1+incompatible/go.mod h1:JLrzqnKDaYBop7H2jaqPtU4hHvMKP+vjCwu2uszcLI8=
+github.com/docker/cli v27.3.2-0.20241107125754-eb986ae71b0c+incompatible h1:KqHavmeo5+ct30Z2UKxbVhUEfuzI9JZFgPdVVaWS4Uc=
+github.com/docker/cli v27.3.2-0.20241107125754-eb986ae71b0c+incompatible/go.mod h1:JLrzqnKDaYBop7H2jaqPtU4hHvMKP+vjCwu2uszcLI8=
 github.com/docker/compose-cli v1.0.35 h1:uZyEHLalfqBS2PiTpA1LAULyJmuQ+YtZg7nG4Xl3/Cc=
 github.com/docker/compose-cli v1.0.35/go.mod h1:mSXI4hFLpRU3EtI8NTo32bNwI0UXSr8jnq+/rYjGAUU=
 github.com/docker/compose/v2 v2.22.0 h1:3rRz4L7tPU75wRsV8JZh2/aTgerQvPa1cpzZN+tHqUY=
