From 5dd6e9a4d4a7b41c2feb02b023a1e624426c937b Mon Sep 17 00:00:00 2001
From: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Date: Wed, 22 Nov 2023 09:31:30 +0100
Subject: [PATCH] docs: move --ipc to docker run reference
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
---
docs/reference/commandline/run.md | 34 ++++++++++++++++++++++++++++++-
docs/reference/run.md | 30 ---------------------------
2 files changed, 33 insertions(+), 31 deletions(-)
diff --git a/docs/reference/commandline/run.md b/docs/reference/commandline/run.md
index 8111f40fbf..7a478fdccd 100644
--- a/docs/reference/commandline/run.md
+++ b/docs/reference/commandline/run.md
@@ -64,7 +64,7 @@ Create and run a new container from an image
| `--io-maxiops` | `uint64` | `0` | Maximum IOps limit for the system drive (Windows only) |
| `--ip` | `string` | | IPv4 address (e.g., 172.30.100.104) |
| `--ip6` | `string` | | IPv6 address (e.g., 2001:db8::33) |
-| `--ipc` | `string` | | IPC mode to use |
+| [`--ipc`](#ipc) | `string` | | IPC mode to use |
| [`--isolation`](#isolation) | `string` | | Container isolation technology |
| `--kernel-memory` | `bytes` | `0` | Kernel memory limit |
| [`-l`](#label), [`--label`](#label) | `list` | | Set meta data on a container |
@@ -289,6 +289,38 @@ You may wish to share the UTS namespace with the host if you would like the
hostname of the container to change as the hostname of the host changes. A more
advanced use case would be changing the host's hostname from a container.
+## IPC settings (--ipc)
+
+```text
+--ipc="MODE" : Set the IPC mode for the container
+```
+
+The `--ipc` flag accepts the following values:
+
+| Value | Description |
+|:---------------------------|:----------------------------------------------------------------------------------|
+| "" | Use daemon's default. |
+| "none" | Own private IPC namespace, with /dev/shm not mounted. |
+| "private" | Own private IPC namespace. |
+| "shareable" | Own private IPC namespace, with a possibility to share it with other containers. |
+| "container:<_name-or-ID_>" | Join another ("shareable") container's IPC namespace. |
+| "host" | Use the host system's IPC namespace. |
+
+If not specified, daemon default is used, which can either be `"private"`
+or `"shareable"`, depending on the daemon version and configuration.
+
+IPC (POSIX/SysV IPC) namespace provides separation of named shared memory
+segments, semaphores and message queues.
+
+Shared memory segments are used to accelerate inter-process communication at
+memory speed, rather than through pipes or through the network stack. Shared
+memory is commonly used by databases and custom-built (typically C/OpenMPI,
+C++/using boost libraries) high performance applications for scientific
+computing and financial services industries. If these types of applications
+are broken into multiple containers, you might need to share the IPC mechanisms
+of the containers, using `"shareable"` mode for the main (i.e. "donor")
+container, and `"container:"` for other containers.
+
### Full container capabilities (--privileged)
```console
diff --git a/docs/reference/run.md b/docs/reference/run.md
index 4eed05b2c0..7b341e6755 100644
--- a/docs/reference/run.md
+++ b/docs/reference/run.md
@@ -159,36 +159,6 @@ $ docker ps -q --filter ancestor=nginx:alpine
For more information about using filters, see
[Filtering](https://docs.docker.com/config/filter/).
-## IPC settings (--ipc)
-
- --ipc="MODE" : Set the IPC mode for the container
-
-The following values are accepted:
-
-| Value | Description |
-|:---------------------------|:----------------------------------------------------------------------------------|
-| "" | Use daemon's default. |
-| "none" | Own private IPC namespace, with /dev/shm not mounted. |
-| "private" | Own private IPC namespace. |
-| "shareable" | Own private IPC namespace, with a possibility to share it with other containers. |
-| "container:<_name-or-ID_>" | Join another ("shareable") container's IPC namespace. |
-| "host" | Use the host system's IPC namespace. |
-
-If not specified, daemon default is used, which can either be `"private"`
-or `"shareable"`, depending on the daemon version and configuration.
-
-IPC (POSIX/SysV IPC) namespace provides separation of named shared memory
-segments, semaphores and message queues.
-
-Shared memory segments are used to accelerate inter-process communication at
-memory speed, rather than through pipes or through the network stack. Shared
-memory is commonly used by databases and custom-built (typically C/OpenMPI,
-C++/using boost libraries) high performance applications for scientific
-computing and financial services industries. If these types of applications
-are broken into multiple containers, you might need to share the IPC mechanisms
-of the containers, using `"shareable"` mode for the main (i.e. "donor")
-container, and `"container:"` for other containers.
-
## Network settings
--dns=[] : Set custom dns servers for the container