From d06e3a71748a5de40fe83ba6755208d07c67d362 Mon Sep 17 00:00:00 2001
From: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Date: Thu, 23 Nov 2023 13:52:55 +0100
Subject: [PATCH] docs: move --rm to docker run reference
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
---
docs/reference/commandline/run.md | 32 ++++++++++++++++++++++++++++++-
docs/reference/run.md | 27 --------------------------
2 files changed, 31 insertions(+), 28 deletions(-)
diff --git a/docs/reference/commandline/run.md b/docs/reference/commandline/run.md
index a84710b2907d..42a3eba1d5c4 100644
--- a/docs/reference/commandline/run.md
+++ b/docs/reference/commandline/run.md
@@ -95,7 +95,7 @@ Create and run a new container from an image
| `-q`, `--quiet` | | | Suppress the pull output |
| [`--read-only`](#read-only) | | | Mount the container's root filesystem as read only |
| [`--restart`](#restart) | `string` | `no` | Restart policy to apply when a container exits |
-| `--rm` | | | Automatically remove the container when it exits |
+| [`--rm`](#rm) | | | Automatically remove the container when it exits |
| `--runtime` | `string` | | Runtime to use for this container |
| [`--security-opt`](#security-opt) | `list` | | Security Options |
| `--shm-size` | `bytes` | `0` | Size of /dev/shm |
@@ -1033,6 +1033,36 @@ $ docker inspect -f "{{ .State.StartedAt }}" my-container
Combining `--restart` (restart policy) with the `--rm` (clean up) flag results
in an error. On container restart, attached clients are disconnected.
+### Clean up (--rm)
+
+By default, a container's file system persists even after the container exits.
+This makes debugging a lot easier, since you can inspect the container's final
+state and you retain all your data.
+
+If you are running short-term **foreground** processes, these container file
+systems can start to pile up. If you'd like Docker to automatically clean up
+the container and remove the file system when the container exits, use the
+`--rm` flag:
+
+```text
+--rm=false: Automatically remove the container when it exits
+```
+
+> **Note**
+>
+> If you set the `--rm` flag, Docker also removes the anonymous volumes
+> associated with the container when the container is removed. This is similar
+> to running `docker rm -v my-container`. Only volumes that are specified without
+> a name are removed. For example, when running:
+>
+> ```console
+> $ docker run --rm -v /foo -v awesome:/bar busybox top
+> ```
+>
+> the volume for `/foo` will be removed, but the volume for `/bar` will not.
+> Volumes inherited via `--volumes-from` will be removed with the same logic: if
+> the original volume was specified with a name it will **not** be removed.
+
### Add entries to container hosts file (--add-host)
You can add other hosts into a container's `/etc/hosts` file by using one or
diff --git a/docs/reference/run.md b/docs/reference/run.md
index 624cffa6608a..336e5625df11 100644
--- a/docs/reference/run.md
+++ b/docs/reference/run.md
@@ -240,33 +240,6 @@ $ echo $?
3
```
-## Clean up (--rm)
-
-By default a container's file system persists even after the container
-exits. This makes debugging a lot easier (since you can inspect the
-final state) and you retain all your data by default. But if you are
-running short-term **foreground** processes, these container file
-systems can really pile up. If instead you'd like Docker to
-**automatically clean up the container and remove the file system when
-the container exits**, you can add the `--rm` flag:
-
- --rm=false: Automatically remove the container when it exits
-
-> **Note**
->
-> If you set the `--rm` flag, Docker also removes the anonymous volumes
-> associated with the container when the container is removed. This is similar
-> to running `docker rm -v my-container`. Only volumes that are specified without
-> a name are removed. For example, when running:
->
-> ```console
-> $ docker run --rm -v /foo -v awesome:/bar busybox top
-> ```
->
-> the volume for `/foo` will be removed, but the volume for `/bar` will not.
-> Volumes inherited via `--volumes-from` will be removed with the same logic: if
-> the original volume was specified with a name it will **not** be removed.
-
## Security configuration
| Option | Description |