Skip to content

Commit

Permalink
docs, man: remove confusing example for "--isolation"
Browse files Browse the repository at this point in the history
This snippet was added in [38ec5d8][1]. The intent was to indicate
that an empty value is equivalent to passing "default" as value. However,
passing the `--isolation` flag _without a value_ (i.e., no `=` specified)
will fail in many cases, as any string after it will be parsed as value
(e.g. `docker run --isolation busybox` would consider `busybox` as value).

This patch removes these lines as they add more confusion than addressing.

[1]: moby/moby@38ec5d8

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
  • Loading branch information
thaJeztah committed Jan 2, 2025
1 parent 07aca45 commit 7b7a4c0
Show file tree
Hide file tree
Showing 3 changed files with 0 additions and 6 deletions.
2 changes: 0 additions & 2 deletions docs/reference/commandline/image_build.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,8 +133,6 @@ Linux namespaces. On Microsoft Windows, you can specify these values:
| `process` | Namespace isolation only. |
| `hyperv` | Hyper-V hypervisor partition-based isolation. |

Specifying the `--isolation` flag without a value is the same as setting `--isolation="default"`.

### <a name="security-opt"></a> Optional security options (--security-opt)

This flag is only supported on a daemon running on Windows, and only supports
Expand Down
2 changes: 0 additions & 2 deletions man/docker-build.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -348,8 +348,6 @@ Linux namespaces. On Microsoft Windows, you can specify these values:
* `process`: Namespace isolation only.
* `hyperv`: Hyper-V hypervisor partition-based isolation.

Specifying the `--isolation` flag without a value is the same as setting `--isolation "default"`.

# HISTORY
March 2014, Originally compiled by William Henry (whenry at redhat dot com)
based on docker.com source material and internal work.
Expand Down
2 changes: 0 additions & 2 deletions man/src/container/create-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ Linux namespaces. On Microsoft Windows, you can specify these values:
* `process`: Namespace isolation only.
* `hyperv`: Hyper-V hypervisor partition-based isolation.

Specifying the `--isolation` flag without a value is the same as setting `--isolation="default"`.

### Dealing with dynamically created devices (--device-cgroup-rule)

Devices available to a container are assigned at creation time. The
Expand Down

0 comments on commit 7b7a4c0

Please sign in to comment.